@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSSimpleSystemsManagement
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSSimpleSystemsManagement instead.
Amazon EC2 Systems Manager is a collection of capabilities that helps you automate management tasks such as collecting system inventory, applying operating system (OS) patches, automating the creation of Amazon Machine Images (AMIs), and configuring operating systems (OSs) and applications at scale. Systems Manager lets you remotely and securely manage the configuration of your managed instances. A managed instance is any Amazon EC2 instance or on-premises machine in your hybrid environment that has been configured for Systems Manager.
This reference is intended to be used with the Amazon EC2 Systems Manager User Guide.
To get started, verify prerequisites and configure managed instances. For more information, see Systems Manager Prerequisites.
For information about other API actions you can perform on Amazon EC2 instances, see the Amazon EC2 API Reference. For information about how to use a Query API, see Making API Requests.
| Modifier and Type | Field and Description |
|---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
| Modifier and Type | Method and Description |
|---|---|
AddTagsToResourceResult |
addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest)
Adds or overwrites one or more tags for the specified resource.
|
CancelCommandResult |
cancelCommand(CancelCommandRequest cancelCommandRequest)
Attempts to cancel the command specified by the Command ID.
|
CreateActivationResult |
createActivation(CreateActivationRequest createActivationRequest)
Registers your on-premises server or virtual machine with Amazon EC2 so that you can manage these resources using
Run Command.
|
CreateAssociationResult |
createAssociation(CreateAssociationRequest createAssociationRequest)
Associates the specified Systems Manager document with the specified instances or targets.
|
CreateAssociationBatchResult |
createAssociationBatch(CreateAssociationBatchRequest createAssociationBatchRequest)
Associates the specified Systems Manager document with the specified instances or targets.
|
CreateDocumentResult |
createDocument(CreateDocumentRequest createDocumentRequest)
Creates a Systems Manager document.
|
CreateMaintenanceWindowResult |
createMaintenanceWindow(CreateMaintenanceWindowRequest createMaintenanceWindowRequest)
Creates a new Maintenance Window.
|
CreatePatchBaselineResult |
createPatchBaseline(CreatePatchBaselineRequest createPatchBaselineRequest)
Creates a patch baseline.
|
CreateResourceDataSyncResult |
createResourceDataSync(CreateResourceDataSyncRequest createResourceDataSyncRequest)
Creates a resource data sync configuration to a single bucket in Amazon S3.
|
DeleteActivationResult |
deleteActivation(DeleteActivationRequest deleteActivationRequest)
Deletes an activation.
|
DeleteAssociationResult |
deleteAssociation(DeleteAssociationRequest deleteAssociationRequest)
Disassociates the specified Systems Manager document from the specified instance.
|
DeleteDocumentResult |
deleteDocument(DeleteDocumentRequest deleteDocumentRequest)
Deletes the Systems Manager document and all instance associations to the document.
|
DeleteMaintenanceWindowResult |
deleteMaintenanceWindow(DeleteMaintenanceWindowRequest deleteMaintenanceWindowRequest)
Deletes a Maintenance Window.
|
DeleteParameterResult |
deleteParameter(DeleteParameterRequest deleteParameterRequest)
Delete a parameter from the system.
|
DeleteParametersResult |
deleteParameters(DeleteParametersRequest deleteParametersRequest)
Delete a list of parameters.
|
DeletePatchBaselineResult |
deletePatchBaseline(DeletePatchBaselineRequest deletePatchBaselineRequest)
Deletes a patch baseline.
|
DeleteResourceDataSyncResult |
deleteResourceDataSync(DeleteResourceDataSyncRequest deleteResourceDataSyncRequest)
Deletes a Resource Data Sync configuration.
|
DeregisterManagedInstanceResult |
deregisterManagedInstance(DeregisterManagedInstanceRequest deregisterManagedInstanceRequest)
Removes the server or virtual machine from the list of registered servers.
|
DeregisterPatchBaselineForPatchGroupResult |
deregisterPatchBaselineForPatchGroup(DeregisterPatchBaselineForPatchGroupRequest deregisterPatchBaselineForPatchGroupRequest)
Removes a patch group from a patch baseline.
|
DeregisterTargetFromMaintenanceWindowResult |
deregisterTargetFromMaintenanceWindow(DeregisterTargetFromMaintenanceWindowRequest deregisterTargetFromMaintenanceWindowRequest)
Removes a target from a Maintenance Window.
|
DeregisterTaskFromMaintenanceWindowResult |
deregisterTaskFromMaintenanceWindow(DeregisterTaskFromMaintenanceWindowRequest deregisterTaskFromMaintenanceWindowRequest)
Removes a task from a Maintenance Window.
|
DescribeActivationsResult |
describeActivations(DescribeActivationsRequest describeActivationsRequest)
Details about the activation, including: the date and time the activation was created, the expiration date, the
IAM role assigned to the instances in the activation, and the number of instances activated by this registration.
|
DescribeAssociationResult |
describeAssociation(DescribeAssociationRequest describeAssociationRequest)
Describes the associations for the specified Systems Manager document or instance.
|
DescribeAutomationExecutionsResult |
describeAutomationExecutions(DescribeAutomationExecutionsRequest describeAutomationExecutionsRequest)
Provides details about all active and terminated Automation executions.
|
DescribeAvailablePatchesResult |
describeAvailablePatches(DescribeAvailablePatchesRequest describeAvailablePatchesRequest)
Lists all patches that could possibly be included in a patch baseline.
|
DescribeDocumentResult |
describeDocument(DescribeDocumentRequest describeDocumentRequest)
Describes the specified Systems Manager document.
|
DescribeDocumentPermissionResult |
describeDocumentPermission(DescribeDocumentPermissionRequest describeDocumentPermissionRequest)
Describes the permissions for a Systems Manager document.
|
DescribeEffectiveInstanceAssociationsResult |
describeEffectiveInstanceAssociations(DescribeEffectiveInstanceAssociationsRequest describeEffectiveInstanceAssociationsRequest)
All associations for the instance(s).
|
DescribeEffectivePatchesForPatchBaselineResult |
describeEffectivePatchesForPatchBaseline(DescribeEffectivePatchesForPatchBaselineRequest describeEffectivePatchesForPatchBaselineRequest)
Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline.
|
DescribeInstanceAssociationsStatusResult |
describeInstanceAssociationsStatus(DescribeInstanceAssociationsStatusRequest describeInstanceAssociationsStatusRequest)
The status of the associations for the instance(s).
|
DescribeInstanceInformationResult |
describeInstanceInformation(DescribeInstanceInformationRequest describeInstanceInformationRequest)
Describes one or more of your instances.
|
DescribeInstancePatchesResult |
describeInstancePatches(DescribeInstancePatchesRequest describeInstancePatchesRequest)
Retrieves information about the patches on the specified instance and their state relative to the patch baseline
being used for the instance.
|
DescribeInstancePatchStatesResult |
describeInstancePatchStates(DescribeInstancePatchStatesRequest describeInstancePatchStatesRequest)
Retrieves the high-level patch state of one or more instances.
|
DescribeInstancePatchStatesForPatchGroupResult |
describeInstancePatchStatesForPatchGroup(DescribeInstancePatchStatesForPatchGroupRequest describeInstancePatchStatesForPatchGroupRequest)
Retrieves the high-level patch state for the instances in the specified patch group.
|
DescribeMaintenanceWindowExecutionsResult |
describeMaintenanceWindowExecutions(DescribeMaintenanceWindowExecutionsRequest describeMaintenanceWindowExecutionsRequest)
Lists the executions of a Maintenance Window.
|
DescribeMaintenanceWindowExecutionTaskInvocationsResult |
describeMaintenanceWindowExecutionTaskInvocations(DescribeMaintenanceWindowExecutionTaskInvocationsRequest describeMaintenanceWindowExecutionTaskInvocationsRequest)
Retrieves the individual task executions (one per target) for a particular task executed as part of a Maintenance
Window execution.
|
DescribeMaintenanceWindowExecutionTasksResult |
describeMaintenanceWindowExecutionTasks(DescribeMaintenanceWindowExecutionTasksRequest describeMaintenanceWindowExecutionTasksRequest)
For a given Maintenance Window execution, lists the tasks that were executed.
|
DescribeMaintenanceWindowsResult |
describeMaintenanceWindows(DescribeMaintenanceWindowsRequest describeMaintenanceWindowsRequest)
Retrieves the Maintenance Windows in an AWS account.
|
DescribeMaintenanceWindowTargetsResult |
describeMaintenanceWindowTargets(DescribeMaintenanceWindowTargetsRequest describeMaintenanceWindowTargetsRequest)
Lists the targets registered with the Maintenance Window.
|
DescribeMaintenanceWindowTasksResult |
describeMaintenanceWindowTasks(DescribeMaintenanceWindowTasksRequest describeMaintenanceWindowTasksRequest)
Lists the tasks in a Maintenance Window.
|
DescribeParametersResult |
describeParameters(DescribeParametersRequest describeParametersRequest)
Get information about a parameter.
|
DescribePatchBaselinesResult |
describePatchBaselines(DescribePatchBaselinesRequest describePatchBaselinesRequest)
Lists the patch baselines in your AWS account.
|
DescribePatchGroupsResult |
describePatchGroups(DescribePatchGroupsRequest describePatchGroupsRequest)
Lists all patch groups that have been registered with patch baselines.
|
DescribePatchGroupStateResult |
describePatchGroupState(DescribePatchGroupStateRequest describePatchGroupStateRequest)
Returns high-level aggregated patch compliance state for a patch group.
|
GetAutomationExecutionResult |
getAutomationExecution(GetAutomationExecutionRequest getAutomationExecutionRequest)
Get detailed information about a particular Automation execution.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetCommandInvocationResult |
getCommandInvocation(GetCommandInvocationRequest getCommandInvocationRequest)
Returns detailed information about command execution for an invocation or plugin.
|
GetDefaultPatchBaselineResult |
getDefaultPatchBaseline(GetDefaultPatchBaselineRequest getDefaultPatchBaselineRequest)
Retrieves the default patch baseline.
|
GetDeployablePatchSnapshotForInstanceResult |
getDeployablePatchSnapshotForInstance(GetDeployablePatchSnapshotForInstanceRequest getDeployablePatchSnapshotForInstanceRequest)
Retrieves the current snapshot for the patch baseline the instance uses.
|
GetDocumentResult |
getDocument(GetDocumentRequest getDocumentRequest)
Gets the contents of the specified Systems Manager document.
|
GetInventoryResult |
getInventory(GetInventoryRequest getInventoryRequest)
Query inventory information.
|
GetInventorySchemaResult |
getInventorySchema(GetInventorySchemaRequest getInventorySchemaRequest)
Return a list of inventory type names for the account, or return a list of attribute names for a specific
Inventory item type.
|
GetMaintenanceWindowResult |
getMaintenanceWindow(GetMaintenanceWindowRequest getMaintenanceWindowRequest)
Retrieves a Maintenance Window.
|
GetMaintenanceWindowExecutionResult |
getMaintenanceWindowExecution(GetMaintenanceWindowExecutionRequest getMaintenanceWindowExecutionRequest)
Retrieves details about a specific task executed as part of a Maintenance Window execution.
|
GetMaintenanceWindowExecutionTaskResult |
getMaintenanceWindowExecutionTask(GetMaintenanceWindowExecutionTaskRequest getMaintenanceWindowExecutionTaskRequest)
Retrieves the details about a specific task executed as part of a Maintenance Window execution.
|
GetMaintenanceWindowExecutionTaskInvocationResult |
getMaintenanceWindowExecutionTaskInvocation(GetMaintenanceWindowExecutionTaskInvocationRequest getMaintenanceWindowExecutionTaskInvocationRequest)
Retrieves a task invocation.
|
GetMaintenanceWindowTaskResult |
getMaintenanceWindowTask(GetMaintenanceWindowTaskRequest getMaintenanceWindowTaskRequest)
Lists the tasks in a Maintenance Window.
|
GetParameterResult |
getParameter(GetParameterRequest getParameterRequest)
Get information about a parameter by using the parameter name.
|
GetParameterHistoryResult |
getParameterHistory(GetParameterHistoryRequest getParameterHistoryRequest)
Query a list of all parameters used by the AWS account.
|
GetParametersResult |
getParameters(GetParametersRequest getParametersRequest)
Get details of a parameter.
|
GetParametersByPathResult |
getParametersByPath(GetParametersByPathRequest getParametersByPathRequest)
Retrieve parameters in a specific hierarchy.
|
GetPatchBaselineResult |
getPatchBaseline(GetPatchBaselineRequest getPatchBaselineRequest)
Retrieves information about a patch baseline.
|
GetPatchBaselineForPatchGroupResult |
getPatchBaselineForPatchGroup(GetPatchBaselineForPatchGroupRequest getPatchBaselineForPatchGroupRequest)
Retrieves the patch baseline that should be used for the specified patch group.
|
ListAssociationsResult |
listAssociations(ListAssociationsRequest listAssociationsRequest)
Lists the associations for the specified Systems Manager document or instance.
|
ListAssociationVersionsResult |
listAssociationVersions(ListAssociationVersionsRequest listAssociationVersionsRequest)
Retrieves all versions of an association for a specific association ID.
|
ListCommandInvocationsResult |
listCommandInvocations(ListCommandInvocationsRequest listCommandInvocationsRequest)
An invocation is copy of a command sent to a specific instance.
|
ListCommandsResult |
listCommands(ListCommandsRequest listCommandsRequest)
Lists the commands requested by users of the AWS account.
|
ListComplianceItemsResult |
listComplianceItems(ListComplianceItemsRequest listComplianceItemsRequest)
For a specified resource ID, this API action returns a list of compliance statuses for different resource types.
|
ListComplianceSummariesResult |
listComplianceSummaries(ListComplianceSummariesRequest listComplianceSummariesRequest)
Returns a summary count of compliant and non-compliant resources for a compliance type.
|
ListDocumentsResult |
listDocuments()
Simplified method form for invoking the ListDocuments operation.
|
ListDocumentsResult |
listDocuments(ListDocumentsRequest listDocumentsRequest)
Describes one or more of your Systems Manager documents.
|
ListDocumentVersionsResult |
listDocumentVersions(ListDocumentVersionsRequest listDocumentVersionsRequest)
List all versions for a document.
|
ListInventoryEntriesResult |
listInventoryEntries(ListInventoryEntriesRequest listInventoryEntriesRequest)
A list of inventory items returned by the request.
|
ListResourceComplianceSummariesResult |
listResourceComplianceSummaries(ListResourceComplianceSummariesRequest listResourceComplianceSummariesRequest)
Returns a resource-level summary count.
|
ListResourceDataSyncResult |
listResourceDataSync(ListResourceDataSyncRequest listResourceDataSyncRequest)
Lists your resource data sync configurations.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Returns a list of the tags assigned to the specified resource.
|
ModifyDocumentPermissionResult |
modifyDocumentPermission(ModifyDocumentPermissionRequest modifyDocumentPermissionRequest)
Shares a Systems Manager document publicly or privately.
|
PutComplianceItemsResult |
putComplianceItems(PutComplianceItemsRequest putComplianceItemsRequest)
Registers a compliance type and other compliance details on a designated resource.
|
PutInventoryResult |
putInventory(PutInventoryRequest putInventoryRequest)
Bulk update custom inventory items on one more instance.
|
PutParameterResult |
putParameter(PutParameterRequest putParameterRequest)
Add one or more parameters to the system.
|
RegisterDefaultPatchBaselineResult |
registerDefaultPatchBaseline(RegisterDefaultPatchBaselineRequest registerDefaultPatchBaselineRequest)
Defines the default patch baseline.
|
RegisterPatchBaselineForPatchGroupResult |
registerPatchBaselineForPatchGroup(RegisterPatchBaselineForPatchGroupRequest registerPatchBaselineForPatchGroupRequest)
Registers a patch baseline for a patch group.
|
RegisterTargetWithMaintenanceWindowResult |
registerTargetWithMaintenanceWindow(RegisterTargetWithMaintenanceWindowRequest registerTargetWithMaintenanceWindowRequest)
Registers a target with a Maintenance Window.
|
RegisterTaskWithMaintenanceWindowResult |
registerTaskWithMaintenanceWindow(RegisterTaskWithMaintenanceWindowRequest registerTaskWithMaintenanceWindowRequest)
Adds a new task to a Maintenance Window.
|
RemoveTagsFromResourceResult |
removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)
Removes all tags from the specified resource.
|
SendAutomationSignalResult |
sendAutomationSignal(SendAutomationSignalRequest sendAutomationSignalRequest)
Sends a signal to an Automation execution to change the current behavior or status of the execution.
|
SendCommandResult |
sendCommand(SendCommandRequest sendCommandRequest)
Executes commands on one or more managed instances.
|
void |
setEndpoint(String endpoint)
Deprecated.
use
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion)); |
void |
setRegion(Region region)
Deprecated.
use
AwsClientBuilder#setRegion(String) |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
StartAutomationExecutionResult |
startAutomationExecution(StartAutomationExecutionRequest startAutomationExecutionRequest)
Initiates execution of an Automation document.
|
StopAutomationExecutionResult |
stopAutomationExecution(StopAutomationExecutionRequest stopAutomationExecutionRequest)
Stop an Automation that is currently executing.
|
UpdateAssociationResult |
updateAssociation(UpdateAssociationRequest updateAssociationRequest)
Updates an association.
|
UpdateAssociationStatusResult |
updateAssociationStatus(UpdateAssociationStatusRequest updateAssociationStatusRequest)
Updates the status of the Systems Manager document associated with the specified instance.
|
UpdateDocumentResult |
updateDocument(UpdateDocumentRequest updateDocumentRequest)
The document you want to update.
|
UpdateDocumentDefaultVersionResult |
updateDocumentDefaultVersion(UpdateDocumentDefaultVersionRequest updateDocumentDefaultVersionRequest)
Set the default version of a document.
|
UpdateMaintenanceWindowResult |
updateMaintenanceWindow(UpdateMaintenanceWindowRequest updateMaintenanceWindowRequest)
Updates an existing Maintenance Window.
|
UpdateMaintenanceWindowTargetResult |
updateMaintenanceWindowTarget(UpdateMaintenanceWindowTargetRequest updateMaintenanceWindowTargetRequest)
Modifies the target of an existing Maintenance Window.
|
UpdateMaintenanceWindowTaskResult |
updateMaintenanceWindowTask(UpdateMaintenanceWindowTaskRequest updateMaintenanceWindowTaskRequest)
Modifies a task assigned to a Maintenance Window.
|
UpdateManagedInstanceRoleResult |
updateManagedInstanceRole(UpdateManagedInstanceRoleRequest updateManagedInstanceRoleRequest)
Assigns or changes an Amazon Identity and Access Management (IAM) role to the managed instance.
|
UpdatePatchBaselineResult |
updatePatchBaseline(UpdatePatchBaselineRequest updatePatchBaselineRequest)
Modifies an existing patch baseline.
|
static final String ENDPOINT_PREFIX
@Deprecated void setEndpoint(String endpoint)
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
Callers can pass in just the endpoint (ex: "ssm.us-east-1.amazonaws.com") or a full URL, including the protocol
(ex: "https://ssm.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from
this client's ClientConfiguration will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
endpoint - The endpoint (ex: "ssm.us-east-1.amazonaws.com") or a full URL, including the protocol (ex:
"https://ssm.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate
with.@Deprecated void setRegion(Region region)
AwsClientBuilder#setRegion(String)setEndpoint(String), sets the regional endpoint for this
client's service calls. Callers can use this method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.Region.getRegion(com.amazonaws.regions.Regions),
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration),
Region.isServiceSupported(String)AddTagsToResourceResult addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest)
Adds or overwrites one or more tags for the specified resource. Tags are metadata that you can assign to your documents, managed instances, Maintenance Windows, Parameter Store parameters, and patch baselines. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define. For example, you could define a set of tags for your account's managed instances that helps you track each instance's owner and stack level. For example: Key=Owner and Value=DbAdmin, SysAdmin, or Dev. Or Key=Stack and Value=Production, Pre-Production, or Test.
Each resource can have a maximum of 10 tags.
We recommend that you devise a set of tag keys that meets your needs for each resource type. Using a consistent set of tag keys makes it easier for you to manage your resources. You can search and filter the resources based on the tags you add. Tags don't have any semantic meaning to Amazon EC2 and are interpreted strictly as a string of characters.
For more information about tags, see Tagging Your Amazon EC2 Resources in the Amazon EC2 User Guide.
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.CancelCommandResult cancelCommand(CancelCommandRequest cancelCommandRequest)
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.
cancelCommandRequest - InternalServerErrorException - An error occurred on the server side.InvalidCommandIdExceptionInvalidInstanceIdException - The following problems can cause this exception:
You do not have permission to access the instance.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
DuplicateInstanceIdException - You cannot specify an instance ID in more than one association.CreateActivationResult createActivation(CreateActivationRequest createActivationRequest)
Registers your on-premises server or virtual machine with Amazon EC2 so that you can manage these resources using Run Command. An on-premises server or virtual machine that has been registered with EC2 is called a managed instance. For more information about activations, see Setting Up Systems Manager in Hybrid Environments.
createActivationRequest - InternalServerErrorException - An error occurred on the server side.CreateAssociationResult createAssociation(CreateAssociationRequest createAssociationRequest)
Associates the specified Systems Manager document with the specified instances or targets.
When you associate a document with one or more instances using instance IDs or tags, the SSM Agent running on the instance processes the document and configures the instance as specified.
If you associate a document with an instance that already has an associated document, the system throws the AssociationAlreadyExists exception.
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.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
UnsupportedPlatformTypeException - The document does not support the platform type of the given instance ID(s). For example, you sent an
document for a Windows instance to a Linux instance.InvalidOutputLocationException - The output location is not valid or does not exist.InvalidParametersException - You must specify values for all required parameters in the Systems Manager document. You can only supply
values to parameters defined in the Systems Manager document.InvalidTargetException - The target is not valid or does not exist. It might not be configured for EC2 Systems Manager or you
might not have permission to perform the operation.InvalidScheduleException - The schedule is invalid. Verify your cron or rate expression and try again.CreateAssociationBatchResult createAssociationBatch(CreateAssociationBatchRequest createAssociationBatchRequest)
Associates the specified Systems Manager document with the specified instances or targets.
When you associate a document with one or more instances using instance IDs or tags, the SSM Agent running on the instance processes the document and configures the instance as specified.
If you associate a document with an instance that already has an associated document, the system throws the AssociationAlreadyExists exception.
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.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
InvalidParametersException - You must specify values for all required parameters in the Systems Manager document. You can only supply
values to parameters defined in the Systems Manager document.DuplicateInstanceIdException - You cannot specify an instance ID in more than one association.AssociationLimitExceededException - You can have at most 2,000 active associations.UnsupportedPlatformTypeException - The document does not support the platform type of the given instance ID(s). For example, you sent an
document for a Windows instance to a Linux instance.InvalidOutputLocationException - The output location is not valid or does not exist.InvalidTargetException - The target is not valid or does not exist. It might not be configured for EC2 Systems Manager or you
might not have permission to perform the operation.InvalidScheduleException - The schedule is invalid. Verify your cron or rate expression and try again.CreateDocumentResult createDocument(CreateDocumentRequest createDocumentRequest)
Creates a Systems Manager document.
After you create a document, you can use CreateAssociation to associate it with one or more running instances.
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.CreateMaintenanceWindowResult createMaintenanceWindow(CreateMaintenanceWindowRequest createMaintenanceWindowRequest)
Creates a new Maintenance Window.
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 (e.g. too many Maintenance
Windows have been created).InternalServerErrorException - An error occurred on the server side.CreatePatchBaselineResult createPatchBaseline(CreatePatchBaselineRequest createPatchBaselineRequest)
Creates a patch baseline.
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 (e.g. too many Maintenance
Windows have been created).InternalServerErrorException - An error occurred on the server side.CreateResourceDataSyncResult createResourceDataSync(CreateResourceDataSyncRequest createResourceDataSyncRequest)
Creates a resource data sync configuration to a single bucket in Amazon S3. This is an asynchronous operation that returns immediately. After a successful initial sync is completed, the system continuously syncs data to the Amazon S3 bucket. To check the status of the sync, use the ListResourceDataSync operation.
By default, data is not encrypted in Amazon S3. We strongly recommend that you enable encryption in Amazon S3 to ensure secure data storage. We also recommend that you secure access to the Amazon S3 bucket by creating a restrictive bucket policy. To view an example of a restrictive Amazon S3 bucket policy for Resource Data Sync, see Configuring Resource Data Sync for Inventory.
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.DeleteActivationResult deleteActivation(DeleteActivationRequest deleteActivationRequest)
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.
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.DeleteAssociationResult deleteAssociation(DeleteAssociationRequest deleteAssociationRequest)
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.
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.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
TooManyUpdatesException - There are concurrent updates for a resource that supports one update at a time.DeleteDocumentResult deleteDocument(DeleteDocumentRequest deleteDocumentRequest)
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.
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.DeleteMaintenanceWindowResult deleteMaintenanceWindow(DeleteMaintenanceWindowRequest deleteMaintenanceWindowRequest)
Deletes a Maintenance Window.
deleteMaintenanceWindowRequest - InternalServerErrorException - An error occurred on the server side.DeleteParameterResult deleteParameter(DeleteParameterRequest deleteParameterRequest)
Delete a parameter from the system.
deleteParameterRequest - InternalServerErrorException - An error occurred on the server side.ParameterNotFoundException - The parameter could not be found. Verify the name and try again.DeleteParametersResult deleteParameters(DeleteParametersRequest deleteParametersRequest)
Delete a list of parameters. This API is used to delete parameters by using the Amazon EC2 console.
deleteParametersRequest - InternalServerErrorException - An error occurred on the server side.DeletePatchBaselineResult deletePatchBaseline(DeletePatchBaselineRequest deletePatchBaselineRequest)
Deletes a patch baseline.
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.DeleteResourceDataSyncResult deleteResourceDataSync(DeleteResourceDataSyncRequest deleteResourceDataSyncRequest)
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.
deleteResourceDataSyncRequest - InternalServerErrorException - An error occurred on the server side.ResourceDataSyncNotFoundException - The specified sync name was not found.DeregisterManagedInstanceResult deregisterManagedInstance(DeregisterManagedInstanceRequest deregisterManagedInstanceRequest)
Removes the server or virtual machine from the list of registered servers. You can reregister the instance again at any time. If you don't plan to use Run Command on the server, we suggest uninstalling the SSM Agent first.
deregisterManagedInstanceRequest - InvalidInstanceIdException - The following problems can cause this exception:
You do not have permission to access the instance.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
InternalServerErrorException - An error occurred on the server side.DeregisterPatchBaselineForPatchGroupResult deregisterPatchBaselineForPatchGroup(DeregisterPatchBaselineForPatchGroupRequest deregisterPatchBaselineForPatchGroupRequest)
Removes a patch group from a patch baseline.
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.DeregisterTargetFromMaintenanceWindowResult deregisterTargetFromMaintenanceWindow(DeregisterTargetFromMaintenanceWindowRequest deregisterTargetFromMaintenanceWindowRequest)
Removes a target from a Maintenance Window.
deregisterTargetFromMaintenanceWindowRequest - DoesNotExistException - Error returned when the ID specified for a resource (e.g. a Maintenance Window) doesn't exist.InternalServerErrorException - An error occurred on the server side.TargetInUseException - You specified the Safe option for the DeregisterTargetFromMaintenanceWindow operation, but
the target is still referenced in a task.DeregisterTaskFromMaintenanceWindowResult deregisterTaskFromMaintenanceWindow(DeregisterTaskFromMaintenanceWindowRequest deregisterTaskFromMaintenanceWindowRequest)
Removes a task from a Maintenance Window.
deregisterTaskFromMaintenanceWindowRequest - DoesNotExistException - Error returned when the ID specified for a resource (e.g. a Maintenance Window) doesn't exist.InternalServerErrorException - An error occurred on the server side.DescribeActivationsResult describeActivations(DescribeActivationsRequest describeActivationsRequest)
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.
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.DescribeAssociationResult describeAssociation(DescribeAssociationRequest describeAssociationRequest)
Describes the associations for the specified Systems Manager document or instance.
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.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
DescribeAutomationExecutionsResult describeAutomationExecutions(DescribeAutomationExecutionsRequest describeAutomationExecutionsRequest)
Provides details about all active and terminated Automation executions.
describeAutomationExecutionsRequest - InvalidNextTokenException - The specified token is not valid.InternalServerErrorException - An error occurred on the server side.DescribeAvailablePatchesResult describeAvailablePatches(DescribeAvailablePatchesRequest describeAvailablePatchesRequest)
Lists all patches that could possibly be included in a patch baseline.
describeAvailablePatchesRequest - InternalServerErrorException - An error occurred on the server side.DescribeDocumentResult describeDocument(DescribeDocumentRequest describeDocumentRequest)
Describes the specified Systems Manager document.
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.DescribeDocumentPermissionResult describeDocumentPermission(DescribeDocumentPermissionRequest describeDocumentPermissionRequest)
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).
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.DescribeEffectiveInstanceAssociationsResult describeEffectiveInstanceAssociations(DescribeEffectiveInstanceAssociationsRequest describeEffectiveInstanceAssociationsRequest)
All associations for the instance(s).
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.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
InvalidNextTokenException - The specified token is not valid.DescribeEffectivePatchesForPatchBaselineResult describeEffectivePatchesForPatchBaseline(DescribeEffectivePatchesForPatchBaselineRequest describeEffectivePatchesForPatchBaselineRequest)
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.
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 (e.g. a Maintenance Window) doesn't exist.UnsupportedOperatingSystemException - The operating systems you specified is not supported, or the operation is not supported for the operating
system. Valid operating systems include: Windows, AmazonLinux, RedhatEnterpriseLinux, and Ubuntu.InternalServerErrorException - An error occurred on the server side.DescribeInstanceAssociationsStatusResult describeInstanceAssociationsStatus(DescribeInstanceAssociationsStatusRequest describeInstanceAssociationsStatusRequest)
The status of the associations for the instance(s).
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.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
InvalidNextTokenException - The specified token is not valid.DescribeInstanceInformationResult describeInstanceInformation(DescribeInstanceInformationRequest describeInstanceInformationRequest)
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.
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.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
InvalidNextTokenException - The specified token is not valid.InvalidInstanceInformationFilterValueException - The specified filter value is not valid.InvalidFilterKeyException - The specified key is not valid.DescribeInstancePatchStatesResult describeInstancePatchStates(DescribeInstancePatchStatesRequest describeInstancePatchStatesRequest)
Retrieves the high-level patch state of one or more instances.
describeInstancePatchStatesRequest - InternalServerErrorException - An error occurred on the server side.InvalidNextTokenException - The specified token is not valid.DescribeInstancePatchStatesForPatchGroupResult describeInstancePatchStatesForPatchGroup(DescribeInstancePatchStatesForPatchGroupRequest describeInstancePatchStatesForPatchGroupRequest)
Retrieves the high-level patch state for the instances in the specified patch group.
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.DescribeInstancePatchesResult describeInstancePatches(DescribeInstancePatchesRequest describeInstancePatchesRequest)
Retrieves information about the patches on the specified instance and their state relative to the patch baseline being used for the instance.
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.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
InvalidFilterException - The filter name is not valid. Verify the you entered the correct name and try again.InvalidNextTokenException - The specified token is not valid.DescribeMaintenanceWindowExecutionTaskInvocationsResult describeMaintenanceWindowExecutionTaskInvocations(DescribeMaintenanceWindowExecutionTaskInvocationsRequest describeMaintenanceWindowExecutionTaskInvocationsRequest)
Retrieves the individual task executions (one per target) for a particular task executed as part of a Maintenance Window execution.
describeMaintenanceWindowExecutionTaskInvocationsRequest - DoesNotExistException - Error returned when the ID specified for a resource (e.g. a Maintenance Window) doesn't exist.InternalServerErrorException - An error occurred on the server side.DescribeMaintenanceWindowExecutionTasksResult describeMaintenanceWindowExecutionTasks(DescribeMaintenanceWindowExecutionTasksRequest describeMaintenanceWindowExecutionTasksRequest)
For a given Maintenance Window execution, lists the tasks that were executed.
describeMaintenanceWindowExecutionTasksRequest - DoesNotExistException - Error returned when the ID specified for a resource (e.g. a Maintenance Window) doesn't exist.InternalServerErrorException - An error occurred on the server side.DescribeMaintenanceWindowExecutionsResult describeMaintenanceWindowExecutions(DescribeMaintenanceWindowExecutionsRequest describeMaintenanceWindowExecutionsRequest)
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.
describeMaintenanceWindowExecutionsRequest - InternalServerErrorException - An error occurred on the server side.DescribeMaintenanceWindowTargetsResult describeMaintenanceWindowTargets(DescribeMaintenanceWindowTargetsRequest describeMaintenanceWindowTargetsRequest)
Lists the targets registered with the Maintenance Window.
describeMaintenanceWindowTargetsRequest - DoesNotExistException - Error returned when the ID specified for a resource (e.g. a Maintenance Window) doesn't exist.InternalServerErrorException - An error occurred on the server side.DescribeMaintenanceWindowTasksResult describeMaintenanceWindowTasks(DescribeMaintenanceWindowTasksRequest describeMaintenanceWindowTasksRequest)
Lists the tasks in a Maintenance Window.
describeMaintenanceWindowTasksRequest - DoesNotExistException - Error returned when the ID specified for a resource (e.g. a Maintenance Window) doesn't exist.InternalServerErrorException - An error occurred on the server side.DescribeMaintenanceWindowsResult describeMaintenanceWindows(DescribeMaintenanceWindowsRequest describeMaintenanceWindowsRequest)
Retrieves the Maintenance Windows in an AWS account.
describeMaintenanceWindowsRequest - InternalServerErrorException - An error occurred on the server side.DescribeParametersResult describeParameters(DescribeParametersRequest describeParametersRequest)
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.
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.DescribePatchBaselinesResult describePatchBaselines(DescribePatchBaselinesRequest describePatchBaselinesRequest)
Lists the patch baselines in your AWS account.
describePatchBaselinesRequest - InternalServerErrorException - An error occurred on the server side.DescribePatchGroupStateResult describePatchGroupState(DescribePatchGroupStateRequest describePatchGroupStateRequest)
Returns high-level aggregated patch compliance state for a patch group.
describePatchGroupStateRequest - InternalServerErrorException - An error occurred on the server side.InvalidNextTokenException - The specified token is not valid.DescribePatchGroupsResult describePatchGroups(DescribePatchGroupsRequest describePatchGroupsRequest)
Lists all patch groups that have been registered with patch baselines.
describePatchGroupsRequest - InternalServerErrorException - An error occurred on the server side.GetAutomationExecutionResult getAutomationExecution(GetAutomationExecutionRequest getAutomationExecutionRequest)
Get detailed information about a particular Automation execution.
getAutomationExecutionRequest - AutomationExecutionNotFoundException - There is no automation execution information for the requested automation execution ID.InternalServerErrorException - An error occurred on the server side.GetCommandInvocationResult getCommandInvocation(GetCommandInvocationRequest getCommandInvocationRequest)
Returns detailed information about command execution for an invocation or plugin.
getCommandInvocationRequest - InternalServerErrorException - An error occurred on the server side.InvalidCommandIdExceptionInvalidInstanceIdException - The following problems can cause this exception:
You do not have permission to access the instance.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
InvalidPluginNameException - The plugin name is not valid.InvocationDoesNotExistException - The command ID and instance ID you specified did not match any invocations. Verify the command ID adn the
instance ID and try again.GetDefaultPatchBaselineResult getDefaultPatchBaseline(GetDefaultPatchBaselineRequest getDefaultPatchBaselineRequest)
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.
getDefaultPatchBaselineRequest - InternalServerErrorException - An error occurred on the server side.GetDeployablePatchSnapshotForInstanceResult getDeployablePatchSnapshotForInstance(GetDeployablePatchSnapshotForInstanceRequest getDeployablePatchSnapshotForInstanceRequest)
Retrieves the current snapshot for the patch baseline the instance uses. This API is primarily used by the AWS-RunPatchBaseline Systems Manager document.
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.GetDocumentResult getDocument(GetDocumentRequest getDocumentRequest)
Gets the contents of the specified Systems Manager document.
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.GetInventoryResult getInventory(GetInventoryRequest getInventoryRequest)
Query inventory information.
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.InvalidNextTokenException - The specified token is not valid.InvalidTypeNameException - The parameter type name is not valid.InvalidResultAttributeException - The specified inventory item result attribute is not valid.GetInventorySchemaResult getInventorySchema(GetInventorySchemaRequest getInventorySchemaRequest)
Return a list of inventory type names for the account, or return a list of attribute names for a specific Inventory item type.
getInventorySchemaRequest - InternalServerErrorException - An error occurred on the server side.InvalidTypeNameException - The parameter type name is not valid.InvalidNextTokenException - The specified token is not valid.GetMaintenanceWindowResult getMaintenanceWindow(GetMaintenanceWindowRequest getMaintenanceWindowRequest)
Retrieves a Maintenance Window.
getMaintenanceWindowRequest - DoesNotExistException - Error returned when the ID specified for a resource (e.g. a Maintenance Window) doesn't exist.InternalServerErrorException - An error occurred on the server side.GetMaintenanceWindowExecutionResult getMaintenanceWindowExecution(GetMaintenanceWindowExecutionRequest getMaintenanceWindowExecutionRequest)
Retrieves details about a specific task executed as part of a Maintenance Window execution.
getMaintenanceWindowExecutionRequest - DoesNotExistException - Error returned when the ID specified for a resource (e.g. a Maintenance Window) doesn't exist.InternalServerErrorException - An error occurred on the server side.GetMaintenanceWindowExecutionTaskResult getMaintenanceWindowExecutionTask(GetMaintenanceWindowExecutionTaskRequest getMaintenanceWindowExecutionTaskRequest)
Retrieves the details about a specific task executed as part of a Maintenance Window execution.
getMaintenanceWindowExecutionTaskRequest - DoesNotExistException - Error returned when the ID specified for a resource (e.g. a Maintenance Window) doesn't exist.InternalServerErrorException - An error occurred on the server side.GetMaintenanceWindowExecutionTaskInvocationResult getMaintenanceWindowExecutionTaskInvocation(GetMaintenanceWindowExecutionTaskInvocationRequest getMaintenanceWindowExecutionTaskInvocationRequest)
Retrieves a task invocation. A task invocation is a specific task executing on a specific target. Maintenance Windows report status for all invocations.
getMaintenanceWindowExecutionTaskInvocationRequest - DoesNotExistException - Error returned when the ID specified for a resource (e.g. a Maintenance Window) doesn't exist.InternalServerErrorException - An error occurred on the server side.GetMaintenanceWindowTaskResult getMaintenanceWindowTask(GetMaintenanceWindowTaskRequest getMaintenanceWindowTaskRequest)
Lists the tasks in a Maintenance Window.
getMaintenanceWindowTaskRequest - DoesNotExistException - Error returned when the ID specified for a resource (e.g. a Maintenance Window) doesn't exist.InternalServerErrorException - An error occurred on the server side.GetParameterResult getParameter(GetParameterRequest getParameterRequest)
Get information about a parameter by using the parameter name.
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.GetParameterHistoryResult getParameterHistory(GetParameterHistoryRequest getParameterHistoryRequest)
Query a list of all parameters used by the AWS account.
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.GetParametersResult getParameters(GetParametersRequest getParametersRequest)
Get details of a parameter.
getParametersRequest - InvalidKeyIdException - The query key ID is not valid.InternalServerErrorException - An error occurred on the server side.GetParametersByPathResult getParametersByPath(GetParametersByPathRequest getParametersByPathRequest)
Retrieve parameters in a specific hierarchy. For more information, see Working with Systems Manager Parameters.
Request results are returned on a best-effort basis. If you specify MaxResults in the request, the
response includes information up to the limit specified. The number of items returned, however, can be between
zero and the value of MaxResults. If the service reaches an internal limit while processing the
results, it stops the operation and returns the matching values up to that point and a NextToken.
You can specify the NextToken in a subsequent call to get the next set of results.
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.GetPatchBaselineResult getPatchBaseline(GetPatchBaselineRequest getPatchBaselineRequest)
Retrieves information about a patch baseline.
getPatchBaselineRequest - DoesNotExistException - Error returned when the ID specified for a resource (e.g. a Maintenance Window) doesn't exist.InvalidResourceIdException - The resource ID is not valid. Verify that you entered the correct ID and try again.InternalServerErrorException - An error occurred on the server side.GetPatchBaselineForPatchGroupResult getPatchBaselineForPatchGroup(GetPatchBaselineForPatchGroupRequest getPatchBaselineForPatchGroupRequest)
Retrieves the patch baseline that should be used for the specified patch group.
getPatchBaselineForPatchGroupRequest - InternalServerErrorException - An error occurred on the server side.ListAssociationVersionsResult listAssociationVersions(ListAssociationVersionsRequest listAssociationVersionsRequest)
Retrieves all versions of an association for a specific association ID.
listAssociationVersionsRequest - InternalServerErrorException - An error occurred on the server side.InvalidNextTokenException - The specified token is not valid.AssociationDoesNotExistException - The specified association does not exist.ListAssociationsResult listAssociations(ListAssociationsRequest listAssociationsRequest)
Lists the associations for the specified Systems Manager document or instance.
listAssociationsRequest - InternalServerErrorException - An error occurred on the server side.InvalidNextTokenException - The specified token is not valid.ListCommandInvocationsResult listCommandInvocations(ListCommandInvocationsRequest listCommandInvocationsRequest)
An invocation is copy of a command sent to a specific instance. A command can apply to one or more instances. A command invocation applies to one instance. For example, if a user executes SendCommand against three instances, then a command invocation is created for each requested instance ID. ListCommandInvocations provide status about command execution.
listCommandInvocationsRequest - InternalServerErrorException - An error occurred on the server side.InvalidCommandIdExceptionInvalidInstanceIdException - The following problems can cause this exception:
You do not have permission to access the instance.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
InvalidFilterKeyException - The specified key is not valid.InvalidNextTokenException - The specified token is not valid.ListCommandsResult listCommands(ListCommandsRequest listCommandsRequest)
Lists the commands requested by users of the AWS account.
listCommandsRequest - InternalServerErrorException - An error occurred on the server side.InvalidCommandIdExceptionInvalidInstanceIdException - The following problems can cause this exception:
You do not have permission to access the instance.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
InvalidFilterKeyException - The specified key is not valid.InvalidNextTokenException - The specified token is not valid.ListComplianceItemsResult listComplianceItems(ListComplianceItemsRequest listComplianceItemsRequest)
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.
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.ListComplianceSummariesResult listComplianceSummaries(ListComplianceSummariesRequest listComplianceSummariesRequest)
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.
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.ListDocumentVersionsResult listDocumentVersions(ListDocumentVersionsRequest listDocumentVersionsRequest)
List all versions for a document.
listDocumentVersionsRequest - InternalServerErrorException - An error occurred on the server side.InvalidNextTokenException - The specified token is not valid.InvalidDocumentException - The specified document does not exist.ListDocumentsResult listDocuments(ListDocumentsRequest listDocumentsRequest)
Describes one or more of your Systems Manager documents.
listDocumentsRequest - InternalServerErrorException - An error occurred on the server side.InvalidNextTokenException - The specified token is not valid.InvalidFilterKeyException - The specified key is not valid.ListDocumentsResult listDocuments()
listDocuments(ListDocumentsRequest)ListInventoryEntriesResult listInventoryEntries(ListInventoryEntriesRequest listInventoryEntriesRequest)
A list of inventory items returned by the request.
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.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
InvalidTypeNameException - The parameter type name is not valid.InvalidFilterException - The filter name is not valid. Verify the you entered the correct name and try again.InvalidNextTokenException - The specified token is not valid.ListResourceComplianceSummariesResult listResourceComplianceSummaries(ListResourceComplianceSummariesRequest listResourceComplianceSummariesRequest)
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.
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.ListResourceDataSyncResult listResourceDataSync(ListResourceDataSyncRequest listResourceDataSyncRequest)
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.
listResourceDataSyncRequest - InternalServerErrorException - An error occurred on the server side.InvalidNextTokenException - The specified token is not valid.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Returns a list of the tags assigned to the specified resource.
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.ModifyDocumentPermissionResult modifyDocumentPermission(ModifyDocumentPermissionRequest modifyDocumentPermissionRequest)
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.
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.PutComplianceItemsResult putComplianceItems(PutComplianceItemsRequest putComplianceItemsRequest)
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.
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.PutInventoryResult putInventory(PutInventoryRequest putInventoryRequest)
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.
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.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
InvalidTypeNameException - The parameter type name is not valid.InvalidItemContentException - One or more content items is not valid.TotalSizeLimitExceededException - The size of inventory data has exceeded the total size limit for the resource.ItemSizeLimitExceededException - The inventory item size has exceeded the size limit.ItemContentMismatchException - The inventory item has invalid content.CustomSchemaCountLimitExceededException - You have exceeded the limit for custom schemas. Delete one or more custom schemas and try again.UnsupportedInventorySchemaVersionException - Inventory item type schema version has to match supported versions in the service. Check output of
GetInventorySchema to see the available schema version for each type.UnsupportedInventoryItemContextException - The Context attribute that you specified for the InventoryItem is not allowed
for this inventory type. You can only use the Context attribute with inventory types like
AWS:ComplianceItem.InvalidInventoryItemContextException - You specified invalid keys or values in the Context attribute for InventoryItem
. Verify the keys and values, and try again.SubTypeCountLimitExceededException - The sub-type count exceeded the limit for the inventory type.PutParameterResult putParameter(PutParameterRequest putParameterRequest)
Add one or more parameters to the system.
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 five levels. For example:
/Finance/Prod/IAD/OS/WinServ2016/license15
For more information, see Working with Systems Manager Parameters.
HierarchyTypeMismatchException - Parameter Store does not support changing a parameter type in a hierarchy. For example, you can't change
a parameter from a String type to a SecureString type. You must create a new, unique parameter.InvalidAllowedPatternException - The request does not meet the regular expression requirement.ParameterMaxVersionLimitExceededException - The parameter exceeded the maximum number of allowed versions.ParameterPatternMismatchException - The parameter name is not valid.UnsupportedParameterTypeException - The parameter type is not supported.RegisterDefaultPatchBaselineResult registerDefaultPatchBaseline(RegisterDefaultPatchBaselineRequest registerDefaultPatchBaselineRequest)
Defines the default patch baseline.
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 (e.g. a Maintenance Window) doesn't exist.InternalServerErrorException - An error occurred on the server side.RegisterPatchBaselineForPatchGroupResult registerPatchBaselineForPatchGroup(RegisterPatchBaselineForPatchGroupRequest registerPatchBaselineForPatchGroupRequest)
Registers a patch baseline for a patch group.
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 (e.g. a Maintenance Window) doesn't exist.InvalidResourceIdException - The resource ID is not valid. Verify that you entered the correct ID and try again.ResourceLimitExceededException - Error returned when the caller has exceeded the default resource limits (e.g. too many Maintenance
Windows have been created).InternalServerErrorException - An error occurred on the server side.RegisterTargetWithMaintenanceWindowResult registerTargetWithMaintenanceWindow(RegisterTargetWithMaintenanceWindowRequest registerTargetWithMaintenanceWindowRequest)
Registers a target with a Maintenance Window.
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 (e.g. a Maintenance Window) doesn't exist.ResourceLimitExceededException - Error returned when the caller has exceeded the default resource limits (e.g. too many Maintenance
Windows have been created).InternalServerErrorException - An error occurred on the server side.RegisterTaskWithMaintenanceWindowResult registerTaskWithMaintenanceWindow(RegisterTaskWithMaintenanceWindowRequest registerTaskWithMaintenanceWindowRequest)
Adds a new task to a Maintenance Window.
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 (e.g. a Maintenance Window) doesn't exist.ResourceLimitExceededException - Error returned when the caller has exceeded the default resource limits (e.g. too many Maintenance
Windows have been created).FeatureNotAvailableException - You attempted to register a LAMBDA or STEP_FUNCTION task in a region where the corresponding service is
not available.InternalServerErrorException - An error occurred on the server side.RemoveTagsFromResourceResult removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)
Removes all tags from the specified resource.
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.SendAutomationSignalResult sendAutomationSignal(SendAutomationSignalRequest sendAutomationSignalRequest)
Sends a signal to an Automation execution to change the current behavior or status of the execution.
sendAutomationSignalRequest - AutomationExecutionNotFoundException - There is no automation execution information for the requested automation execution ID.InvalidAutomationSignalException - The signal is not valid for the current Automation execution.InternalServerErrorException - An error occurred on the server side.SendCommandResult sendCommand(SendCommandRequest sendCommandRequest)
Executes commands on one or more managed instances.
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.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
InvalidDocumentException - The specified document does not exist.InvalidOutputFolderException - The S3 bucket does not exist.InvalidParametersException - You must specify values for all required parameters in the Systems Manager document. You can only supply
values to parameters defined in the Systems Manager document.UnsupportedPlatformTypeException - The document does not support the platform type of the given instance ID(s). For example, you sent an
document for a Windows instance to a Linux instance.MaxDocumentSizeExceededException - The size limit of a document is 64 KB.InvalidRoleException - The role name can't contain invalid characters. Also verify that you specified an IAM role for
notifications that includes the required trust policy. For information about configuring the IAM role for
Run Command notifications, see Configuring
Amazon SNS Notifications for Run Command in the Amazon EC2 Systems Manager User Guide.InvalidNotificationConfigException - One or more configuration items is not valid. Verify that a valid Amazon Resource Name (ARN) was provided
for an Amazon SNS topic.StartAutomationExecutionResult startAutomationExecution(StartAutomationExecutionRequest startAutomationExecutionRequest)
Initiates execution of an Automation document.
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.InternalServerErrorException - An error occurred on the server side.StopAutomationExecutionResult stopAutomationExecution(StopAutomationExecutionRequest stopAutomationExecutionRequest)
Stop an Automation that is currently executing.
stopAutomationExecutionRequest - AutomationExecutionNotFoundException - There is no automation execution information for the requested automation execution ID.InternalServerErrorException - An error occurred on the server side.UpdateAssociationResult updateAssociation(UpdateAssociationRequest updateAssociationRequest)
Updates an association. You can update the association name and version, the document version, schedule, parameters, and Amazon S3 output.
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.UpdateAssociationStatusResult updateAssociationStatus(UpdateAssociationStatusRequest updateAssociationStatusRequest)
Updates the status of the Systems Manager document associated with the specified instance.
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.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
InvalidDocumentException - The specified document does not exist.AssociationDoesNotExistException - The specified association does not exist.StatusUnchangedException - The updated status is the same as the current status.TooManyUpdatesException - There are concurrent updates for a resource that supports one update at a time.UpdateDocumentResult updateDocument(UpdateDocumentRequest updateDocumentRequest)
The document you want to update.
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.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.UpdateDocumentDefaultVersionResult updateDocumentDefaultVersion(UpdateDocumentDefaultVersionRequest updateDocumentDefaultVersionRequest)
Set the default version of a document.
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.UpdateMaintenanceWindowResult updateMaintenanceWindow(UpdateMaintenanceWindowRequest updateMaintenanceWindowRequest)
Updates an existing Maintenance Window. Only specified parameters are modified.
updateMaintenanceWindowRequest - DoesNotExistException - Error returned when the ID specified for a resource (e.g. a Maintenance Window) doesn't exist.InternalServerErrorException - An error occurred on the server side.UpdateMaintenanceWindowTargetResult updateMaintenanceWindowTarget(UpdateMaintenanceWindowTargetRequest updateMaintenanceWindowTargetRequest)
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.
updateMaintenanceWindowTargetRequest - DoesNotExistException - Error returned when the ID specified for a resource (e.g. a Maintenance Window) doesn't exist.InternalServerErrorException - An error occurred on the server side.UpdateMaintenanceWindowTaskResult updateMaintenanceWindowTask(UpdateMaintenanceWindowTaskRequest updateMaintenanceWindowTaskRequest)
Modifies a task assigned to a Maintenance Window. You can't change the task type, but you can change the following values:
Task ARN. For example, you can change a RUN_COMMAND task from AWS-RunPowerShellScript to AWS-RunShellScript.
Service role ARN.
Task parameters.
Task priority.
Task MaxConcurrency and MaxErrors.
Log location.
If a parameter is null, then the corresponding field is not modified. Also, if you set Replace to true, then all fields required by the RegisterTaskWithMaintenanceWindow action are required for this request. Optional fields that aren't specified are set to null.
updateMaintenanceWindowTaskRequest - DoesNotExistException - Error returned when the ID specified for a resource (e.g. a Maintenance Window) doesn't exist.InternalServerErrorException - An error occurred on the server side.UpdateManagedInstanceRoleResult updateManagedInstanceRole(UpdateManagedInstanceRoleRequest updateManagedInstanceRoleRequest)
Assigns or changes an Amazon Identity and Access Management (IAM) role to the managed instance.
updateManagedInstanceRoleRequest - InvalidInstanceIdException - The following problems can cause this exception:
You do not have permission to access the instance.
The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.
The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
InternalServerErrorException - An error occurred on the server side.UpdatePatchBaselineResult updatePatchBaseline(UpdatePatchBaselineRequest updatePatchBaselineRequest)
Modifies an existing patch baseline. Fields not specified in the request are left unchanged.
updatePatchBaselineRequest - DoesNotExistException - Error returned when the ID specified for a resource (e.g. a Maintenance Window) doesn't exist.InternalServerErrorException - An error occurred on the server side.void shutdown()
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 a request.
request - The originally executed request.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.