AutoCloseable
@Generated("software.amazon.awssdk:codegen") public interface SSMClient extends AutoCloseable
builder()
method.
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.
Modifier and Type | Field | Description |
---|---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method | Description |
---|---|---|
default AddTagsToResourceResponse |
addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest) |
Adds or overwrites one or more tags for the specified resource.
|
static SSMClientBuilder |
builder() |
Create a builder that can be used to configure and create a
SSMClient . |
default CancelCommandResponse |
cancelCommand(CancelCommandRequest cancelCommandRequest) |
Attempts to cancel the command specified by the Command ID.
|
static SSMClient |
create() |
Create a
SSMClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default CreateActivationResponse |
createActivation(CreateActivationRequest createActivationRequest) |
Registers your on-premises server or virtual machine with Amazon EC2 so that you can manage these resources using
Run Command.
|
default CreateAssociationResponse |
createAssociation(CreateAssociationRequest createAssociationRequest) |
Associates the specified Systems Manager document with the specified instances or targets.
|
default CreateAssociationBatchResponse |
createAssociationBatch(CreateAssociationBatchRequest createAssociationBatchRequest) |
Associates the specified Systems Manager document with the specified instances or targets.
|
default CreateDocumentResponse |
createDocument(CreateDocumentRequest createDocumentRequest) |
Creates a Systems Manager document.
|
default CreateMaintenanceWindowResponse |
createMaintenanceWindow(CreateMaintenanceWindowRequest createMaintenanceWindowRequest) |
Creates a new Maintenance Window.
|
default CreatePatchBaselineResponse |
createPatchBaseline(CreatePatchBaselineRequest createPatchBaselineRequest) |
Creates a patch baseline.
|
default DeleteActivationResponse |
deleteActivation(DeleteActivationRequest deleteActivationRequest) |
Deletes an activation.
|
default DeleteAssociationResponse |
deleteAssociation(DeleteAssociationRequest deleteAssociationRequest) |
Disassociates the specified Systems Manager document from the specified instance.
|
default DeleteDocumentResponse |
deleteDocument(DeleteDocumentRequest deleteDocumentRequest) |
Deletes the Systems Manager document and all instance associations to the document.
|
default DeleteMaintenanceWindowResponse |
deleteMaintenanceWindow(DeleteMaintenanceWindowRequest deleteMaintenanceWindowRequest) |
Deletes a Maintenance Window.
|
default DeleteParameterResponse |
deleteParameter(DeleteParameterRequest deleteParameterRequest) |
Delete a parameter from the system.
|
default DeleteParametersResponse |
deleteParameters(DeleteParametersRequest deleteParametersRequest) |
Delete a list of parameters.
|
default DeletePatchBaselineResponse |
deletePatchBaseline(DeletePatchBaselineRequest deletePatchBaselineRequest) |
Deletes a patch baseline.
|
default DeregisterManagedInstanceResponse |
deregisterManagedInstance(DeregisterManagedInstanceRequest deregisterManagedInstanceRequest) |
Removes the server or virtual machine from the list of registered servers.
|
default DeregisterPatchBaselineForPatchGroupResponse |
deregisterPatchBaselineForPatchGroup(DeregisterPatchBaselineForPatchGroupRequest deregisterPatchBaselineForPatchGroupRequest) |
Removes a patch group from a patch baseline.
|
default DeregisterTargetFromMaintenanceWindowResponse |
deregisterTargetFromMaintenanceWindow(DeregisterTargetFromMaintenanceWindowRequest deregisterTargetFromMaintenanceWindowRequest) |
Removes a target from a Maintenance Window.
|
default DeregisterTaskFromMaintenanceWindowResponse |
deregisterTaskFromMaintenanceWindow(DeregisterTaskFromMaintenanceWindowRequest deregisterTaskFromMaintenanceWindowRequest) |
Removes a task from a Maintenance Window.
|
default DescribeActivationsResponse |
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.
|
default DescribeAssociationResponse |
describeAssociation(DescribeAssociationRequest describeAssociationRequest) |
Describes the associations for the specified Systems Manager document or instance.
|
default DescribeAutomationExecutionsResponse |
describeAutomationExecutions(DescribeAutomationExecutionsRequest describeAutomationExecutionsRequest) |
Provides details about all active and terminated Automation executions.
|
default DescribeAvailablePatchesResponse |
describeAvailablePatches(DescribeAvailablePatchesRequest describeAvailablePatchesRequest) |
Lists all patches that could possibly be included in a patch baseline.
|
default DescribeDocumentResponse |
describeDocument(DescribeDocumentRequest describeDocumentRequest) |
Describes the specified SSM document.
|
default DescribeDocumentPermissionResponse |
describeDocumentPermission(DescribeDocumentPermissionRequest describeDocumentPermissionRequest) |
Describes the permissions for a Systems Manager document.
|
default DescribeEffectiveInstanceAssociationsResponse |
describeEffectiveInstanceAssociations(DescribeEffectiveInstanceAssociationsRequest describeEffectiveInstanceAssociationsRequest) |
All associations for the instance(s).
|
default DescribeEffectivePatchesForPatchBaselineResponse |
describeEffectivePatchesForPatchBaseline(DescribeEffectivePatchesForPatchBaselineRequest describeEffectivePatchesForPatchBaselineRequest) |
Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline.
|
default DescribeInstanceAssociationsStatusResponse |
describeInstanceAssociationsStatus(DescribeInstanceAssociationsStatusRequest describeInstanceAssociationsStatusRequest) |
The status of the associations for the instance(s).
|
default DescribeInstanceInformationResponse |
describeInstanceInformation(DescribeInstanceInformationRequest describeInstanceInformationRequest) |
Describes one or more of your instances.
|
default DescribeInstancePatchesResponse |
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.
|
default DescribeInstancePatchStatesResponse |
describeInstancePatchStates(DescribeInstancePatchStatesRequest describeInstancePatchStatesRequest) |
Retrieves the high-level patch state of one or more instances.
|
default DescribeInstancePatchStatesForPatchGroupResponse |
describeInstancePatchStatesForPatchGroup(DescribeInstancePatchStatesForPatchGroupRequest describeInstancePatchStatesForPatchGroupRequest) |
Retrieves the high-level patch state for the instances in the specified patch group.
|
default DescribeMaintenanceWindowExecutionsResponse |
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).
|
default DescribeMaintenanceWindowExecutionTaskInvocationsResponse |
describeMaintenanceWindowExecutionTaskInvocations(DescribeMaintenanceWindowExecutionTaskInvocationsRequest describeMaintenanceWindowExecutionTaskInvocationsRequest) |
Retrieves the individual task executions (one per target) for a particular task executed as part of a Maintenance
Window execution.
|
default DescribeMaintenanceWindowExecutionTasksResponse |
describeMaintenanceWindowExecutionTasks(DescribeMaintenanceWindowExecutionTasksRequest describeMaintenanceWindowExecutionTasksRequest) |
For a given Maintenance Window execution, lists the tasks that were executed.
|
default DescribeMaintenanceWindowsResponse |
describeMaintenanceWindows(DescribeMaintenanceWindowsRequest describeMaintenanceWindowsRequest) |
Retrieves the Maintenance Windows in an AWS account.
|
default DescribeMaintenanceWindowTargetsResponse |
describeMaintenanceWindowTargets(DescribeMaintenanceWindowTargetsRequest describeMaintenanceWindowTargetsRequest) |
Lists the targets registered with the Maintenance Window.
|
default DescribeMaintenanceWindowTasksResponse |
describeMaintenanceWindowTasks(DescribeMaintenanceWindowTasksRequest describeMaintenanceWindowTasksRequest) |
Lists the tasks in a Maintenance Window.
|
default DescribeParametersResponse |
describeParameters(DescribeParametersRequest describeParametersRequest) |
Get information about a parameter.
|
default DescribePatchBaselinesResponse |
describePatchBaselines(DescribePatchBaselinesRequest describePatchBaselinesRequest) |
Lists the patch baselines in your AWS account.
|
default DescribePatchGroupsResponse |
describePatchGroups(DescribePatchGroupsRequest describePatchGroupsRequest) |
Lists all patch groups that have been registered with patch baselines.
|
default DescribePatchGroupStateResponse |
describePatchGroupState(DescribePatchGroupStateRequest describePatchGroupStateRequest) |
Returns high-level aggregated patch compliance state for a patch group.
|
default GetAutomationExecutionResponse |
getAutomationExecution(GetAutomationExecutionRequest getAutomationExecutionRequest) |
Get detailed information about a particular Automation execution.
|
default GetCommandInvocationResponse |
getCommandInvocation(GetCommandInvocationRequest getCommandInvocationRequest) |
Returns detailed information about command execution for an invocation or plugin.
|
default GetDefaultPatchBaselineResponse |
getDefaultPatchBaseline(GetDefaultPatchBaselineRequest getDefaultPatchBaselineRequest) |
Retrieves the default patch baseline.
|
default GetDeployablePatchSnapshotForInstanceResponse |
getDeployablePatchSnapshotForInstance(GetDeployablePatchSnapshotForInstanceRequest getDeployablePatchSnapshotForInstanceRequest) |
Retrieves the current snapshot for the patch baseline the instance uses.
|
default GetDocumentResponse |
getDocument(GetDocumentRequest getDocumentRequest) |
Gets the contents of the specified SSM document.
|
default GetInventoryResponse |
getInventory(GetInventoryRequest getInventoryRequest) |
Query inventory information.
|
default GetInventorySchemaResponse |
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.
|
default GetMaintenanceWindowResponse |
getMaintenanceWindow(GetMaintenanceWindowRequest getMaintenanceWindowRequest) |
Retrieves a Maintenance Window.
|
default GetMaintenanceWindowExecutionResponse |
getMaintenanceWindowExecution(GetMaintenanceWindowExecutionRequest getMaintenanceWindowExecutionRequest) |
Retrieves details about a specific task executed as part of a Maintenance Window execution.
|
default GetMaintenanceWindowExecutionTaskResponse |
getMaintenanceWindowExecutionTask(GetMaintenanceWindowExecutionTaskRequest getMaintenanceWindowExecutionTaskRequest) |
Retrieves the details about a specific task executed as part of a Maintenance Window execution.
|
default GetParameterResponse |
getParameter(GetParameterRequest getParameterRequest) |
Get information about a parameter by using the parameter name.
|
default GetParameterHistoryResponse |
getParameterHistory(GetParameterHistoryRequest getParameterHistoryRequest) |
Query a list of all parameters used by the AWS account.
|
default GetParametersResponse |
getParameters(GetParametersRequest getParametersRequest) |
Get details of a parameter.
|
default GetParametersByPathResponse |
getParametersByPath(GetParametersByPathRequest getParametersByPathRequest) |
Retrieve parameters in a specific hierarchy.
|
default GetPatchBaselineResponse |
getPatchBaseline(GetPatchBaselineRequest getPatchBaselineRequest) |
Retrieves information about a patch baseline.
|
default GetPatchBaselineForPatchGroupResponse |
getPatchBaselineForPatchGroup(GetPatchBaselineForPatchGroupRequest getPatchBaselineForPatchGroupRequest) |
Retrieves the patch baseline that should be used for the specified patch group.
|
default ListAssociationsResponse |
listAssociations(ListAssociationsRequest listAssociationsRequest) |
Lists the associations for the specified Systems Manager document or instance.
|
default ListCommandInvocationsResponse |
listCommandInvocations(ListCommandInvocationsRequest listCommandInvocationsRequest) |
An invocation is copy of a command sent to a specific instance.
|
default ListCommandsResponse |
listCommands(ListCommandsRequest listCommandsRequest) |
Lists the commands requested by users of the AWS account.
|
default ListDocumentsResponse |
listDocuments(ListDocumentsRequest listDocumentsRequest) |
Describes one or more of your SSM documents.
|
default ListDocumentVersionsResponse |
listDocumentVersions(ListDocumentVersionsRequest listDocumentVersionsRequest) |
List all versions for a document.
|
default ListInventoryEntriesResponse |
listInventoryEntries(ListInventoryEntriesRequest listInventoryEntriesRequest) |
A list of inventory items returned by the request.
|
default ListTagsForResourceResponse |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) |
Returns a list of the tags assigned to the specified resource.
|
default ModifyDocumentPermissionResponse |
modifyDocumentPermission(ModifyDocumentPermissionRequest modifyDocumentPermissionRequest) |
Shares a Systems Manager document publicly or privately.
|
default PutInventoryResponse |
putInventory(PutInventoryRequest putInventoryRequest) |
Bulk update custom inventory items on one more instance.
|
default PutParameterResponse |
putParameter(PutParameterRequest putParameterRequest) |
Add one or more parameters to the system.
|
default RegisterDefaultPatchBaselineResponse |
registerDefaultPatchBaseline(RegisterDefaultPatchBaselineRequest registerDefaultPatchBaselineRequest) |
Defines the default patch baseline.
|
default RegisterPatchBaselineForPatchGroupResponse |
registerPatchBaselineForPatchGroup(RegisterPatchBaselineForPatchGroupRequest registerPatchBaselineForPatchGroupRequest) |
Registers a patch baseline for a patch group.
|
default RegisterTargetWithMaintenanceWindowResponse |
registerTargetWithMaintenanceWindow(RegisterTargetWithMaintenanceWindowRequest registerTargetWithMaintenanceWindowRequest) |
Registers a target with a Maintenance Window.
|
default RegisterTaskWithMaintenanceWindowResponse |
registerTaskWithMaintenanceWindow(RegisterTaskWithMaintenanceWindowRequest registerTaskWithMaintenanceWindowRequest) |
Adds a new task to a Maintenance Window.
|
default RemoveTagsFromResourceResponse |
removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest) |
Removes all tags from the specified resource.
|
default SendCommandResponse |
sendCommand(SendCommandRequest sendCommandRequest) |
Executes commands on one or more managed instances.
|
static ServiceMetadata |
serviceMetadata() |
|
default StartAutomationExecutionResponse |
startAutomationExecution(StartAutomationExecutionRequest startAutomationExecutionRequest) |
Initiates execution of an Automation document.
|
default StopAutomationExecutionResponse |
stopAutomationExecution(StopAutomationExecutionRequest stopAutomationExecutionRequest) |
Stop an Automation that is currently executing.
|
default UpdateAssociationResponse |
updateAssociation(UpdateAssociationRequest updateAssociationRequest) |
Updates an association.
|
default UpdateAssociationStatusResponse |
updateAssociationStatus(UpdateAssociationStatusRequest updateAssociationStatusRequest) |
Updates the status of the Systems Manager document associated with the specified instance.
|
default UpdateDocumentResponse |
updateDocument(UpdateDocumentRequest updateDocumentRequest) |
The document you want to update.
|
default UpdateDocumentDefaultVersionResponse |
updateDocumentDefaultVersion(UpdateDocumentDefaultVersionRequest updateDocumentDefaultVersionRequest) |
Set the default version of a document.
|
default UpdateMaintenanceWindowResponse |
updateMaintenanceWindow(UpdateMaintenanceWindowRequest updateMaintenanceWindowRequest) |
Updates an existing Maintenance Window.
|
default UpdateManagedInstanceRoleResponse |
updateManagedInstanceRole(UpdateManagedInstanceRoleRequest updateManagedInstanceRoleRequest) |
Assigns or changes an Amazon Identity and Access Management (IAM) role to the managed instance.
|
default UpdatePatchBaselineResponse |
updatePatchBaseline(UpdatePatchBaselineRequest updatePatchBaselineRequest) |
Modifies an existing patch baseline.
|
close
static final String SERVICE_NAME
static SSMClient create()
SSMClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static SSMClientBuilder builder()
SSMClient
.default AddTagsToResourceResponse addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest) throws InvalidResourceTypeException, InvalidResourceIdException, InternalServerErrorException, TooManyTagsErrorException, SdkBaseException, SdkClientException, SSMException
Adds or overwrites one or more tags for the specified resource. Tags are metadata that you assign to your managed instances, Maintenance Windows, or Parameter Store parameters. 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. 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CancelCommandResponse cancelCommand(CancelCommandRequest cancelCommandRequest) throws InternalServerErrorException, InvalidCommandIdException, InvalidInstanceIdException, DuplicateInstanceIdException, SdkBaseException, SdkClientException, SSMException
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.InvalidCommandIdException
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.
DuplicateInstanceIdException
- You cannot specify an instance ID in more than one association.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateActivationResponse createActivation(CreateActivationRequest createActivationRequest) throws InternalServerErrorException, SdkBaseException, SdkClientException, SSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateAssociationResponse createAssociation(CreateAssociationRequest createAssociationRequest) throws AssociationAlreadyExistsException, AssociationLimitExceededException, InternalServerErrorException, InvalidDocumentException, InvalidDocumentVersionException, InvalidInstanceIdException, UnsupportedPlatformTypeException, InvalidOutputLocationException, InvalidParametersException, InvalidTargetException, InvalidScheduleException, SdkBaseException, SdkClientException, SSMException
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 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateAssociationBatchResponse createAssociationBatch(CreateAssociationBatchRequest createAssociationBatchRequest) throws InternalServerErrorException, InvalidDocumentException, InvalidDocumentVersionException, InvalidInstanceIdException, InvalidParametersException, DuplicateInstanceIdException, AssociationLimitExceededException, UnsupportedPlatformTypeException, InvalidOutputLocationException, InvalidTargetException, InvalidScheduleException, SdkBaseException, SdkClientException, SSMException
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 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
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateDocumentResponse createDocument(CreateDocumentRequest createDocumentRequest) throws DocumentAlreadyExistsException, MaxDocumentSizeExceededException, InternalServerErrorException, InvalidDocumentContentException, DocumentLimitExceededException, InvalidDocumentSchemaVersionException, SdkBaseException, SdkClientException, SSMException
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 SSM documents.InvalidDocumentSchemaVersionException
- The version of the document schema is not supported.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateMaintenanceWindowResponse createMaintenanceWindow(CreateMaintenanceWindowRequest createMaintenanceWindowRequest) throws IdempotentParameterMismatchException, ResourceLimitExceededException, InternalServerErrorException, SdkBaseException, SdkClientException, SSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreatePatchBaselineResponse createPatchBaseline(CreatePatchBaselineRequest createPatchBaselineRequest) throws IdempotentParameterMismatchException, ResourceLimitExceededException, InternalServerErrorException, SdkBaseException, SdkClientException, SSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteActivationResponse deleteActivation(DeleteActivationRequest deleteActivationRequest) throws InvalidActivationIdException, InvalidActivationException, InternalServerErrorException, SdkBaseException, SdkClientException, SSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteAssociationResponse deleteAssociation(DeleteAssociationRequest deleteAssociationRequest) throws AssociationDoesNotExistException, InternalServerErrorException, InvalidDocumentException, InvalidInstanceIdException, TooManyUpdatesException, SdkBaseException, SdkClientException, SSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteDocumentResponse deleteDocument(DeleteDocumentRequest deleteDocumentRequest) throws InternalServerErrorException, InvalidDocumentException, InvalidDocumentOperationException, AssociatedInstancesException, SdkBaseException, SdkClientException, SSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteMaintenanceWindowResponse deleteMaintenanceWindow(DeleteMaintenanceWindowRequest deleteMaintenanceWindowRequest) throws InternalServerErrorException, SdkBaseException, SdkClientException, SSMException
Deletes a Maintenance Window.
deleteMaintenanceWindowRequest
- InternalServerErrorException
- An error occurred on the server side.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteParameterResponse deleteParameter(DeleteParameterRequest deleteParameterRequest) throws InternalServerErrorException, ParameterNotFoundException, SdkBaseException, SdkClientException, SSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteParametersResponse deleteParameters(DeleteParametersRequest deleteParametersRequest) throws InternalServerErrorException, SdkBaseException, SdkClientException, SSMException
Delete a list of parameters.
deleteParametersRequest
- InternalServerErrorException
- An error occurred on the server side.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeletePatchBaselineResponse deletePatchBaseline(DeletePatchBaselineRequest deletePatchBaselineRequest) throws ResourceInUseException, InternalServerErrorException, SdkBaseException, SdkClientException, SSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeregisterManagedInstanceResponse deregisterManagedInstance(DeregisterManagedInstanceRequest deregisterManagedInstanceRequest) throws InvalidInstanceIdException, InternalServerErrorException, SdkBaseException, SdkClientException, SSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeregisterPatchBaselineForPatchGroupResponse deregisterPatchBaselineForPatchGroup(DeregisterPatchBaselineForPatchGroupRequest deregisterPatchBaselineForPatchGroupRequest) throws InvalidResourceIdException, InternalServerErrorException, SdkBaseException, SdkClientException, SSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeregisterTargetFromMaintenanceWindowResponse deregisterTargetFromMaintenanceWindow(DeregisterTargetFromMaintenanceWindowRequest deregisterTargetFromMaintenanceWindowRequest) throws DoesNotExistException, InternalServerErrorException, SdkBaseException, SdkClientException, SSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeregisterTaskFromMaintenanceWindowResponse deregisterTaskFromMaintenanceWindow(DeregisterTaskFromMaintenanceWindowRequest deregisterTaskFromMaintenanceWindowRequest) throws DoesNotExistException, InternalServerErrorException, SdkBaseException, SdkClientException, SSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeActivationsResponse describeActivations(DescribeActivationsRequest describeActivationsRequest) throws InvalidFilterException, InvalidNextTokenException, InternalServerErrorException, SdkBaseException, SdkClientException, SSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeAssociationResponse describeAssociation(DescribeAssociationRequest describeAssociationRequest) throws AssociationDoesNotExistException, InternalServerErrorException, InvalidDocumentException, InvalidInstanceIdException, SdkBaseException, SdkClientException, SSMException
Describes the associations for the specified Systems Manager 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.
SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeAutomationExecutionsResponse describeAutomationExecutions(DescribeAutomationExecutionsRequest describeAutomationExecutionsRequest) throws InvalidNextTokenException, InternalServerErrorException, SdkBaseException, SdkClientException, SSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeAvailablePatchesResponse describeAvailablePatches(DescribeAvailablePatchesRequest describeAvailablePatchesRequest) throws InternalServerErrorException, SdkBaseException, SdkClientException, SSMException
Lists all patches that could possibly be included in a patch baseline.
describeAvailablePatchesRequest
- InternalServerErrorException
- An error occurred on the server side.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeDocumentResponse describeDocument(DescribeDocumentRequest describeDocumentRequest) throws InternalServerErrorException, InvalidDocumentException, InvalidDocumentVersionException, SdkBaseException, SdkClientException, SSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeDocumentPermissionResponse describeDocumentPermission(DescribeDocumentPermissionRequest describeDocumentPermissionRequest) throws InternalServerErrorException, InvalidDocumentException, InvalidPermissionTypeException, SdkBaseException, SdkClientException, SSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeEffectiveInstanceAssociationsResponse describeEffectiveInstanceAssociations(DescribeEffectiveInstanceAssociationsRequest describeEffectiveInstanceAssociationsRequest) throws InternalServerErrorException, InvalidInstanceIdException, InvalidNextTokenException, SdkBaseException, SdkClientException, SSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeEffectivePatchesForPatchBaselineResponse describeEffectivePatchesForPatchBaseline(DescribeEffectivePatchesForPatchBaselineRequest describeEffectivePatchesForPatchBaselineRequest) throws InvalidResourceIdException, DoesNotExistException, InternalServerErrorException, SdkBaseException, SdkClientException, SSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeInstanceAssociationsStatusResponse describeInstanceAssociationsStatus(DescribeInstanceAssociationsStatusRequest describeInstanceAssociationsStatusRequest) throws InternalServerErrorException, InvalidInstanceIdException, InvalidNextTokenException, SdkBaseException, SdkClientException, SSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeInstanceInformationResponse describeInstanceInformation(DescribeInstanceInformationRequest describeInstanceInformationRequest) throws InternalServerErrorException, InvalidInstanceIdException, InvalidNextTokenException, InvalidInstanceInformationFilterValueException, InvalidFilterKeyException, SdkBaseException, SdkClientException, SSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeInstancePatchStatesResponse describeInstancePatchStates(DescribeInstancePatchStatesRequest describeInstancePatchStatesRequest) throws InternalServerErrorException, InvalidNextTokenException, SdkBaseException, SdkClientException, SSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeInstancePatchStatesForPatchGroupResponse describeInstancePatchStatesForPatchGroup(DescribeInstancePatchStatesForPatchGroupRequest describeInstancePatchStatesForPatchGroupRequest) throws InternalServerErrorException, InvalidFilterException, InvalidNextTokenException, SdkBaseException, SdkClientException, SSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeInstancePatchesResponse describeInstancePatches(DescribeInstancePatchesRequest describeInstancePatchesRequest) throws InternalServerErrorException, InvalidInstanceIdException, InvalidFilterException, InvalidNextTokenException, SdkBaseException, SdkClientException, SSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeMaintenanceWindowExecutionTaskInvocationsResponse describeMaintenanceWindowExecutionTaskInvocations(DescribeMaintenanceWindowExecutionTaskInvocationsRequest describeMaintenanceWindowExecutionTaskInvocationsRequest) throws DoesNotExistException, InternalServerErrorException, SdkBaseException, SdkClientException, SSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeMaintenanceWindowExecutionTasksResponse describeMaintenanceWindowExecutionTasks(DescribeMaintenanceWindowExecutionTasksRequest describeMaintenanceWindowExecutionTasksRequest) throws DoesNotExistException, InternalServerErrorException, SdkBaseException, SdkClientException, SSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeMaintenanceWindowExecutionsResponse describeMaintenanceWindowExecutions(DescribeMaintenanceWindowExecutionsRequest describeMaintenanceWindowExecutionsRequest) throws InternalServerErrorException, SdkBaseException, SdkClientException, SSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeMaintenanceWindowTargetsResponse describeMaintenanceWindowTargets(DescribeMaintenanceWindowTargetsRequest describeMaintenanceWindowTargetsRequest) throws DoesNotExistException, InternalServerErrorException, SdkBaseException, SdkClientException, SSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeMaintenanceWindowTasksResponse describeMaintenanceWindowTasks(DescribeMaintenanceWindowTasksRequest describeMaintenanceWindowTasksRequest) throws DoesNotExistException, InternalServerErrorException, SdkBaseException, SdkClientException, SSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeMaintenanceWindowsResponse describeMaintenanceWindows(DescribeMaintenanceWindowsRequest describeMaintenanceWindowsRequest) throws InternalServerErrorException, SdkBaseException, SdkClientException, SSMException
Retrieves the Maintenance Windows in an AWS account.
describeMaintenanceWindowsRequest
- InternalServerErrorException
- An error occurred on the server side.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeParametersResponse describeParameters(DescribeParametersRequest describeParametersRequest) throws InternalServerErrorException, InvalidFilterKeyException, InvalidFilterOptionException, InvalidFilterValueException, InvalidNextTokenException, SdkBaseException, SdkClientException, SSMException
Get information about a parameter.
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribePatchBaselinesResponse describePatchBaselines(DescribePatchBaselinesRequest describePatchBaselinesRequest) throws InternalServerErrorException, SdkBaseException, SdkClientException, SSMException
Lists the patch baselines in your AWS account.
describePatchBaselinesRequest
- InternalServerErrorException
- An error occurred on the server side.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribePatchGroupStateResponse describePatchGroupState(DescribePatchGroupStateRequest describePatchGroupStateRequest) throws InternalServerErrorException, InvalidNextTokenException, SdkBaseException, SdkClientException, SSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribePatchGroupsResponse describePatchGroups(DescribePatchGroupsRequest describePatchGroupsRequest) throws InternalServerErrorException, SdkBaseException, SdkClientException, SSMException
Lists all patch groups that have been registered with patch baselines.
describePatchGroupsRequest
- InternalServerErrorException
- An error occurred on the server side.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetAutomationExecutionResponse getAutomationExecution(GetAutomationExecutionRequest getAutomationExecutionRequest) throws AutomationExecutionNotFoundException, InternalServerErrorException, SdkBaseException, SdkClientException, SSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetCommandInvocationResponse getCommandInvocation(GetCommandInvocationRequest getCommandInvocationRequest) throws InternalServerErrorException, InvalidCommandIdException, InvalidInstanceIdException, InvalidPluginNameException, InvocationDoesNotExistException, SdkBaseException, SdkClientException, SSMException
Returns detailed information about command execution for an invocation or plugin.
getCommandInvocationRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidCommandIdException
InvalidInstanceIdException
- The following problems can cause this exception:
You do not have permission to access the instance.
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetDefaultPatchBaselineResponse getDefaultPatchBaseline(GetDefaultPatchBaselineRequest getDefaultPatchBaselineRequest) throws InternalServerErrorException, SdkBaseException, SdkClientException, SSMException
Retrieves the default patch baseline.
getDefaultPatchBaselineRequest
- InternalServerErrorException
- An error occurred on the server side.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetDeployablePatchSnapshotForInstanceResponse getDeployablePatchSnapshotForInstance(GetDeployablePatchSnapshotForInstanceRequest getDeployablePatchSnapshotForInstanceRequest) throws InternalServerErrorException, SdkBaseException, SdkClientException, SSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetDocumentResponse getDocument(GetDocumentRequest getDocumentRequest) throws InternalServerErrorException, InvalidDocumentException, InvalidDocumentVersionException, SdkBaseException, SdkClientException, SSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetInventoryResponse getInventory(GetInventoryRequest getInventoryRequest) throws InternalServerErrorException, InvalidFilterException, InvalidNextTokenException, InvalidTypeNameException, InvalidResultAttributeException, SdkBaseException, SdkClientException, SSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetInventorySchemaResponse getInventorySchema(GetInventorySchemaRequest getInventorySchemaRequest) throws InternalServerErrorException, InvalidTypeNameException, InvalidNextTokenException, SdkBaseException, SdkClientException, SSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetMaintenanceWindowResponse getMaintenanceWindow(GetMaintenanceWindowRequest getMaintenanceWindowRequest) throws DoesNotExistException, InternalServerErrorException, SdkBaseException, SdkClientException, SSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetMaintenanceWindowExecutionResponse getMaintenanceWindowExecution(GetMaintenanceWindowExecutionRequest getMaintenanceWindowExecutionRequest) throws DoesNotExistException, InternalServerErrorException, SdkBaseException, SdkClientException, SSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetMaintenanceWindowExecutionTaskResponse getMaintenanceWindowExecutionTask(GetMaintenanceWindowExecutionTaskRequest getMaintenanceWindowExecutionTaskRequest) throws DoesNotExistException, InternalServerErrorException, SdkBaseException, SdkClientException, SSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetParameterResponse getParameter(GetParameterRequest getParameterRequest) throws InternalServerErrorException, InvalidKeyIdException, ParameterNotFoundException, SdkBaseException, SdkClientException, SSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetParameterHistoryResponse getParameterHistory(GetParameterHistoryRequest getParameterHistoryRequest) throws InternalServerErrorException, ParameterNotFoundException, InvalidNextTokenException, InvalidKeyIdException, SdkBaseException, SdkClientException, SSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetParametersResponse getParameters(GetParametersRequest getParametersRequest) throws InvalidKeyIdException, InternalServerErrorException, SdkBaseException, SdkClientException, SSMException
Get details of a parameter.
getParametersRequest
- InvalidKeyIdException
- The query key ID is not valid.InternalServerErrorException
- An error occurred on the server side.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetParametersByPathResponse getParametersByPath(GetParametersByPathRequest getParametersByPathRequest) throws InternalServerErrorException, InvalidFilterKeyException, InvalidFilterOptionException, InvalidFilterValueException, InvalidKeyIdException, InvalidNextTokenException, SdkBaseException, SdkClientException, SSMException
Retrieve parameters in a specific hierarchy. For more information, see Using Parameter Hierarchies.
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetPatchBaselineResponse getPatchBaseline(GetPatchBaselineRequest getPatchBaselineRequest) throws DoesNotExistException, InvalidResourceIdException, InternalServerErrorException, SdkBaseException, SdkClientException, SSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetPatchBaselineForPatchGroupResponse getPatchBaselineForPatchGroup(GetPatchBaselineForPatchGroupRequest getPatchBaselineForPatchGroupRequest) throws InternalServerErrorException, SdkBaseException, SdkClientException, SSMException
Retrieves the patch baseline that should be used for the specified patch group.
getPatchBaselineForPatchGroupRequest
- InternalServerErrorException
- An error occurred on the server side.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListAssociationsResponse listAssociations(ListAssociationsRequest listAssociationsRequest) throws InternalServerErrorException, InvalidNextTokenException, SdkBaseException, SdkClientException, SSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListCommandInvocationsResponse listCommandInvocations(ListCommandInvocationsRequest listCommandInvocationsRequest) throws InternalServerErrorException, InvalidCommandIdException, InvalidInstanceIdException, InvalidFilterKeyException, InvalidNextTokenException, SdkBaseException, SdkClientException, SSMException
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.InvalidCommandIdException
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.
InvalidFilterKeyException
- The specified key is not valid.InvalidNextTokenException
- The specified token is not valid.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListCommandsResponse listCommands(ListCommandsRequest listCommandsRequest) throws InternalServerErrorException, InvalidCommandIdException, InvalidInstanceIdException, InvalidFilterKeyException, InvalidNextTokenException, SdkBaseException, SdkClientException, SSMException
Lists the commands requested by users of the AWS account.
listCommandsRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidCommandIdException
InvalidInstanceIdException
- The following problems can cause this exception:
You do not have permission to access the instance.
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListDocumentVersionsResponse listDocumentVersions(ListDocumentVersionsRequest listDocumentVersionsRequest) throws InternalServerErrorException, InvalidNextTokenException, InvalidDocumentException, SdkBaseException, SdkClientException, SSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListDocumentsResponse listDocuments(ListDocumentsRequest listDocumentsRequest) throws InternalServerErrorException, InvalidNextTokenException, InvalidFilterKeyException, SdkBaseException, SdkClientException, SSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListInventoryEntriesResponse listInventoryEntries(ListInventoryEntriesRequest listInventoryEntriesRequest) throws InternalServerErrorException, InvalidInstanceIdException, InvalidTypeNameException, InvalidFilterException, InvalidNextTokenException, SdkBaseException, SdkClientException, SSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws InvalidResourceTypeException, InvalidResourceIdException, InternalServerErrorException, SdkBaseException, SdkClientException, SSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ModifyDocumentPermissionResponse modifyDocumentPermission(ModifyDocumentPermissionRequest modifyDocumentPermissionRequest) throws InternalServerErrorException, InvalidDocumentException, InvalidPermissionTypeException, DocumentPermissionLimitException, DocumentLimitExceededException, SdkBaseException, SdkClientException, SSMException
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 SSM documents.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault PutInventoryResponse putInventory(PutInventoryRequest putInventoryRequest) throws InternalServerErrorException, InvalidInstanceIdException, InvalidTypeNameException, InvalidItemContentException, TotalSizeLimitExceededException, ItemSizeLimitExceededException, ItemContentMismatchException, CustomSchemaCountLimitExceededException, UnsupportedInventorySchemaVersionException, SdkBaseException, SdkClientException, SSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault PutParameterResponse putParameter(PutParameterRequest putParameterRequest) throws InternalServerErrorException, InvalidKeyIdException, ParameterLimitExceededException, TooManyUpdatesException, ParameterAlreadyExistsException, HierarchyLevelLimitExceededException, HierarchyTypeMismatchException, InvalidAllowedPatternException, ParameterPatternMismatchException, UnsupportedParameterTypeException, SdkBaseException, SdkClientException, SSMException
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 Develop a Parameter Hierarchy.
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.ParameterPatternMismatchException
- The parameter name is not valid.UnsupportedParameterTypeException
- The parameter type is not supported.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault RegisterDefaultPatchBaselineResponse registerDefaultPatchBaseline(RegisterDefaultPatchBaselineRequest registerDefaultPatchBaselineRequest) throws InvalidResourceIdException, DoesNotExistException, InternalServerErrorException, SdkBaseException, SdkClientException, SSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault RegisterPatchBaselineForPatchGroupResponse registerPatchBaselineForPatchGroup(RegisterPatchBaselineForPatchGroupRequest registerPatchBaselineForPatchGroupRequest) throws AlreadyExistsException, DoesNotExistException, InvalidResourceIdException, ResourceLimitExceededException, InternalServerErrorException, SdkBaseException, SdkClientException, SSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault RegisterTargetWithMaintenanceWindowResponse registerTargetWithMaintenanceWindow(RegisterTargetWithMaintenanceWindowRequest registerTargetWithMaintenanceWindowRequest) throws IdempotentParameterMismatchException, DoesNotExistException, ResourceLimitExceededException, InternalServerErrorException, SdkBaseException, SdkClientException, SSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault RegisterTaskWithMaintenanceWindowResponse registerTaskWithMaintenanceWindow(RegisterTaskWithMaintenanceWindowRequest registerTaskWithMaintenanceWindowRequest) throws IdempotentParameterMismatchException, DoesNotExistException, ResourceLimitExceededException, InternalServerErrorException, SdkBaseException, SdkClientException, SSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault RemoveTagsFromResourceResponse removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest) throws InvalidResourceTypeException, InvalidResourceIdException, InternalServerErrorException, SdkBaseException, SdkClientException, SSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault SendCommandResponse sendCommand(SendCommandRequest sendCommandRequest) throws DuplicateInstanceIdException, InternalServerErrorException, InvalidInstanceIdException, InvalidDocumentException, InvalidOutputFolderException, InvalidParametersException, UnsupportedPlatformTypeException, MaxDocumentSizeExceededException, InvalidRoleException, InvalidNotificationConfigException, SdkBaseException, SdkClientException, SSMException
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 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
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault StartAutomationExecutionResponse startAutomationExecution(StartAutomationExecutionRequest startAutomationExecutionRequest) throws AutomationDefinitionNotFoundException, InvalidAutomationExecutionParametersException, AutomationExecutionLimitExceededException, AutomationDefinitionVersionNotFoundException, InternalServerErrorException, SdkBaseException, SdkClientException, SSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault StopAutomationExecutionResponse stopAutomationExecution(StopAutomationExecutionRequest stopAutomationExecutionRequest) throws AutomationExecutionNotFoundException, InternalServerErrorException, SdkBaseException, SdkClientException, SSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault UpdateAssociationResponse updateAssociation(UpdateAssociationRequest updateAssociationRequest) throws InternalServerErrorException, InvalidScheduleException, InvalidParametersException, InvalidOutputLocationException, InvalidDocumentVersionException, AssociationDoesNotExistException, InvalidUpdateException, TooManyUpdatesException, InvalidDocumentException, InvalidTargetException, SdkBaseException, SdkClientException, SSMException
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.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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault UpdateAssociationStatusResponse updateAssociationStatus(UpdateAssociationStatusRequest updateAssociationStatusRequest) throws InternalServerErrorException, InvalidInstanceIdException, InvalidDocumentException, AssociationDoesNotExistException, StatusUnchangedException, TooManyUpdatesException, SdkBaseException, SdkClientException, SSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault UpdateDocumentResponse updateDocument(UpdateDocumentRequest updateDocumentRequest) throws MaxDocumentSizeExceededException, DocumentVersionLimitExceededException, InternalServerErrorException, DuplicateDocumentContentException, InvalidDocumentContentException, InvalidDocumentVersionException, InvalidDocumentSchemaVersionException, InvalidDocumentException, SdkBaseException, SdkClientException, SSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault UpdateDocumentDefaultVersionResponse updateDocumentDefaultVersion(UpdateDocumentDefaultVersionRequest updateDocumentDefaultVersionRequest) throws InternalServerErrorException, InvalidDocumentException, InvalidDocumentVersionException, InvalidDocumentSchemaVersionException, SdkBaseException, SdkClientException, SSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault UpdateMaintenanceWindowResponse updateMaintenanceWindow(UpdateMaintenanceWindowRequest updateMaintenanceWindowRequest) throws DoesNotExistException, InternalServerErrorException, SdkBaseException, SdkClientException, SSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault UpdateManagedInstanceRoleResponse updateManagedInstanceRole(UpdateManagedInstanceRoleRequest updateManagedInstanceRoleRequest) throws InvalidInstanceIdException, InternalServerErrorException, SdkBaseException, SdkClientException, SSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault UpdatePatchBaselineResponse updatePatchBaseline(UpdatePatchBaselineRequest updatePatchBaselineRequest) throws DoesNotExistException, InternalServerErrorException, SdkBaseException, SdkClientException, SSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typestatic ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.