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 AWSSimpleSystemsManagement. 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.JsonErrorUnmarshaller>	jsonErrorUnmarshallers List of exception unmarshallers for all AWSSimpleSystemsManagement 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 AWSSimpleSystemsManagement.
AWSSimpleSystemsManagementClient(AWSCredentials awsCredentials) Constructs a new client to invoke service methods on AWSSimpleSystemsManagement using the specified AWS account credentials.
AWSSimpleSystemsManagementClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AWSSimpleSystemsManagement using the specified AWS account credentials and client configuration options.
AWSSimpleSystemsManagementClient(AWSCredentialsProvider awsCredentialsProvider) Constructs a new client to invoke service methods on AWSSimpleSystemsManagement using the specified AWS account credentials provider.
AWSSimpleSystemsManagementClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AWSSimpleSystemsManagement 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 AWSSimpleSystemsManagement 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 AWSSimpleSystemsManagement.

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() Describes one or more of your configuration documents.
ListDocumentsResult	listDocuments(ListDocumentsRequest listDocumentsRequest) Describes one or more of your configuration documents.
void	setEndpoint(String endpoint) Overrides the default endpoint for this client ("https://ssm.us-east-1.amazonaws.com/").
void	setEndpoint(String endpoint, String serviceName, String regionId)
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, 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

setRegion, shutdown

Field Detail

jsonErrorUnmarshallers

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

List of exception unmarshallers for all AWSSimpleSystemsManagement exceptions.

Constructor Detail

AWSSimpleSystemsManagementClient

public AWSSimpleSystemsManagementClient()

Constructs a new client to invoke service methods on AWSSimpleSystemsManagement. 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 AWSSimpleSystemsManagement. 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 AWSSimpleSystemsManagement (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AWSSimpleSystemsManagementClient

public AWSSimpleSystemsManagementClient(AWSCredentials awsCredentials)

Constructs a new client to invoke service methods on AWSSimpleSystemsManagement 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 AWSSimpleSystemsManagement 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 AWSSimpleSystemsManagement (ex: proxy settings, retry counts, etc.).

AWSSimpleSystemsManagementClient

public AWSSimpleSystemsManagementClient(AWSCredentialsProvider awsCredentialsProvider)

Constructs a new client to invoke service methods on AWSSimpleSystemsManagement 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 AWSSimpleSystemsManagement 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 AWSSimpleSystemsManagement (ex: proxy settings, retry counts, etc.).

AWSSimpleSystemsManagementClient

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

Constructs a new client to invoke service methods on AWSSimpleSystemsManagement 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 AWSSimpleSystemsManagement (ex: proxy settings, retry counts, etc.).

requestMetricCollector - optional request metric collector

Method Detail

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 - Container for the necessary parameters to execute the DeleteDocument service method on AWSSimpleSystemsManagement.

Returns:

The response from the DeleteDocument service method, as returned by AWSSimpleSystemsManagement.

Throws:

InternalServerErrorException

AssociatedInstancesException

InvalidDocumentException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSSimpleSystemsManagement indicating either a problem with the data in the request, or a server side issue.

describeAssociation

public DescribeAssociationResult describeAssociation(DescribeAssociationRequest describeAssociationRequest)

Describes the associations for the specified configuration document or instance.

Specified by:

describeAssociation in interface AWSSimpleSystemsManagement

Parameters:

describeAssociationRequest - Container for the necessary parameters to execute the DescribeAssociation service method on AWSSimpleSystemsManagement.

Returns:

The response from the DescribeAssociation service method, as returned by AWSSimpleSystemsManagement.

Throws:

InternalServerErrorException

InvalidInstanceIdException

InvalidDocumentException

AssociationDoesNotExistException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSSimpleSystemsManagement indicating either a problem with the data in the request, or a server side issue.

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 - Container for the necessary parameters to execute the CreateAssociation service method on AWSSimpleSystemsManagement.

Returns:

The response from the CreateAssociation service method, as returned by AWSSimpleSystemsManagement.

Throws:

AssociationLimitExceededException

InternalServerErrorException

InvalidInstanceIdException

InvalidDocumentException

AssociationAlreadyExistsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSSimpleSystemsManagement indicating either a problem with the data in the request, or a server side issue.

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 - Container for the necessary parameters to execute the CreateAssociationBatch service method on AWSSimpleSystemsManagement.

Returns:

The response from the CreateAssociationBatch service method, as returned by AWSSimpleSystemsManagement.

Throws:

DuplicateInstanceIdException

InternalServerErrorException

AssociationLimitExceededException

InvalidInstanceIdException

InvalidDocumentException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSSimpleSystemsManagement indicating either a problem with the data in the request, or a server side issue.

describeDocument

public DescribeDocumentResult describeDocument(DescribeDocumentRequest describeDocumentRequest)

Describes the specified configuration document.

Specified by:

describeDocument in interface AWSSimpleSystemsManagement

Parameters:

describeDocumentRequest - Container for the necessary parameters to execute the DescribeDocument service method on AWSSimpleSystemsManagement.

Returns:

The response from the DescribeDocument service method, as returned by AWSSimpleSystemsManagement.

Throws:

InternalServerErrorException

InvalidDocumentException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSSimpleSystemsManagement indicating either a problem with the data in the request, or a server side issue.

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 - Container for the necessary parameters to execute the UpdateAssociationStatus service method on AWSSimpleSystemsManagement.

Returns:

The response from the UpdateAssociationStatus service method, as returned by AWSSimpleSystemsManagement.

Throws:

InternalServerErrorException

InvalidInstanceIdException

InvalidDocumentException

StatusUnchangedException

TooManyUpdatesException

AssociationDoesNotExistException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSSimpleSystemsManagement indicating either a problem with the data in the request, or a server side issue.

listAssociations

public ListAssociationsResult listAssociations(ListAssociationsRequest listAssociationsRequest)

Lists the associations for the specified configuration document or instance.

Specified by:

listAssociations in interface AWSSimpleSystemsManagement

Parameters:

listAssociationsRequest - Container for the necessary parameters to execute the ListAssociations service method on AWSSimpleSystemsManagement.

Returns:

The response from the ListAssociations service method, as returned by AWSSimpleSystemsManagement.

Throws:

InternalServerErrorException

InvalidNextTokenException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSSimpleSystemsManagement indicating either a problem with the data in the request, or a server side issue.

listDocuments

public ListDocumentsResult listDocuments(ListDocumentsRequest listDocumentsRequest)

Describes one or more of your configuration documents.

Specified by:

listDocuments in interface AWSSimpleSystemsManagement

Parameters:

listDocumentsRequest - Container for the necessary parameters to execute the ListDocuments service method on AWSSimpleSystemsManagement.

Returns:

The response from the ListDocuments service method, as returned by AWSSimpleSystemsManagement.

Throws:

InternalServerErrorException

InvalidNextTokenException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSSimpleSystemsManagement indicating either a problem with the data in the request, or a server side issue.

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 - Container for the necessary parameters to execute the DeleteAssociation service method on AWSSimpleSystemsManagement.

Returns:

The response from the DeleteAssociation service method, as returned by AWSSimpleSystemsManagement.

Throws:

InternalServerErrorException

InvalidInstanceIdException

InvalidDocumentException

TooManyUpdatesException

AssociationDoesNotExistException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSSimpleSystemsManagement indicating either a problem with the data in the request, or a server side issue.

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 - Container for the necessary parameters to execute the CreateDocument service method on AWSSimpleSystemsManagement.

Returns:

The response from the CreateDocument service method, as returned by AWSSimpleSystemsManagement.

Throws:

InternalServerErrorException

DocumentAlreadyExistsException

MaxDocumentSizeExceededException

InvalidDocumentContentException

DocumentLimitExceededException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSSimpleSystemsManagement indicating either a problem with the data in the request, or a server side issue.

getDocument

public GetDocumentResult getDocument(GetDocumentRequest getDocumentRequest)

Gets the contents of the specified configuration document.

Specified by:

getDocument in interface AWSSimpleSystemsManagement

Parameters:

getDocumentRequest - Container for the necessary parameters to execute the GetDocument service method on AWSSimpleSystemsManagement.

Returns:

The response from the GetDocument service method, as returned by AWSSimpleSystemsManagement.

Throws:

InternalServerErrorException

InvalidDocumentException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSSimpleSystemsManagement indicating either a problem with the data in the request, or a server side issue.

listDocuments

public ListDocumentsResult listDocuments()
                                  throws AmazonServiceException,
                                         AmazonClientException

Describes one or more of your configuration documents.

Specified by:

listDocuments in interface AWSSimpleSystemsManagement

Returns:

The response from the ListDocuments service method, as returned by AWSSimpleSystemsManagement.

Throws:

InternalServerErrorException

InvalidNextTokenException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSSimpleSystemsManagement indicating either a problem with the data in the request, or a server side issue.

setEndpoint

public void setEndpoint(String endpoint)

Description copied from interface: AWSSimpleSystemsManagement

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 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: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912

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.

Specified by:

setEndpoint in interface AWSSimpleSystemsManagement

Overrides:

setEndpoint in class AmazonWebServiceClient

Parameters:

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.

setEndpoint

public void setEndpoint(String endpoint,
               String serviceName,
               String regionId)
                 throws IllegalArgumentException

Overrides:

setEndpoint in class AmazonWebServiceClient

Throws:

IllegalArgumentException

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.