com.amazonaws.services.simplesystemsmanagement

Class AbstractAWSSimpleSystemsManagement

java.lang.Object

com.amazonaws.services.simplesystemsmanagement.AbstractAWSSimpleSystemsManagement

All Implemented Interfaces:

AWSSimpleSystemsManagement

Direct Known Subclasses:

AbstractAWSSimpleSystemsManagementAsync

public class AbstractAWSSimpleSystemsManagement
extends Object
implements AWSSimpleSystemsManagement

Abstract implementation of AWSSimpleSystemsManagement. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary

Fields inherited from interface com.amazonaws.services.simplesystemsmanagement.AWSSimpleSystemsManagement

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
AddTagsToResourceResult	addTagsToResource(AddTagsToResourceRequest request) Adds or overwrites one or more tags for the specified resource.
CancelCommandResult	cancelCommand(CancelCommandRequest request) Attempts to cancel the command specified by the Command ID.
CreateActivationResult	createActivation(CreateActivationRequest request) Registers your on-premises server or virtual machine with Amazon EC2 so that you can manage these resources using Run Command.
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.
DeleteActivationResult	deleteActivation(DeleteActivationRequest request) Deletes an activation.
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.
DeregisterManagedInstanceResult	deregisterManagedInstance(DeregisterManagedInstanceRequest request) Removes the server or virtual machine from the list of registered servers.
DescribeActivationsResult	describeActivations(DescribeActivationsRequest request) Details about the activation, including: the date and time the activation was created, the expiration date, the IAM role assigned to the instances in the activation, and the number of instances activated by this registration.
DescribeAssociationResult	describeAssociation(DescribeAssociationRequest request) Describes the associations for the specified SSM document or instance.
DescribeDocumentResult	describeDocument(DescribeDocumentRequest request) Describes the specified SSM document.
DescribeDocumentPermissionResult	describeDocumentPermission(DescribeDocumentPermissionRequest request) Describes the permissions for an 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.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) Returns a list of the tags assigned to the specified resource.
ModifyDocumentPermissionResult	modifyDocumentPermission(ModifyDocumentPermissionRequest request) Share a document publicly or privately.
RemoveTagsFromResourceResult	removeTagsFromResource(RemoveTagsFromResourceRequest request) Removes all tags from the specified resource.
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.
UpdateManagedInstanceRoleResult	updateManagedInstanceRole(UpdateManagedInstanceRoleRequest request) Assigns or changes an Amazon Identity and Access Management (IAM) role to the managed instance.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

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

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

public void setRegion(Region region)

Description copied from interface: AWSSimpleSystemsManagement

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

Parameters:

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.

See Also:

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

addTagsToResource

public AddTagsToResourceResult addTagsToResource(AddTagsToResourceRequest request)

Description copied from interface: AWSSimpleSystemsManagement

Adds or overwrites one or more tags for the specified resource. Tags are metadata that you assign to your managed instances. Tags enable you to categorize your managed instances in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define. For example, you could define a set of tags for your account's managed instances that helps you track each instance's owner and stack level. For example: Key=Owner and Value=DbAdmin, SysAdmin, or Dev. Or Key=Stack and Value=Production, Pre-Production, or Test. Each resource can have a maximum of 10 tags.

We recommend that you devise a set of tag keys that meets your needs for each resource type. Using a consistent set of tag keys makes it easier for you to manage your resources. You can search and filter the resources based on the tags you add. Tags don't have any semantic meaning to Amazon EC2 and are interpreted strictly as a string of characters.

For more information about tags, see Tagging Your Amazon EC2 Resources in the Amazon EC2 User Guide.

Specified by:

addTagsToResource in interface AWSSimpleSystemsManagement

Returns:

Result of the AddTagsToResource operation returned by the service.

cancelCommand

public CancelCommandResult cancelCommand(CancelCommandRequest request)

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 interface AWSSimpleSystemsManagement

Returns:

Result of the CancelCommand operation returned by the service.

createActivation

public CreateActivationResult createActivation(CreateActivationRequest request)

Description copied from interface: AWSSimpleSystemsManagement

Registers your on-premises server or virtual machine with Amazon EC2 so that you can manage these resources using Run Command. An on-premises server or virtual machine that has been registered with EC2 is called a managed instance. For more information about activations, see Setting Up Managed Instances (Linux) or Setting Up Managed Instances (Windows) in the Amazon EC2 User Guide.

Specified by:

createActivation in interface AWSSimpleSystemsManagement

Returns:

Result of the CreateActivation operation returned by the service.

createAssociation

public CreateAssociationResult createAssociation(CreateAssociationRequest request)

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 interface AWSSimpleSystemsManagement

Returns:

Result of the CreateAssociation operation returned by the service.

createAssociationBatch

public CreateAssociationBatchResult createAssociationBatch(CreateAssociationBatchRequest request)

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 interface AWSSimpleSystemsManagement

Returns:

Result of the CreateAssociationBatch operation returned by the service.

createDocument

public CreateDocumentResult createDocument(CreateDocumentRequest request)

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 interface AWSSimpleSystemsManagement

Returns:

Result of the CreateDocument operation returned by the service.

deleteActivation

public DeleteActivationResult deleteActivation(DeleteActivationRequest request)

Description copied from interface: AWSSimpleSystemsManagement

Deletes an activation. You are not required to delete an activation. If you delete an activation, you can no longer use it to register additional managed instances. Deleting an activation does not de-register managed instances. You must manually de-register managed instances.

Specified by:

deleteActivation in interface AWSSimpleSystemsManagement

Returns:

Result of the DeleteActivation operation returned by the service.

deleteAssociation

public DeleteAssociationResult deleteAssociation(DeleteAssociationRequest request)

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 interface AWSSimpleSystemsManagement

Returns:

Result of the DeleteAssociation operation returned by the service.

deleteDocument

public DeleteDocumentResult deleteDocument(DeleteDocumentRequest request)

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 interface AWSSimpleSystemsManagement

Returns:

Result of the DeleteDocument operation returned by the service.

deregisterManagedInstance

public DeregisterManagedInstanceResult deregisterManagedInstance(DeregisterManagedInstanceRequest request)

Description copied from interface: AWSSimpleSystemsManagement

Removes the server or virtual machine from the list of registered servers. You can reregister the instance again at any time. If you don’t plan to use Run Command on the server, we suggest uninstalling the SSM agent first.

Specified by:

deregisterManagedInstance in interface AWSSimpleSystemsManagement

Returns:

Result of the DeregisterManagedInstance operation returned by the service.

describeActivations

public DescribeActivationsResult describeActivations(DescribeActivationsRequest request)

Description copied from interface: AWSSimpleSystemsManagement

Details about the activation, including: the date and time the activation was created, the expiration date, the IAM role assigned to the instances in the activation, and the number of instances activated by this registration.

Specified by:

describeActivations in interface AWSSimpleSystemsManagement

Returns:

Result of the DescribeActivations operation returned by the service.

describeAssociation

public DescribeAssociationResult describeAssociation(DescribeAssociationRequest request)

Description copied from interface: AWSSimpleSystemsManagement

Describes the associations for the specified SSM document or instance.

Specified by:

describeAssociation in interface AWSSimpleSystemsManagement

Returns:

Result of the DescribeAssociation operation returned by the service.

describeDocument

public DescribeDocumentResult describeDocument(DescribeDocumentRequest request)

Description copied from interface: AWSSimpleSystemsManagement

Describes the specified SSM document.

Specified by:

describeDocument in interface AWSSimpleSystemsManagement

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 interface AWSSimpleSystemsManagement

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 interface AWSSimpleSystemsManagement

Returns:

Result of the DescribeInstanceInformation operation returned by the service.

getDocument

public GetDocumentResult getDocument(GetDocumentRequest request)

Description copied from interface: AWSSimpleSystemsManagement

Gets the contents of the specified SSM document.

Specified by:

getDocument in interface AWSSimpleSystemsManagement

Returns:

Result of the GetDocument operation returned by the service.

listAssociations

public ListAssociationsResult listAssociations(ListAssociationsRequest request)

Description copied from interface: AWSSimpleSystemsManagement

Lists the associations for the specified SSM document or instance.

Specified by:

listAssociations in interface AWSSimpleSystemsManagement

Returns:

Result of the ListAssociations operation returned by the service.

listCommandInvocations

public ListCommandInvocationsResult listCommandInvocations(ListCommandInvocationsRequest request)

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 interface AWSSimpleSystemsManagement

Returns:

Result of the ListCommandInvocations operation returned by the service.

listCommands

public ListCommandsResult listCommands(ListCommandsRequest request)

Description copied from interface: AWSSimpleSystemsManagement

Lists the commands requested by users of the AWS account.

Specified by:

listCommands in interface AWSSimpleSystemsManagement

Returns:

Result of the ListCommands operation returned by the service.

listDocuments

public ListDocumentsResult listDocuments(ListDocumentsRequest request)

Description copied from interface: AWSSimpleSystemsManagement

Describes one or more of your SSM documents.

Specified by:

listDocuments in interface AWSSimpleSystemsManagement

Returns:

Result of the ListDocuments operation returned by the service.

listDocuments

public ListDocumentsResult listDocuments()

Description copied from interface: AWSSimpleSystemsManagement

Simplified method form for invoking the ListDocuments operation.

Specified by:

listDocuments in interface AWSSimpleSystemsManagement

See Also:

AWSSimpleSystemsManagement.listDocuments(ListDocumentsRequest)

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

Description copied from interface: AWSSimpleSystemsManagement

Returns a list of the tags assigned to the specified resource.

Specified by:

listTagsForResource in interface AWSSimpleSystemsManagement

Returns:

Result of the ListTagsForResource operation returned by the service.

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 interface AWSSimpleSystemsManagement

Returns:

Result of the ModifyDocumentPermission operation returned by the service.

removeTagsFromResource

public RemoveTagsFromResourceResult removeTagsFromResource(RemoveTagsFromResourceRequest request)

Description copied from interface: AWSSimpleSystemsManagement

Removes all tags from the specified resource.

Specified by:

removeTagsFromResource in interface AWSSimpleSystemsManagement

Returns:

Result of the RemoveTagsFromResource operation returned by the service.

sendCommand

public SendCommandResult sendCommand(SendCommandRequest request)

Description copied from interface: AWSSimpleSystemsManagement

Executes commands on one or more remote instances.

Specified by:

sendCommand in interface AWSSimpleSystemsManagement

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 interface AWSSimpleSystemsManagement

Returns:

Result of the UpdateAssociationStatus operation returned by the service.

updateManagedInstanceRole

public UpdateManagedInstanceRoleResult updateManagedInstanceRole(UpdateManagedInstanceRoleRequest request)

Description copied from interface: AWSSimpleSystemsManagement

Assigns or changes an Amazon Identity and Access Management (IAM) role to the managed instance.

Specified by:

updateManagedInstanceRole in interface AWSSimpleSystemsManagement

Returns:

Result of the UpdateManagedInstanceRole 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 interface AWSSimpleSystemsManagement

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

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 interface AWSSimpleSystemsManagement

Parameters:

request - The originally executed request.

Returns:

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