@Generated(value="software.amazon.awssdk:codegen") public interface SsmClient extends SdkClient
builder()
method.
AWS Systems Manager is a collection of capabilities that helps you automate management tasks such as collecting system inventory, applying operating system (OS) patches, automating the creation of Amazon Machine Images (AMIs), and configuring operating systems (OSs) and applications at scale. Systems Manager lets you remotely and securely manage the configuration of your managed instances. A managed instance is any Amazon Elastic Compute Cloud instance (EC2 instance), or any on-premises server or virtual machine (VM) in your hybrid environment that has been configured for Systems Manager.
This reference is intended to be used with the AWS Systems Manager User Guide.
To get started, verify prerequisites and configure managed instances. For more information, see Setting up AWS Systems Manager in the AWS Systems Manager User Guide.
For information about other API actions you can perform on EC2 instances, see the Amazon EC2 API Reference. For information about how to use a Query API, see Making API requests.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider . |
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
default AddTagsToResourceResponse |
addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest)
Adds or overwrites one or more tags for the specified resource.
|
default AddTagsToResourceResponse |
addTagsToResource(Consumer<AddTagsToResourceRequest.Builder> 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.
|
default CancelCommandResponse |
cancelCommand(Consumer<CancelCommandRequest.Builder> cancelCommandRequest)
Attempts to cancel the command specified by the Command ID.
|
default CancelMaintenanceWindowExecutionResponse |
cancelMaintenanceWindowExecution(CancelMaintenanceWindowExecutionRequest cancelMaintenanceWindowExecutionRequest)
Stops a maintenance window execution that is already in progress and cancels any tasks in the window that have
not already starting running.
|
default CancelMaintenanceWindowExecutionResponse |
cancelMaintenanceWindowExecution(Consumer<CancelMaintenanceWindowExecutionRequest.Builder> cancelMaintenanceWindowExecutionRequest)
Stops a maintenance window execution that is already in progress and cancels any tasks in the window that have
not already starting running.
|
static SsmClient |
create()
Create a
SsmClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default CreateActivationResponse |
createActivation(Consumer<CreateActivationRequest.Builder> createActivationRequest)
Generates an activation code and activation ID you can use to register your on-premises server or virtual machine
(VM) with Systems Manager.
|
default CreateActivationResponse |
createActivation(CreateActivationRequest createActivationRequest)
Generates an activation code and activation ID you can use to register your on-premises server or virtual machine
(VM) with Systems Manager.
|
default CreateAssociationResponse |
createAssociation(Consumer<CreateAssociationRequest.Builder> createAssociationRequest)
A State Manager association defines the state that you want to maintain on your instances.
|
default CreateAssociationResponse |
createAssociation(CreateAssociationRequest createAssociationRequest)
A State Manager association defines the state that you want to maintain on your instances.
|
default CreateAssociationBatchResponse |
createAssociationBatch(Consumer<CreateAssociationBatchRequest.Builder> createAssociationBatchRequest)
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(Consumer<CreateDocumentRequest.Builder> createDocumentRequest)
Creates a Systems Manager (SSM) document.
|
default CreateDocumentResponse |
createDocument(CreateDocumentRequest createDocumentRequest)
Creates a Systems Manager (SSM) document.
|
default CreateMaintenanceWindowResponse |
createMaintenanceWindow(Consumer<CreateMaintenanceWindowRequest.Builder> createMaintenanceWindowRequest)
Creates a new maintenance window.
|
default CreateMaintenanceWindowResponse |
createMaintenanceWindow(CreateMaintenanceWindowRequest createMaintenanceWindowRequest)
Creates a new maintenance window.
|
default CreateOpsItemResponse |
createOpsItem(Consumer<CreateOpsItemRequest.Builder> createOpsItemRequest)
Creates a new OpsItem.
|
default CreateOpsItemResponse |
createOpsItem(CreateOpsItemRequest createOpsItemRequest)
Creates a new OpsItem.
|
default CreateOpsMetadataResponse |
createOpsMetadata(Consumer<CreateOpsMetadataRequest.Builder> createOpsMetadataRequest)
If you create a new application in Application Manager, Systems Manager calls this API action to specify
information about the new application, including the application type.
|
default CreateOpsMetadataResponse |
createOpsMetadata(CreateOpsMetadataRequest createOpsMetadataRequest)
If you create a new application in Application Manager, Systems Manager calls this API action to specify
information about the new application, including the application type.
|
default CreatePatchBaselineResponse |
createPatchBaseline(Consumer<CreatePatchBaselineRequest.Builder> createPatchBaselineRequest)
Creates a patch baseline.
|
default CreatePatchBaselineResponse |
createPatchBaseline(CreatePatchBaselineRequest createPatchBaselineRequest)
Creates a patch baseline.
|
default CreateResourceDataSyncResponse |
createResourceDataSync(Consumer<CreateResourceDataSyncRequest.Builder> createResourceDataSyncRequest)
A resource data sync helps you view data from multiple sources in a single location.
|
default CreateResourceDataSyncResponse |
createResourceDataSync(CreateResourceDataSyncRequest createResourceDataSyncRequest)
A resource data sync helps you view data from multiple sources in a single location.
|
default DeleteActivationResponse |
deleteActivation(Consumer<DeleteActivationRequest.Builder> deleteActivationRequest)
Deletes an activation.
|
default DeleteActivationResponse |
deleteActivation(DeleteActivationRequest deleteActivationRequest)
Deletes an activation.
|
default DeleteAssociationResponse |
deleteAssociation(Consumer<DeleteAssociationRequest.Builder> deleteAssociationRequest)
Disassociates the specified Systems Manager document from the specified instance.
|
default DeleteAssociationResponse |
deleteAssociation(DeleteAssociationRequest deleteAssociationRequest)
Disassociates the specified Systems Manager document from the specified instance.
|
default DeleteDocumentResponse |
deleteDocument(Consumer<DeleteDocumentRequest.Builder> deleteDocumentRequest)
Deletes the Systems Manager document and all instance associations to the document.
|
default DeleteDocumentResponse |
deleteDocument(DeleteDocumentRequest deleteDocumentRequest)
Deletes the Systems Manager document and all instance associations to the document.
|
default DeleteInventoryResponse |
deleteInventory(Consumer<DeleteInventoryRequest.Builder> deleteInventoryRequest)
Delete a custom inventory type or the data associated with a custom Inventory type.
|
default DeleteInventoryResponse |
deleteInventory(DeleteInventoryRequest deleteInventoryRequest)
Delete a custom inventory type or the data associated with a custom Inventory type.
|
default DeleteMaintenanceWindowResponse |
deleteMaintenanceWindow(Consumer<DeleteMaintenanceWindowRequest.Builder> deleteMaintenanceWindowRequest)
Deletes a maintenance window.
|
default DeleteMaintenanceWindowResponse |
deleteMaintenanceWindow(DeleteMaintenanceWindowRequest deleteMaintenanceWindowRequest)
Deletes a maintenance window.
|
default DeleteOpsMetadataResponse |
deleteOpsMetadata(Consumer<DeleteOpsMetadataRequest.Builder> deleteOpsMetadataRequest)
Delete OpsMetadata related to an application.
|
default DeleteOpsMetadataResponse |
deleteOpsMetadata(DeleteOpsMetadataRequest deleteOpsMetadataRequest)
Delete OpsMetadata related to an application.
|
default DeleteParameterResponse |
deleteParameter(Consumer<DeleteParameterRequest.Builder> deleteParameterRequest)
Delete a parameter from the system.
|
default DeleteParameterResponse |
deleteParameter(DeleteParameterRequest deleteParameterRequest)
Delete a parameter from the system.
|
default DeleteParametersResponse |
deleteParameters(Consumer<DeleteParametersRequest.Builder> deleteParametersRequest)
Delete a list of parameters.
|
default DeleteParametersResponse |
deleteParameters(DeleteParametersRequest deleteParametersRequest)
Delete a list of parameters.
|
default DeletePatchBaselineResponse |
deletePatchBaseline(Consumer<DeletePatchBaselineRequest.Builder> deletePatchBaselineRequest)
Deletes a patch baseline.
|
default DeletePatchBaselineResponse |
deletePatchBaseline(DeletePatchBaselineRequest deletePatchBaselineRequest)
Deletes a patch baseline.
|
default DeleteResourceDataSyncResponse |
deleteResourceDataSync(Consumer<DeleteResourceDataSyncRequest.Builder> deleteResourceDataSyncRequest)
Deletes a Resource Data Sync configuration.
|
default DeleteResourceDataSyncResponse |
deleteResourceDataSync(DeleteResourceDataSyncRequest deleteResourceDataSyncRequest)
Deletes a Resource Data Sync configuration.
|
default DeregisterManagedInstanceResponse |
deregisterManagedInstance(Consumer<DeregisterManagedInstanceRequest.Builder> deregisterManagedInstanceRequest)
Removes the server or virtual machine from the list of registered servers.
|
default DeregisterManagedInstanceResponse |
deregisterManagedInstance(DeregisterManagedInstanceRequest deregisterManagedInstanceRequest)
Removes the server or virtual machine from the list of registered servers.
|
default DeregisterPatchBaselineForPatchGroupResponse |
deregisterPatchBaselineForPatchGroup(Consumer<DeregisterPatchBaselineForPatchGroupRequest.Builder> deregisterPatchBaselineForPatchGroupRequest)
Removes a patch group from a patch baseline.
|
default DeregisterPatchBaselineForPatchGroupResponse |
deregisterPatchBaselineForPatchGroup(DeregisterPatchBaselineForPatchGroupRequest deregisterPatchBaselineForPatchGroupRequest)
Removes a patch group from a patch baseline.
|
default DeregisterTargetFromMaintenanceWindowResponse |
deregisterTargetFromMaintenanceWindow(Consumer<DeregisterTargetFromMaintenanceWindowRequest.Builder> deregisterTargetFromMaintenanceWindowRequest)
Removes a target from a maintenance window.
|
default DeregisterTargetFromMaintenanceWindowResponse |
deregisterTargetFromMaintenanceWindow(DeregisterTargetFromMaintenanceWindowRequest deregisterTargetFromMaintenanceWindowRequest)
Removes a target from a maintenance window.
|
default DeregisterTaskFromMaintenanceWindowResponse |
deregisterTaskFromMaintenanceWindow(Consumer<DeregisterTaskFromMaintenanceWindowRequest.Builder> deregisterTaskFromMaintenanceWindowRequest)
Removes a task from a maintenance window.
|
default DeregisterTaskFromMaintenanceWindowResponse |
deregisterTaskFromMaintenanceWindow(DeregisterTaskFromMaintenanceWindowRequest deregisterTaskFromMaintenanceWindowRequest)
Removes a task from a maintenance window.
|
default DescribeActivationsResponse |
describeActivations()
Describes details about the activation, such as the date and time the activation was created, its expiration
date, the IAM role assigned to the instances in the activation, and the number of instances registered by using
this activation.
|
default DescribeActivationsResponse |
describeActivations(Consumer<DescribeActivationsRequest.Builder> describeActivationsRequest)
Describes details about the activation, such as the date and time the activation was created, its expiration
date, the IAM role assigned to the instances in the activation, and the number of instances registered by using
this activation.
|
default DescribeActivationsResponse |
describeActivations(DescribeActivationsRequest describeActivationsRequest)
Describes details about the activation, such as the date and time the activation was created, its expiration
date, the IAM role assigned to the instances in the activation, and the number of instances registered by using
this activation.
|
default DescribeActivationsIterable |
describeActivationsPaginator()
Describes details about the activation, such as the date and time the activation was created, its expiration
date, the IAM role assigned to the instances in the activation, and the number of instances registered by using
this activation.
|
default DescribeActivationsIterable |
describeActivationsPaginator(Consumer<DescribeActivationsRequest.Builder> describeActivationsRequest)
Describes details about the activation, such as the date and time the activation was created, its expiration
date, the IAM role assigned to the instances in the activation, and the number of instances registered by using
this activation.
|
default DescribeActivationsIterable |
describeActivationsPaginator(DescribeActivationsRequest describeActivationsRequest)
Describes details about the activation, such as the date and time the activation was created, its expiration
date, the IAM role assigned to the instances in the activation, and the number of instances registered by using
this activation.
|
default DescribeAssociationResponse |
describeAssociation(Consumer<DescribeAssociationRequest.Builder> describeAssociationRequest)
Describes the association for the specified target or instance.
|
default DescribeAssociationResponse |
describeAssociation(DescribeAssociationRequest describeAssociationRequest)
Describes the association for the specified target or instance.
|
default DescribeAssociationExecutionsResponse |
describeAssociationExecutions(Consumer<DescribeAssociationExecutionsRequest.Builder> describeAssociationExecutionsRequest)
Use this API action to view all executions for a specific association ID.
|
default DescribeAssociationExecutionsResponse |
describeAssociationExecutions(DescribeAssociationExecutionsRequest describeAssociationExecutionsRequest)
Use this API action to view all executions for a specific association ID.
|
default DescribeAssociationExecutionsIterable |
describeAssociationExecutionsPaginator(Consumer<DescribeAssociationExecutionsRequest.Builder> describeAssociationExecutionsRequest)
Use this API action to view all executions for a specific association ID.
|
default DescribeAssociationExecutionsIterable |
describeAssociationExecutionsPaginator(DescribeAssociationExecutionsRequest describeAssociationExecutionsRequest)
Use this API action to view all executions for a specific association ID.
|
default DescribeAssociationExecutionTargetsResponse |
describeAssociationExecutionTargets(Consumer<DescribeAssociationExecutionTargetsRequest.Builder> describeAssociationExecutionTargetsRequest)
Use this API action to view information about a specific execution of a specific association.
|
default DescribeAssociationExecutionTargetsResponse |
describeAssociationExecutionTargets(DescribeAssociationExecutionTargetsRequest describeAssociationExecutionTargetsRequest)
Use this API action to view information about a specific execution of a specific association.
|
default DescribeAssociationExecutionTargetsIterable |
describeAssociationExecutionTargetsPaginator(Consumer<DescribeAssociationExecutionTargetsRequest.Builder> describeAssociationExecutionTargetsRequest)
Use this API action to view information about a specific execution of a specific association.
|
default DescribeAssociationExecutionTargetsIterable |
describeAssociationExecutionTargetsPaginator(DescribeAssociationExecutionTargetsRequest describeAssociationExecutionTargetsRequest)
Use this API action to view information about a specific execution of a specific association.
|
default DescribeAutomationExecutionsResponse |
describeAutomationExecutions()
Provides details about all active and terminated Automation executions.
|
default DescribeAutomationExecutionsResponse |
describeAutomationExecutions(Consumer<DescribeAutomationExecutionsRequest.Builder> describeAutomationExecutionsRequest)
Provides details about all active and terminated Automation executions.
|
default DescribeAutomationExecutionsResponse |
describeAutomationExecutions(DescribeAutomationExecutionsRequest describeAutomationExecutionsRequest)
Provides details about all active and terminated Automation executions.
|
default DescribeAutomationExecutionsIterable |
describeAutomationExecutionsPaginator()
Provides details about all active and terminated Automation executions.
|
default DescribeAutomationExecutionsIterable |
describeAutomationExecutionsPaginator(Consumer<DescribeAutomationExecutionsRequest.Builder> describeAutomationExecutionsRequest)
Provides details about all active and terminated Automation executions.
|
default DescribeAutomationExecutionsIterable |
describeAutomationExecutionsPaginator(DescribeAutomationExecutionsRequest describeAutomationExecutionsRequest)
Provides details about all active and terminated Automation executions.
|
default DescribeAutomationStepExecutionsResponse |
describeAutomationStepExecutions(Consumer<DescribeAutomationStepExecutionsRequest.Builder> describeAutomationStepExecutionsRequest)
Information about all active and terminated step executions in an Automation workflow.
|
default DescribeAutomationStepExecutionsResponse |
describeAutomationStepExecutions(DescribeAutomationStepExecutionsRequest describeAutomationStepExecutionsRequest)
Information about all active and terminated step executions in an Automation workflow.
|
default DescribeAutomationStepExecutionsIterable |
describeAutomationStepExecutionsPaginator(Consumer<DescribeAutomationStepExecutionsRequest.Builder> describeAutomationStepExecutionsRequest)
Information about all active and terminated step executions in an Automation workflow.
|
default DescribeAutomationStepExecutionsIterable |
describeAutomationStepExecutionsPaginator(DescribeAutomationStepExecutionsRequest describeAutomationStepExecutionsRequest)
Information about all active and terminated step executions in an Automation workflow.
|
default DescribeAvailablePatchesResponse |
describeAvailablePatches()
Lists all patches eligible to be included in a patch baseline.
|
default DescribeAvailablePatchesResponse |
describeAvailablePatches(Consumer<DescribeAvailablePatchesRequest.Builder> describeAvailablePatchesRequest)
Lists all patches eligible to be included in a patch baseline.
|
default DescribeAvailablePatchesResponse |
describeAvailablePatches(DescribeAvailablePatchesRequest describeAvailablePatchesRequest)
Lists all patches eligible to be included in a patch baseline.
|
default DescribeAvailablePatchesIterable |
describeAvailablePatchesPaginator()
Lists all patches eligible to be included in a patch baseline.
|
default DescribeAvailablePatchesIterable |
describeAvailablePatchesPaginator(Consumer<DescribeAvailablePatchesRequest.Builder> describeAvailablePatchesRequest)
Lists all patches eligible to be included in a patch baseline.
|
default DescribeAvailablePatchesIterable |
describeAvailablePatchesPaginator(DescribeAvailablePatchesRequest describeAvailablePatchesRequest)
Lists all patches eligible to be included in a patch baseline.
|
default DescribeDocumentResponse |
describeDocument(Consumer<DescribeDocumentRequest.Builder> describeDocumentRequest)
Describes the specified Systems Manager document.
|
default DescribeDocumentResponse |
describeDocument(DescribeDocumentRequest describeDocumentRequest)
Describes the specified Systems Manager document.
|
default DescribeDocumentPermissionResponse |
describeDocumentPermission(Consumer<DescribeDocumentPermissionRequest.Builder> describeDocumentPermissionRequest)
Describes the permissions for a Systems Manager document.
|
default DescribeDocumentPermissionResponse |
describeDocumentPermission(DescribeDocumentPermissionRequest describeDocumentPermissionRequest)
Describes the permissions for a Systems Manager document.
|
default DescribeEffectiveInstanceAssociationsResponse |
describeEffectiveInstanceAssociations(Consumer<DescribeEffectiveInstanceAssociationsRequest.Builder> describeEffectiveInstanceAssociationsRequest)
All associations for the instance(s).
|
default DescribeEffectiveInstanceAssociationsResponse |
describeEffectiveInstanceAssociations(DescribeEffectiveInstanceAssociationsRequest describeEffectiveInstanceAssociationsRequest)
All associations for the instance(s).
|
default DescribeEffectiveInstanceAssociationsIterable |
describeEffectiveInstanceAssociationsPaginator(Consumer<DescribeEffectiveInstanceAssociationsRequest.Builder> describeEffectiveInstanceAssociationsRequest)
All associations for the instance(s).
|
default DescribeEffectiveInstanceAssociationsIterable |
describeEffectiveInstanceAssociationsPaginator(DescribeEffectiveInstanceAssociationsRequest describeEffectiveInstanceAssociationsRequest)
All associations for the instance(s).
|
default DescribeEffectivePatchesForPatchBaselineResponse |
describeEffectivePatchesForPatchBaseline(Consumer<DescribeEffectivePatchesForPatchBaselineRequest.Builder> describeEffectivePatchesForPatchBaselineRequest)
Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline.
|
default DescribeEffectivePatchesForPatchBaselineResponse |
describeEffectivePatchesForPatchBaseline(DescribeEffectivePatchesForPatchBaselineRequest describeEffectivePatchesForPatchBaselineRequest)
Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline.
|
default DescribeEffectivePatchesForPatchBaselineIterable |
describeEffectivePatchesForPatchBaselinePaginator(Consumer<DescribeEffectivePatchesForPatchBaselineRequest.Builder> describeEffectivePatchesForPatchBaselineRequest)
Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline.
|
default DescribeEffectivePatchesForPatchBaselineIterable |
describeEffectivePatchesForPatchBaselinePaginator(DescribeEffectivePatchesForPatchBaselineRequest describeEffectivePatchesForPatchBaselineRequest)
Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline.
|
default DescribeInstanceAssociationsStatusResponse |
describeInstanceAssociationsStatus(Consumer<DescribeInstanceAssociationsStatusRequest.Builder> describeInstanceAssociationsStatusRequest)
The status of the associations for the instance(s).
|
default DescribeInstanceAssociationsStatusResponse |
describeInstanceAssociationsStatus(DescribeInstanceAssociationsStatusRequest describeInstanceAssociationsStatusRequest)
The status of the associations for the instance(s).
|
default DescribeInstanceAssociationsStatusIterable |
describeInstanceAssociationsStatusPaginator(Consumer<DescribeInstanceAssociationsStatusRequest.Builder> describeInstanceAssociationsStatusRequest)
The status of the associations for the instance(s).
|
default DescribeInstanceAssociationsStatusIterable |
describeInstanceAssociationsStatusPaginator(DescribeInstanceAssociationsStatusRequest describeInstanceAssociationsStatusRequest)
The status of the associations for the instance(s).
|
default DescribeInstanceInformationResponse |
describeInstanceInformation()
Describes one or more of your instances, including information about the operating system platform, the version
of SSM Agent installed on the instance, instance status, and so on.
|
default DescribeInstanceInformationResponse |
describeInstanceInformation(Consumer<DescribeInstanceInformationRequest.Builder> describeInstanceInformationRequest)
Describes one or more of your instances, including information about the operating system platform, the version
of SSM Agent installed on the instance, instance status, and so on.
|
default DescribeInstanceInformationResponse |
describeInstanceInformation(DescribeInstanceInformationRequest describeInstanceInformationRequest)
Describes one or more of your instances, including information about the operating system platform, the version
of SSM Agent installed on the instance, instance status, and so on.
|
default DescribeInstanceInformationIterable |
describeInstanceInformationPaginator()
Describes one or more of your instances, including information about the operating system platform, the version
of SSM Agent installed on the instance, instance status, and so on.
|
default DescribeInstanceInformationIterable |
describeInstanceInformationPaginator(Consumer<DescribeInstanceInformationRequest.Builder> describeInstanceInformationRequest)
Describes one or more of your instances, including information about the operating system platform, the version
of SSM Agent installed on the instance, instance status, and so on.
|
default DescribeInstanceInformationIterable |
describeInstanceInformationPaginator(DescribeInstanceInformationRequest describeInstanceInformationRequest)
Describes one or more of your instances, including information about the operating system platform, the version
of SSM Agent installed on the instance, instance status, and so on.
|
default DescribeInstancePatchesResponse |
describeInstancePatches(Consumer<DescribeInstancePatchesRequest.Builder> describeInstancePatchesRequest)
Retrieves information about the patches on the specified instance and their state relative to the patch baseline
being used for the instance.
|
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 DescribeInstancePatchesIterable |
describeInstancePatchesPaginator(Consumer<DescribeInstancePatchesRequest.Builder> describeInstancePatchesRequest)
Retrieves information about the patches on the specified instance and their state relative to the patch baseline
being used for the instance.
|
default DescribeInstancePatchesIterable |
describeInstancePatchesPaginator(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(Consumer<DescribeInstancePatchStatesRequest.Builder> describeInstancePatchStatesRequest)
Retrieves the high-level patch state of one or more instances.
|
default DescribeInstancePatchStatesResponse |
describeInstancePatchStates(DescribeInstancePatchStatesRequest describeInstancePatchStatesRequest)
Retrieves the high-level patch state of one or more instances.
|
default DescribeInstancePatchStatesForPatchGroupResponse |
describeInstancePatchStatesForPatchGroup(Consumer<DescribeInstancePatchStatesForPatchGroupRequest.Builder> describeInstancePatchStatesForPatchGroupRequest)
Retrieves the high-level patch state for the instances in the specified patch group.
|
default DescribeInstancePatchStatesForPatchGroupResponse |
describeInstancePatchStatesForPatchGroup(DescribeInstancePatchStatesForPatchGroupRequest describeInstancePatchStatesForPatchGroupRequest)
Retrieves the high-level patch state for the instances in the specified patch group.
|
default DescribeInstancePatchStatesForPatchGroupIterable |
describeInstancePatchStatesForPatchGroupPaginator(Consumer<DescribeInstancePatchStatesForPatchGroupRequest.Builder> describeInstancePatchStatesForPatchGroupRequest)
Retrieves the high-level patch state for the instances in the specified patch group.
|
default DescribeInstancePatchStatesForPatchGroupIterable |
describeInstancePatchStatesForPatchGroupPaginator(DescribeInstancePatchStatesForPatchGroupRequest describeInstancePatchStatesForPatchGroupRequest)
Retrieves the high-level patch state for the instances in the specified patch group.
|
default DescribeInstancePatchStatesIterable |
describeInstancePatchStatesPaginator(Consumer<DescribeInstancePatchStatesRequest.Builder> describeInstancePatchStatesRequest)
Retrieves the high-level patch state of one or more instances.
|
default DescribeInstancePatchStatesIterable |
describeInstancePatchStatesPaginator(DescribeInstancePatchStatesRequest describeInstancePatchStatesRequest)
Retrieves the high-level patch state of one or more instances.
|
default DescribeInventoryDeletionsResponse |
describeInventoryDeletions()
Describes a specific delete inventory operation.
|
default DescribeInventoryDeletionsResponse |
describeInventoryDeletions(Consumer<DescribeInventoryDeletionsRequest.Builder> describeInventoryDeletionsRequest)
Describes a specific delete inventory operation.
|
default DescribeInventoryDeletionsResponse |
describeInventoryDeletions(DescribeInventoryDeletionsRequest describeInventoryDeletionsRequest)
Describes a specific delete inventory operation.
|
default DescribeInventoryDeletionsIterable |
describeInventoryDeletionsPaginator()
Describes a specific delete inventory operation.
|
default DescribeInventoryDeletionsIterable |
describeInventoryDeletionsPaginator(Consumer<DescribeInventoryDeletionsRequest.Builder> describeInventoryDeletionsRequest)
Describes a specific delete inventory operation.
|
default DescribeInventoryDeletionsIterable |
describeInventoryDeletionsPaginator(DescribeInventoryDeletionsRequest describeInventoryDeletionsRequest)
Describes a specific delete inventory operation.
|
default DescribeMaintenanceWindowExecutionsResponse |
describeMaintenanceWindowExecutions(Consumer<DescribeMaintenanceWindowExecutionsRequest.Builder> describeMaintenanceWindowExecutionsRequest)
Lists the executions of a maintenance window.
|
default DescribeMaintenanceWindowExecutionsResponse |
describeMaintenanceWindowExecutions(DescribeMaintenanceWindowExecutionsRequest describeMaintenanceWindowExecutionsRequest)
Lists the executions of a maintenance window.
|
default DescribeMaintenanceWindowExecutionsIterable |
describeMaintenanceWindowExecutionsPaginator(Consumer<DescribeMaintenanceWindowExecutionsRequest.Builder> describeMaintenanceWindowExecutionsRequest)
Lists the executions of a maintenance window.
|
default DescribeMaintenanceWindowExecutionsIterable |
describeMaintenanceWindowExecutionsPaginator(DescribeMaintenanceWindowExecutionsRequest describeMaintenanceWindowExecutionsRequest)
Lists the executions of a maintenance window.
|
default DescribeMaintenanceWindowExecutionTaskInvocationsResponse |
describeMaintenanceWindowExecutionTaskInvocations(Consumer<DescribeMaintenanceWindowExecutionTaskInvocationsRequest.Builder> describeMaintenanceWindowExecutionTaskInvocationsRequest)
Retrieves the individual task executions (one per target) for a particular task run as part of a maintenance
window execution.
|
default DescribeMaintenanceWindowExecutionTaskInvocationsResponse |
describeMaintenanceWindowExecutionTaskInvocations(DescribeMaintenanceWindowExecutionTaskInvocationsRequest describeMaintenanceWindowExecutionTaskInvocationsRequest)
Retrieves the individual task executions (one per target) for a particular task run as part of a maintenance
window execution.
|
default DescribeMaintenanceWindowExecutionTaskInvocationsIterable |
describeMaintenanceWindowExecutionTaskInvocationsPaginator(Consumer<DescribeMaintenanceWindowExecutionTaskInvocationsRequest.Builder> describeMaintenanceWindowExecutionTaskInvocationsRequest)
Retrieves the individual task executions (one per target) for a particular task run as part of a maintenance
window execution.
|
default DescribeMaintenanceWindowExecutionTaskInvocationsIterable |
describeMaintenanceWindowExecutionTaskInvocationsPaginator(DescribeMaintenanceWindowExecutionTaskInvocationsRequest describeMaintenanceWindowExecutionTaskInvocationsRequest)
Retrieves the individual task executions (one per target) for a particular task run as part of a maintenance
window execution.
|
default DescribeMaintenanceWindowExecutionTasksResponse |
describeMaintenanceWindowExecutionTasks(Consumer<DescribeMaintenanceWindowExecutionTasksRequest.Builder> describeMaintenanceWindowExecutionTasksRequest)
For a given maintenance window execution, lists the tasks that were run.
|
default DescribeMaintenanceWindowExecutionTasksResponse |
describeMaintenanceWindowExecutionTasks(DescribeMaintenanceWindowExecutionTasksRequest describeMaintenanceWindowExecutionTasksRequest)
For a given maintenance window execution, lists the tasks that were run.
|
default DescribeMaintenanceWindowExecutionTasksIterable |
describeMaintenanceWindowExecutionTasksPaginator(Consumer<DescribeMaintenanceWindowExecutionTasksRequest.Builder> describeMaintenanceWindowExecutionTasksRequest)
For a given maintenance window execution, lists the tasks that were run.
|
default DescribeMaintenanceWindowExecutionTasksIterable |
describeMaintenanceWindowExecutionTasksPaginator(DescribeMaintenanceWindowExecutionTasksRequest describeMaintenanceWindowExecutionTasksRequest)
For a given maintenance window execution, lists the tasks that were run.
|
default DescribeMaintenanceWindowsResponse |
describeMaintenanceWindows()
Retrieves the maintenance windows in an AWS account.
|
default DescribeMaintenanceWindowsResponse |
describeMaintenanceWindows(Consumer<DescribeMaintenanceWindowsRequest.Builder> describeMaintenanceWindowsRequest)
Retrieves the maintenance windows in an AWS account.
|
default DescribeMaintenanceWindowsResponse |
describeMaintenanceWindows(DescribeMaintenanceWindowsRequest describeMaintenanceWindowsRequest)
Retrieves the maintenance windows in an AWS account.
|
default DescribeMaintenanceWindowScheduleResponse |
describeMaintenanceWindowSchedule(Consumer<DescribeMaintenanceWindowScheduleRequest.Builder> describeMaintenanceWindowScheduleRequest)
Retrieves information about upcoming executions of a maintenance window.
|
default DescribeMaintenanceWindowScheduleResponse |
describeMaintenanceWindowSchedule(DescribeMaintenanceWindowScheduleRequest describeMaintenanceWindowScheduleRequest)
Retrieves information about upcoming executions of a maintenance window.
|
default DescribeMaintenanceWindowScheduleIterable |
describeMaintenanceWindowSchedulePaginator(Consumer<DescribeMaintenanceWindowScheduleRequest.Builder> describeMaintenanceWindowScheduleRequest)
Retrieves information about upcoming executions of a maintenance window.
|
default DescribeMaintenanceWindowScheduleIterable |
describeMaintenanceWindowSchedulePaginator(DescribeMaintenanceWindowScheduleRequest describeMaintenanceWindowScheduleRequest)
Retrieves information about upcoming executions of a maintenance window.
|
default DescribeMaintenanceWindowsForTargetResponse |
describeMaintenanceWindowsForTarget(Consumer<DescribeMaintenanceWindowsForTargetRequest.Builder> describeMaintenanceWindowsForTargetRequest)
Retrieves information about the maintenance window targets or tasks that an instance is associated with.
|
default DescribeMaintenanceWindowsForTargetResponse |
describeMaintenanceWindowsForTarget(DescribeMaintenanceWindowsForTargetRequest describeMaintenanceWindowsForTargetRequest)
Retrieves information about the maintenance window targets or tasks that an instance is associated with.
|
default DescribeMaintenanceWindowsForTargetIterable |
describeMaintenanceWindowsForTargetPaginator(Consumer<DescribeMaintenanceWindowsForTargetRequest.Builder> describeMaintenanceWindowsForTargetRequest)
Retrieves information about the maintenance window targets or tasks that an instance is associated with.
|
default DescribeMaintenanceWindowsForTargetIterable |
describeMaintenanceWindowsForTargetPaginator(DescribeMaintenanceWindowsForTargetRequest describeMaintenanceWindowsForTargetRequest)
Retrieves information about the maintenance window targets or tasks that an instance is associated with.
|
default DescribeMaintenanceWindowsIterable |
describeMaintenanceWindowsPaginator()
Retrieves the maintenance windows in an AWS account.
|
default DescribeMaintenanceWindowsIterable |
describeMaintenanceWindowsPaginator(Consumer<DescribeMaintenanceWindowsRequest.Builder> describeMaintenanceWindowsRequest)
Retrieves the maintenance windows in an AWS account.
|
default DescribeMaintenanceWindowsIterable |
describeMaintenanceWindowsPaginator(DescribeMaintenanceWindowsRequest describeMaintenanceWindowsRequest)
Retrieves the maintenance windows in an AWS account.
|
default DescribeMaintenanceWindowTargetsResponse |
describeMaintenanceWindowTargets(Consumer<DescribeMaintenanceWindowTargetsRequest.Builder> describeMaintenanceWindowTargetsRequest)
Lists the targets registered with the maintenance window.
|
default DescribeMaintenanceWindowTargetsResponse |
describeMaintenanceWindowTargets(DescribeMaintenanceWindowTargetsRequest describeMaintenanceWindowTargetsRequest)
Lists the targets registered with the maintenance window.
|
default DescribeMaintenanceWindowTargetsIterable |
describeMaintenanceWindowTargetsPaginator(Consumer<DescribeMaintenanceWindowTargetsRequest.Builder> describeMaintenanceWindowTargetsRequest)
Lists the targets registered with the maintenance window.
|
default DescribeMaintenanceWindowTargetsIterable |
describeMaintenanceWindowTargetsPaginator(DescribeMaintenanceWindowTargetsRequest describeMaintenanceWindowTargetsRequest)
Lists the targets registered with the maintenance window.
|
default DescribeMaintenanceWindowTasksResponse |
describeMaintenanceWindowTasks(Consumer<DescribeMaintenanceWindowTasksRequest.Builder> describeMaintenanceWindowTasksRequest)
Lists the tasks in a maintenance window.
|
default DescribeMaintenanceWindowTasksResponse |
describeMaintenanceWindowTasks(DescribeMaintenanceWindowTasksRequest describeMaintenanceWindowTasksRequest)
Lists the tasks in a maintenance window.
|
default DescribeMaintenanceWindowTasksIterable |
describeMaintenanceWindowTasksPaginator(Consumer<DescribeMaintenanceWindowTasksRequest.Builder> describeMaintenanceWindowTasksRequest)
Lists the tasks in a maintenance window.
|
default DescribeMaintenanceWindowTasksIterable |
describeMaintenanceWindowTasksPaginator(DescribeMaintenanceWindowTasksRequest describeMaintenanceWindowTasksRequest)
Lists the tasks in a maintenance window.
|
default DescribeOpsItemsResponse |
describeOpsItems(Consumer<DescribeOpsItemsRequest.Builder> describeOpsItemsRequest)
Query a set of OpsItems.
|
default DescribeOpsItemsResponse |
describeOpsItems(DescribeOpsItemsRequest describeOpsItemsRequest)
Query a set of OpsItems.
|
default DescribeOpsItemsIterable |
describeOpsItemsPaginator(Consumer<DescribeOpsItemsRequest.Builder> describeOpsItemsRequest)
Query a set of OpsItems.
|
default DescribeOpsItemsIterable |
describeOpsItemsPaginator(DescribeOpsItemsRequest describeOpsItemsRequest)
Query a set of OpsItems.
|
default DescribeParametersResponse |
describeParameters()
Get information about a parameter.
|
default DescribeParametersResponse |
describeParameters(Consumer<DescribeParametersRequest.Builder> describeParametersRequest)
Get information about a parameter.
|
default DescribeParametersResponse |
describeParameters(DescribeParametersRequest describeParametersRequest)
Get information about a parameter.
|
default DescribeParametersIterable |
describeParametersPaginator()
Get information about a parameter.
|
default DescribeParametersIterable |
describeParametersPaginator(Consumer<DescribeParametersRequest.Builder> describeParametersRequest)
Get information about a parameter.
|
default DescribeParametersIterable |
describeParametersPaginator(DescribeParametersRequest describeParametersRequest)
Get information about a parameter.
|
default DescribePatchBaselinesResponse |
describePatchBaselines()
Lists the patch baselines in your AWS account.
|
default DescribePatchBaselinesResponse |
describePatchBaselines(Consumer<DescribePatchBaselinesRequest.Builder> describePatchBaselinesRequest)
Lists the patch baselines in your AWS account.
|
default DescribePatchBaselinesResponse |
describePatchBaselines(DescribePatchBaselinesRequest describePatchBaselinesRequest)
Lists the patch baselines in your AWS account.
|
default DescribePatchBaselinesIterable |
describePatchBaselinesPaginator()
Lists the patch baselines in your AWS account.
|
default DescribePatchBaselinesIterable |
describePatchBaselinesPaginator(Consumer<DescribePatchBaselinesRequest.Builder> describePatchBaselinesRequest)
Lists the patch baselines in your AWS account.
|
default DescribePatchBaselinesIterable |
describePatchBaselinesPaginator(DescribePatchBaselinesRequest describePatchBaselinesRequest)
Lists the patch baselines in your AWS account.
|
default DescribePatchGroupsResponse |
describePatchGroups()
Lists all patch groups that have been registered with patch baselines.
|
default DescribePatchGroupsResponse |
describePatchGroups(Consumer<DescribePatchGroupsRequest.Builder> describePatchGroupsRequest)
Lists all patch groups that have been registered with patch baselines.
|
default DescribePatchGroupsResponse |
describePatchGroups(DescribePatchGroupsRequest describePatchGroupsRequest)
Lists all patch groups that have been registered with patch baselines.
|
default DescribePatchGroupsIterable |
describePatchGroupsPaginator()
Lists all patch groups that have been registered with patch baselines.
|
default DescribePatchGroupsIterable |
describePatchGroupsPaginator(Consumer<DescribePatchGroupsRequest.Builder> describePatchGroupsRequest)
Lists all patch groups that have been registered with patch baselines.
|
default DescribePatchGroupsIterable |
describePatchGroupsPaginator(DescribePatchGroupsRequest describePatchGroupsRequest)
Lists all patch groups that have been registered with patch baselines.
|
default DescribePatchGroupStateResponse |
describePatchGroupState(Consumer<DescribePatchGroupStateRequest.Builder> describePatchGroupStateRequest)
Returns high-level aggregated patch compliance state for a patch group.
|
default DescribePatchGroupStateResponse |
describePatchGroupState(DescribePatchGroupStateRequest describePatchGroupStateRequest)
Returns high-level aggregated patch compliance state for a patch group.
|
default DescribePatchPropertiesResponse |
describePatchProperties(Consumer<DescribePatchPropertiesRequest.Builder> describePatchPropertiesRequest)
Lists the properties of available patches organized by product, product family, classification, severity, and
other properties of available patches.
|
default DescribePatchPropertiesResponse |
describePatchProperties(DescribePatchPropertiesRequest describePatchPropertiesRequest)
Lists the properties of available patches organized by product, product family, classification, severity, and
other properties of available patches.
|
default DescribePatchPropertiesIterable |
describePatchPropertiesPaginator(Consumer<DescribePatchPropertiesRequest.Builder> describePatchPropertiesRequest)
Lists the properties of available patches organized by product, product family, classification, severity, and
other properties of available patches.
|
default DescribePatchPropertiesIterable |
describePatchPropertiesPaginator(DescribePatchPropertiesRequest describePatchPropertiesRequest)
Lists the properties of available patches organized by product, product family, classification, severity, and
other properties of available patches.
|
default DescribeSessionsResponse |
describeSessions(Consumer<DescribeSessionsRequest.Builder> describeSessionsRequest)
Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30
days.
|
default DescribeSessionsResponse |
describeSessions(DescribeSessionsRequest describeSessionsRequest)
Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30
days.
|
default DescribeSessionsIterable |
describeSessionsPaginator(Consumer<DescribeSessionsRequest.Builder> describeSessionsRequest)
Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30
days.
|
default DescribeSessionsIterable |
describeSessionsPaginator(DescribeSessionsRequest describeSessionsRequest)
Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30
days.
|
default GetAutomationExecutionResponse |
getAutomationExecution(Consumer<GetAutomationExecutionRequest.Builder> getAutomationExecutionRequest)
Get detailed information about a particular Automation execution.
|
default GetAutomationExecutionResponse |
getAutomationExecution(GetAutomationExecutionRequest getAutomationExecutionRequest)
Get detailed information about a particular Automation execution.
|
default GetCalendarStateResponse |
getCalendarState(Consumer<GetCalendarStateRequest.Builder> getCalendarStateRequest)
Gets the state of the AWS Systems Manager Change Calendar at an optional, specified time.
|
default GetCalendarStateResponse |
getCalendarState(GetCalendarStateRequest getCalendarStateRequest)
Gets the state of the AWS Systems Manager Change Calendar at an optional, specified time.
|
default GetCommandInvocationResponse |
getCommandInvocation(Consumer<GetCommandInvocationRequest.Builder> getCommandInvocationRequest)
Returns detailed information about command execution for an invocation or plugin.
|
default GetCommandInvocationResponse |
getCommandInvocation(GetCommandInvocationRequest getCommandInvocationRequest)
Returns detailed information about command execution for an invocation or plugin.
|
default GetConnectionStatusResponse |
getConnectionStatus(Consumer<GetConnectionStatusRequest.Builder> getConnectionStatusRequest)
Retrieves the Session Manager connection status for an instance to determine whether it is running and ready to
receive Session Manager connections.
|
default GetConnectionStatusResponse |
getConnectionStatus(GetConnectionStatusRequest getConnectionStatusRequest)
Retrieves the Session Manager connection status for an instance to determine whether it is running and ready to
receive Session Manager connections.
|
default GetDefaultPatchBaselineResponse |
getDefaultPatchBaseline()
Retrieves the default patch baseline.
|
default GetDefaultPatchBaselineResponse |
getDefaultPatchBaseline(Consumer<GetDefaultPatchBaselineRequest.Builder> getDefaultPatchBaselineRequest)
Retrieves the default patch baseline.
|
default GetDefaultPatchBaselineResponse |
getDefaultPatchBaseline(GetDefaultPatchBaselineRequest getDefaultPatchBaselineRequest)
Retrieves the default patch baseline.
|
default GetDeployablePatchSnapshotForInstanceResponse |
getDeployablePatchSnapshotForInstance(Consumer<GetDeployablePatchSnapshotForInstanceRequest.Builder> getDeployablePatchSnapshotForInstanceRequest)
Retrieves the current snapshot for the patch baseline the instance uses.
|
default GetDeployablePatchSnapshotForInstanceResponse |
getDeployablePatchSnapshotForInstance(GetDeployablePatchSnapshotForInstanceRequest getDeployablePatchSnapshotForInstanceRequest)
Retrieves the current snapshot for the patch baseline the instance uses.
|
default GetDocumentResponse |
getDocument(Consumer<GetDocumentRequest.Builder> getDocumentRequest)
Gets the contents of the specified Systems Manager document.
|
default GetDocumentResponse |
getDocument(GetDocumentRequest getDocumentRequest)
Gets the contents of the specified Systems Manager document.
|
default GetInventoryResponse |
getInventory()
Query inventory information.
|
default GetInventoryResponse |
getInventory(Consumer<GetInventoryRequest.Builder> getInventoryRequest)
Query inventory information.
|
default GetInventoryResponse |
getInventory(GetInventoryRequest getInventoryRequest)
Query inventory information.
|
default GetInventoryIterable |
getInventoryPaginator()
Query inventory information.
|
default GetInventoryIterable |
getInventoryPaginator(Consumer<GetInventoryRequest.Builder> getInventoryRequest)
Query inventory information.
|
default GetInventoryIterable |
getInventoryPaginator(GetInventoryRequest getInventoryRequest)
Query inventory information.
|
default GetInventorySchemaResponse |
getInventorySchema()
Return a list of inventory type names for the account, or return a list of attribute names for a specific
Inventory item type.
|
default GetInventorySchemaResponse |
getInventorySchema(Consumer<GetInventorySchemaRequest.Builder> 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 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 GetInventorySchemaIterable |
getInventorySchemaPaginator()
Return a list of inventory type names for the account, or return a list of attribute names for a specific
Inventory item type.
|
default GetInventorySchemaIterable |
getInventorySchemaPaginator(Consumer<GetInventorySchemaRequest.Builder> 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 GetInventorySchemaIterable |
getInventorySchemaPaginator(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(Consumer<GetMaintenanceWindowRequest.Builder> getMaintenanceWindowRequest)
Retrieves a maintenance window.
|
default GetMaintenanceWindowResponse |
getMaintenanceWindow(GetMaintenanceWindowRequest getMaintenanceWindowRequest)
Retrieves a maintenance window.
|
default GetMaintenanceWindowExecutionResponse |
getMaintenanceWindowExecution(Consumer<GetMaintenanceWindowExecutionRequest.Builder> getMaintenanceWindowExecutionRequest)
Retrieves details about a specific a maintenance window execution.
|
default GetMaintenanceWindowExecutionResponse |
getMaintenanceWindowExecution(GetMaintenanceWindowExecutionRequest getMaintenanceWindowExecutionRequest)
Retrieves details about a specific a maintenance window execution.
|
default GetMaintenanceWindowExecutionTaskResponse |
getMaintenanceWindowExecutionTask(Consumer<GetMaintenanceWindowExecutionTaskRequest.Builder> getMaintenanceWindowExecutionTaskRequest)
Retrieves the details about a specific task run as part of a maintenance window execution.
|
default GetMaintenanceWindowExecutionTaskResponse |
getMaintenanceWindowExecutionTask(GetMaintenanceWindowExecutionTaskRequest getMaintenanceWindowExecutionTaskRequest)
Retrieves the details about a specific task run as part of a maintenance window execution.
|
default GetMaintenanceWindowExecutionTaskInvocationResponse |
getMaintenanceWindowExecutionTaskInvocation(Consumer<GetMaintenanceWindowExecutionTaskInvocationRequest.Builder> getMaintenanceWindowExecutionTaskInvocationRequest)
Retrieves information about a specific task running on a specific target.
|
default GetMaintenanceWindowExecutionTaskInvocationResponse |
getMaintenanceWindowExecutionTaskInvocation(GetMaintenanceWindowExecutionTaskInvocationRequest getMaintenanceWindowExecutionTaskInvocationRequest)
Retrieves information about a specific task running on a specific target.
|
default GetMaintenanceWindowTaskResponse |
getMaintenanceWindowTask(Consumer<GetMaintenanceWindowTaskRequest.Builder> getMaintenanceWindowTaskRequest)
Lists the tasks in a maintenance window.
|
default GetMaintenanceWindowTaskResponse |
getMaintenanceWindowTask(GetMaintenanceWindowTaskRequest getMaintenanceWindowTaskRequest)
Lists the tasks in a maintenance window.
|
default GetOpsItemResponse |
getOpsItem(Consumer<GetOpsItemRequest.Builder> getOpsItemRequest)
Get information about an OpsItem by using the ID.
|
default GetOpsItemResponse |
getOpsItem(GetOpsItemRequest getOpsItemRequest)
Get information about an OpsItem by using the ID.
|
default GetOpsMetadataResponse |
getOpsMetadata(Consumer<GetOpsMetadataRequest.Builder> getOpsMetadataRequest)
View operational metadata related to an application in Application Manager.
|
default GetOpsMetadataResponse |
getOpsMetadata(GetOpsMetadataRequest getOpsMetadataRequest)
View operational metadata related to an application in Application Manager.
|
default GetOpsSummaryResponse |
getOpsSummary(Consumer<GetOpsSummaryRequest.Builder> getOpsSummaryRequest)
View a summary of OpsItems based on specified filters and aggregators.
|
default GetOpsSummaryResponse |
getOpsSummary(GetOpsSummaryRequest getOpsSummaryRequest)
View a summary of OpsItems based on specified filters and aggregators.
|
default GetOpsSummaryIterable |
getOpsSummaryPaginator(Consumer<GetOpsSummaryRequest.Builder> getOpsSummaryRequest)
View a summary of OpsItems based on specified filters and aggregators.
|
default GetOpsSummaryIterable |
getOpsSummaryPaginator(GetOpsSummaryRequest getOpsSummaryRequest)
View a summary of OpsItems based on specified filters and aggregators.
|
default GetParameterResponse |
getParameter(Consumer<GetParameterRequest.Builder> getParameterRequest)
Get information about a parameter by using the parameter name.
|
default GetParameterResponse |
getParameter(GetParameterRequest getParameterRequest)
Get information about a parameter by using the parameter name.
|
default GetParameterHistoryResponse |
getParameterHistory(Consumer<GetParameterHistoryRequest.Builder> getParameterHistoryRequest)
Retrieves the history of all changes to a parameter.
|
default GetParameterHistoryResponse |
getParameterHistory(GetParameterHistoryRequest getParameterHistoryRequest)
Retrieves the history of all changes to a parameter.
|
default GetParameterHistoryIterable |
getParameterHistoryPaginator(Consumer<GetParameterHistoryRequest.Builder> getParameterHistoryRequest)
Retrieves the history of all changes to a parameter.
|
default GetParameterHistoryIterable |
getParameterHistoryPaginator(GetParameterHistoryRequest getParameterHistoryRequest)
Retrieves the history of all changes to a parameter.
|
default GetParametersResponse |
getParameters(Consumer<GetParametersRequest.Builder> getParametersRequest)
Get details of a parameter.
|
default GetParametersResponse |
getParameters(GetParametersRequest getParametersRequest)
Get details of a parameter.
|
default GetParametersByPathResponse |
getParametersByPath(Consumer<GetParametersByPathRequest.Builder> getParametersByPathRequest)
Retrieve information about one or more parameters in a specific hierarchy.
|
default GetParametersByPathResponse |
getParametersByPath(GetParametersByPathRequest getParametersByPathRequest)
Retrieve information about one or more parameters in a specific hierarchy.
|
default GetParametersByPathIterable |
getParametersByPathPaginator(Consumer<GetParametersByPathRequest.Builder> getParametersByPathRequest)
Retrieve information about one or more parameters in a specific hierarchy.
|
default GetParametersByPathIterable |
getParametersByPathPaginator(GetParametersByPathRequest getParametersByPathRequest)
Retrieve information about one or more parameters in a specific hierarchy.
|
default GetPatchBaselineResponse |
getPatchBaseline(Consumer<GetPatchBaselineRequest.Builder> getPatchBaselineRequest)
Retrieves information about a patch baseline.
|
default GetPatchBaselineResponse |
getPatchBaseline(GetPatchBaselineRequest getPatchBaselineRequest)
Retrieves information about a patch baseline.
|
default GetPatchBaselineForPatchGroupResponse |
getPatchBaselineForPatchGroup(Consumer<GetPatchBaselineForPatchGroupRequest.Builder> getPatchBaselineForPatchGroupRequest)
Retrieves the patch baseline that should be used for the specified patch group.
|
default GetPatchBaselineForPatchGroupResponse |
getPatchBaselineForPatchGroup(GetPatchBaselineForPatchGroupRequest getPatchBaselineForPatchGroupRequest)
Retrieves the patch baseline that should be used for the specified patch group.
|
default GetServiceSettingResponse |
getServiceSetting(Consumer<GetServiceSettingRequest.Builder> getServiceSettingRequest)
ServiceSetting is an account-level setting for an AWS service. |
default GetServiceSettingResponse |
getServiceSetting(GetServiceSettingRequest getServiceSettingRequest)
ServiceSetting is an account-level setting for an AWS service. |
default LabelParameterVersionResponse |
labelParameterVersion(Consumer<LabelParameterVersionRequest.Builder> labelParameterVersionRequest)
A parameter label is a user-defined alias to help you manage different versions of a parameter.
|
default LabelParameterVersionResponse |
labelParameterVersion(LabelParameterVersionRequest labelParameterVersionRequest)
A parameter label is a user-defined alias to help you manage different versions of a parameter.
|
default ListAssociationsResponse |
listAssociations()
Returns all State Manager associations in the current AWS account and Region.
|
default ListAssociationsResponse |
listAssociations(Consumer<ListAssociationsRequest.Builder> listAssociationsRequest)
Returns all State Manager associations in the current AWS account and Region.
|
default ListAssociationsResponse |
listAssociations(ListAssociationsRequest listAssociationsRequest)
Returns all State Manager associations in the current AWS account and Region.
|
default ListAssociationsIterable |
listAssociationsPaginator()
Returns all State Manager associations in the current AWS account and Region.
|
default ListAssociationsIterable |
listAssociationsPaginator(Consumer<ListAssociationsRequest.Builder> listAssociationsRequest)
Returns all State Manager associations in the current AWS account and Region.
|
default ListAssociationsIterable |
listAssociationsPaginator(ListAssociationsRequest listAssociationsRequest)
Returns all State Manager associations in the current AWS account and Region.
|
default ListAssociationVersionsResponse |
listAssociationVersions(Consumer<ListAssociationVersionsRequest.Builder> listAssociationVersionsRequest)
Retrieves all versions of an association for a specific association ID.
|
default ListAssociationVersionsResponse |
listAssociationVersions(ListAssociationVersionsRequest listAssociationVersionsRequest)
Retrieves all versions of an association for a specific association ID.
|
default ListAssociationVersionsIterable |
listAssociationVersionsPaginator(Consumer<ListAssociationVersionsRequest.Builder> listAssociationVersionsRequest)
Retrieves all versions of an association for a specific association ID.
|
default ListAssociationVersionsIterable |
listAssociationVersionsPaginator(ListAssociationVersionsRequest listAssociationVersionsRequest)
Retrieves all versions of an association for a specific association ID.
|
default ListCommandInvocationsResponse |
listCommandInvocations()
An invocation is copy of a command sent to a specific instance.
|
default ListCommandInvocationsResponse |
listCommandInvocations(Consumer<ListCommandInvocationsRequest.Builder> listCommandInvocationsRequest)
An invocation is copy of a command sent to a specific instance.
|
default ListCommandInvocationsResponse |
listCommandInvocations(ListCommandInvocationsRequest listCommandInvocationsRequest)
An invocation is copy of a command sent to a specific instance.
|
default ListCommandInvocationsIterable |
listCommandInvocationsPaginator()
An invocation is copy of a command sent to a specific instance.
|
default ListCommandInvocationsIterable |
listCommandInvocationsPaginator(Consumer<ListCommandInvocationsRequest.Builder> listCommandInvocationsRequest)
An invocation is copy of a command sent to a specific instance.
|
default ListCommandInvocationsIterable |
listCommandInvocationsPaginator(ListCommandInvocationsRequest listCommandInvocationsRequest)
An invocation is copy of a command sent to a specific instance.
|
default ListCommandsResponse |
listCommands()
Lists the commands requested by users of the AWS account.
|
default ListCommandsResponse |
listCommands(Consumer<ListCommandsRequest.Builder> listCommandsRequest)
Lists the commands requested by users of the AWS account.
|
default ListCommandsResponse |
listCommands(ListCommandsRequest listCommandsRequest)
Lists the commands requested by users of the AWS account.
|
default ListCommandsIterable |
listCommandsPaginator()
Lists the commands requested by users of the AWS account.
|
default ListCommandsIterable |
listCommandsPaginator(Consumer<ListCommandsRequest.Builder> listCommandsRequest)
Lists the commands requested by users of the AWS account.
|
default ListCommandsIterable |
listCommandsPaginator(ListCommandsRequest listCommandsRequest)
Lists the commands requested by users of the AWS account.
|
default ListComplianceItemsResponse |
listComplianceItems(Consumer<ListComplianceItemsRequest.Builder> listComplianceItemsRequest)
For a specified resource ID, this API action returns a list of compliance statuses for different resource types.
|
default ListComplianceItemsResponse |
listComplianceItems(ListComplianceItemsRequest listComplianceItemsRequest)
For a specified resource ID, this API action returns a list of compliance statuses for different resource types.
|
default ListComplianceItemsIterable |
listComplianceItemsPaginator(Consumer<ListComplianceItemsRequest.Builder> listComplianceItemsRequest)
For a specified resource ID, this API action returns a list of compliance statuses for different resource types.
|
default ListComplianceItemsIterable |
listComplianceItemsPaginator(ListComplianceItemsRequest listComplianceItemsRequest)
For a specified resource ID, this API action returns a list of compliance statuses for different resource types.
|
default ListComplianceSummariesResponse |
listComplianceSummaries()
Returns a summary count of compliant and non-compliant resources for a compliance type.
|
default ListComplianceSummariesResponse |
listComplianceSummaries(Consumer<ListComplianceSummariesRequest.Builder> listComplianceSummariesRequest)
Returns a summary count of compliant and non-compliant resources for a compliance type.
|
default ListComplianceSummariesResponse |
listComplianceSummaries(ListComplianceSummariesRequest listComplianceSummariesRequest)
Returns a summary count of compliant and non-compliant resources for a compliance type.
|
default ListComplianceSummariesIterable |
listComplianceSummariesPaginator()
Returns a summary count of compliant and non-compliant resources for a compliance type.
|
default ListComplianceSummariesIterable |
listComplianceSummariesPaginator(Consumer<ListComplianceSummariesRequest.Builder> listComplianceSummariesRequest)
Returns a summary count of compliant and non-compliant resources for a compliance type.
|
default ListComplianceSummariesIterable |
listComplianceSummariesPaginator(ListComplianceSummariesRequest listComplianceSummariesRequest)
Returns a summary count of compliant and non-compliant resources for a compliance type.
|
default ListDocumentMetadataHistoryResponse |
listDocumentMetadataHistory(Consumer<ListDocumentMetadataHistoryRequest.Builder> listDocumentMetadataHistoryRequest)
Information about approval reviews for a version of an SSM document.
|
default ListDocumentMetadataHistoryResponse |
listDocumentMetadataHistory(ListDocumentMetadataHistoryRequest listDocumentMetadataHistoryRequest)
Information about approval reviews for a version of an SSM document.
|
default ListDocumentsResponse |
listDocuments()
Returns all Systems Manager (SSM) documents in the current AWS account and Region.
|
default ListDocumentsResponse |
listDocuments(Consumer<ListDocumentsRequest.Builder> listDocumentsRequest)
Returns all Systems Manager (SSM) documents in the current AWS account and Region.
|
default ListDocumentsResponse |
listDocuments(ListDocumentsRequest listDocumentsRequest)
Returns all Systems Manager (SSM) documents in the current AWS account and Region.
|
default ListDocumentsIterable |
listDocumentsPaginator()
Returns all Systems Manager (SSM) documents in the current AWS account and Region.
|
default ListDocumentsIterable |
listDocumentsPaginator(Consumer<ListDocumentsRequest.Builder> listDocumentsRequest)
Returns all Systems Manager (SSM) documents in the current AWS account and Region.
|
default ListDocumentsIterable |
listDocumentsPaginator(ListDocumentsRequest listDocumentsRequest)
Returns all Systems Manager (SSM) documents in the current AWS account and Region.
|
default ListDocumentVersionsResponse |
listDocumentVersions(Consumer<ListDocumentVersionsRequest.Builder> listDocumentVersionsRequest)
List all versions for a document.
|
default ListDocumentVersionsResponse |
listDocumentVersions(ListDocumentVersionsRequest listDocumentVersionsRequest)
List all versions for a document.
|
default ListDocumentVersionsIterable |
listDocumentVersionsPaginator(Consumer<ListDocumentVersionsRequest.Builder> listDocumentVersionsRequest)
List all versions for a document.
|
default ListDocumentVersionsIterable |
listDocumentVersionsPaginator(ListDocumentVersionsRequest listDocumentVersionsRequest)
List all versions for a document.
|
default ListInventoryEntriesResponse |
listInventoryEntries(Consumer<ListInventoryEntriesRequest.Builder> listInventoryEntriesRequest)
A list of inventory items returned by the request.
|
default ListInventoryEntriesResponse |
listInventoryEntries(ListInventoryEntriesRequest listInventoryEntriesRequest)
A list of inventory items returned by the request.
|
default ListOpsItemEventsResponse |
listOpsItemEvents(Consumer<ListOpsItemEventsRequest.Builder> listOpsItemEventsRequest)
Returns a list of all OpsItem events in the current AWS account and Region.
|
default ListOpsItemEventsResponse |
listOpsItemEvents(ListOpsItemEventsRequest listOpsItemEventsRequest)
Returns a list of all OpsItem events in the current AWS account and Region.
|
default ListOpsItemEventsIterable |
listOpsItemEventsPaginator(Consumer<ListOpsItemEventsRequest.Builder> listOpsItemEventsRequest)
Returns a list of all OpsItem events in the current AWS account and Region.
|
default ListOpsItemEventsIterable |
listOpsItemEventsPaginator(ListOpsItemEventsRequest listOpsItemEventsRequest)
Returns a list of all OpsItem events in the current AWS account and Region.
|
default ListOpsMetadataResponse |
listOpsMetadata(Consumer<ListOpsMetadataRequest.Builder> listOpsMetadataRequest)
Systems Manager calls this API action when displaying all Application Manager OpsMetadata objects or blobs.
|
default ListOpsMetadataResponse |
listOpsMetadata(ListOpsMetadataRequest listOpsMetadataRequest)
Systems Manager calls this API action when displaying all Application Manager OpsMetadata objects or blobs.
|
default ListOpsMetadataIterable |
listOpsMetadataPaginator(Consumer<ListOpsMetadataRequest.Builder> listOpsMetadataRequest)
Systems Manager calls this API action when displaying all Application Manager OpsMetadata objects or blobs.
|
default ListOpsMetadataIterable |
listOpsMetadataPaginator(ListOpsMetadataRequest listOpsMetadataRequest)
Systems Manager calls this API action when displaying all Application Manager OpsMetadata objects or blobs.
|
default ListResourceComplianceSummariesResponse |
listResourceComplianceSummaries()
Returns a resource-level summary count.
|
default ListResourceComplianceSummariesResponse |
listResourceComplianceSummaries(Consumer<ListResourceComplianceSummariesRequest.Builder> listResourceComplianceSummariesRequest)
Returns a resource-level summary count.
|
default ListResourceComplianceSummariesResponse |
listResourceComplianceSummaries(ListResourceComplianceSummariesRequest listResourceComplianceSummariesRequest)
Returns a resource-level summary count.
|
default ListResourceComplianceSummariesIterable |
listResourceComplianceSummariesPaginator()
Returns a resource-level summary count.
|
default ListResourceComplianceSummariesIterable |
listResourceComplianceSummariesPaginator(Consumer<ListResourceComplianceSummariesRequest.Builder> listResourceComplianceSummariesRequest)
Returns a resource-level summary count.
|
default ListResourceComplianceSummariesIterable |
listResourceComplianceSummariesPaginator(ListResourceComplianceSummariesRequest listResourceComplianceSummariesRequest)
Returns a resource-level summary count.
|
default ListResourceDataSyncResponse |
listResourceDataSync()
Lists your resource data sync configurations.
|
default ListResourceDataSyncResponse |
listResourceDataSync(Consumer<ListResourceDataSyncRequest.Builder> listResourceDataSyncRequest)
Lists your resource data sync configurations.
|
default ListResourceDataSyncResponse |
listResourceDataSync(ListResourceDataSyncRequest listResourceDataSyncRequest)
Lists your resource data sync configurations.
|
default ListResourceDataSyncIterable |
listResourceDataSyncPaginator()
Lists your resource data sync configurations.
|
default ListResourceDataSyncIterable |
listResourceDataSyncPaginator(Consumer<ListResourceDataSyncRequest.Builder> listResourceDataSyncRequest)
Lists your resource data sync configurations.
|
default ListResourceDataSyncIterable |
listResourceDataSyncPaginator(ListResourceDataSyncRequest listResourceDataSyncRequest)
Lists your resource data sync configurations.
|
default ListTagsForResourceResponse |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Returns a list of the tags assigned to the specified resource.
|
default ListTagsForResourceResponse |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Returns a list of the tags assigned to the specified resource.
|
default ModifyDocumentPermissionResponse |
modifyDocumentPermission(Consumer<ModifyDocumentPermissionRequest.Builder> modifyDocumentPermissionRequest)
Shares a Systems Manager document publicly or privately.
|
default ModifyDocumentPermissionResponse |
modifyDocumentPermission(ModifyDocumentPermissionRequest modifyDocumentPermissionRequest)
Shares a Systems Manager document publicly or privately.
|
default PutComplianceItemsResponse |
putComplianceItems(Consumer<PutComplianceItemsRequest.Builder> putComplianceItemsRequest)
Registers a compliance type and other compliance details on a designated resource.
|
default PutComplianceItemsResponse |
putComplianceItems(PutComplianceItemsRequest putComplianceItemsRequest)
Registers a compliance type and other compliance details on a designated resource.
|
default PutInventoryResponse |
putInventory(Consumer<PutInventoryRequest.Builder> putInventoryRequest)
Bulk update custom inventory items on one more instance.
|
default PutInventoryResponse |
putInventory(PutInventoryRequest putInventoryRequest)
Bulk update custom inventory items on one more instance.
|
default PutParameterResponse |
putParameter(Consumer<PutParameterRequest.Builder> putParameterRequest)
Add a parameter to the system.
|
default PutParameterResponse |
putParameter(PutParameterRequest putParameterRequest)
Add a parameter to the system.
|
default RegisterDefaultPatchBaselineResponse |
registerDefaultPatchBaseline(Consumer<RegisterDefaultPatchBaselineRequest.Builder> registerDefaultPatchBaselineRequest)
Defines the default patch baseline for the relevant operating system.
|
default RegisterDefaultPatchBaselineResponse |
registerDefaultPatchBaseline(RegisterDefaultPatchBaselineRequest registerDefaultPatchBaselineRequest)
Defines the default patch baseline for the relevant operating system.
|
default RegisterPatchBaselineForPatchGroupResponse |
registerPatchBaselineForPatchGroup(Consumer<RegisterPatchBaselineForPatchGroupRequest.Builder> registerPatchBaselineForPatchGroupRequest)
Registers a patch baseline for a patch group.
|
default RegisterPatchBaselineForPatchGroupResponse |
registerPatchBaselineForPatchGroup(RegisterPatchBaselineForPatchGroupRequest registerPatchBaselineForPatchGroupRequest)
Registers a patch baseline for a patch group.
|
default RegisterTargetWithMaintenanceWindowResponse |
registerTargetWithMaintenanceWindow(Consumer<RegisterTargetWithMaintenanceWindowRequest.Builder> registerTargetWithMaintenanceWindowRequest)
Registers a target with a maintenance window.
|
default RegisterTargetWithMaintenanceWindowResponse |
registerTargetWithMaintenanceWindow(RegisterTargetWithMaintenanceWindowRequest registerTargetWithMaintenanceWindowRequest)
Registers a target with a maintenance window.
|
default RegisterTaskWithMaintenanceWindowResponse |
registerTaskWithMaintenanceWindow(Consumer<RegisterTaskWithMaintenanceWindowRequest.Builder> registerTaskWithMaintenanceWindowRequest)
Adds a new task to a maintenance window.
|
default RegisterTaskWithMaintenanceWindowResponse |
registerTaskWithMaintenanceWindow(RegisterTaskWithMaintenanceWindowRequest registerTaskWithMaintenanceWindowRequest)
Adds a new task to a maintenance window.
|
default RemoveTagsFromResourceResponse |
removeTagsFromResource(Consumer<RemoveTagsFromResourceRequest.Builder> removeTagsFromResourceRequest)
Removes tag keys from the specified resource.
|
default RemoveTagsFromResourceResponse |
removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)
Removes tag keys from the specified resource.
|
default ResetServiceSettingResponse |
resetServiceSetting(Consumer<ResetServiceSettingRequest.Builder> resetServiceSettingRequest)
ServiceSetting is an account-level setting for an AWS service. |
default ResetServiceSettingResponse |
resetServiceSetting(ResetServiceSettingRequest resetServiceSettingRequest)
ServiceSetting is an account-level setting for an AWS service. |
default ResumeSessionResponse |
resumeSession(Consumer<ResumeSessionRequest.Builder> resumeSessionRequest)
Reconnects a session to an instance after it has been disconnected.
|
default ResumeSessionResponse |
resumeSession(ResumeSessionRequest resumeSessionRequest)
Reconnects a session to an instance after it has been disconnected.
|
default SendAutomationSignalResponse |
sendAutomationSignal(Consumer<SendAutomationSignalRequest.Builder> sendAutomationSignalRequest)
Sends a signal to an Automation execution to change the current behavior or status of the execution.
|
default SendAutomationSignalResponse |
sendAutomationSignal(SendAutomationSignalRequest sendAutomationSignalRequest)
Sends a signal to an Automation execution to change the current behavior or status of the execution.
|
default SendCommandResponse |
sendCommand(Consumer<SendCommandRequest.Builder> sendCommandRequest)
Runs commands on one or more managed instances.
|
default SendCommandResponse |
sendCommand(SendCommandRequest sendCommandRequest)
Runs commands on one or more managed instances.
|
static ServiceMetadata |
serviceMetadata() |
default StartAssociationsOnceResponse |
startAssociationsOnce(Consumer<StartAssociationsOnceRequest.Builder> startAssociationsOnceRequest)
Use this API action to run an association immediately and only one time.
|
default StartAssociationsOnceResponse |
startAssociationsOnce(StartAssociationsOnceRequest startAssociationsOnceRequest)
Use this API action to run an association immediately and only one time.
|
default StartAutomationExecutionResponse |
startAutomationExecution(Consumer<StartAutomationExecutionRequest.Builder> startAutomationExecutionRequest)
Initiates execution of an Automation document.
|
default StartAutomationExecutionResponse |
startAutomationExecution(StartAutomationExecutionRequest startAutomationExecutionRequest)
Initiates execution of an Automation document.
|
default StartChangeRequestExecutionResponse |
startChangeRequestExecution(Consumer<StartChangeRequestExecutionRequest.Builder> startChangeRequestExecutionRequest)
Creates a change request for Change Manager.
|
default StartChangeRequestExecutionResponse |
startChangeRequestExecution(StartChangeRequestExecutionRequest startChangeRequestExecutionRequest)
Creates a change request for Change Manager.
|
default StartSessionResponse |
startSession(Consumer<StartSessionRequest.Builder> startSessionRequest)
Initiates a connection to a target (for example, an instance) for a Session Manager session.
|
default StartSessionResponse |
startSession(StartSessionRequest startSessionRequest)
Initiates a connection to a target (for example, an instance) for a Session Manager session.
|
default StopAutomationExecutionResponse |
stopAutomationExecution(Consumer<StopAutomationExecutionRequest.Builder> stopAutomationExecutionRequest)
Stop an Automation that is currently running.
|
default StopAutomationExecutionResponse |
stopAutomationExecution(StopAutomationExecutionRequest stopAutomationExecutionRequest)
Stop an Automation that is currently running.
|
default TerminateSessionResponse |
terminateSession(Consumer<TerminateSessionRequest.Builder> terminateSessionRequest)
Permanently ends a session and closes the data connection between the Session Manager client and SSM Agent on the
instance.
|
default TerminateSessionResponse |
terminateSession(TerminateSessionRequest terminateSessionRequest)
Permanently ends a session and closes the data connection between the Session Manager client and SSM Agent on the
instance.
|
default UnlabelParameterVersionResponse |
unlabelParameterVersion(Consumer<UnlabelParameterVersionRequest.Builder> unlabelParameterVersionRequest)
Remove a label or labels from a parameter.
|
default UnlabelParameterVersionResponse |
unlabelParameterVersion(UnlabelParameterVersionRequest unlabelParameterVersionRequest)
Remove a label or labels from a parameter.
|
default UpdateAssociationResponse |
updateAssociation(Consumer<UpdateAssociationRequest.Builder> updateAssociationRequest)
Updates an association.
|
default UpdateAssociationResponse |
updateAssociation(UpdateAssociationRequest updateAssociationRequest)
Updates an association.
|
default UpdateAssociationStatusResponse |
updateAssociationStatus(Consumer<UpdateAssociationStatusRequest.Builder> updateAssociationStatusRequest)
Updates the status of the Systems Manager document associated with the specified instance.
|
default UpdateAssociationStatusResponse |
updateAssociationStatus(UpdateAssociationStatusRequest updateAssociationStatusRequest)
Updates the status of the Systems Manager document associated with the specified instance.
|
default UpdateDocumentResponse |
updateDocument(Consumer<UpdateDocumentRequest.Builder> updateDocumentRequest)
Updates one or more values for an SSM document.
|
default UpdateDocumentResponse |
updateDocument(UpdateDocumentRequest updateDocumentRequest)
Updates one or more values for an SSM document.
|
default UpdateDocumentDefaultVersionResponse |
updateDocumentDefaultVersion(Consumer<UpdateDocumentDefaultVersionRequest.Builder> updateDocumentDefaultVersionRequest)
Set the default version of a document.
|
default UpdateDocumentDefaultVersionResponse |
updateDocumentDefaultVersion(UpdateDocumentDefaultVersionRequest updateDocumentDefaultVersionRequest)
Set the default version of a document.
|
default UpdateDocumentMetadataResponse |
updateDocumentMetadata(Consumer<UpdateDocumentMetadataRequest.Builder> updateDocumentMetadataRequest)
Updates information related to approval reviews for a specific version of a document.
|
default UpdateDocumentMetadataResponse |
updateDocumentMetadata(UpdateDocumentMetadataRequest updateDocumentMetadataRequest)
Updates information related to approval reviews for a specific version of a document.
|
default UpdateMaintenanceWindowResponse |
updateMaintenanceWindow(Consumer<UpdateMaintenanceWindowRequest.Builder> updateMaintenanceWindowRequest)
Updates an existing maintenance window.
|
default UpdateMaintenanceWindowResponse |
updateMaintenanceWindow(UpdateMaintenanceWindowRequest updateMaintenanceWindowRequest)
Updates an existing maintenance window.
|
default UpdateMaintenanceWindowTargetResponse |
updateMaintenanceWindowTarget(Consumer<UpdateMaintenanceWindowTargetRequest.Builder> updateMaintenanceWindowTargetRequest)
Modifies the target of an existing maintenance window.
|
default UpdateMaintenanceWindowTargetResponse |
updateMaintenanceWindowTarget(UpdateMaintenanceWindowTargetRequest updateMaintenanceWindowTargetRequest)
Modifies the target of an existing maintenance window.
|
default UpdateMaintenanceWindowTaskResponse |
updateMaintenanceWindowTask(Consumer<UpdateMaintenanceWindowTaskRequest.Builder> updateMaintenanceWindowTaskRequest)
Modifies a task assigned to a maintenance window.
|
default UpdateMaintenanceWindowTaskResponse |
updateMaintenanceWindowTask(UpdateMaintenanceWindowTaskRequest updateMaintenanceWindowTaskRequest)
Modifies a task assigned to a maintenance window.
|
default UpdateManagedInstanceRoleResponse |
updateManagedInstanceRole(Consumer<UpdateManagedInstanceRoleRequest.Builder> updateManagedInstanceRoleRequest)
Changes the Amazon Identity and Access Management (IAM) role that is assigned to the on-premises instance or
virtual machines (VM).
|
default UpdateManagedInstanceRoleResponse |
updateManagedInstanceRole(UpdateManagedInstanceRoleRequest updateManagedInstanceRoleRequest)
Changes the Amazon Identity and Access Management (IAM) role that is assigned to the on-premises instance or
virtual machines (VM).
|
default UpdateOpsItemResponse |
updateOpsItem(Consumer<UpdateOpsItemRequest.Builder> updateOpsItemRequest)
Edit or change an OpsItem.
|
default UpdateOpsItemResponse |
updateOpsItem(UpdateOpsItemRequest updateOpsItemRequest)
Edit or change an OpsItem.
|
default UpdateOpsMetadataResponse |
updateOpsMetadata(Consumer<UpdateOpsMetadataRequest.Builder> updateOpsMetadataRequest)
Systems Manager calls this API action when you edit OpsMetadata in Application Manager.
|
default UpdateOpsMetadataResponse |
updateOpsMetadata(UpdateOpsMetadataRequest updateOpsMetadataRequest)
Systems Manager calls this API action when you edit OpsMetadata in Application Manager.
|
default UpdatePatchBaselineResponse |
updatePatchBaseline(Consumer<UpdatePatchBaselineRequest.Builder> updatePatchBaselineRequest)
Modifies an existing patch baseline.
|
default UpdatePatchBaselineResponse |
updatePatchBaseline(UpdatePatchBaselineRequest updatePatchBaselineRequest)
Modifies an existing patch baseline.
|
default UpdateResourceDataSyncResponse |
updateResourceDataSync(Consumer<UpdateResourceDataSyncRequest.Builder> updateResourceDataSyncRequest)
Update a resource data sync.
|
default UpdateResourceDataSyncResponse |
updateResourceDataSync(UpdateResourceDataSyncRequest updateResourceDataSyncRequest)
Update a resource data sync.
|
default UpdateServiceSettingResponse |
updateServiceSetting(Consumer<UpdateServiceSettingRequest.Builder> updateServiceSettingRequest)
ServiceSetting is an account-level setting for an AWS service. |
default UpdateServiceSettingResponse |
updateServiceSetting(UpdateServiceSettingRequest updateServiceSettingRequest)
ServiceSetting is an account-level setting for an AWS service. |
default SsmWaiter |
waiter()
Create an instance of
SsmWaiter using this client. |
serviceName
close
static final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider
.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, TooManyUpdatesException, AwsServiceException, SdkClientException, SsmException
Adds or overwrites one or more tags for the specified resource. Tags are metadata that you can assign to your documents, managed instances, maintenance windows, Parameter Store parameters, and patch baselines. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define. For example, you could define a set of tags for your account's managed instances that helps you track each instance's owner and stack level. For example: Key=Owner and Value=DbAdmin, SysAdmin, or Dev. Or Key=Stack and Value=Production, Pre-Production, or Test.
Each resource can have a maximum of 50 tags.
We recommend that you devise a set of tag keys that meets your needs for each resource type. Using a consistent set of tag keys makes it easier for you to manage your resources. You can search and filter the resources based on the tags you add. Tags don't have any semantic meaning to and are interpreted strictly as a string of characters.
For more information about using tags with EC2 instances, see Tagging your Amazon EC2 resources in the Amazon EC2 User Guide.
addTagsToResourceRequest
- InvalidResourceTypeException
- The resource type is not valid. For example, if you are attempting to tag an instance, the instance must
be a registered, managed instance.InvalidResourceIdException
- The resource ID is not valid. Verify that you entered the correct ID and try again.InternalServerErrorException
- An error occurred on the server side.TooManyTagsErrorException
- The Targets
parameter includes too many tags. Remove one or more tags and try the command
again.TooManyUpdatesException
- There are concurrent updates for a resource that supports one update at a time.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AddTagsToResourceResponse addTagsToResource(Consumer<AddTagsToResourceRequest.Builder> addTagsToResourceRequest) throws InvalidResourceTypeException, InvalidResourceIdException, InternalServerErrorException, TooManyTagsErrorException, TooManyUpdatesException, AwsServiceException, SdkClientException, SsmException
Adds or overwrites one or more tags for the specified resource. Tags are metadata that you can assign to your documents, managed instances, maintenance windows, Parameter Store parameters, and patch baselines. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define. For example, you could define a set of tags for your account's managed instances that helps you track each instance's owner and stack level. For example: Key=Owner and Value=DbAdmin, SysAdmin, or Dev. Or Key=Stack and Value=Production, Pre-Production, or Test.
Each resource can have a maximum of 50 tags.
We recommend that you devise a set of tag keys that meets your needs for each resource type. Using a consistent set of tag keys makes it easier for you to manage your resources. You can search and filter the resources based on the tags you add. Tags don't have any semantic meaning to and are interpreted strictly as a string of characters.
For more information about using tags with EC2 instances, see Tagging your Amazon EC2 resources in the Amazon EC2 User Guide.
This is a convenience which creates an instance of the AddTagsToResourceRequest.Builder
avoiding the need
to create one manually via AddTagsToResourceRequest.builder()
addTagsToResourceRequest
- A Consumer
that will call methods on AddTagsToResourceRequest.Builder
to create a request.InvalidResourceTypeException
- The resource type is not valid. For example, if you are attempting to tag an instance, the instance must
be a registered, managed instance.InvalidResourceIdException
- The resource ID is not valid. Verify that you entered the correct ID and try again.InternalServerErrorException
- An error occurred on the server side.TooManyTagsErrorException
- The Targets
parameter includes too many tags. Remove one or more tags and try the command
again.TooManyUpdatesException
- There are concurrent updates for a resource that supports one update at a time.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CancelCommandResponse cancelCommand(CancelCommandRequest cancelCommandRequest) throws InternalServerErrorException, InvalidCommandIdException, InvalidInstanceIdException, DuplicateInstanceIdException, AwsServiceException, 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.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CancelCommandResponse cancelCommand(Consumer<CancelCommandRequest.Builder> cancelCommandRequest) throws InternalServerErrorException, InvalidCommandIdException, InvalidInstanceIdException, DuplicateInstanceIdException, AwsServiceException, 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.
This is a convenience which creates an instance of the CancelCommandRequest.Builder
avoiding the need to
create one manually via CancelCommandRequest.builder()
cancelCommandRequest
- A Consumer
that will call methods on CancelCommandRequest.Builder
to create a request.InternalServerErrorException
- An error occurred on the server side.InvalidCommandIdException
InvalidInstanceIdException
- The following problems can cause this exception:
You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CancelMaintenanceWindowExecutionResponse cancelMaintenanceWindowExecution(CancelMaintenanceWindowExecutionRequest cancelMaintenanceWindowExecutionRequest) throws InternalServerErrorException, DoesNotExistException, AwsServiceException, SdkClientException, SsmException
Stops a maintenance window execution that is already in progress and cancels any tasks in the window that have not already starting running. (Tasks already in progress will continue to completion.)
cancelMaintenanceWindowExecutionRequest
- InternalServerErrorException
- An error occurred on the server side.DoesNotExistException
- Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline,
doesn't exist.
For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CancelMaintenanceWindowExecutionResponse cancelMaintenanceWindowExecution(Consumer<CancelMaintenanceWindowExecutionRequest.Builder> cancelMaintenanceWindowExecutionRequest) throws InternalServerErrorException, DoesNotExistException, AwsServiceException, SdkClientException, SsmException
Stops a maintenance window execution that is already in progress and cancels any tasks in the window that have not already starting running. (Tasks already in progress will continue to completion.)
This is a convenience which creates an instance of the CancelMaintenanceWindowExecutionRequest.Builder
avoiding the need to create one manually via CancelMaintenanceWindowExecutionRequest.builder()
cancelMaintenanceWindowExecutionRequest
- A Consumer
that will call methods on CancelMaintenanceWindowExecutionRequest.Builder
to
create a request.InternalServerErrorException
- An error occurred on the server side.DoesNotExistException
- Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline,
doesn't exist.
For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateActivationResponse createActivation(CreateActivationRequest createActivationRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Generates an activation code and activation ID you can use to register your on-premises server or virtual machine (VM) with Systems Manager. Registering these machines with Systems Manager makes it possible to manage them using Systems Manager capabilities. You use the activation code and ID when installing SSM Agent on machines in your hybrid environment. For more information about requirements for managing on-premises instances and VMs using Systems Manager, see Setting up AWS Systems Manager for hybrid environments in the AWS Systems Manager User Guide.
On-premises servers or VMs that are registered with Systems Manager and EC2 instances that you manage with Systems Manager are all called managed instances.
createActivationRequest
- InternalServerErrorException
- An error occurred on the server side.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateActivationResponse createActivation(Consumer<CreateActivationRequest.Builder> createActivationRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Generates an activation code and activation ID you can use to register your on-premises server or virtual machine (VM) with Systems Manager. Registering these machines with Systems Manager makes it possible to manage them using Systems Manager capabilities. You use the activation code and ID when installing SSM Agent on machines in your hybrid environment. For more information about requirements for managing on-premises instances and VMs using Systems Manager, see Setting up AWS Systems Manager for hybrid environments in the AWS Systems Manager User Guide.
On-premises servers or VMs that are registered with Systems Manager and EC2 instances that you manage with Systems Manager are all called managed instances.
This is a convenience which creates an instance of the CreateActivationRequest.Builder
avoiding the need
to create one manually via CreateActivationRequest.builder()
createActivationRequest
- A Consumer
that will call methods on CreateActivationRequest.Builder
to create a request.InternalServerErrorException
- An error occurred on the server side.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateAssociationResponse createAssociation(CreateAssociationRequest createAssociationRequest) throws AssociationAlreadyExistsException, AssociationLimitExceededException, InternalServerErrorException, InvalidDocumentException, InvalidDocumentVersionException, InvalidInstanceIdException, UnsupportedPlatformTypeException, InvalidOutputLocationException, InvalidParametersException, InvalidTargetException, InvalidScheduleException, AwsServiceException, SdkClientException, SsmException
A State Manager association defines the state that you want to maintain on your instances. For example, an association can specify that anti-virus software must be installed and running on your instances, or that certain ports must be closed. For static targets, the association specifies a schedule for when the configuration is reapplied. For dynamic targets, such as an AWS Resource Group or an AWS Autoscaling Group, State Manager applies the configuration when new instances are added to the group. The association also specifies actions to take when applying the configuration. For example, an association for anti-virus software might run once a day. If the software is not installed, then State Manager installs it. If the software is installed, but the service is not running, then the association might instruct State Manager to start the service.
createAssociationRequest
- AssociationAlreadyExistsException
- The specified association already exists.AssociationLimitExceededException
- You can have at most 2,000 active associations.InternalServerErrorException
- An error occurred on the server side.InvalidDocumentException
- The specified document does not exist.InvalidDocumentVersionException
- The document version is not valid or does not exist.InvalidInstanceIdException
- The following problems can cause this exception:
You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
UnsupportedPlatformTypeException
- The document does not support the platform type of the given instance ID(s). For example, you sent an
document for a Windows instance to a Linux instance.InvalidOutputLocationException
- The output location is not valid or does not exist.InvalidParametersException
- You must specify values for all required parameters in the Systems Manager document. You can only supply
values to parameters defined in the Systems Manager document.InvalidTargetException
- The target is not valid or does not exist. It might not be configured for 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateAssociationResponse createAssociation(Consumer<CreateAssociationRequest.Builder> createAssociationRequest) throws AssociationAlreadyExistsException, AssociationLimitExceededException, InternalServerErrorException, InvalidDocumentException, InvalidDocumentVersionException, InvalidInstanceIdException, UnsupportedPlatformTypeException, InvalidOutputLocationException, InvalidParametersException, InvalidTargetException, InvalidScheduleException, AwsServiceException, SdkClientException, SsmException
A State Manager association defines the state that you want to maintain on your instances. For example, an association can specify that anti-virus software must be installed and running on your instances, or that certain ports must be closed. For static targets, the association specifies a schedule for when the configuration is reapplied. For dynamic targets, such as an AWS Resource Group or an AWS Autoscaling Group, State Manager applies the configuration when new instances are added to the group. The association also specifies actions to take when applying the configuration. For example, an association for anti-virus software might run once a day. If the software is not installed, then State Manager installs it. If the software is installed, but the service is not running, then the association might instruct State Manager to start the service.
This is a convenience which creates an instance of the CreateAssociationRequest.Builder
avoiding the need
to create one manually via CreateAssociationRequest.builder()
createAssociationRequest
- A Consumer
that will call methods on CreateAssociationRequest.Builder
to create a request.AssociationAlreadyExistsException
- The specified association already exists.AssociationLimitExceededException
- You can have at most 2,000 active associations.InternalServerErrorException
- An error occurred on the server side.InvalidDocumentException
- The specified document does not exist.InvalidDocumentVersionException
- The document version is not valid or does not exist.InvalidInstanceIdException
- The following problems can cause this exception:
You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
UnsupportedPlatformTypeException
- The document does not support the platform type of the given instance ID(s). For example, you sent an
document for a Windows instance to a Linux instance.InvalidOutputLocationException
- The output location is not valid or does not exist.InvalidParametersException
- You must specify values for all required parameters in the Systems Manager document. You can only supply
values to parameters defined in the Systems Manager document.InvalidTargetException
- The target is not valid or does not exist. It might not be configured for 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateAssociationBatchResponse createAssociationBatch(CreateAssociationBatchRequest createAssociationBatchRequest) throws InternalServerErrorException, InvalidDocumentException, InvalidDocumentVersionException, InvalidInstanceIdException, InvalidParametersException, DuplicateInstanceIdException, AssociationLimitExceededException, UnsupportedPlatformTypeException, InvalidOutputLocationException, InvalidTargetException, InvalidScheduleException, AwsServiceException, 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, SSM Agent running on the instance processes the document and configures the instance as specified.
If you associate a document with an instance that already has an associated document, the system returns the AssociationAlreadyExists exception.
createAssociationBatchRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidDocumentException
- The specified document does not exist.InvalidDocumentVersionException
- The document version is not valid or does not exist.InvalidInstanceIdException
- The following problems can cause this exception:
You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
InvalidParametersException
- You must specify values for all required parameters in the Systems Manager document. You can only supply
values to parameters defined in the Systems Manager document.DuplicateInstanceIdException
- You cannot specify an instance ID in more than one association.AssociationLimitExceededException
- You can have at most 2,000 active associations.UnsupportedPlatformTypeException
- The document does not support the platform type of the given instance ID(s). For example, you sent an
document for a Windows instance to a Linux instance.InvalidOutputLocationException
- The output location is not valid or does not exist.InvalidTargetException
- The target is not valid or does not exist. It might not be configured for 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateAssociationBatchResponse createAssociationBatch(Consumer<CreateAssociationBatchRequest.Builder> createAssociationBatchRequest) throws InternalServerErrorException, InvalidDocumentException, InvalidDocumentVersionException, InvalidInstanceIdException, InvalidParametersException, DuplicateInstanceIdException, AssociationLimitExceededException, UnsupportedPlatformTypeException, InvalidOutputLocationException, InvalidTargetException, InvalidScheduleException, AwsServiceException, 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, SSM Agent running on the instance processes the document and configures the instance as specified.
If you associate a document with an instance that already has an associated document, the system returns the AssociationAlreadyExists exception.
This is a convenience which creates an instance of the CreateAssociationBatchRequest.Builder
avoiding the
need to create one manually via CreateAssociationBatchRequest.builder()
createAssociationBatchRequest
- A Consumer
that will call methods on CreateAssociationBatchRequest.Builder
to create a
request.InternalServerErrorException
- An error occurred on the server side.InvalidDocumentException
- The specified document does not exist.InvalidDocumentVersionException
- The document version is not valid or does not exist.InvalidInstanceIdException
- The following problems can cause this exception:
You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
InvalidParametersException
- You must specify values for all required parameters in the Systems Manager document. You can only supply
values to parameters defined in the Systems Manager document.DuplicateInstanceIdException
- You cannot specify an instance ID in more than one association.AssociationLimitExceededException
- You can have at most 2,000 active associations.UnsupportedPlatformTypeException
- The document does not support the platform type of the given instance ID(s). For example, you sent an
document for a Windows instance to a Linux instance.InvalidOutputLocationException
- The output location is not valid or does not exist.InvalidTargetException
- The target is not valid or does not exist. It might not be configured for 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateDocumentResponse createDocument(CreateDocumentRequest createDocumentRequest) throws DocumentAlreadyExistsException, MaxDocumentSizeExceededException, InternalServerErrorException, InvalidDocumentContentException, DocumentLimitExceededException, InvalidDocumentSchemaVersionException, AwsServiceException, SdkClientException, SsmException
Creates a Systems Manager (SSM) document. An SSM document defines the actions that Systems Manager performs on your managed instances. For more information about SSM documents, including information about supported schemas, features, and syntax, see AWS Systems Manager Documents in the AWS Systems Manager User Guide.
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 500 active Systems Manager documents.InvalidDocumentSchemaVersionException
- The version of the document schema is not supported.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateDocumentResponse createDocument(Consumer<CreateDocumentRequest.Builder> createDocumentRequest) throws DocumentAlreadyExistsException, MaxDocumentSizeExceededException, InternalServerErrorException, InvalidDocumentContentException, DocumentLimitExceededException, InvalidDocumentSchemaVersionException, AwsServiceException, SdkClientException, SsmException
Creates a Systems Manager (SSM) document. An SSM document defines the actions that Systems Manager performs on your managed instances. For more information about SSM documents, including information about supported schemas, features, and syntax, see AWS Systems Manager Documents in the AWS Systems Manager User Guide.
This is a convenience which creates an instance of the CreateDocumentRequest.Builder
avoiding the need to
create one manually via CreateDocumentRequest.builder()
createDocumentRequest
- A Consumer
that will call methods on CreateDocumentRequest.Builder
to create a request.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 500 active Systems Manager documents.InvalidDocumentSchemaVersionException
- The version of the document schema is not supported.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateMaintenanceWindowResponse createMaintenanceWindow(CreateMaintenanceWindowRequest createMaintenanceWindowRequest) throws IdempotentParameterMismatchException, ResourceLimitExceededException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Creates a new maintenance window.
The value you specify for Duration
determines the specific end time for the maintenance window based
on the time it begins. No maintenance window tasks are permitted to start after the resulting endtime minus the
number of hours you specify for Cutoff
. For example, if the maintenance window starts at 3 PM, the
duration is three hours, and the value you specify for Cutoff
is one hour, no maintenance window
tasks can start after 5 PM.
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 quotas. For example, too many
maintenance windows or patch baselines have been created.
For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
InternalServerErrorException
- An error occurred on the server side.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateMaintenanceWindowResponse createMaintenanceWindow(Consumer<CreateMaintenanceWindowRequest.Builder> createMaintenanceWindowRequest) throws IdempotentParameterMismatchException, ResourceLimitExceededException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Creates a new maintenance window.
The value you specify for Duration
determines the specific end time for the maintenance window based
on the time it begins. No maintenance window tasks are permitted to start after the resulting endtime minus the
number of hours you specify for Cutoff
. For example, if the maintenance window starts at 3 PM, the
duration is three hours, and the value you specify for Cutoff
is one hour, no maintenance window
tasks can start after 5 PM.
This is a convenience which creates an instance of the CreateMaintenanceWindowRequest.Builder
avoiding
the need to create one manually via CreateMaintenanceWindowRequest.builder()
createMaintenanceWindowRequest
- A Consumer
that will call methods on CreateMaintenanceWindowRequest.Builder
to create a
request.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 quotas. For example, too many
maintenance windows or patch baselines have been created.
For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
InternalServerErrorException
- An error occurred on the server side.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateOpsItemResponse createOpsItem(CreateOpsItemRequest createOpsItemRequest) throws InternalServerErrorException, OpsItemAlreadyExistsException, OpsItemLimitExceededException, OpsItemInvalidParameterException, AwsServiceException, SdkClientException, SsmException
Creates a new OpsItem. You must have permission in AWS Identity and Access Management (IAM) to create a new OpsItem. For more information, see Getting started with OpsCenter in the AWS Systems Manager User Guide.
Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see AWS Systems Manager OpsCenter in the AWS Systems Manager User Guide.
createOpsItemRequest
- InternalServerErrorException
- An error occurred on the server side.OpsItemAlreadyExistsException
- The OpsItem already exists.OpsItemLimitExceededException
- The request caused OpsItems to exceed one or more quotas. For information about OpsItem quotas, see What are the resource limits for OpsCenter?.OpsItemInvalidParameterException
- A specified parameter argument isn't valid. Verify the available arguments and try again.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateOpsItemResponse createOpsItem(Consumer<CreateOpsItemRequest.Builder> createOpsItemRequest) throws InternalServerErrorException, OpsItemAlreadyExistsException, OpsItemLimitExceededException, OpsItemInvalidParameterException, AwsServiceException, SdkClientException, SsmException
Creates a new OpsItem. You must have permission in AWS Identity and Access Management (IAM) to create a new OpsItem. For more information, see Getting started with OpsCenter in the AWS Systems Manager User Guide.
Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see AWS Systems Manager OpsCenter in the AWS Systems Manager User Guide.
This is a convenience which creates an instance of the CreateOpsItemRequest.Builder
avoiding the need to
create one manually via CreateOpsItemRequest.builder()
createOpsItemRequest
- A Consumer
that will call methods on CreateOpsItemRequest.Builder
to create a request.InternalServerErrorException
- An error occurred on the server side.OpsItemAlreadyExistsException
- The OpsItem already exists.OpsItemLimitExceededException
- The request caused OpsItems to exceed one or more quotas. For information about OpsItem quotas, see What are the resource limits for OpsCenter?.OpsItemInvalidParameterException
- A specified parameter argument isn't valid. Verify the available arguments and try again.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateOpsMetadataResponse createOpsMetadata(CreateOpsMetadataRequest createOpsMetadataRequest) throws OpsMetadataAlreadyExistsException, OpsMetadataTooManyUpdatesException, OpsMetadataInvalidArgumentException, OpsMetadataLimitExceededException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
If you create a new application in Application Manager, Systems Manager calls this API action to specify information about the new application, including the application type.
createOpsMetadataRequest
- OpsMetadataAlreadyExistsException
- An OpsMetadata object already exists for the selected resource.OpsMetadataTooManyUpdatesException
- The system is processing too many concurrent updates. Wait a few moments and try again.OpsMetadataInvalidArgumentException
- One of the arguments passed is invalid.OpsMetadataLimitExceededException
- Your account reached the maximum number of OpsMetadata objects allowed by Application Manager. The
maximum is 200 OpsMetadata objects. Delete one or more OpsMetadata object and try again.InternalServerErrorException
- An error occurred on the server side.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateOpsMetadataResponse createOpsMetadata(Consumer<CreateOpsMetadataRequest.Builder> createOpsMetadataRequest) throws OpsMetadataAlreadyExistsException, OpsMetadataTooManyUpdatesException, OpsMetadataInvalidArgumentException, OpsMetadataLimitExceededException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
If you create a new application in Application Manager, Systems Manager calls this API action to specify information about the new application, including the application type.
This is a convenience which creates an instance of the CreateOpsMetadataRequest.Builder
avoiding the need
to create one manually via CreateOpsMetadataRequest.builder()
createOpsMetadataRequest
- A Consumer
that will call methods on CreateOpsMetadataRequest.Builder
to create a request.OpsMetadataAlreadyExistsException
- An OpsMetadata object already exists for the selected resource.OpsMetadataTooManyUpdatesException
- The system is processing too many concurrent updates. Wait a few moments and try again.OpsMetadataInvalidArgumentException
- One of the arguments passed is invalid.OpsMetadataLimitExceededException
- Your account reached the maximum number of OpsMetadata objects allowed by Application Manager. The
maximum is 200 OpsMetadata objects. Delete one or more OpsMetadata object and try again.InternalServerErrorException
- An error occurred on the server side.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreatePatchBaselineResponse createPatchBaseline(CreatePatchBaselineRequest createPatchBaselineRequest) throws IdempotentParameterMismatchException, ResourceLimitExceededException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Creates a patch baseline.
For information about valid key and value pairs in PatchFilters
for each supported operating system
type, see PatchFilter.
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 quotas. For example, too many
maintenance windows or patch baselines have been created.
For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
InternalServerErrorException
- An error occurred on the server side.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreatePatchBaselineResponse createPatchBaseline(Consumer<CreatePatchBaselineRequest.Builder> createPatchBaselineRequest) throws IdempotentParameterMismatchException, ResourceLimitExceededException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Creates a patch baseline.
For information about valid key and value pairs in PatchFilters
for each supported operating system
type, see PatchFilter.
This is a convenience which creates an instance of the CreatePatchBaselineRequest.Builder
avoiding the
need to create one manually via CreatePatchBaselineRequest.builder()
createPatchBaselineRequest
- A Consumer
that will call methods on CreatePatchBaselineRequest.Builder
to create a
request.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 quotas. For example, too many
maintenance windows or patch baselines have been created.
For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
InternalServerErrorException
- An error occurred on the server side.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateResourceDataSyncResponse createResourceDataSync(CreateResourceDataSyncRequest createResourceDataSyncRequest) throws InternalServerErrorException, ResourceDataSyncCountExceededException, ResourceDataSyncAlreadyExistsException, ResourceDataSyncInvalidConfigurationException, AwsServiceException, SdkClientException, SsmException
A resource data sync helps you view data from multiple sources in a single location. Systems Manager offers two
types of resource data sync: SyncToDestination
and SyncFromSource
.
You can configure Systems Manager Inventory to use the SyncToDestination
type to synchronize
Inventory data from multiple AWS Regions to a single S3 bucket. For more information, see Configuring
Resource Data Sync for Inventory in the AWS Systems Manager User Guide.
You can configure Systems Manager Explorer to use the SyncFromSource
type to synchronize operational
work items (OpsItems) and operational data (OpsData) from multiple AWS Regions to a single S3 bucket. This type
can synchronize OpsItems and OpsData from multiple AWS accounts and Regions or EntireOrganization
by
using AWS Organizations. For more information, see Setting up
Systems Manager Explorer to display data from multiple accounts and Regions in the AWS Systems Manager
User Guide.
A resource data sync is an asynchronous operation that returns immediately. After a successful initial sync is completed, the system continuously syncs data. To check the status of a sync, use the ListResourceDataSync.
By default, data is not encrypted in Amazon S3. We strongly recommend that you enable encryption in Amazon S3 to ensure secure data storage. We also recommend that you secure access to the Amazon S3 bucket by creating a restrictive bucket policy.
createResourceDataSyncRequest
- InternalServerErrorException
- An error occurred on the server side.ResourceDataSyncCountExceededException
- You have exceeded the allowed maximum sync configurations.ResourceDataSyncAlreadyExistsException
- A sync configuration with the same name already exists.ResourceDataSyncInvalidConfigurationException
- The specified sync configuration is invalid.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateResourceDataSyncResponse createResourceDataSync(Consumer<CreateResourceDataSyncRequest.Builder> createResourceDataSyncRequest) throws InternalServerErrorException, ResourceDataSyncCountExceededException, ResourceDataSyncAlreadyExistsException, ResourceDataSyncInvalidConfigurationException, AwsServiceException, SdkClientException, SsmException
A resource data sync helps you view data from multiple sources in a single location. Systems Manager offers two
types of resource data sync: SyncToDestination
and SyncFromSource
.
You can configure Systems Manager Inventory to use the SyncToDestination
type to synchronize
Inventory data from multiple AWS Regions to a single S3 bucket. For more information, see Configuring
Resource Data Sync for Inventory in the AWS Systems Manager User Guide.
You can configure Systems Manager Explorer to use the SyncFromSource
type to synchronize operational
work items (OpsItems) and operational data (OpsData) from multiple AWS Regions to a single S3 bucket. This type
can synchronize OpsItems and OpsData from multiple AWS accounts and Regions or EntireOrganization
by
using AWS Organizations. For more information, see Setting up
Systems Manager Explorer to display data from multiple accounts and Regions in the AWS Systems Manager
User Guide.
A resource data sync is an asynchronous operation that returns immediately. After a successful initial sync is completed, the system continuously syncs data. To check the status of a sync, use the ListResourceDataSync.
By default, data is not encrypted in Amazon S3. We strongly recommend that you enable encryption in Amazon S3 to ensure secure data storage. We also recommend that you secure access to the Amazon S3 bucket by creating a restrictive bucket policy.
This is a convenience which creates an instance of the CreateResourceDataSyncRequest.Builder
avoiding the
need to create one manually via CreateResourceDataSyncRequest.builder()
createResourceDataSyncRequest
- A Consumer
that will call methods on CreateResourceDataSyncRequest.Builder
to create a
request.InternalServerErrorException
- An error occurred on the server side.ResourceDataSyncCountExceededException
- You have exceeded the allowed maximum sync configurations.ResourceDataSyncAlreadyExistsException
- A sync configuration with the same name already exists.ResourceDataSyncInvalidConfigurationException
- The specified sync configuration is invalid.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteActivationResponse deleteActivation(DeleteActivationRequest deleteActivationRequest) throws InvalidActivationIdException, InvalidActivationException, InternalServerErrorException, TooManyUpdatesException, AwsServiceException, 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.TooManyUpdatesException
- There are concurrent updates for a resource that supports one update at a time.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteActivationResponse deleteActivation(Consumer<DeleteActivationRequest.Builder> deleteActivationRequest) throws InvalidActivationIdException, InvalidActivationException, InternalServerErrorException, TooManyUpdatesException, AwsServiceException, 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.
This is a convenience which creates an instance of the DeleteActivationRequest.Builder
avoiding the need
to create one manually via DeleteActivationRequest.builder()
deleteActivationRequest
- A Consumer
that will call methods on DeleteActivationRequest.Builder
to create a request.InvalidActivationIdException
- The activation ID is not valid. Verify the you entered the correct ActivationId or ActivationCode and try
again.InvalidActivationException
- The activation is not valid. The activation might have been deleted, or the ActivationId and the
ActivationCode do not match.InternalServerErrorException
- An error occurred on the server side.TooManyUpdatesException
- There are concurrent updates for a resource that supports one update at a time.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteAssociationResponse deleteAssociation(DeleteAssociationRequest deleteAssociationRequest) throws AssociationDoesNotExistException, InternalServerErrorException, InvalidDocumentException, InvalidInstanceIdException, TooManyUpdatesException, AwsServiceException, 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.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteAssociationResponse deleteAssociation(Consumer<DeleteAssociationRequest.Builder> deleteAssociationRequest) throws AssociationDoesNotExistException, InternalServerErrorException, InvalidDocumentException, InvalidInstanceIdException, TooManyUpdatesException, AwsServiceException, 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.
This is a convenience which creates an instance of the DeleteAssociationRequest.Builder
avoiding the need
to create one manually via DeleteAssociationRequest.builder()
deleteAssociationRequest
- A Consumer
that will call methods on DeleteAssociationRequest.Builder
to create a request.AssociationDoesNotExistException
- The specified association does not exist.InternalServerErrorException
- An error occurred on the server side.InvalidDocumentException
- The specified document does not exist.InvalidInstanceIdException
- The following problems can cause this exception:
You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteDocumentResponse deleteDocument(DeleteDocumentRequest deleteDocumentRequest) throws InternalServerErrorException, InvalidDocumentException, InvalidDocumentOperationException, AssociatedInstancesException, AwsServiceException, 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteDocumentResponse deleteDocument(Consumer<DeleteDocumentRequest.Builder> deleteDocumentRequest) throws InternalServerErrorException, InvalidDocumentException, InvalidDocumentOperationException, AssociatedInstancesException, AwsServiceException, 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.
This is a convenience which creates an instance of the DeleteDocumentRequest.Builder
avoiding the need to
create one manually via DeleteDocumentRequest.builder()
deleteDocumentRequest
- A Consumer
that will call methods on DeleteDocumentRequest.Builder
to create a request.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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteInventoryResponse deleteInventory(DeleteInventoryRequest deleteInventoryRequest) throws InternalServerErrorException, InvalidTypeNameException, InvalidOptionException, InvalidDeleteInventoryParametersException, InvalidInventoryRequestException, AwsServiceException, SdkClientException, SsmException
Delete a custom inventory type or the data associated with a custom Inventory type. Deleting a custom inventory type is also referred to as deleting a custom inventory schema.
deleteInventoryRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidTypeNameException
- The parameter type name is not valid.InvalidOptionException
- The delete inventory option specified is not valid. Verify the option and try again.InvalidDeleteInventoryParametersException
- One or more of the parameters specified for the delete operation is not valid. Verify all parameters and
try again.InvalidInventoryRequestException
- The request is not valid.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteInventoryResponse deleteInventory(Consumer<DeleteInventoryRequest.Builder> deleteInventoryRequest) throws InternalServerErrorException, InvalidTypeNameException, InvalidOptionException, InvalidDeleteInventoryParametersException, InvalidInventoryRequestException, AwsServiceException, SdkClientException, SsmException
Delete a custom inventory type or the data associated with a custom Inventory type. Deleting a custom inventory type is also referred to as deleting a custom inventory schema.
This is a convenience which creates an instance of the DeleteInventoryRequest.Builder
avoiding the need
to create one manually via DeleteInventoryRequest.builder()
deleteInventoryRequest
- A Consumer
that will call methods on DeleteInventoryRequest.Builder
to create a request.InternalServerErrorException
- An error occurred on the server side.InvalidTypeNameException
- The parameter type name is not valid.InvalidOptionException
- The delete inventory option specified is not valid. Verify the option and try again.InvalidDeleteInventoryParametersException
- One or more of the parameters specified for the delete operation is not valid. Verify all parameters and
try again.InvalidInventoryRequestException
- The request is not valid.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteMaintenanceWindowResponse deleteMaintenanceWindow(DeleteMaintenanceWindowRequest deleteMaintenanceWindowRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Deletes a maintenance window.
deleteMaintenanceWindowRequest
- InternalServerErrorException
- An error occurred on the server side.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteMaintenanceWindowResponse deleteMaintenanceWindow(Consumer<DeleteMaintenanceWindowRequest.Builder> deleteMaintenanceWindowRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Deletes a maintenance window.
This is a convenience which creates an instance of the DeleteMaintenanceWindowRequest.Builder
avoiding
the need to create one manually via DeleteMaintenanceWindowRequest.builder()
deleteMaintenanceWindowRequest
- A Consumer
that will call methods on DeleteMaintenanceWindowRequest.Builder
to create a
request.InternalServerErrorException
- An error occurred on the server side.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteOpsMetadataResponse deleteOpsMetadata(DeleteOpsMetadataRequest deleteOpsMetadataRequest) throws OpsMetadataNotFoundException, OpsMetadataInvalidArgumentException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Delete OpsMetadata related to an application.
deleteOpsMetadataRequest
- OpsMetadataNotFoundException
- The OpsMetadata object does not exist.OpsMetadataInvalidArgumentException
- One of the arguments passed is invalid.InternalServerErrorException
- An error occurred on the server side.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteOpsMetadataResponse deleteOpsMetadata(Consumer<DeleteOpsMetadataRequest.Builder> deleteOpsMetadataRequest) throws OpsMetadataNotFoundException, OpsMetadataInvalidArgumentException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Delete OpsMetadata related to an application.
This is a convenience which creates an instance of the DeleteOpsMetadataRequest.Builder
avoiding the need
to create one manually via DeleteOpsMetadataRequest.builder()
deleteOpsMetadataRequest
- A Consumer
that will call methods on DeleteOpsMetadataRequest.Builder
to create a request.OpsMetadataNotFoundException
- The OpsMetadata object does not exist.OpsMetadataInvalidArgumentException
- One of the arguments passed is invalid.InternalServerErrorException
- An error occurred on the server side.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteParameterResponse deleteParameter(DeleteParameterRequest deleteParameterRequest) throws InternalServerErrorException, ParameterNotFoundException, AwsServiceException, 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteParameterResponse deleteParameter(Consumer<DeleteParameterRequest.Builder> deleteParameterRequest) throws InternalServerErrorException, ParameterNotFoundException, AwsServiceException, SdkClientException, SsmException
Delete a parameter from the system.
This is a convenience which creates an instance of the DeleteParameterRequest.Builder
avoiding the need
to create one manually via DeleteParameterRequest.builder()
deleteParameterRequest
- A Consumer
that will call methods on DeleteParameterRequest.Builder
to create a request.InternalServerErrorException
- An error occurred on the server side.ParameterNotFoundException
- The parameter could not be found. Verify the name and try again.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteParametersResponse deleteParameters(DeleteParametersRequest deleteParametersRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Delete a list of parameters.
deleteParametersRequest
- InternalServerErrorException
- An error occurred on the server side.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteParametersResponse deleteParameters(Consumer<DeleteParametersRequest.Builder> deleteParametersRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Delete a list of parameters.
This is a convenience which creates an instance of the DeleteParametersRequest.Builder
avoiding the need
to create one manually via DeleteParametersRequest.builder()
deleteParametersRequest
- A Consumer
that will call methods on DeleteParametersRequest.Builder
to create a request.InternalServerErrorException
- An error occurred on the server side.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeletePatchBaselineResponse deletePatchBaseline(DeletePatchBaselineRequest deletePatchBaselineRequest) throws ResourceInUseException, InternalServerErrorException, AwsServiceException, 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeletePatchBaselineResponse deletePatchBaseline(Consumer<DeletePatchBaselineRequest.Builder> deletePatchBaselineRequest) throws ResourceInUseException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Deletes a patch baseline.
This is a convenience which creates an instance of the DeletePatchBaselineRequest.Builder
avoiding the
need to create one manually via DeletePatchBaselineRequest.builder()
deletePatchBaselineRequest
- A Consumer
that will call methods on DeletePatchBaselineRequest.Builder
to create a
request.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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteResourceDataSyncResponse deleteResourceDataSync(DeleteResourceDataSyncRequest deleteResourceDataSyncRequest) throws InternalServerErrorException, ResourceDataSyncNotFoundException, ResourceDataSyncInvalidConfigurationException, AwsServiceException, SdkClientException, SsmException
Deletes a Resource Data Sync configuration. After the configuration is deleted, changes to data on managed instances are no longer synced to or from the target. Deleting a sync configuration does not delete data.
deleteResourceDataSyncRequest
- InternalServerErrorException
- An error occurred on the server side.ResourceDataSyncNotFoundException
- The specified sync name was not found.ResourceDataSyncInvalidConfigurationException
- The specified sync configuration is invalid.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteResourceDataSyncResponse deleteResourceDataSync(Consumer<DeleteResourceDataSyncRequest.Builder> deleteResourceDataSyncRequest) throws InternalServerErrorException, ResourceDataSyncNotFoundException, ResourceDataSyncInvalidConfigurationException, AwsServiceException, SdkClientException, SsmException
Deletes a Resource Data Sync configuration. After the configuration is deleted, changes to data on managed instances are no longer synced to or from the target. Deleting a sync configuration does not delete data.
This is a convenience which creates an instance of the DeleteResourceDataSyncRequest.Builder
avoiding the
need to create one manually via DeleteResourceDataSyncRequest.builder()
deleteResourceDataSyncRequest
- A Consumer
that will call methods on DeleteResourceDataSyncRequest.Builder
to create a
request.InternalServerErrorException
- An error occurred on the server side.ResourceDataSyncNotFoundException
- The specified sync name was not found.ResourceDataSyncInvalidConfigurationException
- The specified sync configuration is invalid.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeregisterManagedInstanceResponse deregisterManagedInstance(DeregisterManagedInstanceRequest deregisterManagedInstanceRequest) throws InvalidInstanceIdException, InternalServerErrorException, AwsServiceException, 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 SSM Agent first.
deregisterManagedInstanceRequest
- InvalidInstanceIdException
- The following problems can cause this exception:
You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeregisterManagedInstanceResponse deregisterManagedInstance(Consumer<DeregisterManagedInstanceRequest.Builder> deregisterManagedInstanceRequest) throws InvalidInstanceIdException, InternalServerErrorException, AwsServiceException, 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 SSM Agent first.
This is a convenience which creates an instance of the DeregisterManagedInstanceRequest.Builder
avoiding
the need to create one manually via DeregisterManagedInstanceRequest.builder()
deregisterManagedInstanceRequest
- A Consumer
that will call methods on DeregisterManagedInstanceRequest.Builder
to create a
request.InvalidInstanceIdException
- The following problems can cause this exception:
You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeregisterPatchBaselineForPatchGroupResponse deregisterPatchBaselineForPatchGroup(DeregisterPatchBaselineForPatchGroupRequest deregisterPatchBaselineForPatchGroupRequest) throws InvalidResourceIdException, InternalServerErrorException, AwsServiceException, 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeregisterPatchBaselineForPatchGroupResponse deregisterPatchBaselineForPatchGroup(Consumer<DeregisterPatchBaselineForPatchGroupRequest.Builder> deregisterPatchBaselineForPatchGroupRequest) throws InvalidResourceIdException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Removes a patch group from a patch baseline.
This is a convenience which creates an instance of the
DeregisterPatchBaselineForPatchGroupRequest.Builder
avoiding the need to create one manually via
DeregisterPatchBaselineForPatchGroupRequest.builder()
deregisterPatchBaselineForPatchGroupRequest
- A Consumer
that will call methods on DeregisterPatchBaselineForPatchGroupRequest.Builder
to create a request.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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeregisterTargetFromMaintenanceWindowResponse deregisterTargetFromMaintenanceWindow(DeregisterTargetFromMaintenanceWindowRequest deregisterTargetFromMaintenanceWindowRequest) throws DoesNotExistException, InternalServerErrorException, TargetInUseException, AwsServiceException, SdkClientException, SsmException
Removes a target from a maintenance window.
deregisterTargetFromMaintenanceWindowRequest
- DoesNotExistException
- Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline,
doesn't exist.
For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
InternalServerErrorException
- An error occurred on the server side.TargetInUseException
- You specified the Safe
option for the DeregisterTargetFromMaintenanceWindow operation, but
the target is still referenced in a task.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeregisterTargetFromMaintenanceWindowResponse deregisterTargetFromMaintenanceWindow(Consumer<DeregisterTargetFromMaintenanceWindowRequest.Builder> deregisterTargetFromMaintenanceWindowRequest) throws DoesNotExistException, InternalServerErrorException, TargetInUseException, AwsServiceException, SdkClientException, SsmException
Removes a target from a maintenance window.
This is a convenience which creates an instance of the
DeregisterTargetFromMaintenanceWindowRequest.Builder
avoiding the need to create one manually via
DeregisterTargetFromMaintenanceWindowRequest.builder()
deregisterTargetFromMaintenanceWindowRequest
- A Consumer
that will call methods on DeregisterTargetFromMaintenanceWindowRequest.Builder
to create a request.DoesNotExistException
- Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline,
doesn't exist.
For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
InternalServerErrorException
- An error occurred on the server side.TargetInUseException
- You specified the Safe
option for the DeregisterTargetFromMaintenanceWindow operation, but
the target is still referenced in a task.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeregisterTaskFromMaintenanceWindowResponse deregisterTaskFromMaintenanceWindow(DeregisterTaskFromMaintenanceWindowRequest deregisterTaskFromMaintenanceWindowRequest) throws DoesNotExistException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Removes a task from a maintenance window.
deregisterTaskFromMaintenanceWindowRequest
- DoesNotExistException
- Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline,
doesn't exist.
For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
InternalServerErrorException
- An error occurred on the server side.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeregisterTaskFromMaintenanceWindowResponse deregisterTaskFromMaintenanceWindow(Consumer<DeregisterTaskFromMaintenanceWindowRequest.Builder> deregisterTaskFromMaintenanceWindowRequest) throws DoesNotExistException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Removes a task from a maintenance window.
This is a convenience which creates an instance of the DeregisterTaskFromMaintenanceWindowRequest.Builder
avoiding the need to create one manually via DeregisterTaskFromMaintenanceWindowRequest.builder()
deregisterTaskFromMaintenanceWindowRequest
- A Consumer
that will call methods on DeregisterTaskFromMaintenanceWindowRequest.Builder
to
create a request.DoesNotExistException
- Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline,
doesn't exist.
For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
InternalServerErrorException
- An error occurred on the server side.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeActivationsResponse describeActivations() throws InvalidFilterException, InvalidNextTokenException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Describes details about the activation, such as the date and time the activation was created, its expiration date, the IAM role assigned to the instances in the activation, and the number of instances registered by using this activation.
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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeActivations(DescribeActivationsRequest)
,
AWS API
Documentationdefault DescribeActivationsResponse describeActivations(DescribeActivationsRequest describeActivationsRequest) throws InvalidFilterException, InvalidNextTokenException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Describes details about the activation, such as the date and time the activation was created, its expiration date, the IAM role assigned to the instances in the activation, and the number of instances registered by using this activation.
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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeActivationsResponse describeActivations(Consumer<DescribeActivationsRequest.Builder> describeActivationsRequest) throws InvalidFilterException, InvalidNextTokenException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Describes details about the activation, such as the date and time the activation was created, its expiration date, the IAM role assigned to the instances in the activation, and the number of instances registered by using this activation.
This is a convenience which creates an instance of the DescribeActivationsRequest.Builder
avoiding the
need to create one manually via DescribeActivationsRequest.builder()
describeActivationsRequest
- A Consumer
that will call methods on DescribeActivationsRequest.Builder
to create a
request.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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeActivationsIterable describeActivationsPaginator() throws InvalidFilterException, InvalidNextTokenException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Describes details about the activation, such as the date and time the activation was created, its expiration date, the IAM role assigned to the instances in the activation, and the number of instances registered by using this activation.
This is a variant of
describeActivations(software.amazon.awssdk.services.ssm.model.DescribeActivationsRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ssm.paginators.DescribeActivationsIterable responses = client.describeActivationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.DescribeActivationsIterable responses = client .describeActivationsPaginator(request); for (software.amazon.awssdk.services.ssm.model.DescribeActivationsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.DescribeActivationsIterable responses = client.describeActivationsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeActivations(software.amazon.awssdk.services.ssm.model.DescribeActivationsRequest)
operation.
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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeActivationsPaginator(DescribeActivationsRequest)
,
AWS API
Documentationdefault DescribeActivationsIterable describeActivationsPaginator(DescribeActivationsRequest describeActivationsRequest) throws InvalidFilterException, InvalidNextTokenException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Describes details about the activation, such as the date and time the activation was created, its expiration date, the IAM role assigned to the instances in the activation, and the number of instances registered by using this activation.
This is a variant of
describeActivations(software.amazon.awssdk.services.ssm.model.DescribeActivationsRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ssm.paginators.DescribeActivationsIterable responses = client.describeActivationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.DescribeActivationsIterable responses = client .describeActivationsPaginator(request); for (software.amazon.awssdk.services.ssm.model.DescribeActivationsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.DescribeActivationsIterable responses = client.describeActivationsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeActivations(software.amazon.awssdk.services.ssm.model.DescribeActivationsRequest)
operation.
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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeActivationsIterable describeActivationsPaginator(Consumer<DescribeActivationsRequest.Builder> describeActivationsRequest) throws InvalidFilterException, InvalidNextTokenException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Describes details about the activation, such as the date and time the activation was created, its expiration date, the IAM role assigned to the instances in the activation, and the number of instances registered by using this activation.
This is a variant of
describeActivations(software.amazon.awssdk.services.ssm.model.DescribeActivationsRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ssm.paginators.DescribeActivationsIterable responses = client.describeActivationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.DescribeActivationsIterable responses = client .describeActivationsPaginator(request); for (software.amazon.awssdk.services.ssm.model.DescribeActivationsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.DescribeActivationsIterable responses = client.describeActivationsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeActivations(software.amazon.awssdk.services.ssm.model.DescribeActivationsRequest)
operation.
This is a convenience which creates an instance of the DescribeActivationsRequest.Builder
avoiding the
need to create one manually via DescribeActivationsRequest.builder()
describeActivationsRequest
- A Consumer
that will call methods on DescribeActivationsRequest.Builder
to create a
request.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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeAssociationResponse describeAssociation(DescribeAssociationRequest describeAssociationRequest) throws AssociationDoesNotExistException, InvalidAssociationVersionException, InternalServerErrorException, InvalidDocumentException, InvalidInstanceIdException, AwsServiceException, SdkClientException, SsmException
Describes the association for the specified target or instance. If you created the association by using the
Targets
parameter, then you must retrieve the association by using the association ID. If you
created the association by specifying an instance ID and a Systems Manager document, then you retrieve the
association by specifying the document name and the instance ID.
describeAssociationRequest
- AssociationDoesNotExistException
- The specified association does not exist.InvalidAssociationVersionException
- The version you specified is not valid. Use ListAssociationVersions to view all versions of an
association according to the association ID. Or, use the $LATEST
parameter to view the
latest version of the association.InternalServerErrorException
- An error occurred on the server side.InvalidDocumentException
- The specified document does not exist.InvalidInstanceIdException
- The following problems can cause this exception:
You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeAssociationResponse describeAssociation(Consumer<DescribeAssociationRequest.Builder> describeAssociationRequest) throws AssociationDoesNotExistException, InvalidAssociationVersionException, InternalServerErrorException, InvalidDocumentException, InvalidInstanceIdException, AwsServiceException, SdkClientException, SsmException
Describes the association for the specified target or instance. If you created the association by using the
Targets
parameter, then you must retrieve the association by using the association ID. If you
created the association by specifying an instance ID and a Systems Manager document, then you retrieve the
association by specifying the document name and the instance ID.
This is a convenience which creates an instance of the DescribeAssociationRequest.Builder
avoiding the
need to create one manually via DescribeAssociationRequest.builder()
describeAssociationRequest
- A Consumer
that will call methods on DescribeAssociationRequest.Builder
to create a
request.AssociationDoesNotExistException
- The specified association does not exist.InvalidAssociationVersionException
- The version you specified is not valid. Use ListAssociationVersions to view all versions of an
association according to the association ID. Or, use the $LATEST
parameter to view the
latest version of the association.InternalServerErrorException
- An error occurred on the server side.InvalidDocumentException
- The specified document does not exist.InvalidInstanceIdException
- The following problems can cause this exception:
You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeAssociationExecutionTargetsResponse describeAssociationExecutionTargets(DescribeAssociationExecutionTargetsRequest describeAssociationExecutionTargetsRequest) throws InternalServerErrorException, AssociationDoesNotExistException, InvalidNextTokenException, AssociationExecutionDoesNotExistException, AwsServiceException, SdkClientException, SsmException
Use this API action to view information about a specific execution of a specific association.
describeAssociationExecutionTargetsRequest
- InternalServerErrorException
- An error occurred on the server side.AssociationDoesNotExistException
- The specified association does not exist.InvalidNextTokenException
- The specified token is not valid.AssociationExecutionDoesNotExistException
- The specified execution ID does not exist. Verify the ID number and try again.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeAssociationExecutionTargetsResponse describeAssociationExecutionTargets(Consumer<DescribeAssociationExecutionTargetsRequest.Builder> describeAssociationExecutionTargetsRequest) throws InternalServerErrorException, AssociationDoesNotExistException, InvalidNextTokenException, AssociationExecutionDoesNotExistException, AwsServiceException, SdkClientException, SsmException
Use this API action to view information about a specific execution of a specific association.
This is a convenience which creates an instance of the DescribeAssociationExecutionTargetsRequest.Builder
avoiding the need to create one manually via DescribeAssociationExecutionTargetsRequest.builder()
describeAssociationExecutionTargetsRequest
- A Consumer
that will call methods on DescribeAssociationExecutionTargetsRequest.Builder
to
create a request.InternalServerErrorException
- An error occurred on the server side.AssociationDoesNotExistException
- The specified association does not exist.InvalidNextTokenException
- The specified token is not valid.AssociationExecutionDoesNotExistException
- The specified execution ID does not exist. Verify the ID number and try again.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeAssociationExecutionTargetsIterable describeAssociationExecutionTargetsPaginator(DescribeAssociationExecutionTargetsRequest describeAssociationExecutionTargetsRequest) throws InternalServerErrorException, AssociationDoesNotExistException, InvalidNextTokenException, AssociationExecutionDoesNotExistException, AwsServiceException, SdkClientException, SsmException
Use this API action to view information about a specific execution of a specific association.
This is a variant of
describeAssociationExecutionTargets(software.amazon.awssdk.services.ssm.model.DescribeAssociationExecutionTargetsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ssm.paginators.DescribeAssociationExecutionTargetsIterable responses = client.describeAssociationExecutionTargetsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.DescribeAssociationExecutionTargetsIterable responses = client .describeAssociationExecutionTargetsPaginator(request); for (software.amazon.awssdk.services.ssm.model.DescribeAssociationExecutionTargetsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.DescribeAssociationExecutionTargetsIterable responses = client.describeAssociationExecutionTargetsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeAssociationExecutionTargets(software.amazon.awssdk.services.ssm.model.DescribeAssociationExecutionTargetsRequest)
operation.
describeAssociationExecutionTargetsRequest
- InternalServerErrorException
- An error occurred on the server side.AssociationDoesNotExistException
- The specified association does not exist.InvalidNextTokenException
- The specified token is not valid.AssociationExecutionDoesNotExistException
- The specified execution ID does not exist. Verify the ID number and try again.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeAssociationExecutionTargetsIterable describeAssociationExecutionTargetsPaginator(Consumer<DescribeAssociationExecutionTargetsRequest.Builder> describeAssociationExecutionTargetsRequest) throws InternalServerErrorException, AssociationDoesNotExistException, InvalidNextTokenException, AssociationExecutionDoesNotExistException, AwsServiceException, SdkClientException, SsmException
Use this API action to view information about a specific execution of a specific association.
This is a variant of
describeAssociationExecutionTargets(software.amazon.awssdk.services.ssm.model.DescribeAssociationExecutionTargetsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ssm.paginators.DescribeAssociationExecutionTargetsIterable responses = client.describeAssociationExecutionTargetsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.DescribeAssociationExecutionTargetsIterable responses = client .describeAssociationExecutionTargetsPaginator(request); for (software.amazon.awssdk.services.ssm.model.DescribeAssociationExecutionTargetsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.DescribeAssociationExecutionTargetsIterable responses = client.describeAssociationExecutionTargetsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeAssociationExecutionTargets(software.amazon.awssdk.services.ssm.model.DescribeAssociationExecutionTargetsRequest)
operation.
This is a convenience which creates an instance of the DescribeAssociationExecutionTargetsRequest.Builder
avoiding the need to create one manually via DescribeAssociationExecutionTargetsRequest.builder()
describeAssociationExecutionTargetsRequest
- A Consumer
that will call methods on DescribeAssociationExecutionTargetsRequest.Builder
to
create a request.InternalServerErrorException
- An error occurred on the server side.AssociationDoesNotExistException
- The specified association does not exist.InvalidNextTokenException
- The specified token is not valid.AssociationExecutionDoesNotExistException
- The specified execution ID does not exist. Verify the ID number and try again.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeAssociationExecutionsResponse describeAssociationExecutions(DescribeAssociationExecutionsRequest describeAssociationExecutionsRequest) throws InternalServerErrorException, AssociationDoesNotExistException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Use this API action to view all executions for a specific association ID.
describeAssociationExecutionsRequest
- InternalServerErrorException
- An error occurred on the server side.AssociationDoesNotExistException
- The specified association does not exist.InvalidNextTokenException
- The specified token is not valid.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeAssociationExecutionsResponse describeAssociationExecutions(Consumer<DescribeAssociationExecutionsRequest.Builder> describeAssociationExecutionsRequest) throws InternalServerErrorException, AssociationDoesNotExistException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Use this API action to view all executions for a specific association ID.
This is a convenience which creates an instance of the DescribeAssociationExecutionsRequest.Builder
avoiding the need to create one manually via DescribeAssociationExecutionsRequest.builder()
describeAssociationExecutionsRequest
- A Consumer
that will call methods on DescribeAssociationExecutionsRequest.Builder
to
create a request.InternalServerErrorException
- An error occurred on the server side.AssociationDoesNotExistException
- The specified association does not exist.InvalidNextTokenException
- The specified token is not valid.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeAssociationExecutionsIterable describeAssociationExecutionsPaginator(DescribeAssociationExecutionsRequest describeAssociationExecutionsRequest) throws InternalServerErrorException, AssociationDoesNotExistException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Use this API action to view all executions for a specific association ID.
This is a variant of
describeAssociationExecutions(software.amazon.awssdk.services.ssm.model.DescribeAssociationExecutionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ssm.paginators.DescribeAssociationExecutionsIterable responses = client.describeAssociationExecutionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.DescribeAssociationExecutionsIterable responses = client .describeAssociationExecutionsPaginator(request); for (software.amazon.awssdk.services.ssm.model.DescribeAssociationExecutionsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.DescribeAssociationExecutionsIterable responses = client.describeAssociationExecutionsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeAssociationExecutions(software.amazon.awssdk.services.ssm.model.DescribeAssociationExecutionsRequest)
operation.
describeAssociationExecutionsRequest
- InternalServerErrorException
- An error occurred on the server side.AssociationDoesNotExistException
- The specified association does not exist.InvalidNextTokenException
- The specified token is not valid.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeAssociationExecutionsIterable describeAssociationExecutionsPaginator(Consumer<DescribeAssociationExecutionsRequest.Builder> describeAssociationExecutionsRequest) throws InternalServerErrorException, AssociationDoesNotExistException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Use this API action to view all executions for a specific association ID.
This is a variant of
describeAssociationExecutions(software.amazon.awssdk.services.ssm.model.DescribeAssociationExecutionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ssm.paginators.DescribeAssociationExecutionsIterable responses = client.describeAssociationExecutionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.DescribeAssociationExecutionsIterable responses = client .describeAssociationExecutionsPaginator(request); for (software.amazon.awssdk.services.ssm.model.DescribeAssociationExecutionsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.DescribeAssociationExecutionsIterable responses = client.describeAssociationExecutionsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeAssociationExecutions(software.amazon.awssdk.services.ssm.model.DescribeAssociationExecutionsRequest)
operation.
This is a convenience which creates an instance of the DescribeAssociationExecutionsRequest.Builder
avoiding the need to create one manually via DescribeAssociationExecutionsRequest.builder()
describeAssociationExecutionsRequest
- A Consumer
that will call methods on DescribeAssociationExecutionsRequest.Builder
to
create a request.InternalServerErrorException
- An error occurred on the server side.AssociationDoesNotExistException
- The specified association does not exist.InvalidNextTokenException
- The specified token is not valid.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeAutomationExecutionsResponse describeAutomationExecutions() throws InvalidFilterKeyException, InvalidFilterValueException, InvalidNextTokenException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Provides details about all active and terminated Automation executions.
InvalidFilterKeyException
- The specified key is not valid.InvalidFilterValueException
- The filter value is not valid. Verify the value and try again.InvalidNextTokenException
- The specified token is not valid.InternalServerErrorException
- An error occurred on the server side.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeAutomationExecutions(DescribeAutomationExecutionsRequest)
,
AWS API Documentationdefault DescribeAutomationExecutionsResponse describeAutomationExecutions(DescribeAutomationExecutionsRequest describeAutomationExecutionsRequest) throws InvalidFilterKeyException, InvalidFilterValueException, InvalidNextTokenException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Provides details about all active and terminated Automation executions.
describeAutomationExecutionsRequest
- InvalidFilterKeyException
- The specified key is not valid.InvalidFilterValueException
- The filter value is not valid. Verify the value and try again.InvalidNextTokenException
- The specified token is not valid.InternalServerErrorException
- An error occurred on the server side.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeAutomationExecutionsResponse describeAutomationExecutions(Consumer<DescribeAutomationExecutionsRequest.Builder> describeAutomationExecutionsRequest) throws InvalidFilterKeyException, InvalidFilterValueException, InvalidNextTokenException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Provides details about all active and terminated Automation executions.
This is a convenience which creates an instance of the DescribeAutomationExecutionsRequest.Builder
avoiding the need to create one manually via DescribeAutomationExecutionsRequest.builder()
describeAutomationExecutionsRequest
- A Consumer
that will call methods on DescribeAutomationExecutionsRequest.Builder
to create
a request.InvalidFilterKeyException
- The specified key is not valid.InvalidFilterValueException
- The filter value is not valid. Verify the value and try again.InvalidNextTokenException
- The specified token is not valid.InternalServerErrorException
- An error occurred on the server side.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeAutomationExecutionsIterable describeAutomationExecutionsPaginator() throws InvalidFilterKeyException, InvalidFilterValueException, InvalidNextTokenException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Provides details about all active and terminated Automation executions.
This is a variant of
describeAutomationExecutions(software.amazon.awssdk.services.ssm.model.DescribeAutomationExecutionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ssm.paginators.DescribeAutomationExecutionsIterable responses = client.describeAutomationExecutionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.DescribeAutomationExecutionsIterable responses = client .describeAutomationExecutionsPaginator(request); for (software.amazon.awssdk.services.ssm.model.DescribeAutomationExecutionsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.DescribeAutomationExecutionsIterable responses = client.describeAutomationExecutionsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeAutomationExecutions(software.amazon.awssdk.services.ssm.model.DescribeAutomationExecutionsRequest)
operation.
InvalidFilterKeyException
- The specified key is not valid.InvalidFilterValueException
- The filter value is not valid. Verify the value and try again.InvalidNextTokenException
- The specified token is not valid.InternalServerErrorException
- An error occurred on the server side.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeAutomationExecutionsPaginator(DescribeAutomationExecutionsRequest)
,
AWS API Documentationdefault DescribeAutomationExecutionsIterable describeAutomationExecutionsPaginator(DescribeAutomationExecutionsRequest describeAutomationExecutionsRequest) throws InvalidFilterKeyException, InvalidFilterValueException, InvalidNextTokenException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Provides details about all active and terminated Automation executions.
This is a variant of
describeAutomationExecutions(software.amazon.awssdk.services.ssm.model.DescribeAutomationExecutionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ssm.paginators.DescribeAutomationExecutionsIterable responses = client.describeAutomationExecutionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.DescribeAutomationExecutionsIterable responses = client .describeAutomationExecutionsPaginator(request); for (software.amazon.awssdk.services.ssm.model.DescribeAutomationExecutionsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.DescribeAutomationExecutionsIterable responses = client.describeAutomationExecutionsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeAutomationExecutions(software.amazon.awssdk.services.ssm.model.DescribeAutomationExecutionsRequest)
operation.
describeAutomationExecutionsRequest
- InvalidFilterKeyException
- The specified key is not valid.InvalidFilterValueException
- The filter value is not valid. Verify the value and try again.InvalidNextTokenException
- The specified token is not valid.InternalServerErrorException
- An error occurred on the server side.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeAutomationExecutionsIterable describeAutomationExecutionsPaginator(Consumer<DescribeAutomationExecutionsRequest.Builder> describeAutomationExecutionsRequest) throws InvalidFilterKeyException, InvalidFilterValueException, InvalidNextTokenException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Provides details about all active and terminated Automation executions.
This is a variant of
describeAutomationExecutions(software.amazon.awssdk.services.ssm.model.DescribeAutomationExecutionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ssm.paginators.DescribeAutomationExecutionsIterable responses = client.describeAutomationExecutionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.DescribeAutomationExecutionsIterable responses = client .describeAutomationExecutionsPaginator(request); for (software.amazon.awssdk.services.ssm.model.DescribeAutomationExecutionsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.DescribeAutomationExecutionsIterable responses = client.describeAutomationExecutionsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeAutomationExecutions(software.amazon.awssdk.services.ssm.model.DescribeAutomationExecutionsRequest)
operation.
This is a convenience which creates an instance of the DescribeAutomationExecutionsRequest.Builder
avoiding the need to create one manually via DescribeAutomationExecutionsRequest.builder()
describeAutomationExecutionsRequest
- A Consumer
that will call methods on DescribeAutomationExecutionsRequest.Builder
to create
a request.InvalidFilterKeyException
- The specified key is not valid.InvalidFilterValueException
- The filter value is not valid. Verify the value and try again.InvalidNextTokenException
- The specified token is not valid.InternalServerErrorException
- An error occurred on the server side.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeAutomationStepExecutionsResponse describeAutomationStepExecutions(DescribeAutomationStepExecutionsRequest describeAutomationStepExecutionsRequest) throws AutomationExecutionNotFoundException, InvalidNextTokenException, InvalidFilterKeyException, InvalidFilterValueException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Information about all active and terminated step executions in an Automation workflow.
describeAutomationStepExecutionsRequest
- AutomationExecutionNotFoundException
- There is no automation execution information for the requested automation execution ID.InvalidNextTokenException
- The specified token is not valid.InvalidFilterKeyException
- The specified key is not valid.InvalidFilterValueException
- The filter value is not valid. Verify the value and try again.InternalServerErrorException
- An error occurred on the server side.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeAutomationStepExecutionsResponse describeAutomationStepExecutions(Consumer<DescribeAutomationStepExecutionsRequest.Builder> describeAutomationStepExecutionsRequest) throws AutomationExecutionNotFoundException, InvalidNextTokenException, InvalidFilterKeyException, InvalidFilterValueException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Information about all active and terminated step executions in an Automation workflow.
This is a convenience which creates an instance of the DescribeAutomationStepExecutionsRequest.Builder
avoiding the need to create one manually via DescribeAutomationStepExecutionsRequest.builder()
describeAutomationStepExecutionsRequest
- A Consumer
that will call methods on DescribeAutomationStepExecutionsRequest.Builder
to
create a request.AutomationExecutionNotFoundException
- There is no automation execution information for the requested automation execution ID.InvalidNextTokenException
- The specified token is not valid.InvalidFilterKeyException
- The specified key is not valid.InvalidFilterValueException
- The filter value is not valid. Verify the value and try again.InternalServerErrorException
- An error occurred on the server side.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeAutomationStepExecutionsIterable describeAutomationStepExecutionsPaginator(DescribeAutomationStepExecutionsRequest describeAutomationStepExecutionsRequest) throws AutomationExecutionNotFoundException, InvalidNextTokenException, InvalidFilterKeyException, InvalidFilterValueException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Information about all active and terminated step executions in an Automation workflow.
This is a variant of
describeAutomationStepExecutions(software.amazon.awssdk.services.ssm.model.DescribeAutomationStepExecutionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ssm.paginators.DescribeAutomationStepExecutionsIterable responses = client.describeAutomationStepExecutionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.DescribeAutomationStepExecutionsIterable responses = client .describeAutomationStepExecutionsPaginator(request); for (software.amazon.awssdk.services.ssm.model.DescribeAutomationStepExecutionsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.DescribeAutomationStepExecutionsIterable responses = client.describeAutomationStepExecutionsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeAutomationStepExecutions(software.amazon.awssdk.services.ssm.model.DescribeAutomationStepExecutionsRequest)
operation.
describeAutomationStepExecutionsRequest
- AutomationExecutionNotFoundException
- There is no automation execution information for the requested automation execution ID.InvalidNextTokenException
- The specified token is not valid.InvalidFilterKeyException
- The specified key is not valid.InvalidFilterValueException
- The filter value is not valid. Verify the value and try again.InternalServerErrorException
- An error occurred on the server side.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeAutomationStepExecutionsIterable describeAutomationStepExecutionsPaginator(Consumer<DescribeAutomationStepExecutionsRequest.Builder> describeAutomationStepExecutionsRequest) throws AutomationExecutionNotFoundException, InvalidNextTokenException, InvalidFilterKeyException, InvalidFilterValueException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Information about all active and terminated step executions in an Automation workflow.
This is a variant of
describeAutomationStepExecutions(software.amazon.awssdk.services.ssm.model.DescribeAutomationStepExecutionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ssm.paginators.DescribeAutomationStepExecutionsIterable responses = client.describeAutomationStepExecutionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.DescribeAutomationStepExecutionsIterable responses = client .describeAutomationStepExecutionsPaginator(request); for (software.amazon.awssdk.services.ssm.model.DescribeAutomationStepExecutionsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.DescribeAutomationStepExecutionsIterable responses = client.describeAutomationStepExecutionsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeAutomationStepExecutions(software.amazon.awssdk.services.ssm.model.DescribeAutomationStepExecutionsRequest)
operation.
This is a convenience which creates an instance of the DescribeAutomationStepExecutionsRequest.Builder
avoiding the need to create one manually via DescribeAutomationStepExecutionsRequest.builder()
describeAutomationStepExecutionsRequest
- A Consumer
that will call methods on DescribeAutomationStepExecutionsRequest.Builder
to
create a request.AutomationExecutionNotFoundException
- There is no automation execution information for the requested automation execution ID.InvalidNextTokenException
- The specified token is not valid.InvalidFilterKeyException
- The specified key is not valid.InvalidFilterValueException
- The filter value is not valid. Verify the value and try again.InternalServerErrorException
- An error occurred on the server side.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeAvailablePatchesResponse describeAvailablePatches() throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Lists all patches eligible to be included in a patch baseline.
InternalServerErrorException
- An error occurred on the server side.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeAvailablePatches(DescribeAvailablePatchesRequest)
,
AWS
API Documentationdefault DescribeAvailablePatchesResponse describeAvailablePatches(DescribeAvailablePatchesRequest describeAvailablePatchesRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Lists all patches eligible to be included in a patch baseline.
describeAvailablePatchesRequest
- InternalServerErrorException
- An error occurred on the server side.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeAvailablePatchesResponse describeAvailablePatches(Consumer<DescribeAvailablePatchesRequest.Builder> describeAvailablePatchesRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Lists all patches eligible to be included in a patch baseline.
This is a convenience which creates an instance of the DescribeAvailablePatchesRequest.Builder
avoiding
the need to create one manually via DescribeAvailablePatchesRequest.builder()
describeAvailablePatchesRequest
- A Consumer
that will call methods on DescribeAvailablePatchesRequest.Builder
to create a
request.InternalServerErrorException
- An error occurred on the server side.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeAvailablePatchesIterable describeAvailablePatchesPaginator() throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Lists all patches eligible to be included in a patch baseline.
This is a variant of
describeAvailablePatches(software.amazon.awssdk.services.ssm.model.DescribeAvailablePatchesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ssm.paginators.DescribeAvailablePatchesIterable responses = client.describeAvailablePatchesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.DescribeAvailablePatchesIterable responses = client .describeAvailablePatchesPaginator(request); for (software.amazon.awssdk.services.ssm.model.DescribeAvailablePatchesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.DescribeAvailablePatchesIterable responses = client.describeAvailablePatchesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeAvailablePatches(software.amazon.awssdk.services.ssm.model.DescribeAvailablePatchesRequest)
operation.
InternalServerErrorException
- An error occurred on the server side.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeAvailablePatchesPaginator(DescribeAvailablePatchesRequest)
,
AWS
API Documentationdefault DescribeAvailablePatchesIterable describeAvailablePatchesPaginator(DescribeAvailablePatchesRequest describeAvailablePatchesRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Lists all patches eligible to be included in a patch baseline.
This is a variant of
describeAvailablePatches(software.amazon.awssdk.services.ssm.model.DescribeAvailablePatchesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ssm.paginators.DescribeAvailablePatchesIterable responses = client.describeAvailablePatchesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.DescribeAvailablePatchesIterable responses = client .describeAvailablePatchesPaginator(request); for (software.amazon.awssdk.services.ssm.model.DescribeAvailablePatchesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.DescribeAvailablePatchesIterable responses = client.describeAvailablePatchesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeAvailablePatches(software.amazon.awssdk.services.ssm.model.DescribeAvailablePatchesRequest)
operation.
describeAvailablePatchesRequest
- InternalServerErrorException
- An error occurred on the server side.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeAvailablePatchesIterable describeAvailablePatchesPaginator(Consumer<DescribeAvailablePatchesRequest.Builder> describeAvailablePatchesRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Lists all patches eligible to be included in a patch baseline.
This is a variant of
describeAvailablePatches(software.amazon.awssdk.services.ssm.model.DescribeAvailablePatchesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ssm.paginators.DescribeAvailablePatchesIterable responses = client.describeAvailablePatchesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.DescribeAvailablePatchesIterable responses = client .describeAvailablePatchesPaginator(request); for (software.amazon.awssdk.services.ssm.model.DescribeAvailablePatchesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.DescribeAvailablePatchesIterable responses = client.describeAvailablePatchesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeAvailablePatches(software.amazon.awssdk.services.ssm.model.DescribeAvailablePatchesRequest)
operation.
This is a convenience which creates an instance of the DescribeAvailablePatchesRequest.Builder
avoiding
the need to create one manually via DescribeAvailablePatchesRequest.builder()
describeAvailablePatchesRequest
- A Consumer
that will call methods on DescribeAvailablePatchesRequest.Builder
to create a
request.InternalServerErrorException
- An error occurred on the server side.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDocumentResponse describeDocument(DescribeDocumentRequest describeDocumentRequest) throws InternalServerErrorException, InvalidDocumentException, InvalidDocumentVersionException, AwsServiceException, SdkClientException, SsmException
Describes the specified Systems Manager document.
describeDocumentRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidDocumentException
- The specified document does not exist.InvalidDocumentVersionException
- The document version is not valid or does not exist.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDocumentResponse describeDocument(Consumer<DescribeDocumentRequest.Builder> describeDocumentRequest) throws InternalServerErrorException, InvalidDocumentException, InvalidDocumentVersionException, AwsServiceException, SdkClientException, SsmException
Describes the specified Systems Manager document.
This is a convenience which creates an instance of the DescribeDocumentRequest.Builder
avoiding the need
to create one manually via DescribeDocumentRequest.builder()
describeDocumentRequest
- A Consumer
that will call methods on DescribeDocumentRequest.Builder
to create a request.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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDocumentPermissionResponse describeDocumentPermission(DescribeDocumentPermissionRequest describeDocumentPermissionRequest) throws InternalServerErrorException, InvalidDocumentException, InvalidNextTokenException, InvalidPermissionTypeException, InvalidDocumentOperationException, AwsServiceException, 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.InvalidNextTokenException
- The specified token is not valid.InvalidPermissionTypeException
- The permission type is not supported. Share is the only supported permission type.InvalidDocumentOperationException
- You attempted to delete a document while it is still shared. You must stop sharing the document before
you can delete it.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDocumentPermissionResponse describeDocumentPermission(Consumer<DescribeDocumentPermissionRequest.Builder> describeDocumentPermissionRequest) throws InternalServerErrorException, InvalidDocumentException, InvalidNextTokenException, InvalidPermissionTypeException, InvalidDocumentOperationException, AwsServiceException, 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).
This is a convenience which creates an instance of the DescribeDocumentPermissionRequest.Builder
avoiding
the need to create one manually via DescribeDocumentPermissionRequest.builder()
describeDocumentPermissionRequest
- A Consumer
that will call methods on DescribeDocumentPermissionRequest.Builder
to create a
request.InternalServerErrorException
- An error occurred on the server side.InvalidDocumentException
- The specified document does not exist.InvalidNextTokenException
- The specified token is not valid.InvalidPermissionTypeException
- The permission type is not supported. Share is the only supported permission type.InvalidDocumentOperationException
- You attempted to delete a document while it is still shared. You must stop sharing the document before
you can delete it.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeEffectiveInstanceAssociationsResponse describeEffectiveInstanceAssociations(DescribeEffectiveInstanceAssociationsRequest describeEffectiveInstanceAssociationsRequest) throws InternalServerErrorException, InvalidInstanceIdException, InvalidNextTokenException, AwsServiceException, 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.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeEffectiveInstanceAssociationsResponse describeEffectiveInstanceAssociations(Consumer<DescribeEffectiveInstanceAssociationsRequest.Builder> describeEffectiveInstanceAssociationsRequest) throws InternalServerErrorException, InvalidInstanceIdException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
All associations for the instance(s).
This is a convenience which creates an instance of the
DescribeEffectiveInstanceAssociationsRequest.Builder
avoiding the need to create one manually via
DescribeEffectiveInstanceAssociationsRequest.builder()
describeEffectiveInstanceAssociationsRequest
- A Consumer
that will call methods on DescribeEffectiveInstanceAssociationsRequest.Builder
to create a request.InternalServerErrorException
- An error occurred on the server side.InvalidInstanceIdException
- The following problems can cause this exception:
You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeEffectiveInstanceAssociationsIterable describeEffectiveInstanceAssociationsPaginator(DescribeEffectiveInstanceAssociationsRequest describeEffectiveInstanceAssociationsRequest) throws InternalServerErrorException, InvalidInstanceIdException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
All associations for the instance(s).
This is a variant of
describeEffectiveInstanceAssociations(software.amazon.awssdk.services.ssm.model.DescribeEffectiveInstanceAssociationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ssm.paginators.DescribeEffectiveInstanceAssociationsIterable responses = client.describeEffectiveInstanceAssociationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.DescribeEffectiveInstanceAssociationsIterable responses = client .describeEffectiveInstanceAssociationsPaginator(request); for (software.amazon.awssdk.services.ssm.model.DescribeEffectiveInstanceAssociationsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.DescribeEffectiveInstanceAssociationsIterable responses = client.describeEffectiveInstanceAssociationsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeEffectiveInstanceAssociations(software.amazon.awssdk.services.ssm.model.DescribeEffectiveInstanceAssociationsRequest)
operation.
describeEffectiveInstanceAssociationsRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidInstanceIdException
- The following problems can cause this exception:
You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeEffectiveInstanceAssociationsIterable describeEffectiveInstanceAssociationsPaginator(Consumer<DescribeEffectiveInstanceAssociationsRequest.Builder> describeEffectiveInstanceAssociationsRequest) throws InternalServerErrorException, InvalidInstanceIdException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
All associations for the instance(s).
This is a variant of
describeEffectiveInstanceAssociations(software.amazon.awssdk.services.ssm.model.DescribeEffectiveInstanceAssociationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ssm.paginators.DescribeEffectiveInstanceAssociationsIterable responses = client.describeEffectiveInstanceAssociationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.DescribeEffectiveInstanceAssociationsIterable responses = client .describeEffectiveInstanceAssociationsPaginator(request); for (software.amazon.awssdk.services.ssm.model.DescribeEffectiveInstanceAssociationsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.DescribeEffectiveInstanceAssociationsIterable responses = client.describeEffectiveInstanceAssociationsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeEffectiveInstanceAssociations(software.amazon.awssdk.services.ssm.model.DescribeEffectiveInstanceAssociationsRequest)
operation.
This is a convenience which creates an instance of the
DescribeEffectiveInstanceAssociationsRequest.Builder
avoiding the need to create one manually via
DescribeEffectiveInstanceAssociationsRequest.builder()
describeEffectiveInstanceAssociationsRequest
- A Consumer
that will call methods on DescribeEffectiveInstanceAssociationsRequest.Builder
to create a request.InternalServerErrorException
- An error occurred on the server side.InvalidInstanceIdException
- The following problems can cause this exception:
You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeEffectivePatchesForPatchBaselineResponse describeEffectivePatchesForPatchBaseline(DescribeEffectivePatchesForPatchBaselineRequest describeEffectivePatchesForPatchBaselineRequest) throws InvalidResourceIdException, DoesNotExistException, UnsupportedOperatingSystemException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline. Note that this API applies only to Windows patch baselines.
describeEffectivePatchesForPatchBaselineRequest
- InvalidResourceIdException
- The resource ID is not valid. Verify that you entered the correct ID and try again.DoesNotExistException
- Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline,
doesn't exist.
For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
UnsupportedOperatingSystemException
- The operating systems you specified is not supported, or the operation is not supported for the operating
system.InternalServerErrorException
- An error occurred on the server side.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeEffectivePatchesForPatchBaselineResponse describeEffectivePatchesForPatchBaseline(Consumer<DescribeEffectivePatchesForPatchBaselineRequest.Builder> describeEffectivePatchesForPatchBaselineRequest) throws InvalidResourceIdException, DoesNotExistException, UnsupportedOperatingSystemException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline. Note that this API applies only to Windows patch baselines.
This is a convenience which creates an instance of the
DescribeEffectivePatchesForPatchBaselineRequest.Builder
avoiding the need to create one manually via
DescribeEffectivePatchesForPatchBaselineRequest.builder()
describeEffectivePatchesForPatchBaselineRequest
- A Consumer
that will call methods on
DescribeEffectivePatchesForPatchBaselineRequest.Builder
to create a request.InvalidResourceIdException
- The resource ID is not valid. Verify that you entered the correct ID and try again.DoesNotExistException
- Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline,
doesn't exist.
For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
UnsupportedOperatingSystemException
- The operating systems you specified is not supported, or the operation is not supported for the operating
system.InternalServerErrorException
- An error occurred on the server side.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeEffectivePatchesForPatchBaselineIterable describeEffectivePatchesForPatchBaselinePaginator(DescribeEffectivePatchesForPatchBaselineRequest describeEffectivePatchesForPatchBaselineRequest) throws InvalidResourceIdException, DoesNotExistException, UnsupportedOperatingSystemException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline. Note that this API applies only to Windows patch baselines.
This is a variant of
describeEffectivePatchesForPatchBaseline(software.amazon.awssdk.services.ssm.model.DescribeEffectivePatchesForPatchBaselineRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ssm.paginators.DescribeEffectivePatchesForPatchBaselineIterable responses = client.describeEffectivePatchesForPatchBaselinePaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.DescribeEffectivePatchesForPatchBaselineIterable responses = client .describeEffectivePatchesForPatchBaselinePaginator(request); for (software.amazon.awssdk.services.ssm.model.DescribeEffectivePatchesForPatchBaselineResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.DescribeEffectivePatchesForPatchBaselineIterable responses = client.describeEffectivePatchesForPatchBaselinePaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeEffectivePatchesForPatchBaseline(software.amazon.awssdk.services.ssm.model.DescribeEffectivePatchesForPatchBaselineRequest)
operation.
describeEffectivePatchesForPatchBaselineRequest
- InvalidResourceIdException
- The resource ID is not valid. Verify that you entered the correct ID and try again.DoesNotExistException
- Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline,
doesn't exist.
For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
UnsupportedOperatingSystemException
- The operating systems you specified is not supported, or the operation is not supported for the operating
system.InternalServerErrorException
- An error occurred on the server side.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeEffectivePatchesForPatchBaselineIterable describeEffectivePatchesForPatchBaselinePaginator(Consumer<DescribeEffectivePatchesForPatchBaselineRequest.Builder> describeEffectivePatchesForPatchBaselineRequest) throws InvalidResourceIdException, DoesNotExistException, UnsupportedOperatingSystemException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline. Note that this API applies only to Windows patch baselines.
This is a variant of
describeEffectivePatchesForPatchBaseline(software.amazon.awssdk.services.ssm.model.DescribeEffectivePatchesForPatchBaselineRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ssm.paginators.DescribeEffectivePatchesForPatchBaselineIterable responses = client.describeEffectivePatchesForPatchBaselinePaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.DescribeEffectivePatchesForPatchBaselineIterable responses = client .describeEffectivePatchesForPatchBaselinePaginator(request); for (software.amazon.awssdk.services.ssm.model.DescribeEffectivePatchesForPatchBaselineResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.DescribeEffectivePatchesForPatchBaselineIterable responses = client.describeEffectivePatchesForPatchBaselinePaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeEffectivePatchesForPatchBaseline(software.amazon.awssdk.services.ssm.model.DescribeEffectivePatchesForPatchBaselineRequest)
operation.
This is a convenience which creates an instance of the
DescribeEffectivePatchesForPatchBaselineRequest.Builder
avoiding the need to create one manually via
DescribeEffectivePatchesForPatchBaselineRequest.builder()
describeEffectivePatchesForPatchBaselineRequest
- A Consumer
that will call methods on
DescribeEffectivePatchesForPatchBaselineRequest.Builder
to create a request.InvalidResourceIdException
- The resource ID is not valid. Verify that you entered the correct ID and try again.DoesNotExistException
- Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline,
doesn't exist.
For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
UnsupportedOperatingSystemException
- The operating systems you specified is not supported, or the operation is not supported for the operating
system.InternalServerErrorException
- An error occurred on the server side.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeInstanceAssociationsStatusResponse describeInstanceAssociationsStatus(DescribeInstanceAssociationsStatusRequest describeInstanceAssociationsStatusRequest) throws InternalServerErrorException, InvalidInstanceIdException, InvalidNextTokenException, AwsServiceException, 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.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeInstanceAssociationsStatusResponse describeInstanceAssociationsStatus(Consumer<DescribeInstanceAssociationsStatusRequest.Builder> describeInstanceAssociationsStatusRequest) throws InternalServerErrorException, InvalidInstanceIdException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
The status of the associations for the instance(s).
This is a convenience which creates an instance of the DescribeInstanceAssociationsStatusRequest.Builder
avoiding the need to create one manually via DescribeInstanceAssociationsStatusRequest.builder()
describeInstanceAssociationsStatusRequest
- A Consumer
that will call methods on DescribeInstanceAssociationsStatusRequest.Builder
to
create a request.InternalServerErrorException
- An error occurred on the server side.InvalidInstanceIdException
- The following problems can cause this exception:
You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeInstanceAssociationsStatusIterable describeInstanceAssociationsStatusPaginator(DescribeInstanceAssociationsStatusRequest describeInstanceAssociationsStatusRequest) throws InternalServerErrorException, InvalidInstanceIdException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
The status of the associations for the instance(s).
This is a variant of
describeInstanceAssociationsStatus(software.amazon.awssdk.services.ssm.model.DescribeInstanceAssociationsStatusRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ssm.paginators.DescribeInstanceAssociationsStatusIterable responses = client.describeInstanceAssociationsStatusPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.DescribeInstanceAssociationsStatusIterable responses = client .describeInstanceAssociationsStatusPaginator(request); for (software.amazon.awssdk.services.ssm.model.DescribeInstanceAssociationsStatusResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.DescribeInstanceAssociationsStatusIterable responses = client.describeInstanceAssociationsStatusPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeInstanceAssociationsStatus(software.amazon.awssdk.services.ssm.model.DescribeInstanceAssociationsStatusRequest)
operation.
describeInstanceAssociationsStatusRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidInstanceIdException
- The following problems can cause this exception:
You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeInstanceAssociationsStatusIterable describeInstanceAssociationsStatusPaginator(Consumer<DescribeInstanceAssociationsStatusRequest.Builder> describeInstanceAssociationsStatusRequest) throws InternalServerErrorException, InvalidInstanceIdException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
The status of the associations for the instance(s).
This is a variant of
describeInstanceAssociationsStatus(software.amazon.awssdk.services.ssm.model.DescribeInstanceAssociationsStatusRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ssm.paginators.DescribeInstanceAssociationsStatusIterable responses = client.describeInstanceAssociationsStatusPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.DescribeInstanceAssociationsStatusIterable responses = client .describeInstanceAssociationsStatusPaginator(request); for (software.amazon.awssdk.services.ssm.model.DescribeInstanceAssociationsStatusResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.DescribeInstanceAssociationsStatusIterable responses = client.describeInstanceAssociationsStatusPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeInstanceAssociationsStatus(software.amazon.awssdk.services.ssm.model.DescribeInstanceAssociationsStatusRequest)
operation.
This is a convenience which creates an instance of the DescribeInstanceAssociationsStatusRequest.Builder
avoiding the need to create one manually via DescribeInstanceAssociationsStatusRequest.builder()
describeInstanceAssociationsStatusRequest
- A Consumer
that will call methods on DescribeInstanceAssociationsStatusRequest.Builder
to
create a request.InternalServerErrorException
- An error occurred on the server side.InvalidInstanceIdException
- The following problems can cause this exception:
You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeInstanceInformationResponse describeInstanceInformation() throws InternalServerErrorException, InvalidInstanceIdException, InvalidNextTokenException, InvalidInstanceInformationFilterValueException, InvalidFilterKeyException, AwsServiceException, SdkClientException, SsmException
Describes one or more of your instances, including information about the operating system platform, the version of SSM Agent installed on the instance, instance status, and so on.
If you specify one or more instance IDs, it returns information for those instances. If you do not specify instance IDs, it returns information for all your instances. If you specify an instance ID that is not valid or an instance that you do not own, you receive an error.
The IamRole field for this API action is the Amazon Identity and Access Management (IAM) role assigned to on-premises instances. This call does not return the IAM role for EC2 instances.
InternalServerErrorException
- An error occurred on the server side.InvalidInstanceIdException
- The following problems can cause this exception:
You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeInstanceInformation(DescribeInstanceInformationRequest)
,
AWS API Documentationdefault DescribeInstanceInformationResponse describeInstanceInformation(DescribeInstanceInformationRequest describeInstanceInformationRequest) throws InternalServerErrorException, InvalidInstanceIdException, InvalidNextTokenException, InvalidInstanceInformationFilterValueException, InvalidFilterKeyException, AwsServiceException, SdkClientException, SsmException
Describes one or more of your instances, including information about the operating system platform, the version of SSM Agent installed on the instance, instance status, and so on.
If you specify one or more instance IDs, it returns information for those instances. If you do not specify instance IDs, it returns information for all your instances. If you specify an instance ID that is not valid or an instance that you do not own, you receive an error.
The IamRole field for this API action is the Amazon Identity and Access Management (IAM) role assigned to on-premises instances. This call does not return the IAM role for EC2 instances.
describeInstanceInformationRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidInstanceIdException
- The following problems can cause this exception:
You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeInstanceInformationResponse describeInstanceInformation(Consumer<DescribeInstanceInformationRequest.Builder> describeInstanceInformationRequest) throws InternalServerErrorException, InvalidInstanceIdException, InvalidNextTokenException, InvalidInstanceInformationFilterValueException, InvalidFilterKeyException, AwsServiceException, SdkClientException, SsmException
Describes one or more of your instances, including information about the operating system platform, the version of SSM Agent installed on the instance, instance status, and so on.
If you specify one or more instance IDs, it returns information for those instances. If you do not specify instance IDs, it returns information for all your instances. If you specify an instance ID that is not valid or an instance that you do not own, you receive an error.
The IamRole field for this API action is the Amazon Identity and Access Management (IAM) role assigned to on-premises instances. This call does not return the IAM role for EC2 instances.
This is a convenience which creates an instance of the DescribeInstanceInformationRequest.Builder
avoiding the need to create one manually via DescribeInstanceInformationRequest.builder()
describeInstanceInformationRequest
- A Consumer
that will call methods on DescribeInstanceInformationRequest.Builder
to create
a request.InternalServerErrorException
- An error occurred on the server side.InvalidInstanceIdException
- The following problems can cause this exception:
You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeInstanceInformationIterable describeInstanceInformationPaginator() throws InternalServerErrorException, InvalidInstanceIdException, InvalidNextTokenException, InvalidInstanceInformationFilterValueException, InvalidFilterKeyException, AwsServiceException, SdkClientException, SsmException
Describes one or more of your instances, including information about the operating system platform, the version of SSM Agent installed on the instance, instance status, and so on.
If you specify one or more instance IDs, it returns information for those instances. If you do not specify instance IDs, it returns information for all your instances. If you specify an instance ID that is not valid or an instance that you do not own, you receive an error.
The IamRole field for this API action is the Amazon Identity and Access Management (IAM) role assigned to on-premises instances. This call does not return the IAM role for EC2 instances.
This is a variant of
describeInstanceInformation(software.amazon.awssdk.services.ssm.model.DescribeInstanceInformationRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ssm.paginators.DescribeInstanceInformationIterable responses = client.describeInstanceInformationPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.DescribeInstanceInformationIterable responses = client .describeInstanceInformationPaginator(request); for (software.amazon.awssdk.services.ssm.model.DescribeInstanceInformationResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.DescribeInstanceInformationIterable responses = client.describeInstanceInformationPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeInstanceInformation(software.amazon.awssdk.services.ssm.model.DescribeInstanceInformationRequest)
operation.
InternalServerErrorException
- An error occurred on the server side.InvalidInstanceIdException
- The following problems can cause this exception:
You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeInstanceInformationPaginator(DescribeInstanceInformationRequest)
,
AWS API Documentationdefault DescribeInstanceInformationIterable describeInstanceInformationPaginator(DescribeInstanceInformationRequest describeInstanceInformationRequest) throws InternalServerErrorException, InvalidInstanceIdException, InvalidNextTokenException, InvalidInstanceInformationFilterValueException, InvalidFilterKeyException, AwsServiceException, SdkClientException, SsmException
Describes one or more of your instances, including information about the operating system platform, the version of SSM Agent installed on the instance, instance status, and so on.
If you specify one or more instance IDs, it returns information for those instances. If you do not specify instance IDs, it returns information for all your instances. If you specify an instance ID that is not valid or an instance that you do not own, you receive an error.
The IamRole field for this API action is the Amazon Identity and Access Management (IAM) role assigned to on-premises instances. This call does not return the IAM role for EC2 instances.
This is a variant of
describeInstanceInformation(software.amazon.awssdk.services.ssm.model.DescribeInstanceInformationRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ssm.paginators.DescribeInstanceInformationIterable responses = client.describeInstanceInformationPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.DescribeInstanceInformationIterable responses = client .describeInstanceInformationPaginator(request); for (software.amazon.awssdk.services.ssm.model.DescribeInstanceInformationResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.DescribeInstanceInformationIterable responses = client.describeInstanceInformationPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeInstanceInformation(software.amazon.awssdk.services.ssm.model.DescribeInstanceInformationRequest)
operation.
describeInstanceInformationRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidInstanceIdException
- The following problems can cause this exception:
You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeInstanceInformationIterable describeInstanceInformationPaginator(Consumer<DescribeInstanceInformationRequest.Builder> describeInstanceInformationRequest) throws InternalServerErrorException, InvalidInstanceIdException, InvalidNextTokenException, InvalidInstanceInformationFilterValueException, InvalidFilterKeyException, AwsServiceException, SdkClientException, SsmException
Describes one or more of your instances, including information about the operating system platform, the version of SSM Agent installed on the instance, instance status, and so on.
If you specify one or more instance IDs, it returns information for those instances. If you do not specify instance IDs, it returns information for all your instances. If you specify an instance ID that is not valid or an instance that you do not own, you receive an error.
The IamRole field for this API action is the Amazon Identity and Access Management (IAM) role assigned to on-premises instances. This call does not return the IAM role for EC2 instances.
This is a variant of
describeInstanceInformation(software.amazon.awssdk.services.ssm.model.DescribeInstanceInformationRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ssm.paginators.DescribeInstanceInformationIterable responses = client.describeInstanceInformationPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.DescribeInstanceInformationIterable responses = client .describeInstanceInformationPaginator(request); for (software.amazon.awssdk.services.ssm.model.DescribeInstanceInformationResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.DescribeInstanceInformationIterable responses = client.describeInstanceInformationPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeInstanceInformation(software.amazon.awssdk.services.ssm.model.DescribeInstanceInformationRequest)
operation.
This is a convenience which creates an instance of the DescribeInstanceInformationRequest.Builder
avoiding the need to create one manually via DescribeInstanceInformationRequest.builder()
describeInstanceInformationRequest
- A Consumer
that will call methods on DescribeInstanceInformationRequest.Builder
to create
a request.InternalServerErrorException
- An error occurred on the server side.InvalidInstanceIdException
- The following problems can cause this exception:
You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeInstancePatchStatesResponse describeInstancePatchStates(DescribeInstancePatchStatesRequest describeInstancePatchStatesRequest) throws InternalServerErrorException,