com.amazonaws.services.simplesystemsmanagement

Class AWSSimpleSystemsManagementClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.simplesystemsmanagement.AWSSimpleSystemsManagementClient

All Implemented Interfaces:

AWSSimpleSystemsManagement

Direct Known Subclasses:

AWSSimpleSystemsManagementAsyncClient

public class AWSSimpleSystemsManagementClient
extends AmazonWebServiceClient
implements AWSSimpleSystemsManagement

Client for accessing Amazon SSM. All service calls made using this client are blocking, and will not return until the service call completes.

Amazon EC2 Simple Systems Manager (SSM) enables you to configure and manage your EC2 instances. You can create a configuration document and then associate it with one or more running instances.

You can use a configuration document to automate the following tasks for your Windows instances:

• Join an AWS Directory

• Install, repair, or uninstall software using an MSI package

• Run PowerShell scripts

• Configure CloudWatch Logs to monitor applications and systems

Note that configuration documents are not supported on Linux instances.

Field Summary

Fields

Modifier and Type	Field and Description
protected List<com.amazonaws.transform.JsonErrorUnmarshallerV2>	jsonErrorUnmarshallers List of exception unmarshallers for all Amazon SSM exceptions.

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Constructor Summary

Constructors

Constructor and Description
AWSSimpleSystemsManagementClient() Constructs a new client to invoke service methods on Amazon SSM.
AWSSimpleSystemsManagementClient(AWSCredentials awsCredentials) Constructs a new client to invoke service methods on Amazon SSM using the specified AWS account credentials.
AWSSimpleSystemsManagementClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on Amazon SSM using the specified AWS account credentials and client configuration options.
AWSSimpleSystemsManagementClient(AWSCredentialsProvider awsCredentialsProvider) Constructs a new client to invoke service methods on Amazon SSM using the specified AWS account credentials provider.
AWSSimpleSystemsManagementClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on Amazon SSM using the specified AWS account credentials provider and client configuration options.
AWSSimpleSystemsManagementClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Constructs a new client to invoke service methods on Amazon SSM using the specified AWS account credentials provider, client configuration options, and request metric collector.
AWSSimpleSystemsManagementClient(ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on Amazon SSM.

Method Summary

Methods

Modifier and Type	Method and Description
CreateAssociationResult	createAssociation(CreateAssociationRequest createAssociationRequest) Associates the specified configuration document with the specified instance.
CreateAssociationBatchResult	createAssociationBatch(CreateAssociationBatchRequest createAssociationBatchRequest) Associates the specified configuration documents with the specified instances.
CreateDocumentResult	createDocument(CreateDocumentRequest createDocumentRequest) Creates a configuration document.
DeleteAssociationResult	deleteAssociation(DeleteAssociationRequest deleteAssociationRequest) Disassociates the specified configuration document from the specified instance.
DeleteDocumentResult	deleteDocument(DeleteDocumentRequest deleteDocumentRequest) Deletes the specified configuration document.
DescribeAssociationResult	describeAssociation(DescribeAssociationRequest describeAssociationRequest) Describes the associations for the specified configuration document or instance.
DescribeDocumentResult	describeDocument(DescribeDocumentRequest describeDocumentRequest) Describes the specified configuration document.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
GetDocumentResult	getDocument(GetDocumentRequest getDocumentRequest) Gets the contents of the specified configuration document.
ListAssociationsResult	listAssociations(ListAssociationsRequest listAssociationsRequest) Lists the associations for the specified configuration document or instance.
ListDocumentsResult	listDocuments() Simplified method form for invoking the ListDocuments operation.
ListDocumentsResult	listDocuments(ListDocumentsRequest listDocumentsRequest) Describes one or more of your configuration documents.
UpdateAssociationStatusResult	updateAssociationStatus(UpdateAssociationStatusRequest updateAssociationStatusRequest) Updates the status of the configuration document associated with the specified instance.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeMarshalling, configSigner, configSigner, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.simplesystemsmanagement.AWSSimpleSystemsManagement

setEndpoint, setRegion, shutdown

Field Detail

jsonErrorUnmarshallers

protected List<com.amazonaws.transform.JsonErrorUnmarshallerV2> jsonErrorUnmarshallers

List of exception unmarshallers for all Amazon SSM exceptions.

Constructor Detail

AWSSimpleSystemsManagementClient

public AWSSimpleSystemsManagementClient()

Constructs a new client to invoke service methods on Amazon SSM. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

See Also:

DefaultAWSCredentialsProviderChain

AWSSimpleSystemsManagementClient

public AWSSimpleSystemsManagementClient(ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on Amazon SSM. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to Amazon SSM (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AWSSimpleSystemsManagementClient

public AWSSimpleSystemsManagementClient(AWSCredentials awsCredentials)

Constructs a new client to invoke service methods on Amazon SSM using the specified AWS account credentials.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

AWSSimpleSystemsManagementClient

public AWSSimpleSystemsManagementClient(AWSCredentials awsCredentials,
                                ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on Amazon SSM using the specified AWS account credentials and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to Amazon SSM (ex: proxy settings, retry counts, etc.).

AWSSimpleSystemsManagementClient

public AWSSimpleSystemsManagementClient(AWSCredentialsProvider awsCredentialsProvider)

Constructs a new client to invoke service methods on Amazon SSM using the specified AWS account credentials provider.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

AWSSimpleSystemsManagementClient

public AWSSimpleSystemsManagementClient(AWSCredentialsProvider awsCredentialsProvider,
                                ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on Amazon SSM using the specified AWS account credentials provider and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to Amazon SSM (ex: proxy settings, retry counts, etc.).

AWSSimpleSystemsManagementClient

public AWSSimpleSystemsManagementClient(AWSCredentialsProvider awsCredentialsProvider,
                                ClientConfiguration clientConfiguration,
                                RequestMetricCollector requestMetricCollector)

Constructs a new client to invoke service methods on Amazon SSM using the specified AWS account credentials provider, client configuration options, and request metric collector.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to Amazon SSM (ex: proxy settings, retry counts, etc.).

requestMetricCollector - optional request metric collector

Method Detail

createAssociation

public CreateAssociationResult createAssociation(CreateAssociationRequest createAssociationRequest)

Associates the specified configuration document with the specified instance.

When you associate a configuration document with an instance, the configuration agent on the instance processes the configuration document and configures the instance as specified.

If you associate a configuration document with an instance that already has an associated configuration document, we replace the current configuration document with the new configuration document.

Specified by:

createAssociation in interface AWSSimpleSystemsManagement

Parameters:

createAssociationRequest - null

Returns:

Result of the CreateAssociation operation returned by the service.

Throws:

AssociationAlreadyExistsException - The specified association already exists.

AssociationLimitExceededException - You can have at most 2,000 active associations.

InternalServerErrorException - An error occurred on the server side.

InvalidDocumentException - The configuration document is not valid.

InvalidInstanceIdException - You must specify the ID of a running instance.

createAssociationBatch

public CreateAssociationBatchResult createAssociationBatch(CreateAssociationBatchRequest createAssociationBatchRequest)

Associates the specified configuration documents with the specified instances.

When you associate a configuration document with an instance, the configuration agent on the instance processes the configuration document and configures the instance as specified.

If you associate a configuration document with an instance that already has an associated configuration document, we replace the current configuration document with the new configuration document.

Specified by:

createAssociationBatch in interface AWSSimpleSystemsManagement

Parameters:

createAssociationBatchRequest - null

Returns:

Result of the CreateAssociationBatch operation returned by the service.

Throws:

InternalServerErrorException - An error occurred on the server side.

InvalidDocumentException - The configuration document is not valid.

InvalidInstanceIdException - You must specify the ID of a running instance.

DuplicateInstanceIdException - You cannot specify an instance ID in more than one association.

AssociationLimitExceededException - You can have at most 2,000 active associations.

createDocument

public CreateDocumentResult createDocument(CreateDocumentRequest createDocumentRequest)

Creates a configuration document.

After you create a configuration document, you can use CreateAssociation to associate it with one or more running instances.

Specified by:

createDocument in interface AWSSimpleSystemsManagement

Parameters:

createDocumentRequest - null

Returns:

Result of the CreateDocument operation returned by the service.

Throws:

DocumentAlreadyExistsException - The specified configuration document already exists.

MaxDocumentSizeExceededException - The size limit of a configuration document is 64 KB.

InternalServerErrorException - An error occurred on the server side.

InvalidDocumentContentException - The content for the configuration document is not valid.

DocumentLimitExceededException - You can have at most 100 active configuration documents.

deleteAssociation

public DeleteAssociationResult deleteAssociation(DeleteAssociationRequest deleteAssociationRequest)

Disassociates the specified configuration document from the specified instance.

When you disassociate a configuration document from an instance, it does not change the configuration of the instance. To change the configuration state of an instance after you disassociate a configuration document, you must create a new configuration document with the desired configuration and associate it with the instance.

Specified by:

deleteAssociation in interface AWSSimpleSystemsManagement

Parameters:

deleteAssociationRequest - null

Returns:

Result of the DeleteAssociation operation returned by the service.

Throws:

AssociationDoesNotExistException - The specified association does not exist.

InternalServerErrorException - An error occurred on the server side.

InvalidDocumentException - The configuration document is not valid.

InvalidInstanceIdException - You must specify the ID of a running instance.

TooManyUpdatesException - There are concurrent updates for a resource that supports one update at a time.

deleteDocument

public DeleteDocumentResult deleteDocument(DeleteDocumentRequest deleteDocumentRequest)

Deletes the specified configuration document.

You must use DeleteAssociation to disassociate all instances that are associated with the configuration document before you can delete it.

Specified by:

deleteDocument in interface AWSSimpleSystemsManagement

Parameters:

deleteDocumentRequest - null

Returns:

Result of the DeleteDocument operation returned by the service.

Throws:

InternalServerErrorException - An error occurred on the server side.

InvalidDocumentException - The configuration document is not valid.

AssociatedInstancesException - You must disassociate a configuration document from all instances before you can delete it.

describeAssociation

public DescribeAssociationResult describeAssociation(DescribeAssociationRequest describeAssociationRequest)

Describes the associations for the specified configuration document or instance.

Specified by:

describeAssociation in interface AWSSimpleSystemsManagement

Parameters:

describeAssociationRequest - null

Returns:

Result of the DescribeAssociation operation returned by the service.

Throws:

AssociationDoesNotExistException - The specified association does not exist.

InternalServerErrorException - An error occurred on the server side.

InvalidDocumentException - The configuration document is not valid.

InvalidInstanceIdException - You must specify the ID of a running instance.

describeDocument

public DescribeDocumentResult describeDocument(DescribeDocumentRequest describeDocumentRequest)

Describes the specified configuration document.

Specified by:

describeDocument in interface AWSSimpleSystemsManagement

Parameters:

describeDocumentRequest - null

Returns:

Result of the DescribeDocument operation returned by the service.

Throws:

InternalServerErrorException - An error occurred on the server side.

InvalidDocumentException - The configuration document is not valid.

getDocument

public GetDocumentResult getDocument(GetDocumentRequest getDocumentRequest)

Gets the contents of the specified configuration document.

Specified by:

getDocument in interface AWSSimpleSystemsManagement

Parameters:

getDocumentRequest - null

Returns:

Result of the GetDocument operation returned by the service.

Throws:

InternalServerErrorException - An error occurred on the server side.

InvalidDocumentException - The configuration document is not valid.

listAssociations

public ListAssociationsResult listAssociations(ListAssociationsRequest listAssociationsRequest)

Lists the associations for the specified configuration document or instance.

Specified by:

listAssociations in interface AWSSimpleSystemsManagement

Parameters:

listAssociationsRequest - null

Returns:

Result of the ListAssociations operation returned by the service.

Throws:

InternalServerErrorException - An error occurred on the server side.

InvalidNextTokenException - The specified token is not valid.

listDocuments

public ListDocumentsResult listDocuments(ListDocumentsRequest listDocumentsRequest)

Describes one or more of your configuration documents.

Specified by:

listDocuments in interface AWSSimpleSystemsManagement

Parameters:

listDocumentsRequest - null

Returns:

Result of the ListDocuments operation returned by the service.

Throws:

InternalServerErrorException - An error occurred on the server side.

InvalidNextTokenException - The specified token is not valid.

listDocuments

public ListDocumentsResult listDocuments()

Description copied from interface: AWSSimpleSystemsManagement

Simplified method form for invoking the ListDocuments operation.

Specified by:

listDocuments in interface AWSSimpleSystemsManagement

See Also:

AWSSimpleSystemsManagement.listDocuments(ListDocumentsRequest)

updateAssociationStatus

public UpdateAssociationStatusResult updateAssociationStatus(UpdateAssociationStatusRequest updateAssociationStatusRequest)

Updates the status of the configuration document associated with the specified instance.

Specified by:

updateAssociationStatus in interface AWSSimpleSystemsManagement

Parameters:

updateAssociationStatusRequest - null

Returns:

Result of the UpdateAssociationStatus operation returned by the service.

Throws:

InternalServerErrorException - An error occurred on the server side.

InvalidInstanceIdException - You must specify the ID of a running instance.

InvalidDocumentException - The configuration document is not valid.

AssociationDoesNotExistException - The specified association does not exist.

StatusUnchangedException - The updated status is the same as the current status.

TooManyUpdatesException - There are concurrent updates for a resource that supports one update at a time.

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

Specified by:

getCachedResponseMetadata in interface AWSSimpleSystemsManagement

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.