@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_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 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 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 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)
Query a list of all parameters used by the AWS account.
|
default GetParameterHistoryResponse |
getParameterHistory(GetParameterHistoryRequest getParameterHistoryRequest)
Query a list of all parameters used by the AWS account.
|
default GetParameterHistoryIterable |
getParameterHistoryPaginator(Consumer<GetParameterHistoryRequest.Builder> getParameterHistoryRequest)
Query a list of all parameters used by the AWS account.
|
default GetParameterHistoryIterable |
getParameterHistoryPaginator(GetParameterHistoryRequest getParameterHistoryRequest)
Query a list of all parameters used by the AWS account.
|
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 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 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 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 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 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 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. |
serviceName
close
static final String SERVICE_NAME
static SsmClient create()
SsmClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static SsmClientBuilder builder()
SsmClient
.default AddTagsToResourceResponse addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest) throws InvalidResourceTypeException, InvalidResourceIdException, InternalServerErrorException, TooManyTagsErrorException, 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 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 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, InvalidPermissionTypeException, 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.InvalidPermissionTypeException
- The permission type is not supported. Share is the only supported permission type.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, InvalidPermissionTypeException, 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.InvalidPermissionTypeException
- The permission type is not supported. Share is the only supported permission type.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. Valid operating systems include: Windows, AmazonLinux, RedhatEnterpriseLinux, and Ubuntu.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. Valid operating systems include: Windows, AmazonLinux, RedhatEnterpriseLinux, and Ubuntu.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. Valid operating systems include: Windows, AmazonLinux, RedhatEnterpriseLinux, and Ubuntu.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. Valid operating systems include: Windows, AmazonLinux, RedhatEnterpriseLinux, and Ubuntu.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, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Retrieves the high-level patch state of one or more instances.
describeInstancePatchStatesRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidNextTokenException
- The specified token is not valid.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(Consumer<DescribeInstancePatchStatesRequest.Builder> describeInstancePatchStatesRequest) throws InternalServerErrorException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Retrieves the high-level patch state of one or more instances.
This is a convenience which creates an instance of the DescribeInstancePatchStatesRequest.Builder
avoiding the need to create one manually via DescribeInstancePatchStatesRequest.builder()
describeInstancePatchStatesRequest
- A Consumer
that will call methods on DescribeInstancePatchStatesRequest.Builder
to create
a request.InternalServerErrorException
- An error occurred on the server side.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 DescribeInstancePatchStatesIterable describeInstancePatchStatesPaginator(DescribeInstancePatchStatesRequest describeInstancePatchStatesRequest) throws InternalServerErrorException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Retrieves the high-level patch state of one or more instances.
This is a variant of
describeInstancePatchStates(software.amazon.awssdk.services.ssm.model.DescribeInstancePatchStatesRequest)
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.DescribeInstancePatchStatesIterable responses = client.describeInstancePatchStatesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.DescribeInstancePatchStatesIterable responses = client .describeInstancePatchStatesPaginator(request); for (software.amazon.awssdk.services.ssm.model.DescribeInstancePatchStatesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.DescribeInstancePatchStatesIterable responses = client.describeInstancePatchStatesPaginator(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
describeInstancePatchStates(software.amazon.awssdk.services.ssm.model.DescribeInstancePatchStatesRequest)
operation.
describeInstancePatchStatesRequest
- InternalServerErrorException
- An error occurred on the server side.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 DescribeInstancePatchStatesIterable describeInstancePatchStatesPaginator(Consumer<DescribeInstancePatchStatesRequest.Builder> describeInstancePatchStatesRequest) throws InternalServerErrorException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Retrieves the high-level patch state of one or more instances.
This is a variant of
describeInstancePatchStates(software.amazon.awssdk.services.ssm.model.DescribeInstancePatchStatesRequest)
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.DescribeInstancePatchStatesIterable responses = client.describeInstancePatchStatesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.DescribeInstancePatchStatesIterable responses = client .describeInstancePatchStatesPaginator(request); for (software.amazon.awssdk.services.ssm.model.DescribeInstancePatchStatesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.DescribeInstancePatchStatesIterable responses = client.describeInstancePatchStatesPaginator(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
describeInstancePatchStates(software.amazon.awssdk.services.ssm.model.DescribeInstancePatchStatesRequest)
operation.
This is a convenience which creates an instance of the DescribeInstancePatchStatesRequest.Builder
avoiding the need to create one manually via DescribeInstancePatchStatesRequest.builder()
describeInstancePatchStatesRequest
- A Consumer
that will call methods on DescribeInstancePatchStatesRequest.Builder
to create
a request.InternalServerErrorException
- An error occurred on the server side.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 DescribeInstancePatchStatesForPatchGroupResponse describeInstancePatchStatesForPatchGroup(DescribeInstancePatchStatesForPatchGroupRequest describeInstancePatchStatesForPatchGroupRequest) throws InternalServerErrorException, InvalidFilterException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Retrieves the high-level patch state for the instances in the specified patch group.
describeInstancePatchStatesForPatchGroupRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidFilterException
- The filter name is not valid. Verify the you entered the correct name and try again.InvalidNextTokenException
- The specified token is not valid.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 DescribeInstancePatchStatesForPatchGroupResponse describeInstancePatchStatesForPatchGroup(Consumer<DescribeInstancePatchStatesForPatchGroupRequest.Builder> describeInstancePatchStatesForPatchGroupRequest) throws InternalServerErrorException, InvalidFilterException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Retrieves the high-level patch state for the instances in the specified patch group.
This is a convenience which creates an instance of the
DescribeInstancePatchStatesForPatchGroupRequest.Builder
avoiding the need to create one manually via
DescribeInstancePatchStatesForPatchGroupRequest.builder()
describeInstancePatchStatesForPatchGroupRequest
- A Consumer
that will call methods on
DescribeInstancePatchStatesForPatchGroupRequest.Builder
to create a request.InternalServerErrorException
- An error occurred on the server side.InvalidFilterException
- The filter name is not valid. Verify the you entered the correct name and try again.InvalidNextTokenException
- The specified token is not valid.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 DescribeInstancePatchStatesForPatchGroupIterable describeInstancePatchStatesForPatchGroupPaginator(DescribeInstancePatchStatesForPatchGroupRequest describeInstancePatchStatesForPatchGroupRequest) throws InternalServerErrorException, InvalidFilterException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Retrieves the high-level patch state for the instances in the specified patch group.
This is a variant of
describeInstancePatchStatesForPatchGroup(software.amazon.awssdk.services.ssm.model.DescribeInstancePatchStatesForPatchGroupRequest)
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.DescribeInstancePatchStatesForPatchGroupIterable responses = client.describeInstancePatchStatesForPatchGroupPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.DescribeInstancePatchStatesForPatchGroupIterable responses = client .describeInstancePatchStatesForPatchGroupPaginator(request); for (software.amazon.awssdk.services.ssm.model.DescribeInstancePatchStatesForPatchGroupResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.DescribeInstancePatchStatesForPatchGroupIterable responses = client.describeInstancePatchStatesForPatchGroupPaginator(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
describeInstancePatchStatesForPatchGroup(software.amazon.awssdk.services.ssm.model.DescribeInstancePatchStatesForPatchGroupRequest)
operation.
describeInstancePatchStatesForPatchGroupRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidFilterException
- The filter name is not valid. Verify the you entered the correct name and try again.InvalidNextTokenException
- The specified token is not valid.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 DescribeInstancePatchStatesForPatchGroupIterable describeInstancePatchStatesForPatchGroupPaginator(Consumer<DescribeInstancePatchStatesForPatchGroupRequest.Builder> describeInstancePatchStatesForPatchGroupRequest) throws InternalServerErrorException, InvalidFilterException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Retrieves the high-level patch state for the instances in the specified patch group.
This is a variant of
describeInstancePatchStatesForPatchGroup(software.amazon.awssdk.services.ssm.model.DescribeInstancePatchStatesForPatchGroupRequest)
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.DescribeInstancePatchStatesForPatchGroupIterable responses = client.describeInstancePatchStatesForPatchGroupPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.DescribeInstancePatchStatesForPatchGroupIterable responses = client .describeInstancePatchStatesForPatchGroupPaginator(request); for (software.amazon.awssdk.services.ssm.model.DescribeInstancePatchStatesForPatchGroupResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.DescribeInstancePatchStatesForPatchGroupIterable responses = client.describeInstancePatchStatesForPatchGroupPaginator(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
describeInstancePatchStatesForPatchGroup(software.amazon.awssdk.services.ssm.model.DescribeInstancePatchStatesForPatchGroupRequest)
operation.
This is a convenience which creates an instance of the
DescribeInstancePatchStatesForPatchGroupRequest.Builder
avoiding the need to create one manually via
DescribeInstancePatchStatesForPatchGroupRequest.builder()
describeInstancePatchStatesForPatchGroupRequest
- A Consumer
that will call methods on
DescribeInstancePatchStatesForPatchGroupRequest.Builder
to create a request.InternalServerErrorException
- An error occurred on the server side.InvalidFilterException
- The filter name is not valid. Verify the you entered the correct name and try again.InvalidNextTokenException
- The specified token is not valid.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 DescribeInstancePatchesResponse describeInstancePatches(DescribeInstancePatchesRequest describeInstancePatchesRequest) throws InternalServerErrorException, InvalidInstanceIdException, InvalidFilterException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Retrieves information about the patches on the specified instance and their state relative to the patch baseline being used for the instance.
describeInstancePatchesRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidInstanceIdException
- The following problems can cause this exception:
You do not have permission to access the instance.
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.
InvalidFilterException
- The filter name is not valid. Verify the you entered the correct name and try again.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 DescribeInstancePatchesResponse describeInstancePatches(Consumer<DescribeInstancePatchesRequest.Builder> describeInstancePatchesRequest) throws InternalServerErrorException, InvalidInstanceIdException, InvalidFilterException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Retrieves information about the patches on the specified instance and their state relative to the patch baseline being used for the instance.
This is a convenience which creates an instance of the DescribeInstancePatchesRequest.Builder
avoiding
the need to create one manually via DescribeInstancePatchesRequest.builder()
describeInstancePatchesRequest
- A Consumer
that will call methods on DescribeInstancePatchesRequest.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.
InvalidFilterException
- The filter name is not valid. Verify the you entered the correct name and try again.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 DescribeInstancePatchesIterable describeInstancePatchesPaginator(DescribeInstancePatchesRequest describeInstancePatchesRequest) throws InternalServerErrorException, InvalidInstanceIdException, InvalidFilterException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Retrieves information about the patches on the specified instance and their state relative to the patch baseline being used for the instance.
This is a variant of
describeInstancePatches(software.amazon.awssdk.services.ssm.model.DescribeInstancePatchesRequest)
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.DescribeInstancePatchesIterable responses = client.describeInstancePatchesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.DescribeInstancePatchesIterable responses = client .describeInstancePatchesPaginator(request); for (software.amazon.awssdk.services.ssm.model.DescribeInstancePatchesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.DescribeInstancePatchesIterable responses = client.describeInstancePatchesPaginator(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
describeInstancePatches(software.amazon.awssdk.services.ssm.model.DescribeInstancePatchesRequest)
operation.
describeInstancePatchesRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidInstanceIdException
- The following problems can cause this exception:
You do not have permission to access the instance.
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.
InvalidFilterException
- The filter name is not valid. Verify the you entered the correct name and try again.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 DescribeInstancePatchesIterable describeInstancePatchesPaginator(Consumer<DescribeInstancePatchesRequest.Builder> describeInstancePatchesRequest) throws InternalServerErrorException, InvalidInstanceIdException, InvalidFilterException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Retrieves information about the patches on the specified instance and their state relative to the patch baseline being used for the instance.
This is a variant of
describeInstancePatches(software.amazon.awssdk.services.ssm.model.DescribeInstancePatchesRequest)
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.DescribeInstancePatchesIterable responses = client.describeInstancePatchesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.DescribeInstancePatchesIterable responses = client .describeInstancePatchesPaginator(request); for (software.amazon.awssdk.services.ssm.model.DescribeInstancePatchesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.DescribeInstancePatchesIterable responses = client.describeInstancePatchesPaginator(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
describeInstancePatches(software.amazon.awssdk.services.ssm.model.DescribeInstancePatchesRequest)
operation.
This is a convenience which creates an instance of the DescribeInstancePatchesRequest.Builder
avoiding
the need to create one manually via DescribeInstancePatchesRequest.builder()
describeInstancePatchesRequest
- A Consumer
that will call methods on DescribeInstancePatchesRequest.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.
InvalidFilterException
- The filter name is not valid. Verify the you entered the correct name and try again.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 DescribeInventoryDeletionsResponse describeInventoryDeletions() throws InternalServerErrorException, InvalidDeletionIdException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Describes a specific delete inventory operation.
InternalServerErrorException
- An error occurred on the server side.InvalidDeletionIdException
- The ID specified for the delete operation does not exist or is not valid. Verify the ID and try again.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
describeInventoryDeletions(DescribeInventoryDeletionsRequest)
,
AWS
API Documentationdefault DescribeInventoryDeletionsResponse describeInventoryDeletions(DescribeInventoryDeletionsRequest describeInventoryDeletionsRequest) throws InternalServerErrorException, InvalidDeletionIdException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Describes a specific delete inventory operation.
describeInventoryDeletionsRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidDeletionIdException
- The ID specified for the delete operation does not exist or is not valid. Verify the ID and try again.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 DescribeInventoryDeletionsResponse describeInventoryDeletions(Consumer<DescribeInventoryDeletionsRequest.Builder> describeInventoryDeletionsRequest) throws InternalServerErrorException, InvalidDeletionIdException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Describes a specific delete inventory operation.
This is a convenience which creates an instance of the DescribeInventoryDeletionsRequest.Builder
avoiding
the need to create one manually via DescribeInventoryDeletionsRequest.builder()
describeInventoryDeletionsRequest
- A Consumer
that will call methods on DescribeInventoryDeletionsRequest.Builder
to create a
request.InternalServerErrorException
- An error occurred on the server side.InvalidDeletionIdException
- The ID specified for the delete operation does not exist or is not valid. Verify the ID and try again.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 DescribeInventoryDeletionsIterable describeInventoryDeletionsPaginator() throws InternalServerErrorException, InvalidDeletionIdException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Describes a specific delete inventory operation.
This is a variant of
describeInventoryDeletions(software.amazon.awssdk.services.ssm.model.DescribeInventoryDeletionsRequest)
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.DescribeInventoryDeletionsIterable responses = client.describeInventoryDeletionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.DescribeInventoryDeletionsIterable responses = client .describeInventoryDeletionsPaginator(request); for (software.amazon.awssdk.services.ssm.model.DescribeInventoryDeletionsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.DescribeInventoryDeletionsIterable responses = client.describeInventoryDeletionsPaginator(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
describeInventoryDeletions(software.amazon.awssdk.services.ssm.model.DescribeInventoryDeletionsRequest)
operation.
InternalServerErrorException
- An error occurred on the server side.InvalidDeletionIdException
- The ID specified for the delete operation does not exist or is not valid. Verify the ID and try again.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
describeInventoryDeletionsPaginator(DescribeInventoryDeletionsRequest)
,
AWS
API Documentationdefault DescribeInventoryDeletionsIterable describeInventoryDeletionsPaginator(DescribeInventoryDeletionsRequest describeInventoryDeletionsRequest) throws InternalServerErrorException, InvalidDeletionIdException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Describes a specific delete inventory operation.
This is a variant of
describeInventoryDeletions(software.amazon.awssdk.services.ssm.model.DescribeInventoryDeletionsRequest)
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.DescribeInventoryDeletionsIterable responses = client.describeInventoryDeletionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.DescribeInventoryDeletionsIterable responses = client .describeInventoryDeletionsPaginator(request); for (software.amazon.awssdk.services.ssm.model.DescribeInventoryDeletionsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.DescribeInventoryDeletionsIterable responses = client.describeInventoryDeletionsPaginator(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
describeInventoryDeletions(software.amazon.awssdk.services.ssm.model.DescribeInventoryDeletionsRequest)
operation.
describeInventoryDeletionsRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidDeletionIdException
- The ID specified for the delete operation does not exist or is not valid. Verify the ID and try again.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 DescribeInventoryDeletionsIterable describeInventoryDeletionsPaginator(Consumer<DescribeInventoryDeletionsRequest.Builder> describeInventoryDeletionsRequest) throws InternalServerErrorException, InvalidDeletionIdException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Describes a specific delete inventory operation.
This is a variant of
describeInventoryDeletions(software.amazon.awssdk.services.ssm.model.DescribeInventoryDeletionsRequest)
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.DescribeInventoryDeletionsIterable responses = client.describeInventoryDeletionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.DescribeInventoryDeletionsIterable responses = client .describeInventoryDeletionsPaginator(request); for (software.amazon.awssdk.services.ssm.model.DescribeInventoryDeletionsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.DescribeInventoryDeletionsIterable responses = client.describeInventoryDeletionsPaginator(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
describeInventoryDeletions(software.amazon.awssdk.services.ssm.model.DescribeInventoryDeletionsRequest)
operation.
This is a convenience which creates an instance of the DescribeInventoryDeletionsRequest.Builder
avoiding
the need to create one manually via DescribeInventoryDeletionsRequest.builder()
describeInventoryDeletionsRequest
- A Consumer
that will call methods on DescribeInventoryDeletionsRequest.Builder
to create a
request.InternalServerErrorException
- An error occurred on the server side.InvalidDeletionIdException
- The ID specified for the delete operation does not exist or is not valid. Verify the ID and try again.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 DescribeMaintenanceWindowExecutionTaskInvocationsResponse describeMaintenanceWindowExecutionTaskInvocations(DescribeMaintenanceWindowExecutionTaskInvocationsRequest describeMaintenanceWindowExecutionTaskInvocationsRequest) throws DoesNotExistException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Retrieves the individual task executions (one per target) for a particular task run as part of a maintenance window execution.
describeMaintenanceWindowExecutionTaskInvocationsRequest
- 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 DescribeMaintenanceWindowExecutionTaskInvocationsResponse describeMaintenanceWindowExecutionTaskInvocations(Consumer<DescribeMaintenanceWindowExecutionTaskInvocationsRequest.Builder> describeMaintenanceWindowExecutionTaskInvocationsRequest) throws DoesNotExistException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Retrieves the individual task executions (one per target) for a particular task run as part of a maintenance window execution.
This is a convenience which creates an instance of the
DescribeMaintenanceWindowExecutionTaskInvocationsRequest.Builder
avoiding the need to create one manually
via DescribeMaintenanceWindowExecutionTaskInvocationsRequest.builder()
describeMaintenanceWindowExecutionTaskInvocationsRequest
- A Consumer
that will call methods on
DescribeMaintenanceWindowExecutionTaskInvocationsRequest.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 DescribeMaintenanceWindowExecutionTaskInvocationsIterable describeMaintenanceWindowExecutionTaskInvocationsPaginator(DescribeMaintenanceWindowExecutionTaskInvocationsRequest describeMaintenanceWindowExecutionTaskInvocationsRequest) throws DoesNotExistException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Retrieves the individual task executions (one per target) for a particular task run as part of a maintenance window execution.
This is a variant of
describeMaintenanceWindowExecutionTaskInvocations(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionTaskInvocationsRequest)
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.DescribeMaintenanceWindowExecutionTaskInvocationsIterable responses = client.describeMaintenanceWindowExecutionTaskInvocationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowExecutionTaskInvocationsIterable responses = client .describeMaintenanceWindowExecutionTaskInvocationsPaginator(request); for (software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionTaskInvocationsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowExecutionTaskInvocationsIterable responses = client.describeMaintenanceWindowExecutionTaskInvocationsPaginator(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
describeMaintenanceWindowExecutionTaskInvocations(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionTaskInvocationsRequest)
operation.
describeMaintenanceWindowExecutionTaskInvocationsRequest
- 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 DescribeMaintenanceWindowExecutionTaskInvocationsIterable describeMaintenanceWindowExecutionTaskInvocationsPaginator(Consumer<DescribeMaintenanceWindowExecutionTaskInvocationsRequest.Builder> describeMaintenanceWindowExecutionTaskInvocationsRequest) throws DoesNotExistException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Retrieves the individual task executions (one per target) for a particular task run as part of a maintenance window execution.
This is a variant of
describeMaintenanceWindowExecutionTaskInvocations(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionTaskInvocationsRequest)
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.DescribeMaintenanceWindowExecutionTaskInvocationsIterable responses = client.describeMaintenanceWindowExecutionTaskInvocationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowExecutionTaskInvocationsIterable responses = client .describeMaintenanceWindowExecutionTaskInvocationsPaginator(request); for (software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionTaskInvocationsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowExecutionTaskInvocationsIterable responses = client.describeMaintenanceWindowExecutionTaskInvocationsPaginator(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
describeMaintenanceWindowExecutionTaskInvocations(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionTaskInvocationsRequest)
operation.
This is a convenience which creates an instance of the
DescribeMaintenanceWindowExecutionTaskInvocationsRequest.Builder
avoiding the need to create one manually
via DescribeMaintenanceWindowExecutionTaskInvocationsRequest.builder()
describeMaintenanceWindowExecutionTaskInvocationsRequest
- A Consumer
that will call methods on
DescribeMaintenanceWindowExecutionTaskInvocationsRequest.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 DescribeMaintenanceWindowExecutionTasksResponse describeMaintenanceWindowExecutionTasks(DescribeMaintenanceWindowExecutionTasksRequest describeMaintenanceWindowExecutionTasksRequest) throws DoesNotExistException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
For a given maintenance window execution, lists the tasks that were run.
describeMaintenanceWindowExecutionTasksRequest
- 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 DescribeMaintenanceWindowExecutionTasksResponse describeMaintenanceWindowExecutionTasks(Consumer<DescribeMaintenanceWindowExecutionTasksRequest.Builder> describeMaintenanceWindowExecutionTasksRequest) throws DoesNotExistException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
For a given maintenance window execution, lists the tasks that were run.
This is a convenience which creates an instance of the
DescribeMaintenanceWindowExecutionTasksRequest.Builder
avoiding the need to create one manually via
DescribeMaintenanceWindowExecutionTasksRequest.builder()
describeMaintenanceWindowExecutionTasksRequest
- A Consumer
that will call methods on
DescribeMaintenanceWindowExecutionTasksRequest.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 DescribeMaintenanceWindowExecutionTasksIterable describeMaintenanceWindowExecutionTasksPaginator(DescribeMaintenanceWindowExecutionTasksRequest describeMaintenanceWindowExecutionTasksRequest) throws DoesNotExistException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
For a given maintenance window execution, lists the tasks that were run.
This is a variant of
describeMaintenanceWindowExecutionTasks(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionTasksRequest)
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.DescribeMaintenanceWindowExecutionTasksIterable responses = client.describeMaintenanceWindowExecutionTasksPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowExecutionTasksIterable responses = client .describeMaintenanceWindowExecutionTasksPaginator(request); for (software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionTasksResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowExecutionTasksIterable responses = client.describeMaintenanceWindowExecutionTasksPaginator(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
describeMaintenanceWindowExecutionTasks(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionTasksRequest)
operation.
describeMaintenanceWindowExecutionTasksRequest
- 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 DescribeMaintenanceWindowExecutionTasksIterable describeMaintenanceWindowExecutionTasksPaginator(Consumer<DescribeMaintenanceWindowExecutionTasksRequest.Builder> describeMaintenanceWindowExecutionTasksRequest) throws DoesNotExistException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
For a given maintenance window execution, lists the tasks that were run.
This is a variant of
describeMaintenanceWindowExecutionTasks(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionTasksRequest)
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.DescribeMaintenanceWindowExecutionTasksIterable responses = client.describeMaintenanceWindowExecutionTasksPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowExecutionTasksIterable responses = client .describeMaintenanceWindowExecutionTasksPaginator(request); for (software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionTasksResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowExecutionTasksIterable responses = client.describeMaintenanceWindowExecutionTasksPaginator(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
describeMaintenanceWindowExecutionTasks(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionTasksRequest)
operation.
This is a convenience which creates an instance of the
DescribeMaintenanceWindowExecutionTasksRequest.Builder
avoiding the need to create one manually via
DescribeMaintenanceWindowExecutionTasksRequest.builder()
describeMaintenanceWindowExecutionTasksRequest
- A Consumer
that will call methods on
DescribeMaintenanceWindowExecutionTasksRequest.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 DescribeMaintenanceWindowExecutionsResponse describeMaintenanceWindowExecutions(DescribeMaintenanceWindowExecutionsRequest describeMaintenanceWindowExecutionsRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Lists the executions of a maintenance window. This includes information about when the maintenance window was scheduled to be active, and information about tasks registered and run with the maintenance window.
describeMaintenanceWindowExecutionsRequest
- InternalServerErrorException
- An error occurred on the server side.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 DescribeMaintenanceWindowExecutionsResponse describeMaintenanceWindowExecutions(Consumer<DescribeMaintenanceWindowExecutionsRequest.Builder> describeMaintenanceWindowExecutionsRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Lists the executions of a maintenance window. This includes information about when the maintenance window was scheduled to be active, and information about tasks registered and run with the maintenance window.
This is a convenience which creates an instance of the DescribeMaintenanceWindowExecutionsRequest.Builder
avoiding the need to create one manually via DescribeMaintenanceWindowExecutionsRequest.builder()
describeMaintenanceWindowExecutionsRequest
- A Consumer
that will call methods on DescribeMaintenanceWindowExecutionsRequest.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 DescribeMaintenanceWindowExecutionsIterable describeMaintenanceWindowExecutionsPaginator(DescribeMaintenanceWindowExecutionsRequest describeMaintenanceWindowExecutionsRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Lists the executions of a maintenance window. This includes information about when the maintenance window was scheduled to be active, and information about tasks registered and run with the maintenance window.
This is a variant of
describeMaintenanceWindowExecutions(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionsRequest)
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.DescribeMaintenanceWindowExecutionsIterable responses = client.describeMaintenanceWindowExecutionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowExecutionsIterable responses = client .describeMaintenanceWindowExecutionsPaginator(request); for (software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowExecutionsIterable responses = client.describeMaintenanceWindowExecutionsPaginator(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
describeMaintenanceWindowExecutions(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionsRequest)
operation.
describeMaintenanceWindowExecutionsRequest
- 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 DescribeMaintenanceWindowExecutionsIterable describeMaintenanceWindowExecutionsPaginator(Consumer<DescribeMaintenanceWindowExecutionsRequest.Builder> describeMaintenanceWindowExecutionsRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Lists the executions of a maintenance window. This includes information about when the maintenance window was scheduled to be active, and information about tasks registered and run with the maintenance window.
This is a variant of
describeMaintenanceWindowExecutions(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionsRequest)
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.DescribeMaintenanceWindowExecutionsIterable responses = client.describeMaintenanceWindowExecutionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowExecutionsIterable responses = client .describeMaintenanceWindowExecutionsPaginator(request); for (software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowExecutionsIterable responses = client.describeMaintenanceWindowExecutionsPaginator(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
describeMaintenanceWindowExecutions(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowExecutionsRequest)
operation.
This is a convenience which creates an instance of the DescribeMaintenanceWindowExecutionsRequest.Builder
avoiding the need to create one manually via DescribeMaintenanceWindowExecutionsRequest.builder()
describeMaintenanceWindowExecutionsRequest
- A Consumer
that will call methods on DescribeMaintenanceWindowExecutionsRequest.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 DescribeMaintenanceWindowScheduleResponse describeMaintenanceWindowSchedule(DescribeMaintenanceWindowScheduleRequest describeMaintenanceWindowScheduleRequest) throws InternalServerErrorException, DoesNotExistException, AwsServiceException, SdkClientException, SsmException
Retrieves information about upcoming executions of a maintenance window.
describeMaintenanceWindowScheduleRequest
- 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 DescribeMaintenanceWindowScheduleResponse describeMaintenanceWindowSchedule(Consumer<DescribeMaintenanceWindowScheduleRequest.Builder> describeMaintenanceWindowScheduleRequest) throws InternalServerErrorException, DoesNotExistException, AwsServiceException, SdkClientException, SsmException
Retrieves information about upcoming executions of a maintenance window.
This is a convenience which creates an instance of the DescribeMaintenanceWindowScheduleRequest.Builder
avoiding the need to create one manually via DescribeMaintenanceWindowScheduleRequest.builder()
describeMaintenanceWindowScheduleRequest
- A Consumer
that will call methods on DescribeMaintenanceWindowScheduleRequest.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 DescribeMaintenanceWindowScheduleIterable describeMaintenanceWindowSchedulePaginator(DescribeMaintenanceWindowScheduleRequest describeMaintenanceWindowScheduleRequest) throws InternalServerErrorException, DoesNotExistException, AwsServiceException, SdkClientException, SsmException
Retrieves information about upcoming executions of a maintenance window.
This is a variant of
describeMaintenanceWindowSchedule(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowScheduleRequest)
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.DescribeMaintenanceWindowScheduleIterable responses = client.describeMaintenanceWindowSchedulePaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowScheduleIterable responses = client .describeMaintenanceWindowSchedulePaginator(request); for (software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowScheduleResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowScheduleIterable responses = client.describeMaintenanceWindowSchedulePaginator(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
describeMaintenanceWindowSchedule(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowScheduleRequest)
operation.
describeMaintenanceWindowScheduleRequest
- 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 DescribeMaintenanceWindowScheduleIterable describeMaintenanceWindowSchedulePaginator(Consumer<DescribeMaintenanceWindowScheduleRequest.Builder> describeMaintenanceWindowScheduleRequest) throws InternalServerErrorException, DoesNotExistException, AwsServiceException, SdkClientException, SsmException
Retrieves information about upcoming executions of a maintenance window.
This is a variant of
describeMaintenanceWindowSchedule(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowScheduleRequest)
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.DescribeMaintenanceWindowScheduleIterable responses = client.describeMaintenanceWindowSchedulePaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowScheduleIterable responses = client .describeMaintenanceWindowSchedulePaginator(request); for (software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowScheduleResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowScheduleIterable responses = client.describeMaintenanceWindowSchedulePaginator(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
describeMaintenanceWindowSchedule(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowScheduleRequest)
operation.
This is a convenience which creates an instance of the DescribeMaintenanceWindowScheduleRequest.Builder
avoiding the need to create one manually via DescribeMaintenanceWindowScheduleRequest.builder()
describeMaintenanceWindowScheduleRequest
- A Consumer
that will call methods on DescribeMaintenanceWindowScheduleRequest.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 DescribeMaintenanceWindowTargetsResponse describeMaintenanceWindowTargets(DescribeMaintenanceWindowTargetsRequest describeMaintenanceWindowTargetsRequest) throws DoesNotExistException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Lists the targets registered with the maintenance window.
describeMaintenanceWindowTargetsRequest
- 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 DescribeMaintenanceWindowTargetsResponse describeMaintenanceWindowTargets(Consumer<DescribeMaintenanceWindowTargetsRequest.Builder> describeMaintenanceWindowTargetsRequest) throws DoesNotExistException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Lists the targets registered with the maintenance window.
This is a convenience which creates an instance of the DescribeMaintenanceWindowTargetsRequest.Builder
avoiding the need to create one manually via DescribeMaintenanceWindowTargetsRequest.builder()
describeMaintenanceWindowTargetsRequest
- A Consumer
that will call methods on DescribeMaintenanceWindowTargetsRequest.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 DescribeMaintenanceWindowTargetsIterable describeMaintenanceWindowTargetsPaginator(DescribeMaintenanceWindowTargetsRequest describeMaintenanceWindowTargetsRequest) throws DoesNotExistException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Lists the targets registered with the maintenance window.
This is a variant of
describeMaintenanceWindowTargets(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowTargetsRequest)
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.DescribeMaintenanceWindowTargetsIterable responses = client.describeMaintenanceWindowTargetsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowTargetsIterable responses = client .describeMaintenanceWindowTargetsPaginator(request); for (software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowTargetsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowTargetsIterable responses = client.describeMaintenanceWindowTargetsPaginator(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
describeMaintenanceWindowTargets(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowTargetsRequest)
operation.
describeMaintenanceWindowTargetsRequest
- 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 DescribeMaintenanceWindowTargetsIterable describeMaintenanceWindowTargetsPaginator(Consumer<DescribeMaintenanceWindowTargetsRequest.Builder> describeMaintenanceWindowTargetsRequest) throws DoesNotExistException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Lists the targets registered with the maintenance window.
This is a variant of
describeMaintenanceWindowTargets(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowTargetsRequest)
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.DescribeMaintenanceWindowTargetsIterable responses = client.describeMaintenanceWindowTargetsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowTargetsIterable responses = client .describeMaintenanceWindowTargetsPaginator(request); for (software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowTargetsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowTargetsIterable responses = client.describeMaintenanceWindowTargetsPaginator(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
describeMaintenanceWindowTargets(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowTargetsRequest)
operation.
This is a convenience which creates an instance of the DescribeMaintenanceWindowTargetsRequest.Builder
avoiding the need to create one manually via DescribeMaintenanceWindowTargetsRequest.builder()
describeMaintenanceWindowTargetsRequest
- A Consumer
that will call methods on DescribeMaintenanceWindowTargetsRequest.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 DescribeMaintenanceWindowTasksResponse describeMaintenanceWindowTasks(DescribeMaintenanceWindowTasksRequest describeMaintenanceWindowTasksRequest) throws DoesNotExistException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Lists the tasks in a maintenance window.
describeMaintenanceWindowTasksRequest
- 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 DescribeMaintenanceWindowTasksResponse describeMaintenanceWindowTasks(Consumer<DescribeMaintenanceWindowTasksRequest.Builder> describeMaintenanceWindowTasksRequest) throws DoesNotExistException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Lists the tasks in a maintenance window.
This is a convenience which creates an instance of the DescribeMaintenanceWindowTasksRequest.Builder
avoiding the need to create one manually via DescribeMaintenanceWindowTasksRequest.builder()
describeMaintenanceWindowTasksRequest
- A Consumer
that will call methods on DescribeMaintenanceWindowTasksRequest.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 DescribeMaintenanceWindowTasksIterable describeMaintenanceWindowTasksPaginator(DescribeMaintenanceWindowTasksRequest describeMaintenanceWindowTasksRequest) throws DoesNotExistException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Lists the tasks in a maintenance window.
This is a variant of
describeMaintenanceWindowTasks(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowTasksRequest)
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.DescribeMaintenanceWindowTasksIterable responses = client.describeMaintenanceWindowTasksPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowTasksIterable responses = client .describeMaintenanceWindowTasksPaginator(request); for (software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowTasksResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowTasksIterable responses = client.describeMaintenanceWindowTasksPaginator(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
describeMaintenanceWindowTasks(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowTasksRequest)
operation.
describeMaintenanceWindowTasksRequest
- 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 DescribeMaintenanceWindowTasksIterable describeMaintenanceWindowTasksPaginator(Consumer<DescribeMaintenanceWindowTasksRequest.Builder> describeMaintenanceWindowTasksRequest) throws DoesNotExistException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Lists the tasks in a maintenance window.
This is a variant of
describeMaintenanceWindowTasks(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowTasksRequest)
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.DescribeMaintenanceWindowTasksIterable responses = client.describeMaintenanceWindowTasksPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowTasksIterable responses = client .describeMaintenanceWindowTasksPaginator(request); for (software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowTasksResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowTasksIterable responses = client.describeMaintenanceWindowTasksPaginator(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
describeMaintenanceWindowTasks(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowTasksRequest)
operation.
This is a convenience which creates an instance of the DescribeMaintenanceWindowTasksRequest.Builder
avoiding the need to create one manually via DescribeMaintenanceWindowTasksRequest.builder()
describeMaintenanceWindowTasksRequest
- A Consumer
that will call methods on DescribeMaintenanceWindowTasksRequest.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 DescribeMaintenanceWindowsResponse describeMaintenanceWindows() throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Retrieves the maintenance windows in an AWS account.
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
describeMaintenanceWindows(DescribeMaintenanceWindowsRequest)
,
AWS
API Documentationdefault DescribeMaintenanceWindowsResponse describeMaintenanceWindows(DescribeMaintenanceWindowsRequest describeMaintenanceWindowsRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Retrieves the maintenance windows in an AWS account.
describeMaintenanceWindowsRequest
- 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 DescribeMaintenanceWindowsResponse describeMaintenanceWindows(Consumer<DescribeMaintenanceWindowsRequest.Builder> describeMaintenanceWindowsRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Retrieves the maintenance windows in an AWS account.
This is a convenience which creates an instance of the DescribeMaintenanceWindowsRequest.Builder
avoiding
the need to create one manually via DescribeMaintenanceWindowsRequest.builder()
describeMaintenanceWindowsRequest
- A Consumer
that will call methods on DescribeMaintenanceWindowsRequest.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 DescribeMaintenanceWindowsIterable describeMaintenanceWindowsPaginator() throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Retrieves the maintenance windows in an AWS account.
This is a variant of
describeMaintenanceWindows(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowsRequest)
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.DescribeMaintenanceWindowsIterable responses = client.describeMaintenanceWindowsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowsIterable responses = client .describeMaintenanceWindowsPaginator(request); for (software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowsIterable responses = client.describeMaintenanceWindowsPaginator(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
describeMaintenanceWindows(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowsRequest)
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
describeMaintenanceWindowsPaginator(DescribeMaintenanceWindowsRequest)
,
AWS
API Documentationdefault DescribeMaintenanceWindowsIterable describeMaintenanceWindowsPaginator(DescribeMaintenanceWindowsRequest describeMaintenanceWindowsRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Retrieves the maintenance windows in an AWS account.
This is a variant of
describeMaintenanceWindows(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowsRequest)
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.DescribeMaintenanceWindowsIterable responses = client.describeMaintenanceWindowsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowsIterable responses = client .describeMaintenanceWindowsPaginator(request); for (software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowsIterable responses = client.describeMaintenanceWindowsPaginator(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
describeMaintenanceWindows(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowsRequest)
operation.
describeMaintenanceWindowsRequest
- 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 DescribeMaintenanceWindowsIterable describeMaintenanceWindowsPaginator(Consumer<DescribeMaintenanceWindowsRequest.Builder> describeMaintenanceWindowsRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Retrieves the maintenance windows in an AWS account.
This is a variant of
describeMaintenanceWindows(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowsRequest)
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.DescribeMaintenanceWindowsIterable responses = client.describeMaintenanceWindowsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowsIterable responses = client .describeMaintenanceWindowsPaginator(request); for (software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowsIterable responses = client.describeMaintenanceWindowsPaginator(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
describeMaintenanceWindows(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowsRequest)
operation.
This is a convenience which creates an instance of the DescribeMaintenanceWindowsRequest.Builder
avoiding
the need to create one manually via DescribeMaintenanceWindowsRequest.builder()
describeMaintenanceWindowsRequest
- A Consumer
that will call methods on DescribeMaintenanceWindowsRequest.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 DescribeMaintenanceWindowsForTargetResponse describeMaintenanceWindowsForTarget(DescribeMaintenanceWindowsForTargetRequest describeMaintenanceWindowsForTargetRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Retrieves information about the maintenance window targets or tasks that an instance is associated with.
describeMaintenanceWindowsForTargetRequest
- 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 DescribeMaintenanceWindowsForTargetResponse describeMaintenanceWindowsForTarget(Consumer<DescribeMaintenanceWindowsForTargetRequest.Builder> describeMaintenanceWindowsForTargetRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Retrieves information about the maintenance window targets or tasks that an instance is associated with.
This is a convenience which creates an instance of the DescribeMaintenanceWindowsForTargetRequest.Builder
avoiding the need to create one manually via DescribeMaintenanceWindowsForTargetRequest.builder()
describeMaintenanceWindowsForTargetRequest
- A Consumer
that will call methods on DescribeMaintenanceWindowsForTargetRequest.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 DescribeMaintenanceWindowsForTargetIterable describeMaintenanceWindowsForTargetPaginator(DescribeMaintenanceWindowsForTargetRequest describeMaintenanceWindowsForTargetRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Retrieves information about the maintenance window targets or tasks that an instance is associated with.
This is a variant of
describeMaintenanceWindowsForTarget(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowsForTargetRequest)
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.DescribeMaintenanceWindowsForTargetIterable responses = client.describeMaintenanceWindowsForTargetPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowsForTargetIterable responses = client .describeMaintenanceWindowsForTargetPaginator(request); for (software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowsForTargetResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowsForTargetIterable responses = client.describeMaintenanceWindowsForTargetPaginator(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
describeMaintenanceWindowsForTarget(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowsForTargetRequest)
operation.
describeMaintenanceWindowsForTargetRequest
- 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 DescribeMaintenanceWindowsForTargetIterable describeMaintenanceWindowsForTargetPaginator(Consumer<DescribeMaintenanceWindowsForTargetRequest.Builder> describeMaintenanceWindowsForTargetRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Retrieves information about the maintenance window targets or tasks that an instance is associated with.
This is a variant of
describeMaintenanceWindowsForTarget(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowsForTargetRequest)
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.DescribeMaintenanceWindowsForTargetIterable responses = client.describeMaintenanceWindowsForTargetPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowsForTargetIterable responses = client .describeMaintenanceWindowsForTargetPaginator(request); for (software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowsForTargetResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowsForTargetIterable responses = client.describeMaintenanceWindowsForTargetPaginator(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
describeMaintenanceWindowsForTarget(software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowsForTargetRequest)
operation.
This is a convenience which creates an instance of the DescribeMaintenanceWindowsForTargetRequest.Builder
avoiding the need to create one manually via DescribeMaintenanceWindowsForTargetRequest.builder()
describeMaintenanceWindowsForTargetRequest
- A Consumer
that will call methods on DescribeMaintenanceWindowsForTargetRequest.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 DescribeOpsItemsResponse describeOpsItems(DescribeOpsItemsRequest describeOpsItemsRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Query a set of OpsItems. You must have permission in AWS Identity and Access Management (IAM) to query a list of OpsItems. 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.
describeOpsItemsRequest
- 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 DescribeOpsItemsResponse describeOpsItems(Consumer<DescribeOpsItemsRequest.Builder> describeOpsItemsRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Query a set of OpsItems. You must have permission in AWS Identity and Access Management (IAM) to query a list of OpsItems. 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 DescribeOpsItemsRequest.Builder
avoiding the need
to create one manually via DescribeOpsItemsRequest.builder()
describeOpsItemsRequest
- A Consumer
that will call methods on DescribeOpsItemsRequest.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 DescribeOpsItemsIterable describeOpsItemsPaginator(DescribeOpsItemsRequest describeOpsItemsRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Query a set of OpsItems. You must have permission in AWS Identity and Access Management (IAM) to query a list of OpsItems. 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 variant of describeOpsItems(software.amazon.awssdk.services.ssm.model.DescribeOpsItemsRequest)
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.DescribeOpsItemsIterable responses = client.describeOpsItemsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.DescribeOpsItemsIterable responses = client.describeOpsItemsPaginator(request); for (software.amazon.awssdk.services.ssm.model.DescribeOpsItemsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.DescribeOpsItemsIterable responses = client.describeOpsItemsPaginator(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
describeOpsItems(software.amazon.awssdk.services.ssm.model.DescribeOpsItemsRequest)
operation.
describeOpsItemsRequest
- 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 DescribeOpsItemsIterable describeOpsItemsPaginator(Consumer<DescribeOpsItemsRequest.Builder> describeOpsItemsRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Query a set of OpsItems. You must have permission in AWS Identity and Access Management (IAM) to query a list of OpsItems. 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 variant of describeOpsItems(software.amazon.awssdk.services.ssm.model.DescribeOpsItemsRequest)
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.DescribeOpsItemsIterable responses = client.describeOpsItemsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.DescribeOpsItemsIterable responses = client.describeOpsItemsPaginator(request); for (software.amazon.awssdk.services.ssm.model.DescribeOpsItemsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.DescribeOpsItemsIterable responses = client.describeOpsItemsPaginator(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
describeOpsItems(software.amazon.awssdk.services.ssm.model.DescribeOpsItemsRequest)
operation.
This is a convenience which creates an instance of the DescribeOpsItemsRequest.Builder
avoiding the need
to create one manually via DescribeOpsItemsRequest.builder()
describeOpsItemsRequest
- A Consumer
that will call methods on DescribeOpsItemsRequest.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 DescribeParametersResponse describeParameters() throws InternalServerErrorException, InvalidFilterKeyException, InvalidFilterOptionException, InvalidFilterValueException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Get information about a parameter.
Request results are returned on a best-effort basis. If you specify MaxResults
in the request, the
response includes information up to the limit specified. The number of items returned, however, can be between
zero and the value of MaxResults
. If the service reaches an internal limit while processing the
results, it stops the operation and returns the matching values up to that point and a NextToken
.
You can specify the NextToken
in a subsequent call to get the next set of results.
InternalServerErrorException
- An error occurred on the server side.InvalidFilterKeyException
- The specified key is not valid.InvalidFilterOptionException
- The specified filter option is not valid. Valid options are Equals and BeginsWith. For Path filter, valid
options are Recursive and OneLevel.InvalidFilterValueException
- The filter value is not valid. Verify the value and try again.InvalidNextTokenException
- The specified token is not valid.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
describeParameters(DescribeParametersRequest)
,
AWS API
Documentationdefault DescribeParametersResponse describeParameters(DescribeParametersRequest describeParametersRequest) throws InternalServerErrorException, InvalidFilterKeyException, InvalidFilterOptionException, InvalidFilterValueException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Get information about a parameter.
Request results are returned on a best-effort basis. If you specify MaxResults
in the request, the
response includes information up to the limit specified. The number of items returned, however, can be between
zero and the value of MaxResults
. If the service reaches an internal limit while processing the
results, it stops the operation and returns the matching values up to that point and a NextToken
.
You can specify the NextToken
in a subsequent call to get the next set of results.
describeParametersRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidFilterKeyException
- The specified key is not valid.InvalidFilterOptionException
- The specified filter option is not valid. Valid options are Equals and BeginsWith. For Path filter, valid
options are Recursive and OneLevel.InvalidFilterValueException
- The filter value is not valid. Verify the value and try again.InvalidNextTokenException
- The specified token is not valid.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 DescribeParametersResponse describeParameters(Consumer<DescribeParametersRequest.Builder> describeParametersRequest) throws InternalServerErrorException, InvalidFilterKeyException, InvalidFilterOptionException, InvalidFilterValueException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Get information about a parameter.
Request results are returned on a best-effort basis. If you specify MaxResults
in the request, the
response includes information up to the limit specified. The number of items returned, however, can be between
zero and the value of MaxResults
. If the service reaches an internal limit while processing the
results, it stops the operation and returns the matching values up to that point and a NextToken
.
You can specify the NextToken
in a subsequent call to get the next set of results.
This is a convenience which creates an instance of the DescribeParametersRequest.Builder
avoiding the
need to create one manually via DescribeParametersRequest.builder()
describeParametersRequest
- A Consumer
that will call methods on DescribeParametersRequest.Builder
to create a
request.InternalServerErrorException
- An error occurred on the server side.InvalidFilterKeyException
- The specified key is not valid.InvalidFilterOptionException
- The specified filter option is not valid. Valid options are Equals and BeginsWith. For Path filter, valid
options are Recursive and OneLevel.InvalidFilterValueException
- The filter value is not valid. Verify the value and try again.InvalidNextTokenException
- The specified token is not valid.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 DescribeParametersIterable describeParametersPaginator() throws InternalServerErrorException, InvalidFilterKeyException, InvalidFilterOptionException, InvalidFilterValueException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Get information about a parameter.
Request results are returned on a best-effort basis. If you specify MaxResults
in the request, the
response includes information up to the limit specified. The number of items returned, however, can be between
zero and the value of MaxResults
. If the service reaches an internal limit while processing the
results, it stops the operation and returns the matching values up to that point and a NextToken
.
You can specify the NextToken
in a subsequent call to get the next set of results.
This is a variant of
describeParameters(software.amazon.awssdk.services.ssm.model.DescribeParametersRequest)
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.DescribeParametersIterable responses = client.describeParametersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.DescribeParametersIterable responses = client .describeParametersPaginator(request); for (software.amazon.awssdk.services.ssm.model.DescribeParametersResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.DescribeParametersIterable responses = client.describeParametersPaginator(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
describeParameters(software.amazon.awssdk.services.ssm.model.DescribeParametersRequest)
operation.
InternalServerErrorException
- An error occurred on the server side.InvalidFilterKeyException
- The specified key is not valid.InvalidFilterOptionException
- The specified filter option is not valid. Valid options are Equals and BeginsWith. For Path filter, valid
options are Recursive and OneLevel.InvalidFilterValueException
- The filter value is not valid. Verify the value and try again.InvalidNextTokenException
- The specified token is not valid.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
describeParametersPaginator(DescribeParametersRequest)
,
AWS API
Documentationdefault DescribeParametersIterable describeParametersPaginator(DescribeParametersRequest describeParametersRequest) throws InternalServerErrorException, InvalidFilterKeyException, InvalidFilterOptionException, InvalidFilterValueException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Get information about a parameter.
Request results are returned on a best-effort basis. If you specify MaxResults
in the request, the
response includes information up to the limit specified. The number of items returned, however, can be between
zero and the value of MaxResults
. If the service reaches an internal limit while processing the
results, it stops the operation and returns the matching values up to that point and a NextToken
.
You can specify the NextToken
in a subsequent call to get the next set of results.
This is a variant of
describeParameters(software.amazon.awssdk.services.ssm.model.DescribeParametersRequest)
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.DescribeParametersIterable responses = client.describeParametersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.DescribeParametersIterable responses = client .describeParametersPaginator(request); for (software.amazon.awssdk.services.ssm.model.DescribeParametersResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.DescribeParametersIterable responses = client.describeParametersPaginator(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
describeParameters(software.amazon.awssdk.services.ssm.model.DescribeParametersRequest)
operation.
describeParametersRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidFilterKeyException
- The specified key is not valid.InvalidFilterOptionException
- The specified filter option is not valid. Valid options are Equals and BeginsWith. For Path filter, valid
options are Recursive and OneLevel.InvalidFilterValueException
- The filter value is not valid. Verify the value and try again.InvalidNextTokenException
- The specified token is not valid.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 DescribeParametersIterable describeParametersPaginator(Consumer<DescribeParametersRequest.Builder> describeParametersRequest) throws InternalServerErrorException, InvalidFilterKeyException, InvalidFilterOptionException, InvalidFilterValueException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Get information about a parameter.
Request results are returned on a best-effort basis. If you specify MaxResults
in the request, the
response includes information up to the limit specified. The number of items returned, however, can be between
zero and the value of MaxResults
. If the service reaches an internal limit while processing the
results, it stops the operation and returns the matching values up to that point and a NextToken
.
You can specify the NextToken
in a subsequent call to get the next set of results.
This is a variant of
describeParameters(software.amazon.awssdk.services.ssm.model.DescribeParametersRequest)
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.DescribeParametersIterable responses = client.describeParametersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.DescribeParametersIterable responses = client .describeParametersPaginator(request); for (software.amazon.awssdk.services.ssm.model.DescribeParametersResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.DescribeParametersIterable responses = client.describeParametersPaginator(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
describeParameters(software.amazon.awssdk.services.ssm.model.DescribeParametersRequest)
operation.
This is a convenience which creates an instance of the DescribeParametersRequest.Builder
avoiding the
need to create one manually via DescribeParametersRequest.builder()
describeParametersRequest
- A Consumer
that will call methods on DescribeParametersRequest.Builder
to create a
request.InternalServerErrorException
- An error occurred on the server side.InvalidFilterKeyException
- The specified key is not valid.InvalidFilterOptionException
- The specified filter option is not valid. Valid options are Equals and BeginsWith. For Path filter, valid
options are Recursive and OneLevel.InvalidFilterValueException
- The filter value is not valid. Verify the value and try again.InvalidNextTokenException
- The specified token is not valid.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 DescribePatchBaselinesResponse describePatchBaselines() throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Lists the patch baselines in your AWS account.
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
describePatchBaselines(DescribePatchBaselinesRequest)
,
AWS API
Documentationdefault DescribePatchBaselinesResponse describePatchBaselines(DescribePatchBaselinesRequest describePatchBaselinesRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Lists the patch baselines in your AWS account.
describePatchBaselinesRequest
- 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 DescribePatchBaselinesResponse describePatchBaselines(Consumer<DescribePatchBaselinesRequest.Builder> describePatchBaselinesRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Lists the patch baselines in your AWS account.
This is a convenience which creates an instance of the DescribePatchBaselinesRequest.Builder
avoiding the
need to create one manually via DescribePatchBaselinesRequest.builder()
describePatchBaselinesRequest
- A Consumer
that will call methods on DescribePatchBaselinesRequest.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 DescribePatchBaselinesIterable describePatchBaselinesPaginator() throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Lists the patch baselines in your AWS account.
This is a variant of
describePatchBaselines(software.amazon.awssdk.services.ssm.model.DescribePatchBaselinesRequest)
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.DescribePatchBaselinesIterable responses = client.describePatchBaselinesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.DescribePatchBaselinesIterable responses = client .describePatchBaselinesPaginator(request); for (software.amazon.awssdk.services.ssm.model.DescribePatchBaselinesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.DescribePatchBaselinesIterable responses = client.describePatchBaselinesPaginator(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
describePatchBaselines(software.amazon.awssdk.services.ssm.model.DescribePatchBaselinesRequest)
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
describePatchBaselinesPaginator(DescribePatchBaselinesRequest)
,
AWS API
Documentationdefault DescribePatchBaselinesIterable describePatchBaselinesPaginator(DescribePatchBaselinesRequest describePatchBaselinesRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Lists the patch baselines in your AWS account.
This is a variant of
describePatchBaselines(software.amazon.awssdk.services.ssm.model.DescribePatchBaselinesRequest)
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.DescribePatchBaselinesIterable responses = client.describePatchBaselinesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.DescribePatchBaselinesIterable responses = client .describePatchBaselinesPaginator(request); for (software.amazon.awssdk.services.ssm.model.DescribePatchBaselinesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.DescribePatchBaselinesIterable responses = client.describePatchBaselinesPaginator(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
describePatchBaselines(software.amazon.awssdk.services.ssm.model.DescribePatchBaselinesRequest)
operation.
describePatchBaselinesRequest
- 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 DescribePatchBaselinesIterable describePatchBaselinesPaginator(Consumer<DescribePatchBaselinesRequest.Builder> describePatchBaselinesRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Lists the patch baselines in your AWS account.
This is a variant of
describePatchBaselines(software.amazon.awssdk.services.ssm.model.DescribePatchBaselinesRequest)
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.DescribePatchBaselinesIterable responses = client.describePatchBaselinesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.DescribePatchBaselinesIterable responses = client .describePatchBaselinesPaginator(request); for (software.amazon.awssdk.services.ssm.model.DescribePatchBaselinesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.DescribePatchBaselinesIterable responses = client.describePatchBaselinesPaginator(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
describePatchBaselines(software.amazon.awssdk.services.ssm.model.DescribePatchBaselinesRequest)
operation.
This is a convenience which creates an instance of the DescribePatchBaselinesRequest.Builder
avoiding the
need to create one manually via DescribePatchBaselinesRequest.builder()
describePatchBaselinesRequest
- A Consumer
that will call methods on DescribePatchBaselinesRequest.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 DescribePatchGroupStateResponse describePatchGroupState(DescribePatchGroupStateRequest describePatchGroupStateRequest) throws InternalServerErrorException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Returns high-level aggregated patch compliance state for a patch group.
describePatchGroupStateRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidNextTokenException
- The specified token is not valid.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 DescribePatchGroupStateResponse describePatchGroupState(Consumer<DescribePatchGroupStateRequest.Builder> describePatchGroupStateRequest) throws InternalServerErrorException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Returns high-level aggregated patch compliance state for a patch group.
This is a convenience which creates an instance of the DescribePatchGroupStateRequest.Builder
avoiding
the need to create one manually via DescribePatchGroupStateRequest.builder()
describePatchGroupStateRequest
- A Consumer
that will call methods on DescribePatchGroupStateRequest.Builder
to create a
request.InternalServerErrorException
- An error occurred on the server side.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 DescribePatchGroupsResponse describePatchGroups() throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Lists all patch groups that have been registered with patch baselines.
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
describePatchGroups(DescribePatchGroupsRequest)
,
AWS API
Documentationdefault DescribePatchGroupsResponse describePatchGroups(DescribePatchGroupsRequest describePatchGroupsRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Lists all patch groups that have been registered with patch baselines.
describePatchGroupsRequest
- 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 DescribePatchGroupsResponse describePatchGroups(Consumer<DescribePatchGroupsRequest.Builder> describePatchGroupsRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Lists all patch groups that have been registered with patch baselines.
This is a convenience which creates an instance of the DescribePatchGroupsRequest.Builder
avoiding the
need to create one manually via DescribePatchGroupsRequest.builder()
describePatchGroupsRequest
- A Consumer
that will call methods on DescribePatchGroupsRequest.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 DescribePatchGroupsIterable describePatchGroupsPaginator() throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Lists all patch groups that have been registered with patch baselines.
This is a variant of
describePatchGroups(software.amazon.awssdk.services.ssm.model.DescribePatchGroupsRequest)
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.DescribePatchGroupsIterable responses = client.describePatchGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.DescribePatchGroupsIterable responses = client .describePatchGroupsPaginator(request); for (software.amazon.awssdk.services.ssm.model.DescribePatchGroupsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.DescribePatchGroupsIterable responses = client.describePatchGroupsPaginator(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
describePatchGroups(software.amazon.awssdk.services.ssm.model.DescribePatchGroupsRequest)
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
describePatchGroupsPaginator(DescribePatchGroupsRequest)
,
AWS API
Documentationdefault DescribePatchGroupsIterable describePatchGroupsPaginator(DescribePatchGroupsRequest describePatchGroupsRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Lists all patch groups that have been registered with patch baselines.
This is a variant of
describePatchGroups(software.amazon.awssdk.services.ssm.model.DescribePatchGroupsRequest)
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.DescribePatchGroupsIterable responses = client.describePatchGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.DescribePatchGroupsIterable responses = client .describePatchGroupsPaginator(request); for (software.amazon.awssdk.services.ssm.model.DescribePatchGroupsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.DescribePatchGroupsIterable responses = client.describePatchGroupsPaginator(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
describePatchGroups(software.amazon.awssdk.services.ssm.model.DescribePatchGroupsRequest)
operation.
describePatchGroupsRequest
- 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 DescribePatchGroupsIterable describePatchGroupsPaginator(Consumer<DescribePatchGroupsRequest.Builder> describePatchGroupsRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Lists all patch groups that have been registered with patch baselines.
This is a variant of
describePatchGroups(software.amazon.awssdk.services.ssm.model.DescribePatchGroupsRequest)
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.DescribePatchGroupsIterable responses = client.describePatchGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.DescribePatchGroupsIterable responses = client .describePatchGroupsPaginator(request); for (software.amazon.awssdk.services.ssm.model.DescribePatchGroupsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.DescribePatchGroupsIterable responses = client.describePatchGroupsPaginator(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
describePatchGroups(software.amazon.awssdk.services.ssm.model.DescribePatchGroupsRequest)
operation.
This is a convenience which creates an instance of the DescribePatchGroupsRequest.Builder
avoiding the
need to create one manually via DescribePatchGroupsRequest.builder()
describePatchGroupsRequest
- A Consumer
that will call methods on DescribePatchGroupsRequest.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 DescribePatchPropertiesResponse describePatchProperties(DescribePatchPropertiesRequest describePatchPropertiesRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Lists the properties of available patches organized by product, product family, classification, severity, and other properties of available patches. You can use the reported properties in the filters you specify in requests for actions such as CreatePatchBaseline, UpdatePatchBaseline, DescribeAvailablePatches, and DescribePatchBaselines.
The following section lists the properties that can be used in filters for each major operating system type:
Valid properties: PRODUCT, PRODUCT_FAMILY, CLASSIFICATION, MSRC_SEVERITY
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
Valid properties: PRODUCT, PRIORITY
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
describePatchPropertiesRequest
- 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 DescribePatchPropertiesResponse describePatchProperties(Consumer<DescribePatchPropertiesRequest.Builder> describePatchPropertiesRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Lists the properties of available patches organized by product, product family, classification, severity, and other properties of available patches. You can use the reported properties in the filters you specify in requests for actions such as CreatePatchBaseline, UpdatePatchBaseline, DescribeAvailablePatches, and DescribePatchBaselines.
The following section lists the properties that can be used in filters for each major operating system type:
Valid properties: PRODUCT, PRODUCT_FAMILY, CLASSIFICATION, MSRC_SEVERITY
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
Valid properties: PRODUCT, PRIORITY
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
This is a convenience which creates an instance of the DescribePatchPropertiesRequest.Builder
avoiding
the need to create one manually via DescribePatchPropertiesRequest.builder()
describePatchPropertiesRequest
- A Consumer
that will call methods on DescribePatchPropertiesRequest.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 DescribePatchPropertiesIterable describePatchPropertiesPaginator(DescribePatchPropertiesRequest describePatchPropertiesRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Lists the properties of available patches organized by product, product family, classification, severity, and other properties of available patches. You can use the reported properties in the filters you specify in requests for actions such as CreatePatchBaseline, UpdatePatchBaseline, DescribeAvailablePatches, and DescribePatchBaselines.
The following section lists the properties that can be used in filters for each major operating system type:
Valid properties: PRODUCT, PRODUCT_FAMILY, CLASSIFICATION, MSRC_SEVERITY
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
Valid properties: PRODUCT, PRIORITY
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
This is a variant of
describePatchProperties(software.amazon.awssdk.services.ssm.model.DescribePatchPropertiesRequest)
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.DescribePatchPropertiesIterable responses = client.describePatchPropertiesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.DescribePatchPropertiesIterable responses = client .describePatchPropertiesPaginator(request); for (software.amazon.awssdk.services.ssm.model.DescribePatchPropertiesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.DescribePatchPropertiesIterable responses = client.describePatchPropertiesPaginator(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
describePatchProperties(software.amazon.awssdk.services.ssm.model.DescribePatchPropertiesRequest)
operation.
describePatchPropertiesRequest
- 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 DescribePatchPropertiesIterable describePatchPropertiesPaginator(Consumer<DescribePatchPropertiesRequest.Builder> describePatchPropertiesRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Lists the properties of available patches organized by product, product family, classification, severity, and other properties of available patches. You can use the reported properties in the filters you specify in requests for actions such as CreatePatchBaseline, UpdatePatchBaseline, DescribeAvailablePatches, and DescribePatchBaselines.
The following section lists the properties that can be used in filters for each major operating system type:
Valid properties: PRODUCT, PRODUCT_FAMILY, CLASSIFICATION, MSRC_SEVERITY
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
Valid properties: PRODUCT, PRIORITY
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
This is a variant of
describePatchProperties(software.amazon.awssdk.services.ssm.model.DescribePatchPropertiesRequest)
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.DescribePatchPropertiesIterable responses = client.describePatchPropertiesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.DescribePatchPropertiesIterable responses = client .describePatchPropertiesPaginator(request); for (software.amazon.awssdk.services.ssm.model.DescribePatchPropertiesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.DescribePatchPropertiesIterable responses = client.describePatchPropertiesPaginator(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
describePatchProperties(software.amazon.awssdk.services.ssm.model.DescribePatchPropertiesRequest)
operation.
This is a convenience which creates an instance of the DescribePatchPropertiesRequest.Builder
avoiding
the need to create one manually via DescribePatchPropertiesRequest.builder()
describePatchPropertiesRequest
- A Consumer
that will call methods on DescribePatchPropertiesRequest.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 DescribeSessionsResponse describeSessions(DescribeSessionsRequest describeSessionsRequest) throws InternalServerErrorException, InvalidFilterKeyException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30 days.
describeSessionsRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidFilterKeyException
- The specified key is not valid.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 DescribeSessionsResponse describeSessions(Consumer<DescribeSessionsRequest.Builder> describeSessionsRequest) throws InternalServerErrorException, InvalidFilterKeyException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30 days.
This is a convenience which creates an instance of the DescribeSessionsRequest.Builder
avoiding the need
to create one manually via DescribeSessionsRequest.builder()
describeSessionsRequest
- A Consumer
that will call methods on DescribeSessionsRequest.Builder
to create a request.InternalServerErrorException
- An error occurred on the server side.InvalidFilterKeyException
- The specified key is not valid.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 DescribeSessionsIterable describeSessionsPaginator(DescribeSessionsRequest describeSessionsRequest) throws InternalServerErrorException, InvalidFilterKeyException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30 days.
This is a variant of describeSessions(software.amazon.awssdk.services.ssm.model.DescribeSessionsRequest)
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.DescribeSessionsIterable responses = client.describeSessionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.DescribeSessionsIterable responses = client.describeSessionsPaginator(request); for (software.amazon.awssdk.services.ssm.model.DescribeSessionsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.DescribeSessionsIterable responses = client.describeSessionsPaginator(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
describeSessions(software.amazon.awssdk.services.ssm.model.DescribeSessionsRequest)
operation.
describeSessionsRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidFilterKeyException
- The specified key is not valid.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 DescribeSessionsIterable describeSessionsPaginator(Consumer<DescribeSessionsRequest.Builder> describeSessionsRequest) throws InternalServerErrorException, InvalidFilterKeyException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30 days.
This is a variant of describeSessions(software.amazon.awssdk.services.ssm.model.DescribeSessionsRequest)
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.DescribeSessionsIterable responses = client.describeSessionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.DescribeSessionsIterable responses = client.describeSessionsPaginator(request); for (software.amazon.awssdk.services.ssm.model.DescribeSessionsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.DescribeSessionsIterable responses = client.describeSessionsPaginator(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
describeSessions(software.amazon.awssdk.services.ssm.model.DescribeSessionsRequest)
operation.
This is a convenience which creates an instance of the DescribeSessionsRequest.Builder
avoiding the need
to create one manually via DescribeSessionsRequest.builder()
describeSessionsRequest
- A Consumer
that will call methods on DescribeSessionsRequest.Builder
to create a request.InternalServerErrorException
- An error occurred on the server side.InvalidFilterKeyException
- The specified key is not valid.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 GetAutomationExecutionResponse getAutomationExecution(GetAutomationExecutionRequest getAutomationExecutionRequest) throws AutomationExecutionNotFoundException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Get detailed information about a particular Automation execution.
getAutomationExecutionRequest
- AutomationExecutionNotFoundException
- There is no automation execution information for the requested automation execution ID.InternalServerErrorException
- An error occurred on the server side.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 GetAutomationExecutionResponse getAutomationExecution(Consumer<GetAutomationExecutionRequest.Builder> getAutomationExecutionRequest) throws AutomationExecutionNotFoundException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Get detailed information about a particular Automation execution.
This is a convenience which creates an instance of the GetAutomationExecutionRequest.Builder
avoiding the
need to create one manually via GetAutomationExecutionRequest.builder()
getAutomationExecutionRequest
- A Consumer
that will call methods on GetAutomationExecutionRequest.Builder
to create a
request.AutomationExecutionNotFoundException
- There is no automation execution information for the requested automation execution ID.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 GetCalendarStateResponse getCalendarState(GetCalendarStateRequest getCalendarStateRequest) throws InternalServerErrorException, InvalidDocumentException, InvalidDocumentTypeException, UnsupportedCalendarException, AwsServiceException, SdkClientException, SsmException
Gets the state of the AWS Systems Manager Change Calendar at an optional, specified time. If you specify a time,
GetCalendarState
returns the state of the calendar at a specific time, and returns the next time
that the Change Calendar state will transition. If you do not specify a time, GetCalendarState
assumes the current time. Change Calendar entries have two possible states: OPEN
or
CLOSED
.
If you specify more than one calendar in a request, the command returns the status of OPEN
only if
all calendars in the request are open. If one or more calendars in the request are closed, the status returned is
CLOSED
.
For more information about Systems Manager Change Calendar, see AWS Systems Manager Change Calendar in the AWS Systems Manager User Guide.
getCalendarStateRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidDocumentException
- The specified document does not exist.InvalidDocumentTypeException
- The document type is not valid. Valid document types are described in the DocumentType
property.UnsupportedCalendarException
- The calendar entry contained in the specified Systems Manager document 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 GetCalendarStateResponse getCalendarState(Consumer<GetCalendarStateRequest.Builder> getCalendarStateRequest) throws InternalServerErrorException, InvalidDocumentException, InvalidDocumentTypeException, UnsupportedCalendarException, AwsServiceException, SdkClientException, SsmException
Gets the state of the AWS Systems Manager Change Calendar at an optional, specified time. If you specify a time,
GetCalendarState
returns the state of the calendar at a specific time, and returns the next time
that the Change Calendar state will transition. If you do not specify a time, GetCalendarState
assumes the current time. Change Calendar entries have two possible states: OPEN
or
CLOSED
.
If you specify more than one calendar in a request, the command returns the status of OPEN
only if
all calendars in the request are open. If one or more calendars in the request are closed, the status returned is
CLOSED
.
For more information about Systems Manager Change Calendar, see AWS Systems Manager Change Calendar in the AWS Systems Manager User Guide.
This is a convenience which creates an instance of the GetCalendarStateRequest.Builder
avoiding the need
to create one manually via GetCalendarStateRequest.builder()
getCalendarStateRequest
- A Consumer
that will call methods on GetCalendarStateRequest.Builder
to create a request.InternalServerErrorException
- An error occurred on the server side.InvalidDocumentException
- The specified document does not exist.InvalidDocumentTypeException
- The document type is not valid. Valid document types are described in the DocumentType
property.UnsupportedCalendarException
- The calendar entry contained in the specified Systems Manager document 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 GetCommandInvocationResponse getCommandInvocation(GetCommandInvocationRequest getCommandInvocationRequest) throws InternalServerErrorException, InvalidCommandIdException, InvalidInstanceIdException, InvalidPluginNameException, InvocationDoesNotExistException, AwsServiceException, SdkClientException, SsmException
Returns detailed information about command execution for an invocation or plugin.
getCommandInvocationRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidCommandIdException
InvalidInstanceIdException
- The following problems can cause this exception:
You do not have permission to access the instance.
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.
InvalidPluginNameException
- The plugin name is not valid.InvocationDoesNotExistException
- The command ID and instance ID you specified did not match any invocations. Verify the command ID and the
instance ID 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 GetCommandInvocationResponse getCommandInvocation(Consumer<GetCommandInvocationRequest.Builder> getCommandInvocationRequest) throws InternalServerErrorException, InvalidCommandIdException, InvalidInstanceIdException, InvalidPluginNameException, InvocationDoesNotExistException, AwsServiceException, SdkClientException, SsmException
Returns detailed information about command execution for an invocation or plugin.
This is a convenience which creates an instance of the GetCommandInvocationRequest.Builder
avoiding the
need to create one manually via GetCommandInvocationRequest.builder()
getCommandInvocationRequest
- A Consumer
that will call methods on GetCommandInvocationRequest.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.
InvalidPluginNameException
- The plugin name is not valid.InvocationDoesNotExistException
- The command ID and instance ID you specified did not match any invocations. Verify the command ID and the
instance ID 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 GetConnectionStatusResponse getConnectionStatus(GetConnectionStatusRequest getConnectionStatusRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Retrieves the Session Manager connection status for an instance to determine whether it is running and ready to receive Session Manager connections.
getConnectionStatusRequest
- 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 GetConnectionStatusResponse getConnectionStatus(Consumer<GetConnectionStatusRequest.Builder> getConnectionStatusRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Retrieves the Session Manager connection status for an instance to determine whether it is running and ready to receive Session Manager connections.
This is a convenience which creates an instance of the GetConnectionStatusRequest.Builder
avoiding the
need to create one manually via GetConnectionStatusRequest.builder()
getConnectionStatusRequest
- A Consumer
that will call methods on GetConnectionStatusRequest.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 GetDefaultPatchBaselineResponse getDefaultPatchBaseline() throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Retrieves the default patch baseline. Note that Systems Manager supports creating multiple default patch baselines. For example, you can create a default patch baseline for each operating system.
If you do not specify an operating system value, the default patch baseline for Windows is returned.
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
getDefaultPatchBaseline(GetDefaultPatchBaselineRequest)
,
AWS
API Documentationdefault GetDefaultPatchBaselineResponse getDefaultPatchBaseline(GetDefaultPatchBaselineRequest getDefaultPatchBaselineRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Retrieves the default patch baseline. Note that Systems Manager supports creating multiple default patch baselines. For example, you can create a default patch baseline for each operating system.
If you do not specify an operating system value, the default patch baseline for Windows is returned.
getDefaultPatchBaselineRequest
- 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 GetDefaultPatchBaselineResponse getDefaultPatchBaseline(Consumer<GetDefaultPatchBaselineRequest.Builder> getDefaultPatchBaselineRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Retrieves the default patch baseline. Note that Systems Manager supports creating multiple default patch baselines. For example, you can create a default patch baseline for each operating system.
If you do not specify an operating system value, the default patch baseline for Windows is returned.
This is a convenience which creates an instance of the GetDefaultPatchBaselineRequest.Builder
avoiding
the need to create one manually via GetDefaultPatchBaselineRequest.builder()
getDefaultPatchBaselineRequest
- A Consumer
that will call methods on GetDefaultPatchBaselineRequest.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 GetDeployablePatchSnapshotForInstanceResponse getDeployablePatchSnapshotForInstance(GetDeployablePatchSnapshotForInstanceRequest getDeployablePatchSnapshotForInstanceRequest) throws InternalServerErrorException, UnsupportedOperatingSystemException, UnsupportedFeatureRequiredException, AwsServiceException, SdkClientException, SsmException
Retrieves the current snapshot for the patch baseline the instance uses. This API is primarily used by the AWS-RunPatchBaseline Systems Manager document.
getDeployablePatchSnapshotForInstanceRequest
- InternalServerErrorException
- An error occurred on the server side.UnsupportedOperatingSystemException
- The operating systems you specified is not supported, or the operation is not supported for the operating
system. Valid operating systems include: Windows, AmazonLinux, RedhatEnterpriseLinux, and Ubuntu.UnsupportedFeatureRequiredException
- Microsoft application patching is only available on EC2 instances and advanced instances. To patch
Microsoft applications on on-premises servers and VMs, you must enable advanced instances. For more
information, see Using the advanced-instances tier in the AWS Systems Manager User Guide.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 GetDeployablePatchSnapshotForInstanceResponse getDeployablePatchSnapshotForInstance(Consumer<GetDeployablePatchSnapshotForInstanceRequest.Builder> getDeployablePatchSnapshotForInstanceRequest) throws InternalServerErrorException, UnsupportedOperatingSystemException, UnsupportedFeatureRequiredException, AwsServiceException, SdkClientException, SsmException
Retrieves the current snapshot for the patch baseline the instance uses. This API is primarily used by the AWS-RunPatchBaseline Systems Manager document.
This is a convenience which creates an instance of the
GetDeployablePatchSnapshotForInstanceRequest.Builder
avoiding the need to create one manually via
GetDeployablePatchSnapshotForInstanceRequest.builder()
getDeployablePatchSnapshotForInstanceRequest
- A Consumer
that will call methods on GetDeployablePatchSnapshotForInstanceRequest.Builder
to create a request.InternalServerErrorException
- An error occurred on the server side.UnsupportedOperatingSystemException
- The operating systems you specified is not supported, or the operation is not supported for the operating
system. Valid operating systems include: Windows, AmazonLinux, RedhatEnterpriseLinux, and Ubuntu.UnsupportedFeatureRequiredException
- Microsoft application patching is only available on EC2 instances and advanced instances. To patch
Microsoft applications on on-premises servers and VMs, you must enable advanced instances. For more
information, see Using the advanced-instances tier in the AWS Systems Manager User Guide.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 GetDocumentResponse getDocument(GetDocumentRequest getDocumentRequest) throws InternalServerErrorException, InvalidDocumentException, InvalidDocumentVersionException, AwsServiceException, SdkClientException, SsmException
Gets the contents of the specified Systems Manager document.
getDocumentRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidDocumentException
- The specified document does not exist.InvalidDocumentVersionException
- The document version is not valid or does not exist.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 GetDocumentResponse getDocument(Consumer<GetDocumentRequest.Builder> getDocumentRequest) throws InternalServerErrorException, InvalidDocumentException, InvalidDocumentVersionException, AwsServiceException, SdkClientException, SsmException
Gets the contents of the specified Systems Manager document.
This is a convenience which creates an instance of the GetDocumentRequest.Builder
avoiding the need to
create one manually via GetDocumentRequest.builder()
getDocumentRequest
- A Consumer
that will call methods on GetDocumentRequest.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 GetInventoryResponse getInventory() throws InternalServerErrorException, InvalidFilterException, InvalidInventoryGroupException, InvalidNextTokenException, InvalidTypeNameException, InvalidAggregatorException, InvalidResultAttributeException, AwsServiceException, SdkClientException, SsmException
Query inventory information.
InternalServerErrorException
- An error occurred on the server side.InvalidFilterException
- The filter name is not valid. Verify the you entered the correct name and try again.InvalidInventoryGroupException
- The specified inventory group is not valid.InvalidNextTokenException
- The specified token is not valid.InvalidTypeNameException
- The parameter type name is not valid.InvalidAggregatorException
- The specified aggregator is not valid for inventory groups. Verify that the aggregator uses a valid
inventory type such as AWS:Application
or AWS:InstanceInformation
.InvalidResultAttributeException
- The specified inventory item result attribute 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
getInventory(GetInventoryRequest)
,
AWS API
Documentationdefault GetInventoryResponse getInventory(GetInventoryRequest getInventoryRequest) throws InternalServerErrorException, InvalidFilterException, InvalidInventoryGroupException, InvalidNextTokenException, InvalidTypeNameException, InvalidAggregatorException, InvalidResultAttributeException, AwsServiceException, SdkClientException, SsmException
Query inventory information.
getInventoryRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidFilterException
- The filter name is not valid. Verify the you entered the correct name and try again.InvalidInventoryGroupException
- The specified inventory group is not valid.InvalidNextTokenException
- The specified token is not valid.InvalidTypeNameException
- The parameter type name is not valid.InvalidAggregatorException
- The specified aggregator is not valid for inventory groups. Verify that the aggregator uses a valid
inventory type such as AWS:Application
or AWS:InstanceInformation
.InvalidResultAttributeException
- The specified inventory item result attribute 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 GetInventoryResponse getInventory(Consumer<GetInventoryRequest.Builder> getInventoryRequest) throws InternalServerErrorException, InvalidFilterException, InvalidInventoryGroupException, InvalidNextTokenException, InvalidTypeNameException, InvalidAggregatorException, InvalidResultAttributeException, AwsServiceException, SdkClientException, SsmException
Query inventory information.
This is a convenience which creates an instance of the GetInventoryRequest.Builder
avoiding the need to
create one manually via GetInventoryRequest.builder()
getInventoryRequest
- A Consumer
that will call methods on GetInventoryRequest.Builder
to create a request.InternalServerErrorException
- An error occurred on the server side.InvalidFilterException
- The filter name is not valid. Verify the you entered the correct name and try again.InvalidInventoryGroupException
- The specified inventory group is not valid.InvalidNextTokenException
- The specified token is not valid.InvalidTypeNameException
- The parameter type name is not valid.InvalidAggregatorException
- The specified aggregator is not valid for inventory groups. Verify that the aggregator uses a valid
inventory type such as AWS:Application
or AWS:InstanceInformation
.InvalidResultAttributeException
- The specified inventory item result attribute 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 GetInventoryIterable getInventoryPaginator() throws InternalServerErrorException, InvalidFilterException, InvalidInventoryGroupException, InvalidNextTokenException, InvalidTypeNameException, InvalidAggregatorException, InvalidResultAttributeException, AwsServiceException, SdkClientException, SsmException
Query inventory information.
This is a variant of getInventory(software.amazon.awssdk.services.ssm.model.GetInventoryRequest)
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.GetInventoryIterable responses = client.getInventoryPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.GetInventoryIterable responses = client.getInventoryPaginator(request); for (software.amazon.awssdk.services.ssm.model.GetInventoryResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.GetInventoryIterable responses = client.getInventoryPaginator(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
getInventory(software.amazon.awssdk.services.ssm.model.GetInventoryRequest)
operation.
InternalServerErrorException
- An error occurred on the server side.InvalidFilterException
- The filter name is not valid. Verify the you entered the correct name and try again.InvalidInventoryGroupException
- The specified inventory group is not valid.InvalidNextTokenException
- The specified token is not valid.InvalidTypeNameException
- The parameter type name is not valid.InvalidAggregatorException
- The specified aggregator is not valid for inventory groups. Verify that the aggregator uses a valid
inventory type such as AWS:Application
or AWS:InstanceInformation
.InvalidResultAttributeException
- The specified inventory item result attribute 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
getInventoryPaginator(GetInventoryRequest)
,
AWS API
Documentationdefault GetInventoryIterable getInventoryPaginator(GetInventoryRequest getInventoryRequest) throws InternalServerErrorException, InvalidFilterException, InvalidInventoryGroupException, InvalidNextTokenException, InvalidTypeNameException, InvalidAggregatorException, InvalidResultAttributeException, AwsServiceException, SdkClientException, SsmException
Query inventory information.
This is a variant of getInventory(software.amazon.awssdk.services.ssm.model.GetInventoryRequest)
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.GetInventoryIterable responses = client.getInventoryPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.GetInventoryIterable responses = client.getInventoryPaginator(request); for (software.amazon.awssdk.services.ssm.model.GetInventoryResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.GetInventoryIterable responses = client.getInventoryPaginator(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
getInventory(software.amazon.awssdk.services.ssm.model.GetInventoryRequest)
operation.
getInventoryRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidFilterException
- The filter name is not valid. Verify the you entered the correct name and try again.InvalidInventoryGroupException
- The specified inventory group is not valid.InvalidNextTokenException
- The specified token is not valid.InvalidTypeNameException
- The parameter type name is not valid.InvalidAggregatorException
- The specified aggregator is not valid for inventory groups. Verify that the aggregator uses a valid
inventory type such as AWS:Application
or AWS:InstanceInformation
.InvalidResultAttributeException
- The specified inventory item result attribute 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 GetInventoryIterable getInventoryPaginator(Consumer<GetInventoryRequest.Builder> getInventoryRequest) throws InternalServerErrorException, InvalidFilterException, InvalidInventoryGroupException, InvalidNextTokenException, InvalidTypeNameException, InvalidAggregatorException, InvalidResultAttributeException, AwsServiceException, SdkClientException, SsmException
Query inventory information.
This is a variant of getInventory(software.amazon.awssdk.services.ssm.model.GetInventoryRequest)
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.GetInventoryIterable responses = client.getInventoryPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.GetInventoryIterable responses = client.getInventoryPaginator(request); for (software.amazon.awssdk.services.ssm.model.GetInventoryResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.GetInventoryIterable responses = client.getInventoryPaginator(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
getInventory(software.amazon.awssdk.services.ssm.model.GetInventoryRequest)
operation.
This is a convenience which creates an instance of the GetInventoryRequest.Builder
avoiding the need to
create one manually via GetInventoryRequest.builder()
getInventoryRequest
- A Consumer
that will call methods on GetInventoryRequest.Builder
to create a request.InternalServerErrorException
- An error occurred on the server side.InvalidFilterException
- The filter name is not valid. Verify the you entered the correct name and try again.InvalidInventoryGroupException
- The specified inventory group is not valid.InvalidNextTokenException
- The specified token is not valid.InvalidTypeNameException
- The parameter type name is not valid.InvalidAggregatorException
- The specified aggregator is not valid for inventory groups. Verify that the aggregator uses a valid
inventory type such as AWS:Application
or AWS:InstanceInformation
.InvalidResultAttributeException
- The specified inventory item result attribute 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 GetInventorySchemaResponse getInventorySchema() throws InternalServerErrorException, InvalidTypeNameException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Return a list of inventory type names for the account, or return a list of attribute names for a specific Inventory item type.
InternalServerErrorException
- An error occurred on the server side.InvalidTypeNameException
- The parameter type name is not valid.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
getInventorySchema(GetInventorySchemaRequest)
,
AWS API
Documentationdefault GetInventorySchemaResponse getInventorySchema(GetInventorySchemaRequest getInventorySchemaRequest) throws InternalServerErrorException, InvalidTypeNameException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Return a list of inventory type names for the account, or return a list of attribute names for a specific Inventory item type.
getInventorySchemaRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidTypeNameException
- The parameter type name is not valid.InvalidNextTokenException
- The specified token is not valid.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 GetInventorySchemaResponse getInventorySchema(Consumer<GetInventorySchemaRequest.Builder> getInventorySchemaRequest) throws InternalServerErrorException, InvalidTypeNameException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Return a list of inventory type names for the account, or return a list of attribute names for a specific Inventory item type.
This is a convenience which creates an instance of the GetInventorySchemaRequest.Builder
avoiding the
need to create one manually via GetInventorySchemaRequest.builder()
getInventorySchemaRequest
- A Consumer
that will call methods on GetInventorySchemaRequest.Builder
to create a
request.InternalServerErrorException
- An error occurred on the server side.InvalidTypeNameException
- The parameter type name is not valid.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 GetInventorySchemaIterable getInventorySchemaPaginator() throws InternalServerErrorException, InvalidTypeNameException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Return a list of inventory type names for the account, or return a list of attribute names for a specific Inventory item type.
This is a variant of
getInventorySchema(software.amazon.awssdk.services.ssm.model.GetInventorySchemaRequest)
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.GetInventorySchemaIterable responses = client.getInventorySchemaPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.GetInventorySchemaIterable responses = client .getInventorySchemaPaginator(request); for (software.amazon.awssdk.services.ssm.model.GetInventorySchemaResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.GetInventorySchemaIterable responses = client.getInventorySchemaPaginator(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
getInventorySchema(software.amazon.awssdk.services.ssm.model.GetInventorySchemaRequest)
operation.
InternalServerErrorException
- An error occurred on the server side.InvalidTypeNameException
- The parameter type name is not valid.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
getInventorySchemaPaginator(GetInventorySchemaRequest)
,
AWS API
Documentationdefault GetInventorySchemaIterable getInventorySchemaPaginator(GetInventorySchemaRequest getInventorySchemaRequest) throws InternalServerErrorException, InvalidTypeNameException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Return a list of inventory type names for the account, or return a list of attribute names for a specific Inventory item type.
This is a variant of
getInventorySchema(software.amazon.awssdk.services.ssm.model.GetInventorySchemaRequest)
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.GetInventorySchemaIterable responses = client.getInventorySchemaPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.GetInventorySchemaIterable responses = client .getInventorySchemaPaginator(request); for (software.amazon.awssdk.services.ssm.model.GetInventorySchemaResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.GetInventorySchemaIterable responses = client.getInventorySchemaPaginator(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
getInventorySchema(software.amazon.awssdk.services.ssm.model.GetInventorySchemaRequest)
operation.
getInventorySchemaRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidTypeNameException
- The parameter type name is not valid.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 GetInventorySchemaIterable getInventorySchemaPaginator(Consumer<GetInventorySchemaRequest.Builder> getInventorySchemaRequest) throws InternalServerErrorException, InvalidTypeNameException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Return a list of inventory type names for the account, or return a list of attribute names for a specific Inventory item type.
This is a variant of
getInventorySchema(software.amazon.awssdk.services.ssm.model.GetInventorySchemaRequest)
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.GetInventorySchemaIterable responses = client.getInventorySchemaPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.GetInventorySchemaIterable responses = client .getInventorySchemaPaginator(request); for (software.amazon.awssdk.services.ssm.model.GetInventorySchemaResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.GetInventorySchemaIterable responses = client.getInventorySchemaPaginator(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
getInventorySchema(software.amazon.awssdk.services.ssm.model.GetInventorySchemaRequest)
operation.
This is a convenience which creates an instance of the GetInventorySchemaRequest.Builder
avoiding the
need to create one manually via GetInventorySchemaRequest.builder()
getInventorySchemaRequest
- A Consumer
that will call methods on GetInventorySchemaRequest.Builder
to create a
request.InternalServerErrorException
- An error occurred on the server side.InvalidTypeNameException
- The parameter type name is not valid.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 GetMaintenanceWindowResponse getMaintenanceWindow(GetMaintenanceWindowRequest getMaintenanceWindowRequest) throws DoesNotExistException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Retrieves a maintenance window.
getMaintenanceWindowRequest
- 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 GetMaintenanceWindowResponse getMaintenanceWindow(Consumer<GetMaintenanceWindowRequest.Builder> getMaintenanceWindowRequest) throws DoesNotExistException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Retrieves a maintenance window.
This is a convenience which creates an instance of the GetMaintenanceWindowRequest.Builder
avoiding the
need to create one manually via GetMaintenanceWindowRequest.builder()
getMaintenanceWindowRequest
- A Consumer
that will call methods on GetMaintenanceWindowRequest.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 GetMaintenanceWindowExecutionResponse getMaintenanceWindowExecution(GetMaintenanceWindowExecutionRequest getMaintenanceWindowExecutionRequest) throws DoesNotExistException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Retrieves details about a specific a maintenance window execution.
getMaintenanceWindowExecutionRequest
- 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 GetMaintenanceWindowExecutionResponse getMaintenanceWindowExecution(Consumer<GetMaintenanceWindowExecutionRequest.Builder> getMaintenanceWindowExecutionRequest) throws DoesNotExistException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Retrieves details about a specific a maintenance window execution.
This is a convenience which creates an instance of the GetMaintenanceWindowExecutionRequest.Builder
avoiding the need to create one manually via GetMaintenanceWindowExecutionRequest.builder()
getMaintenanceWindowExecutionRequest
- A Consumer
that will call methods on GetMaintenanceWindowExecutionRequest.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 GetMaintenanceWindowExecutionTaskResponse getMaintenanceWindowExecutionTask(GetMaintenanceWindowExecutionTaskRequest getMaintenanceWindowExecutionTaskRequest) throws DoesNotExistException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Retrieves the details about a specific task run as part of a maintenance window execution.
getMaintenanceWindowExecutionTaskRequest
- 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 GetMaintenanceWindowExecutionTaskResponse getMaintenanceWindowExecutionTask(Consumer<GetMaintenanceWindowExecutionTaskRequest.Builder> getMaintenanceWindowExecutionTaskRequest) throws DoesNotExistException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Retrieves the details about a specific task run as part of a maintenance window execution.
This is a convenience which creates an instance of the GetMaintenanceWindowExecutionTaskRequest.Builder
avoiding the need to create one manually via GetMaintenanceWindowExecutionTaskRequest.builder()
getMaintenanceWindowExecutionTaskRequest
- A Consumer
that will call methods on GetMaintenanceWindowExecutionTaskRequest.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 GetMaintenanceWindowExecutionTaskInvocationResponse getMaintenanceWindowExecutionTaskInvocation(GetMaintenanceWindowExecutionTaskInvocationRequest getMaintenanceWindowExecutionTaskInvocationRequest) throws DoesNotExistException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Retrieves information about a specific task running on a specific target.
getMaintenanceWindowExecutionTaskInvocationRequest
- 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 GetMaintenanceWindowExecutionTaskInvocationResponse getMaintenanceWindowExecutionTaskInvocation(Consumer<GetMaintenanceWindowExecutionTaskInvocationRequest.Builder> getMaintenanceWindowExecutionTaskInvocationRequest) throws DoesNotExistException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Retrieves information about a specific task running on a specific target.
This is a convenience which creates an instance of the
GetMaintenanceWindowExecutionTaskInvocationRequest.Builder
avoiding the need to create one manually via
GetMaintenanceWindowExecutionTaskInvocationRequest.builder()
getMaintenanceWindowExecutionTaskInvocationRequest
- A Consumer
that will call methods on
GetMaintenanceWindowExecutionTaskInvocationRequest.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 GetMaintenanceWindowTaskResponse getMaintenanceWindowTask(GetMaintenanceWindowTaskRequest getMaintenanceWindowTaskRequest) throws DoesNotExistException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Lists the tasks in a maintenance window.
getMaintenanceWindowTaskRequest
- 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 GetMaintenanceWindowTaskResponse getMaintenanceWindowTask(Consumer<GetMaintenanceWindowTaskRequest.Builder> getMaintenanceWindowTaskRequest) throws DoesNotExistException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Lists the tasks in a maintenance window.
This is a convenience which creates an instance of the GetMaintenanceWindowTaskRequest.Builder
avoiding
the need to create one manually via GetMaintenanceWindowTaskRequest.builder()
getMaintenanceWindowTaskRequest
- A Consumer
that will call methods on GetMaintenanceWindowTaskRequest.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 GetOpsItemResponse getOpsItem(GetOpsItemRequest getOpsItemRequest) throws InternalServerErrorException, OpsItemNotFoundException, AwsServiceException, SdkClientException, SsmException
Get information about an OpsItem by using the ID. You must have permission in AWS Identity and Access Management (IAM) to view information about an 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.
getOpsItemRequest
- InternalServerErrorException
- An error occurred on the server side.OpsItemNotFoundException
- The specified OpsItem ID doesn't exist. Verify the ID 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 GetOpsItemResponse getOpsItem(Consumer<GetOpsItemRequest.Builder> getOpsItemRequest) throws InternalServerErrorException, OpsItemNotFoundException, AwsServiceException, SdkClientException, SsmException
Get information about an OpsItem by using the ID. You must have permission in AWS Identity and Access Management (IAM) to view information about an 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 GetOpsItemRequest.Builder
avoiding the need to
create one manually via GetOpsItemRequest.builder()
getOpsItemRequest
- A Consumer
that will call methods on GetOpsItemRequest.Builder
to create a request.InternalServerErrorException
- An error occurred on the server side.OpsItemNotFoundException
- The specified OpsItem ID doesn't exist. Verify the ID 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 GetOpsSummaryResponse getOpsSummary(GetOpsSummaryRequest getOpsSummaryRequest) throws InternalServerErrorException, ResourceDataSyncNotFoundException, InvalidFilterException, InvalidNextTokenException, InvalidTypeNameException, InvalidAggregatorException, AwsServiceException, SdkClientException, SsmException
View a summary of OpsItems based on specified filters and aggregators.
getOpsSummaryRequest
- InternalServerErrorException
- An error occurred on the server side.ResourceDataSyncNotFoundException
- The specified sync name was not found.InvalidFilterException
- The filter name is not valid. Verify the you entered the correct name and try again.InvalidNextTokenException
- The specified token is not valid.InvalidTypeNameException
- The parameter type name is not valid.InvalidAggregatorException
- The specified aggregator is not valid for inventory groups. Verify that the aggregator uses a valid
inventory type such as AWS:Application
or AWS:InstanceInformation
.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 GetOpsSummaryResponse getOpsSummary(Consumer<GetOpsSummaryRequest.Builder> getOpsSummaryRequest) throws InternalServerErrorException, ResourceDataSyncNotFoundException, InvalidFilterException, InvalidNextTokenException, InvalidTypeNameException, InvalidAggregatorException, AwsServiceException, SdkClientException, SsmException
View a summary of OpsItems based on specified filters and aggregators.
This is a convenience which creates an instance of the GetOpsSummaryRequest.Builder
avoiding the need to
create one manually via GetOpsSummaryRequest.builder()
getOpsSummaryRequest
- A Consumer
that will call methods on GetOpsSummaryRequest.Builder
to create a request.InternalServerErrorException
- An error occurred on the server side.ResourceDataSyncNotFoundException
- The specified sync name was not found.InvalidFilterException
- The filter name is not valid. Verify the you entered the correct name and try again.InvalidNextTokenException
- The specified token is not valid.InvalidTypeNameException
- The parameter type name is not valid.InvalidAggregatorException
- The specified aggregator is not valid for inventory groups. Verify that the aggregator uses a valid
inventory type such as AWS:Application
or AWS:InstanceInformation
.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 GetOpsSummaryIterable getOpsSummaryPaginator(GetOpsSummaryRequest getOpsSummaryRequest) throws InternalServerErrorException, ResourceDataSyncNotFoundException, InvalidFilterException, InvalidNextTokenException, InvalidTypeNameException, InvalidAggregatorException, AwsServiceException, SdkClientException, SsmException
View a summary of OpsItems based on specified filters and aggregators.
This is a variant of getOpsSummary(software.amazon.awssdk.services.ssm.model.GetOpsSummaryRequest)
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.GetOpsSummaryIterable responses = client.getOpsSummaryPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.GetOpsSummaryIterable responses = client.getOpsSummaryPaginator(request); for (software.amazon.awssdk.services.ssm.model.GetOpsSummaryResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.GetOpsSummaryIterable responses = client.getOpsSummaryPaginator(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
getOpsSummary(software.amazon.awssdk.services.ssm.model.GetOpsSummaryRequest)
operation.
getOpsSummaryRequest
- InternalServerErrorException
- An error occurred on the server side.ResourceDataSyncNotFoundException
- The specified sync name was not found.InvalidFilterException
- The filter name is not valid. Verify the you entered the correct name and try again.InvalidNextTokenException
- The specified token is not valid.InvalidTypeNameException
- The parameter type name is not valid.InvalidAggregatorException
- The specified aggregator is not valid for inventory groups. Verify that the aggregator uses a valid
inventory type such as AWS:Application
or AWS:InstanceInformation
.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 GetOpsSummaryIterable getOpsSummaryPaginator(Consumer<GetOpsSummaryRequest.Builder> getOpsSummaryRequest) throws InternalServerErrorException, ResourceDataSyncNotFoundException, InvalidFilterException, InvalidNextTokenException, InvalidTypeNameException, InvalidAggregatorException, AwsServiceException, SdkClientException, SsmException
View a summary of OpsItems based on specified filters and aggregators.
This is a variant of getOpsSummary(software.amazon.awssdk.services.ssm.model.GetOpsSummaryRequest)
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.GetOpsSummaryIterable responses = client.getOpsSummaryPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.GetOpsSummaryIterable responses = client.getOpsSummaryPaginator(request); for (software.amazon.awssdk.services.ssm.model.GetOpsSummaryResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.GetOpsSummaryIterable responses = client.getOpsSummaryPaginator(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
getOpsSummary(software.amazon.awssdk.services.ssm.model.GetOpsSummaryRequest)
operation.
This is a convenience which creates an instance of the GetOpsSummaryRequest.Builder
avoiding the need to
create one manually via GetOpsSummaryRequest.builder()
getOpsSummaryRequest
- A Consumer
that will call methods on GetOpsSummaryRequest.Builder
to create a request.InternalServerErrorException
- An error occurred on the server side.ResourceDataSyncNotFoundException
- The specified sync name was not found.InvalidFilterException
- The filter name is not valid. Verify the you entered the correct name and try again.InvalidNextTokenException
- The specified token is not valid.InvalidTypeNameException
- The parameter type name is not valid.InvalidAggregatorException
- The specified aggregator is not valid for inventory groups. Verify that the aggregator uses a valid
inventory type such as AWS:Application
or AWS:InstanceInformation
.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 GetParameterResponse getParameter(GetParameterRequest getParameterRequest) throws InternalServerErrorException, InvalidKeyIdException, ParameterNotFoundException, ParameterVersionNotFoundException, AwsServiceException, SdkClientException, SsmException
Get information about a parameter by using the parameter name. Don't confuse this API action with the GetParameters API action.
getParameterRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidKeyIdException
- The query key ID is not valid.ParameterNotFoundException
- The parameter could not be found. Verify the name and try again.ParameterVersionNotFoundException
- The specified parameter version was not found. Verify the parameter name and version, and try again.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 GetParameterResponse getParameter(Consumer<GetParameterRequest.Builder> getParameterRequest) throws InternalServerErrorException, InvalidKeyIdException, ParameterNotFoundException, ParameterVersionNotFoundException, AwsServiceException, SdkClientException, SsmException
Get information about a parameter by using the parameter name. Don't confuse this API action with the GetParameters API action.
This is a convenience which creates an instance of the GetParameterRequest.Builder
avoiding the need to
create one manually via GetParameterRequest.builder()
getParameterRequest
- A Consumer
that will call methods on GetParameterRequest.Builder
to create a request.InternalServerErrorException
- An error occurred on the server side.InvalidKeyIdException
- The query key ID is not valid.ParameterNotFoundException
- The parameter could not be found. Verify the name and try again.ParameterVersionNotFoundException
- The specified parameter version was not found. Verify the parameter name and version, and try again.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 GetParameterHistoryResponse getParameterHistory(GetParameterHistoryRequest getParameterHistoryRequest) throws InternalServerErrorException, ParameterNotFoundException, InvalidNextTokenException, InvalidKeyIdException, AwsServiceException, SdkClientException, SsmException
Query a list of all parameters used by the AWS account.
getParameterHistoryRequest
- InternalServerErrorException
- An error occurred on the server side.ParameterNotFoundException
- The parameter could not be found. Verify the name and try again.InvalidNextTokenException
- The specified token is not valid.InvalidKeyIdException
- The query key ID is not valid.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 GetParameterHistoryResponse getParameterHistory(Consumer<GetParameterHistoryRequest.Builder> getParameterHistoryRequest) throws InternalServerErrorException, ParameterNotFoundException, InvalidNextTokenException, InvalidKeyIdException, AwsServiceException, SdkClientException, SsmException
Query a list of all parameters used by the AWS account.
This is a convenience which creates an instance of the GetParameterHistoryRequest.Builder
avoiding the
need to create one manually via GetParameterHistoryRequest.builder()
getParameterHistoryRequest
- A Consumer
that will call methods on GetParameterHistoryRequest.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.InvalidNextTokenException
- The specified token is not valid.InvalidKeyIdException
- The query key ID 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 GetParameterHistoryIterable getParameterHistoryPaginator(GetParameterHistoryRequest getParameterHistoryRequest) throws InternalServerErrorException, ParameterNotFoundException, InvalidNextTokenException, InvalidKeyIdException, AwsServiceException, SdkClientException, SsmException
Query a list of all parameters used by the AWS account.
This is a variant of
getParameterHistory(software.amazon.awssdk.services.ssm.model.GetParameterHistoryRequest)
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.GetParameterHistoryIterable responses = client.getParameterHistoryPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.GetParameterHistoryIterable responses = client .getParameterHistoryPaginator(request); for (software.amazon.awssdk.services.ssm.model.GetParameterHistoryResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.GetParameterHistoryIterable responses = client.getParameterHistoryPaginator(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
getParameterHistory(software.amazon.awssdk.services.ssm.model.GetParameterHistoryRequest)
operation.
getParameterHistoryRequest
- InternalServerErrorException
- An error occurred on the server side.ParameterNotFoundException
- The parameter could not be found. Verify the name and try again.InvalidNextTokenException
- The specified token is not valid.InvalidKeyIdException
- The query key ID is not valid.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 GetParameterHistoryIterable getParameterHistoryPaginator(Consumer<GetParameterHistoryRequest.Builder> getParameterHistoryRequest) throws InternalServerErrorException, ParameterNotFoundException, InvalidNextTokenException, InvalidKeyIdException, AwsServiceException, SdkClientException, SsmException
Query a list of all parameters used by the AWS account.
This is a variant of
getParameterHistory(software.amazon.awssdk.services.ssm.model.GetParameterHistoryRequest)
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.GetParameterHistoryIterable responses = client.getParameterHistoryPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.GetParameterHistoryIterable responses = client .getParameterHistoryPaginator(request); for (software.amazon.awssdk.services.ssm.model.GetParameterHistoryResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.GetParameterHistoryIterable responses = client.getParameterHistoryPaginator(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
getParameterHistory(software.amazon.awssdk.services.ssm.model.GetParameterHistoryRequest)
operation.
This is a convenience which creates an instance of the GetParameterHistoryRequest.Builder
avoiding the
need to create one manually via GetParameterHistoryRequest.builder()
getParameterHistoryRequest
- A Consumer
that will call methods on GetParameterHistoryRequest.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.InvalidNextTokenException
- The specified token is not valid.InvalidKeyIdException
- The query key ID 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 GetParametersResponse getParameters(GetParametersRequest getParametersRequest) throws InvalidKeyIdException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Get details of a parameter. Don't confuse this API action with the GetParameter API action.
getParametersRequest
- InvalidKeyIdException
- The query key ID 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 GetParametersResponse getParameters(Consumer<GetParametersRequest.Builder> getParametersRequest) throws InvalidKeyIdException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Get details of a parameter. Don't confuse this API action with the GetParameter API action.
This is a convenience which creates an instance of the GetParametersRequest.Builder
avoiding the need to
create one manually via GetParametersRequest.builder()
getParametersRequest
- A Consumer
that will call methods on GetParametersRequest.Builder
to create a request.InvalidKeyIdException
- The query key ID 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 GetParametersByPathResponse getParametersByPath(GetParametersByPathRequest getParametersByPathRequest) throws InternalServerErrorException, InvalidFilterKeyException, InvalidFilterOptionException, InvalidFilterValueException, InvalidKeyIdException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Retrieve information about one or more parameters in a specific hierarchy.
Request results are returned on a best-effort basis. If you specify MaxResults
in the request, the
response includes information up to the limit specified. The number of items returned, however, can be between
zero and the value of MaxResults
. If the service reaches an internal limit while processing the
results, it stops the operation and returns the matching values up to that point and a NextToken
.
You can specify the NextToken
in a subsequent call to get the next set of results.
getParametersByPathRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidFilterKeyException
- The specified key is not valid.InvalidFilterOptionException
- The specified filter option is not valid. Valid options are Equals and BeginsWith. For Path filter, valid
options are Recursive and OneLevel.InvalidFilterValueException
- The filter value is not valid. Verify the value and try again.InvalidKeyIdException
- The query key ID is not valid.InvalidNextTokenException
- The specified token is not valid.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 GetParametersByPathResponse getParametersByPath(Consumer<GetParametersByPathRequest.Builder> getParametersByPathRequest) throws InternalServerErrorException, InvalidFilterKeyException, InvalidFilterOptionException, InvalidFilterValueException, InvalidKeyIdException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Retrieve information about one or more parameters in a specific hierarchy.
Request results are returned on a best-effort basis. If you specify MaxResults
in the request, the
response includes information up to the limit specified. The number of items returned, however, can be between
zero and the value of MaxResults
. If the service reaches an internal limit while processing the
results, it stops the operation and returns the matching values up to that point and a NextToken
.
You can specify the NextToken
in a subsequent call to get the next set of results.
This is a convenience which creates an instance of the GetParametersByPathRequest.Builder
avoiding the
need to create one manually via GetParametersByPathRequest.builder()
getParametersByPathRequest
- A Consumer
that will call methods on GetParametersByPathRequest.Builder
to create a
request.InternalServerErrorException
- An error occurred on the server side.InvalidFilterKeyException
- The specified key is not valid.InvalidFilterOptionException
- The specified filter option is not valid. Valid options are Equals and BeginsWith. For Path filter, valid
options are Recursive and OneLevel.InvalidFilterValueException
- The filter value is not valid. Verify the value and try again.InvalidKeyIdException
- The query key ID is not valid.InvalidNextTokenException
- The specified token is not valid.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 GetParametersByPathIterable getParametersByPathPaginator(GetParametersByPathRequest getParametersByPathRequest) throws InternalServerErrorException, InvalidFilterKeyException, InvalidFilterOptionException, InvalidFilterValueException, InvalidKeyIdException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Retrieve information about one or more parameters in a specific hierarchy.
Request results are returned on a best-effort basis. If you specify MaxResults
in the request, the
response includes information up to the limit specified. The number of items returned, however, can be between
zero and the value of MaxResults
. If the service reaches an internal limit while processing the
results, it stops the operation and returns the matching values up to that point and a NextToken
.
You can specify the NextToken
in a subsequent call to get the next set of results.
This is a variant of
getParametersByPath(software.amazon.awssdk.services.ssm.model.GetParametersByPathRequest)
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.GetParametersByPathIterable responses = client.getParametersByPathPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.GetParametersByPathIterable responses = client .getParametersByPathPaginator(request); for (software.amazon.awssdk.services.ssm.model.GetParametersByPathResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.GetParametersByPathIterable responses = client.getParametersByPathPaginator(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
getParametersByPath(software.amazon.awssdk.services.ssm.model.GetParametersByPathRequest)
operation.
getParametersByPathRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidFilterKeyException
- The specified key is not valid.InvalidFilterOptionException
- The specified filter option is not valid. Valid options are Equals and BeginsWith. For Path filter, valid
options are Recursive and OneLevel.InvalidFilterValueException
- The filter value is not valid. Verify the value and try again.InvalidKeyIdException
- The query key ID is not valid.InvalidNextTokenException
- The specified token is not valid.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 GetParametersByPathIterable getParametersByPathPaginator(Consumer<GetParametersByPathRequest.Builder> getParametersByPathRequest) throws InternalServerErrorException, InvalidFilterKeyException, InvalidFilterOptionException, InvalidFilterValueException, InvalidKeyIdException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Retrieve information about one or more parameters in a specific hierarchy.
Request results are returned on a best-effort basis. If you specify MaxResults
in the request, the
response includes information up to the limit specified. The number of items returned, however, can be between
zero and the value of MaxResults
. If the service reaches an internal limit while processing the
results, it stops the operation and returns the matching values up to that point and a NextToken
.
You can specify the NextToken
in a subsequent call to get the next set of results.
This is a variant of
getParametersByPath(software.amazon.awssdk.services.ssm.model.GetParametersByPathRequest)
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.GetParametersByPathIterable responses = client.getParametersByPathPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.GetParametersByPathIterable responses = client .getParametersByPathPaginator(request); for (software.amazon.awssdk.services.ssm.model.GetParametersByPathResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.GetParametersByPathIterable responses = client.getParametersByPathPaginator(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
getParametersByPath(software.amazon.awssdk.services.ssm.model.GetParametersByPathRequest)
operation.
This is a convenience which creates an instance of the GetParametersByPathRequest.Builder
avoiding the
need to create one manually via GetParametersByPathRequest.builder()
getParametersByPathRequest
- A Consumer
that will call methods on GetParametersByPathRequest.Builder
to create a
request.InternalServerErrorException
- An error occurred on the server side.InvalidFilterKeyException
- The specified key is not valid.InvalidFilterOptionException
- The specified filter option is not valid. Valid options are Equals and BeginsWith. For Path filter, valid
options are Recursive and OneLevel.InvalidFilterValueException
- The filter value is not valid. Verify the value and try again.InvalidKeyIdException
- The query key ID is not valid.InvalidNextTokenException
- The specified token is not valid.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 GetPatchBaselineResponse getPatchBaseline(GetPatchBaselineRequest getPatchBaselineRequest) throws DoesNotExistException, InvalidResourceIdException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Retrieves information about a patch baseline.
getPatchBaselineRequest
- 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.
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 GetPatchBaselineResponse getPatchBaseline(Consumer<GetPatchBaselineRequest.Builder> getPatchBaselineRequest) throws DoesNotExistException, InvalidResourceIdException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Retrieves information about a patch baseline.
This is a convenience which creates an instance of the GetPatchBaselineRequest.Builder
avoiding the need
to create one manually via GetPatchBaselineRequest.builder()
getPatchBaselineRequest
- A Consumer
that will call methods on GetPatchBaselineRequest.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.
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 GetPatchBaselineForPatchGroupResponse getPatchBaselineForPatchGroup(GetPatchBaselineForPatchGroupRequest getPatchBaselineForPatchGroupRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Retrieves the patch baseline that should be used for the specified patch group.
getPatchBaselineForPatchGroupRequest
- 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 GetPatchBaselineForPatchGroupResponse getPatchBaselineForPatchGroup(Consumer<GetPatchBaselineForPatchGroupRequest.Builder> getPatchBaselineForPatchGroupRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Retrieves the patch baseline that should be used for the specified patch group.
This is a convenience which creates an instance of the GetPatchBaselineForPatchGroupRequest.Builder
avoiding the need to create one manually via GetPatchBaselineForPatchGroupRequest.builder()
getPatchBaselineForPatchGroupRequest
- A Consumer
that will call methods on GetPatchBaselineForPatchGroupRequest.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 GetServiceSettingResponse getServiceSetting(GetServiceSettingRequest getServiceSettingRequest) throws InternalServerErrorException, ServiceSettingNotFoundException, AwsServiceException, SdkClientException, SsmException
ServiceSetting
is an account-level setting for an AWS service. This setting defines how a user
interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the
account based on feature or service usage, then the AWS service team might create a default setting of "false".
This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for
a paid feature.
Services map a SettingId
object to a setting value. AWS services teams define the default value for
a SettingId
. You can't create a new SettingId
, but you can overwrite the default value
if you have the ssm:UpdateServiceSetting
permission for the setting. Use the
UpdateServiceSetting API action to change the default setting. Or use the ResetServiceSetting to
change the value back to the original value defined by the AWS service team.
Query the current service setting for the account.
getServiceSettingRequest
- The request body of the GetServiceSetting API action.InternalServerErrorException
- An error occurred on the server side.ServiceSettingNotFoundException
- The specified service setting was not found. Either the service name or the setting has not been
provisioned by the AWS service team.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 GetServiceSettingResponse getServiceSetting(Consumer<GetServiceSettingRequest.Builder> getServiceSettingRequest) throws InternalServerErrorException, ServiceSettingNotFoundException, AwsServiceException, SdkClientException, SsmException
ServiceSetting
is an account-level setting for an AWS service. This setting defines how a user
interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the
account based on feature or service usage, then the AWS service team might create a default setting of "false".
This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for
a paid feature.
Services map a SettingId
object to a setting value. AWS services teams define the default value for
a SettingId
. You can't create a new SettingId
, but you can overwrite the default value
if you have the ssm:UpdateServiceSetting
permission for the setting. Use the
UpdateServiceSetting API action to change the default setting. Or use the ResetServiceSetting to
change the value back to the original value defined by the AWS service team.
Query the current service setting for the account.
This is a convenience which creates an instance of the GetServiceSettingRequest.Builder
avoiding the need
to create one manually via GetServiceSettingRequest.builder()
getServiceSettingRequest
- A Consumer
that will call methods on GetServiceSettingRequest.Builder
to create a request.
The request body of the GetServiceSetting API action.InternalServerErrorException
- An error occurred on the server side.ServiceSettingNotFoundException
- The specified service setting was not found. Either the service name or the setting has not been
provisioned by the AWS service team.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 LabelParameterVersionResponse labelParameterVersion(LabelParameterVersionRequest labelParameterVersionRequest) throws InternalServerErrorException, TooManyUpdatesException, ParameterNotFoundException, ParameterVersionNotFoundException, ParameterVersionLabelLimitExceededException, AwsServiceException, SdkClientException, SsmException
A parameter label is a user-defined alias to help you manage different versions of a parameter. When you modify a parameter, Systems Manager automatically saves a new version and increments the version number by one. A label can help you remember the purpose of a parameter when there are multiple versions.
Parameter labels have the following requirements and restrictions.
A version of a parameter can have a maximum of 10 labels.
You can't attach the same label to different versions of the same parameter. For example, if version 1 has the label Production, then you can't attach Production to version 2.
You can move a label from one version of a parameter to another.
You can't create a label when you create a new parameter. You must attach a label to a specific version of a parameter.
You can't delete a parameter label. If you no longer want to use a parameter label, then you must move it to a different version of a parameter.
A label can have a maximum of 100 characters.
Labels can contain letters (case sensitive), numbers, periods (.), hyphens (-), or underscores (_).
Labels can't begin with a number, "aws," or "ssm" (not case sensitive). If a label fails to meet these requirements, then the label is not associated with a parameter and the system displays it in the list of InvalidLabels.
labelParameterVersionRequest
- InternalServerErrorException
- An error occurred on the server side.TooManyUpdatesException
- There are concurrent updates for a resource that supports one update at a time.ParameterNotFoundException
- The parameter could not be found. Verify the name and try again.ParameterVersionNotFoundException
- The specified parameter version was not found. Verify the parameter name and version, and try again.ParameterVersionLabelLimitExceededException
- A parameter version can have a maximum of ten labels.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 LabelParameterVersionResponse labelParameterVersion(Consumer<LabelParameterVersionRequest.Builder> labelParameterVersionRequest) throws InternalServerErrorException, TooManyUpdatesException, ParameterNotFoundException, ParameterVersionNotFoundException, ParameterVersionLabelLimitExceededException, AwsServiceException, SdkClientException, SsmException
A parameter label is a user-defined alias to help you manage different versions of a parameter. When you modify a parameter, Systems Manager automatically saves a new version and increments the version number by one. A label can help you remember the purpose of a parameter when there are multiple versions.
Parameter labels have the following requirements and restrictions.
A version of a parameter can have a maximum of 10 labels.
You can't attach the same label to different versions of the same parameter. For example, if version 1 has the label Production, then you can't attach Production to version 2.
You can move a label from one version of a parameter to another.
You can't create a label when you create a new parameter. You must attach a label to a specific version of a parameter.
You can't delete a parameter label. If you no longer want to use a parameter label, then you must move it to a different version of a parameter.
A label can have a maximum of 100 characters.
Labels can contain letters (case sensitive), numbers, periods (.), hyphens (-), or underscores (_).
Labels can't begin with a number, "aws," or "ssm" (not case sensitive). If a label fails to meet these requirements, then the label is not associated with a parameter and the system displays it in the list of InvalidLabels.
This is a convenience which creates an instance of the LabelParameterVersionRequest.Builder
avoiding the
need to create one manually via LabelParameterVersionRequest.builder()
labelParameterVersionRequest
- A Consumer
that will call methods on LabelParameterVersionRequest.Builder
to create a
request.InternalServerErrorException
- An error occurred on the server side.TooManyUpdatesException
- There are concurrent updates for a resource that supports one update at a time.ParameterNotFoundException
- The parameter could not be found. Verify the name and try again.ParameterVersionNotFoundException
- The specified parameter version was not found. Verify the parameter name and version, and try again.ParameterVersionLabelLimitExceededException
- A parameter version can have a maximum of ten labels.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 ListAssociationVersionsResponse listAssociationVersions(ListAssociationVersionsRequest listAssociationVersionsRequest) throws InternalServerErrorException, InvalidNextTokenException, AssociationDoesNotExistException, AwsServiceException, SdkClientException, SsmException
Retrieves all versions of an association for a specific association ID.
listAssociationVersionsRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidNextTokenException
- The specified token is not valid.AssociationDoesNotExistException
- The specified association does not exist.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 ListAssociationVersionsResponse listAssociationVersions(Consumer<ListAssociationVersionsRequest.Builder> listAssociationVersionsRequest) throws InternalServerErrorException, InvalidNextTokenException, AssociationDoesNotExistException, AwsServiceException, SdkClientException, SsmException
Retrieves all versions of an association for a specific association ID.
This is a convenience which creates an instance of the ListAssociationVersionsRequest.Builder
avoiding
the need to create one manually via ListAssociationVersionsRequest.builder()
listAssociationVersionsRequest
- A Consumer
that will call methods on ListAssociationVersionsRequest.Builder
to create a
request.InternalServerErrorException
- An error occurred on the server side.InvalidNextTokenException
- The specified token is not valid.AssociationDoesNotExistException
- The specified association 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 ListAssociationVersionsIterable listAssociationVersionsPaginator(ListAssociationVersionsRequest listAssociationVersionsRequest) throws InternalServerErrorException, InvalidNextTokenException, AssociationDoesNotExistException, AwsServiceException, SdkClientException, SsmException
Retrieves all versions of an association for a specific association ID.
This is a variant of
listAssociationVersions(software.amazon.awssdk.services.ssm.model.ListAssociationVersionsRequest)
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.ListAssociationVersionsIterable responses = client.listAssociationVersionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.ListAssociationVersionsIterable responses = client .listAssociationVersionsPaginator(request); for (software.amazon.awssdk.services.ssm.model.ListAssociationVersionsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.ListAssociationVersionsIterable responses = client.listAssociationVersionsPaginator(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
listAssociationVersions(software.amazon.awssdk.services.ssm.model.ListAssociationVersionsRequest)
operation.
listAssociationVersionsRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidNextTokenException
- The specified token is not valid.AssociationDoesNotExistException
- The specified association 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 ListAssociationVersionsIterable listAssociationVersionsPaginator(Consumer<ListAssociationVersionsRequest.Builder> listAssociationVersionsRequest) throws InternalServerErrorException, InvalidNextTokenException, AssociationDoesNotExistException, AwsServiceException, SdkClientException, SsmException
Retrieves all versions of an association for a specific association ID.
This is a variant of
listAssociationVersions(software.amazon.awssdk.services.ssm.model.ListAssociationVersionsRequest)
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.ListAssociationVersionsIterable responses = client.listAssociationVersionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.ListAssociationVersionsIterable responses = client .listAssociationVersionsPaginator(request); for (software.amazon.awssdk.services.ssm.model.ListAssociationVersionsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.ListAssociationVersionsIterable responses = client.listAssociationVersionsPaginator(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
listAssociationVersions(software.amazon.awssdk.services.ssm.model.ListAssociationVersionsRequest)
operation.
This is a convenience which creates an instance of the ListAssociationVersionsRequest.Builder
avoiding
the need to create one manually via ListAssociationVersionsRequest.builder()
listAssociationVersionsRequest
- A Consumer
that will call methods on ListAssociationVersionsRequest.Builder
to create a
request.InternalServerErrorException
- An error occurred on the server side.InvalidNextTokenException
- The specified token is not valid.AssociationDoesNotExistException
- The specified association 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 ListAssociationsResponse listAssociations() throws InternalServerErrorException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Returns all State Manager associations in the current AWS account and Region. You can limit the results to a specific State Manager association document or instance by specifying a filter.
InternalServerErrorException
- An error occurred on the server side.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
listAssociations(ListAssociationsRequest)
,
AWS API
Documentationdefault ListAssociationsResponse listAssociations(ListAssociationsRequest listAssociationsRequest) throws InternalServerErrorException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Returns all State Manager associations in the current AWS account and Region. You can limit the results to a specific State Manager association document or instance by specifying a filter.
listAssociationsRequest
- InternalServerErrorException
- An error occurred on the server side.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 ListAssociationsResponse listAssociations(Consumer<ListAssociationsRequest.Builder> listAssociationsRequest) throws InternalServerErrorException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Returns all State Manager associations in the current AWS account and Region. You can limit the results to a specific State Manager association document or instance by specifying a filter.
This is a convenience which creates an instance of the ListAssociationsRequest.Builder
avoiding the need
to create one manually via ListAssociationsRequest.builder()
listAssociationsRequest
- A Consumer
that will call methods on ListAssociationsRequest.Builder
to create a request.InternalServerErrorException
- An error occurred on the server side.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 ListAssociationsIterable listAssociationsPaginator() throws InternalServerErrorException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Returns all State Manager associations in the current AWS account and Region. You can limit the results to a specific State Manager association document or instance by specifying a filter.
This is a variant of listAssociations(software.amazon.awssdk.services.ssm.model.ListAssociationsRequest)
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.ListAssociationsIterable responses = client.listAssociationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.ListAssociationsIterable responses = client.listAssociationsPaginator(request); for (software.amazon.awssdk.services.ssm.model.ListAssociationsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.ListAssociationsIterable responses = client.listAssociationsPaginator(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
listAssociations(software.amazon.awssdk.services.ssm.model.ListAssociationsRequest)
operation.
InternalServerErrorException
- An error occurred on the server side.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
listAssociationsPaginator(ListAssociationsRequest)
,
AWS API
Documentationdefault ListAssociationsIterable listAssociationsPaginator(ListAssociationsRequest listAssociationsRequest) throws InternalServerErrorException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Returns all State Manager associations in the current AWS account and Region. You can limit the results to a specific State Manager association document or instance by specifying a filter.
This is a variant of listAssociations(software.amazon.awssdk.services.ssm.model.ListAssociationsRequest)
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.ListAssociationsIterable responses = client.listAssociationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.ListAssociationsIterable responses = client.listAssociationsPaginator(request); for (software.amazon.awssdk.services.ssm.model.ListAssociationsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.ListAssociationsIterable responses = client.listAssociationsPaginator(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
listAssociations(software.amazon.awssdk.services.ssm.model.ListAssociationsRequest)
operation.
listAssociationsRequest
- InternalServerErrorException
- An error occurred on the server side.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 ListAssociationsIterable listAssociationsPaginator(Consumer<ListAssociationsRequest.Builder> listAssociationsRequest) throws InternalServerErrorException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Returns all State Manager associations in the current AWS account and Region. You can limit the results to a specific State Manager association document or instance by specifying a filter.
This is a variant of listAssociations(software.amazon.awssdk.services.ssm.model.ListAssociationsRequest)
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.ListAssociationsIterable responses = client.listAssociationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.ListAssociationsIterable responses = client.listAssociationsPaginator(request); for (software.amazon.awssdk.services.ssm.model.ListAssociationsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.ListAssociationsIterable responses = client.listAssociationsPaginator(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
listAssociations(software.amazon.awssdk.services.ssm.model.ListAssociationsRequest)
operation.
This is a convenience which creates an instance of the ListAssociationsRequest.Builder
avoiding the need
to create one manually via ListAssociationsRequest.builder()
listAssociationsRequest
- A Consumer
that will call methods on ListAssociationsRequest.Builder
to create a request.InternalServerErrorException
- An error occurred on the server side.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 ListCommandInvocationsResponse listCommandInvocations() throws InternalServerErrorException, InvalidCommandIdException, InvalidInstanceIdException, InvalidFilterKeyException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
An invocation is copy of a command sent to a specific instance. A command can apply to one or more instances. A command invocation applies to one instance. For example, if a user runs SendCommand against three instances, then a command invocation is created for each requested instance ID. ListCommandInvocations provide status about command execution.
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.
InvalidFilterKeyException
- The specified key is not valid.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
listCommandInvocations(ListCommandInvocationsRequest)
,
AWS API
Documentationdefault ListCommandInvocationsResponse listCommandInvocations(ListCommandInvocationsRequest listCommandInvocationsRequest) throws InternalServerErrorException, InvalidCommandIdException, InvalidInstanceIdException, InvalidFilterKeyException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
An invocation is copy of a command sent to a specific instance. A command can apply to one or more instances. A command invocation applies to one instance. For example, if a user runs SendCommand against three instances, then a command invocation is created for each requested instance ID. ListCommandInvocations provide status about command execution.
listCommandInvocationsRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidCommandIdException
InvalidInstanceIdException
- The following problems can cause this exception:
You do not have permission to access the instance.
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.
InvalidFilterKeyException
- The specified key is not valid.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 ListCommandInvocationsResponse listCommandInvocations(Consumer<ListCommandInvocationsRequest.Builder> listCommandInvocationsRequest) throws InternalServerErrorException, InvalidCommandIdException, InvalidInstanceIdException, InvalidFilterKeyException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
An invocation is copy of a command sent to a specific instance. A command can apply to one or more instances. A command invocation applies to one instance. For example, if a user runs SendCommand against three instances, then a command invocation is created for each requested instance ID. ListCommandInvocations provide status about command execution.
This is a convenience which creates an instance of the ListCommandInvocationsRequest.Builder
avoiding the
need to create one manually via ListCommandInvocationsRequest.builder()
listCommandInvocationsRequest
- A Consumer
that will call methods on ListCommandInvocationsRequest.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.
InvalidFilterKeyException
- The specified key is not valid.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 ListCommandInvocationsIterable listCommandInvocationsPaginator() throws InternalServerErrorException, InvalidCommandIdException, InvalidInstanceIdException, InvalidFilterKeyException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
An invocation is copy of a command sent to a specific instance. A command can apply to one or more instances. A command invocation applies to one instance. For example, if a user runs SendCommand against three instances, then a command invocation is created for each requested instance ID. ListCommandInvocations provide status about command execution.
This is a variant of
listCommandInvocations(software.amazon.awssdk.services.ssm.model.ListCommandInvocationsRequest)
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.ListCommandInvocationsIterable responses = client.listCommandInvocationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.ListCommandInvocationsIterable responses = client .listCommandInvocationsPaginator(request); for (software.amazon.awssdk.services.ssm.model.ListCommandInvocationsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.ListCommandInvocationsIterable responses = client.listCommandInvocationsPaginator(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
listCommandInvocations(software.amazon.awssdk.services.ssm.model.ListCommandInvocationsRequest)
operation.
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.
InvalidFilterKeyException
- The specified key is not valid.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
listCommandInvocationsPaginator(ListCommandInvocationsRequest)
,
AWS API
Documentationdefault ListCommandInvocationsIterable listCommandInvocationsPaginator(ListCommandInvocationsRequest listCommandInvocationsRequest) throws InternalServerErrorException, InvalidCommandIdException, InvalidInstanceIdException, InvalidFilterKeyException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
An invocation is copy of a command sent to a specific instance. A command can apply to one or more instances. A command invocation applies to one instance. For example, if a user runs SendCommand against three instances, then a command invocation is created for each requested instance ID. ListCommandInvocations provide status about command execution.
This is a variant of
listCommandInvocations(software.amazon.awssdk.services.ssm.model.ListCommandInvocationsRequest)
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.ListCommandInvocationsIterable responses = client.listCommandInvocationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.ListCommandInvocationsIterable responses = client .listCommandInvocationsPaginator(request); for (software.amazon.awssdk.services.ssm.model.ListCommandInvocationsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.ListCommandInvocationsIterable responses = client.listCommandInvocationsPaginator(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
listCommandInvocations(software.amazon.awssdk.services.ssm.model.ListCommandInvocationsRequest)
operation.
listCommandInvocationsRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidCommandIdException
InvalidInstanceIdException
- The following problems can cause this exception:
You do not have permission to access the instance.
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.
InvalidFilterKeyException
- The specified key is not valid.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 ListCommandInvocationsIterable listCommandInvocationsPaginator(Consumer<ListCommandInvocationsRequest.Builder> listCommandInvocationsRequest) throws InternalServerErrorException, InvalidCommandIdException, InvalidInstanceIdException, InvalidFilterKeyException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
An invocation is copy of a command sent to a specific instance. A command can apply to one or more instances. A command invocation applies to one instance. For example, if a user runs SendCommand against three instances, then a command invocation is created for each requested instance ID. ListCommandInvocations provide status about command execution.
This is a variant of
listCommandInvocations(software.amazon.awssdk.services.ssm.model.ListCommandInvocationsRequest)
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.ListCommandInvocationsIterable responses = client.listCommandInvocationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.ListCommandInvocationsIterable responses = client .listCommandInvocationsPaginator(request); for (software.amazon.awssdk.services.ssm.model.ListCommandInvocationsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.ListCommandInvocationsIterable responses = client.listCommandInvocationsPaginator(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
listCommandInvocations(software.amazon.awssdk.services.ssm.model.ListCommandInvocationsRequest)
operation.
This is a convenience which creates an instance of the ListCommandInvocationsRequest.Builder
avoiding the
need to create one manually via ListCommandInvocationsRequest.builder()
listCommandInvocationsRequest
- A Consumer
that will call methods on ListCommandInvocationsRequest.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.
InvalidFilterKeyException
- The specified key is not valid.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 ListCommandsResponse listCommands() throws InternalServerErrorException, InvalidCommandIdException, InvalidInstanceIdException, InvalidFilterKeyException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Lists the commands requested by users of the AWS account.
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.
InvalidFilterKeyException
- The specified key is not valid.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
listCommands(ListCommandsRequest)
,
AWS API
Documentationdefault ListCommandsResponse listCommands(ListCommandsRequest listCommandsRequest) throws InternalServerErrorException, InvalidCommandIdException, InvalidInstanceIdException, InvalidFilterKeyException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Lists the commands requested by users of the AWS account.
listCommandsRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidCommandIdException
InvalidInstanceIdException
- The following problems can cause this exception:
You do not have permission to access the instance.
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.
InvalidFilterKeyException
- The specified key is not valid.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 ListCommandsResponse listCommands(Consumer<ListCommandsRequest.Builder> listCommandsRequest) throws InternalServerErrorException, InvalidCommandIdException, InvalidInstanceIdException, InvalidFilterKeyException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Lists the commands requested by users of the AWS account.
This is a convenience which creates an instance of the ListCommandsRequest.Builder
avoiding the need to
create one manually via ListCommandsRequest.builder()
listCommandsRequest
- A Consumer
that will call methods on ListCommandsRequest.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.
InvalidFilterKeyException
- The specified key is not valid.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 ListCommandsIterable listCommandsPaginator() throws InternalServerErrorException, InvalidCommandIdException, InvalidInstanceIdException, InvalidFilterKeyException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Lists the commands requested by users of the AWS account.
This is a variant of listCommands(software.amazon.awssdk.services.ssm.model.ListCommandsRequest)
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.ListCommandsIterable responses = client.listCommandsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.ListCommandsIterable responses = client.listCommandsPaginator(request); for (software.amazon.awssdk.services.ssm.model.ListCommandsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.ListCommandsIterable responses = client.listCommandsPaginator(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
listCommands(software.amazon.awssdk.services.ssm.model.ListCommandsRequest)
operation.
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.
InvalidFilterKeyException
- The specified key is not valid.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
listCommandsPaginator(ListCommandsRequest)
,
AWS API
Documentationdefault ListCommandsIterable listCommandsPaginator(ListCommandsRequest listCommandsRequest) throws InternalServerErrorException, InvalidCommandIdException, InvalidInstanceIdException, InvalidFilterKeyException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Lists the commands requested by users of the AWS account.
This is a variant of listCommands(software.amazon.awssdk.services.ssm.model.ListCommandsRequest)
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.ListCommandsIterable responses = client.listCommandsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.ListCommandsIterable responses = client.listCommandsPaginator(request); for (software.amazon.awssdk.services.ssm.model.ListCommandsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.ListCommandsIterable responses = client.listCommandsPaginator(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
listCommands(software.amazon.awssdk.services.ssm.model.ListCommandsRequest)
operation.
listCommandsRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidCommandIdException
InvalidInstanceIdException
- The following problems can cause this exception:
You do not have permission to access the instance.
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.
InvalidFilterKeyException
- The specified key is not valid.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 ListCommandsIterable listCommandsPaginator(Consumer<ListCommandsRequest.Builder> listCommandsRequest) throws InternalServerErrorException, InvalidCommandIdException, InvalidInstanceIdException, InvalidFilterKeyException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Lists the commands requested by users of the AWS account.
This is a variant of listCommands(software.amazon.awssdk.services.ssm.model.ListCommandsRequest)
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.ListCommandsIterable responses = client.listCommandsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.ListCommandsIterable responses = client.listCommandsPaginator(request); for (software.amazon.awssdk.services.ssm.model.ListCommandsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.ListCommandsIterable responses = client.listCommandsPaginator(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
listCommands(software.amazon.awssdk.services.ssm.model.ListCommandsRequest)
operation.
This is a convenience which creates an instance of the ListCommandsRequest.Builder
avoiding the need to
create one manually via ListCommandsRequest.builder()
listCommandsRequest
- A Consumer
that will call methods on ListCommandsRequest.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.
InvalidFilterKeyException
- The specified key is not valid.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 ListComplianceItemsResponse listComplianceItems(ListComplianceItemsRequest listComplianceItemsRequest) throws InvalidResourceTypeException, InvalidResourceIdException, InternalServerErrorException, InvalidFilterException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
For a specified resource ID, this API action returns a list of compliance statuses for different resource types. Currently, you can only specify one resource ID per call. List results depend on the criteria specified in the filter.
listComplianceItemsRequest
- InvalidResourceTypeException
- The resource type is not valid. For example, if you are attempting to tag an instance, the instance must
be a registered, managed instance.InvalidResourceIdException
- The resource ID is not valid. Verify that you entered the correct ID and try again.InternalServerErrorException
- An error occurred on the server side.InvalidFilterException
- The filter name is not valid. Verify the you entered the correct name and try again.InvalidNextTokenException
- The specified token is not valid.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 ListComplianceItemsResponse listComplianceItems(Consumer<ListComplianceItemsRequest.Builder> listComplianceItemsRequest) throws InvalidResourceTypeException, InvalidResourceIdException, InternalServerErrorException, InvalidFilterException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
For a specified resource ID, this API action returns a list of compliance statuses for different resource types. Currently, you can only specify one resource ID per call. List results depend on the criteria specified in the filter.
This is a convenience which creates an instance of the ListComplianceItemsRequest.Builder
avoiding the
need to create one manually via ListComplianceItemsRequest.builder()
listComplianceItemsRequest
- A Consumer
that will call methods on ListComplianceItemsRequest.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.InvalidFilterException
- The filter name is not valid. Verify the you entered the correct name and try again.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 ListComplianceItemsIterable listComplianceItemsPaginator(ListComplianceItemsRequest listComplianceItemsRequest) throws InvalidResourceTypeException, InvalidResourceIdException, InternalServerErrorException, InvalidFilterException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
For a specified resource ID, this API action returns a list of compliance statuses for different resource types. Currently, you can only specify one resource ID per call. List results depend on the criteria specified in the filter.
This is a variant of
listComplianceItems(software.amazon.awssdk.services.ssm.model.ListComplianceItemsRequest)
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.ListComplianceItemsIterable responses = client.listComplianceItemsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.ListComplianceItemsIterable responses = client .listComplianceItemsPaginator(request); for (software.amazon.awssdk.services.ssm.model.ListComplianceItemsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.ListComplianceItemsIterable responses = client.listComplianceItemsPaginator(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
listComplianceItems(software.amazon.awssdk.services.ssm.model.ListComplianceItemsRequest)
operation.
listComplianceItemsRequest
- InvalidResourceTypeException
- The resource type is not valid. For example, if you are attempting to tag an instance, the instance must
be a registered, managed instance.InvalidResourceIdException
- The resource ID is not valid. Verify that you entered the correct ID and try again.InternalServerErrorException
- An error occurred on the server side.InvalidFilterException
- The filter name is not valid. Verify the you entered the correct name and try again.InvalidNextTokenException
- The specified token is not valid.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 ListComplianceItemsIterable listComplianceItemsPaginator(Consumer<ListComplianceItemsRequest.Builder> listComplianceItemsRequest) throws InvalidResourceTypeException, InvalidResourceIdException, InternalServerErrorException, InvalidFilterException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
For a specified resource ID, this API action returns a list of compliance statuses for different resource types. Currently, you can only specify one resource ID per call. List results depend on the criteria specified in the filter.
This is a variant of
listComplianceItems(software.amazon.awssdk.services.ssm.model.ListComplianceItemsRequest)
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.ListComplianceItemsIterable responses = client.listComplianceItemsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.ListComplianceItemsIterable responses = client .listComplianceItemsPaginator(request); for (software.amazon.awssdk.services.ssm.model.ListComplianceItemsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.ListComplianceItemsIterable responses = client.listComplianceItemsPaginator(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
listComplianceItems(software.amazon.awssdk.services.ssm.model.ListComplianceItemsRequest)
operation.
This is a convenience which creates an instance of the ListComplianceItemsRequest.Builder
avoiding the
need to create one manually via ListComplianceItemsRequest.builder()
listComplianceItemsRequest
- A Consumer
that will call methods on ListComplianceItemsRequest.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.InvalidFilterException
- The filter name is not valid. Verify the you entered the correct name and try again.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 ListComplianceSummariesResponse listComplianceSummaries() throws InvalidFilterException, InvalidNextTokenException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Returns a summary count of compliant and non-compliant resources for a compliance type. For example, this call can return State Manager associations, patches, or custom compliance types according to the filter criteria that you specify.
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
listComplianceSummaries(ListComplianceSummariesRequest)
,
AWS
API Documentationdefault ListComplianceSummariesResponse listComplianceSummaries(ListComplianceSummariesRequest listComplianceSummariesRequest) throws InvalidFilterException, InvalidNextTokenException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Returns a summary count of compliant and non-compliant resources for a compliance type. For example, this call can return State Manager associations, patches, or custom compliance types according to the filter criteria that you specify.
listComplianceSummariesRequest
- InvalidFilterException
- The filter name is not valid. Verify the you entered the correct name and try again.InvalidNextTokenException
- The specified token is not valid.InternalServerErrorException
- An error occurred on the server side.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 ListComplianceSummariesResponse listComplianceSummaries(Consumer<ListComplianceSummariesRequest.Builder> listComplianceSummariesRequest) throws InvalidFilterException, InvalidNextTokenException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Returns a summary count of compliant and non-compliant resources for a compliance type. For example, this call can return State Manager associations, patches, or custom compliance types according to the filter criteria that you specify.
This is a convenience which creates an instance of the ListComplianceSummariesRequest.Builder
avoiding
the need to create one manually via ListComplianceSummariesRequest.builder()
listComplianceSummariesRequest
- A Consumer
that will call methods on ListComplianceSummariesRequest.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 ListComplianceSummariesIterable listComplianceSummariesPaginator() throws InvalidFilterException, InvalidNextTokenException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Returns a summary count of compliant and non-compliant resources for a compliance type. For example, this call can return State Manager associations, patches, or custom compliance types according to the filter criteria that you specify.
This is a variant of
listComplianceSummaries(software.amazon.awssdk.services.ssm.model.ListComplianceSummariesRequest)
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.ListComplianceSummariesIterable responses = client.listComplianceSummariesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.ListComplianceSummariesIterable responses = client .listComplianceSummariesPaginator(request); for (software.amazon.awssdk.services.ssm.model.ListComplianceSummariesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.ListComplianceSummariesIterable responses = client.listComplianceSummariesPaginator(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
listComplianceSummaries(software.amazon.awssdk.services.ssm.model.ListComplianceSummariesRequest)
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
listComplianceSummariesPaginator(ListComplianceSummariesRequest)
,
AWS
API Documentationdefault ListComplianceSummariesIterable listComplianceSummariesPaginator(ListComplianceSummariesRequest listComplianceSummariesRequest) throws InvalidFilterException, InvalidNextTokenException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Returns a summary count of compliant and non-compliant resources for a compliance type. For example, this call can return State Manager associations, patches, or custom compliance types according to the filter criteria that you specify.
This is a variant of
listComplianceSummaries(software.amazon.awssdk.services.ssm.model.ListComplianceSummariesRequest)
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.ListComplianceSummariesIterable responses = client.listComplianceSummariesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.ListComplianceSummariesIterable responses = client .listComplianceSummariesPaginator(request); for (software.amazon.awssdk.services.ssm.model.ListComplianceSummariesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.ListComplianceSummariesIterable responses = client.listComplianceSummariesPaginator(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
listComplianceSummaries(software.amazon.awssdk.services.ssm.model.ListComplianceSummariesRequest)
operation.
listComplianceSummariesRequest
- InvalidFilterException
- The filter name is not valid. Verify the you entered the correct name and try again.InvalidNextTokenException
- The specified token is not valid.InternalServerErrorException
- An error occurred on the server side.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 ListComplianceSummariesIterable listComplianceSummariesPaginator(Consumer<ListComplianceSummariesRequest.Builder> listComplianceSummariesRequest) throws InvalidFilterException, InvalidNextTokenException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Returns a summary count of compliant and non-compliant resources for a compliance type. For example, this call can return State Manager associations, patches, or custom compliance types according to the filter criteria that you specify.
This is a variant of
listComplianceSummaries(software.amazon.awssdk.services.ssm.model.ListComplianceSummariesRequest)
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.ListComplianceSummariesIterable responses = client.listComplianceSummariesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.ListComplianceSummariesIterable responses = client .listComplianceSummariesPaginator(request); for (software.amazon.awssdk.services.ssm.model.ListComplianceSummariesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.ListComplianceSummariesIterable responses = client.listComplianceSummariesPaginator(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
listComplianceSummaries(software.amazon.awssdk.services.ssm.model.ListComplianceSummariesRequest)
operation.
This is a convenience which creates an instance of the ListComplianceSummariesRequest.Builder
avoiding
the need to create one manually via ListComplianceSummariesRequest.builder()
listComplianceSummariesRequest
- A Consumer
that will call methods on ListComplianceSummariesRequest.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 ListDocumentVersionsResponse listDocumentVersions(ListDocumentVersionsRequest listDocumentVersionsRequest) throws InternalServerErrorException, InvalidNextTokenException, InvalidDocumentException, AwsServiceException, SdkClientException, SsmException
List all versions for a document.
listDocumentVersionsRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidNextTokenException
- The specified token is not valid.InvalidDocumentException
- The specified document does not exist.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 ListDocumentVersionsResponse listDocumentVersions(Consumer<ListDocumentVersionsRequest.Builder> listDocumentVersionsRequest) throws InternalServerErrorException, InvalidNextTokenException, InvalidDocumentException, AwsServiceException, SdkClientException, SsmException
List all versions for a document.
This is a convenience which creates an instance of the ListDocumentVersionsRequest.Builder
avoiding the
need to create one manually via ListDocumentVersionsRequest.builder()
listDocumentVersionsRequest
- A Consumer
that will call methods on ListDocumentVersionsRequest.Builder
to create a
request.InternalServerErrorException
- An error occurred on the server side.InvalidNextTokenException
- The specified token is not valid.InvalidDocumentException
- The specified document 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 ListDocumentVersionsIterable listDocumentVersionsPaginator(ListDocumentVersionsRequest listDocumentVersionsRequest) throws InternalServerErrorException, InvalidNextTokenException, InvalidDocumentException, AwsServiceException, SdkClientException, SsmException
List all versions for a document.
This is a variant of
listDocumentVersions(software.amazon.awssdk.services.ssm.model.ListDocumentVersionsRequest)
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.ListDocumentVersionsIterable responses = client.listDocumentVersionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.ListDocumentVersionsIterable responses = client .listDocumentVersionsPaginator(request); for (software.amazon.awssdk.services.ssm.model.ListDocumentVersionsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.ListDocumentVersionsIterable responses = client.listDocumentVersionsPaginator(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
listDocumentVersions(software.amazon.awssdk.services.ssm.model.ListDocumentVersionsRequest)
operation.
listDocumentVersionsRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidNextTokenException
- The specified token is not valid.InvalidDocumentException
- The specified document 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 ListDocumentVersionsIterable listDocumentVersionsPaginator(Consumer<ListDocumentVersionsRequest.Builder> listDocumentVersionsRequest) throws InternalServerErrorException, InvalidNextTokenException, InvalidDocumentException, AwsServiceException, SdkClientException, SsmException
List all versions for a document.
This is a variant of
listDocumentVersions(software.amazon.awssdk.services.ssm.model.ListDocumentVersionsRequest)
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.ListDocumentVersionsIterable responses = client.listDocumentVersionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.ListDocumentVersionsIterable responses = client .listDocumentVersionsPaginator(request); for (software.amazon.awssdk.services.ssm.model.ListDocumentVersionsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.ListDocumentVersionsIterable responses = client.listDocumentVersionsPaginator(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
listDocumentVersions(software.amazon.awssdk.services.ssm.model.ListDocumentVersionsRequest)
operation.
This is a convenience which creates an instance of the ListDocumentVersionsRequest.Builder
avoiding the
need to create one manually via ListDocumentVersionsRequest.builder()
listDocumentVersionsRequest
- A Consumer
that will call methods on ListDocumentVersionsRequest.Builder
to create a
request.InternalServerErrorException
- An error occurred on the server side.InvalidNextTokenException
- The specified token is not valid.InvalidDocumentException
- The specified document 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 ListDocumentsResponse listDocuments() throws InternalServerErrorException, InvalidNextTokenException, InvalidFilterKeyException, AwsServiceException, SdkClientException, SsmException
Returns all Systems Manager (SSM) documents in the current AWS account and Region. You can limit the results of this request by using a filter.
InternalServerErrorException
- An error occurred on the server side.InvalidNextTokenException
- The specified token 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
listDocuments(ListDocumentsRequest)
,
AWS API
Documentationdefault ListDocumentsResponse listDocuments(ListDocumentsRequest listDocumentsRequest) throws InternalServerErrorException, InvalidNextTokenException, InvalidFilterKeyException, AwsServiceException, SdkClientException, SsmException
Returns all Systems Manager (SSM) documents in the current AWS account and Region. You can limit the results of this request by using a filter.
listDocumentsRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidNextTokenException
- The specified token 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 ListDocumentsResponse listDocuments(Consumer<ListDocumentsRequest.Builder> listDocumentsRequest) throws InternalServerErrorException, InvalidNextTokenException, InvalidFilterKeyException, AwsServiceException, SdkClientException, SsmException
Returns all Systems Manager (SSM) documents in the current AWS account and Region. You can limit the results of this request by using a filter.
This is a convenience which creates an instance of the ListDocumentsRequest.Builder
avoiding the need to
create one manually via ListDocumentsRequest.builder()
listDocumentsRequest
- A Consumer
that will call methods on ListDocumentsRequest.Builder
to create a request.InternalServerErrorException
- An error occurred on the server side.InvalidNextTokenException
- The specified token 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 ListDocumentsIterable listDocumentsPaginator() throws InternalServerErrorException, InvalidNextTokenException, InvalidFilterKeyException, AwsServiceException, SdkClientException, SsmException
Returns all Systems Manager (SSM) documents in the current AWS account and Region. You can limit the results of this request by using a filter.
This is a variant of listDocuments(software.amazon.awssdk.services.ssm.model.ListDocumentsRequest)
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.ListDocumentsIterable responses = client.listDocumentsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.ListDocumentsIterable responses = client.listDocumentsPaginator(request); for (software.amazon.awssdk.services.ssm.model.ListDocumentsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.ListDocumentsIterable responses = client.listDocumentsPaginator(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
listDocuments(software.amazon.awssdk.services.ssm.model.ListDocumentsRequest)
operation.
InternalServerErrorException
- An error occurred on the server side.InvalidNextTokenException
- The specified token 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
listDocumentsPaginator(ListDocumentsRequest)
,
AWS API
Documentationdefault ListDocumentsIterable listDocumentsPaginator(ListDocumentsRequest listDocumentsRequest) throws InternalServerErrorException, InvalidNextTokenException, InvalidFilterKeyException, AwsServiceException, SdkClientException, SsmException
Returns all Systems Manager (SSM) documents in the current AWS account and Region. You can limit the results of this request by using a filter.
This is a variant of listDocuments(software.amazon.awssdk.services.ssm.model.ListDocumentsRequest)
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.ListDocumentsIterable responses = client.listDocumentsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.ListDocumentsIterable responses = client.listDocumentsPaginator(request); for (software.amazon.awssdk.services.ssm.model.ListDocumentsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.ListDocumentsIterable responses = client.listDocumentsPaginator(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
listDocuments(software.amazon.awssdk.services.ssm.model.ListDocumentsRequest)
operation.
listDocumentsRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidNextTokenException
- The specified token 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 ListDocumentsIterable listDocumentsPaginator(Consumer<ListDocumentsRequest.Builder> listDocumentsRequest) throws InternalServerErrorException, InvalidNextTokenException, InvalidFilterKeyException, AwsServiceException, SdkClientException, SsmException
Returns all Systems Manager (SSM) documents in the current AWS account and Region. You can limit the results of this request by using a filter.
This is a variant of listDocuments(software.amazon.awssdk.services.ssm.model.ListDocumentsRequest)
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.ListDocumentsIterable responses = client.listDocumentsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.ListDocumentsIterable responses = client.listDocumentsPaginator(request); for (software.amazon.awssdk.services.ssm.model.ListDocumentsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.ListDocumentsIterable responses = client.listDocumentsPaginator(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
listDocuments(software.amazon.awssdk.services.ssm.model.ListDocumentsRequest)
operation.
This is a convenience which creates an instance of the ListDocumentsRequest.Builder
avoiding the need to
create one manually via ListDocumentsRequest.builder()
listDocumentsRequest
- A Consumer
that will call methods on ListDocumentsRequest.Builder
to create a request.InternalServerErrorException
- An error occurred on the server side.InvalidNextTokenException
- The specified token 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 ListInventoryEntriesResponse listInventoryEntries(ListInventoryEntriesRequest listInventoryEntriesRequest) throws InternalServerErrorException, InvalidInstanceIdException, InvalidTypeNameException, InvalidFilterException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
A list of inventory items returned by the request.
listInventoryEntriesRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidInstanceIdException
- The following problems can cause this exception:
You do not have permission to access the instance.
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.
InvalidTypeNameException
- The parameter type name is not valid.InvalidFilterException
- The filter name is not valid. Verify the you entered the correct name and try again.InvalidNextTokenException
- The specified token is not valid.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 ListInventoryEntriesResponse listInventoryEntries(Consumer<ListInventoryEntriesRequest.Builder> listInventoryEntriesRequest) throws InternalServerErrorException, InvalidInstanceIdException, InvalidTypeNameException, InvalidFilterException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
A list of inventory items returned by the request.
This is a convenience which creates an instance of the ListInventoryEntriesRequest.Builder
avoiding the
need to create one manually via ListInventoryEntriesRequest.builder()
listInventoryEntriesRequest
- A Consumer
that will call methods on ListInventoryEntriesRequest.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.
InvalidTypeNameException
- The parameter type name is not valid.InvalidFilterException
- The filter name is not valid. Verify the you entered the correct name and try again.InvalidNextTokenException
- The specified token is not valid.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 ListResourceComplianceSummariesResponse listResourceComplianceSummaries() throws InvalidFilterException, InvalidNextTokenException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Returns a resource-level summary count. The summary includes information about compliant and non-compliant statuses and detailed compliance-item severity counts, according to the filter criteria you specify.
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
listResourceComplianceSummaries(ListResourceComplianceSummariesRequest)
,
AWS API Documentationdefault ListResourceComplianceSummariesResponse listResourceComplianceSummaries(ListResourceComplianceSummariesRequest listResourceComplianceSummariesRequest) throws InvalidFilterException, InvalidNextTokenException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Returns a resource-level summary count. The summary includes information about compliant and non-compliant statuses and detailed compliance-item severity counts, according to the filter criteria you specify.
listResourceComplianceSummariesRequest
- InvalidFilterException
- The filter name is not valid. Verify the you entered the correct name and try again.InvalidNextTokenException
- The specified token is not valid.InternalServerErrorException
- An error occurred on the server side.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 ListResourceComplianceSummariesResponse listResourceComplianceSummaries(Consumer<ListResourceComplianceSummariesRequest.Builder> listResourceComplianceSummariesRequest) throws InvalidFilterException, InvalidNextTokenException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Returns a resource-level summary count. The summary includes information about compliant and non-compliant statuses and detailed compliance-item severity counts, according to the filter criteria you specify.
This is a convenience which creates an instance of the ListResourceComplianceSummariesRequest.Builder
avoiding the need to create one manually via ListResourceComplianceSummariesRequest.builder()
listResourceComplianceSummariesRequest
- A Consumer
that will call methods on ListResourceComplianceSummariesRequest.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 ListResourceComplianceSummariesIterable listResourceComplianceSummariesPaginator() throws InvalidFilterException, InvalidNextTokenException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Returns a resource-level summary count. The summary includes information about compliant and non-compliant statuses and detailed compliance-item severity counts, according to the filter criteria you specify.
This is a variant of
listResourceComplianceSummaries(software.amazon.awssdk.services.ssm.model.ListResourceComplianceSummariesRequest)
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.ListResourceComplianceSummariesIterable responses = client.listResourceComplianceSummariesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.ListResourceComplianceSummariesIterable responses = client .listResourceComplianceSummariesPaginator(request); for (software.amazon.awssdk.services.ssm.model.ListResourceComplianceSummariesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.ListResourceComplianceSummariesIterable responses = client.listResourceComplianceSummariesPaginator(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
listResourceComplianceSummaries(software.amazon.awssdk.services.ssm.model.ListResourceComplianceSummariesRequest)
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
listResourceComplianceSummariesPaginator(ListResourceComplianceSummariesRequest)
,
AWS API Documentationdefault ListResourceComplianceSummariesIterable listResourceComplianceSummariesPaginator(ListResourceComplianceSummariesRequest listResourceComplianceSummariesRequest) throws InvalidFilterException, InvalidNextTokenException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Returns a resource-level summary count. The summary includes information about compliant and non-compliant statuses and detailed compliance-item severity counts, according to the filter criteria you specify.
This is a variant of
listResourceComplianceSummaries(software.amazon.awssdk.services.ssm.model.ListResourceComplianceSummariesRequest)
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.ListResourceComplianceSummariesIterable responses = client.listResourceComplianceSummariesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.ListResourceComplianceSummariesIterable responses = client .listResourceComplianceSummariesPaginator(request); for (software.amazon.awssdk.services.ssm.model.ListResourceComplianceSummariesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.ListResourceComplianceSummariesIterable responses = client.listResourceComplianceSummariesPaginator(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
listResourceComplianceSummaries(software.amazon.awssdk.services.ssm.model.ListResourceComplianceSummariesRequest)
operation.
listResourceComplianceSummariesRequest
- InvalidFilterException
- The filter name is not valid. Verify the you entered the correct name and try again.InvalidNextTokenException
- The specified token is not valid.InternalServerErrorException
- An error occurred on the server side.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 ListResourceComplianceSummariesIterable listResourceComplianceSummariesPaginator(Consumer<ListResourceComplianceSummariesRequest.Builder> listResourceComplianceSummariesRequest) throws InvalidFilterException, InvalidNextTokenException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Returns a resource-level summary count. The summary includes information about compliant and non-compliant statuses and detailed compliance-item severity counts, according to the filter criteria you specify.
This is a variant of
listResourceComplianceSummaries(software.amazon.awssdk.services.ssm.model.ListResourceComplianceSummariesRequest)
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.ListResourceComplianceSummariesIterable responses = client.listResourceComplianceSummariesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.ListResourceComplianceSummariesIterable responses = client .listResourceComplianceSummariesPaginator(request); for (software.amazon.awssdk.services.ssm.model.ListResourceComplianceSummariesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.ListResourceComplianceSummariesIterable responses = client.listResourceComplianceSummariesPaginator(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
listResourceComplianceSummaries(software.amazon.awssdk.services.ssm.model.ListResourceComplianceSummariesRequest)
operation.
This is a convenience which creates an instance of the ListResourceComplianceSummariesRequest.Builder
avoiding the need to create one manually via ListResourceComplianceSummariesRequest.builder()
listResourceComplianceSummariesRequest
- A Consumer
that will call methods on ListResourceComplianceSummariesRequest.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 ListResourceDataSyncResponse listResourceDataSync() throws ResourceDataSyncInvalidConfigurationException, InternalServerErrorException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Lists your resource data sync configurations. Includes information about the last time a sync attempted to start, the last sync status, and the last time a sync successfully completed.
The number of sync configurations might be too large to return using a single call to
ListResourceDataSync
. You can limit the number of sync configurations returned by using the
MaxResults
parameter. To determine whether there are more sync configurations to list, check the
value of NextToken
in the output. If there are more sync configurations to list, you can request
them by specifying the NextToken
returned in the call to the parameter of a subsequent call.
ResourceDataSyncInvalidConfigurationException
- The specified sync configuration is invalid.InternalServerErrorException
- An error occurred on the server side.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
listResourceDataSync(ListResourceDataSyncRequest)
,
AWS API
Documentationdefault ListResourceDataSyncResponse listResourceDataSync(ListResourceDataSyncRequest listResourceDataSyncRequest) throws ResourceDataSyncInvalidConfigurationException, InternalServerErrorException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Lists your resource data sync configurations. Includes information about the last time a sync attempted to start, the last sync status, and the last time a sync successfully completed.
The number of sync configurations might be too large to return using a single call to
ListResourceDataSync
. You can limit the number of sync configurations returned by using the
MaxResults
parameter. To determine whether there are more sync configurations to list, check the
value of NextToken
in the output. If there are more sync configurations to list, you can request
them by specifying the NextToken
returned in the call to the parameter of a subsequent call.
listResourceDataSyncRequest
- ResourceDataSyncInvalidConfigurationException
- The specified sync configuration is invalid.InternalServerErrorException
- An error occurred on the server side.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 ListResourceDataSyncResponse listResourceDataSync(Consumer<ListResourceDataSyncRequest.Builder> listResourceDataSyncRequest) throws ResourceDataSyncInvalidConfigurationException, InternalServerErrorException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Lists your resource data sync configurations. Includes information about the last time a sync attempted to start, the last sync status, and the last time a sync successfully completed.
The number of sync configurations might be too large to return using a single call to
ListResourceDataSync
. You can limit the number of sync configurations returned by using the
MaxResults
parameter. To determine whether there are more sync configurations to list, check the
value of NextToken
in the output. If there are more sync configurations to list, you can request
them by specifying the NextToken
returned in the call to the parameter of a subsequent call.
This is a convenience which creates an instance of the ListResourceDataSyncRequest.Builder
avoiding the
need to create one manually via ListResourceDataSyncRequest.builder()
listResourceDataSyncRequest
- A Consumer
that will call methods on ListResourceDataSyncRequest.Builder
to create a
request.ResourceDataSyncInvalidConfigurationException
- The specified sync configuration is invalid.InternalServerErrorException
- An error occurred on the server side.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 ListResourceDataSyncIterable listResourceDataSyncPaginator() throws ResourceDataSyncInvalidConfigurationException, InternalServerErrorException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Lists your resource data sync configurations. Includes information about the last time a sync attempted to start, the last sync status, and the last time a sync successfully completed.
The number of sync configurations might be too large to return using a single call to
ListResourceDataSync
. You can limit the number of sync configurations returned by using the
MaxResults
parameter. To determine whether there are more sync configurations to list, check the
value of NextToken
in the output. If there are more sync configurations to list, you can request
them by specifying the NextToken
returned in the call to the parameter of a subsequent call.
This is a variant of
listResourceDataSync(software.amazon.awssdk.services.ssm.model.ListResourceDataSyncRequest)
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.ListResourceDataSyncIterable responses = client.listResourceDataSyncPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.ListResourceDataSyncIterable responses = client .listResourceDataSyncPaginator(request); for (software.amazon.awssdk.services.ssm.model.ListResourceDataSyncResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.ListResourceDataSyncIterable responses = client.listResourceDataSyncPaginator(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
listResourceDataSync(software.amazon.awssdk.services.ssm.model.ListResourceDataSyncRequest)
operation.
ResourceDataSyncInvalidConfigurationException
- The specified sync configuration is invalid.InternalServerErrorException
- An error occurred on the server side.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
listResourceDataSyncPaginator(ListResourceDataSyncRequest)
,
AWS API
Documentationdefault ListResourceDataSyncIterable listResourceDataSyncPaginator(ListResourceDataSyncRequest listResourceDataSyncRequest) throws ResourceDataSyncInvalidConfigurationException, InternalServerErrorException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Lists your resource data sync configurations. Includes information about the last time a sync attempted to start, the last sync status, and the last time a sync successfully completed.
The number of sync configurations might be too large to return using a single call to
ListResourceDataSync
. You can limit the number of sync configurations returned by using the
MaxResults
parameter. To determine whether there are more sync configurations to list, check the
value of NextToken
in the output. If there are more sync configurations to list, you can request
them by specifying the NextToken
returned in the call to the parameter of a subsequent call.
This is a variant of
listResourceDataSync(software.amazon.awssdk.services.ssm.model.ListResourceDataSyncRequest)
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.ListResourceDataSyncIterable responses = client.listResourceDataSyncPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.ListResourceDataSyncIterable responses = client .listResourceDataSyncPaginator(request); for (software.amazon.awssdk.services.ssm.model.ListResourceDataSyncResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.ListResourceDataSyncIterable responses = client.listResourceDataSyncPaginator(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
listResourceDataSync(software.amazon.awssdk.services.ssm.model.ListResourceDataSyncRequest)
operation.
listResourceDataSyncRequest
- ResourceDataSyncInvalidConfigurationException
- The specified sync configuration is invalid.InternalServerErrorException
- An error occurred on the server side.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 ListResourceDataSyncIterable listResourceDataSyncPaginator(Consumer<ListResourceDataSyncRequest.Builder> listResourceDataSyncRequest) throws ResourceDataSyncInvalidConfigurationException, InternalServerErrorException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Lists your resource data sync configurations. Includes information about the last time a sync attempted to start, the last sync status, and the last time a sync successfully completed.
The number of sync configurations might be too large to return using a single call to
ListResourceDataSync
. You can limit the number of sync configurations returned by using the
MaxResults
parameter. To determine whether there are more sync configurations to list, check the
value of NextToken
in the output. If there are more sync configurations to list, you can request
them by specifying the NextToken
returned in the call to the parameter of a subsequent call.
This is a variant of
listResourceDataSync(software.amazon.awssdk.services.ssm.model.ListResourceDataSyncRequest)
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.ListResourceDataSyncIterable responses = client.listResourceDataSyncPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.ListResourceDataSyncIterable responses = client .listResourceDataSyncPaginator(request); for (software.amazon.awssdk.services.ssm.model.ListResourceDataSyncResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.ListResourceDataSyncIterable responses = client.listResourceDataSyncPaginator(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
listResourceDataSync(software.amazon.awssdk.services.ssm.model.ListResourceDataSyncRequest)
operation.
This is a convenience which creates an instance of the ListResourceDataSyncRequest.Builder
avoiding the
need to create one manually via ListResourceDataSyncRequest.builder()
listResourceDataSyncRequest
- A Consumer
that will call methods on ListResourceDataSyncRequest.Builder
to create a
request.ResourceDataSyncInvalidConfigurationException
- The specified sync configuration is invalid.InternalServerErrorException
- An error occurred on the server side.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 ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws InvalidResourceTypeException, InvalidResourceIdException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Returns a list of the tags assigned to the specified resource.
listTagsForResourceRequest
- InvalidResourceTypeException
- The resource type is not valid. For example, if you are attempting to tag an instance, the instance must
be a registered, managed instance.InvalidResourceIdException
- The resource ID is not valid. Verify that you entered the correct ID and try again.InternalServerErrorException
- An error occurred on the server side.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 ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws InvalidResourceTypeException, InvalidResourceIdException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Returns a list of the tags assigned to the specified resource.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder
avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest
- A Consumer
that will call methods on ListTagsForResourceRequest.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.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 ModifyDocumentPermissionResponse modifyDocumentPermission(ModifyDocumentPermissionRequest modifyDocumentPermissionRequest) throws InternalServerErrorException, InvalidDocumentException, InvalidPermissionTypeException, DocumentPermissionLimitException, DocumentLimitExceededException, AwsServiceException, SdkClientException, SsmException
Shares a Systems Manager document publicly or privately. If you share a document privately, you must specify the AWS user account IDs for those people who can use the document. If you share a document publicly, you must specify All as the account ID.
modifyDocumentPermissionRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidDocumentException
- The specified document does not exist.InvalidPermissionTypeException
- The permission type is not supported. Share is the only supported permission type.DocumentPermissionLimitException
- The document cannot be shared with more AWS user accounts. You can share a document with a maximum of 20
accounts. You can publicly share up to five documents. If you need to increase this limit, contact AWS
Support.DocumentLimitExceededException
- You can have at most 500 active Systems Manager documents.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 ModifyDocumentPermissionResponse modifyDocumentPermission(Consumer<ModifyDocumentPermissionRequest.Builder> modifyDocumentPermissionRequest) throws InternalServerErrorException, InvalidDocumentException, InvalidPermissionTypeException, DocumentPermissionLimitException, DocumentLimitExceededException, AwsServiceException, SdkClientException, SsmException
Shares a Systems Manager document publicly or privately. If you share a document privately, you must specify the AWS user account IDs for those people who can use the document. If you share a document publicly, you must specify All as the account ID.
This is a convenience which creates an instance of the ModifyDocumentPermissionRequest.Builder
avoiding
the need to create one manually via ModifyDocumentPermissionRequest.builder()
modifyDocumentPermissionRequest
- A Consumer
that will call methods on ModifyDocumentPermissionRequest.Builder
to create a
request.InternalServerErrorException
- An error occurred on the server side.InvalidDocumentException
- The specified document does not exist.InvalidPermissionTypeException
- The permission type is not supported. Share is the only supported permission type.DocumentPermissionLimitException
- The document cannot be shared with more AWS user accounts. You can share a document with a maximum of 20
accounts. You can publicly share up to five documents. If you need to increase this limit, contact AWS
Support.DocumentLimitExceededException
- You can have at most 500 active Systems Manager documents.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 PutComplianceItemsResponse putComplianceItems(PutComplianceItemsRequest putComplianceItemsRequest) throws InternalServerErrorException, InvalidItemContentException, TotalSizeLimitExceededException, ItemSizeLimitExceededException, ComplianceTypeCountLimitExceededException, InvalidResourceTypeException, InvalidResourceIdException, AwsServiceException, SdkClientException, SsmException
Registers a compliance type and other compliance details on a designated resource. This action lets you register custom compliance details with a resource. This call overwrites existing compliance information on the resource, so you must provide a full list of compliance items each time that you send the request.
ComplianceType can be one of the following:
ExecutionId: The execution ID when the patch, association, or custom compliance item was applied.
ExecutionType: Specify patch, association, or Custom:string
.
ExecutionTime. The time the patch, association, or custom compliance item was applied to the instance.
Id: The patch, association, or custom compliance ID.
Title: A title.
Status: The status of the compliance item. For example, approved
for patches, or Failed
for associations.
Severity: A patch severity. For example, critical
.
DocumentName: A SSM document name. For example, AWS-RunPatchBaseline.
DocumentVersion: An SSM document version number. For example, 4.
Classification: A patch classification. For example, security updates
.
PatchBaselineId: A patch baseline ID.
PatchSeverity: A patch severity. For example, Critical
.
PatchState: A patch state. For example, InstancesWithFailedPatches
.
PatchGroup: The name of a patch group.
InstalledTime: The time the association, patch, or custom compliance item was applied to the resource. Specify the time by using the following format: yyyy-MM-dd'T'HH:mm:ss'Z'
putComplianceItemsRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidItemContentException
- One or more content items is not valid.TotalSizeLimitExceededException
- The size of inventory data has exceeded the total size limit for the resource.ItemSizeLimitExceededException
- The inventory item size has exceeded the size limit.ComplianceTypeCountLimitExceededException
- You specified too many custom compliance types. You can specify a maximum of 10 different types.InvalidResourceTypeException
- The resource type is not valid. For example, if you are attempting to tag an instance, the instance must
be a registered, managed instance.InvalidResourceIdException
- The resource ID is not valid. Verify that you entered the correct ID and try again.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 PutComplianceItemsResponse putComplianceItems(Consumer<PutComplianceItemsRequest.Builder> putComplianceItemsRequest) throws InternalServerErrorException, InvalidItemContentException, TotalSizeLimitExceededException, ItemSizeLimitExceededException, ComplianceTypeCountLimitExceededException, InvalidResourceTypeException, InvalidResourceIdException, AwsServiceException, SdkClientException, SsmException
Registers a compliance type and other compliance details on a designated resource. This action lets you register custom compliance details with a resource. This call overwrites existing compliance information on the resource, so you must provide a full list of compliance items each time that you send the request.
ComplianceType can be one of the following:
ExecutionId: The execution ID when the patch, association, or custom compliance item was applied.
ExecutionType: Specify patch, association, or Custom:string
.
ExecutionTime. The time the patch, association, or custom compliance item was applied to the instance.
Id: The patch, association, or custom compliance ID.
Title: A title.
Status: The status of the compliance item. For example, approved
for patches, or Failed
for associations.
Severity: A patch severity. For example, critical
.
DocumentName: A SSM document name. For example, AWS-RunPatchBaseline.
DocumentVersion: An SSM document version number. For example, 4.
Classification: A patch classification. For example, security updates
.
PatchBaselineId: A patch baseline ID.
PatchSeverity: A patch severity. For example, Critical
.
PatchState: A patch state. For example, InstancesWithFailedPatches
.
PatchGroup: The name of a patch group.
InstalledTime: The time the association, patch, or custom compliance item was applied to the resource. Specify the time by using the following format: yyyy-MM-dd'T'HH:mm:ss'Z'
This is a convenience which creates an instance of the PutComplianceItemsRequest.Builder
avoiding the
need to create one manually via PutComplianceItemsRequest.builder()
putComplianceItemsRequest
- A Consumer
that will call methods on PutComplianceItemsRequest.Builder
to create a
request.InternalServerErrorException
- An error occurred on the server side.InvalidItemContentException
- One or more content items is not valid.TotalSizeLimitExceededException
- The size of inventory data has exceeded the total size limit for the resource.ItemSizeLimitExceededException
- The inventory item size has exceeded the size limit.ComplianceTypeCountLimitExceededException
- You specified too many custom compliance types. You can specify a maximum of 10 different types.InvalidResourceTypeException
- The resource type is not valid. For example, if you are attempting to tag an instance, the instance must
be a registered, managed instance.InvalidResourceIdException
- The resource ID is not valid. Verify that you entered the correct ID and try again.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 PutInventoryResponse putInventory(PutInventoryRequest putInventoryRequest) throws InternalServerErrorException, InvalidInstanceIdException, InvalidTypeNameException, InvalidItemContentException, TotalSizeLimitExceededException, ItemSizeLimitExceededException, ItemContentMismatchException, CustomSchemaCountLimitExceededException, UnsupportedInventorySchemaVersionException, UnsupportedInventoryItemContextException, InvalidInventoryItemContextException, SubTypeCountLimitExceededException, AwsServiceException, SdkClientException, SsmException
Bulk update custom inventory items on one more instance. The request adds an inventory item, if it doesn't already exist, or updates an inventory item, if it does exist.
putInventoryRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidInstanceIdException
- The following problems can cause this exception:
You do not have permission to access the instance.
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.
InvalidTypeNameException
- The parameter type name is not valid.InvalidItemContentException
- One or more content items is not valid.TotalSizeLimitExceededException
- The size of inventory data has exceeded the total size limit for the resource.ItemSizeLimitExceededException
- The inventory item size has exceeded the size limit.ItemContentMismatchException
- The inventory item has invalid content.CustomSchemaCountLimitExceededException
- You have exceeded the limit for custom schemas. Delete one or more custom schemas and try again.UnsupportedInventorySchemaVersionException
- Inventory item type schema version has to match supported versions in the service. Check output of
GetInventorySchema to see the available schema version for each type.UnsupportedInventoryItemContextException
- The Context
attribute that you specified for the InventoryItem
is not allowed
for this inventory type. You can only use the Context
attribute with inventory types like
AWS:ComplianceItem
.InvalidInventoryItemContextException
- You specified invalid keys or values in the Context
attribute for InventoryItem
. Verify the keys and values, and try again.SubTypeCountLimitExceededException
- The sub-type count exceeded the limit for the inventory type.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 PutInventoryResponse putInventory(Consumer<PutInventoryRequest.Builder> putInventoryRequest) throws InternalServerErrorException, InvalidInstanceIdException, InvalidTypeNameException, InvalidItemContentException, TotalSizeLimitExceededException, ItemSizeLimitExceededException, ItemContentMismatchException, CustomSchemaCountLimitExceededException, UnsupportedInventorySchemaVersionException, UnsupportedInventoryItemContextException, InvalidInventoryItemContextException, SubTypeCountLimitExceededException, AwsServiceException, SdkClientException, SsmException
Bulk update custom inventory items on one more instance. The request adds an inventory item, if it doesn't already exist, or updates an inventory item, if it does exist.
This is a convenience which creates an instance of the PutInventoryRequest.Builder
avoiding the need to
create one manually via PutInventoryRequest.builder()
putInventoryRequest
- A Consumer
that will call methods on PutInventoryRequest.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.
InvalidTypeNameException
- The parameter type name is not valid.InvalidItemContentException
- One or more content items is not valid.TotalSizeLimitExceededException
- The size of inventory data has exceeded the total size limit for the resource.ItemSizeLimitExceededException
- The inventory item size has exceeded the size limit.ItemContentMismatchException
- The inventory item has invalid content.CustomSchemaCountLimitExceededException
- You have exceeded the limit for custom schemas. Delete one or more custom schemas and try again.UnsupportedInventorySchemaVersionException
- Inventory item type schema version has to match supported versions in the service. Check output of
GetInventorySchema to see the available schema version for each type.UnsupportedInventoryItemContextException
- The Context
attribute that you specified for the InventoryItem
is not allowed
for this inventory type. You can only use the Context
attribute with inventory types like
AWS:ComplianceItem
.InvalidInventoryItemContextException
- You specified invalid keys or values in the Context
attribute for InventoryItem
. Verify the keys and values, and try again.SubTypeCountLimitExceededException
- The sub-type count exceeded the limit for the inventory type.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 PutParameterResponse putParameter(PutParameterRequest putParameterRequest) throws InternalServerErrorException, InvalidKeyIdException, ParameterLimitExceededException, TooManyUpdatesException, ParameterAlreadyExistsException, HierarchyLevelLimitExceededException, HierarchyTypeMismatchException, InvalidAllowedPatternException, ParameterMaxVersionLimitExceededException, ParameterPatternMismatchException, UnsupportedParameterTypeException, PoliciesLimitExceededException, InvalidPolicyTypeException, InvalidPolicyAttributeException, IncompatiblePolicyException, AwsServiceException, SdkClientException, SsmException
Add a parameter to the system.
putParameterRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidKeyIdException
- The query key ID is not valid.ParameterLimitExceededException
- You have exceeded the number of parameters for this AWS account. Delete one or more parameters and try
again.TooManyUpdatesException
- There are concurrent updates for a resource that supports one update at a time.ParameterAlreadyExistsException
- The parameter already exists. You can't create duplicate parameters.HierarchyLevelLimitExceededException
- A hierarchy can have a maximum of 15 levels. For more information, see Requirements and constraints for parameter names in the AWS Systems Manager User Guide.HierarchyTypeMismatchException
- Parameter Store does not support changing a parameter type in a hierarchy. For example, you can't change
a parameter from a String
type to a SecureString
type. You must create a new,
unique parameter.InvalidAllowedPatternException
- The request does not meet the regular expression requirement.ParameterMaxVersionLimitExceededException
- The parameter exceeded the maximum number of allowed versions.ParameterPatternMismatchException
- The parameter name is not valid.UnsupportedParameterTypeException
- The parameter type is not supported.PoliciesLimitExceededException
- You specified more than the maximum number of allowed policies for the parameter. The maximum is 10.InvalidPolicyTypeException
- The policy type is not supported. Parameter Store supports the following policy types: Expiration,
ExpirationNotification, and NoChangeNotification.InvalidPolicyAttributeException
- A policy attribute or its value is invalid.IncompatiblePolicyException
- There is a conflict in the policies specified for this parameter. You can't, for example, specify two
Expiration policies for a parameter. Review your policies, 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 PutParameterResponse putParameter(Consumer<PutParameterRequest.Builder> putParameterRequest) throws InternalServerErrorException, InvalidKeyIdException, ParameterLimitExceededException, TooManyUpdatesException, ParameterAlreadyExistsException, HierarchyLevelLimitExceededException, HierarchyTypeMismatchException, InvalidAllowedPatternException, ParameterMaxVersionLimitExceededException, ParameterPatternMismatchException, UnsupportedParameterTypeException, PoliciesLimitExceededException, InvalidPolicyTypeException, InvalidPolicyAttributeException, IncompatiblePolicyException, AwsServiceException, SdkClientException, SsmException
Add a parameter to the system.
This is a convenience which creates an instance of the PutParameterRequest.Builder
avoiding the need to
create one manually via PutParameterRequest.builder()
putParameterRequest
- A Consumer
that will call methods on PutParameterRequest.Builder
to create a request.InternalServerErrorException
- An error occurred on the server side.InvalidKeyIdException
- The query key ID is not valid.ParameterLimitExceededException
- You have exceeded the number of parameters for this AWS account. Delete one or more parameters and try
again.TooManyUpdatesException
- There are concurrent updates for a resource that supports one update at a time.ParameterAlreadyExistsException
- The parameter already exists. You can't create duplicate parameters.HierarchyLevelLimitExceededException
- A hierarchy can have a maximum of 15 levels. For more information, see Requirements and constraints for parameter names in the AWS Systems Manager User Guide.HierarchyTypeMismatchException
- Parameter Store does not support changing a parameter type in a hierarchy. For example, you can't change
a parameter from a String
type to a SecureString
type. You must create a new,
unique parameter.InvalidAllowedPatternException
- The request does not meet the regular expression requirement.ParameterMaxVersionLimitExceededException
- The parameter exceeded the maximum number of allowed versions.ParameterPatternMismatchException
- The parameter name is not valid.UnsupportedParameterTypeException
- The parameter type is not supported.PoliciesLimitExceededException
- You specified more than the maximum number of allowed policies for the parameter. The maximum is 10.InvalidPolicyTypeException
- The policy type is not supported. Parameter Store supports the following policy types: Expiration,
ExpirationNotification, and NoChangeNotification.InvalidPolicyAttributeException
- A policy attribute or its value is invalid.IncompatiblePolicyException
- There is a conflict in the policies specified for this parameter. You can't, for example, specify two
Expiration policies for a parameter. Review your policies, 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 RegisterDefaultPatchBaselineResponse registerDefaultPatchBaseline(RegisterDefaultPatchBaselineRequest registerDefaultPatchBaselineRequest) throws InvalidResourceIdException, DoesNotExistException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Defines the default patch baseline for the relevant operating system.
To reset the AWS predefined patch baseline as the default, specify the full patch baseline ARN as the baseline ID
value. For example, for CentOS, specify
arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-0574b43a65ea646ed
instead of
pb-0574b43a65ea646ed
.
registerDefaultPatchBaselineRequest
- InvalidResourceIdException
- The resource ID is not valid. Verify that you entered the correct ID and try again.DoesNotExistException
- Error returned when the ID specified for a resource, 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 RegisterDefaultPatchBaselineResponse registerDefaultPatchBaseline(Consumer<RegisterDefaultPatchBaselineRequest.Builder> registerDefaultPatchBaselineRequest) throws InvalidResourceIdException, DoesNotExistException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Defines the default patch baseline for the relevant operating system.
To reset the AWS predefined patch baseline as the default, specify the full patch baseline ARN as the baseline ID
value. For example, for CentOS, specify
arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-0574b43a65ea646ed
instead of
pb-0574b43a65ea646ed
.
This is a convenience which creates an instance of the RegisterDefaultPatchBaselineRequest.Builder
avoiding the need to create one manually via RegisterDefaultPatchBaselineRequest.builder()
registerDefaultPatchBaselineRequest
- A Consumer
that will call methods on RegisterDefaultPatchBaselineRequest.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.
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 RegisterPatchBaselineForPatchGroupResponse registerPatchBaselineForPatchGroup(RegisterPatchBaselineForPatchGroupRequest registerPatchBaselineForPatchGroupRequest) throws AlreadyExistsException, DoesNotExistException, InvalidResourceIdException, ResourceLimitExceededException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Registers a patch baseline for a patch group.
registerPatchBaselineForPatchGroupRequest
- AlreadyExistsException
- Error returned if an attempt is made to register a patch group with a patch baseline that is already
registered with a different patch baseline.DoesNotExistException
- Error returned when the ID specified for a resource, 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.
InvalidResourceIdException
- The resource ID is not valid. Verify that you entered the correct ID and try again.ResourceLimitExceededException
- Error returned when the caller has exceeded the default resource 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 RegisterPatchBaselineForPatchGroupResponse registerPatchBaselineForPatchGroup(Consumer<RegisterPatchBaselineForPatchGroupRequest.Builder> registerPatchBaselineForPatchGroupRequest) throws AlreadyExistsException, DoesNotExistException, InvalidResourceIdException, ResourceLimitExceededException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Registers a patch baseline for a patch group.
This is a convenience which creates an instance of the RegisterPatchBaselineForPatchGroupRequest.Builder
avoiding the need to create one manually via RegisterPatchBaselineForPatchGroupRequest.builder()
registerPatchBaselineForPatchGroupRequest
- A Consumer
that will call methods on RegisterPatchBaselineForPatchGroupRequest.Builder
to
create a request.AlreadyExistsException
- Error returned if an attempt is made to register a patch group with a patch baseline that is already
registered with a different patch baseline.DoesNotExistException
- Error returned when the ID specified for a resource, 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.
InvalidResourceIdException
- The resource ID is not valid. Verify that you entered the correct ID and try again.ResourceLimitExceededException
- Error returned when the caller has exceeded the default resource 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 RegisterTargetWithMaintenanceWindowResponse registerTargetWithMaintenanceWindow(RegisterTargetWithMaintenanceWindowRequest registerTargetWithMaintenanceWindowRequest) throws IdempotentParameterMismatchException, DoesNotExistException, ResourceLimitExceededException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Registers a target with a maintenance window.
registerTargetWithMaintenanceWindowRequest
- IdempotentParameterMismatchException
- Error returned when an idempotent operation is retried and the parameters don't match the original call
to the API with the same idempotency token.DoesNotExistException
- Error returned when the ID specified for a resource, 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.
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 RegisterTargetWithMaintenanceWindowResponse registerTargetWithMaintenanceWindow(Consumer<RegisterTargetWithMaintenanceWindowRequest.Builder> registerTargetWithMaintenanceWindowRequest) throws IdempotentParameterMismatchException, DoesNotExistException, ResourceLimitExceededException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Registers a target with a maintenance window.
This is a convenience which creates an instance of the RegisterTargetWithMaintenanceWindowRequest.Builder
avoiding the need to create one manually via RegisterTargetWithMaintenanceWindowRequest.builder()
registerTargetWithMaintenanceWindowRequest
- A Consumer
that will call methods on RegisterTargetWithMaintenanceWindowRequest.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.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.
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 RegisterTaskWithMaintenanceWindowResponse registerTaskWithMaintenanceWindow(RegisterTaskWithMaintenanceWindowRequest registerTaskWithMaintenanceWindowRequest) throws IdempotentParameterMismatchException, DoesNotExistException, ResourceLimitExceededException, FeatureNotAvailableException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Adds a new task to a maintenance window.
registerTaskWithMaintenanceWindowRequest
- IdempotentParameterMismatchException
- Error returned when an idempotent operation is retried and the parameters don't match the original call
to the API with the same idempotency token.DoesNotExistException
- Error returned when the ID specified for a resource, 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.
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.
FeatureNotAvailableException
- You attempted to register a LAMBDA or STEP_FUNCTIONS task in a region where the corresponding service is
not available.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 RegisterTaskWithMaintenanceWindowResponse registerTaskWithMaintenanceWindow(Consumer<RegisterTaskWithMaintenanceWindowRequest.Builder> registerTaskWithMaintenanceWindowRequest) throws IdempotentParameterMismatchException, DoesNotExistException, ResourceLimitExceededException, FeatureNotAvailableException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Adds a new task to a maintenance window.
This is a convenience which creates an instance of the RegisterTaskWithMaintenanceWindowRequest.Builder
avoiding the need to create one manually via RegisterTaskWithMaintenanceWindowRequest.builder()
registerTaskWithMaintenanceWindowRequest
- A Consumer
that will call methods on RegisterTaskWithMaintenanceWindowRequest.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.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.
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.
FeatureNotAvailableException
- You attempted to register a LAMBDA or STEP_FUNCTIONS task in a region where the corresponding service is
not available.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 RemoveTagsFromResourceResponse removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest) throws InvalidResourceTypeException, InvalidResourceIdException, InternalServerErrorException, TooManyUpdatesException, AwsServiceException, SdkClientException, SsmException
Removes tag keys from the specified resource.
removeTagsFromResourceRequest
- InvalidResourceTypeException
- The resource type is not valid. For example, if you are attempting to tag an instance, the instance must
be a registered, managed instance.InvalidResourceIdException
- The resource ID is not valid. Verify that you entered the correct ID and try again.InternalServerErrorException
- An error occurred on the server side.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 RemoveTagsFromResourceResponse removeTagsFromResource(Consumer<RemoveTagsFromResourceRequest.Builder> removeTagsFromResourceRequest) throws InvalidResourceTypeException, InvalidResourceIdException, InternalServerErrorException, TooManyUpdatesException, AwsServiceException, SdkClientException, SsmException
Removes tag keys from the specified resource.
This is a convenience which creates an instance of the RemoveTagsFromResourceRequest.Builder
avoiding the
need to create one manually via RemoveTagsFromResourceRequest.builder()
removeTagsFromResourceRequest
- A Consumer
that will call methods on RemoveTagsFromResourceRequest.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.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 ResetServiceSettingResponse resetServiceSetting(ResetServiceSettingRequest resetServiceSettingRequest) throws InternalServerErrorException, ServiceSettingNotFoundException, TooManyUpdatesException, AwsServiceException, SdkClientException, SsmException
ServiceSetting
is an account-level setting for an AWS service. This setting defines how a user
interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the
account based on feature or service usage, then the AWS service team might create a default setting of "false".
This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for
a paid feature.
Services map a SettingId
object to a setting value. AWS services teams define the default value for
a SettingId
. You can't create a new SettingId
, but you can overwrite the default value
if you have the ssm:UpdateServiceSetting
permission for the setting. Use the
GetServiceSetting API action to view the current value. Use the UpdateServiceSetting API action to
change the default setting.
Reset the service setting for the account to the default value as provisioned by the AWS service team.
resetServiceSettingRequest
- The request body of the ResetServiceSetting API action.InternalServerErrorException
- An error occurred on the server side.ServiceSettingNotFoundException
- The specified service setting was not found. Either the service name or the setting has not been
provisioned by the AWS service team.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 ResetServiceSettingResponse resetServiceSetting(Consumer<ResetServiceSettingRequest.Builder> resetServiceSettingRequest) throws InternalServerErrorException, ServiceSettingNotFoundException, TooManyUpdatesException, AwsServiceException, SdkClientException, SsmException
ServiceSetting
is an account-level setting for an AWS service. This setting defines how a user
interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the
account based on feature or service usage, then the AWS service team might create a default setting of "false".
This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for
a paid feature.
Services map a SettingId
object to a setting value. AWS services teams define the default value for
a SettingId
. You can't create a new SettingId
, but you can overwrite the default value
if you have the ssm:UpdateServiceSetting
permission for the setting. Use the
GetServiceSetting API action to view the current value. Use the UpdateServiceSetting API action to
change the default setting.
Reset the service setting for the account to the default value as provisioned by the AWS service team.
This is a convenience which creates an instance of the ResetServiceSettingRequest.Builder
avoiding the
need to create one manually via ResetServiceSettingRequest.builder()
resetServiceSettingRequest
- A Consumer
that will call methods on ResetServiceSettingRequest.Builder
to create a
request. The request body of the ResetServiceSetting API action.InternalServerErrorException
- An error occurred on the server side.ServiceSettingNotFoundException
- The specified service setting was not found. Either the service name or the setting has not been
provisioned by the AWS service team.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 ResumeSessionResponse resumeSession(ResumeSessionRequest resumeSessionRequest) throws DoesNotExistException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Reconnects a session to an instance after it has been disconnected. Connections can be resumed for disconnected sessions, but not terminated sessions.
This command is primarily for use by client machines to automatically reconnect during intermittent network issues. It is not intended for any other use.
resumeSessionRequest
- 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 ResumeSessionResponse resumeSession(Consumer<ResumeSessionRequest.Builder> resumeSessionRequest) throws DoesNotExistException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Reconnects a session to an instance after it has been disconnected. Connections can be resumed for disconnected sessions, but not terminated sessions.
This command is primarily for use by client machines to automatically reconnect during intermittent network issues. It is not intended for any other use.
This is a convenience which creates an instance of the ResumeSessionRequest.Builder
avoiding the need to
create one manually via ResumeSessionRequest.builder()
resumeSessionRequest
- A Consumer
that will call methods on ResumeSessionRequest.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 SendAutomationSignalResponse sendAutomationSignal(SendAutomationSignalRequest sendAutomationSignalRequest) throws AutomationExecutionNotFoundException, AutomationStepNotFoundException, InvalidAutomationSignalException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Sends a signal to an Automation execution to change the current behavior or status of the execution.
sendAutomationSignalRequest
- AutomationExecutionNotFoundException
- There is no automation execution information for the requested automation execution ID.AutomationStepNotFoundException
- The specified step name and execution ID don't exist. Verify the information and try again.InvalidAutomationSignalException
- The signal is not valid for the current Automation execution.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 SendAutomationSignalResponse sendAutomationSignal(Consumer<SendAutomationSignalRequest.Builder> sendAutomationSignalRequest) throws AutomationExecutionNotFoundException, AutomationStepNotFoundException, InvalidAutomationSignalException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Sends a signal to an Automation execution to change the current behavior or status of the execution.
This is a convenience which creates an instance of the SendAutomationSignalRequest.Builder
avoiding the
need to create one manually via SendAutomationSignalRequest.builder()
sendAutomationSignalRequest
- A Consumer
that will call methods on SendAutomationSignalRequest.Builder
to create a
request.AutomationExecutionNotFoundException
- There is no automation execution information for the requested automation execution ID.AutomationStepNotFoundException
- The specified step name and execution ID don't exist. Verify the information and try again.InvalidAutomationSignalException
- The signal is not valid for the current Automation execution.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 SendCommandResponse sendCommand(SendCommandRequest sendCommandRequest) throws DuplicateInstanceIdException, InternalServerErrorException, InvalidInstanceIdException, InvalidDocumentException, InvalidDocumentVersionException, InvalidOutputFolderException, InvalidParametersException, UnsupportedPlatformTypeException, MaxDocumentSizeExceededException, InvalidRoleException, InvalidNotificationConfigException, AwsServiceException, SdkClientException, SsmException
Runs commands on one or more managed instances.
sendCommandRequest
- DuplicateInstanceIdException
- You cannot specify an instance ID in more than one association.InternalServerErrorException
- An error occurred on the server side.InvalidInstanceIdException
- The following problems can cause this exception:
You do not have permission to access the instance.
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.
InvalidDocumentException
- The specified document does not exist.InvalidDocumentVersionException
- The document version is not valid or does not exist.InvalidOutputFolderException
- The S3 bucket does not exist.InvalidParametersException
- You must specify values for all required parameters in the Systems Manager document. You can only supply
values to parameters defined in the Systems Manager document.UnsupportedPlatformTypeException
- The document does not support the platform type of the given instance ID(s). For example, you sent an
document for a Windows instance to a Linux instance.MaxDocumentSizeExceededException
- The size limit of a document is 64 KB.InvalidRoleException
- The role name can't contain invalid characters. Also verify that you specified an IAM role for
notifications that includes the required trust policy. For information about configuring the IAM role for
Run Command notifications, see Configuring
Amazon SNS Notifications for Run Command in the AWS Systems Manager User Guide.InvalidNotificationConfigException
- One or more configuration items is not valid. Verify that a valid Amazon Resource Name (ARN) was provided
for an Amazon SNS topic.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 SendCommandResponse sendCommand(Consumer<SendCommandRequest.Builder> sendCommandRequest) throws DuplicateInstanceIdException, InternalServerErrorException, InvalidInstanceIdException, InvalidDocumentException, InvalidDocumentVersionException, InvalidOutputFolderException, InvalidParametersException, UnsupportedPlatformTypeException, MaxDocumentSizeExceededException, InvalidRoleException, InvalidNotificationConfigException, AwsServiceException, SdkClientException, SsmException
Runs commands on one or more managed instances.
This is a convenience which creates an instance of the SendCommandRequest.Builder
avoiding the need to
create one manually via SendCommandRequest.builder()
sendCommandRequest
- A Consumer
that will call methods on SendCommandRequest.Builder
to create a request.DuplicateInstanceIdException
- You cannot specify an instance ID in more than one association.InternalServerErrorException
- An error occurred on the server side.InvalidInstanceIdException
- The following problems can cause this exception:
You do not have permission to access the instance.
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.
InvalidDocumentException
- The specified document does not exist.InvalidDocumentVersionException
- The document version is not valid or does not exist.InvalidOutputFolderException
- The S3 bucket does not exist.InvalidParametersException
- You must specify values for all required parameters in the Systems Manager document. You can only supply
values to parameters defined in the Systems Manager document.UnsupportedPlatformTypeException
- The document does not support the platform type of the given instance ID(s). For example, you sent an
document for a Windows instance to a Linux instance.MaxDocumentSizeExceededException
- The size limit of a document is 64 KB.InvalidRoleException
- The role name can't contain invalid characters. Also verify that you specified an IAM role for
notifications that includes the required trust policy. For information about configuring the IAM role for
Run Command notifications, see Configuring
Amazon SNS Notifications for Run Command in the AWS Systems Manager User Guide.InvalidNotificationConfigException
- One or more configuration items is not valid. Verify that a valid Amazon Resource Name (ARN) was provided
for an Amazon SNS topic.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 StartAssociationsOnceResponse startAssociationsOnce(StartAssociationsOnceRequest startAssociationsOnceRequest) throws InvalidAssociationException, AssociationDoesNotExistException, AwsServiceException, SdkClientException, SsmException
Use this API action to run an association immediately and only one time. This action can be helpful when troubleshooting associations.
startAssociationsOnceRequest
- InvalidAssociationException
- The association is not valid or does not exist.AssociationDoesNotExistException
- The specified association 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 StartAssociationsOnceResponse startAssociationsOnce(Consumer<StartAssociationsOnceRequest.Builder> startAssociationsOnceRequest) throws InvalidAssociationException, AssociationDoesNotExistException, AwsServiceException, SdkClientException, SsmException
Use this API action to run an association immediately and only one time. This action can be helpful when troubleshooting associations.
This is a convenience which creates an instance of the StartAssociationsOnceRequest.Builder
avoiding the
need to create one manually via StartAssociationsOnceRequest.builder()
startAssociationsOnceRequest
- A Consumer
that will call methods on StartAssociationsOnceRequest.Builder
to create a
request.InvalidAssociationException
- The association is not valid or does not exist.AssociationDoesNotExistException
- The specified association 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 StartAutomationExecutionResponse startAutomationExecution(StartAutomationExecutionRequest startAutomationExecutionRequest) throws AutomationDefinitionNotFoundException, InvalidAutomationExecutionParametersException, AutomationExecutionLimitExceededException, AutomationDefinitionVersionNotFoundException, IdempotentParameterMismatchException, InvalidTargetException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Initiates execution of an Automation document.
startAutomationExecutionRequest
- AutomationDefinitionNotFoundException
- An Automation document with the specified name could not be found.InvalidAutomationExecutionParametersException
- The supplied parameters for invoking the specified Automation document are incorrect. For example, they
may not match the set of parameters permitted for the specified Automation document.AutomationExecutionLimitExceededException
- The number of simultaneously running Automation executions exceeded the allowable limit.AutomationDefinitionVersionNotFoundException
- An Automation document with the specified name and version could not be found.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.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.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 StartAutomationExecutionResponse startAutomationExecution(Consumer<StartAutomationExecutionRequest.Builder> startAutomationExecutionRequest) throws AutomationDefinitionNotFoundException, InvalidAutomationExecutionParametersException, AutomationExecutionLimitExceededException, AutomationDefinitionVersionNotFoundException, IdempotentParameterMismatchException, InvalidTargetException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Initiates execution of an Automation document.
This is a convenience which creates an instance of the StartAutomationExecutionRequest.Builder
avoiding
the need to create one manually via StartAutomationExecutionRequest.builder()
startAutomationExecutionRequest
- A Consumer
that will call methods on StartAutomationExecutionRequest.Builder
to create a
request.AutomationDefinitionNotFoundException
- An Automation document with the specified name could not be found.InvalidAutomationExecutionParametersException
- The supplied parameters for invoking the specified Automation document are incorrect. For example, they
may not match the set of parameters permitted for the specified Automation document.AutomationExecutionLimitExceededException
- The number of simultaneously running Automation executions exceeded the allowable limit.AutomationDefinitionVersionNotFoundException
- An Automation document with the specified name and version could not be found.IdempotentParameterMismatchException
- Error returned when an idempotent operation is retried and the parameters don't match the original call
to the API with the same idempotency token.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.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 StartSessionResponse startSession(StartSessionRequest startSessionRequest) throws InvalidDocumentException, TargetNotConnectedException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Initiates a connection to a target (for example, an instance) for a Session Manager session. Returns a URL and token that can be used to open a WebSocket connection for sending input and receiving outputs.
AWS CLI usage: start-session
is an interactive command that requires the Session Manager plugin to
be installed on the client machine making the call. For information, see Install the Session Manager plugin for the AWS CLI in the AWS Systems Manager User Guide.
AWS Tools for PowerShell usage: Start-SSMSession is not currently supported by AWS Tools for PowerShell on Windows local machines.
startSessionRequest
- InvalidDocumentException
- The specified document does not exist.TargetNotConnectedException
- The specified target instance for the session is not fully configured for use with Session Manager. For
more information, see Getting started with Session Manager in the AWS Systems Manager User Guide.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 StartSessionResponse startSession(Consumer<StartSessionRequest.Builder> startSessionRequest) throws InvalidDocumentException, TargetNotConnectedException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Initiates a connection to a target (for example, an instance) for a Session Manager session. Returns a URL and token that can be used to open a WebSocket connection for sending input and receiving outputs.
AWS CLI usage: start-session
is an interactive command that requires the Session Manager plugin to
be installed on the client machine making the call. For information, see Install the Session Manager plugin for the AWS CLI in the AWS Systems Manager User Guide.
AWS Tools for PowerShell usage: Start-SSMSession is not currently supported by AWS Tools for PowerShell on Windows local machines.
This is a convenience which creates an instance of the StartSessionRequest.Builder
avoiding the need to
create one manually via StartSessionRequest.builder()
startSessionRequest
- A Consumer
that will call methods on StartSessionRequest.Builder
to create a request.InvalidDocumentException
- The specified document does not exist.TargetNotConnectedException
- The specified target instance for the session is not fully configured for use with Session Manager. For
more information, see Getting started with Session Manager in the AWS Systems Manager User Guide.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 StopAutomationExecutionResponse stopAutomationExecution(StopAutomationExecutionRequest stopAutomationExecutionRequest) throws AutomationExecutionNotFoundException, InvalidAutomationStatusUpdateException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Stop an Automation that is currently running.
stopAutomationExecutionRequest
- AutomationExecutionNotFoundException
- There is no automation execution information for the requested automation execution ID.InvalidAutomationStatusUpdateException
- The specified update status operation 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 StopAutomationExecutionResponse stopAutomationExecution(Consumer<StopAutomationExecutionRequest.Builder> stopAutomationExecutionRequest) throws AutomationExecutionNotFoundException, InvalidAutomationStatusUpdateException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Stop an Automation that is currently running.
This is a convenience which creates an instance of the StopAutomationExecutionRequest.Builder
avoiding
the need to create one manually via StopAutomationExecutionRequest.builder()
stopAutomationExecutionRequest
- A Consumer
that will call methods on StopAutomationExecutionRequest.Builder
to create a
request.AutomationExecutionNotFoundException
- There is no automation execution information for the requested automation execution ID.InvalidAutomationStatusUpdateException
- The specified update status operation 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 TerminateSessionResponse terminateSession(TerminateSessionRequest terminateSessionRequest) throws DoesNotExistException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Permanently ends a session and closes the data connection between the Session Manager client and SSM Agent on the instance. A terminated session cannot be resumed.
terminateSessionRequest
- 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 TerminateSessionResponse terminateSession(Consumer<TerminateSessionRequest.Builder> terminateSessionRequest) throws DoesNotExistException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Permanently ends a session and closes the data connection between the Session Manager client and SSM Agent on the instance. A terminated session cannot be resumed.
This is a convenience which creates an instance of the TerminateSessionRequest.Builder
avoiding the need
to create one manually via TerminateSessionRequest.builder()
terminateSessionRequest
- A Consumer
that will call methods on TerminateSessionRequest.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 UpdateAssociationResponse updateAssociation(UpdateAssociationRequest updateAssociationRequest) throws InternalServerErrorException, InvalidScheduleException, InvalidParametersException, InvalidOutputLocationException, InvalidDocumentVersionException, AssociationDoesNotExistException, InvalidUpdateException, TooManyUpdatesException, InvalidDocumentException, InvalidTargetException, InvalidAssociationVersionException, AssociationVersionLimitExceededException, AwsServiceException, SdkClientException, SsmException
Updates an association. You can update the association name and version, the document version, schedule, parameters, and Amazon S3 output.
In order to call this API action, your IAM user account, group, or role must be configured with permission to
call the DescribeAssociation API action. If you don't have permission to call DescribeAssociation, then
you receive the following error:
An error occurred (AccessDeniedException) when calling the UpdateAssociation operation: User: <user_arn> is not authorized to perform: ssm:DescribeAssociation on resource: <resource_arn>
When you update an association, the association immediately runs against the specified targets.
updateAssociationRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidScheduleException
- The schedule is invalid. Verify your cron or rate expression and try again.InvalidParametersException
- You must specify values for all required parameters in the Systems Manager document. You can only supply
values to parameters defined in the Systems Manager document.InvalidOutputLocationException
- The output location is not valid or does not exist.InvalidDocumentVersionException
- The document version is not valid or does not exist.AssociationDoesNotExistException
- The specified association does not exist.InvalidUpdateException
- The update is not valid.TooManyUpdatesException
- There are concurrent updates for a resource that supports one update at a time.InvalidDocumentException
- The specified document does not exist.InvalidTargetException
- The target is not valid or does not exist. It might not be configured for Systems Manager or you might
not have permission to perform the operation.InvalidAssociationVersionException
- The version you specified is not valid. Use ListAssociationVersions to view all versions of an
association according to the association ID. Or, use the $LATEST
parameter to view the
latest version of the association.AssociationVersionLimitExceededException
- You have reached the maximum number versions allowed for an association. Each association has a limit of
1,000 versions.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 UpdateAssociationResponse updateAssociation(Consumer<UpdateAssociationRequest.Builder> updateAssociationRequest) throws InternalServerErrorException, InvalidScheduleException, InvalidParametersException, InvalidOutputLocationException, InvalidDocumentVersionException, AssociationDoesNotExistException, InvalidUpdateException, TooManyUpdatesException, InvalidDocumentException, InvalidTargetException, InvalidAssociationVersionException, AssociationVersionLimitExceededException, AwsServiceException, SdkClientException, SsmException
Updates an association. You can update the association name and version, the document version, schedule, parameters, and Amazon S3 output.
In order to call this API action, your IAM user account, group, or role must be configured with permission to
call the DescribeAssociation API action. If you don't have permission to call DescribeAssociation, then
you receive the following error:
An error occurred (AccessDeniedException) when calling the UpdateAssociation operation: User: <user_arn> is not authorized to perform: ssm:DescribeAssociation on resource: <resource_arn>
When you update an association, the association immediately runs against the specified targets.
This is a convenience which creates an instance of the UpdateAssociationRequest.Builder
avoiding the need
to create one manually via UpdateAssociationRequest.builder()
updateAssociationRequest
- A Consumer
that will call methods on UpdateAssociationRequest.Builder
to create a request.InternalServerErrorException
- An error occurred on the server side.InvalidScheduleException
- The schedule is invalid. Verify your cron or rate expression and try again.InvalidParametersException
- You must specify values for all required parameters in the Systems Manager document. You can only supply
values to parameters defined in the Systems Manager document.InvalidOutputLocationException
- The output location is not valid or does not exist.InvalidDocumentVersionException
- The document version is not valid or does not exist.AssociationDoesNotExistException
- The specified association does not exist.InvalidUpdateException
- The update is not valid.TooManyUpdatesException
- There are concurrent updates for a resource that supports one update at a time.InvalidDocumentException
- The specified document does not exist.InvalidTargetException
- The target is not valid or does not exist. It might not be configured for Systems Manager or you might
not have permission to perform the operation.InvalidAssociationVersionException
- The version you specified is not valid. Use ListAssociationVersions to view all versions of an
association according to the association ID. Or, use the $LATEST
parameter to view the
latest version of the association.AssociationVersionLimitExceededException
- You have reached the maximum number versions allowed for an association. Each association has a limit of
1,000 versions.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 UpdateAssociationStatusResponse updateAssociationStatus(UpdateAssociationStatusRequest updateAssociationStatusRequest) throws InternalServerErrorException, InvalidInstanceIdException, InvalidDocumentException, AssociationDoesNotExistException, StatusUnchangedException, TooManyUpdatesException, AwsServiceException, SdkClientException, SsmException
Updates the status of the Systems Manager document associated with the specified instance.
updateAssociationStatusRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidInstanceIdException
- The following problems can cause this exception:
You do not have permission to access the instance.
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.
InvalidDocumentException
- The specified document does not exist.AssociationDoesNotExistException
- The specified association does not exist.StatusUnchangedException
- The updated status is the same as the current status.TooManyUpdatesException
- There are concurrent updates for a resource that supports one update at a time.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 UpdateAssociationStatusResponse updateAssociationStatus(Consumer<UpdateAssociationStatusRequest.Builder> updateAssociationStatusRequest) throws InternalServerErrorException, InvalidInstanceIdException, InvalidDocumentException, AssociationDoesNotExistException, StatusUnchangedException, TooManyUpdatesException, AwsServiceException, SdkClientException, SsmException
Updates the status of the Systems Manager document associated with the specified instance.
This is a convenience which creates an instance of the UpdateAssociationStatusRequest.Builder
avoiding
the need to create one manually via UpdateAssociationStatusRequest.builder()
updateAssociationStatusRequest
- A Consumer
that will call methods on UpdateAssociationStatusRequest.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.
InvalidDocumentException
- The specified document does not exist.AssociationDoesNotExistException
- The specified association does not exist.StatusUnchangedException
- The updated status is the same as the current status.TooManyUpdatesException
- There are concurrent updates for a resource that supports one update at a time.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 UpdateDocumentResponse updateDocument(UpdateDocumentRequest updateDocumentRequest) throws MaxDocumentSizeExceededException, DocumentVersionLimitExceededException, InternalServerErrorException, DuplicateDocumentContentException, DuplicateDocumentVersionNameException, InvalidDocumentContentException, InvalidDocumentVersionException, InvalidDocumentSchemaVersionException, InvalidDocumentException, InvalidDocumentOperationException, AwsServiceException, SdkClientException, SsmException
Updates one or more values for an SSM document.
updateDocumentRequest
- MaxDocumentSizeExceededException
- The size limit of a document is 64 KB.DocumentVersionLimitExceededException
- The document has too many versions. Delete one or more document versions and try again.InternalServerErrorException
- An error occurred on the server side.DuplicateDocumentContentException
- The content of the association document matches another document. Change the content of the document and
try again.DuplicateDocumentVersionNameException
- The version name has already been used in this document. Specify a different version name, and then try
again.InvalidDocumentContentException
- The content for the document is not valid.InvalidDocumentVersionException
- The document version is not valid or does not exist.InvalidDocumentSchemaVersionException
- The version of the document schema is not supported.InvalidDocumentException
- The specified document does not exist.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 UpdateDocumentResponse updateDocument(Consumer<UpdateDocumentRequest.Builder> updateDocumentRequest) throws MaxDocumentSizeExceededException, DocumentVersionLimitExceededException, InternalServerErrorException, DuplicateDocumentContentException, DuplicateDocumentVersionNameException, InvalidDocumentContentException, InvalidDocumentVersionException, InvalidDocumentSchemaVersionException, InvalidDocumentException, InvalidDocumentOperationException, AwsServiceException, SdkClientException, SsmException
Updates one or more values for an SSM document.
This is a convenience which creates an instance of the UpdateDocumentRequest.Builder
avoiding the need to
create one manually via UpdateDocumentRequest.builder()
updateDocumentRequest
- A Consumer
that will call methods on UpdateDocumentRequest.Builder
to create a request.MaxDocumentSizeExceededException
- The size limit of a document is 64 KB.DocumentVersionLimitExceededException
- The document has too many versions. Delete one or more document versions and try again.InternalServerErrorException
- An error occurred on the server side.DuplicateDocumentContentException
- The content of the association document matches another document. Change the content of the document and
try again.DuplicateDocumentVersionNameException
- The version name has already been used in this document. Specify a different version name, and then try
again.InvalidDocumentContentException
- The content for the document is not valid.InvalidDocumentVersionException
- The document version is not valid or does not exist.InvalidDocumentSchemaVersionException
- The version of the document schema is not supported.InvalidDocumentException
- The specified document does not exist.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 UpdateDocumentDefaultVersionResponse updateDocumentDefaultVersion(UpdateDocumentDefaultVersionRequest updateDocumentDefaultVersionRequest) throws InternalServerErrorException, InvalidDocumentException, InvalidDocumentVersionException, InvalidDocumentSchemaVersionException, AwsServiceException, SdkClientException, SsmException
Set the default version of a document.
updateDocumentDefaultVersionRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidDocumentException
- The specified document does not exist.InvalidDocumentVersionException
- The document version is not valid or does not exist.InvalidDocumentSchemaVersionException
- The version of the document schema is not supported.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 UpdateDocumentDefaultVersionResponse updateDocumentDefaultVersion(Consumer<UpdateDocumentDefaultVersionRequest.Builder> updateDocumentDefaultVersionRequest) throws InternalServerErrorException, InvalidDocumentException, InvalidDocumentVersionException, InvalidDocumentSchemaVersionException, AwsServiceException, SdkClientException, SsmException
Set the default version of a document.
This is a convenience which creates an instance of the UpdateDocumentDefaultVersionRequest.Builder
avoiding the need to create one manually via UpdateDocumentDefaultVersionRequest.builder()
updateDocumentDefaultVersionRequest
- A Consumer
that will call methods on UpdateDocumentDefaultVersionRequest.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.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 UpdateMaintenanceWindowResponse updateMaintenanceWindow(UpdateMaintenanceWindowRequest updateMaintenanceWindowRequest) throws DoesNotExistException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Updates an existing maintenance window. Only specified parameters are modified.
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.
updateMaintenanceWindowRequest
- 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 UpdateMaintenanceWindowResponse updateMaintenanceWindow(Consumer<UpdateMaintenanceWindowRequest.Builder> updateMaintenanceWindowRequest) throws DoesNotExistException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Updates an existing maintenance window. Only specified parameters are modified.
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 UpdateMaintenanceWindowRequest.Builder
avoiding
the need to create one manually via UpdateMaintenanceWindowRequest.builder()
updateMaintenanceWindowRequest
- A Consumer
that will call methods on UpdateMaintenanceWindowRequest.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 UpdateMaintenanceWindowTargetResponse updateMaintenanceWindowTarget(UpdateMaintenanceWindowTargetRequest updateMaintenanceWindowTargetRequest) throws DoesNotExistException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Modifies the target of an existing maintenance window. You can change the following:
Name
Description
Owner
IDs for an ID target
Tags for a Tag target
From any supported tag type to another. The three supported tag types are ID target, Tag target, and resource group. For more information, see Target.
If a parameter is null, then the corresponding field is not modified.
updateMaintenanceWindowTargetRequest
- 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 UpdateMaintenanceWindowTargetResponse updateMaintenanceWindowTarget(Consumer<UpdateMaintenanceWindowTargetRequest.Builder> updateMaintenanceWindowTargetRequest) throws DoesNotExistException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Modifies the target of an existing maintenance window. You can change the following:
Name
Description
Owner
IDs for an ID target
Tags for a Tag target
From any supported tag type to another. The three supported tag types are ID target, Tag target, and resource group. For more information, see Target.
If a parameter is null, then the corresponding field is not modified.
This is a convenience which creates an instance of the UpdateMaintenanceWindowTargetRequest.Builder
avoiding the need to create one manually via UpdateMaintenanceWindowTargetRequest.builder()
updateMaintenanceWindowTargetRequest
- A Consumer
that will call methods on UpdateMaintenanceWindowTargetRequest.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 UpdateMaintenanceWindowTaskResponse updateMaintenanceWindowTask(UpdateMaintenanceWindowTaskRequest updateMaintenanceWindowTaskRequest) throws DoesNotExistException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Modifies a task assigned to a maintenance window. You can't change the task type, but you can change the following values:
TaskARN. For example, you can change a RUN_COMMAND task from AWS-RunPowerShellScript to AWS-RunShellScript.
ServiceRoleArn
TaskInvocationParameters
Priority
MaxConcurrency
MaxErrors
If a parameter is null, then the corresponding field is not modified. Also, if you set Replace to true, then all fields required by the RegisterTaskWithMaintenanceWindow action are required for this request. Optional fields that aren't specified are set to null.
updateMaintenanceWindowTaskRequest
- DoesNotExistException
- Error returned when the ID specified for a resource, 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 UpdateMaintenanceWindowTaskResponse updateMaintenanceWindowTask(Consumer<UpdateMaintenanceWindowTaskRequest.Builder> updateMaintenanceWindowTaskRequest) throws DoesNotExistException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Modifies a task assigned to a maintenance window. You can't change the task type, but you can change the following values:
TaskARN. For example, you can change a RUN_COMMAND task from AWS-RunPowerShellScript to AWS-RunShellScript.
ServiceRoleArn
TaskInvocationParameters
Priority
MaxConcurrency
MaxErrors
If a parameter is null, then the corresponding field is not modified. Also, if you set Replace to true, then all fields required by the RegisterTaskWithMaintenanceWindow action are required for this request. Optional fields that aren't specified are set to null.
This is a convenience which creates an instance of the UpdateMaintenanceWindowTaskRequest.Builder
avoiding the need to create one manually via UpdateMaintenanceWindowTaskRequest.builder()
updateMaintenanceWindowTaskRequest
- A Consumer
that will call methods on UpdateMaintenanceWindowTaskRequest.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 UpdateManagedInstanceRoleResponse updateManagedInstanceRole(UpdateManagedInstanceRoleRequest updateManagedInstanceRoleRequest) throws InvalidInstanceIdException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Changes the Amazon Identity and Access Management (IAM) role that is assigned to the on-premises instance or virtual machines (VM). IAM roles are first assigned to these hybrid instances during the activation process. For more information, see CreateActivation.
updateManagedInstanceRoleRequest
- 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 UpdateManagedInstanceRoleResponse updateManagedInstanceRole(Consumer<UpdateManagedInstanceRoleRequest.Builder> updateManagedInstanceRoleRequest) throws InvalidInstanceIdException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Changes the Amazon Identity and Access Management (IAM) role that is assigned to the on-premises instance or virtual machines (VM). IAM roles are first assigned to these hybrid instances during the activation process. For more information, see CreateActivation.
This is a convenience which creates an instance of the UpdateManagedInstanceRoleRequest.Builder
avoiding
the need to create one manually via UpdateManagedInstanceRoleRequest.builder()
updateManagedInstanceRoleRequest
- A Consumer
that will call methods on UpdateManagedInstanceRoleRequest.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 UpdateOpsItemResponse updateOpsItem(UpdateOpsItemRequest updateOpsItemRequest) throws InternalServerErrorException, OpsItemNotFoundException, OpsItemAlreadyExistsException, OpsItemLimitExceededException, OpsItemInvalidParameterException, AwsServiceException, SdkClientException, SsmException
Edit or change an OpsItem. You must have permission in AWS Identity and Access Management (IAM) to update an 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.
updateOpsItemRequest
- InternalServerErrorException
- An error occurred on the server side.OpsItemNotFoundException
- The specified OpsItem ID doesn't exist. Verify the ID and try again.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 UpdateOpsItemResponse updateOpsItem(Consumer<UpdateOpsItemRequest.Builder> updateOpsItemRequest) throws InternalServerErrorException, OpsItemNotFoundException, OpsItemAlreadyExistsException, OpsItemLimitExceededException, OpsItemInvalidParameterException, AwsServiceException, SdkClientException, SsmException
Edit or change an OpsItem. You must have permission in AWS Identity and Access Management (IAM) to update an 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 UpdateOpsItemRequest.Builder
avoiding the need to
create one manually via UpdateOpsItemRequest.builder()
updateOpsItemRequest
- A Consumer
that will call methods on UpdateOpsItemRequest.Builder
to create a request.InternalServerErrorException
- An error occurred on the server side.OpsItemNotFoundException
- The specified OpsItem ID doesn't exist. Verify the ID and try again.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 UpdatePatchBaselineResponse updatePatchBaseline(UpdatePatchBaselineRequest updatePatchBaselineRequest) throws DoesNotExistException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Modifies an existing patch baseline. Fields not specified in the request are left unchanged.
For information about valid key and value pairs in PatchFilters
for each supported operating system
type, see PatchFilter.
updatePatchBaselineRequest
- 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 UpdatePatchBaselineResponse updatePatchBaseline(Consumer<UpdatePatchBaselineRequest.Builder> updatePatchBaselineRequest) throws DoesNotExistException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Modifies an existing patch baseline. Fields not specified in the request are left unchanged.
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 UpdatePatchBaselineRequest.Builder
avoiding the
need to create one manually via UpdatePatchBaselineRequest.builder()
updatePatchBaselineRequest
- A Consumer
that will call methods on UpdatePatchBaselineRequest.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 UpdateResourceDataSyncResponse updateResourceDataSync(UpdateResourceDataSyncRequest updateResourceDataSyncRequest) throws ResourceDataSyncNotFoundException, ResourceDataSyncInvalidConfigurationException, ResourceDataSyncConflictException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Update a resource data sync. After you create a resource data sync for a Region, you can't change the account options for that sync. For example, if you create a sync in the us-east-2 (Ohio) Region and you choose the Include only the current account option, you can't edit that sync later and choose the Include all accounts from my AWS Organizations configuration option. Instead, you must delete the first resource data sync, and create a new one.
This API action only supports a resource data sync that was created with a SyncFromSource SyncType
.
updateResourceDataSyncRequest
- ResourceDataSyncNotFoundException
- The specified sync name was not found.ResourceDataSyncInvalidConfigurationException
- The specified sync configuration is invalid.ResourceDataSyncConflictException
- Another UpdateResourceDataSync
request is being processed. Wait a few minutes 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 UpdateResourceDataSyncResponse updateResourceDataSync(Consumer<UpdateResourceDataSyncRequest.Builder> updateResourceDataSyncRequest) throws ResourceDataSyncNotFoundException, ResourceDataSyncInvalidConfigurationException, ResourceDataSyncConflictException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Update a resource data sync. After you create a resource data sync for a Region, you can't change the account options for that sync. For example, if you create a sync in the us-east-2 (Ohio) Region and you choose the Include only the current account option, you can't edit that sync later and choose the Include all accounts from my AWS Organizations configuration option. Instead, you must delete the first resource data sync, and create a new one.
This API action only supports a resource data sync that was created with a SyncFromSource SyncType
.
This is a convenience which creates an instance of the UpdateResourceDataSyncRequest.Builder
avoiding the
need to create one manually via UpdateResourceDataSyncRequest.builder()
updateResourceDataSyncRequest
- A Consumer
that will call methods on UpdateResourceDataSyncRequest.Builder
to create a
request.ResourceDataSyncNotFoundException
- The specified sync name was not found.ResourceDataSyncInvalidConfigurationException
- The specified sync configuration is invalid.ResourceDataSyncConflictException
- Another UpdateResourceDataSync
request is being processed. Wait a few minutes 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 UpdateServiceSettingResponse updateServiceSetting(UpdateServiceSettingRequest updateServiceSettingRequest) throws InternalServerErrorException, ServiceSettingNotFoundException, TooManyUpdatesException, AwsServiceException, SdkClientException, SsmException
ServiceSetting
is an account-level setting for an AWS service. This setting defines how a user
interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the
account based on feature or service usage, then the AWS service team might create a default setting of "false".
This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for
a paid feature.
Services map a SettingId
object to a setting value. AWS services teams define the default value for
a SettingId
. You can't create a new SettingId
, but you can overwrite the default value
if you have the ssm:UpdateServiceSetting
permission for the setting. Use the
GetServiceSetting API action to view the current value. Or, use the ResetServiceSetting to change
the value back to the original value defined by the AWS service team.
Update the service setting for the account.
updateServiceSettingRequest
- The request body of the UpdateServiceSetting API action.InternalServerErrorException
- An error occurred on the server side.ServiceSettingNotFoundException
- The specified service setting was not found. Either the service name or the setting has not been
provisioned by the AWS service team.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 UpdateServiceSettingResponse updateServiceSetting(Consumer<UpdateServiceSettingRequest.Builder> updateServiceSettingRequest) throws InternalServerErrorException, ServiceSettingNotFoundException, TooManyUpdatesException, AwsServiceException, SdkClientException, SsmException
ServiceSetting
is an account-level setting for an AWS service. This setting defines how a user
interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the
account based on feature or service usage, then the AWS service team might create a default setting of "false".
This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for
a paid feature.
Services map a SettingId
object to a setting value. AWS services teams define the default value for
a SettingId
. You can't create a new SettingId
, but you can overwrite the default value
if you have the ssm:UpdateServiceSetting
permission for the setting. Use the
GetServiceSetting API action to view the current value. Or, use the ResetServiceSetting to change
the value back to the original value defined by the AWS service team.
Update the service setting for the account.
This is a convenience which creates an instance of the UpdateServiceSettingRequest.Builder
avoiding the
need to create one manually via UpdateServiceSettingRequest.builder()
updateServiceSettingRequest
- A Consumer
that will call methods on UpdateServiceSettingRequest.Builder
to create a
request. The request body of the UpdateServiceSetting API action.InternalServerErrorException
- An error occurred on the server side.ServiceSettingNotFoundException
- The specified service setting was not found. Either the service name or the setting has not been
provisioned by the AWS service team.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
static ServiceMetadata serviceMetadata()
Copyright © 2020. All rights reserved.