com.amazonaws.services.simplesystemsmanagement

Interface AWSSimpleSystemsManagement

All Known Subinterfaces:

AWSSimpleSystemsManagementAsync

All Known Implementing Classes:

AWSSimpleSystemsManagementAsyncClient, AWSSimpleSystemsManagementClient

public interface AWSSimpleSystemsManagement

Interface for accessing AWSSimpleSystemsManagement.

AWS Simple Systems Management 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:

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

• Run PowerShell scripts

• Join an AWS Directory

• Configure CloudWatch Logs to monitor applications and systems

Note that configuration documents are not supported on Linux instances.

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	setRegion(Region region) An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
UpdateAssociationStatusResult	updateAssociationStatus(UpdateAssociationStatusRequest updateAssociationStatusRequest) Updates the status of the configuration document associated with the specified instance.

Method Detail

setEndpoint

void setEndpoint(String endpoint)
                 throws IllegalArgumentException

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.

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.

Throws:

IllegalArgumentException - If any problems are detected with the specified endpoint.

setRegion

void setRegion(Region region)
               throws IllegalArgumentException

An alternative to 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 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.

Parameters:

region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region.

Throws:

IllegalArgumentException - If the given region is null, or if this service isn't available in the given region. See Region.isServiceSupported(String)

See Also:

Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)

deleteDocument

DeleteDocumentResult deleteDocument(DeleteDocumentRequest deleteDocumentRequest)
                                    throws AmazonServiceException,
                                           AmazonClientException

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.

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

DescribeAssociationResult describeAssociation(DescribeAssociationRequest describeAssociationRequest)
                                              throws AmazonServiceException,
                                                     AmazonClientException

Describes the associations for the specified configuration document or instance.

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

CreateAssociationResult createAssociation(CreateAssociationRequest createAssociationRequest)
                                          throws AmazonServiceException,
                                                 AmazonClientException

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.

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

CreateAssociationBatchResult createAssociationBatch(CreateAssociationBatchRequest createAssociationBatchRequest)
                                                    throws AmazonServiceException,
                                                           AmazonClientException

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.

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

DescribeDocumentResult describeDocument(DescribeDocumentRequest describeDocumentRequest)
                                        throws AmazonServiceException,
                                               AmazonClientException

Describes the specified configuration document.

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

UpdateAssociationStatusResult updateAssociationStatus(UpdateAssociationStatusRequest updateAssociationStatusRequest)
                                                      throws AmazonServiceException,
                                                             AmazonClientException

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

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

ListAssociationsResult listAssociations(ListAssociationsRequest listAssociationsRequest)
                                        throws AmazonServiceException,
                                               AmazonClientException

Lists the associations for the specified configuration document or instance.

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

ListDocumentsResult listDocuments(ListDocumentsRequest listDocumentsRequest)
                                  throws AmazonServiceException,
                                         AmazonClientException

Describes one or more of your configuration documents.

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

DeleteAssociationResult deleteAssociation(DeleteAssociationRequest deleteAssociationRequest)
                                          throws AmazonServiceException,
                                                 AmazonClientException

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.

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

CreateDocumentResult createDocument(CreateDocumentRequest createDocumentRequest)
                                    throws AmazonServiceException,
                                           AmazonClientException

Creates a configuration document.

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

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

GetDocumentResult getDocument(GetDocumentRequest getDocumentRequest)
                              throws AmazonServiceException,
                                     AmazonClientException

Gets the contents of the specified configuration document.

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

ListDocumentsResult listDocuments()
                                  throws AmazonServiceException,
                                         AmazonClientException

Describes one or more of your configuration documents.

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.

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

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 a request.

Parameters:

request - The originally executed request.

Returns:

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