public interface AWSSimpleSystemsManagement
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.
| 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.
|
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.
|
void setEndpoint(String endpoint)
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.
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.void setRegion(Region region)
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.
region - The region this client will communicate with. See
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.Region.getRegion(com.amazonaws.regions.Regions),
Region.createClient(Class,
com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration),
Region.isServiceSupported(String)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.
createAssociationRequest - nullAssociationAlreadyExistsException - 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.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.
createAssociationBatchRequest - nullInternalServerErrorException - 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.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.
createDocumentRequest - nullDocumentAlreadyExistsException - 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.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.
deleteAssociationRequest - nullAssociationDoesNotExistException - 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.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.
deleteDocumentRequest - nullInternalServerErrorException - 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.DescribeAssociationResult describeAssociation(DescribeAssociationRequest describeAssociationRequest)
Describes the associations for the specified configuration document or instance.
describeAssociationRequest - nullAssociationDoesNotExistException - 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.DescribeDocumentResult describeDocument(DescribeDocumentRequest describeDocumentRequest)
Describes the specified configuration document.
describeDocumentRequest - nullInternalServerErrorException - An error occurred on the server side.InvalidDocumentException - The configuration document is not valid.GetDocumentResult getDocument(GetDocumentRequest getDocumentRequest)
Gets the contents of the specified configuration document.
getDocumentRequest - nullInternalServerErrorException - An error occurred on the server side.InvalidDocumentException - The configuration document is not valid.ListAssociationsResult listAssociations(ListAssociationsRequest listAssociationsRequest)
Lists the associations for the specified configuration document or instance.
listAssociationsRequest - nullInternalServerErrorException - An error occurred on the server side.InvalidNextTokenException - The specified token is not valid.ListDocumentsResult listDocuments(ListDocumentsRequest listDocumentsRequest)
Describes one or more of your configuration documents.
listDocumentsRequest - nullInternalServerErrorException - An error occurred on the server side.InvalidNextTokenException - The specified token is not valid.ListDocumentsResult listDocuments()
listDocuments(ListDocumentsRequest)UpdateAssociationStatusResult updateAssociationStatus(UpdateAssociationStatusRequest updateAssociationStatusRequest)
Updates the status of the configuration document associated with the specified instance.
updateAssociationStatusRequest - nullInternalServerErrorException - 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.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
request - The originally executed request.Copyright © 2015. All rights reserved.