@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSSimpleSystemsManagementClient extends AmazonWebServiceClient implements AWSSimpleSystemsManagement
Amazon EC2 Systems Manager is a collection of capabilities that helps you automate management tasks such as collecting system inventory, applying operating system (OS) patches, automating the creation of Amazon Machine Images (AMIs), and configuring operating systems (OSs) and applications at scale. Systems Manager lets you remotely and securely manage the configuration of your managed instances. A managed instance is any Amazon EC2 instance or on-premises machine in your hybrid environment that has been configured for Systems Manager.
This reference is intended to be used with the Amazon EC2 Systems Manager User Guide.
To get started, verify prerequisites and configure managed instances. For more information, see Systems Manager Prerequisites.
For information about other API actions you can perform on Amazon EC2 instances, see the Amazon EC2 API Reference. For information about how to use a Query API, see Making API Requests.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIX| Constructor and Description |
|---|
AWSSimpleSystemsManagementClient()
Deprecated.
|
AWSSimpleSystemsManagementClient(AWSCredentials awsCredentials)
Deprecated.
use
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for
example:
AWSSimpleSystemsManagementClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build(); |
AWSSimpleSystemsManagementClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
|
AWSSimpleSystemsManagementClient(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AWSSimpleSystemsManagementClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AWSSimpleSystemsManagementClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
|
AWSSimpleSystemsManagementClient(ClientConfiguration clientConfiguration)
Deprecated.
|
addRequestHandler, addRequestHandler, configureRegion, getEndpointPrefix, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitsetEndpoint, setRegion, shutdown@Deprecated public AWSSimpleSystemsManagementClient()
AWSSimpleSystemsManagementClientBuilder.defaultClient()All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain@Deprecated public AWSSimpleSystemsManagementClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration - The client configuration options controlling how this client connects to Amazon SSM (ex: proxy settings,
retry counts, etc.).DefaultAWSCredentialsProviderChain@Deprecated public AWSSimpleSystemsManagementClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for
example:
AWSSimpleSystemsManagementClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.@Deprecated public AWSSimpleSystemsManagementClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.clientConfiguration - The client configuration options controlling how this client connects to Amazon SSM (ex: proxy settings,
retry counts, etc.).@Deprecated public AWSSimpleSystemsManagementClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.@Deprecated public AWSSimpleSystemsManagementClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration - The client configuration options controlling how this client connects to Amazon SSM (ex: proxy settings,
retry counts, etc.).@Deprecated public AWSSimpleSystemsManagementClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration) and
AwsClientBuilder.withMetricsCollector(RequestMetricCollector)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration - The client configuration options controlling how this client connects to Amazon SSM (ex: proxy settings,
retry counts, etc.).requestMetricCollector - optional request metric collectorpublic static AWSSimpleSystemsManagementClientBuilder builder()
public AddTagsToResourceResult addTagsToResource(AddTagsToResourceRequest request)
Adds or overwrites one or more tags for the specified resource. Tags are metadata that you can assign to your documents, managed instances, Maintenance Windows, Parameter Store parameters, and patch baselines. Tags enable you to categorize your resources 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.
addTagsToResource in interface AWSSimpleSystemsManagementaddTagsToResourceRequest - InvalidResourceTypeException - The resource type is not valid. For example, if you are attempting to tag an instance, the instance must
be a registered, managed instance.InvalidResourceIdException - The resource ID is not valid. Verify that you entered the correct ID and try again.InternalServerErrorException - An error occurred on the server side.TooManyTagsErrorException - The Targets parameter includes too many tags. Remove one or more tags and try the command again.public CancelCommandResult cancelCommand(CancelCommandRequest request)
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.
cancelCommand in interface AWSSimpleSystemsManagementcancelCommandRequest - InternalServerErrorException - An error occurred on the server side.InvalidCommandIdExceptionInvalidInstanceIdException - The following problems can cause this exception:
You do not have permission to access the instance.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
DuplicateInstanceIdException - You cannot specify an instance ID in more than one association.public 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. 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 Systems Manager in Hybrid Environments.
createActivation in interface AWSSimpleSystemsManagementcreateActivationRequest - InternalServerErrorException - An error occurred on the server side.public CreateAssociationResult createAssociation(CreateAssociationRequest request)
Associates the specified Systems Manager document with the specified instances or targets.
When you associate a document with one or more instances using instance IDs or tags, the SSM Agent running 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 AWSSimpleSystemsManagementcreateAssociationRequest - AssociationAlreadyExistsException - 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 specified document does not exist.InvalidDocumentVersionException - The document version is not valid or does not exist.InvalidInstanceIdException - The following problems can cause this exception:
You do not have permission to access the instance.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
UnsupportedPlatformTypeException - The document does not support the platform type of the given instance ID(s). For example, you sent an
document for a Windows instance to a Linux instance.InvalidOutputLocationException - The output location is not valid or does not exist.InvalidParametersException - You must specify values for all required parameters in the Systems Manager document. You can only supply
values to parameters defined in the Systems Manager document.InvalidTargetException - The target is not valid or does not exist. It might not be configured for EC2 Systems Manager or you
might not have permission to perform the operation.InvalidScheduleException - The schedule is invalid. Verify your cron or rate expression and try again.public CreateAssociationBatchResult createAssociationBatch(CreateAssociationBatchRequest request)
Associates the specified Systems Manager document with the specified instances or targets.
When you associate a document with one or more instances using instance IDs or tags, the SSM Agent running 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 AWSSimpleSystemsManagementcreateAssociationBatchRequest - InternalServerErrorException - An error occurred on the server side.InvalidDocumentException - The specified document does not exist.InvalidDocumentVersionException - The document version is not valid or does not exist.InvalidInstanceIdException - The following problems can cause this exception:
You do not have permission to access the instance.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
InvalidParametersException - You must specify values for all required parameters in the Systems Manager document. You can only supply
values to parameters defined in the Systems Manager document.DuplicateInstanceIdException - You cannot specify an instance ID in more than one association.AssociationLimitExceededException - You can have at most 2,000 active associations.UnsupportedPlatformTypeException - The document does not support the platform type of the given instance ID(s). For example, you sent an
document for a Windows instance to a Linux instance.InvalidOutputLocationException - The output location is not valid or does not exist.InvalidTargetException - The target is not valid or does not exist. It might not be configured for EC2 Systems Manager or you
might not have permission to perform the operation.InvalidScheduleException - The schedule is invalid. Verify your cron or rate expression and try again.public CreateDocumentResult createDocument(CreateDocumentRequest request)
Creates a Systems Manager document.
After you create a document, you can use CreateAssociation to associate it with one or more running instances.
createDocument in interface AWSSimpleSystemsManagementcreateDocumentRequest - DocumentAlreadyExistsException - The specified document already exists.MaxDocumentSizeExceededException - The size limit of a document is 64 KB.InternalServerErrorException - An error occurred on the server side.InvalidDocumentContentException - The content for the document is not valid.DocumentLimitExceededException - You can have at most 200 active Systems Manager documents.InvalidDocumentSchemaVersionException - The version of the document schema is not supported.public CreateMaintenanceWindowResult createMaintenanceWindow(CreateMaintenanceWindowRequest request)
Creates a new Maintenance Window.
createMaintenanceWindow in interface AWSSimpleSystemsManagementcreateMaintenanceWindowRequest - IdempotentParameterMismatchException - Error returned when an idempotent operation is retried and the parameters don't match the original call
to the API with the same idempotency token.ResourceLimitExceededException - Error returned when the caller has exceeded the default resource limits (e.g. too many Maintenance
Windows have been created).InternalServerErrorException - An error occurred on the server side.public CreatePatchBaselineResult createPatchBaseline(CreatePatchBaselineRequest request)
Creates a patch baseline.
createPatchBaseline in interface AWSSimpleSystemsManagementcreatePatchBaselineRequest - IdempotentParameterMismatchException - Error returned when an idempotent operation is retried and the parameters don't match the original call
to the API with the same idempotency token.ResourceLimitExceededException - Error returned when the caller has exceeded the default resource limits (e.g. too many Maintenance
Windows have been created).InternalServerErrorException - An error occurred on the server side.public CreateResourceDataSyncResult createResourceDataSync(CreateResourceDataSyncRequest request)
Creates a resource data sync configuration to a single bucket in Amazon S3. This is an asynchronous operation that returns immediately. After a successful initial sync is completed, the system continuously syncs data to the Amazon S3 bucket. To check the status of the sync, use the ListResourceDataSync operation.
By default, data is not encrypted in Amazon S3. We strongly recommend that you enable encryption in Amazon S3 to ensure secure data storage. We also recommend that you secure access to the Amazon S3 bucket by creating a restrictive bucket policy. To view an example of a restrictive Amazon S3 bucket policy for Resource Data Sync, see Configuring Resource Data Sync for Inventory.
createResourceDataSync in interface AWSSimpleSystemsManagementcreateResourceDataSyncRequest - InternalServerErrorException - An error occurred on the server side.ResourceDataSyncCountExceededException - You have exceeded the allowed maximum sync configurations.ResourceDataSyncAlreadyExistsException - A sync configuration with the same name already exists.ResourceDataSyncInvalidConfigurationException - The specified sync configuration is invalid.public DeleteActivationResult deleteActivation(DeleteActivationRequest request)
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.
deleteActivation in interface AWSSimpleSystemsManagementdeleteActivationRequest - InvalidActivationIdException - The activation ID is not valid. Verify the you entered the correct ActivationId or ActivationCode and try
again.InvalidActivationException - The activation is not valid. The activation might have been deleted, or the ActivationId and the
ActivationCode do not match.InternalServerErrorException - An error occurred on the server side.TooManyUpdatesException - There are concurrent updates for a resource that supports one update at a time.public DeleteAssociationResult deleteAssociation(DeleteAssociationRequest request)
Disassociates the specified Systems Manager document from the specified instance.
When you disassociate a 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 AWSSimpleSystemsManagementdeleteAssociationRequest - AssociationDoesNotExistException - The specified association does not exist.InternalServerErrorException - An error occurred on the server side.InvalidDocumentException - The specified document does not exist.InvalidInstanceIdException - The following problems can cause this exception:
You do not have permission to access the instance.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
TooManyUpdatesException - There are concurrent updates for a resource that supports one update at a time.public DeleteDocumentResult deleteDocument(DeleteDocumentRequest request)
Deletes the Systems Manager document and all instance associations to the document.
Before you delete the document, we recommend that you use DeleteAssociation to disassociate all instances that are associated with the document.
deleteDocument in interface AWSSimpleSystemsManagementdeleteDocumentRequest - InternalServerErrorException - An error occurred on the server side.InvalidDocumentException - The specified document does not exist.InvalidDocumentOperationException - You attempted to delete a document while it is still shared. You must stop sharing the document before
you can delete it.AssociatedInstancesException - You must disassociate a document from all instances before you can delete it.public DeleteMaintenanceWindowResult deleteMaintenanceWindow(DeleteMaintenanceWindowRequest request)
Deletes a Maintenance Window.
deleteMaintenanceWindow in interface AWSSimpleSystemsManagementdeleteMaintenanceWindowRequest - InternalServerErrorException - An error occurred on the server side.public DeleteParameterResult deleteParameter(DeleteParameterRequest request)
Delete a parameter from the system.
deleteParameter in interface AWSSimpleSystemsManagementdeleteParameterRequest - InternalServerErrorException - An error occurred on the server side.ParameterNotFoundException - The parameter could not be found. Verify the name and try again.public DeleteParametersResult deleteParameters(DeleteParametersRequest request)
Delete a list of parameters. This API is used to delete parameters by using the Amazon EC2 console.
deleteParameters in interface AWSSimpleSystemsManagementdeleteParametersRequest - InternalServerErrorException - An error occurred on the server side.public DeletePatchBaselineResult deletePatchBaseline(DeletePatchBaselineRequest request)
Deletes a patch baseline.
deletePatchBaseline in interface AWSSimpleSystemsManagementdeletePatchBaselineRequest - ResourceInUseException - Error returned if an attempt is made to delete a patch baseline that is registered for a patch group.InternalServerErrorException - An error occurred on the server side.public DeleteResourceDataSyncResult deleteResourceDataSync(DeleteResourceDataSyncRequest request)
Deletes a Resource Data Sync configuration. After the configuration is deleted, changes to inventory data on managed instances are no longer synced with the target Amazon S3 bucket. Deleting a sync configuration does not delete data in the target Amazon S3 bucket.
deleteResourceDataSync in interface AWSSimpleSystemsManagementdeleteResourceDataSyncRequest - InternalServerErrorException - An error occurred on the server side.ResourceDataSyncNotFoundException - The specified sync name was not found.public DeregisterManagedInstanceResult deregisterManagedInstance(DeregisterManagedInstanceRequest request)
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.
deregisterManagedInstance in interface AWSSimpleSystemsManagementderegisterManagedInstanceRequest - InvalidInstanceIdException - The following problems can cause this exception:
You do not have permission to access the instance.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
InternalServerErrorException - An error occurred on the server side.public DeregisterPatchBaselineForPatchGroupResult deregisterPatchBaselineForPatchGroup(DeregisterPatchBaselineForPatchGroupRequest request)
Removes a patch group from a patch baseline.
deregisterPatchBaselineForPatchGroup in interface AWSSimpleSystemsManagementderegisterPatchBaselineForPatchGroupRequest - InvalidResourceIdException - The resource ID is not valid. Verify that you entered the correct ID and try again.InternalServerErrorException - An error occurred on the server side.public DeregisterTargetFromMaintenanceWindowResult deregisterTargetFromMaintenanceWindow(DeregisterTargetFromMaintenanceWindowRequest request)
Removes a target from a Maintenance Window.
deregisterTargetFromMaintenanceWindow in interface AWSSimpleSystemsManagementderegisterTargetFromMaintenanceWindowRequest - DoesNotExistException - Error returned when the ID specified for a resource (e.g. a Maintenance Window) doesn't exist.InternalServerErrorException - An error occurred on the server side.TargetInUseException - You specified the Safe option for the DeregisterTargetFromMaintenanceWindow operation, but
the target is still referenced in a task.public DeregisterTaskFromMaintenanceWindowResult deregisterTaskFromMaintenanceWindow(DeregisterTaskFromMaintenanceWindowRequest request)
Removes a task from a Maintenance Window.
deregisterTaskFromMaintenanceWindow in interface AWSSimpleSystemsManagementderegisterTaskFromMaintenanceWindowRequest - DoesNotExistException - Error returned when the ID specified for a resource (e.g. a Maintenance Window) doesn't exist.InternalServerErrorException - An error occurred on the server side.public 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.
describeActivations in interface AWSSimpleSystemsManagementdescribeActivationsRequest - InvalidFilterException - The filter name is not valid. Verify the you entered the correct name and try again.InvalidNextTokenException - The specified token is not valid.InternalServerErrorException - An error occurred on the server side.public DescribeAssociationResult describeAssociation(DescribeAssociationRequest request)
Describes the associations for the specified Systems Manager document or instance.
describeAssociation in interface AWSSimpleSystemsManagementdescribeAssociationRequest - AssociationDoesNotExistException - The specified association does not exist.InvalidAssociationVersionException - The version you specified is not valid. Use ListAssociationVersions to view all versions of an
association according to the association ID. Or, use the $LATEST parameter to view the
latest version of the association.InternalServerErrorException - An error occurred on the server side.InvalidDocumentException - The specified document does not exist.InvalidInstanceIdException - The following problems can cause this exception:
You do not have permission to access the instance.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
public DescribeAutomationExecutionsResult describeAutomationExecutions(DescribeAutomationExecutionsRequest request)
Provides details about all active and terminated Automation executions.
describeAutomationExecutions in interface AWSSimpleSystemsManagementdescribeAutomationExecutionsRequest - InvalidNextTokenException - The specified token is not valid.InternalServerErrorException - An error occurred on the server side.public DescribeAvailablePatchesResult describeAvailablePatches(DescribeAvailablePatchesRequest request)
Lists all patches that could possibly be included in a patch baseline.
describeAvailablePatches in interface AWSSimpleSystemsManagementdescribeAvailablePatchesRequest - InternalServerErrorException - An error occurred on the server side.public DescribeDocumentResult describeDocument(DescribeDocumentRequest request)
Describes the specified Systems Manager document.
describeDocument in interface AWSSimpleSystemsManagementdescribeDocumentRequest - InternalServerErrorException - An error occurred on the server side.InvalidDocumentException - The specified document does not exist.InvalidDocumentVersionException - The document version is not valid or does not exist.public DescribeDocumentPermissionResult describeDocumentPermission(DescribeDocumentPermissionRequest request)
Describes the permissions for a Systems Manager 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).
describeDocumentPermission in interface AWSSimpleSystemsManagementdescribeDocumentPermissionRequest - InternalServerErrorException - An error occurred on the server side.InvalidDocumentException - The specified document does not exist.InvalidPermissionTypeException - The permission type is not supported. Share is the only supported permission type.public DescribeEffectiveInstanceAssociationsResult describeEffectiveInstanceAssociations(DescribeEffectiveInstanceAssociationsRequest request)
All associations for the instance(s).
describeEffectiveInstanceAssociations in interface AWSSimpleSystemsManagementdescribeEffectiveInstanceAssociationsRequest - InternalServerErrorException - An error occurred on the server side.InvalidInstanceIdException - The following problems can cause this exception:
You do not have permission to access the instance.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
InvalidNextTokenException - The specified token is not valid.public DescribeEffectivePatchesForPatchBaselineResult describeEffectivePatchesForPatchBaseline(DescribeEffectivePatchesForPatchBaselineRequest request)
Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline. Note that this API applies only to Windows patch baselines.
describeEffectivePatchesForPatchBaseline in interface AWSSimpleSystemsManagementdescribeEffectivePatchesForPatchBaselineRequest - InvalidResourceIdException - The resource ID is not valid. Verify that you entered the correct ID and try again.DoesNotExistException - Error returned when the ID specified for a resource (e.g. a Maintenance Window) doesn't exist.UnsupportedOperatingSystemException - The operating systems you specified is not supported, or the operation is not supported for the operating
system. Valid operating systems include: Windows, AmazonLinux, RedhatEnterpriseLinux, and Ubuntu.InternalServerErrorException - An error occurred on the server side.public DescribeInstanceAssociationsStatusResult describeInstanceAssociationsStatus(DescribeInstanceAssociationsStatusRequest request)
The status of the associations for the instance(s).
describeInstanceAssociationsStatus in interface AWSSimpleSystemsManagementdescribeInstanceAssociationsStatusRequest - InternalServerErrorException - An error occurred on the server side.InvalidInstanceIdException - The following problems can cause this exception:
You do not have permission to access the instance.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
InvalidNextTokenException - The specified token is not valid.public DescribeInstanceInformationResult describeInstanceInformation(DescribeInstanceInformationRequest request)
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 (Linux), 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.
describeInstanceInformation in interface AWSSimpleSystemsManagementdescribeInstanceInformationRequest - InternalServerErrorException - An error occurred on the server side.InvalidInstanceIdException - The following problems can cause this exception:
You do not have permission to access the instance.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
InvalidNextTokenException - The specified token is not valid.InvalidInstanceInformationFilterValueException - The specified filter value is not valid.InvalidFilterKeyException - The specified key is not valid.public DescribeInstancePatchStatesResult describeInstancePatchStates(DescribeInstancePatchStatesRequest request)
Retrieves the high-level patch state of one or more instances.
describeInstancePatchStates in interface AWSSimpleSystemsManagementdescribeInstancePatchStatesRequest - InternalServerErrorException - An error occurred on the server side.InvalidNextTokenException - The specified token is not valid.public DescribeInstancePatchStatesForPatchGroupResult describeInstancePatchStatesForPatchGroup(DescribeInstancePatchStatesForPatchGroupRequest request)
Retrieves the high-level patch state for the instances in the specified patch group.
describeInstancePatchStatesForPatchGroup in interface AWSSimpleSystemsManagementdescribeInstancePatchStatesForPatchGroupRequest - InternalServerErrorException - An error occurred on the server side.InvalidFilterException - The filter name is not valid. Verify the you entered the correct name and try again.InvalidNextTokenException - The specified token is not valid.public DescribeInstancePatchesResult describeInstancePatches(DescribeInstancePatchesRequest request)
Retrieves information about the patches on the specified instance and their state relative to the patch baseline being used for the instance.
describeInstancePatches in interface AWSSimpleSystemsManagementdescribeInstancePatchesRequest - InternalServerErrorException - An error occurred on the server side.InvalidInstanceIdException - The following problems can cause this exception:
You do not have permission to access the instance.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
InvalidFilterException - The filter name is not valid. Verify the you entered the correct name and try again.InvalidNextTokenException - The specified token is not valid.public DescribeMaintenanceWindowExecutionTaskInvocationsResult describeMaintenanceWindowExecutionTaskInvocations(DescribeMaintenanceWindowExecutionTaskInvocationsRequest request)
Retrieves the individual task executions (one per target) for a particular task executed as part of a Maintenance Window execution.
describeMaintenanceWindowExecutionTaskInvocations in interface AWSSimpleSystemsManagementdescribeMaintenanceWindowExecutionTaskInvocationsRequest - DoesNotExistException - Error returned when the ID specified for a resource (e.g. a Maintenance Window) doesn't exist.InternalServerErrorException - An error occurred on the server side.public DescribeMaintenanceWindowExecutionTasksResult describeMaintenanceWindowExecutionTasks(DescribeMaintenanceWindowExecutionTasksRequest request)
For a given Maintenance Window execution, lists the tasks that were executed.
describeMaintenanceWindowExecutionTasks in interface AWSSimpleSystemsManagementdescribeMaintenanceWindowExecutionTasksRequest - DoesNotExistException - Error returned when the ID specified for a resource (e.g. a Maintenance Window) doesn't exist.InternalServerErrorException - An error occurred on the server side.public DescribeMaintenanceWindowExecutionsResult describeMaintenanceWindowExecutions(DescribeMaintenanceWindowExecutionsRequest request)
Lists the executions of a Maintenance Window. This includes information about when the Maintenance Window was scheduled to be active, and information about tasks registered and run with the Maintenance Window.
describeMaintenanceWindowExecutions in interface AWSSimpleSystemsManagementdescribeMaintenanceWindowExecutionsRequest - InternalServerErrorException - An error occurred on the server side.public DescribeMaintenanceWindowTargetsResult describeMaintenanceWindowTargets(DescribeMaintenanceWindowTargetsRequest request)
Lists the targets registered with the Maintenance Window.
describeMaintenanceWindowTargets in interface AWSSimpleSystemsManagementdescribeMaintenanceWindowTargetsRequest - DoesNotExistException - Error returned when the ID specified for a resource (e.g. a Maintenance Window) doesn't exist.InternalServerErrorException - An error occurred on the server side.public DescribeMaintenanceWindowTasksResult describeMaintenanceWindowTasks(DescribeMaintenanceWindowTasksRequest request)
Lists the tasks in a Maintenance Window.
describeMaintenanceWindowTasks in interface AWSSimpleSystemsManagementdescribeMaintenanceWindowTasksRequest - DoesNotExistException - Error returned when the ID specified for a resource (e.g. a Maintenance Window) doesn't exist.InternalServerErrorException - An error occurred on the server side.public DescribeMaintenanceWindowsResult describeMaintenanceWindows(DescribeMaintenanceWindowsRequest request)
Retrieves the Maintenance Windows in an AWS account.
describeMaintenanceWindows in interface AWSSimpleSystemsManagementdescribeMaintenanceWindowsRequest - InternalServerErrorException - An error occurred on the server side.public DescribeParametersResult describeParameters(DescribeParametersRequest request)
Get information about a parameter.
Request results are returned on a best-effort basis. If you specify MaxResults in the request, the
response includes information up to the limit specified. The number of items returned, however, can be between
zero and the value of MaxResults. If the service reaches an internal limit while processing the
results, it stops the operation and returns the matching values up to that point and a NextToken.
You can specify the NextToken in a subsequent call to get the next set of results.
describeParameters in interface AWSSimpleSystemsManagementdescribeParametersRequest - InternalServerErrorException - An error occurred on the server side.InvalidFilterKeyException - The specified key is not valid.InvalidFilterOptionException - The specified filter option is not valid. Valid options are Equals and BeginsWith. For Path filter, valid
options are Recursive and OneLevel.InvalidFilterValueException - The filter value is not valid. Verify the value and try again.InvalidNextTokenException - The specified token is not valid.public DescribePatchBaselinesResult describePatchBaselines(DescribePatchBaselinesRequest request)
Lists the patch baselines in your AWS account.
describePatchBaselines in interface AWSSimpleSystemsManagementdescribePatchBaselinesRequest - InternalServerErrorException - An error occurred on the server side.public DescribePatchGroupStateResult describePatchGroupState(DescribePatchGroupStateRequest request)
Returns high-level aggregated patch compliance state for a patch group.
describePatchGroupState in interface AWSSimpleSystemsManagementdescribePatchGroupStateRequest - InternalServerErrorException - An error occurred on the server side.InvalidNextTokenException - The specified token is not valid.public DescribePatchGroupsResult describePatchGroups(DescribePatchGroupsRequest request)
Lists all patch groups that have been registered with patch baselines.
describePatchGroups in interface AWSSimpleSystemsManagementdescribePatchGroupsRequest - InternalServerErrorException - An error occurred on the server side.public GetAutomationExecutionResult getAutomationExecution(GetAutomationExecutionRequest request)
Get detailed information about a particular Automation execution.
getAutomationExecution in interface AWSSimpleSystemsManagementgetAutomationExecutionRequest - AutomationExecutionNotFoundException - There is no automation execution information for the requested automation execution ID.InternalServerErrorException - An error occurred on the server side.public GetCommandInvocationResult getCommandInvocation(GetCommandInvocationRequest request)
Returns detailed information about command execution for an invocation or plugin.
getCommandInvocation in interface AWSSimpleSystemsManagementgetCommandInvocationRequest - InternalServerErrorException - An error occurred on the server side.InvalidCommandIdExceptionInvalidInstanceIdException - The following problems can cause this exception:
You do not have permission to access the instance.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
InvalidPluginNameException - The plugin name is not valid.InvocationDoesNotExistException - The command ID and instance ID you specified did not match any invocations. Verify the command ID adn the
instance ID and try again.public GetDefaultPatchBaselineResult getDefaultPatchBaseline(GetDefaultPatchBaselineRequest request)
Retrieves the default patch baseline. Note that Systems Manager supports creating multiple default patch baselines. For example, you can create a default patch baseline for each operating system.
getDefaultPatchBaseline in interface AWSSimpleSystemsManagementgetDefaultPatchBaselineRequest - InternalServerErrorException - An error occurred on the server side.public GetDeployablePatchSnapshotForInstanceResult getDeployablePatchSnapshotForInstance(GetDeployablePatchSnapshotForInstanceRequest request)
Retrieves the current snapshot for the patch baseline the instance uses. This API is primarily used by the AWS-RunPatchBaseline Systems Manager document.
getDeployablePatchSnapshotForInstance in interface AWSSimpleSystemsManagementgetDeployablePatchSnapshotForInstanceRequest - InternalServerErrorException - An error occurred on the server side.UnsupportedOperatingSystemException - The operating systems you specified is not supported, or the operation is not supported for the operating
system. Valid operating systems include: Windows, AmazonLinux, RedhatEnterpriseLinux, and Ubuntu.public GetDocumentResult getDocument(GetDocumentRequest request)
Gets the contents of the specified Systems Manager document.
getDocument in interface AWSSimpleSystemsManagementgetDocumentRequest - InternalServerErrorException - An error occurred on the server side.InvalidDocumentException - The specified document does not exist.InvalidDocumentVersionException - The document version is not valid or does not exist.public GetInventoryResult getInventory(GetInventoryRequest request)
Query inventory information.
getInventory in interface AWSSimpleSystemsManagementgetInventoryRequest - InternalServerErrorException - An error occurred on the server side.InvalidFilterException - The filter name is not valid. Verify the you entered the correct name and try again.InvalidNextTokenException - The specified token is not valid.InvalidTypeNameException - The parameter type name is not valid.InvalidResultAttributeException - The specified inventory item result attribute is not valid.public GetInventorySchemaResult getInventorySchema(GetInventorySchemaRequest request)
Return a list of inventory type names for the account, or return a list of attribute names for a specific Inventory item type.
getInventorySchema in interface AWSSimpleSystemsManagementgetInventorySchemaRequest - InternalServerErrorException - An error occurred on the server side.InvalidTypeNameException - The parameter type name is not valid.InvalidNextTokenException - The specified token is not valid.public GetMaintenanceWindowResult getMaintenanceWindow(GetMaintenanceWindowRequest request)
Retrieves a Maintenance Window.
getMaintenanceWindow in interface AWSSimpleSystemsManagementgetMaintenanceWindowRequest - DoesNotExistException - Error returned when the ID specified for a resource (e.g. a Maintenance Window) doesn't exist.InternalServerErrorException - An error occurred on the server side.public GetMaintenanceWindowExecutionResult getMaintenanceWindowExecution(GetMaintenanceWindowExecutionRequest request)
Retrieves details about a specific task executed as part of a Maintenance Window execution.
getMaintenanceWindowExecution in interface AWSSimpleSystemsManagementgetMaintenanceWindowExecutionRequest - DoesNotExistException - Error returned when the ID specified for a resource (e.g. a Maintenance Window) doesn't exist.InternalServerErrorException - An error occurred on the server side.public GetMaintenanceWindowExecutionTaskResult getMaintenanceWindowExecutionTask(GetMaintenanceWindowExecutionTaskRequest request)
Retrieves the details about a specific task executed as part of a Maintenance Window execution.
getMaintenanceWindowExecutionTask in interface AWSSimpleSystemsManagementgetMaintenanceWindowExecutionTaskRequest - DoesNotExistException - Error returned when the ID specified for a resource (e.g. a Maintenance Window) doesn't exist.InternalServerErrorException - An error occurred on the server side.public GetMaintenanceWindowExecutionTaskInvocationResult getMaintenanceWindowExecutionTaskInvocation(GetMaintenanceWindowExecutionTaskInvocationRequest request)
Retrieves a task invocation. A task invocation is a specific task executing on a specific target. Maintenance Windows report status for all invocations.
getMaintenanceWindowExecutionTaskInvocation in interface AWSSimpleSystemsManagementgetMaintenanceWindowExecutionTaskInvocationRequest - DoesNotExistException - Error returned when the ID specified for a resource (e.g. a Maintenance Window) doesn't exist.InternalServerErrorException - An error occurred on the server side.public GetMaintenanceWindowTaskResult getMaintenanceWindowTask(GetMaintenanceWindowTaskRequest request)
Lists the tasks in a Maintenance Window.
getMaintenanceWindowTask in interface AWSSimpleSystemsManagementgetMaintenanceWindowTaskRequest - DoesNotExistException - Error returned when the ID specified for a resource (e.g. a Maintenance Window) doesn't exist.InternalServerErrorException - An error occurred on the server side.public GetParameterResult getParameter(GetParameterRequest request)
Get information about a parameter by using the parameter name.
getParameter in interface AWSSimpleSystemsManagementgetParameterRequest - InternalServerErrorException - An error occurred on the server side.InvalidKeyIdException - The query key ID is not valid.ParameterNotFoundException - The parameter could not be found. Verify the name and try again.ParameterVersionNotFoundException - The specified parameter version was not found. Verify the parameter name and version, and try again.public GetParameterHistoryResult getParameterHistory(GetParameterHistoryRequest request)
Query a list of all parameters used by the AWS account.
getParameterHistory in interface AWSSimpleSystemsManagementgetParameterHistoryRequest - InternalServerErrorException - An error occurred on the server side.ParameterNotFoundException - The parameter could not be found. Verify the name and try again.InvalidNextTokenException - The specified token is not valid.InvalidKeyIdException - The query key ID is not valid.public GetParametersResult getParameters(GetParametersRequest request)
Get details of a parameter.
getParameters in interface AWSSimpleSystemsManagementgetParametersRequest - InvalidKeyIdException - The query key ID is not valid.InternalServerErrorException - An error occurred on the server side.public GetParametersByPathResult getParametersByPath(GetParametersByPathRequest request)
Retrieve parameters in a specific hierarchy. For more information, see Working with Systems Manager Parameters.
Request results are returned on a best-effort basis. If you specify MaxResults in the request, the
response includes information up to the limit specified. The number of items returned, however, can be between
zero and the value of MaxResults. If the service reaches an internal limit while processing the
results, it stops the operation and returns the matching values up to that point and a NextToken.
You can specify the NextToken in a subsequent call to get the next set of results.
getParametersByPath in interface AWSSimpleSystemsManagementgetParametersByPathRequest - InternalServerErrorException - An error occurred on the server side.InvalidFilterKeyException - The specified key is not valid.InvalidFilterOptionException - The specified filter option is not valid. Valid options are Equals and BeginsWith. For Path filter, valid
options are Recursive and OneLevel.InvalidFilterValueException - The filter value is not valid. Verify the value and try again.InvalidKeyIdException - The query key ID is not valid.InvalidNextTokenException - The specified token is not valid.public GetPatchBaselineResult getPatchBaseline(GetPatchBaselineRequest request)
Retrieves information about a patch baseline.
getPatchBaseline in interface AWSSimpleSystemsManagementgetPatchBaselineRequest - DoesNotExistException - Error returned when the ID specified for a resource (e.g. a Maintenance Window) doesn't exist.InvalidResourceIdException - The resource ID is not valid. Verify that you entered the correct ID and try again.InternalServerErrorException - An error occurred on the server side.public GetPatchBaselineForPatchGroupResult getPatchBaselineForPatchGroup(GetPatchBaselineForPatchGroupRequest request)
Retrieves the patch baseline that should be used for the specified patch group.
getPatchBaselineForPatchGroup in interface AWSSimpleSystemsManagementgetPatchBaselineForPatchGroupRequest - InternalServerErrorException - An error occurred on the server side.public ListAssociationVersionsResult listAssociationVersions(ListAssociationVersionsRequest request)
Retrieves all versions of an association for a specific association ID.
listAssociationVersions in interface AWSSimpleSystemsManagementlistAssociationVersionsRequest - InternalServerErrorException - An error occurred on the server side.InvalidNextTokenException - The specified token is not valid.AssociationDoesNotExistException - The specified association does not exist.public ListAssociationsResult listAssociations(ListAssociationsRequest request)
Lists the associations for the specified Systems Manager document or instance.
listAssociations in interface AWSSimpleSystemsManagementlistAssociationsRequest - InternalServerErrorException - An error occurred on the server side.InvalidNextTokenException - The specified token is not valid.public ListCommandInvocationsResult listCommandInvocations(ListCommandInvocationsRequest request)
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.
listCommandInvocations in interface AWSSimpleSystemsManagementlistCommandInvocationsRequest - InternalServerErrorException - An error occurred on the server side.InvalidCommandIdExceptionInvalidInstanceIdException - The following problems can cause this exception:
You do not have permission to access the instance.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
InvalidFilterKeyException - The specified key is not valid.InvalidNextTokenException - The specified token is not valid.public ListCommandsResult listCommands(ListCommandsRequest request)
Lists the commands requested by users of the AWS account.
listCommands in interface AWSSimpleSystemsManagementlistCommandsRequest - InternalServerErrorException - An error occurred on the server side.InvalidCommandIdExceptionInvalidInstanceIdException - The following problems can cause this exception:
You do not have permission to access the instance.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
InvalidFilterKeyException - The specified key is not valid.InvalidNextTokenException - The specified token is not valid.public ListComplianceItemsResult listComplianceItems(ListComplianceItemsRequest request)
For a specified resource ID, this API action returns a list of compliance statuses for different resource types. Currently, you can only specify one resource ID per call. List results depend on the criteria specified in the filter.
listComplianceItems in interface AWSSimpleSystemsManagementlistComplianceItemsRequest - InvalidResourceTypeException - The resource type is not valid. For example, if you are attempting to tag an instance, the instance must
be a registered, managed instance.InvalidResourceIdException - The resource ID is not valid. Verify that you entered the correct ID and try again.InternalServerErrorException - An error occurred on the server side.InvalidFilterException - The filter name is not valid. Verify the you entered the correct name and try again.InvalidNextTokenException - The specified token is not valid.public ListComplianceSummariesResult listComplianceSummaries(ListComplianceSummariesRequest request)
Returns a summary count of compliant and non-compliant resources for a compliance type. For example, this call can return State Manager associations, patches, or custom compliance types according to the filter criteria that you specify.
listComplianceSummaries in interface AWSSimpleSystemsManagementlistComplianceSummariesRequest - InvalidFilterException - The filter name is not valid. Verify the you entered the correct name and try again.InvalidNextTokenException - The specified token is not valid.InternalServerErrorException - An error occurred on the server side.public ListDocumentVersionsResult listDocumentVersions(ListDocumentVersionsRequest request)
List all versions for a document.
listDocumentVersions in interface AWSSimpleSystemsManagementlistDocumentVersionsRequest - InternalServerErrorException - An error occurred on the server side.InvalidNextTokenException - The specified token is not valid.InvalidDocumentException - The specified document does not exist.public ListDocumentsResult listDocuments(ListDocumentsRequest request)
Describes one or more of your Systems Manager documents.
listDocuments in interface AWSSimpleSystemsManagementlistDocumentsRequest - InternalServerErrorException - An error occurred on the server side.InvalidNextTokenException - The specified token is not valid.InvalidFilterKeyException - The specified key is not valid.public ListDocumentsResult listDocuments()
AWSSimpleSystemsManagementlistDocuments in interface AWSSimpleSystemsManagementAWSSimpleSystemsManagement.listDocuments(ListDocumentsRequest)public ListInventoryEntriesResult listInventoryEntries(ListInventoryEntriesRequest request)
A list of inventory items returned by the request.
listInventoryEntries in interface AWSSimpleSystemsManagementlistInventoryEntriesRequest - InternalServerErrorException - An error occurred on the server side.InvalidInstanceIdException - The following problems can cause this exception:
You do not have permission to access the instance.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
InvalidTypeNameException - The parameter type name is not valid.InvalidFilterException - The filter name is not valid. Verify the you entered the correct name and try again.InvalidNextTokenException - The specified token is not valid.public ListResourceComplianceSummariesResult listResourceComplianceSummaries(ListResourceComplianceSummariesRequest request)
Returns a resource-level summary count. The summary includes information about compliant and non-compliant statuses and detailed compliance-item severity counts, according to the filter criteria you specify.
listResourceComplianceSummaries in interface AWSSimpleSystemsManagementlistResourceComplianceSummariesRequest - InvalidFilterException - The filter name is not valid. Verify the you entered the correct name and try again.InvalidNextTokenException - The specified token is not valid.InternalServerErrorException - An error occurred on the server side.public ListResourceDataSyncResult listResourceDataSync(ListResourceDataSyncRequest request)
Lists your resource data sync configurations. Includes information about the last time a sync attempted to start, the last sync status, and the last time a sync successfully completed.
The number of sync configurations might be too large to return using a single call to
ListResourceDataSync. You can limit the number of sync configurations returned by using the
MaxResults parameter. To determine whether there are more sync configurations to list, check the
value of NextToken in the output. If there are more sync configurations to list, you can request
them by specifying the NextToken returned in the call to the parameter of a subsequent call.
listResourceDataSync in interface AWSSimpleSystemsManagementlistResourceDataSyncRequest - InternalServerErrorException - An error occurred on the server side.InvalidNextTokenException - The specified token is not valid.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Returns a list of the tags assigned to the specified resource.
listTagsForResource in interface AWSSimpleSystemsManagementlistTagsForResourceRequest - InvalidResourceTypeException - The resource type is not valid. For example, if you are attempting to tag an instance, the instance must
be a registered, managed instance.InvalidResourceIdException - The resource ID is not valid. Verify that you entered the correct ID and try again.InternalServerErrorException - An error occurred on the server side.public ModifyDocumentPermissionResult modifyDocumentPermission(ModifyDocumentPermissionRequest request)
Shares a Systems Manager 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.
modifyDocumentPermission in interface AWSSimpleSystemsManagementmodifyDocumentPermissionRequest - InternalServerErrorException - An error occurred on the server side.InvalidDocumentException - The specified document does not exist.InvalidPermissionTypeException - The permission type is not supported. Share is the only supported permission type.DocumentPermissionLimitException - The document cannot be shared with more AWS user accounts. You can share a document with a maximum of 20
accounts. You can publicly share up to five documents. If you need to increase this limit, contact AWS
Support.DocumentLimitExceededException - You can have at most 200 active Systems Manager documents.public PutComplianceItemsResult putComplianceItems(PutComplianceItemsRequest request)
Registers a compliance type and other compliance details on a designated resource. This action lets you register custom compliance details with a resource. This call overwrites existing compliance information on the resource, so you must provide a full list of compliance items each time that you send the request.
putComplianceItems in interface AWSSimpleSystemsManagementputComplianceItemsRequest - InternalServerErrorException - An error occurred on the server side.InvalidItemContentException - One or more content items is not valid.TotalSizeLimitExceededException - The size of inventory data has exceeded the total size limit for the resource.ItemSizeLimitExceededException - The inventory item size has exceeded the size limit.ComplianceTypeCountLimitExceededException - You specified too many custom compliance types. You can specify a maximum of 10 different types.InvalidResourceTypeException - The resource type is not valid. For example, if you are attempting to tag an instance, the instance must
be a registered, managed instance.InvalidResourceIdException - The resource ID is not valid. Verify that you entered the correct ID and try again.public PutInventoryResult putInventory(PutInventoryRequest request)
Bulk update custom inventory items on one more instance. The request adds an inventory item, if it doesn't already exist, or updates an inventory item, if it does exist.
putInventory in interface AWSSimpleSystemsManagementputInventoryRequest - InternalServerErrorException - An error occurred on the server side.InvalidInstanceIdException - The following problems can cause this exception:
You do not have permission to access the instance.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
InvalidTypeNameException - The parameter type name is not valid.InvalidItemContentException - One or more content items is not valid.TotalSizeLimitExceededException - The size of inventory data has exceeded the total size limit for the resource.ItemSizeLimitExceededException - The inventory item size has exceeded the size limit.ItemContentMismatchException - The inventory item has invalid content.CustomSchemaCountLimitExceededException - You have exceeded the limit for custom schemas. Delete one or more custom schemas and try again.UnsupportedInventorySchemaVersionException - Inventory item type schema version has to match supported versions in the service. Check output of
GetInventorySchema to see the available schema version for each type.UnsupportedInventoryItemContextException - The Context attribute that you specified for the InventoryItem is not allowed
for this inventory type. You can only use the Context attribute with inventory types like
AWS:ComplianceItem.InvalidInventoryItemContextException - You specified invalid keys or values in the Context attribute for InventoryItem
. Verify the keys and values, and try again.SubTypeCountLimitExceededException - The sub-type count exceeded the limit for the inventory type.public PutParameterResult putParameter(PutParameterRequest request)
Add one or more parameters to the system.
putParameter in interface AWSSimpleSystemsManagementputParameterRequest - InternalServerErrorException - An error occurred on the server side.InvalidKeyIdException - The query key ID is not valid.ParameterLimitExceededException - You have exceeded the number of parameters for this AWS account. Delete one or more parameters and try
again.TooManyUpdatesException - There are concurrent updates for a resource that supports one update at a time.ParameterAlreadyExistsException - The parameter already exists. You can't create duplicate parameters.HierarchyLevelLimitExceededException - A hierarchy can have a maximum of five levels. For example:
/Finance/Prod/IAD/OS/WinServ2016/license15
For more information, see Working with Systems Manager Parameters.
HierarchyTypeMismatchException - Parameter Store does not support changing a parameter type in a hierarchy. For example, you can't change
a parameter from a String type to a SecureString type. You must create a new, unique parameter.InvalidAllowedPatternException - The request does not meet the regular expression requirement.ParameterMaxVersionLimitExceededException - The parameter exceeded the maximum number of allowed versions.ParameterPatternMismatchException - The parameter name is not valid.UnsupportedParameterTypeException - The parameter type is not supported.public RegisterDefaultPatchBaselineResult registerDefaultPatchBaseline(RegisterDefaultPatchBaselineRequest request)
Defines the default patch baseline.
registerDefaultPatchBaseline in interface AWSSimpleSystemsManagementregisterDefaultPatchBaselineRequest - InvalidResourceIdException - The resource ID is not valid. Verify that you entered the correct ID and try again.DoesNotExistException - Error returned when the ID specified for a resource (e.g. a Maintenance Window) doesn't exist.InternalServerErrorException - An error occurred on the server side.public RegisterPatchBaselineForPatchGroupResult registerPatchBaselineForPatchGroup(RegisterPatchBaselineForPatchGroupRequest request)
Registers a patch baseline for a patch group.
registerPatchBaselineForPatchGroup in interface AWSSimpleSystemsManagementregisterPatchBaselineForPatchGroupRequest - AlreadyExistsException - Error returned if an attempt is made to register a patch group with a patch baseline that is already
registered with a different patch baseline.DoesNotExistException - Error returned when the ID specified for a resource (e.g. a Maintenance Window) doesn't exist.InvalidResourceIdException - The resource ID is not valid. Verify that you entered the correct ID and try again.ResourceLimitExceededException - Error returned when the caller has exceeded the default resource limits (e.g. too many Maintenance
Windows have been created).InternalServerErrorException - An error occurred on the server side.public RegisterTargetWithMaintenanceWindowResult registerTargetWithMaintenanceWindow(RegisterTargetWithMaintenanceWindowRequest request)
Registers a target with a Maintenance Window.
registerTargetWithMaintenanceWindow in interface AWSSimpleSystemsManagementregisterTargetWithMaintenanceWindowRequest - IdempotentParameterMismatchException - Error returned when an idempotent operation is retried and the parameters don't match the original call
to the API with the same idempotency token.DoesNotExistException - Error returned when the ID specified for a resource (e.g. a Maintenance Window) doesn't exist.ResourceLimitExceededException - Error returned when the caller has exceeded the default resource limits (e.g. too many Maintenance
Windows have been created).InternalServerErrorException - An error occurred on the server side.public RegisterTaskWithMaintenanceWindowResult registerTaskWithMaintenanceWindow(RegisterTaskWithMaintenanceWindowRequest request)
Adds a new task to a Maintenance Window.
registerTaskWithMaintenanceWindow in interface AWSSimpleSystemsManagementregisterTaskWithMaintenanceWindowRequest - IdempotentParameterMismatchException - Error returned when an idempotent operation is retried and the parameters don't match the original call
to the API with the same idempotency token.DoesNotExistException - Error returned when the ID specified for a resource (e.g. a Maintenance Window) doesn't exist.ResourceLimitExceededException - Error returned when the caller has exceeded the default resource limits (e.g. too many Maintenance
Windows have been created).FeatureNotAvailableException - You attempted to register a LAMBDA or STEP_FUNCTION task in a region where the corresponding service is
not available.InternalServerErrorException - An error occurred on the server side.public RemoveTagsFromResourceResult removeTagsFromResource(RemoveTagsFromResourceRequest request)
Removes all tags from the specified resource.
removeTagsFromResource in interface AWSSimpleSystemsManagementremoveTagsFromResourceRequest - InvalidResourceTypeException - The resource type is not valid. For example, if you are attempting to tag an instance, the instance must
be a registered, managed instance.InvalidResourceIdException - The resource ID is not valid. Verify that you entered the correct ID and try again.InternalServerErrorException - An error occurred on the server side.public SendAutomationSignalResult sendAutomationSignal(SendAutomationSignalRequest request)
Sends a signal to an Automation execution to change the current behavior or status of the execution.
sendAutomationSignal in interface AWSSimpleSystemsManagementsendAutomationSignalRequest - AutomationExecutionNotFoundException - There is no automation execution information for the requested automation execution ID.InvalidAutomationSignalException - The signal is not valid for the current Automation execution.InternalServerErrorException - An error occurred on the server side.public SendCommandResult sendCommand(SendCommandRequest request)
Executes commands on one or more managed instances.
sendCommand in interface AWSSimpleSystemsManagementsendCommandRequest - DuplicateInstanceIdException - You cannot specify an instance ID in more than one association.InternalServerErrorException - An error occurred on the server side.InvalidInstanceIdException - The following problems can cause this exception:
You do not have permission to access the instance.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
InvalidDocumentException - The specified document does not exist.InvalidOutputFolderException - The S3 bucket does not exist.InvalidParametersException - You must specify values for all required parameters in the Systems Manager document. You can only supply
values to parameters defined in the Systems Manager document.UnsupportedPlatformTypeException - The document does not support the platform type of the given instance ID(s). For example, you sent an
document for a Windows instance to a Linux instance.MaxDocumentSizeExceededException - The size limit of a document is 64 KB.InvalidRoleException - The role name can't contain invalid characters. Also verify that you specified an IAM role for
notifications that includes the required trust policy. For information about configuring the IAM role for
Run Command notifications, see Configuring
Amazon SNS Notifications for Run Command in the Amazon EC2 Systems Manager User Guide.InvalidNotificationConfigException - One or more configuration items is not valid. Verify that a valid Amazon Resource Name (ARN) was provided
for an Amazon SNS topic.public StartAutomationExecutionResult startAutomationExecution(StartAutomationExecutionRequest request)
Initiates execution of an Automation document.
startAutomationExecution in interface AWSSimpleSystemsManagementstartAutomationExecutionRequest - AutomationDefinitionNotFoundException - An Automation document with the specified name could not be found.InvalidAutomationExecutionParametersException - The supplied parameters for invoking the specified Automation document are incorrect. For example, they
may not match the set of parameters permitted for the specified Automation document.AutomationExecutionLimitExceededException - The number of simultaneously running Automation executions exceeded the allowable limit.AutomationDefinitionVersionNotFoundException - An Automation document with the specified name and version could not be found.IdempotentParameterMismatchException - Error returned when an idempotent operation is retried and the parameters don't match the original call
to the API with the same idempotency token.InternalServerErrorException - An error occurred on the server side.public StopAutomationExecutionResult stopAutomationExecution(StopAutomationExecutionRequest request)
Stop an Automation that is currently executing.
stopAutomationExecution in interface AWSSimpleSystemsManagementstopAutomationExecutionRequest - AutomationExecutionNotFoundException - There is no automation execution information for the requested automation execution ID.InternalServerErrorException - An error occurred on the server side.public UpdateAssociationResult updateAssociation(UpdateAssociationRequest request)
Updates an association. You can update the association name and version, the document version, schedule, parameters, and Amazon S3 output.
updateAssociation in interface AWSSimpleSystemsManagementupdateAssociationRequest - InternalServerErrorException - An error occurred on the server side.InvalidScheduleException - The schedule is invalid. Verify your cron or rate expression and try again.InvalidParametersException - You must specify values for all required parameters in the Systems Manager document. You can only supply
values to parameters defined in the Systems Manager document.InvalidOutputLocationException - The output location is not valid or does not exist.InvalidDocumentVersionException - The document version is not valid or does not exist.AssociationDoesNotExistException - The specified association does not exist.InvalidUpdateException - The update is not valid.TooManyUpdatesException - There are concurrent updates for a resource that supports one update at a time.InvalidDocumentException - The specified document does not exist.InvalidTargetException - The target is not valid or does not exist. It might not be configured for EC2 Systems Manager or you
might not have permission to perform the operation.InvalidAssociationVersionException - The version you specified is not valid. Use ListAssociationVersions to view all versions of an
association according to the association ID. Or, use the $LATEST parameter to view the
latest version of the association.AssociationVersionLimitExceededException - You have reached the maximum number versions allowed for an association. Each association has a limit of
1,000 versions.public UpdateAssociationStatusResult updateAssociationStatus(UpdateAssociationStatusRequest request)
Updates the status of the Systems Manager document associated with the specified instance.
updateAssociationStatus in interface AWSSimpleSystemsManagementupdateAssociationStatusRequest - InternalServerErrorException - An error occurred on the server side.InvalidInstanceIdException - The following problems can cause this exception:
You do not have permission to access the instance.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
InvalidDocumentException - The specified document does not exist.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.public UpdateDocumentResult updateDocument(UpdateDocumentRequest request)
The document you want to update.
updateDocument in interface AWSSimpleSystemsManagementupdateDocumentRequest - MaxDocumentSizeExceededException - The size limit of a document is 64 KB.DocumentVersionLimitExceededException - The document has too many versions. Delete one or more document versions and try again.InternalServerErrorException - An error occurred on the server side.DuplicateDocumentContentException - The content of the association document matches another document. Change the content of the document and
try again.InvalidDocumentContentException - The content for the document is not valid.InvalidDocumentVersionException - The document version is not valid or does not exist.InvalidDocumentSchemaVersionException - The version of the document schema is not supported.InvalidDocumentException - The specified document does not exist.public UpdateDocumentDefaultVersionResult updateDocumentDefaultVersion(UpdateDocumentDefaultVersionRequest request)
Set the default version of a document.
updateDocumentDefaultVersion in interface AWSSimpleSystemsManagementupdateDocumentDefaultVersionRequest - InternalServerErrorException - An error occurred on the server side.InvalidDocumentException - The specified document does not exist.InvalidDocumentVersionException - The document version is not valid or does not exist.InvalidDocumentSchemaVersionException - The version of the document schema is not supported.public UpdateMaintenanceWindowResult updateMaintenanceWindow(UpdateMaintenanceWindowRequest request)
Updates an existing Maintenance Window. Only specified parameters are modified.
updateMaintenanceWindow in interface AWSSimpleSystemsManagementupdateMaintenanceWindowRequest - DoesNotExistException - Error returned when the ID specified for a resource (e.g. a Maintenance Window) doesn't exist.InternalServerErrorException - An error occurred on the server side.public UpdateMaintenanceWindowTargetResult updateMaintenanceWindowTarget(UpdateMaintenanceWindowTargetRequest request)
Modifies the target of an existing Maintenance Window. You can't change the target type, but you can change the following:
The target from being an ID target to a Tag target, or a Tag target to an ID target.
IDs for an ID target.
Tags for a Tag target.
Owner.
Name.
Description.
If a parameter is null, then the corresponding field is not modified.
updateMaintenanceWindowTarget in interface AWSSimpleSystemsManagementupdateMaintenanceWindowTargetRequest - DoesNotExistException - Error returned when the ID specified for a resource (e.g. a Maintenance Window) doesn't exist.InternalServerErrorException - An error occurred on the server side.public UpdateMaintenanceWindowTaskResult updateMaintenanceWindowTask(UpdateMaintenanceWindowTaskRequest request)
Modifies a task assigned to a Maintenance Window. You can't change the task type, but you can change the following values:
Task ARN. For example, you can change a RUN_COMMAND task from AWS-RunPowerShellScript to AWS-RunShellScript.
Service role ARN.
Task parameters.
Task priority.
Task MaxConcurrency and MaxErrors.
Log location.
If a parameter is null, then the corresponding field is not modified. Also, if you set Replace to true, then all fields required by the RegisterTaskWithMaintenanceWindow action are required for this request. Optional fields that aren't specified are set to null.
updateMaintenanceWindowTask in interface AWSSimpleSystemsManagementupdateMaintenanceWindowTaskRequest - DoesNotExistException - Error returned when the ID specified for a resource (e.g. a Maintenance Window) doesn't exist.InternalServerErrorException - An error occurred on the server side.public UpdateManagedInstanceRoleResult updateManagedInstanceRole(UpdateManagedInstanceRoleRequest request)
Assigns or changes an Amazon Identity and Access Management (IAM) role to the managed instance.
updateManagedInstanceRole in interface AWSSimpleSystemsManagementupdateManagedInstanceRoleRequest - InvalidInstanceIdException - The following problems can cause this exception:
You do not have permission to access the instance.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
InternalServerErrorException - An error occurred on the server side.public UpdatePatchBaselineResult updatePatchBaseline(UpdatePatchBaselineRequest request)
Modifies an existing patch baseline. Fields not specified in the request are left unchanged.
updatePatchBaseline in interface AWSSimpleSystemsManagementupdatePatchBaselineRequest - DoesNotExistException - Error returned when the ID specified for a resource (e.g. a Maintenance Window) doesn't exist.InternalServerErrorException - An error occurred on the server side.public 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 the request.
getCachedResponseMetadata in interface AWSSimpleSystemsManagementrequest - The originally executed requestCopyright © 2013 Amazon Web Services, Inc. All Rights Reserved.