Class AbstractAWSSimpleSystemsManagement
- All Implemented Interfaces:
AWSSimpleSystemsManagement
- Direct Known Subclasses:
AbstractAWSSimpleSystemsManagementAsync
AWSSimpleSystemsManagement
. Convenient
method forms pass through to the corresponding overload that takes a request
object, which throws an UnsupportedOperationException
.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncancelCommand
(CancelCommandRequest request) Attempts to cancel the command specified by the Command ID.Associates the specified SSM document with the specified instance.Associates the specified SSM document with the specified instances.createDocument
(CreateDocumentRequest request) Creates an SSM document.Disassociates the specified SSM document from the specified instance.deleteDocument
(DeleteDocumentRequest request) Deletes the SSM document and all instance associations to the document.Describes the associations for the specified SSM document or instance.describeDocument
(DescribeDocumentRequest request) Describes the specified SSM document.Describes the permissions for an SSM document.Describes one or more of your instances.Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.getDocument
(GetDocumentRequest request) Gets the contents of the specified SSM document.listAssociations
(ListAssociationsRequest request) Lists the associations for the specified SSM document or instance.An invocation is copy of a command sent to a specific instance.listCommands
(ListCommandsRequest request) Lists the commands requested by users of the AWS account.Simplified method form for invoking the ListDocuments operation.listDocuments
(ListDocumentsRequest request) Describes one or more of your SSM documents.Share a document publicly or privately.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
An alternative toAWSSimpleSystemsManagement.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.Updates the status of the SSM document associated with the specified instance.
-
Constructor Details
-
AbstractAWSSimpleSystemsManagement
protected AbstractAWSSimpleSystemsManagement()
-
-
Method Details
-
setEndpoint
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 interfaceAWSSimpleSystemsManagement
- 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.
-
setRegion
Description copied from interface:AWSSimpleSystemsManagement
An alternative toAWSSimpleSystemsManagement.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.
- Specified by:
setRegion
in interfaceAWSSimpleSystemsManagement
- Parameters:
region
- The region this client will communicate with. SeeRegion.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.- See Also:
-
cancelCommand
Description copied from interface:AWSSimpleSystemsManagement
Attempts to cancel the command specified by the Command ID. There is no guarantee that the command will be terminated and the underlying process stopped.
- Specified by:
cancelCommand
in interfaceAWSSimpleSystemsManagement
- Parameters:
request
-- Returns:
- Result of the CancelCommand operation returned by the service.
-
createAssociation
Description copied from interface:AWSSimpleSystemsManagement
Associates 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.
- Specified by:
createAssociation
in interfaceAWSSimpleSystemsManagement
- Parameters:
request
-- Returns:
- Result of the CreateAssociation operation returned by the service.
-
createAssociationBatch
Description copied from interface:AWSSimpleSystemsManagement
Associates 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.
- Specified by:
createAssociationBatch
in interfaceAWSSimpleSystemsManagement
- Parameters:
request
-- Returns:
- Result of the CreateAssociationBatch operation returned by the service.
-
createDocument
Description copied from interface:AWSSimpleSystemsManagement
Creates an SSM document.
After you create an SSM document, you can use CreateAssociation to associate it with one or more running instances.
- Specified by:
createDocument
in interfaceAWSSimpleSystemsManagement
- Parameters:
request
-- Returns:
- Result of the CreateDocument operation returned by the service.
-
deleteAssociation
Description copied from interface:AWSSimpleSystemsManagement
Disassociates 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.
- Specified by:
deleteAssociation
in interfaceAWSSimpleSystemsManagement
- Parameters:
request
-- Returns:
- Result of the DeleteAssociation operation returned by the service.
-
deleteDocument
Description copied from interface:AWSSimpleSystemsManagement
Deletes 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.
- Specified by:
deleteDocument
in interfaceAWSSimpleSystemsManagement
- Parameters:
request
-- Returns:
- Result of the DeleteDocument operation returned by the service.
-
describeAssociation
Description copied from interface:AWSSimpleSystemsManagement
Describes the associations for the specified SSM document or instance.
- Specified by:
describeAssociation
in interfaceAWSSimpleSystemsManagement
- Parameters:
request
-- Returns:
- Result of the DescribeAssociation operation returned by the service.
-
describeDocument
Description copied from interface:AWSSimpleSystemsManagement
Describes the specified SSM document.
- Specified by:
describeDocument
in interfaceAWSSimpleSystemsManagement
- Parameters:
request
-- Returns:
- Result of the DescribeDocument operation returned by the service.
-
describeDocumentPermission
public DescribeDocumentPermissionResult describeDocumentPermission(DescribeDocumentPermissionRequest request) Description copied from interface:AWSSimpleSystemsManagement
Describes the permissions for an SSM document. If you created the document, you are the owner. If a document is shared, it can either be shared privately (by specifying a user’s AWS account ID) or publicly (All).
- Specified by:
describeDocumentPermission
in interfaceAWSSimpleSystemsManagement
- Parameters:
request
-- Returns:
- Result of the DescribeDocumentPermission operation returned by the service.
-
describeInstanceInformation
public DescribeInstanceInformationResult describeInstanceInformation(DescribeInstanceInformationRequest request) Description copied from interface:AWSSimpleSystemsManagement
Describes one or more of your instances. You can use this to get information about instances like the operating system platform, the SSM agent version, status etc. If you specify one or more instance IDs, it returns information for those instances. If you do not specify instance IDs, it returns information for all your instances. If you specify an instance ID that is not valid or an instance that you do not own, you receive an error.
- Specified by:
describeInstanceInformation
in interfaceAWSSimpleSystemsManagement
- Parameters:
request
-- Returns:
- Result of the DescribeInstanceInformation operation returned by the service.
-
getDocument
Description copied from interface:AWSSimpleSystemsManagement
Gets the contents of the specified SSM document.
- Specified by:
getDocument
in interfaceAWSSimpleSystemsManagement
- Parameters:
request
-- Returns:
- Result of the GetDocument operation returned by the service.
-
listAssociations
Description copied from interface:AWSSimpleSystemsManagement
Lists the associations for the specified SSM document or instance.
- Specified by:
listAssociations
in interfaceAWSSimpleSystemsManagement
- Parameters:
request
-- Returns:
- Result of the ListAssociations operation returned by the service.
-
listCommandInvocations
Description copied from interface:AWSSimpleSystemsManagement
An invocation is copy of a command sent to a specific instance. A command can apply to one or more instances. A command invocation applies to one instance. For example, if a user executes SendCommand against three instances, then a command invocation is created for each requested instance ID. ListCommandInvocations provide status about command execution.
- Specified by:
listCommandInvocations
in interfaceAWSSimpleSystemsManagement
- Parameters:
request
-- Returns:
- Result of the ListCommandInvocations operation returned by the service.
-
listCommands
Description copied from interface:AWSSimpleSystemsManagement
Lists the commands requested by users of the AWS account.
- Specified by:
listCommands
in interfaceAWSSimpleSystemsManagement
- Parameters:
request
-- Returns:
- Result of the ListCommands operation returned by the service.
-
listDocuments
Description copied from interface:AWSSimpleSystemsManagement
Describes one or more of your SSM documents.
- Specified by:
listDocuments
in interfaceAWSSimpleSystemsManagement
- Parameters:
request
-- Returns:
- Result of the ListDocuments operation returned by the service.
-
listDocuments
Description copied from interface:AWSSimpleSystemsManagement
Simplified method form for invoking the ListDocuments operation.- Specified by:
listDocuments
in interfaceAWSSimpleSystemsManagement
- See Also:
-
modifyDocumentPermission
public ModifyDocumentPermissionResult modifyDocumentPermission(ModifyDocumentPermissionRequest request) Description copied from interface:AWSSimpleSystemsManagement
Share a document publicly or privately. If you share a document privately, you must specify the AWS user account IDs for those people who can use the document. If you share a document publicly, you must specify All as the account ID.
- Specified by:
modifyDocumentPermission
in interfaceAWSSimpleSystemsManagement
- Parameters:
request
-- Returns:
- Result of the ModifyDocumentPermission operation returned by the service.
-
sendCommand
Description copied from interface:AWSSimpleSystemsManagement
Executes commands on one or more remote instances.
- Specified by:
sendCommand
in interfaceAWSSimpleSystemsManagement
- Parameters:
request
-- Returns:
- Result of the SendCommand operation returned by the service.
-
updateAssociationStatus
public UpdateAssociationStatusResult updateAssociationStatus(UpdateAssociationStatusRequest request) Description copied from interface:AWSSimpleSystemsManagement
Updates the status of the SSM document associated with the specified instance.
- Specified by:
updateAssociationStatus
in interfaceAWSSimpleSystemsManagement
- Parameters:
request
-- Returns:
- Result of the UpdateAssociationStatus operation returned by the service.
-
shutdown
public void shutdown()Description copied from interface:AWSSimpleSystemsManagement
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.- Specified by:
shutdown
in interfaceAWSSimpleSystemsManagement
-
getCachedResponseMetadata
Description copied from interface:AWSSimpleSystemsManagement
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.
- Specified by:
getCachedResponseMetadata
in interfaceAWSSimpleSystemsManagement
- Parameters:
request
- The originally executed request.- Returns:
- The response metadata for the specified request, or null if none is available.
-