public class AbstractAWSSimpleSystemsManagement extends Object implements AWSSimpleSystemsManagement
AWSSimpleSystemsManagement. Convenient
method forms pass through to the corresponding overload that takes a request
object, which throws an UnsupportedOperationException.| Modifier and Type | Method and Description |
|---|---|
CancelCommandResult |
cancelCommand(CancelCommandRequest request)
Attempts to cancel the command specified by the Command ID.
|
CreateAssociationResult |
createAssociation(CreateAssociationRequest request)
Associates the specified SSM document with the specified instance.
|
CreateAssociationBatchResult |
createAssociationBatch(CreateAssociationBatchRequest request)
Associates the specified SSM document with the specified instances.
|
CreateDocumentResult |
createDocument(CreateDocumentRequest request)
Creates an SSM document.
|
DeleteAssociationResult |
deleteAssociation(DeleteAssociationRequest request)
Disassociates the specified SSM document from the specified instance.
|
DeleteDocumentResult |
deleteDocument(DeleteDocumentRequest request)
Deletes the SSM document and all instance associations to the document.
|
DescribeAssociationResult |
describeAssociation(DescribeAssociationRequest request)
Describes the associations for the specified SSM document or instance.
|
DescribeDocumentResult |
describeDocument(DescribeDocumentRequest request)
Describes the specified SSM document.
|
DescribeInstanceInformationResult |
describeInstanceInformation(DescribeInstanceInformationRequest request)
Describes one or more of your instances.
|
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 request)
Gets the contents of the specified SSM document.
|
ListAssociationsResult |
listAssociations(ListAssociationsRequest request)
Lists the associations for the specified SSM document or instance.
|
ListCommandInvocationsResult |
listCommandInvocations(ListCommandInvocationsRequest request)
An invocation is copy of a command sent to a specific instance.
|
ListCommandsResult |
listCommands(ListCommandsRequest request)
Lists the commands requested by users of the AWS account.
|
ListDocumentsResult |
listDocuments()
Simplified method form for invoking the ListDocuments operation.
|
ListDocumentsResult |
listDocuments(ListDocumentsRequest request)
Describes one or more of your SSM documents.
|
SendCommandResult |
sendCommand(SendCommandRequest request)
Executes commands on one or more remote instances.
|
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
AWSSimpleSystemsManagement.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 request)
Updates the status of the SSM document associated with the specified
instance.
|
public void setEndpoint(String endpoint)
AWSSimpleSystemsManagement
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.
setEndpoint in interface AWSSimpleSystemsManagementendpoint - 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.public void setRegion(Region region)
AWSSimpleSystemsManagementAWSSimpleSystemsManagement.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.
setRegion in interface AWSSimpleSystemsManagementregion - 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)public CancelCommandResult cancelCommand(CancelCommandRequest request)
AWSSimpleSystemsManagementAttempts to cancel the command specified by the Command ID. There is no guarantee that the command will be terminated and the underlying process stopped.
cancelCommand in interface AWSSimpleSystemsManagementpublic CreateAssociationResult createAssociation(CreateAssociationRequest request)
AWSSimpleSystemsManagementAssociates the specified SSM document with the specified instance.
When you associate an SSM document with an instance, the configuration agent on the instance processes the document and configures the instance as specified.
If you associate a document with an instance that already has an associated document, the system throws the AssociationAlreadyExists exception.
createAssociation in interface AWSSimpleSystemsManagementpublic CreateAssociationBatchResult createAssociationBatch(CreateAssociationBatchRequest request)
AWSSimpleSystemsManagementAssociates the specified SSM document with the specified instances.
When you associate an SSM document with an instance, the configuration agent on the instance processes the document and configures the instance as specified.
If you associate a document with an instance that already has an associated document, the system throws the AssociationAlreadyExists exception.
createAssociationBatch in interface AWSSimpleSystemsManagementpublic CreateDocumentResult createDocument(CreateDocumentRequest request)
AWSSimpleSystemsManagementCreates an SSM document.
After you create an SSM document, you can use CreateAssociation to associate it with one or more running instances.
createDocument in interface AWSSimpleSystemsManagementpublic DeleteAssociationResult deleteAssociation(DeleteAssociationRequest request)
AWSSimpleSystemsManagementDisassociates the specified SSM document from the specified instance.
When you disassociate an SSM 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 document, you must create a new document with the desired configuration and associate it with the instance.
deleteAssociation in interface AWSSimpleSystemsManagementpublic DeleteDocumentResult deleteDocument(DeleteDocumentRequest request)
AWSSimpleSystemsManagementDeletes the SSM document and all instance associations to the document.
Before you delete the SSM document, we recommend that you use DeleteAssociation to disassociate all instances that are associated with the document.
deleteDocument in interface AWSSimpleSystemsManagementpublic DescribeAssociationResult describeAssociation(DescribeAssociationRequest request)
AWSSimpleSystemsManagementDescribes the associations for the specified SSM document or instance.
describeAssociation in interface AWSSimpleSystemsManagementpublic DescribeDocumentResult describeDocument(DescribeDocumentRequest request)
AWSSimpleSystemsManagementDescribes the specified SSM document.
describeDocument in interface AWSSimpleSystemsManagementpublic DescribeInstanceInformationResult describeInstanceInformation(DescribeInstanceInformationRequest request)
AWSSimpleSystemsManagementdescribeInstanceInformation in interface AWSSimpleSystemsManagementpublic GetDocumentResult getDocument(GetDocumentRequest request)
AWSSimpleSystemsManagementGets the contents of the specified SSM document.
getDocument in interface AWSSimpleSystemsManagementpublic ListAssociationsResult listAssociations(ListAssociationsRequest request)
AWSSimpleSystemsManagementLists the associations for the specified SSM document or instance.
listAssociations in interface AWSSimpleSystemsManagementpublic ListCommandInvocationsResult listCommandInvocations(ListCommandInvocationsRequest request)
AWSSimpleSystemsManagementlistCommandInvocations in interface AWSSimpleSystemsManagementpublic ListCommandsResult listCommands(ListCommandsRequest request)
AWSSimpleSystemsManagementLists the commands requested by users of the AWS account.
listCommands in interface AWSSimpleSystemsManagementpublic ListDocumentsResult listDocuments(ListDocumentsRequest request)
AWSSimpleSystemsManagementDescribes one or more of your SSM documents.
listDocuments in interface AWSSimpleSystemsManagementpublic ListDocumentsResult listDocuments()
AWSSimpleSystemsManagementlistDocuments in interface AWSSimpleSystemsManagementAWSSimpleSystemsManagement.listDocuments(ListDocumentsRequest)public SendCommandResult sendCommand(SendCommandRequest request)
AWSSimpleSystemsManagementsendCommand in interface AWSSimpleSystemsManagementpublic UpdateAssociationStatusResult updateAssociationStatus(UpdateAssociationStatusRequest request)
AWSSimpleSystemsManagementUpdates the status of the SSM document associated with the specified instance.
updateAssociationStatus in interface AWSSimpleSystemsManagementpublic void shutdown()
AWSSimpleSystemsManagementshutdown in interface AWSSimpleSystemsManagementpublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSSimpleSystemsManagementResponse 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.
getCachedResponseMetadata in interface AWSSimpleSystemsManagementrequest - The originally executed request.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.