| Package | Description |
|---|---|
| software.amazon.awssdk.services.ssm |
|
| software.amazon.awssdk.services.ssm.model |
| Modifier and Type | Method and Description |
|---|---|
default AddTagsToResourceResponse |
SSMClient.addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest)
Adds or overwrites one or more tags for the specified resource.
|
default CancelCommandResponse |
SSMClient.cancelCommand(CancelCommandRequest cancelCommandRequest)
Attempts to cancel the command specified by the Command ID.
|
default CreateActivationResponse |
SSMClient.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 |
SSMClient.createAssociation(CreateAssociationRequest createAssociationRequest)
Associates the specified Systems Manager document with the specified instances or targets.
|
default CreateAssociationBatchResponse |
SSMClient.createAssociationBatch(CreateAssociationBatchRequest createAssociationBatchRequest)
Associates the specified Systems Manager document with the specified instances or targets.
|
default CreateDocumentResponse |
SSMClient.createDocument(CreateDocumentRequest createDocumentRequest)
Creates a Systems Manager document.
|
default CreateMaintenanceWindowResponse |
SSMClient.createMaintenanceWindow(CreateMaintenanceWindowRequest createMaintenanceWindowRequest)
Creates a new Maintenance Window.
|
default CreatePatchBaselineResponse |
SSMClient.createPatchBaseline(CreatePatchBaselineRequest createPatchBaselineRequest)
Creates a patch baseline.
|
default DeleteActivationResponse |
SSMClient.deleteActivation(DeleteActivationRequest deleteActivationRequest)
Deletes an activation.
|
default DeleteAssociationResponse |
SSMClient.deleteAssociation(DeleteAssociationRequest deleteAssociationRequest)
Disassociates the specified Systems Manager document from the specified instance.
|
default DeleteDocumentResponse |
SSMClient.deleteDocument(DeleteDocumentRequest deleteDocumentRequest)
Deletes the Systems Manager document and all instance associations to the document.
|
default DeleteMaintenanceWindowResponse |
SSMClient.deleteMaintenanceWindow(DeleteMaintenanceWindowRequest deleteMaintenanceWindowRequest)
Deletes a Maintenance Window.
|
default DeleteParameterResponse |
SSMClient.deleteParameter(DeleteParameterRequest deleteParameterRequest)
Delete a parameter from the system.
|
default DeleteParametersResponse |
SSMClient.deleteParameters(DeleteParametersRequest deleteParametersRequest)
Delete a list of parameters.
|
default DeletePatchBaselineResponse |
SSMClient.deletePatchBaseline(DeletePatchBaselineRequest deletePatchBaselineRequest)
Deletes a patch baseline.
|
default DeregisterManagedInstanceResponse |
SSMClient.deregisterManagedInstance(DeregisterManagedInstanceRequest deregisterManagedInstanceRequest)
Removes the server or virtual machine from the list of registered servers.
|
default DeregisterPatchBaselineForPatchGroupResponse |
SSMClient.deregisterPatchBaselineForPatchGroup(DeregisterPatchBaselineForPatchGroupRequest deregisterPatchBaselineForPatchGroupRequest)
Removes a patch group from a patch baseline.
|
default DeregisterTargetFromMaintenanceWindowResponse |
SSMClient.deregisterTargetFromMaintenanceWindow(DeregisterTargetFromMaintenanceWindowRequest deregisterTargetFromMaintenanceWindowRequest)
Removes a target from a Maintenance Window.
|
default DeregisterTaskFromMaintenanceWindowResponse |
SSMClient.deregisterTaskFromMaintenanceWindow(DeregisterTaskFromMaintenanceWindowRequest deregisterTaskFromMaintenanceWindowRequest)
Removes a task from a Maintenance Window.
|
default DescribeActivationsResponse |
SSMClient.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 |
SSMClient.describeAssociation(DescribeAssociationRequest describeAssociationRequest)
Describes the associations for the specified Systems Manager document or instance.
|
default DescribeAutomationExecutionsResponse |
SSMClient.describeAutomationExecutions(DescribeAutomationExecutionsRequest describeAutomationExecutionsRequest)
Provides details about all active and terminated Automation executions.
|
default DescribeAvailablePatchesResponse |
SSMClient.describeAvailablePatches(DescribeAvailablePatchesRequest describeAvailablePatchesRequest)
Lists all patches that could possibly be included in a patch baseline.
|
default DescribeDocumentResponse |
SSMClient.describeDocument(DescribeDocumentRequest describeDocumentRequest)
Describes the specified SSM document.
|
default DescribeDocumentPermissionResponse |
SSMClient.describeDocumentPermission(DescribeDocumentPermissionRequest describeDocumentPermissionRequest)
Describes the permissions for a Systems Manager document.
|
default DescribeEffectiveInstanceAssociationsResponse |
SSMClient.describeEffectiveInstanceAssociations(DescribeEffectiveInstanceAssociationsRequest describeEffectiveInstanceAssociationsRequest)
All associations for the instance(s).
|
default DescribeEffectivePatchesForPatchBaselineResponse |
SSMClient.describeEffectivePatchesForPatchBaseline(DescribeEffectivePatchesForPatchBaselineRequest describeEffectivePatchesForPatchBaselineRequest)
Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline.
|
default DescribeInstanceAssociationsStatusResponse |
SSMClient.describeInstanceAssociationsStatus(DescribeInstanceAssociationsStatusRequest describeInstanceAssociationsStatusRequest)
The status of the associations for the instance(s).
|
default DescribeInstanceInformationResponse |
SSMClient.describeInstanceInformation(DescribeInstanceInformationRequest describeInstanceInformationRequest)
Describes one or more of your instances.
|
default DescribeInstancePatchesResponse |
SSMClient.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 |
SSMClient.describeInstancePatchStates(DescribeInstancePatchStatesRequest describeInstancePatchStatesRequest)
Retrieves the high-level patch state of one or more instances.
|
default DescribeInstancePatchStatesForPatchGroupResponse |
SSMClient.describeInstancePatchStatesForPatchGroup(DescribeInstancePatchStatesForPatchGroupRequest describeInstancePatchStatesForPatchGroupRequest)
Retrieves the high-level patch state for the instances in the specified patch group.
|
default DescribeMaintenanceWindowExecutionsResponse |
SSMClient.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 |
SSMClient.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 |
SSMClient.describeMaintenanceWindowExecutionTasks(DescribeMaintenanceWindowExecutionTasksRequest describeMaintenanceWindowExecutionTasksRequest)
For a given Maintenance Window execution, lists the tasks that were executed.
|
default DescribeMaintenanceWindowsResponse |
SSMClient.describeMaintenanceWindows(DescribeMaintenanceWindowsRequest describeMaintenanceWindowsRequest)
Retrieves the Maintenance Windows in an AWS account.
|
default DescribeMaintenanceWindowTargetsResponse |
SSMClient.describeMaintenanceWindowTargets(DescribeMaintenanceWindowTargetsRequest describeMaintenanceWindowTargetsRequest)
Lists the targets registered with the Maintenance Window.
|
default DescribeMaintenanceWindowTasksResponse |
SSMClient.describeMaintenanceWindowTasks(DescribeMaintenanceWindowTasksRequest describeMaintenanceWindowTasksRequest)
Lists the tasks in a Maintenance Window.
|
default DescribeParametersResponse |
SSMClient.describeParameters(DescribeParametersRequest describeParametersRequest)
Get information about a parameter.
|
default DescribePatchBaselinesResponse |
SSMClient.describePatchBaselines(DescribePatchBaselinesRequest describePatchBaselinesRequest)
Lists the patch baselines in your AWS account.
|
default DescribePatchGroupsResponse |
SSMClient.describePatchGroups(DescribePatchGroupsRequest describePatchGroupsRequest)
Lists all patch groups that have been registered with patch baselines.
|
default DescribePatchGroupStateResponse |
SSMClient.describePatchGroupState(DescribePatchGroupStateRequest describePatchGroupStateRequest)
Returns high-level aggregated patch compliance state for a patch group.
|
default GetAutomationExecutionResponse |
SSMClient.getAutomationExecution(GetAutomationExecutionRequest getAutomationExecutionRequest)
Get detailed information about a particular Automation execution.
|
default GetCommandInvocationResponse |
SSMClient.getCommandInvocation(GetCommandInvocationRequest getCommandInvocationRequest)
Returns detailed information about command execution for an invocation or plugin.
|
default GetDefaultPatchBaselineResponse |
SSMClient.getDefaultPatchBaseline(GetDefaultPatchBaselineRequest getDefaultPatchBaselineRequest)
Retrieves the default patch baseline.
|
default GetDeployablePatchSnapshotForInstanceResponse |
SSMClient.getDeployablePatchSnapshotForInstance(GetDeployablePatchSnapshotForInstanceRequest getDeployablePatchSnapshotForInstanceRequest)
Retrieves the current snapshot for the patch baseline the instance uses.
|
default GetDocumentResponse |
SSMClient.getDocument(GetDocumentRequest getDocumentRequest)
Gets the contents of the specified SSM document.
|
default GetInventoryResponse |
SSMClient.getInventory(GetInventoryRequest getInventoryRequest)
Query inventory information.
|
default GetInventorySchemaResponse |
SSMClient.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 |
SSMClient.getMaintenanceWindow(GetMaintenanceWindowRequest getMaintenanceWindowRequest)
Retrieves a Maintenance Window.
|
default GetMaintenanceWindowExecutionResponse |
SSMClient.getMaintenanceWindowExecution(GetMaintenanceWindowExecutionRequest getMaintenanceWindowExecutionRequest)
Retrieves details about a specific task executed as part of a Maintenance Window execution.
|
default GetMaintenanceWindowExecutionTaskResponse |
SSMClient.getMaintenanceWindowExecutionTask(GetMaintenanceWindowExecutionTaskRequest getMaintenanceWindowExecutionTaskRequest)
Retrieves the details about a specific task executed as part of a Maintenance Window execution.
|
default GetParameterResponse |
SSMClient.getParameter(GetParameterRequest getParameterRequest)
Get information about a parameter by using the parameter name.
|
default GetParameterHistoryResponse |
SSMClient.getParameterHistory(GetParameterHistoryRequest getParameterHistoryRequest)
Query a list of all parameters used by the AWS account.
|
default GetParametersResponse |
SSMClient.getParameters(GetParametersRequest getParametersRequest)
Get details of a parameter.
|
default GetParametersByPathResponse |
SSMClient.getParametersByPath(GetParametersByPathRequest getParametersByPathRequest)
Retrieve parameters in a specific hierarchy.
|
default GetPatchBaselineResponse |
SSMClient.getPatchBaseline(GetPatchBaselineRequest getPatchBaselineRequest)
Retrieves information about a patch baseline.
|
default GetPatchBaselineForPatchGroupResponse |
SSMClient.getPatchBaselineForPatchGroup(GetPatchBaselineForPatchGroupRequest getPatchBaselineForPatchGroupRequest)
Retrieves the patch baseline that should be used for the specified patch group.
|
default ListAssociationsResponse |
SSMClient.listAssociations(ListAssociationsRequest listAssociationsRequest)
Lists the associations for the specified Systems Manager document or instance.
|
default ListCommandInvocationsResponse |
SSMClient.listCommandInvocations(ListCommandInvocationsRequest listCommandInvocationsRequest)
An invocation is copy of a command sent to a specific instance.
|
default ListCommandsResponse |
SSMClient.listCommands(ListCommandsRequest listCommandsRequest)
Lists the commands requested by users of the AWS account.
|
default ListDocumentsResponse |
SSMClient.listDocuments(ListDocumentsRequest listDocumentsRequest)
Describes one or more of your SSM documents.
|
default ListDocumentVersionsResponse |
SSMClient.listDocumentVersions(ListDocumentVersionsRequest listDocumentVersionsRequest)
List all versions for a document.
|
default ListInventoryEntriesResponse |
SSMClient.listInventoryEntries(ListInventoryEntriesRequest listInventoryEntriesRequest)
A list of inventory items returned by the request.
|
default ListTagsForResourceResponse |
SSMClient.listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Returns a list of the tags assigned to the specified resource.
|
default ModifyDocumentPermissionResponse |
SSMClient.modifyDocumentPermission(ModifyDocumentPermissionRequest modifyDocumentPermissionRequest)
Shares a Systems Manager document publicly or privately.
|
default PutInventoryResponse |
SSMClient.putInventory(PutInventoryRequest putInventoryRequest)
Bulk update custom inventory items on one more instance.
|
default PutParameterResponse |
SSMClient.putParameter(PutParameterRequest putParameterRequest)
Add one or more parameters to the system.
|
default RegisterDefaultPatchBaselineResponse |
SSMClient.registerDefaultPatchBaseline(RegisterDefaultPatchBaselineRequest registerDefaultPatchBaselineRequest)
Defines the default patch baseline.
|
default RegisterPatchBaselineForPatchGroupResponse |
SSMClient.registerPatchBaselineForPatchGroup(RegisterPatchBaselineForPatchGroupRequest registerPatchBaselineForPatchGroupRequest)
Registers a patch baseline for a patch group.
|
default RegisterTargetWithMaintenanceWindowResponse |
SSMClient.registerTargetWithMaintenanceWindow(RegisterTargetWithMaintenanceWindowRequest registerTargetWithMaintenanceWindowRequest)
Registers a target with a Maintenance Window.
|
default RegisterTaskWithMaintenanceWindowResponse |
SSMClient.registerTaskWithMaintenanceWindow(RegisterTaskWithMaintenanceWindowRequest registerTaskWithMaintenanceWindowRequest)
Adds a new task to a Maintenance Window.
|
default RemoveTagsFromResourceResponse |
SSMClient.removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)
Removes all tags from the specified resource.
|
default SendCommandResponse |
SSMClient.sendCommand(SendCommandRequest sendCommandRequest)
Executes commands on one or more managed instances.
|
default StartAutomationExecutionResponse |
SSMClient.startAutomationExecution(StartAutomationExecutionRequest startAutomationExecutionRequest)
Initiates execution of an Automation document.
|
default StopAutomationExecutionResponse |
SSMClient.stopAutomationExecution(StopAutomationExecutionRequest stopAutomationExecutionRequest)
Stop an Automation that is currently executing.
|
default UpdateAssociationResponse |
SSMClient.updateAssociation(UpdateAssociationRequest updateAssociationRequest)
Updates an association.
|
default UpdateAssociationStatusResponse |
SSMClient.updateAssociationStatus(UpdateAssociationStatusRequest updateAssociationStatusRequest)
Updates the status of the Systems Manager document associated with the specified instance.
|
default UpdateDocumentResponse |
SSMClient.updateDocument(UpdateDocumentRequest updateDocumentRequest)
The document you want to update.
|
default UpdateDocumentDefaultVersionResponse |
SSMClient.updateDocumentDefaultVersion(UpdateDocumentDefaultVersionRequest updateDocumentDefaultVersionRequest)
Set the default version of a document.
|
default UpdateMaintenanceWindowResponse |
SSMClient.updateMaintenanceWindow(UpdateMaintenanceWindowRequest updateMaintenanceWindowRequest)
Updates an existing Maintenance Window.
|
default UpdateManagedInstanceRoleResponse |
SSMClient.updateManagedInstanceRole(UpdateManagedInstanceRoleRequest updateManagedInstanceRoleRequest)
Assigns or changes an Amazon Identity and Access Management (IAM) role to the managed instance.
|
default UpdatePatchBaselineResponse |
SSMClient.updatePatchBaseline(UpdatePatchBaselineRequest updatePatchBaselineRequest)
Modifies an existing patch baseline.
|
| Modifier and Type | Class and Description |
|---|---|
class |
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.
|
class |
AssociatedInstancesException
You must disassociate a document from all instances before you can delete it.
|
class |
AssociationAlreadyExistsException
The specified association already exists.
|
class |
AssociationDoesNotExistException
The specified association does not exist.
|
class |
AssociationLimitExceededException
You can have at most 2,000 active associations.
|
class |
AutomationDefinitionNotFoundException
An Automation document with the specified name could not be found.
|
class |
AutomationDefinitionVersionNotFoundException
An Automation document with the specified name and version could not be found.
|
class |
AutomationExecutionLimitExceededException
The number of simultaneously running Automation executions exceeded the allowable limit.
|
class |
AutomationExecutionNotFoundException
There is no automation execution information for the requested automation execution ID.
|
class |
CustomSchemaCountLimitExceededException
You have exceeded the limit for custom schemas.
|
class |
DocumentAlreadyExistsException
The specified document already exists.
|
class |
DocumentLimitExceededException
You can have at most 200 active SSM documents.
|
class |
DocumentPermissionLimitException
The document cannot be shared with more AWS user accounts.
|
class |
DocumentVersionLimitExceededException
The document has too many versions.
|
class |
DoesNotExistException
Error returned when the ID specified for a resource (e.g.
|
class |
DuplicateDocumentContentException
The content of the association document matches another document.
|
class |
DuplicateInstanceIdException
You cannot specify an instance ID in more than one association.
|
class |
HierarchyLevelLimitExceededException
A hierarchy can have a maximum of five levels.
|
class |
HierarchyTypeMismatchException
Parameter Store does not support changing a parameter type in a hierarchy.
|
class |
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.
|
class |
InternalServerErrorException
An error occurred on the server side.
|
class |
InvalidActivationException
The activation is not valid.
|
class |
InvalidActivationIdException
The activation ID is not valid.
|
class |
InvalidAllowedPatternException
The request does not meet the regular expression requirement.
|
class |
InvalidAutomationExecutionParametersException
The supplied parameters for invoking the specified Automation document are incorrect.
|
class |
InvalidCommandIdException |
class |
InvalidDocumentContentException
The content for the document is not valid.
|
class |
InvalidDocumentException
The specified document does not exist.
|
class |
InvalidDocumentOperationException
You attempted to delete a document while it is still shared.
|
class |
InvalidDocumentSchemaVersionException
The version of the document schema is not supported.
|
class |
InvalidDocumentVersionException
The document version is not valid or does not exist.
|
class |
InvalidFilterException
The filter name is not valid.
|
class |
InvalidFilterKeyException
The specified key is not valid.
|
class |
InvalidFilterOptionException
The specified filter option is not valid.
|
class |
InvalidFilterValueException
The filter value is not valid.
|
class |
InvalidInstanceIdException
The following problems can cause this exception:
|
class |
InvalidInstanceInformationFilterValueException
The specified filter value is not valid.
|
class |
InvalidItemContentException
One or more content items is not valid.
|
class |
InvalidKeyIdException
The query key ID is not valid.
|
class |
InvalidNextTokenException
The specified token is not valid.
|
class |
InvalidNotificationConfigException
One or more configuration items is not valid.
|
class |
InvalidOutputFolderException
The S3 bucket does not exist.
|
class |
InvalidOutputLocationException
The output location is not valid or does not exist.
|
class |
InvalidParametersException
You must specify values for all required parameters in the SSM document.
|
class |
InvalidPermissionTypeException
The permission type is not supported.
|
class |
InvalidPluginNameException
The plugin name is not valid.
|
class |
InvalidResourceIdException
The resource ID is not valid.
|
class |
InvalidResourceTypeException
The resource type is not valid.
|
class |
InvalidResultAttributeException
The specified inventory item result attribute is not valid.
|
class |
InvalidRoleException
The role name can't contain invalid characters.
|
class |
InvalidScheduleException
The schedule is invalid.
|
class |
InvalidTargetException
The target is not valid or does not exist.
|
class |
InvalidTypeNameException
The parameter type name is not valid.
|
class |
InvalidUpdateException
The update is not valid.
|
class |
InvocationDoesNotExistException
The command ID and instance ID you specified did not match any invocations.
|
class |
ItemContentMismatchException
The inventory item has invalid content.
|
class |
ItemSizeLimitExceededException
The inventory item size has exceeded the size limit.
|
class |
MaxDocumentSizeExceededException
The size limit of a document is 64 KB.
|
class |
ParameterAlreadyExistsException
The parameter already exists.
|
class |
ParameterLimitExceededException
You have exceeded the number of parameters for this AWS account.
|
class |
ParameterNotFoundException
The parameter could not be found.
|
class |
ParameterPatternMismatchException
The parameter name is not valid.
|
class |
ResourceInUseException
Error returned if an attempt is made to delete a patch baseline that is registered for a patch group.
|
class |
ResourceLimitExceededException
Error returned when the caller has exceeded the default resource limits (e.g.
|
class |
StatusUnchangedException
The updated status is the same as the current status.
|
class |
TooManyTagsErrorException
The Targets parameter includes too many tags.
|
class |
TooManyUpdatesException
There are concurrent updates for a resource that supports one update at a time.
|
class |
TotalSizeLimitExceededException
The size of inventory data has exceeded the total size limit for the resource.
|
class |
UnsupportedInventorySchemaVersionException
Inventory item type schema version has to match supported versions in the service.
|
class |
UnsupportedParameterTypeException
The parameter type is not supported.
|
class |
UnsupportedPlatformTypeException
The document does not support the platform type of the given instance ID(s).
|
Copyright © 2017. All rights reserved.