@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSSimpleSystemsManagementClient extends AmazonWebServiceClient implements AWSSimpleSystemsManagement
AWS 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 AWS Systems Manager User Guide.
To get started, verify prerequisites and configure managed instances. For more information, see Setting Up AWS Systems Manager in the AWS Systems Manager User Guide.
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.
Modifier and Type | Field and Description |
---|---|
protected static ClientConfigurationFactory |
configFactory
Client configuration factory providing ClientConfigurations tailored to this client
|
client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
ENDPOINT_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, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, shutdown, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
setEndpoint, setRegion, shutdown
protected static final ClientConfigurationFactory configFactory
@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 50 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 AWSSimpleSystemsManagement
addTagsToResourceRequest
- 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.TooManyUpdatesException
- There are concurrent updates for a resource that supports one update at a time.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 AWSSimpleSystemsManagement
cancelCommandRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidCommandIdException
InvalidInstanceIdException
- The following problems can cause this exception:
You do not have permission to access the instance.
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.
SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling 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 CancelMaintenanceWindowExecutionResult cancelMaintenanceWindowExecution(CancelMaintenanceWindowExecutionRequest request)
Stops a maintenance window execution that is already in progress and cancels any tasks in the window that have not already starting running. (Tasks already in progress will continue to completion.)
cancelMaintenanceWindowExecution
in interface AWSSimpleSystemsManagement
cancelMaintenanceWindowExecutionRequest
- InternalServerErrorException
- An error occurred on the server side.DoesNotExistException
- Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline,
doesn't exist.
For information about resource limits in Systems Manager, see AWS Systems Manager Limits.
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 AWS Systems Manager for Hybrid Environments.
createActivation
in interface AWSSimpleSystemsManagement
createActivationRequest
- 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, 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 returns the AssociationAlreadyExists exception.
createAssociation
in interface AWSSimpleSystemsManagement
createAssociationRequest
- 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.
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.
SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling 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, 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 returns the AssociationAlreadyExists exception.
createAssociationBatch
in interface AWSSimpleSystemsManagement
createAssociationBatchRequest
- 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.
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.
SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling 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 AWSSimpleSystemsManagement
createDocumentRequest
- 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 AWSSimpleSystemsManagement
createMaintenanceWindowRequest
- 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. For example, too many
maintenance windows or patch baselines have been created.
For information about resource limits in Systems Manager, see AWS Systems Manager Limits.
InternalServerErrorException
- An error occurred on the server side.public CreatePatchBaselineResult createPatchBaseline(CreatePatchBaselineRequest request)
Creates a patch baseline.
For information about valid key and value pairs in PatchFilters
for each supported operating system
type, see PatchFilter.
createPatchBaseline
in interface AWSSimpleSystemsManagement
createPatchBaselineRequest
- 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. For example, too many
maintenance windows or patch baselines have been created.
For information about resource limits in Systems Manager, see AWS Systems Manager Limits.
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.
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. For more information, see Configuring Resource Data Sync for Inventory in the AWS Systems Manager User Guide.
createResourceDataSync
in interface AWSSimpleSystemsManagement
createResourceDataSyncRequest
- 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 AWSSimpleSystemsManagement
deleteActivationRequest
- 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 AWSSimpleSystemsManagement
deleteAssociationRequest
- 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.
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.
SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling 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 AWSSimpleSystemsManagement
deleteDocumentRequest
- 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 DeleteInventoryResult deleteInventory(DeleteInventoryRequest request)
Delete a custom inventory type, or the data associated with a custom Inventory type. Deleting a custom inventory type is also referred to as deleting a custom inventory schema.
deleteInventory
in interface AWSSimpleSystemsManagement
deleteInventoryRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidTypeNameException
- The parameter type name is not valid.InvalidOptionException
- The delete inventory option specified is not valid. Verify the option and try again.InvalidDeleteInventoryParametersException
- One or more of the parameters specified for the delete operation is not valid. Verify all parameters and
try again.InvalidInventoryRequestException
- The request is not valid.public DeleteMaintenanceWindowResult deleteMaintenanceWindow(DeleteMaintenanceWindowRequest request)
Deletes a maintenance window.
deleteMaintenanceWindow
in interface AWSSimpleSystemsManagement
deleteMaintenanceWindowRequest
- InternalServerErrorException
- An error occurred on the server side.public DeleteParameterResult deleteParameter(DeleteParameterRequest request)
Delete a parameter from the system.
deleteParameter
in interface AWSSimpleSystemsManagement
deleteParameterRequest
- 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 AWSSimpleSystemsManagement
deleteParametersRequest
- InternalServerErrorException
- An error occurred on the server side.public DeletePatchBaselineResult deletePatchBaseline(DeletePatchBaselineRequest request)
Deletes a patch baseline.
deletePatchBaseline
in interface AWSSimpleSystemsManagement
deletePatchBaselineRequest
- 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 AWSSimpleSystemsManagement
deleteResourceDataSyncRequest
- 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 SSM Agent first.
deregisterManagedInstance
in interface AWSSimpleSystemsManagement
deregisterManagedInstanceRequest
- InvalidInstanceIdException
- The following problems can cause this exception:
You do not have permission to access the instance.
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.
SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling 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 AWSSimpleSystemsManagement
deregisterPatchBaselineForPatchGroupRequest
- 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 AWSSimpleSystemsManagement
deregisterTargetFromMaintenanceWindowRequest
- DoesNotExistException
- Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline,
doesn't exist.
For information about resource limits in Systems Manager, see AWS Systems Manager Limits.
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 AWSSimpleSystemsManagement
deregisterTaskFromMaintenanceWindowRequest
- DoesNotExistException
- Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline,
doesn't exist.
For information about resource limits in Systems Manager, see AWS Systems Manager Limits.
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 AWSSimpleSystemsManagement
describeActivationsRequest
- 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 association for the specified target or instance. If you created the association by using the
Targets
parameter, then you must retrieve the association by using the association ID. If you
created the association by specifying an instance ID and a Systems Manager document, then you retrieve the
association by specifying the document name and the instance ID.
describeAssociation
in interface AWSSimpleSystemsManagement
describeAssociationRequest
- 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.
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.
SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling 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 DescribeAssociationExecutionTargetsResult describeAssociationExecutionTargets(DescribeAssociationExecutionTargetsRequest request)
Use this API action to view information about a specific execution of a specific association.
describeAssociationExecutionTargets
in interface AWSSimpleSystemsManagement
describeAssociationExecutionTargetsRequest
- InternalServerErrorException
- An error occurred on the server side.AssociationDoesNotExistException
- The specified association does not exist.InvalidNextTokenException
- The specified token is not valid.AssociationExecutionDoesNotExistException
- The specified execution ID does not exist. Verify the ID number and try again.public DescribeAssociationExecutionsResult describeAssociationExecutions(DescribeAssociationExecutionsRequest request)
Use this API action to view all executions for a specific association ID.
describeAssociationExecutions
in interface AWSSimpleSystemsManagement
describeAssociationExecutionsRequest
- InternalServerErrorException
- An error occurred on the server side.AssociationDoesNotExistException
- The specified association does not exist.InvalidNextTokenException
- The specified token is not valid.public DescribeAutomationExecutionsResult describeAutomationExecutions(DescribeAutomationExecutionsRequest request)
Provides details about all active and terminated Automation executions.
describeAutomationExecutions
in interface AWSSimpleSystemsManagement
describeAutomationExecutionsRequest
- InvalidFilterKeyException
- The specified key is not valid.InvalidFilterValueException
- The filter value is not valid. Verify the value and try again.InvalidNextTokenException
- The specified token is not valid.InternalServerErrorException
- An error occurred on the server side.public DescribeAutomationStepExecutionsResult describeAutomationStepExecutions(DescribeAutomationStepExecutionsRequest request)
Information about all active and terminated step executions in an Automation workflow.
describeAutomationStepExecutions
in interface AWSSimpleSystemsManagement
describeAutomationStepExecutionsRequest
- AutomationExecutionNotFoundException
- There is no automation execution information for the requested automation execution ID.InvalidNextTokenException
- The specified token is not valid.InvalidFilterKeyException
- The specified key is not valid.InvalidFilterValueException
- The filter value is not valid. Verify the value and try again.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 AWSSimpleSystemsManagement
describeAvailablePatchesRequest
- InternalServerErrorException
- An error occurred on the server side.public DescribeDocumentResult describeDocument(DescribeDocumentRequest request)
Describes the specified Systems Manager document.
describeDocument
in interface AWSSimpleSystemsManagement
describeDocumentRequest
- 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 AWSSimpleSystemsManagement
describeDocumentPermissionRequest
- 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 AWSSimpleSystemsManagement
describeEffectiveInstanceAssociationsRequest
- 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.
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.
SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling 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 AWSSimpleSystemsManagement
describeEffectivePatchesForPatchBaselineRequest
- 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, such as a maintenance window or Patch baseline,
doesn't exist.
For information about resource limits in Systems Manager, see AWS Systems Manager Limits.
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 AWSSimpleSystemsManagement
describeInstanceAssociationsStatusRequest
- 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.
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.
SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling 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.
The IamRole field for this API action is the Amazon Identity and Access Management (IAM) role assigned to on-premises instances. This call does not return the IAM role for Amazon EC2 instances.
describeInstanceInformation
in interface AWSSimpleSystemsManagement
describeInstanceInformationRequest
- 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.
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.
SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling 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 AWSSimpleSystemsManagement
describeInstancePatchStatesRequest
- 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 AWSSimpleSystemsManagement
describeInstancePatchStatesForPatchGroupRequest
- 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 AWSSimpleSystemsManagement
describeInstancePatchesRequest
- 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.
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.
SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling 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 DescribeInventoryDeletionsResult describeInventoryDeletions(DescribeInventoryDeletionsRequest request)
Describes a specific delete inventory operation.
describeInventoryDeletions
in interface AWSSimpleSystemsManagement
describeInventoryDeletionsRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidDeletionIdException
- The ID specified for the delete operation does not exist or is not valid. Verify the ID 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 run as part of a maintenance window execution.
describeMaintenanceWindowExecutionTaskInvocations
in interface AWSSimpleSystemsManagement
describeMaintenanceWindowExecutionTaskInvocationsRequest
- DoesNotExistException
- Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline,
doesn't exist.
For information about resource limits in Systems Manager, see AWS Systems Manager Limits.
InternalServerErrorException
- An error occurred on the server side.public DescribeMaintenanceWindowExecutionTasksResult describeMaintenanceWindowExecutionTasks(DescribeMaintenanceWindowExecutionTasksRequest request)
For a given maintenance window execution, lists the tasks that were run.
describeMaintenanceWindowExecutionTasks
in interface AWSSimpleSystemsManagement
describeMaintenanceWindowExecutionTasksRequest
- DoesNotExistException
- Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline,
doesn't exist.
For information about resource limits in Systems Manager, see AWS Systems Manager Limits.
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 AWSSimpleSystemsManagement
describeMaintenanceWindowExecutionsRequest
- InternalServerErrorException
- An error occurred on the server side.public DescribeMaintenanceWindowScheduleResult describeMaintenanceWindowSchedule(DescribeMaintenanceWindowScheduleRequest request)
Retrieves information about upcoming executions of a maintenance window.
describeMaintenanceWindowSchedule
in interface AWSSimpleSystemsManagement
describeMaintenanceWindowScheduleRequest
- InternalServerErrorException
- An error occurred on the server side.DoesNotExistException
- Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline,
doesn't exist.
For information about resource limits in Systems Manager, see AWS Systems Manager Limits.
public DescribeMaintenanceWindowTargetsResult describeMaintenanceWindowTargets(DescribeMaintenanceWindowTargetsRequest request)
Lists the targets registered with the maintenance window.
describeMaintenanceWindowTargets
in interface AWSSimpleSystemsManagement
describeMaintenanceWindowTargetsRequest
- DoesNotExistException
- Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline,
doesn't exist.
For information about resource limits in Systems Manager, see AWS Systems Manager Limits.
InternalServerErrorException
- An error occurred on the server side.public DescribeMaintenanceWindowTasksResult describeMaintenanceWindowTasks(DescribeMaintenanceWindowTasksRequest request)
Lists the tasks in a maintenance window.
describeMaintenanceWindowTasks
in interface AWSSimpleSystemsManagement
describeMaintenanceWindowTasksRequest
- DoesNotExistException
- Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline,
doesn't exist.
For information about resource limits in Systems Manager, see AWS Systems Manager Limits.
InternalServerErrorException
- An error occurred on the server side.public DescribeMaintenanceWindowsResult describeMaintenanceWindows(DescribeMaintenanceWindowsRequest request)
Retrieves the maintenance windows in an AWS account.
describeMaintenanceWindows
in interface AWSSimpleSystemsManagement
describeMaintenanceWindowsRequest
- InternalServerErrorException
- An error occurred on the server side.public DescribeMaintenanceWindowsForTargetResult describeMaintenanceWindowsForTarget(DescribeMaintenanceWindowsForTargetRequest request)
Retrieves information about the maintenance window targets or tasks that an instance is associated with.
describeMaintenanceWindowsForTarget
in interface AWSSimpleSystemsManagement
describeMaintenanceWindowsForTargetRequest
- 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 AWSSimpleSystemsManagement
describeParametersRequest
- 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 AWSSimpleSystemsManagement
describePatchBaselinesRequest
- 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 AWSSimpleSystemsManagement
describePatchGroupStateRequest
- 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 AWSSimpleSystemsManagement
describePatchGroupsRequest
- InternalServerErrorException
- An error occurred on the server side.public DescribePatchPropertiesResult describePatchProperties(DescribePatchPropertiesRequest request)
Lists the properties of available patches organized by product, product family, classification, severity, and other properties of available patches. You can use the reported properties in the filters you specify in requests for actions such as CreatePatchBaseline, UpdatePatchBaseline, DescribeAvailablePatches, and DescribePatchBaselines.
The following section lists the properties that can be used in filters for each major operating system type:
Valid properties: PRODUCT, PRODUCT_FAMILY, CLASSIFICATION, MSRC_SEVERITY
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
Valid properties: PRODUCT, PRIORITY
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
describePatchProperties
in interface AWSSimpleSystemsManagement
describePatchPropertiesRequest
- InternalServerErrorException
- An error occurred on the server side.public DescribeSessionsResult describeSessions(DescribeSessionsRequest request)
Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30 days.
describeSessions
in interface AWSSimpleSystemsManagement
describeSessionsRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidFilterKeyException
- The specified key is not valid.InvalidNextTokenException
- The specified token is not valid.public GetAutomationExecutionResult getAutomationExecution(GetAutomationExecutionRequest request)
Get detailed information about a particular Automation execution.
getAutomationExecution
in interface AWSSimpleSystemsManagement
getAutomationExecutionRequest
- 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 AWSSimpleSystemsManagement
getCommandInvocationRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidCommandIdException
InvalidInstanceIdException
- The following problems can cause this exception:
You do not have permission to access the instance.
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.
SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling 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 and the
instance ID and try again.public GetConnectionStatusResult getConnectionStatus(GetConnectionStatusRequest request)
Retrieves the Session Manager connection status for an instance to determine whether it is connected and ready to receive Session Manager connections.
getConnectionStatus
in interface AWSSimpleSystemsManagement
getConnectionStatusRequest
- InternalServerErrorException
- An error occurred on the server side.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.
If you do not specify an operating system value, the default patch baseline for Windows is returned.
getDefaultPatchBaseline
in interface AWSSimpleSystemsManagement
getDefaultPatchBaselineRequest
- 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 AWSSimpleSystemsManagement
getDeployablePatchSnapshotForInstanceRequest
- 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.UnsupportedFeatureRequiredException
- Microsoft application patching is only available on EC2 instances and Advanced Instances. To patch
Microsoft applications on on-premises servers and VMs, you must enable Advanced Instances. For more
information, see Using the Advanced-Instances Tier in the AWS Systems Manager User Guide.public GetDocumentResult getDocument(GetDocumentRequest request)
Gets the contents of the specified Systems Manager document.
getDocument
in interface AWSSimpleSystemsManagement
getDocumentRequest
- 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 AWSSimpleSystemsManagement
getInventoryRequest
- 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.InvalidInventoryGroupException
- The specified inventory group is not valid.InvalidNextTokenException
- The specified token is not valid.InvalidTypeNameException
- The parameter type name is not valid.InvalidAggregatorException
- The specified aggregator is not valid for inventory groups. Verify that the aggregator uses a valid
inventory type such as AWS:Application
or AWS:InstanceInformation
.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 AWSSimpleSystemsManagement
getInventorySchemaRequest
- 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 AWSSimpleSystemsManagement
getMaintenanceWindowRequest
- DoesNotExistException
- Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline,
doesn't exist.
For information about resource limits in Systems Manager, see AWS Systems Manager Limits.
InternalServerErrorException
- An error occurred on the server side.public GetMaintenanceWindowExecutionResult getMaintenanceWindowExecution(GetMaintenanceWindowExecutionRequest request)
Retrieves details about a specific task run as part of a maintenance window execution.
getMaintenanceWindowExecution
in interface AWSSimpleSystemsManagement
getMaintenanceWindowExecutionRequest
- DoesNotExistException
- Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline,
doesn't exist.
For information about resource limits in Systems Manager, see AWS Systems Manager Limits.
InternalServerErrorException
- An error occurred on the server side.public GetMaintenanceWindowExecutionTaskResult getMaintenanceWindowExecutionTask(GetMaintenanceWindowExecutionTaskRequest request)
Retrieves the details about a specific task run as part of a maintenance window execution.
getMaintenanceWindowExecutionTask
in interface AWSSimpleSystemsManagement
getMaintenanceWindowExecutionTaskRequest
- DoesNotExistException
- Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline,
doesn't exist.
For information about resource limits in Systems Manager, see AWS Systems Manager Limits.
InternalServerErrorException
- An error occurred on the server side.public GetMaintenanceWindowExecutionTaskInvocationResult getMaintenanceWindowExecutionTaskInvocation(GetMaintenanceWindowExecutionTaskInvocationRequest request)
Retrieves a task invocation. A task invocation is a specific task running on a specific target. maintenance windows report status for all invocations.
getMaintenanceWindowExecutionTaskInvocation
in interface AWSSimpleSystemsManagement
getMaintenanceWindowExecutionTaskInvocationRequest
- DoesNotExistException
- Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline,
doesn't exist.
For information about resource limits in Systems Manager, see AWS Systems Manager Limits.
InternalServerErrorException
- An error occurred on the server side.public GetMaintenanceWindowTaskResult getMaintenanceWindowTask(GetMaintenanceWindowTaskRequest request)
Lists the tasks in a maintenance window.
getMaintenanceWindowTask
in interface AWSSimpleSystemsManagement
getMaintenanceWindowTaskRequest
- DoesNotExistException
- Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline,
doesn't exist.
For information about resource limits in Systems Manager, see AWS Systems Manager Limits.
InternalServerErrorException
- An error occurred on the server side.public GetParameterResult getParameter(GetParameterRequest request)
Get information about a parameter by using the parameter name. Don't confuse this API action with the GetParameters API action.
getParameter
in interface AWSSimpleSystemsManagement
getParameterRequest
- 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 AWSSimpleSystemsManagement
getParameterHistoryRequest
- 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. Don't confuse this API action with the GetParameter API action.
getParameters
in interface AWSSimpleSystemsManagement
getParametersRequest
- 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 in the AWS Systems Manager User Guide.
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.
This API action doesn't support filtering by tags.
getParametersByPath
in interface AWSSimpleSystemsManagement
getParametersByPathRequest
- 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 AWSSimpleSystemsManagement
getPatchBaselineRequest
- DoesNotExistException
- Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline,
doesn't exist.
For information about resource limits in Systems Manager, see AWS Systems Manager Limits.
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 AWSSimpleSystemsManagement
getPatchBaselineForPatchGroupRequest
- InternalServerErrorException
- An error occurred on the server side.public GetServiceSettingResult getServiceSetting(GetServiceSettingRequest request)
ServiceSetting
is an account-level setting for an AWS service. This setting defines how a user
interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the
account based on feature or service usage, then the AWS service team might create a default setting of "false".
This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for
a paid feature.
Services map a SettingId
object to a setting value. AWS services teams define the default value for
a SettingId
. You can't create a new SettingId
, but you can overwrite the default value
if you have the ssm:UpdateServiceSetting
permission for the setting. Use the
UpdateServiceSetting API action to change the default setting. Or use the ResetServiceSetting to
change the value back to the original value defined by the AWS service team.
Query the current service setting for the account.
getServiceSetting
in interface AWSSimpleSystemsManagement
getServiceSettingRequest
- The request body of the GetServiceSetting API action.InternalServerErrorException
- An error occurred on the server side.ServiceSettingNotFoundException
- The specified service setting was not found. Either the service name or the setting has not been
provisioned by the AWS service team.public LabelParameterVersionResult labelParameterVersion(LabelParameterVersionRequest request)
A parameter label is a user-defined alias to help you manage different versions of a parameter. When you modify a parameter, Systems Manager automatically saves a new version and increments the version number by one. A label can help you remember the purpose of a parameter when there are multiple versions.
Parameter labels have the following requirements and restrictions.
A version of a parameter can have a maximum of 10 labels.
You can't attach the same label to different versions of the same parameter. For example, if version 1 has the label Production, then you can't attach Production to version 2.
You can move a label from one version of a parameter to another.
You can't create a label when you create a new parameter. You must attach a label to a specific version of a parameter.
You can't delete a parameter label. If you no longer want to use a parameter label, then you must move it to a different version of a parameter.
A label can have a maximum of 100 characters.
Labels can contain letters (case sensitive), numbers, periods (.), hyphens (-), or underscores (_).
Labels can't begin with a number, "aws," or "ssm" (not case sensitive). If a label fails to meet these requirements, then the label is not associated with a parameter and the system displays it in the list of InvalidLabels.
labelParameterVersion
in interface AWSSimpleSystemsManagement
labelParameterVersionRequest
- InternalServerErrorException
- An error occurred on the server side.TooManyUpdatesException
- There are concurrent updates for a resource that supports one update at a time.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.ParameterVersionLabelLimitExceededException
- A parameter version can have a maximum of ten labels.public ListAssociationVersionsResult listAssociationVersions(ListAssociationVersionsRequest request)
Retrieves all versions of an association for a specific association ID.
listAssociationVersions
in interface AWSSimpleSystemsManagement
listAssociationVersionsRequest
- 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 AWSSimpleSystemsManagement
listAssociationsRequest
- 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 runs SendCommand against three instances, then a command invocation is created for each requested instance ID. ListCommandInvocations provide status about command execution.
listCommandInvocations
in interface AWSSimpleSystemsManagement
listCommandInvocationsRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidCommandIdException
InvalidInstanceIdException
- The following problems can cause this exception:
You do not have permission to access the instance.
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.
SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling 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 AWSSimpleSystemsManagement
listCommandsRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidCommandIdException
InvalidInstanceIdException
- The following problems can cause this exception:
You do not have permission to access the instance.
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.
SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling 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 AWSSimpleSystemsManagement
listComplianceItemsRequest
- 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 AWSSimpleSystemsManagement
listComplianceSummariesRequest
- 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 AWSSimpleSystemsManagement
listDocumentVersionsRequest
- 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 AWSSimpleSystemsManagement
listDocumentsRequest
- 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()
AWSSimpleSystemsManagement
listDocuments
in interface AWSSimpleSystemsManagement
AWSSimpleSystemsManagement.listDocuments(ListDocumentsRequest)
public ListInventoryEntriesResult listInventoryEntries(ListInventoryEntriesRequest request)
A list of inventory items returned by the request.
listInventoryEntries
in interface AWSSimpleSystemsManagement
listInventoryEntriesRequest
- 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.
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.
SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling 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 AWSSimpleSystemsManagement
listResourceComplianceSummariesRequest
- 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 AWSSimpleSystemsManagement
listResourceDataSyncRequest
- 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 AWSSimpleSystemsManagement
listTagsForResourceRequest
- 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 AWSSimpleSystemsManagement
modifyDocumentPermissionRequest
- 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.
ComplianceType can be one of the following:
ExecutionId: The execution ID when the patch, association, or custom compliance item was applied.
ExecutionType: Specify patch, association, or Custom:string
.
ExecutionTime. The time the patch, association, or custom compliance item was applied to the instance.
Id: The patch, association, or custom compliance ID.
Title: A title.
Status: The status of the compliance item. For example, approved
for patches, or Failed
for associations.
Severity: A patch severity. For example, critical
.
DocumentName: A SSM document name. For example, AWS-RunPatchBaseline.
DocumentVersion: An SSM document version number. For example, 4.
Classification: A patch classification. For example, security updates
.
PatchBaselineId: A patch baseline ID.
PatchSeverity: A patch severity. For example, Critical
.
PatchState: A patch state. For example, InstancesWithFailedPatches
.
PatchGroup: The name of a patch group.
InstalledTime: The time the association, patch, or custom compliance item was applied to the resource. Specify the time by using the following format: yyyy-MM-dd'T'HH:mm:ss'Z'
putComplianceItems
in interface AWSSimpleSystemsManagement
putComplianceItemsRequest
- 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 AWSSimpleSystemsManagement
putInventoryRequest
- 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.
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.
SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling 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 a parameter to the system.
putParameter
in interface AWSSimpleSystemsManagement
putParameterRequest
- 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 15 levels. For more information, see Requirements and Constraints for Parameter Names in the AWS Systems Manager User Guide.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.PoliciesLimitExceededException
- You specified more than the maximum number of allowed policies for the parameter. The maximum is 10.InvalidPolicyTypeException
- The policy type is not supported. Parameter Store supports the following policy types: Expiration,
ExpirationNotification, and NoChangeNotification.InvalidPolicyAttributeException
- A policy attribute or its value is invalid.IncompatiblePolicyException
- There is a conflict in the policies specified for this parameter. You can't, for example, specify two
Expiration policies for a parameter. Review your policies, and try again.public RegisterDefaultPatchBaselineResult registerDefaultPatchBaseline(RegisterDefaultPatchBaselineRequest request)
Defines the default patch baseline.
registerDefaultPatchBaseline
in interface AWSSimpleSystemsManagement
registerDefaultPatchBaselineRequest
- 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, such as a maintenance window or Patch baseline,
doesn't exist.
For information about resource limits in Systems Manager, see AWS Systems Manager Limits.
InternalServerErrorException
- An error occurred on the server side.public RegisterPatchBaselineForPatchGroupResult registerPatchBaselineForPatchGroup(RegisterPatchBaselineForPatchGroupRequest request)
Registers a patch baseline for a patch group.
registerPatchBaselineForPatchGroup
in interface AWSSimpleSystemsManagement
registerPatchBaselineForPatchGroupRequest
- 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, such as a maintenance window or Patch baseline,
doesn't exist.
For information about resource limits in Systems Manager, see AWS Systems Manager Limits.
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. For example, too many
maintenance windows or patch baselines have been created.
For information about resource limits in Systems Manager, see AWS Systems Manager Limits.
InternalServerErrorException
- An error occurred on the server side.public RegisterTargetWithMaintenanceWindowResult registerTargetWithMaintenanceWindow(RegisterTargetWithMaintenanceWindowRequest request)
Registers a target with a maintenance window.
registerTargetWithMaintenanceWindow
in interface AWSSimpleSystemsManagement
registerTargetWithMaintenanceWindowRequest
- 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, such as a maintenance window or Patch baseline,
doesn't exist.
For information about resource limits in Systems Manager, see AWS Systems Manager Limits.
ResourceLimitExceededException
- Error returned when the caller has exceeded the default resource limits. For example, too many
maintenance windows or patch baselines have been created.
For information about resource limits in Systems Manager, see AWS Systems Manager Limits.
InternalServerErrorException
- An error occurred on the server side.public RegisterTaskWithMaintenanceWindowResult registerTaskWithMaintenanceWindow(RegisterTaskWithMaintenanceWindowRequest request)
Adds a new task to a maintenance window.
registerTaskWithMaintenanceWindow
in interface AWSSimpleSystemsManagement
registerTaskWithMaintenanceWindowRequest
- 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, such as a maintenance window or Patch baseline,
doesn't exist.
For information about resource limits in Systems Manager, see AWS Systems Manager Limits.
ResourceLimitExceededException
- Error returned when the caller has exceeded the default resource limits. For example, too many
maintenance windows or patch baselines have been created.
For information about resource limits in Systems Manager, see AWS Systems Manager Limits.
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 AWSSimpleSystemsManagement
removeTagsFromResourceRequest
- 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.TooManyUpdatesException
- There are concurrent updates for a resource that supports one update at a time.public ResetServiceSettingResult resetServiceSetting(ResetServiceSettingRequest request)
ServiceSetting
is an account-level setting for an AWS service. This setting defines how a user
interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the
account based on feature or service usage, then the AWS service team might create a default setting of "false".
This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for
a paid feature.
Services map a SettingId
object to a setting value. AWS services teams define the default value for
a SettingId
. You can't create a new SettingId
, but you can overwrite the default value
if you have the ssm:UpdateServiceSetting
permission for the setting. Use the
GetServiceSetting API action to view the current value. Use the UpdateServiceSetting API action to
change the default setting.
Reset the service setting for the account to the default value as provisioned by the AWS service team.
resetServiceSetting
in interface AWSSimpleSystemsManagement
resetServiceSettingRequest
- The request body of the ResetServiceSetting API action.InternalServerErrorException
- An error occurred on the server side.ServiceSettingNotFoundException
- The specified service setting was not found. Either the service name or the setting has not been
provisioned by the AWS service team.TooManyUpdatesException
- There are concurrent updates for a resource that supports one update at a time.public ResumeSessionResult resumeSession(ResumeSessionRequest request)
Reconnects a session to an instance after it has been disconnected. Connections can be resumed for disconnected sessions, but not terminated sessions.
This command is primarily for use by client machines to automatically reconnect during intermittent network issues. It is not intended for any other use.
resumeSession
in interface AWSSimpleSystemsManagement
resumeSessionRequest
- DoesNotExistException
- Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline,
doesn't exist.
For information about resource limits in Systems Manager, see AWS Systems Manager Limits.
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 AWSSimpleSystemsManagement
sendAutomationSignalRequest
- AutomationExecutionNotFoundException
- There is no automation execution information for the requested automation execution ID.AutomationStepNotFoundException
- The specified step name and execution ID don't exist. Verify the information and try again.InvalidAutomationSignalException
- The signal is not valid for the current Automation execution.InternalServerErrorException
- An error occurred on the server side.public SendCommandResult sendCommand(SendCommandRequest request)
Runs commands on one or more managed instances.
sendCommand
in interface AWSSimpleSystemsManagement
sendCommandRequest
- 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.
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.
SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling 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.InvalidDocumentVersionException
- The document version is not valid or 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 AWS 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 StartAssociationsOnceResult startAssociationsOnce(StartAssociationsOnceRequest request)
Use this API action to run an association immediately and only one time. This action can be helpful when troubleshooting associations.
startAssociationsOnce
in interface AWSSimpleSystemsManagement
startAssociationsOnceRequest
- InvalidAssociationException
- The association is not valid or does not exist.AssociationDoesNotExistException
- The specified association does not exist.public StartAutomationExecutionResult startAutomationExecution(StartAutomationExecutionRequest request)
Initiates execution of an Automation document.
startAutomationExecution
in interface AWSSimpleSystemsManagement
startAutomationExecutionRequest
- 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.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.InternalServerErrorException
- An error occurred on the server side.public StartSessionResult startSession(StartSessionRequest request)
Initiates a connection to a target (for example, an instance) for a Session Manager session. Returns a URL and token that can be used to open a WebSocket connection for sending input and receiving outputs.
AWS CLI usage: start-session
is an interactive command that requires the Session Manager plugin to
be installed on the client machine making the call. For information, see
Install the Session Manager Plugin for the AWS CLI in the AWS Systems Manager User Guide.
startSession
in interface AWSSimpleSystemsManagement
startSessionRequest
- InvalidDocumentException
- The specified document does not exist.TargetNotConnectedException
- The specified target instance for the session is not fully configured for use with Session Manager. For
more information, see Getting Started with Session Manager in the AWS Systems Manager User Guide.InternalServerErrorException
- An error occurred on the server side.public StopAutomationExecutionResult stopAutomationExecution(StopAutomationExecutionRequest request)
Stop an Automation that is currently running.
stopAutomationExecution
in interface AWSSimpleSystemsManagement
stopAutomationExecutionRequest
- AutomationExecutionNotFoundException
- There is no automation execution information for the requested automation execution ID.InvalidAutomationStatusUpdateException
- The specified update status operation is not valid.InternalServerErrorException
- An error occurred on the server side.public TerminateSessionResult terminateSession(TerminateSessionRequest request)
Permanently ends a session and closes the data connection between the Session Manager client and SSM Agent on the instance. A terminated session cannot be resumed.
terminateSession
in interface AWSSimpleSystemsManagement
terminateSessionRequest
- DoesNotExistException
- Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline,
doesn't exist.
For information about resource limits in Systems Manager, see AWS Systems Manager Limits.
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.
When you update an association, the association immediately runs against the specified targets.
updateAssociation
in interface AWSSimpleSystemsManagement
updateAssociationRequest
- 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 AWSSimpleSystemsManagement
updateAssociationStatusRequest
- 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.
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.
SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling 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 AWSSimpleSystemsManagement
updateDocumentRequest
- 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.DuplicateDocumentVersionNameException
- The version name has already been used in this document. Specify a different version name, and then 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.InvalidDocumentOperationException
- You attempted to delete a document while it is still shared. You must stop sharing the document before
you can delete it.public UpdateDocumentDefaultVersionResult updateDocumentDefaultVersion(UpdateDocumentDefaultVersionRequest request)
Set the default version of a document.
updateDocumentDefaultVersion
in interface AWSSimpleSystemsManagement
updateDocumentDefaultVersionRequest
- 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 AWSSimpleSystemsManagement
updateMaintenanceWindowRequest
- DoesNotExistException
- Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline,
doesn't exist.
For information about resource limits in Systems Manager, see AWS Systems Manager Limits.
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 AWSSimpleSystemsManagement
updateMaintenanceWindowTargetRequest
- DoesNotExistException
- Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline,
doesn't exist.
For information about resource limits in Systems Manager, see AWS Systems Manager Limits.
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:
TaskARN. For example, you can change a RUN_COMMAND task from AWS-RunPowerShellScript to AWS-RunShellScript.
ServiceRoleArn
TaskInvocationParameters
Priority
MaxConcurrency
MaxErrors
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 AWSSimpleSystemsManagement
updateMaintenanceWindowTaskRequest
- DoesNotExistException
- Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline,
doesn't exist.
For information about resource limits in Systems Manager, see AWS Systems Manager Limits.
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 AWSSimpleSystemsManagement
updateManagedInstanceRoleRequest
- InvalidInstanceIdException
- The following problems can cause this exception:
You do not have permission to access the instance.
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.
SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling 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.
For information about valid key and value pairs in PatchFilters
for each supported operating system
type, see PatchFilter.
updatePatchBaseline
in interface AWSSimpleSystemsManagement
updatePatchBaselineRequest
- DoesNotExistException
- Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline,
doesn't exist.
For information about resource limits in Systems Manager, see AWS Systems Manager Limits.
InternalServerErrorException
- An error occurred on the server side.public UpdateServiceSettingResult updateServiceSetting(UpdateServiceSettingRequest request)
ServiceSetting
is an account-level setting for an AWS service. This setting defines how a user
interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the
account based on feature or service usage, then the AWS service team might create a default setting of "false".
This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for
a paid feature.
Services map a SettingId
object to a setting value. AWS services teams define the default value for
a SettingId
. You can't create a new SettingId
, but you can overwrite the default value
if you have the ssm:UpdateServiceSetting
permission for the setting. Use the
GetServiceSetting API action to view the current value. Or, use the ResetServiceSetting to change
the value back to the original value defined by the AWS service team.
Update the service setting for the account.
updateServiceSetting
in interface AWSSimpleSystemsManagement
updateServiceSettingRequest
- The request body of the UpdateServiceSetting API action.InternalServerErrorException
- An error occurred on the server side.ServiceSettingNotFoundException
- The specified service setting was not found. Either the service name or the setting has not been
provisioned by the AWS service team.TooManyUpdatesException
- There are concurrent updates for a resource that supports one update at a time.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 AWSSimpleSystemsManagement
request
- The originally executed requestCopyright © 2019. All rights reserved.