/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.simplesystemsmanagement; import javax.annotation.Generated; import com.amazonaws.*; import com.amazonaws.regions.*; import com.amazonaws.services.simplesystemsmanagement.model.*; import com.amazonaws.services.simplesystemsmanagement.waiters.AWSSimpleSystemsManagementWaiters; /** * Interface for accessing Amazon SSM. *

* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from * {@link com.amazonaws.services.simplesystemsmanagement.AbstractAWSSimpleSystemsManagement} instead. *

*

*

* Amazon Web Services Systems Manager is the operations hub for your Amazon Web Services applications and resources and * a secure end-to-end management solution for hybrid cloud environments that enables safe and secure operations at * scale. *

*

* This reference is intended to be used with the Amazon Web Services Systems Manager User * Guide. To get started, see Setting up Amazon * Web Services Systems Manager. *

*

* Related resources *

* */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public interface AWSSimpleSystemsManagement { /** * The region metadata service name for computing region endpoints. You can use this value to retrieve metadata * (such as supported regions) of the service. * * @see RegionUtils#getRegionsForService(String) */ String ENDPOINT_PREFIX = "ssm"; /** * Overrides the default endpoint for this client ("https://ssm.us-east-1.amazonaws.com"). Callers can use this * method to control which AWS region they want to work with. *

* Callers can pass in just the endpoint (ex: "ssm.us-east-1.amazonaws.com") or a full URL, including the protocol * (ex: "https://ssm.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from * this client's {@link ClientConfiguration} will be used, which by default is HTTPS. *

* For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available * endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- * choose-endpoint *

* This method is not threadsafe. An endpoint should be configured when the client is created and before any * service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in * transit or retrying. * * @param endpoint * The endpoint (ex: "ssm.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: * "https://ssm.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate * with. * @deprecated use {@link AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration)} for * example: * {@code builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));} */ @Deprecated void setEndpoint(String endpoint); /** * An alternative to {@link AWSSimpleSystemsManagement#setEndpoint(String)}, sets the regional endpoint for this * client's service calls. Callers can use this method to control which AWS region they want to work with. *

* By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the * {@link ClientConfiguration} supplied at construction. *

* This method is not threadsafe. A region should be configured when the client is created and before any service * requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit * or retrying. * * @param region * The region this client will communicate with. See {@link Region#getRegion(com.amazonaws.regions.Regions)} * for accessing a given region. Must not be null and must be a region where the service is available. * * @see Region#getRegion(com.amazonaws.regions.Regions) * @see Region#createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration) * @see Region#isServiceSupported(String) * @deprecated use {@link AwsClientBuilder#setRegion(String)} */ @Deprecated void setRegion(Region region); /** *

* Adds or overwrites one or more tags for the specified resource. Tags are metadata that you can assign to * your automations, documents, managed nodes, maintenance windows, Parameter Store parameters, and patch baselines. * Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. * Each tag consists of a key and an optional value, both of which you define. For example, you could define a set * of tags for your account's managed nodes that helps you track each node's owner and stack level. For example: *

* *

* Most resources can have a maximum of 50 tags. Automations can have a maximum of 5 tags. *

*

* We recommend that you devise a set of tag keys that meets your needs for each resource type. Using a consistent * set of tag keys makes it easier for you to manage your resources. You can search and filter the resources based * on the tags you add. Tags don't have any semantic meaning to and are interpreted strictly as a string of * characters. *

*

* For more information about using tags with Amazon Elastic Compute Cloud (Amazon EC2) instances, see Tagging your Amazon EC2 resources * in the Amazon EC2 User Guide. *

* * @param addTagsToResourceRequest * @return Result of the AddTagsToResource operation returned by the service. * @throws InvalidResourceTypeException * The resource type isn't valid. For example, if you are attempting to tag an EC2 instance, the instance * must be a registered managed node. * @throws InvalidResourceIdException * The resource ID isn't valid. Verify that you entered the correct ID and try again. * @throws InternalServerErrorException * An error occurred on the server side. * @throws TooManyTagsErrorException * The Targets parameter includes too many tags. Remove one or more tags and try the command * again. * @throws TooManyUpdatesException * There are concurrent updates for a resource that supports one update at a time. * @sample AWSSimpleSystemsManagement.AddTagsToResource * @see AWS API * Documentation */ AddTagsToResourceResult addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest); /** *

* Associates a related item to a Systems Manager OpsCenter OpsItem. For example, you can associate an Incident * Manager incident or analysis with an OpsItem. Incident Manager and OpsCenter are capabilities of Amazon Web * Services Systems Manager. *

* * @param associateOpsItemRelatedItemRequest * @return Result of the AssociateOpsItemRelatedItem operation returned by the service. * @throws InternalServerErrorException * An error occurred on the server side. * @throws OpsItemNotFoundException * The specified OpsItem ID doesn't exist. Verify the ID and try again. * @throws OpsItemLimitExceededException * The request caused OpsItems to exceed one or more quotas. * @throws OpsItemInvalidParameterException * A specified parameter argument isn't valid. Verify the available arguments and try again. * @throws OpsItemRelatedItemAlreadyExistsException * The Amazon Resource Name (ARN) is already associated with the OpsItem. * @sample AWSSimpleSystemsManagement.AssociateOpsItemRelatedItem * @see AWS API Documentation */ AssociateOpsItemRelatedItemResult associateOpsItemRelatedItem(AssociateOpsItemRelatedItemRequest associateOpsItemRelatedItemRequest); /** *

* Attempts to cancel the command specified by the Command ID. There is no guarantee that the command will be * terminated and the underlying process stopped. *

* * @param cancelCommandRequest * @return Result of the CancelCommand operation returned by the service. * @throws InternalServerErrorException * An error occurred on the server side. * @throws InvalidCommandIdException * The specified command ID isn't valid. Verify the ID and try again. * @throws InvalidInstanceIdException * The following problems can cause this exception:

*