@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 works with managed instances: Amazon EC2 instances and servers or virtual machines (VMs) in your on-premises environment that are configured for Systems Manager.
This references is intended to be used with the EC2 Systems Manager User Guide (Linux) (Windows).
To get started, verify prerequisites and configure managed instances (Linux) (Windows).
| 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 SSM document with the specified instances or targets.
|
CreateAssociationBatchResult |
createAssociationBatch(CreateAssociationBatchRequest createAssociationBatchRequest)
Associates the specified SSM document with the specified instances or targets.
|
CreateDocumentResult |
createDocument(CreateDocumentRequest createDocumentRequest)
Creates an SSM document.
|
CreateMaintenanceWindowResult |
createMaintenanceWindow(CreateMaintenanceWindowRequest createMaintenanceWindowRequest)
Creates a new Maintenance Window.
|
CreatePatchBaselineResult |
createPatchBaseline(CreatePatchBaselineRequest createPatchBaselineRequest)
Creates a patch baseline.
|
DeleteActivationResult |
deleteActivation(DeleteActivationRequest deleteActivationRequest)
Deletes an activation.
|
DeleteAssociationResult |
deleteAssociation(DeleteAssociationRequest deleteAssociationRequest)
Disassociates the specified SSM document from the specified instance.
|
DeleteDocumentResult |
deleteDocument(DeleteDocumentRequest deleteDocumentRequest)
Deletes the SSM 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.
|
DeletePatchBaselineResult |
deletePatchBaseline(DeletePatchBaselineRequest deletePatchBaselineRequest)
Deletes a patch baseline.
|
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 SSM 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 SSM document.
|
DescribeDocumentPermissionResult |
describeDocumentPermission(DescribeDocumentPermissionRequest describeDocumentPermissionRequest)
Describes the permissions for an SSM 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 (meaning, information about when the Maintenance Window was
scheduled to be active and information about tasks registered and run with the 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 SSM 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.
|
GetParameterHistoryResult |
getParameterHistory(GetParameterHistoryRequest getParameterHistoryRequest)
Query a list of all parameters used by the AWS account.
|
GetParametersResult |
getParameters(GetParametersRequest getParametersRequest)
Get a list of parameters used by the AWS account.>
|
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 SSM document or instance.
|
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.
|
ListDocumentsResult |
listDocuments()
Simplified method form for invoking the ListDocuments operation.
|
ListDocumentsResult |
listDocuments(ListDocumentsRequest listDocumentsRequest)
Describes one or more of your SSM documents.
|
ListDocumentVersionsResult |
listDocumentVersions(ListDocumentVersionsRequest listDocumentVersionsRequest)
List all versions for a document.
|
ListInventoryEntriesResult |
listInventoryEntries(ListInventoryEntriesRequest listInventoryEntriesRequest)
A list of inventory items returned by the request.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Returns a list of the tags assigned to the specified resource.
|
ModifyDocumentPermissionResult |
modifyDocumentPermission(ModifyDocumentPermissionRequest modifyDocumentPermissionRequest)
Share a document publicly or privately.
|
PutInventoryResult |
putInventory(PutInventoryRequest putInventoryRequest)
Bulk update custom inventory items on one more instance.
|
PutParameterResult |
putParameter(PutParameterRequest putParameterRequest)
Add one or more paramaters 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.
|
SendCommandResult |
sendCommand(SendCommandRequest sendCommandRequest)
Executes commands on one or more remote 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 SSM 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.
|
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 assign to your managed instances. Tags enable you to categorize your managed instances in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define. For example, you could define a set of tags for your account's managed instances that helps you track each instance's owner and stack level. For example: Key=Owner and Value=DbAdmin, SysAdmin, or Dev. Or Key=Stack and Value=Production, Pre-Production, or Test. Each resource can have a maximum of 10 tags.
We recommend that you devise a set of tag keys that meets your needs for each resource type. Using a consistent set of tag keys makes it easier for you to manage your resources. You can search and filter the resources based on the tags you add. Tags don't have any semantic meaning to Amazon EC2 and are interpreted strictly as a string of characters.
For more information about tags, see Tagging Your Amazon EC2 Resources in the Amazon EC2 User Guide.
addTagsToResourceRequest - InvalidResourceTypeException - The resource type is not valid. 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 Managed Instances (Linux) or Setting Up Managed Instances (Windows) in the Amazon EC2 User Guide.
createActivationRequest - InternalServerErrorException - An error occurred on the server side.CreateAssociationResult createAssociation(CreateAssociationRequest createAssociationRequest)
Associates the specified SSM document with the specified instances or targets.
When you associate an SSM 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 SSM
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 SSM document. You can only supply values to
parameters defined in the SSM 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 SSM document with the specified instances or targets.
When you associate an SSM 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 SSM document. You can only supply values to
parameters defined in the SSM 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 SSM
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 an SSM document.
After you create an SSM document, you can use CreateAssociation to associate it with one or more running instances.
createDocumentRequest - DocumentAlreadyExistsException - The specified SSM document already exists.MaxDocumentSizeExceededException - The size limit of an SSM document is 64 KB.InternalServerErrorException - An error occurred on the server side.InvalidDocumentContentException - The content for the SSM document is not valid.DocumentLimitExceededException - You can have at most 200 active SSM 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.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.DeleteAssociationResult deleteAssociation(DeleteAssociationRequest deleteAssociationRequest)
Disassociates the specified SSM document from the specified instance.
When you disassociate an SSM document from an instance, it does not change the configuration of the instance. To change the configuration state of an instance after you disassociate a document, you must create a new document with the desired configuration and associate it with the instance.
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 SSM document and all instance associations to the document.
Before you delete the SSM document, we recommend that you use DeleteAssociation to disassociate all instances that are associated with the document.
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 an SSM 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.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.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.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 SSM document or instance.
describeAssociationRequest - 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.
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 SSM 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 an SSM document. If you created the document, you are the owner. If a document is shared, it can either be shared privately (by specifying a user’s AWS account ID) or publicly (All).
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.
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.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 (meaning, 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.
describeParametersRequest - InternalServerErrorException - An error occurred on the server side.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.
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-ApplyPatchBaseline Systems Manager document.
getDeployablePatchSnapshotForInstanceRequest - InternalServerErrorException - An error occurred on the server side.GetDocumentResult getDocument(GetDocumentRequest getDocumentRequest)
Gets the contents of the specified SSM 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.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.GetParametersResult getParameters(GetParametersRequest getParametersRequest)
Get a list of parameters used by the AWS account.>
getParametersRequest - InternalServerErrorException - An error occurred on the server side.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.ListAssociationsResult listAssociations(ListAssociationsRequest listAssociationsRequest)
Lists the associations for the specified SSM 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.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 SSM 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.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Returns a list of the tags assigned to the specified resource.
listTagsForResourceRequest - InvalidResourceTypeException - The resource type is not valid. 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)
Share a document publicly or privately. If you share a document privately, you must specify the AWS user account IDs for those people who can use the document. If you share a document publicly, you must specify All as the account ID.
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 SSM documents.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.PutParameterResult putParameter(PutParameterRequest putParameterRequest)
Add one or more paramaters 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.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).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. 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.SendCommandResult sendCommand(SendCommandRequest sendCommandRequest)
Executes commands on one or more remote 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 SSM document. You can only supply values to
parameters defined in the SSM document.UnsupportedPlatformTypeException - The document does not support the platform type of the given instance ID(s). For example, you sent an SSM
document for a Windows instance to a Linux instance.MaxDocumentSizeExceededException - The size limit of an SSM 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 Getting Amazon SNS Notifications
When a Command Changes Status in the Amazon Elastic Compute Cloud 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.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 only update the document version, schedule, parameters, and Amazon S3 output of an association.
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 SSM document. You can only supply values to
parameters defined in the SSM 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.UpdateAssociationStatusResult updateAssociationStatus(UpdateAssociationStatusRequest updateAssociationStatusRequest)
Updates the status of the SSM 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 an SSM 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 SSM 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.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.