Interface SsmClient
-
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface SsmClient extends AwsClient
Service client for accessing Amazon SSM. This can be created using the staticbuilder()
method.Amazon Web Services Systems Manager is the operations hub for your Amazon Web Services applications and resources and a secure end-to-end management solution for hybrid cloud environments that enables safe and secure operations at scale.
This reference is intended to be used with the Amazon Web Services Systems Manager User Guide. To get started, see Setting up Amazon Web Services Systems Manager.
Related resources
-
For information about each of the capabilities that comprise Systems Manager, see Systems Manager capabilities in the Amazon Web Services Systems Manager User Guide.
-
For details about predefined runbooks for Automation, a capability of Amazon Web Services Systems Manager, see the Systems Manager Automation runbook reference .
-
For information about AppConfig, a capability of Systems Manager, see the AppConfig User Guide and the AppConfig API Reference .
-
For information about Incident Manager, a capability of Systems Manager, see the Systems Manager Incident Manager User Guide and the Systems Manager Incident Manager API Reference .
-
-
Field Summary
Fields Modifier and Type Field Description static String
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.static String
SERVICE_NAME
-
Method Summary
All Methods Static Methods Instance Methods Default Methods Modifier and Type Method Description default AddTagsToResourceResponse
addTagsToResource(Consumer<AddTagsToResourceRequest.Builder> addTagsToResourceRequest)
Adds or overwrites one or more tags for the specified resource.default AddTagsToResourceResponse
addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest)
Adds or overwrites one or more tags for the specified resource.default AssociateOpsItemRelatedItemResponse
associateOpsItemRelatedItem(Consumer<AssociateOpsItemRelatedItemRequest.Builder> associateOpsItemRelatedItemRequest)
Associates a related item to a Systems Manager OpsCenter OpsItem.default AssociateOpsItemRelatedItemResponse
associateOpsItemRelatedItem(AssociateOpsItemRelatedItemRequest associateOpsItemRelatedItemRequest)
Associates a related item to a Systems Manager OpsCenter OpsItem.static SsmClientBuilder
builder()
Create a builder that can be used to configure and create aSsmClient
.default CancelCommandResponse
cancelCommand(Consumer<CancelCommandRequest.Builder> cancelCommandRequest)
Attempts to cancel the command specified by the Command ID.default CancelCommandResponse
cancelCommand(CancelCommandRequest cancelCommandRequest)
Attempts to cancel the command specified by the Command ID.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 haven't already starting running.default CancelMaintenanceWindowExecutionResponse
cancelMaintenanceWindowExecution(CancelMaintenanceWindowExecutionRequest cancelMaintenanceWindowExecutionRequest)
Stops a maintenance window execution that is already in progress and cancels any tasks in the window that haven't already starting running.static SsmClient
create()
Create aSsmClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CreateActivationResponse
createActivation(Consumer<CreateActivationRequest.Builder> createActivationRequest)
Generates an activation code and activation ID you can use to register your on-premises servers, edge devices, or virtual machine (VM) with Amazon Web Services Systems Manager.default CreateActivationResponse
createActivation(CreateActivationRequest createActivationRequest)
Generates an activation code and activation ID you can use to register your on-premises servers, edge devices, or virtual machine (VM) with Amazon Web Services Systems Manager.default CreateAssociationResponse
createAssociation(Consumer<CreateAssociationRequest.Builder> createAssociationRequest)
A State Manager association defines the state that you want to maintain on your managed nodes.default CreateAssociationResponse
createAssociation(CreateAssociationRequest createAssociationRequest)
A State Manager association defines the state that you want to maintain on your managed nodes.default CreateAssociationBatchResponse
createAssociationBatch(Consumer<CreateAssociationBatchRequest.Builder> createAssociationBatchRequest)
Associates the specified Amazon Web Services Systems Manager document (SSM document) with the specified managed nodes or targets.default CreateAssociationBatchResponse
createAssociationBatch(CreateAssociationBatchRequest createAssociationBatchRequest)
Associates the specified Amazon Web Services Systems Manager document (SSM document) with the specified managed nodes or targets.default CreateDocumentResponse
createDocument(Consumer<CreateDocumentRequest.Builder> createDocumentRequest)
Creates a Amazon Web Services Systems Manager (SSM document).default CreateDocumentResponse
createDocument(CreateDocumentRequest createDocumentRequest)
Creates a Amazon Web Services Systems Manager (SSM document).default CreateMaintenanceWindowResponse
createMaintenanceWindow(Consumer<CreateMaintenanceWindowRequest.Builder> createMaintenanceWindowRequest)
Creates a new maintenance window.default CreateMaintenanceWindowResponse
createMaintenanceWindow(CreateMaintenanceWindowRequest createMaintenanceWindowRequest)
Creates a new maintenance window.default CreateOpsItemResponse
createOpsItem(Consumer<CreateOpsItemRequest.Builder> createOpsItemRequest)
Creates a new OpsItem.default CreateOpsItemResponse
createOpsItem(CreateOpsItemRequest createOpsItemRequest)
Creates a new OpsItem.default CreateOpsMetadataResponse
createOpsMetadata(Consumer<CreateOpsMetadataRequest.Builder> createOpsMetadataRequest)
If you create a new application in Application Manager, Amazon Web Services Systems Manager calls this API operation to specify information about the new application, including the application type.default CreateOpsMetadataResponse
createOpsMetadata(CreateOpsMetadataRequest createOpsMetadataRequest)
If you create a new application in Application Manager, Amazon Web Services Systems Manager calls this API operation to specify information about the new application, including the application type.default CreatePatchBaselineResponse
createPatchBaseline(Consumer<CreatePatchBaselineRequest.Builder> createPatchBaselineRequest)
Creates a patch baseline.default CreatePatchBaselineResponse
createPatchBaseline(CreatePatchBaselineRequest createPatchBaselineRequest)
Creates a patch baseline.default CreateResourceDataSyncResponse
createResourceDataSync(Consumer<CreateResourceDataSyncRequest.Builder> createResourceDataSyncRequest)
A resource data sync helps you view data from multiple sources in a single location.default CreateResourceDataSyncResponse
createResourceDataSync(CreateResourceDataSyncRequest createResourceDataSyncRequest)
A resource data sync helps you view data from multiple sources in a single location.default DeleteActivationResponse
deleteActivation(Consumer<DeleteActivationRequest.Builder> deleteActivationRequest)
Deletes an activation.default DeleteActivationResponse
deleteActivation(DeleteActivationRequest deleteActivationRequest)
Deletes an activation.default DeleteAssociationResponse
deleteAssociation(Consumer<DeleteAssociationRequest.Builder> deleteAssociationRequest)
Disassociates the specified Amazon Web Services Systems Manager document (SSM document) from the specified managed node.default DeleteAssociationResponse
deleteAssociation(DeleteAssociationRequest deleteAssociationRequest)
Disassociates the specified Amazon Web Services Systems Manager document (SSM document) from the specified managed node.default DeleteDocumentResponse
deleteDocument(Consumer<DeleteDocumentRequest.Builder> deleteDocumentRequest)
Deletes the Amazon Web Services Systems Manager document (SSM document) and all managed node associations to the document.default DeleteDocumentResponse
deleteDocument(DeleteDocumentRequest deleteDocumentRequest)
Deletes the Amazon Web Services Systems Manager document (SSM document) and all managed node 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 DeleteOpsItemResponse
deleteOpsItem(Consumer<DeleteOpsItemRequest.Builder> deleteOpsItemRequest)
Delete an OpsItem.default DeleteOpsItemResponse
deleteOpsItem(DeleteOpsItemRequest deleteOpsItemRequest)
Delete an OpsItem.default DeleteOpsMetadataResponse
deleteOpsMetadata(Consumer<DeleteOpsMetadataRequest.Builder> deleteOpsMetadataRequest)
Delete OpsMetadata related to an application.default DeleteOpsMetadataResponse
deleteOpsMetadata(DeleteOpsMetadataRequest deleteOpsMetadataRequest)
Delete OpsMetadata related to an application.default DeleteParameterResponse
deleteParameter(Consumer<DeleteParameterRequest.Builder> deleteParameterRequest)
Delete a parameter from the system.default DeleteParameterResponse
deleteParameter(DeleteParameterRequest deleteParameterRequest)
Delete a parameter from the system.default DeleteParametersResponse
deleteParameters(Consumer<DeleteParametersRequest.Builder> deleteParametersRequest)
Delete a list of parameters.default DeleteParametersResponse
deleteParameters(DeleteParametersRequest deleteParametersRequest)
Delete a list of parameters.default DeletePatchBaselineResponse
deletePatchBaseline(Consumer<DeletePatchBaselineRequest.Builder> deletePatchBaselineRequest)
Deletes a patch baseline.default DeletePatchBaselineResponse
deletePatchBaseline(DeletePatchBaselineRequest deletePatchBaselineRequest)
Deletes a patch baseline.default DeleteResourceDataSyncResponse
deleteResourceDataSync(Consumer<DeleteResourceDataSyncRequest.Builder> deleteResourceDataSyncRequest)
Deletes a resource data sync configuration.default DeleteResourceDataSyncResponse
deleteResourceDataSync(DeleteResourceDataSyncRequest deleteResourceDataSyncRequest)
Deletes a resource data sync configuration.default DeleteResourcePolicyResponse
deleteResourcePolicy(Consumer<DeleteResourcePolicyRequest.Builder> deleteResourcePolicyRequest)
Deletes a Systems Manager resource policy.default DeleteResourcePolicyResponse
deleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest)
Deletes a Systems Manager resource policy.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 Identity and Access Management (IAM) role assigned to the managed nodes in the activation, and the number of nodes 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 Identity and Access Management (IAM) role assigned to the managed nodes in the activation, and the number of nodes 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 Identity and Access Management (IAM) role assigned to the managed nodes in the activation, and the number of nodes 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 Identity and Access Management (IAM) role assigned to the managed nodes in the activation, and the number of nodes 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 Identity and Access Management (IAM) role assigned to the managed nodes in the activation, and the number of nodes 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 Identity and Access Management (IAM) role assigned to the managed nodes in the activation, and the number of nodes registered by using this activation.default DescribeAssociationResponse
describeAssociation(Consumer<DescribeAssociationRequest.Builder> describeAssociationRequest)
Describes the association for the specified target or managed node.default DescribeAssociationResponse
describeAssociation(DescribeAssociationRequest describeAssociationRequest)
Describes the association for the specified target or managed node.default DescribeAssociationExecutionsResponse
describeAssociationExecutions(Consumer<DescribeAssociationExecutionsRequest.Builder> describeAssociationExecutionsRequest)
Views all executions for a specific association ID.default DescribeAssociationExecutionsResponse
describeAssociationExecutions(DescribeAssociationExecutionsRequest describeAssociationExecutionsRequest)
Views all executions for a specific association ID.default DescribeAssociationExecutionsIterable
describeAssociationExecutionsPaginator(Consumer<DescribeAssociationExecutionsRequest.Builder> describeAssociationExecutionsRequest)
Views all executions for a specific association ID.default DescribeAssociationExecutionsIterable
describeAssociationExecutionsPaginator(DescribeAssociationExecutionsRequest describeAssociationExecutionsRequest)
Views all executions for a specific association ID.default DescribeAssociationExecutionTargetsResponse
describeAssociationExecutionTargets(Consumer<DescribeAssociationExecutionTargetsRequest.Builder> describeAssociationExecutionTargetsRequest)
Views information about a specific execution of a specific association.default DescribeAssociationExecutionTargetsResponse
describeAssociationExecutionTargets(DescribeAssociationExecutionTargetsRequest describeAssociationExecutionTargetsRequest)
Views information about a specific execution of a specific association.default DescribeAssociationExecutionTargetsIterable
describeAssociationExecutionTargetsPaginator(Consumer<DescribeAssociationExecutionTargetsRequest.Builder> describeAssociationExecutionTargetsRequest)
Views information about a specific execution of a specific association.default DescribeAssociationExecutionTargetsIterable
describeAssociationExecutionTargetsPaginator(DescribeAssociationExecutionTargetsRequest describeAssociationExecutionTargetsRequest)
Views 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 Amazon Web Services Systems Manager document (SSM document).default DescribeDocumentResponse
describeDocument(DescribeDocumentRequest describeDocumentRequest)
Describes the specified Amazon Web Services Systems Manager document (SSM document).default DescribeDocumentPermissionResponse
describeDocumentPermission(Consumer<DescribeDocumentPermissionRequest.Builder> describeDocumentPermissionRequest)
Describes the permissions for a Amazon Web Services Systems Manager document (SSM document).default DescribeDocumentPermissionResponse
describeDocumentPermission(DescribeDocumentPermissionRequest describeDocumentPermissionRequest)
Describes the permissions for a Amazon Web Services Systems Manager document (SSM document).default DescribeEffectiveInstanceAssociationsResponse
describeEffectiveInstanceAssociations(Consumer<DescribeEffectiveInstanceAssociationsRequest.Builder> describeEffectiveInstanceAssociationsRequest)
All associations for the managed node(s).default DescribeEffectiveInstanceAssociationsResponse
describeEffectiveInstanceAssociations(DescribeEffectiveInstanceAssociationsRequest describeEffectiveInstanceAssociationsRequest)
All associations for the managed node(s).default DescribeEffectiveInstanceAssociationsIterable
describeEffectiveInstanceAssociationsPaginator(Consumer<DescribeEffectiveInstanceAssociationsRequest.Builder> describeEffectiveInstanceAssociationsRequest)
All associations for the managed node(s).default DescribeEffectiveInstanceAssociationsIterable
describeEffectiveInstanceAssociationsPaginator(DescribeEffectiveInstanceAssociationsRequest describeEffectiveInstanceAssociationsRequest)
All associations for the managed node(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 managed node(s).default DescribeInstanceAssociationsStatusResponse
describeInstanceAssociationsStatus(DescribeInstanceAssociationsStatusRequest describeInstanceAssociationsStatusRequest)
The status of the associations for the managed node(s).default DescribeInstanceAssociationsStatusIterable
describeInstanceAssociationsStatusPaginator(Consumer<DescribeInstanceAssociationsStatusRequest.Builder> describeInstanceAssociationsStatusRequest)
The status of the associations for the managed node(s).default DescribeInstanceAssociationsStatusIterable
describeInstanceAssociationsStatusPaginator(DescribeInstanceAssociationsStatusRequest describeInstanceAssociationsStatusRequest)
The status of the associations for the managed node(s).default DescribeInstanceInformationResponse
describeInstanceInformation()
Provides information about one or more of your managed nodes, including the operating system platform, SSM Agent version, association status, and IP address.default DescribeInstanceInformationResponse
describeInstanceInformation(Consumer<DescribeInstanceInformationRequest.Builder> describeInstanceInformationRequest)
Provides information about one or more of your managed nodes, including the operating system platform, SSM Agent version, association status, and IP address.default DescribeInstanceInformationResponse
describeInstanceInformation(DescribeInstanceInformationRequest describeInstanceInformationRequest)
Provides information about one or more of your managed nodes, including the operating system platform, SSM Agent version, association status, and IP address.default DescribeInstanceInformationIterable
describeInstanceInformationPaginator()
Provides information about one or more of your managed nodes, including the operating system platform, SSM Agent version, association status, and IP address.default DescribeInstanceInformationIterable
describeInstanceInformationPaginator(Consumer<DescribeInstanceInformationRequest.Builder> describeInstanceInformationRequest)
Provides information about one or more of your managed nodes, including the operating system platform, SSM Agent version, association status, and IP address.default DescribeInstanceInformationIterable
describeInstanceInformationPaginator(DescribeInstanceInformationRequest describeInstanceInformationRequest)
Provides information about one or more of your managed nodes, including the operating system platform, SSM Agent version, association status, and IP address.default DescribeInstancePatchesResponse
describeInstancePatches(Consumer<DescribeInstancePatchesRequest.Builder> describeInstancePatchesRequest)
Retrieves information about the patches on the specified managed node and their state relative to the patch baseline being used for the node.default DescribeInstancePatchesResponse
describeInstancePatches(DescribeInstancePatchesRequest describeInstancePatchesRequest)
Retrieves information about the patches on the specified managed node and their state relative to the patch baseline being used for the node.default DescribeInstancePatchesIterable
describeInstancePatchesPaginator(Consumer<DescribeInstancePatchesRequest.Builder> describeInstancePatchesRequest)
Retrieves information about the patches on the specified managed node and their state relative to the patch baseline being used for the node.default DescribeInstancePatchesIterable
describeInstancePatchesPaginator(DescribeInstancePatchesRequest describeInstancePatchesRequest)
Retrieves information about the patches on the specified managed node and their state relative to the patch baseline being used for the node.default DescribeInstancePatchStatesResponse
describeInstancePatchStates(Consumer<DescribeInstancePatchStatesRequest.Builder> describeInstancePatchStatesRequest)
Retrieves the high-level patch state of one or more managed nodes.default DescribeInstancePatchStatesResponse
describeInstancePatchStates(DescribeInstancePatchStatesRequest describeInstancePatchStatesRequest)
Retrieves the high-level patch state of one or more managed nodes.default DescribeInstancePatchStatesForPatchGroupResponse
describeInstancePatchStatesForPatchGroup(Consumer<DescribeInstancePatchStatesForPatchGroupRequest.Builder> describeInstancePatchStatesForPatchGroupRequest)
Retrieves the high-level patch state for the managed nodes in the specified patch group.default DescribeInstancePatchStatesForPatchGroupResponse
describeInstancePatchStatesForPatchGroup(DescribeInstancePatchStatesForPatchGroupRequest describeInstancePatchStatesForPatchGroupRequest)
Retrieves the high-level patch state for the managed nodes in the specified patch group.default DescribeInstancePatchStatesForPatchGroupIterable
describeInstancePatchStatesForPatchGroupPaginator(Consumer<DescribeInstancePatchStatesForPatchGroupRequest.Builder> describeInstancePatchStatesForPatchGroupRequest)
Retrieves the high-level patch state for the managed nodes in the specified patch group.default DescribeInstancePatchStatesForPatchGroupIterable
describeInstancePatchStatesForPatchGroupPaginator(DescribeInstancePatchStatesForPatchGroupRequest describeInstancePatchStatesForPatchGroupRequest)
Retrieves the high-level patch state for the managed nodes in the specified patch group.default DescribeInstancePatchStatesIterable
describeInstancePatchStatesPaginator(Consumer<DescribeInstancePatchStatesRequest.Builder> describeInstancePatchStatesRequest)
Retrieves the high-level patch state of one or more managed nodes.default DescribeInstancePatchStatesIterable
describeInstancePatchStatesPaginator(DescribeInstancePatchStatesRequest describeInstancePatchStatesRequest)
Retrieves the high-level patch state of one or more managed nodes.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 Amazon Web Services account.default DescribeMaintenanceWindowsResponse
describeMaintenanceWindows(Consumer<DescribeMaintenanceWindowsRequest.Builder> describeMaintenanceWindowsRequest)
Retrieves the maintenance windows in an Amazon Web Services account.default DescribeMaintenanceWindowsResponse
describeMaintenanceWindows(DescribeMaintenanceWindowsRequest describeMaintenanceWindowsRequest)
Retrieves the maintenance windows in an Amazon Web Services 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 a managed node is associated with.default DescribeMaintenanceWindowsForTargetResponse
describeMaintenanceWindowsForTarget(DescribeMaintenanceWindowsForTargetRequest describeMaintenanceWindowsForTargetRequest)
Retrieves information about the maintenance window targets or tasks that a managed node is associated with.default DescribeMaintenanceWindowsForTargetIterable
describeMaintenanceWindowsForTargetPaginator(Consumer<DescribeMaintenanceWindowsForTargetRequest.Builder> describeMaintenanceWindowsForTargetRequest)
Retrieves information about the maintenance window targets or tasks that a managed node is associated with.default DescribeMaintenanceWindowsForTargetIterable
describeMaintenanceWindowsForTargetPaginator(DescribeMaintenanceWindowsForTargetRequest describeMaintenanceWindowsForTargetRequest)
Retrieves information about the maintenance window targets or tasks that a managed node is associated with.default DescribeMaintenanceWindowsIterable
describeMaintenanceWindowsPaginator()
Retrieves the maintenance windows in an Amazon Web Services account.default DescribeMaintenanceWindowsIterable
describeMaintenanceWindowsPaginator(Consumer<DescribeMaintenanceWindowsRequest.Builder> describeMaintenanceWindowsRequest)
Retrieves the maintenance windows in an Amazon Web Services account.default DescribeMaintenanceWindowsIterable
describeMaintenanceWindowsPaginator(DescribeMaintenanceWindowsRequest describeMaintenanceWindowsRequest)
Retrieves the maintenance windows in an Amazon Web Services 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 Amazon Web Services account.default DescribePatchBaselinesResponse
describePatchBaselines(Consumer<DescribePatchBaselinesRequest.Builder> describePatchBaselinesRequest)
Lists the patch baselines in your Amazon Web Services account.default DescribePatchBaselinesResponse
describePatchBaselines(DescribePatchBaselinesRequest describePatchBaselinesRequest)
Lists the patch baselines in your Amazon Web Services account.default DescribePatchBaselinesIterable
describePatchBaselinesPaginator()
Lists the patch baselines in your Amazon Web Services account.default DescribePatchBaselinesIterable
describePatchBaselinesPaginator(Consumer<DescribePatchBaselinesRequest.Builder> describePatchBaselinesRequest)
Lists the patch baselines in your Amazon Web Services account.default DescribePatchBaselinesIterable
describePatchBaselinesPaginator(DescribePatchBaselinesRequest describePatchBaselinesRequest)
Lists the patch baselines in your Amazon Web Services 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 information for a patch group.default DescribePatchGroupStateResponse
describePatchGroupState(DescribePatchGroupStateRequest describePatchGroupStateRequest)
Returns high-level aggregated patch compliance state information 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 DisassociateOpsItemRelatedItemResponse
disassociateOpsItemRelatedItem(Consumer<DisassociateOpsItemRelatedItemRequest.Builder> disassociateOpsItemRelatedItemRequest)
Deletes the association between an OpsItem and a related item.default DisassociateOpsItemRelatedItemResponse
disassociateOpsItemRelatedItem(DisassociateOpsItemRelatedItemRequest disassociateOpsItemRelatedItemRequest)
Deletes the association between an OpsItem and a related item.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 a Amazon Web Services Systems Manager change calendar at the current time or a specified time.default GetCalendarStateResponse
getCalendarState(GetCalendarStateRequest getCalendarStateRequest)
Gets the state of a Amazon Web Services Systems Manager change calendar at the current time or a 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 a managed node 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 a managed node 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 managed node uses.default GetDeployablePatchSnapshotForInstanceResponse
getDeployablePatchSnapshotForInstance(GetDeployablePatchSnapshotForInstanceRequest getDeployablePatchSnapshotForInstanceRequest)
Retrieves the current snapshot for the patch baseline the managed node uses.default GetDocumentResponse
getDocument(Consumer<GetDocumentRequest.Builder> getDocumentRequest)
Gets the contents of the specified Amazon Web Services Systems Manager document (SSM document).default GetDocumentResponse
getDocument(GetDocumentRequest getDocumentRequest)
Gets the contents of the specified Amazon Web Services Systems Manager document (SSM 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)
Retrieves the details of a maintenance window task.default GetMaintenanceWindowTaskResponse
getMaintenanceWindowTask(GetMaintenanceWindowTaskRequest getMaintenanceWindowTaskRequest)
Retrieves the details of a maintenance window task.default GetOpsItemResponse
getOpsItem(Consumer<GetOpsItemRequest.Builder> getOpsItemRequest)
Get information about an OpsItem by using the ID.default GetOpsItemResponse
getOpsItem(GetOpsItemRequest getOpsItemRequest)
Get information about an OpsItem by using the ID.default GetOpsMetadataResponse
getOpsMetadata(Consumer<GetOpsMetadataRequest.Builder> getOpsMetadataRequest)
View operational metadata related to an application in Application Manager.default GetOpsMetadataResponse
getOpsMetadata(GetOpsMetadataRequest getOpsMetadataRequest)
View operational metadata related to an application in Application Manager.default GetOpsSummaryResponse
getOpsSummary(Consumer<GetOpsSummaryRequest.Builder> getOpsSummaryRequest)
View a summary of operations metadata (OpsData) based on specified filters and aggregators.default GetOpsSummaryResponse
getOpsSummary(GetOpsSummaryRequest getOpsSummaryRequest)
View a summary of operations metadata (OpsData) based on specified filters and aggregators.default GetOpsSummaryIterable
getOpsSummaryPaginator(Consumer<GetOpsSummaryRequest.Builder> getOpsSummaryRequest)
View a summary of operations metadata (OpsData) based on specified filters and aggregators.default GetOpsSummaryIterable
getOpsSummaryPaginator(GetOpsSummaryRequest getOpsSummaryRequest)
View a summary of operations metadata (OpsData) based on specified filters and aggregators.default GetParameterResponse
getParameter(Consumer<GetParameterRequest.Builder> getParameterRequest)
Get information about a single parameter by specifying the parameter name.default GetParameterResponse
getParameter(GetParameterRequest getParameterRequest)
Get information about a single parameter by specifying the parameter name.default GetParameterHistoryResponse
getParameterHistory(Consumer<GetParameterHistoryRequest.Builder> getParameterHistoryRequest)
Retrieves the history of all changes to a parameter.default GetParameterHistoryResponse
getParameterHistory(GetParameterHistoryRequest getParameterHistoryRequest)
Retrieves the history of all changes to a parameter.default GetParameterHistoryIterable
getParameterHistoryPaginator(Consumer<GetParameterHistoryRequest.Builder> getParameterHistoryRequest)
Retrieves the history of all changes to a parameter.default GetParameterHistoryIterable
getParameterHistoryPaginator(GetParameterHistoryRequest getParameterHistoryRequest)
Retrieves the history of all changes to a parameter.default GetParametersResponse
getParameters(Consumer<GetParametersRequest.Builder> getParametersRequest)
Get information about one or more parameters by specifying multiple parameter names.default GetParametersResponse
getParameters(GetParametersRequest getParametersRequest)
Get information about one or more parameters by specifying multiple parameter names.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 GetResourcePoliciesResponse
getResourcePolicies(Consumer<GetResourcePoliciesRequest.Builder> getResourcePoliciesRequest)
Returns an array of thePolicy
object.default GetResourcePoliciesResponse
getResourcePolicies(GetResourcePoliciesRequest getResourcePoliciesRequest)
Returns an array of thePolicy
object.default GetResourcePoliciesIterable
getResourcePoliciesPaginator(Consumer<GetResourcePoliciesRequest.Builder> getResourcePoliciesRequest)
Returns an array of thePolicy
object.default GetResourcePoliciesIterable
getResourcePoliciesPaginator(GetResourcePoliciesRequest getResourcePoliciesRequest)
Returns an array of thePolicy
object.default GetServiceSettingResponse
getServiceSetting(Consumer<GetServiceSettingRequest.Builder> getServiceSettingRequest)
ServiceSetting
is an account-level setting for an Amazon Web Services service.default GetServiceSettingResponse
getServiceSetting(GetServiceSettingRequest getServiceSettingRequest)
ServiceSetting
is an account-level setting for an Amazon Web Services 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 Amazon Web Services account and Amazon Web Services Region.default ListAssociationsResponse
listAssociations(Consumer<ListAssociationsRequest.Builder> listAssociationsRequest)
Returns all State Manager associations in the current Amazon Web Services account and Amazon Web Services Region.default ListAssociationsResponse
listAssociations(ListAssociationsRequest listAssociationsRequest)
Returns all State Manager associations in the current Amazon Web Services account and Amazon Web Services Region.default ListAssociationsIterable
listAssociationsPaginator()
Returns all State Manager associations in the current Amazon Web Services account and Amazon Web Services Region.default ListAssociationsIterable
listAssociationsPaginator(Consumer<ListAssociationsRequest.Builder> listAssociationsRequest)
Returns all State Manager associations in the current Amazon Web Services account and Amazon Web Services Region.default ListAssociationsIterable
listAssociationsPaginator(ListAssociationsRequest listAssociationsRequest)
Returns all State Manager associations in the current Amazon Web Services account and Amazon Web Services 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 managed node.default ListCommandInvocationsResponse
listCommandInvocations(Consumer<ListCommandInvocationsRequest.Builder> listCommandInvocationsRequest)
An invocation is copy of a command sent to a specific managed node.default ListCommandInvocationsResponse
listCommandInvocations(ListCommandInvocationsRequest listCommandInvocationsRequest)
An invocation is copy of a command sent to a specific managed node.default ListCommandInvocationsIterable
listCommandInvocationsPaginator()
An invocation is copy of a command sent to a specific managed node.default ListCommandInvocationsIterable
listCommandInvocationsPaginator(Consumer<ListCommandInvocationsRequest.Builder> listCommandInvocationsRequest)
An invocation is copy of a command sent to a specific managed node.default ListCommandInvocationsIterable
listCommandInvocationsPaginator(ListCommandInvocationsRequest listCommandInvocationsRequest)
An invocation is copy of a command sent to a specific managed node.default ListCommandsResponse
listCommands()
Lists the commands requested by users of the Amazon Web Services account.default ListCommandsResponse
listCommands(Consumer<ListCommandsRequest.Builder> listCommandsRequest)
Lists the commands requested by users of the Amazon Web Services account.default ListCommandsResponse
listCommands(ListCommandsRequest listCommandsRequest)
Lists the commands requested by users of the Amazon Web Services account.default ListCommandsIterable
listCommandsPaginator()
Lists the commands requested by users of the Amazon Web Services account.default ListCommandsIterable
listCommandsPaginator(Consumer<ListCommandsRequest.Builder> listCommandsRequest)
Lists the commands requested by users of the Amazon Web Services account.default ListCommandsIterable
listCommandsPaginator(ListCommandsRequest listCommandsRequest)
Lists the commands requested by users of the Amazon Web Services account.default ListComplianceItemsResponse
listComplianceItems(Consumer<ListComplianceItemsRequest.Builder> listComplianceItemsRequest)
For a specified resource ID, this API operation returns a list of compliance statuses for different resource types.default ListComplianceItemsResponse
listComplianceItems(ListComplianceItemsRequest listComplianceItemsRequest)
For a specified resource ID, this API operation returns a list of compliance statuses for different resource types.default ListComplianceItemsIterable
listComplianceItemsPaginator(Consumer<ListComplianceItemsRequest.Builder> listComplianceItemsRequest)
For a specified resource ID, this API operation returns a list of compliance statuses for different resource types.default ListComplianceItemsIterable
listComplianceItemsPaginator(ListComplianceItemsRequest listComplianceItemsRequest)
For a specified resource ID, this API operation returns a list of compliance statuses for different resource types.default ListComplianceSummariesResponse
listComplianceSummaries()
Returns a summary count of compliant and non-compliant resources for a compliance type.default ListComplianceSummariesResponse
listComplianceSummaries(Consumer<ListComplianceSummariesRequest.Builder> listComplianceSummariesRequest)
Returns a summary count of compliant and non-compliant resources for a compliance type.default ListComplianceSummariesResponse
listComplianceSummaries(ListComplianceSummariesRequest listComplianceSummariesRequest)
Returns a summary count of compliant and non-compliant resources for a compliance type.default ListComplianceSummariesIterable
listComplianceSummariesPaginator()
Returns a summary count of compliant and non-compliant resources for a compliance type.default ListComplianceSummariesIterable
listComplianceSummariesPaginator(Consumer<ListComplianceSummariesRequest.Builder> listComplianceSummariesRequest)
Returns a summary count of compliant and non-compliant resources for a compliance type.default ListComplianceSummariesIterable
listComplianceSummariesPaginator(ListComplianceSummariesRequest listComplianceSummariesRequest)
Returns a summary count of compliant and non-compliant resources for a compliance type.default ListDocumentMetadataHistoryResponse
listDocumentMetadataHistory(Consumer<ListDocumentMetadataHistoryRequest.Builder> listDocumentMetadataHistoryRequest)
Information about approval reviews for a version of a change template in Change Manager.default ListDocumentMetadataHistoryResponse
listDocumentMetadataHistory(ListDocumentMetadataHistoryRequest listDocumentMetadataHistoryRequest)
Information about approval reviews for a version of a change template in Change Manager.default ListDocumentsResponse
listDocuments()
Returns all Systems Manager (SSM) documents in the current Amazon Web Services account and Amazon Web Services Region.default ListDocumentsResponse
listDocuments(Consumer<ListDocumentsRequest.Builder> listDocumentsRequest)
Returns all Systems Manager (SSM) documents in the current Amazon Web Services account and Amazon Web Services Region.default ListDocumentsResponse
listDocuments(ListDocumentsRequest listDocumentsRequest)
Returns all Systems Manager (SSM) documents in the current Amazon Web Services account and Amazon Web Services Region.default ListDocumentsIterable
listDocumentsPaginator()
Returns all Systems Manager (SSM) documents in the current Amazon Web Services account and Amazon Web Services Region.default ListDocumentsIterable
listDocumentsPaginator(Consumer<ListDocumentsRequest.Builder> listDocumentsRequest)
Returns all Systems Manager (SSM) documents in the current Amazon Web Services account and Amazon Web Services Region.default ListDocumentsIterable
listDocumentsPaginator(ListDocumentsRequest listDocumentsRequest)
Returns all Systems Manager (SSM) documents in the current Amazon Web Services account and Amazon Web Services Region.default ListDocumentVersionsResponse
listDocumentVersions(Consumer<ListDocumentVersionsRequest.Builder> listDocumentVersionsRequest)
List all versions for a document.default ListDocumentVersionsResponse
listDocumentVersions(ListDocumentVersionsRequest listDocumentVersionsRequest)
List all versions for a document.default ListDocumentVersionsIterable
listDocumentVersionsPaginator(Consumer<ListDocumentVersionsRequest.Builder> listDocumentVersionsRequest)
List all versions for a document.default ListDocumentVersionsIterable
listDocumentVersionsPaginator(ListDocumentVersionsRequest listDocumentVersionsRequest)
List all versions for a document.default ListInventoryEntriesResponse
listInventoryEntries(Consumer<ListInventoryEntriesRequest.Builder> listInventoryEntriesRequest)
A list of inventory items returned by the request.default ListInventoryEntriesResponse
listInventoryEntries(ListInventoryEntriesRequest listInventoryEntriesRequest)
A list of inventory items returned by the request.default ListOpsItemEventsResponse
listOpsItemEvents(Consumer<ListOpsItemEventsRequest.Builder> listOpsItemEventsRequest)
Returns a list of all OpsItem events in the current Amazon Web Services Region and Amazon Web Services account.default ListOpsItemEventsResponse
listOpsItemEvents(ListOpsItemEventsRequest listOpsItemEventsRequest)
Returns a list of all OpsItem events in the current Amazon Web Services Region and Amazon Web Services account.default ListOpsItemEventsIterable
listOpsItemEventsPaginator(Consumer<ListOpsItemEventsRequest.Builder> listOpsItemEventsRequest)
Returns a list of all OpsItem events in the current Amazon Web Services Region and Amazon Web Services account.default ListOpsItemEventsIterable
listOpsItemEventsPaginator(ListOpsItemEventsRequest listOpsItemEventsRequest)
Returns a list of all OpsItem events in the current Amazon Web Services Region and Amazon Web Services account.default ListOpsItemRelatedItemsResponse
listOpsItemRelatedItems(Consumer<ListOpsItemRelatedItemsRequest.Builder> listOpsItemRelatedItemsRequest)
Lists all related-item resources associated with a Systems Manager OpsCenter OpsItem.default ListOpsItemRelatedItemsResponse
listOpsItemRelatedItems(ListOpsItemRelatedItemsRequest listOpsItemRelatedItemsRequest)
Lists all related-item resources associated with a Systems Manager OpsCenter OpsItem.default ListOpsItemRelatedItemsIterable
listOpsItemRelatedItemsPaginator(Consumer<ListOpsItemRelatedItemsRequest.Builder> listOpsItemRelatedItemsRequest)
Lists all related-item resources associated with a Systems Manager OpsCenter OpsItem.default ListOpsItemRelatedItemsIterable
listOpsItemRelatedItemsPaginator(ListOpsItemRelatedItemsRequest listOpsItemRelatedItemsRequest)
Lists all related-item resources associated with a Systems Manager OpsCenter OpsItem.default ListOpsMetadataResponse
listOpsMetadata(Consumer<ListOpsMetadataRequest.Builder> listOpsMetadataRequest)
Amazon Web Services Systems Manager calls this API operation when displaying all Application Manager OpsMetadata objects or blobs.default ListOpsMetadataResponse
listOpsMetadata(ListOpsMetadataRequest listOpsMetadataRequest)
Amazon Web Services Systems Manager calls this API operation when displaying all Application Manager OpsMetadata objects or blobs.default ListOpsMetadataIterable
listOpsMetadataPaginator(Consumer<ListOpsMetadataRequest.Builder> listOpsMetadataRequest)
Amazon Web Services Systems Manager calls this API operation when displaying all Application Manager OpsMetadata objects or blobs.default ListOpsMetadataIterable
listOpsMetadataPaginator(ListOpsMetadataRequest listOpsMetadataRequest)
Amazon Web Services Systems Manager calls this API operation when displaying all Application Manager OpsMetadata objects or blobs.default ListResourceComplianceSummariesResponse
listResourceComplianceSummaries()
Returns a resource-level summary count.default ListResourceComplianceSummariesResponse
listResourceComplianceSummaries(Consumer<ListResourceComplianceSummariesRequest.Builder> listResourceComplianceSummariesRequest)
Returns a resource-level summary count.default ListResourceComplianceSummariesResponse
listResourceComplianceSummaries(ListResourceComplianceSummariesRequest listResourceComplianceSummariesRequest)
Returns a resource-level summary count.default ListResourceComplianceSummariesIterable
listResourceComplianceSummariesPaginator()
Returns a resource-level summary count.default ListResourceComplianceSummariesIterable
listResourceComplianceSummariesPaginator(Consumer<ListResourceComplianceSummariesRequest.Builder> listResourceComplianceSummariesRequest)
Returns a resource-level summary count.default ListResourceComplianceSummariesIterable
listResourceComplianceSummariesPaginator(ListResourceComplianceSummariesRequest listResourceComplianceSummariesRequest)
Returns a resource-level summary count.default ListResourceDataSyncResponse
listResourceDataSync()
Lists your resource data sync configurations.default ListResourceDataSyncResponse
listResourceDataSync(Consumer<ListResourceDataSyncRequest.Builder> listResourceDataSyncRequest)
Lists your resource data sync configurations.default ListResourceDataSyncResponse
listResourceDataSync(ListResourceDataSyncRequest listResourceDataSyncRequest)
Lists your resource data sync configurations.default ListResourceDataSyncIterable
listResourceDataSyncPaginator()
Lists your resource data sync configurations.default ListResourceDataSyncIterable
listResourceDataSyncPaginator(Consumer<ListResourceDataSyncRequest.Builder> listResourceDataSyncRequest)
Lists your resource data sync configurations.default ListResourceDataSyncIterable
listResourceDataSyncPaginator(ListResourceDataSyncRequest listResourceDataSyncRequest)
Lists your resource data sync configurations.default ListTagsForResourceResponse
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Returns a list of the tags assigned to the specified resource.default ListTagsForResourceResponse
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Returns a list of the tags assigned to the specified resource.default ModifyDocumentPermissionResponse
modifyDocumentPermission(Consumer<ModifyDocumentPermissionRequest.Builder> modifyDocumentPermissionRequest)
Shares a Amazon Web Services Systems Manager document (SSM document)publicly or privately.default ModifyDocumentPermissionResponse
modifyDocumentPermission(ModifyDocumentPermissionRequest modifyDocumentPermissionRequest)
Shares a Amazon Web Services Systems Manager document (SSM 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 or more managed nodes.default PutInventoryResponse
putInventory(PutInventoryRequest putInventoryRequest)
Bulk update custom inventory items on one or more managed nodes.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 PutResourcePolicyResponse
putResourcePolicy(Consumer<PutResourcePolicyRequest.Builder> putResourcePolicyRequest)
Creates or updates a Systems Manager resource policy.default PutResourcePolicyResponse
putResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest)
Creates or updates a Systems Manager resource policy.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 Amazon Web Services service.default ResetServiceSettingResponse
resetServiceSetting(ResetServiceSettingRequest resetServiceSettingRequest)
ServiceSetting
is an account-level setting for an Amazon Web Services service.default ResumeSessionResponse
resumeSession(Consumer<ResumeSessionRequest.Builder> resumeSessionRequest)
Reconnects a session to a managed node after it has been disconnected.default ResumeSessionResponse
resumeSession(ResumeSessionRequest resumeSessionRequest)
Reconnects a session to a managed node 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 nodes.default SendCommandResponse
sendCommand(SendCommandRequest sendCommandRequest)
Runs commands on one or more managed nodes.default SsmServiceClientConfiguration
serviceClientConfiguration()
static ServiceMetadata
serviceMetadata()
default StartAssociationsOnceResponse
startAssociationsOnce(Consumer<StartAssociationsOnceRequest.Builder> startAssociationsOnceRequest)
Runs an association immediately and only one time.default StartAssociationsOnceResponse
startAssociationsOnce(StartAssociationsOnceRequest startAssociationsOnceRequest)
Runs an association immediately and only one time.default StartAutomationExecutionResponse
startAutomationExecution(Consumer<StartAutomationExecutionRequest.Builder> startAutomationExecutionRequest)
Initiates execution of an Automation runbook.default StartAutomationExecutionResponse
startAutomationExecution(StartAutomationExecutionRequest startAutomationExecutionRequest)
Initiates execution of an Automation runbook.default StartChangeRequestExecutionResponse
startChangeRequestExecution(Consumer<StartChangeRequestExecutionRequest.Builder> startChangeRequestExecutionRequest)
Creates a change request for Change Manager.default StartChangeRequestExecutionResponse
startChangeRequestExecution(StartChangeRequestExecutionRequest startChangeRequestExecutionRequest)
Creates a change request for Change Manager.default StartSessionResponse
startSession(Consumer<StartSessionRequest.Builder> startSessionRequest)
Initiates a connection to a target (for example, a managed node) for a Session Manager session.default StartSessionResponse
startSession(StartSessionRequest startSessionRequest)
Initiates a connection to a target (for example, a managed node) 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 managed node.default TerminateSessionResponse
terminateSession(TerminateSessionRequest terminateSessionRequest)
Permanently ends a session and closes the data connection between the Session Manager client and SSM Agent on the managed node.default UnlabelParameterVersionResponse
unlabelParameterVersion(Consumer<UnlabelParameterVersionRequest.Builder> unlabelParameterVersionRequest)
Remove a label or labels from a parameter.default UnlabelParameterVersionResponse
unlabelParameterVersion(UnlabelParameterVersionRequest unlabelParameterVersionRequest)
Remove a label or labels from a parameter.default UpdateAssociationResponse
updateAssociation(Consumer<UpdateAssociationRequest.Builder> updateAssociationRequest)
Updates an association.default UpdateAssociationResponse
updateAssociation(UpdateAssociationRequest updateAssociationRequest)
Updates an association.default UpdateAssociationStatusResponse
updateAssociationStatus(Consumer<UpdateAssociationStatusRequest.Builder> updateAssociationStatusRequest)
Updates the status of the Amazon Web Services Systems Manager document (SSM document) associated with the specified managed node.default UpdateAssociationStatusResponse
updateAssociationStatus(UpdateAssociationStatusRequest updateAssociationStatusRequest)
Updates the status of the Amazon Web Services Systems Manager document (SSM document) associated with the specified managed node.default UpdateDocumentResponse
updateDocument(Consumer<UpdateDocumentRequest.Builder> updateDocumentRequest)
Updates one or more values for an SSM document.default UpdateDocumentResponse
updateDocument(UpdateDocumentRequest updateDocumentRequest)
Updates one or more values for an SSM document.default UpdateDocumentDefaultVersionResponse
updateDocumentDefaultVersion(Consumer<UpdateDocumentDefaultVersionRequest.Builder> updateDocumentDefaultVersionRequest)
Set the default version of a document.default UpdateDocumentDefaultVersionResponse
updateDocumentDefaultVersion(UpdateDocumentDefaultVersionRequest updateDocumentDefaultVersionRequest)
Set the default version of a document.default UpdateDocumentMetadataResponse
updateDocumentMetadata(Consumer<UpdateDocumentMetadataRequest.Builder> updateDocumentMetadataRequest)
Updates information related to approval reviews for a specific version of a change template in Change Manager.default UpdateDocumentMetadataResponse
updateDocumentMetadata(UpdateDocumentMetadataRequest updateDocumentMetadataRequest)
Updates information related to approval reviews for a specific version of a change template in Change Manager.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 Identity and Access Management (IAM) role that is assigned to the on-premises server, edge device, or virtual machines (VM).default UpdateManagedInstanceRoleResponse
updateManagedInstanceRole(UpdateManagedInstanceRoleRequest updateManagedInstanceRoleRequest)
Changes the Identity and Access Management (IAM) role that is assigned to the on-premises server, edge device, or virtual machines (VM).default UpdateOpsItemResponse
updateOpsItem(Consumer<UpdateOpsItemRequest.Builder> updateOpsItemRequest)
Edit or change an OpsItem.default UpdateOpsItemResponse
updateOpsItem(UpdateOpsItemRequest updateOpsItemRequest)
Edit or change an OpsItem.default UpdateOpsMetadataResponse
updateOpsMetadata(Consumer<UpdateOpsMetadataRequest.Builder> updateOpsMetadataRequest)
Amazon Web Services Systems Manager calls this API operation when you edit OpsMetadata in Application Manager.default UpdateOpsMetadataResponse
updateOpsMetadata(UpdateOpsMetadataRequest updateOpsMetadataRequest)
Amazon Web Services Systems Manager calls this API operation when you edit OpsMetadata in Application Manager.default UpdatePatchBaselineResponse
updatePatchBaseline(Consumer<UpdatePatchBaselineRequest.Builder> updatePatchBaselineRequest)
Modifies an existing patch baseline.default UpdatePatchBaselineResponse
updatePatchBaseline(UpdatePatchBaselineRequest updatePatchBaselineRequest)
Modifies an existing patch baseline.default UpdateResourceDataSyncResponse
updateResourceDataSync(Consumer<UpdateResourceDataSyncRequest.Builder> updateResourceDataSyncRequest)
Update a resource data sync.default UpdateResourceDataSyncResponse
updateResourceDataSync(UpdateResourceDataSyncRequest updateResourceDataSyncRequest)
Update a resource data sync.default UpdateServiceSettingResponse
updateServiceSetting(Consumer<UpdateServiceSettingRequest.Builder> updateServiceSettingRequest)
ServiceSetting
is an account-level setting for an Amazon Web Services service.default UpdateServiceSettingResponse
updateServiceSetting(UpdateServiceSettingRequest updateServiceSettingRequest)
ServiceSetting
is an account-level setting for an Amazon Web Services service.default SsmWaiter
waiter()
Create an instance ofSsmWaiter
using this client.-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
- Constant Field Values
-
-
Method Detail
-
addTagsToResource
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 automations, documents, managed nodes, 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 nodes that helps you track each node's owner and stack level. For example:
-
Key=Owner,Value=DbAdmin
-
Key=Owner,Value=SysAdmin
-
Key=Owner,Value=Dev
-
Key=Stack,Value=Production
-
Key=Stack,Value=Pre-Production
-
Key=Stack,Value=Test
Most resources can have a maximum of 50 tags. Automations can have a maximum of 5 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 Amazon Elastic Compute Cloud (Amazon EC2) instances, see Tagging your Amazon EC2 resources in the Amazon EC2 User Guide.
- Parameters:
addTagsToResourceRequest
-- Returns:
- Result of the AddTagsToResource operation returned by the service.
- Throws:
InvalidResourceTypeException
- The resource type isn't valid. For example, if you are attempting to tag an EC2 instance, the instance must be a registered managed node.InvalidResourceIdException
- The resource ID isn't valid. Verify that you entered the correct ID and try again.InternalServerErrorException
- An error occurred on the server side.TooManyTagsErrorException
- TheTargets
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
- See Also:
- AWS API Documentation
-
-
addTagsToResource
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 automations, documents, managed nodes, 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 nodes that helps you track each node's owner and stack level. For example:
-
Key=Owner,Value=DbAdmin
-
Key=Owner,Value=SysAdmin
-
Key=Owner,Value=Dev
-
Key=Stack,Value=Production
-
Key=Stack,Value=Pre-Production
-
Key=Stack,Value=Test
Most resources can have a maximum of 50 tags. Automations can have a maximum of 5 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 Amazon Elastic Compute Cloud (Amazon 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 viaAddTagsToResourceRequest.builder()
- Parameters:
addTagsToResourceRequest
- AConsumer
that will call methods onAddTagsToResourceRequest.Builder
to create a request.- Returns:
- Result of the AddTagsToResource operation returned by the service.
- Throws:
InvalidResourceTypeException
- The resource type isn't valid. For example, if you are attempting to tag an EC2 instance, the instance must be a registered managed node.InvalidResourceIdException
- The resource ID isn't valid. Verify that you entered the correct ID and try again.InternalServerErrorException
- An error occurred on the server side.TooManyTagsErrorException
- TheTargets
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
- See Also:
- AWS API Documentation
-
-
associateOpsItemRelatedItem
default AssociateOpsItemRelatedItemResponse associateOpsItemRelatedItem(AssociateOpsItemRelatedItemRequest associateOpsItemRelatedItemRequest) throws InternalServerErrorException, OpsItemNotFoundException, OpsItemLimitExceededException, OpsItemInvalidParameterException, OpsItemRelatedItemAlreadyExistsException, OpsItemConflictException, AwsServiceException, SdkClientException, SsmException
Associates a related item to a Systems Manager OpsCenter OpsItem. For example, you can associate an Incident Manager incident or analysis with an OpsItem. Incident Manager and OpsCenter are capabilities of Amazon Web Services Systems Manager.
- Parameters:
associateOpsItemRelatedItemRequest
-- Returns:
- Result of the AssociateOpsItemRelatedItem operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.OpsItemNotFoundException
- The specified OpsItem ID doesn't exist. Verify the ID and try again.OpsItemLimitExceededException
- The request caused OpsItems to exceed one or more quotas.OpsItemInvalidParameterException
- A specified parameter argument isn't valid. Verify the available arguments and try again.OpsItemRelatedItemAlreadyExistsException
- The Amazon Resource Name (ARN) is already associated with the OpsItem.OpsItemConflictException
- The specified OpsItem is in the process of being deleted.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
associateOpsItemRelatedItem
default AssociateOpsItemRelatedItemResponse associateOpsItemRelatedItem(Consumer<AssociateOpsItemRelatedItemRequest.Builder> associateOpsItemRelatedItemRequest) throws InternalServerErrorException, OpsItemNotFoundException, OpsItemLimitExceededException, OpsItemInvalidParameterException, OpsItemRelatedItemAlreadyExistsException, OpsItemConflictException, AwsServiceException, SdkClientException, SsmException
Associates a related item to a Systems Manager OpsCenter OpsItem. For example, you can associate an Incident Manager incident or analysis with an OpsItem. Incident Manager and OpsCenter are capabilities of Amazon Web Services Systems Manager.
This is a convenience which creates an instance of the
AssociateOpsItemRelatedItemRequest.Builder
avoiding the need to create one manually viaAssociateOpsItemRelatedItemRequest.builder()
- Parameters:
associateOpsItemRelatedItemRequest
- AConsumer
that will call methods onAssociateOpsItemRelatedItemRequest.Builder
to create a request.- Returns:
- Result of the AssociateOpsItemRelatedItem operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.OpsItemNotFoundException
- The specified OpsItem ID doesn't exist. Verify the ID and try again.OpsItemLimitExceededException
- The request caused OpsItems to exceed one or more quotas.OpsItemInvalidParameterException
- A specified parameter argument isn't valid. Verify the available arguments and try again.OpsItemRelatedItemAlreadyExistsException
- The Amazon Resource Name (ARN) is already associated with the OpsItem.OpsItemConflictException
- The specified OpsItem is in the process of being deleted.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
cancelCommand
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.
- Parameters:
cancelCommandRequest
-- Returns:
- Result of the CancelCommand operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidCommandIdException
- The specified command ID isn't valid. Verify the ID and try again.InvalidInstanceIdException
- The following problems can cause this exception:-
You don't have permission to access the managed node.
-
Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running.
-
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
-
The managed node isn't in valid state. Valid states are:
Running
,Pending
,Stopped
, andStopping
. Invalid states are:Shutting-down
andTerminated
.
-
DuplicateInstanceIdException
- You can't specify a managed node 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
- See Also:
- AWS API Documentation
-
cancelCommand
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 viaCancelCommandRequest.builder()
- Parameters:
cancelCommandRequest
- AConsumer
that will call methods onCancelCommandRequest.Builder
to create a request.- Returns:
- Result of the CancelCommand operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidCommandIdException
- The specified command ID isn't valid. Verify the ID and try again.InvalidInstanceIdException
- The following problems can cause this exception:-
You don't have permission to access the managed node.
-
Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running.
-
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
-
The managed node isn't in valid state. Valid states are:
Running
,Pending
,Stopped
, andStopping
. Invalid states are:Shutting-down
andTerminated
.
-
DuplicateInstanceIdException
- You can't specify a managed node 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
- See Also:
- AWS API Documentation
-
cancelMaintenanceWindowExecution
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 haven't already starting running. Tasks already in progress will continue to completion.
- Parameters:
cancelMaintenanceWindowExecutionRequest
-- Returns:
- Result of the CancelMaintenanceWindowExecution operation returned by the service.
- Throws:
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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services 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
- See Also:
- AWS API Documentation
-
cancelMaintenanceWindowExecution
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 haven't 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 viaCancelMaintenanceWindowExecutionRequest.builder()
- Parameters:
cancelMaintenanceWindowExecutionRequest
- AConsumer
that will call methods onCancelMaintenanceWindowExecutionRequest.Builder
to create a request.- Returns:
- Result of the CancelMaintenanceWindowExecution operation returned by the service.
- Throws:
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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services 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
- See Also:
- AWS API Documentation
-
createActivation
default CreateActivationResponse createActivation(CreateActivationRequest createActivationRequest) throws InvalidParametersException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Generates an activation code and activation ID you can use to register your on-premises servers, edge devices, or virtual machine (VM) with Amazon Web Services 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 machines using Systems Manager, see Setting up Amazon Web Services Systems Manager for hybrid environments in the Amazon Web Services Systems Manager User Guide.
Amazon Elastic Compute Cloud (Amazon EC2) instances, edge devices, and on-premises servers and VMs that are configured for Systems Manager are all called managed nodes.
- Parameters:
createActivationRequest
-- Returns:
- Result of the CreateActivation operation returned by the service.
- Throws:
InvalidParametersException
- You must specify values for all required parameters in the Amazon Web Services Systems Manager document (SSM document). You can only supply values to parameters defined in the SSM document.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
- See Also:
- AWS API Documentation
-
createActivation
default CreateActivationResponse createActivation(Consumer<CreateActivationRequest.Builder> createActivationRequest) throws InvalidParametersException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Generates an activation code and activation ID you can use to register your on-premises servers, edge devices, or virtual machine (VM) with Amazon Web Services 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 machines using Systems Manager, see Setting up Amazon Web Services Systems Manager for hybrid environments in the Amazon Web Services Systems Manager User Guide.
Amazon Elastic Compute Cloud (Amazon EC2) instances, edge devices, and on-premises servers and VMs that are configured for Systems Manager are all called managed nodes.
This is a convenience which creates an instance of the
CreateActivationRequest.Builder
avoiding the need to create one manually viaCreateActivationRequest.builder()
- Parameters:
createActivationRequest
- AConsumer
that will call methods onCreateActivationRequest.Builder
to create a request.- Returns:
- Result of the CreateActivation operation returned by the service.
- Throws:
InvalidParametersException
- You must specify values for all required parameters in the Amazon Web Services Systems Manager document (SSM document). You can only supply values to parameters defined in the SSM document.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
- See Also:
- AWS API Documentation
-
createAssociation
default CreateAssociationResponse createAssociation(CreateAssociationRequest createAssociationRequest) throws AssociationAlreadyExistsException, AssociationLimitExceededException, InternalServerErrorException, InvalidDocumentException, InvalidDocumentVersionException, InvalidInstanceIdException, UnsupportedPlatformTypeException, InvalidOutputLocationException, InvalidParametersException, InvalidTargetException, InvalidScheduleException, InvalidTargetMapsException, InvalidTagException, AwsServiceException, SdkClientException, SsmException
A State Manager association defines the state that you want to maintain on your managed nodes. For example, an association can specify that anti-virus software must be installed and running on your managed nodes, 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 Amazon Web Services resource group or an Amazon Web Services autoscaling group, State Manager, a capability of Amazon Web Services Systems Manager applies the configuration when new managed nodes 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 isn't installed, then State Manager installs it. If the software is installed, but the service isn't running, then the association might instruct State Manager to start the service.
- Parameters:
createAssociationRequest
-- Returns:
- Result of the CreateAssociation operation returned by the service.
- Throws:
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 SSM document doesn't exist.InvalidDocumentVersionException
- The document version isn't valid or doesn't exist.InvalidInstanceIdException
- The following problems can cause this exception:-
You don't have permission to access the managed node.
-
Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running.
-
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
-
The managed node isn't in valid state. Valid states are:
Running
,Pending
,Stopped
, andStopping
. Invalid states are:Shutting-down
andTerminated
.
-
UnsupportedPlatformTypeException
- The document doesn't support the platform type of the given managed node ID(s). For example, you sent an document for a Windows managed node to a Linux node.InvalidOutputLocationException
- The output location isn't valid or doesn't exist.InvalidParametersException
- You must specify values for all required parameters in the Amazon Web Services Systems Manager document (SSM document). You can only supply values to parameters defined in the SSM document.InvalidTargetException
- The target isn't valid or doesn't 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.InvalidTargetMapsException
- TargetMap parameter isn't valid.InvalidTagException
- The specified tag key or value isn't 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
- See Also:
- AWS API Documentation
-
createAssociation
default CreateAssociationResponse createAssociation(Consumer<CreateAssociationRequest.Builder> createAssociationRequest) throws AssociationAlreadyExistsException, AssociationLimitExceededException, InternalServerErrorException, InvalidDocumentException, InvalidDocumentVersionException, InvalidInstanceIdException, UnsupportedPlatformTypeException, InvalidOutputLocationException, InvalidParametersException, InvalidTargetException, InvalidScheduleException, InvalidTargetMapsException, InvalidTagException, AwsServiceException, SdkClientException, SsmException
A State Manager association defines the state that you want to maintain on your managed nodes. For example, an association can specify that anti-virus software must be installed and running on your managed nodes, 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 Amazon Web Services resource group or an Amazon Web Services autoscaling group, State Manager, a capability of Amazon Web Services Systems Manager applies the configuration when new managed nodes 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 isn't installed, then State Manager installs it. If the software is installed, but the service isn't 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 viaCreateAssociationRequest.builder()
- Parameters:
createAssociationRequest
- AConsumer
that will call methods onCreateAssociationRequest.Builder
to create a request.- Returns:
- Result of the CreateAssociation operation returned by the service.
- Throws:
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 SSM document doesn't exist.InvalidDocumentVersionException
- The document version isn't valid or doesn't exist.InvalidInstanceIdException
- The following problems can cause this exception:-
You don't have permission to access the managed node.
-
Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running.
-
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
-
The managed node isn't in valid state. Valid states are:
Running
,Pending
,Stopped
, andStopping
. Invalid states are:Shutting-down
andTerminated
.
-
UnsupportedPlatformTypeException
- The document doesn't support the platform type of the given managed node ID(s). For example, you sent an document for a Windows managed node to a Linux node.InvalidOutputLocationException
- The output location isn't valid or doesn't exist.InvalidParametersException
- You must specify values for all required parameters in the Amazon Web Services Systems Manager document (SSM document). You can only supply values to parameters defined in the SSM document.InvalidTargetException
- The target isn't valid or doesn't 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.InvalidTargetMapsException
- TargetMap parameter isn't valid.InvalidTagException
- The specified tag key or value isn't 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
- See Also:
- AWS API Documentation
-
createAssociationBatch
default CreateAssociationBatchResponse createAssociationBatch(CreateAssociationBatchRequest createAssociationBatchRequest) throws InternalServerErrorException, InvalidDocumentException, InvalidDocumentVersionException, InvalidInstanceIdException, InvalidParametersException, DuplicateInstanceIdException, AssociationLimitExceededException, UnsupportedPlatformTypeException, InvalidOutputLocationException, InvalidTargetException, InvalidScheduleException, InvalidTargetMapsException, AwsServiceException, SdkClientException, SsmException
Associates the specified Amazon Web Services Systems Manager document (SSM document) with the specified managed nodes or targets.
When you associate a document with one or more managed nodes using IDs or tags, Amazon Web Services Systems Manager Agent (SSM Agent) running on the managed node processes the document and configures the node as specified.
If you associate a document with a managed node that already has an associated document, the system returns the AssociationAlreadyExists exception.
- Parameters:
createAssociationBatchRequest
-- Returns:
- Result of the CreateAssociationBatch operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidDocumentException
- The specified SSM document doesn't exist.InvalidDocumentVersionException
- The document version isn't valid or doesn't exist.InvalidInstanceIdException
- The following problems can cause this exception:-
You don't have permission to access the managed node.
-
Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running.
-
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
-
The managed node isn't in valid state. Valid states are:
Running
,Pending
,Stopped
, andStopping
. Invalid states are:Shutting-down
andTerminated
.
-
InvalidParametersException
- You must specify values for all required parameters in the Amazon Web Services Systems Manager document (SSM document). You can only supply values to parameters defined in the SSM document.DuplicateInstanceIdException
- You can't specify a managed node ID in more than one association.AssociationLimitExceededException
- You can have at most 2,000 active associations.UnsupportedPlatformTypeException
- The document doesn't support the platform type of the given managed node ID(s). For example, you sent an document for a Windows managed node to a Linux node.InvalidOutputLocationException
- The output location isn't valid or doesn't exist.InvalidTargetException
- The target isn't valid or doesn't 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.InvalidTargetMapsException
- TargetMap parameter isn't 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
- See Also:
- AWS API Documentation
-
createAssociationBatch
default CreateAssociationBatchResponse createAssociationBatch(Consumer<CreateAssociationBatchRequest.Builder> createAssociationBatchRequest) throws InternalServerErrorException, InvalidDocumentException, InvalidDocumentVersionException, InvalidInstanceIdException, InvalidParametersException, DuplicateInstanceIdException, AssociationLimitExceededException, UnsupportedPlatformTypeException, InvalidOutputLocationException, InvalidTargetException, InvalidScheduleException, InvalidTargetMapsException, AwsServiceException, SdkClientException, SsmException
Associates the specified Amazon Web Services Systems Manager document (SSM document) with the specified managed nodes or targets.
When you associate a document with one or more managed nodes using IDs or tags, Amazon Web Services Systems Manager Agent (SSM Agent) running on the managed node processes the document and configures the node as specified.
If you associate a document with a managed node 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 viaCreateAssociationBatchRequest.builder()
- Parameters:
createAssociationBatchRequest
- AConsumer
that will call methods onCreateAssociationBatchRequest.Builder
to create a request.- Returns:
- Result of the CreateAssociationBatch operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidDocumentException
- The specified SSM document doesn't exist.InvalidDocumentVersionException
- The document version isn't valid or doesn't exist.InvalidInstanceIdException
- The following problems can cause this exception:-
You don't have permission to access the managed node.
-
Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running.
-
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
-
The managed node isn't in valid state. Valid states are:
Running
,Pending
,Stopped
, andStopping
. Invalid states are:Shutting-down
andTerminated
.
-
InvalidParametersException
- You must specify values for all required parameters in the Amazon Web Services Systems Manager document (SSM document). You can only supply values to parameters defined in the SSM document.DuplicateInstanceIdException
- You can't specify a managed node ID in more than one association.AssociationLimitExceededException
- You can have at most 2,000 active associations.UnsupportedPlatformTypeException
- The document doesn't support the platform type of the given managed node ID(s). For example, you sent an document for a Windows managed node to a Linux node.InvalidOutputLocationException
- The output location isn't valid or doesn't exist.InvalidTargetException
- The target isn't valid or doesn't 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.InvalidTargetMapsException
- TargetMap parameter isn't 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
- See Also:
- AWS API Documentation
-
createDocument
default CreateDocumentResponse createDocument(CreateDocumentRequest createDocumentRequest) throws DocumentAlreadyExistsException, MaxDocumentSizeExceededException, InternalServerErrorException, InvalidDocumentContentException, DocumentLimitExceededException, InvalidDocumentSchemaVersionException, AwsServiceException, SdkClientException, SsmException
Creates a Amazon Web Services Systems Manager (SSM document). An SSM document defines the actions that Systems Manager performs on your managed nodes. For more information about SSM documents, including information about supported schemas, features, and syntax, see Amazon Web Services Systems Manager Documents in the Amazon Web Services Systems Manager User Guide.
- Parameters:
createDocumentRequest
-- Returns:
- Result of the CreateDocument operation returned by the service.
- Throws:
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 isn't valid.DocumentLimitExceededException
- You can have at most 500 active SSM documents.InvalidDocumentSchemaVersionException
- The version of the document schema isn't 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
- See Also:
- AWS API Documentation
-
createDocument
default CreateDocumentResponse createDocument(Consumer<CreateDocumentRequest.Builder> createDocumentRequest) throws DocumentAlreadyExistsException, MaxDocumentSizeExceededException, InternalServerErrorException, InvalidDocumentContentException, DocumentLimitExceededException, InvalidDocumentSchemaVersionException, AwsServiceException, SdkClientException, SsmException
Creates a Amazon Web Services Systems Manager (SSM document). An SSM document defines the actions that Systems Manager performs on your managed nodes. For more information about SSM documents, including information about supported schemas, features, and syntax, see Amazon Web Services Systems Manager Documents in the Amazon Web Services Systems Manager User Guide.
This is a convenience which creates an instance of the
CreateDocumentRequest.Builder
avoiding the need to create one manually viaCreateDocumentRequest.builder()
- Parameters:
createDocumentRequest
- AConsumer
that will call methods onCreateDocumentRequest.Builder
to create a request.- Returns:
- Result of the CreateDocument operation returned by the service.
- Throws:
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 isn't valid.DocumentLimitExceededException
- You can have at most 500 active SSM documents.InvalidDocumentSchemaVersionException
- The version of the document schema isn't 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
- See Also:
- AWS API Documentation
-
createMaintenanceWindow
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 forCutoff
. For example, if the maintenance window starts at 3 PM, the duration is three hours, and the value you specify forCutoff
is one hour, no maintenance window tasks can start after 5 PM.- Parameters:
createMaintenanceWindowRequest
-- Returns:
- Result of the CreateMaintenanceWindow operation returned by the service.
- Throws:
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 Amazon Web Services 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
- See Also:
- AWS API Documentation
-
createMaintenanceWindow
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 forCutoff
. For example, if the maintenance window starts at 3 PM, the duration is three hours, and the value you specify forCutoff
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 viaCreateMaintenanceWindowRequest.builder()
- Parameters:
createMaintenanceWindowRequest
- AConsumer
that will call methods onCreateMaintenanceWindowRequest.Builder
to create a request.- Returns:
- Result of the CreateMaintenanceWindow operation returned by the service.
- Throws:
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 Amazon Web Services 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
- See Also:
- AWS API Documentation
-
createOpsItem
default CreateOpsItemResponse createOpsItem(CreateOpsItemRequest createOpsItemRequest) throws InternalServerErrorException, OpsItemAlreadyExistsException, OpsItemLimitExceededException, OpsItemInvalidParameterException, OpsItemAccessDeniedException, AwsServiceException, SdkClientException, SsmException
Creates a new OpsItem. You must have permission in Identity and Access Management (IAM) to create a new OpsItem. For more information, see Set up OpsCenter in the Amazon Web Services Systems Manager User Guide.
Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For more information, see Amazon Web Services Systems Manager OpsCenter in the Amazon Web Services Systems Manager User Guide.
- Parameters:
createOpsItemRequest
-- Returns:
- Result of the CreateOpsItem operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.OpsItemAlreadyExistsException
- The OpsItem already exists.OpsItemLimitExceededException
- The request caused OpsItems to exceed one or more quotas.OpsItemInvalidParameterException
- A specified parameter argument isn't valid. Verify the available arguments and try again.OpsItemAccessDeniedException
- You don't have permission to view OpsItems in the specified account. Verify that your account is configured either as a Systems Manager delegated administrator or that you are logged into the Organizations management account.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
createOpsItem
default CreateOpsItemResponse createOpsItem(Consumer<CreateOpsItemRequest.Builder> createOpsItemRequest) throws InternalServerErrorException, OpsItemAlreadyExistsException, OpsItemLimitExceededException, OpsItemInvalidParameterException, OpsItemAccessDeniedException, AwsServiceException, SdkClientException, SsmException
Creates a new OpsItem. You must have permission in Identity and Access Management (IAM) to create a new OpsItem. For more information, see Set up OpsCenter in the Amazon Web Services Systems Manager User Guide.
Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For more information, see Amazon Web Services Systems Manager OpsCenter in the Amazon Web Services Systems Manager User Guide.
This is a convenience which creates an instance of the
CreateOpsItemRequest.Builder
avoiding the need to create one manually viaCreateOpsItemRequest.builder()
- Parameters:
createOpsItemRequest
- AConsumer
that will call methods onCreateOpsItemRequest.Builder
to create a request.- Returns:
- Result of the CreateOpsItem operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.OpsItemAlreadyExistsException
- The OpsItem already exists.OpsItemLimitExceededException
- The request caused OpsItems to exceed one or more quotas.OpsItemInvalidParameterException
- A specified parameter argument isn't valid. Verify the available arguments and try again.OpsItemAccessDeniedException
- You don't have permission to view OpsItems in the specified account. Verify that your account is configured either as a Systems Manager delegated administrator or that you are logged into the Organizations management account.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
createOpsMetadata
default CreateOpsMetadataResponse createOpsMetadata(CreateOpsMetadataRequest createOpsMetadataRequest) throws OpsMetadataAlreadyExistsException, OpsMetadataTooManyUpdatesException, OpsMetadataInvalidArgumentException, OpsMetadataLimitExceededException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
If you create a new application in Application Manager, Amazon Web Services Systems Manager calls this API operation to specify information about the new application, including the application type.
- Parameters:
createOpsMetadataRequest
-- Returns:
- Result of the CreateOpsMetadata operation returned by the service.
- Throws:
OpsMetadataAlreadyExistsException
- An OpsMetadata object already exists for the selected resource.OpsMetadataTooManyUpdatesException
- The system is processing too many concurrent updates. Wait a few moments and try again.OpsMetadataInvalidArgumentException
- One of the arguments passed is invalid.OpsMetadataLimitExceededException
- Your account reached the maximum number of OpsMetadata objects allowed by Application Manager. The maximum is 200 OpsMetadata objects. Delete one or more OpsMetadata object and try again.InternalServerErrorException
- An error occurred on the server side.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
createOpsMetadata
default CreateOpsMetadataResponse createOpsMetadata(Consumer<CreateOpsMetadataRequest.Builder> createOpsMetadataRequest) throws OpsMetadataAlreadyExistsException, OpsMetadataTooManyUpdatesException, OpsMetadataInvalidArgumentException, OpsMetadataLimitExceededException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
If you create a new application in Application Manager, Amazon Web Services Systems Manager calls this API operation to specify information about the new application, including the application type.
This is a convenience which creates an instance of the
CreateOpsMetadataRequest.Builder
avoiding the need to create one manually viaCreateOpsMetadataRequest.builder()
- Parameters:
createOpsMetadataRequest
- AConsumer
that will call methods onCreateOpsMetadataRequest.Builder
to create a request.- Returns:
- Result of the CreateOpsMetadata operation returned by the service.
- Throws:
OpsMetadataAlreadyExistsException
- An OpsMetadata object already exists for the selected resource.OpsMetadataTooManyUpdatesException
- The system is processing too many concurrent updates. Wait a few moments and try again.OpsMetadataInvalidArgumentException
- One of the arguments passed is invalid.OpsMetadataLimitExceededException
- Your account reached the maximum number of OpsMetadata objects allowed by Application Manager. The maximum is 200 OpsMetadata objects. Delete one or more OpsMetadata object and try again.InternalServerErrorException
- An error occurred on the server side.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
createPatchBaseline
default CreatePatchBaselineResponse createPatchBaseline(CreatePatchBaselineRequest createPatchBaselineRequest) throws IdempotentParameterMismatchException, ResourceLimitExceededException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Creates a patch baseline.
For information about valid key-value pairs in
PatchFilters
for each supported operating system type, see PatchFilter.- Parameters:
createPatchBaselineRequest
-- Returns:
- Result of the CreatePatchBaseline operation returned by the service.
- Throws:
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 Amazon Web Services 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
- See Also:
- AWS API Documentation
-
createPatchBaseline
default CreatePatchBaselineResponse createPatchBaseline(Consumer<CreatePatchBaselineRequest.Builder> createPatchBaselineRequest) throws IdempotentParameterMismatchException, ResourceLimitExceededException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Creates a patch baseline.
For information about valid key-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 viaCreatePatchBaselineRequest.builder()
- Parameters:
createPatchBaselineRequest
- AConsumer
that will call methods onCreatePatchBaselineRequest.Builder
to create a request.- Returns:
- Result of the CreatePatchBaseline operation returned by the service.
- Throws:
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 Amazon Web Services 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
- See Also:
- AWS API Documentation
-
createResourceDataSync
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. Amazon Web Services Systems Manager offers two types of resource data sync:
SyncToDestination
andSyncFromSource
.You can configure Systems Manager Inventory to use the
SyncToDestination
type to synchronize Inventory data from multiple Amazon Web Services Regions to a single Amazon Simple Storage Service (Amazon S3) bucket. For more information, see Configuring resource data sync for Inventory in the Amazon Web Services 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 Amazon Web Services Regions to a single Amazon S3 bucket. This type can synchronize OpsItems and OpsData from multiple Amazon Web Services accounts and Amazon Web Services Regions orEntireOrganization
by using Organizations. For more information, see Setting up Systems Manager Explorer to display data from multiple accounts and Regions in the Amazon Web Services 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 isn't 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.
- Parameters:
createResourceDataSyncRequest
-- Returns:
- Result of the CreateResourceDataSync operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
createResourceDataSync
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. Amazon Web Services Systems Manager offers two types of resource data sync:
SyncToDestination
andSyncFromSource
.You can configure Systems Manager Inventory to use the
SyncToDestination
type to synchronize Inventory data from multiple Amazon Web Services Regions to a single Amazon Simple Storage Service (Amazon S3) bucket. For more information, see Configuring resource data sync for Inventory in the Amazon Web Services 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 Amazon Web Services Regions to a single Amazon S3 bucket. This type can synchronize OpsItems and OpsData from multiple Amazon Web Services accounts and Amazon Web Services Regions orEntireOrganization
by using Organizations. For more information, see Setting up Systems Manager Explorer to display data from multiple accounts and Regions in the Amazon Web Services 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 isn't 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 viaCreateResourceDataSyncRequest.builder()
- Parameters:
createResourceDataSyncRequest
- AConsumer
that will call methods onCreateResourceDataSyncRequest.Builder
to create a request.- Returns:
- Result of the CreateResourceDataSync operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
deleteActivation
default DeleteActivationResponse deleteActivation(DeleteActivationRequest deleteActivationRequest) throws InvalidActivationIdException, InvalidActivationException, InternalServerErrorException, TooManyUpdatesException, AwsServiceException, SdkClientException, SsmException
Deletes an activation. You aren't required to delete an activation. If you delete an activation, you can no longer use it to register additional managed nodes. Deleting an activation doesn't de-register managed nodes. You must manually de-register managed nodes.
- Parameters:
deleteActivationRequest
-- Returns:
- Result of the DeleteActivation operation returned by the service.
- Throws:
InvalidActivationIdException
- The activation ID isn't valid. Verify the you entered the correct ActivationId or ActivationCode and try again.InvalidActivationException
- The activation isn't valid. The activation might have been deleted, or the ActivationId and the ActivationCode don't 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
- See Also:
- AWS API Documentation
-
deleteActivation
default DeleteActivationResponse deleteActivation(Consumer<DeleteActivationRequest.Builder> deleteActivationRequest) throws InvalidActivationIdException, InvalidActivationException, InternalServerErrorException, TooManyUpdatesException, AwsServiceException, SdkClientException, SsmException
Deletes an activation. You aren't required to delete an activation. If you delete an activation, you can no longer use it to register additional managed nodes. Deleting an activation doesn't de-register managed nodes. You must manually de-register managed nodes.
This is a convenience which creates an instance of the
DeleteActivationRequest.Builder
avoiding the need to create one manually viaDeleteActivationRequest.builder()
- Parameters:
deleteActivationRequest
- AConsumer
that will call methods onDeleteActivationRequest.Builder
to create a request.- Returns:
- Result of the DeleteActivation operation returned by the service.
- Throws:
InvalidActivationIdException
- The activation ID isn't valid. Verify the you entered the correct ActivationId or ActivationCode and try again.InvalidActivationException
- The activation isn't valid. The activation might have been deleted, or the ActivationId and the ActivationCode don't 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
- See Also:
- AWS API Documentation
-
deleteAssociation
default DeleteAssociationResponse deleteAssociation(DeleteAssociationRequest deleteAssociationRequest) throws AssociationDoesNotExistException, InternalServerErrorException, InvalidDocumentException, InvalidInstanceIdException, TooManyUpdatesException, AwsServiceException, SdkClientException, SsmException
Disassociates the specified Amazon Web Services Systems Manager document (SSM document) from the specified managed node. If you created the association by using the
Targets
parameter, then you must delete the association by using the association ID.When you disassociate a document from a managed node, it doesn't change the configuration of the node. To change the configuration state of a managed node after you disassociate a document, you must create a new document with the desired configuration and associate it with the node.
- Parameters:
deleteAssociationRequest
-- Returns:
- Result of the DeleteAssociation operation returned by the service.
- Throws:
AssociationDoesNotExistException
- The specified association doesn't exist.InternalServerErrorException
- An error occurred on the server side.InvalidDocumentException
- The specified SSM document doesn't exist.InvalidInstanceIdException
- The following problems can cause this exception:-
You don't have permission to access the managed node.
-
Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running.
-
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
-
The managed node isn't in valid state. Valid states are:
Running
,Pending
,Stopped
, andStopping
. Invalid states are:Shutting-down
andTerminated
.
-
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
- See Also:
- AWS API Documentation
-
deleteAssociation
default DeleteAssociationResponse deleteAssociation(Consumer<DeleteAssociationRequest.Builder> deleteAssociationRequest) throws AssociationDoesNotExistException, InternalServerErrorException, InvalidDocumentException, InvalidInstanceIdException, TooManyUpdatesException, AwsServiceException, SdkClientException, SsmException
Disassociates the specified Amazon Web Services Systems Manager document (SSM document) from the specified managed node. If you created the association by using the
Targets
parameter, then you must delete the association by using the association ID.When you disassociate a document from a managed node, it doesn't change the configuration of the node. To change the configuration state of a managed node after you disassociate a document, you must create a new document with the desired configuration and associate it with the node.
This is a convenience which creates an instance of the
DeleteAssociationRequest.Builder
avoiding the need to create one manually viaDeleteAssociationRequest.builder()
- Parameters:
deleteAssociationRequest
- AConsumer
that will call methods onDeleteAssociationRequest.Builder
to create a request.- Returns:
- Result of the DeleteAssociation operation returned by the service.
- Throws:
AssociationDoesNotExistException
- The specified association doesn't exist.InternalServerErrorException
- An error occurred on the server side.InvalidDocumentException
- The specified SSM document doesn't exist.InvalidInstanceIdException
- The following problems can cause this exception:-
You don't have permission to access the managed node.
-
Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running.
-
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
-
The managed node isn't in valid state. Valid states are:
Running
,Pending
,Stopped
, andStopping
. Invalid states are:Shutting-down
andTerminated
.
-
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
- See Also:
- AWS API Documentation
-
deleteDocument
default DeleteDocumentResponse deleteDocument(DeleteDocumentRequest deleteDocumentRequest) throws InternalServerErrorException, InvalidDocumentException, InvalidDocumentOperationException, AssociatedInstancesException, AwsServiceException, SdkClientException, SsmException
Deletes the Amazon Web Services Systems Manager document (SSM document) and all managed node associations to the document.
Before you delete the document, we recommend that you use DeleteAssociation to disassociate all managed nodes that are associated with the document.
- Parameters:
deleteDocumentRequest
-- Returns:
- Result of the DeleteDocument operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidDocumentException
- The specified SSM document doesn't 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 managed nodes 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
- See Also:
- AWS API Documentation
-
deleteDocument
default DeleteDocumentResponse deleteDocument(Consumer<DeleteDocumentRequest.Builder> deleteDocumentRequest) throws InternalServerErrorException, InvalidDocumentException, InvalidDocumentOperationException, AssociatedInstancesException, AwsServiceException, SdkClientException, SsmException
Deletes the Amazon Web Services Systems Manager document (SSM document) and all managed node associations to the document.
Before you delete the document, we recommend that you use DeleteAssociation to disassociate all managed nodes 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 viaDeleteDocumentRequest.builder()
- Parameters:
deleteDocumentRequest
- AConsumer
that will call methods onDeleteDocumentRequest.Builder
to create a request.- Returns:
- Result of the DeleteDocument operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidDocumentException
- The specified SSM document doesn't 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 managed nodes 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
- See Also:
- AWS API Documentation
-
deleteInventory
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.
- Parameters:
deleteInventoryRequest
-- Returns:
- Result of the DeleteInventory operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidTypeNameException
- The parameter type name isn't valid.InvalidOptionException
- The delete inventory option specified isn't valid. Verify the option and try again.InvalidDeleteInventoryParametersException
- One or more of the parameters specified for the delete operation isn't valid. Verify all parameters and try again.InvalidInventoryRequestException
- The request isn't 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
- See Also:
- AWS API Documentation
-
deleteInventory
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 viaDeleteInventoryRequest.builder()
- Parameters:
deleteInventoryRequest
- AConsumer
that will call methods onDeleteInventoryRequest.Builder
to create a request.- Returns:
- Result of the DeleteInventory operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidTypeNameException
- The parameter type name isn't valid.InvalidOptionException
- The delete inventory option specified isn't valid. Verify the option and try again.InvalidDeleteInventoryParametersException
- One or more of the parameters specified for the delete operation isn't valid. Verify all parameters and try again.InvalidInventoryRequestException
- The request isn't 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
- See Also:
- AWS API Documentation
-
deleteMaintenanceWindow
default DeleteMaintenanceWindowResponse deleteMaintenanceWindow(DeleteMaintenanceWindowRequest deleteMaintenanceWindowRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Deletes a maintenance window.
- Parameters:
deleteMaintenanceWindowRequest
-- Returns:
- Result of the DeleteMaintenanceWindow operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
deleteMaintenanceWindow
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 viaDeleteMaintenanceWindowRequest.builder()
- Parameters:
deleteMaintenanceWindowRequest
- AConsumer
that will call methods onDeleteMaintenanceWindowRequest.Builder
to create a request.- Returns:
- Result of the DeleteMaintenanceWindow operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
deleteOpsItem
default DeleteOpsItemResponse deleteOpsItem(DeleteOpsItemRequest deleteOpsItemRequest) throws InternalServerErrorException, OpsItemInvalidParameterException, AwsServiceException, SdkClientException, SsmException
Delete an OpsItem. You must have permission in Identity and Access Management (IAM) to delete an OpsItem.
Note the following important information about this operation.
-
Deleting an OpsItem is irreversible. You can't restore a deleted OpsItem.
-
This operation uses an eventual consistency model, which means the system can take a few minutes to complete this operation. If you delete an OpsItem and immediately call, for example, GetOpsItem, the deleted OpsItem might still appear in the response.
-
This operation is idempotent. The system doesn't throw an exception if you repeatedly call this operation for the same OpsItem. If the first call is successful, all additional calls return the same successful response as the first call.
-
This operation doesn't support cross-account calls. A delegated administrator or management account can't delete OpsItems in other accounts, even if OpsCenter has been set up for cross-account administration. For more information about cross-account administration, see Setting up OpsCenter to centrally manage OpsItems across accounts in the Systems Manager User Guide.
- Parameters:
deleteOpsItemRequest
-- Returns:
- Result of the DeleteOpsItem operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.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
- See Also:
- AWS API Documentation
-
-
deleteOpsItem
default DeleteOpsItemResponse deleteOpsItem(Consumer<DeleteOpsItemRequest.Builder> deleteOpsItemRequest) throws InternalServerErrorException, OpsItemInvalidParameterException, AwsServiceException, SdkClientException, SsmException
Delete an OpsItem. You must have permission in Identity and Access Management (IAM) to delete an OpsItem.
Note the following important information about this operation.
-
Deleting an OpsItem is irreversible. You can't restore a deleted OpsItem.
-
This operation uses an eventual consistency model, which means the system can take a few minutes to complete this operation. If you delete an OpsItem and immediately call, for example, GetOpsItem, the deleted OpsItem might still appear in the response.
-
This operation is idempotent. The system doesn't throw an exception if you repeatedly call this operation for the same OpsItem. If the first call is successful, all additional calls return the same successful response as the first call.
-
This operation doesn't support cross-account calls. A delegated administrator or management account can't delete OpsItems in other accounts, even if OpsCenter has been set up for cross-account administration. For more information about cross-account administration, see Setting up OpsCenter to centrally manage OpsItems across accounts in the Systems Manager User Guide.
This is a convenience which creates an instance of the
DeleteOpsItemRequest.Builder
avoiding the need to create one manually viaDeleteOpsItemRequest.builder()
- Parameters:
deleteOpsItemRequest
- AConsumer
that will call methods onDeleteOpsItemRequest.Builder
to create a request.- Returns:
- Result of the DeleteOpsItem operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.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
- See Also:
- AWS API Documentation
-
-
deleteOpsMetadata
default DeleteOpsMetadataResponse deleteOpsMetadata(DeleteOpsMetadataRequest deleteOpsMetadataRequest) throws OpsMetadataNotFoundException, OpsMetadataInvalidArgumentException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Delete OpsMetadata related to an application.
- Parameters:
deleteOpsMetadataRequest
-- Returns:
- Result of the DeleteOpsMetadata operation returned by the service.
- Throws:
OpsMetadataNotFoundException
- The OpsMetadata object doesn't exist.OpsMetadataInvalidArgumentException
- One of the arguments passed is invalid.InternalServerErrorException
- An error occurred on the server side.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteOpsMetadata
default DeleteOpsMetadataResponse deleteOpsMetadata(Consumer<DeleteOpsMetadataRequest.Builder> deleteOpsMetadataRequest) throws OpsMetadataNotFoundException, OpsMetadataInvalidArgumentException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Delete OpsMetadata related to an application.
This is a convenience which creates an instance of the
DeleteOpsMetadataRequest.Builder
avoiding the need to create one manually viaDeleteOpsMetadataRequest.builder()
- Parameters:
deleteOpsMetadataRequest
- AConsumer
that will call methods onDeleteOpsMetadataRequest.Builder
to create a request.- Returns:
- Result of the DeleteOpsMetadata operation returned by the service.
- Throws:
OpsMetadataNotFoundException
- The OpsMetadata object doesn't exist.OpsMetadataInvalidArgumentException
- One of the arguments passed is invalid.InternalServerErrorException
- An error occurred on the server side.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteParameter
default DeleteParameterResponse deleteParameter(DeleteParameterRequest deleteParameterRequest) throws InternalServerErrorException, ParameterNotFoundException, AwsServiceException, SdkClientException, SsmException
Delete a parameter from the system. After deleting a parameter, wait for at least 30 seconds to create a parameter with the same name.
- Parameters:
deleteParameterRequest
-- Returns:
- Result of the DeleteParameter operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.ParameterNotFoundException
- The parameter couldn't 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
- See Also:
- AWS API Documentation
-
deleteParameter
default DeleteParameterResponse deleteParameter(Consumer<DeleteParameterRequest.Builder> deleteParameterRequest) throws InternalServerErrorException, ParameterNotFoundException, AwsServiceException, SdkClientException, SsmException
Delete a parameter from the system. After deleting a parameter, wait for at least 30 seconds to create a parameter with the same name.
This is a convenience which creates an instance of the
DeleteParameterRequest.Builder
avoiding the need to create one manually viaDeleteParameterRequest.builder()
- Parameters:
deleteParameterRequest
- AConsumer
that will call methods onDeleteParameterRequest.Builder
to create a request.- Returns:
- Result of the DeleteParameter operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.ParameterNotFoundException
- The parameter couldn't 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
- See Also:
- AWS API Documentation
-
deleteParameters
default DeleteParametersResponse deleteParameters(DeleteParametersRequest deleteParametersRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Delete a list of parameters. After deleting a parameter, wait for at least 30 seconds to create a parameter with the same name.
- Parameters:
deleteParametersRequest
-- Returns:
- Result of the DeleteParameters operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
deleteParameters
default DeleteParametersResponse deleteParameters(Consumer<DeleteParametersRequest.Builder> deleteParametersRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Delete a list of parameters. After deleting a parameter, wait for at least 30 seconds to create a parameter with the same name.
This is a convenience which creates an instance of the
DeleteParametersRequest.Builder
avoiding the need to create one manually viaDeleteParametersRequest.builder()
- Parameters:
deleteParametersRequest
- AConsumer
that will call methods onDeleteParametersRequest.Builder
to create a request.- Returns:
- Result of the DeleteParameters operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
deletePatchBaseline
default DeletePatchBaselineResponse deletePatchBaseline(DeletePatchBaselineRequest deletePatchBaselineRequest) throws ResourceInUseException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Deletes a patch baseline.
- Parameters:
deletePatchBaselineRequest
-- Returns:
- Result of the DeletePatchBaseline operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
deletePatchBaseline
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 viaDeletePatchBaselineRequest.builder()
- Parameters:
deletePatchBaselineRequest
- AConsumer
that will call methods onDeletePatchBaselineRequest.Builder
to create a request.- Returns:
- Result of the DeletePatchBaseline operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
deleteResourceDataSync
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 nodes are no longer synced to or from the target. Deleting a sync configuration doesn't delete data.
- Parameters:
deleteResourceDataSyncRequest
-- Returns:
- Result of the DeleteResourceDataSync operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.ResourceDataSyncNotFoundException
- The specified sync name wasn't 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
- See Also:
- AWS API Documentation
-
deleteResourceDataSync
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 nodes are no longer synced to or from the target. Deleting a sync configuration doesn't delete data.
This is a convenience which creates an instance of the
DeleteResourceDataSyncRequest.Builder
avoiding the need to create one manually viaDeleteResourceDataSyncRequest.builder()
- Parameters:
deleteResourceDataSyncRequest
- AConsumer
that will call methods onDeleteResourceDataSyncRequest.Builder
to create a request.- Returns:
- Result of the DeleteResourceDataSync operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.ResourceDataSyncNotFoundException
- The specified sync name wasn't 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
- See Also:
- AWS API Documentation
-
deleteResourcePolicy
default DeleteResourcePolicyResponse deleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest) throws InternalServerErrorException, ResourcePolicyInvalidParameterException, ResourcePolicyConflictException, AwsServiceException, SdkClientException, SsmException
Deletes a Systems Manager resource policy. A resource policy helps you to define the IAM entity (for example, an Amazon Web Services account) that can manage your Systems Manager resources. Currently,
OpsItemGroup
is the only resource that supports Systems Manager resource policies. The resource policy forOpsItemGroup
enables Amazon Web Services accounts to view and interact with OpsCenter operational work items (OpsItems).- Parameters:
deleteResourcePolicyRequest
-- Returns:
- Result of the DeleteResourcePolicy operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.ResourcePolicyInvalidParameterException
- One or more parameters specified for the call aren't valid. Verify the parameters and their values and try again.ResourcePolicyConflictException
- The hash provided in the call doesn't match the stored hash. This exception is thrown when trying to update an obsolete policy version or when multiple requests to update a policy are sent.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteResourcePolicy
default DeleteResourcePolicyResponse deleteResourcePolicy(Consumer<DeleteResourcePolicyRequest.Builder> deleteResourcePolicyRequest) throws InternalServerErrorException, ResourcePolicyInvalidParameterException, ResourcePolicyConflictException, AwsServiceException, SdkClientException, SsmException
Deletes a Systems Manager resource policy. A resource policy helps you to define the IAM entity (for example, an Amazon Web Services account) that can manage your Systems Manager resources. Currently,
OpsItemGroup
is the only resource that supports Systems Manager resource policies. The resource policy forOpsItemGroup
enables Amazon Web Services accounts to view and interact with OpsCenter operational work items (OpsItems).
This is a convenience which creates an instance of the
DeleteResourcePolicyRequest.Builder
avoiding the need to create one manually viaDeleteResourcePolicyRequest.builder()
- Parameters:
deleteResourcePolicyRequest
- AConsumer
that will call methods onDeleteResourcePolicyRequest.Builder
to create a request.- Returns:
- Result of the DeleteResourcePolicy operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.ResourcePolicyInvalidParameterException
- One or more parameters specified for the call aren't valid. Verify the parameters and their values and try again.ResourcePolicyConflictException
- The hash provided in the call doesn't match the stored hash. This exception is thrown when trying to update an obsolete policy version or when multiple requests to update a policy are sent.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deregisterManagedInstance
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 node again at any time. If you don't plan to use Run Command on the server, we suggest uninstalling SSM Agent first.
- Parameters:
deregisterManagedInstanceRequest
-- Returns:
- Result of the DeregisterManagedInstance operation returned by the service.
- Throws:
InvalidInstanceIdException
- The following problems can cause this exception:-
You don't have permission to access the managed node.
-
Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running.
-
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
-
The managed node isn't in valid state. Valid states are:
Running
,Pending
,Stopped
, andStopping
. Invalid states are:Shutting-down
andTerminated
.
-
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
- See Also:
- AWS API Documentation
-
deregisterManagedInstance
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 node 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 viaDeregisterManagedInstanceRequest.builder()
- Parameters:
deregisterManagedInstanceRequest
- AConsumer
that will call methods onDeregisterManagedInstanceRequest.Builder
to create a request.- Returns:
- Result of the DeregisterManagedInstance operation returned by the service.
- Throws:
InvalidInstanceIdException
- The following problems can cause this exception:-
You don't have permission to access the managed node.
-
Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running.
-
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
-
The managed node isn't in valid state. Valid states are:
Running
,Pending
,Stopped
, andStopping
. Invalid states are:Shutting-down
andTerminated
.
-
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
- See Also:
- AWS API Documentation
-
deregisterPatchBaselineForPatchGroup
default DeregisterPatchBaselineForPatchGroupResponse deregisterPatchBaselineForPatchGroup(DeregisterPatchBaselineForPatchGroupRequest deregisterPatchBaselineForPatchGroupRequest) throws InvalidResourceIdException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Removes a patch group from a patch baseline.
- Parameters:
deregisterPatchBaselineForPatchGroupRequest
-- Returns:
- Result of the DeregisterPatchBaselineForPatchGroup operation returned by the service.
- Throws:
InvalidResourceIdException
- The resource ID isn't 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
- See Also:
- AWS API Documentation
-
deregisterPatchBaselineForPatchGroup
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 viaDeregisterPatchBaselineForPatchGroupRequest.builder()
- Parameters:
deregisterPatchBaselineForPatchGroupRequest
- AConsumer
that will call methods onDeregisterPatchBaselineForPatchGroupRequest.Builder
to create a request.- Returns:
- Result of the DeregisterPatchBaselineForPatchGroup operation returned by the service.
- Throws:
InvalidResourceIdException
- The resource ID isn't 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
- See Also:
- AWS API Documentation
-
deregisterTargetFromMaintenanceWindow
default DeregisterTargetFromMaintenanceWindowResponse deregisterTargetFromMaintenanceWindow(DeregisterTargetFromMaintenanceWindowRequest deregisterTargetFromMaintenanceWindowRequest) throws DoesNotExistException, InternalServerErrorException, TargetInUseException, AwsServiceException, SdkClientException, SsmException
Removes a target from a maintenance window.
- Parameters:
deregisterTargetFromMaintenanceWindowRequest
-- Returns:
- Result of the DeregisterTargetFromMaintenanceWindow operation returned by the service.
- Throws:
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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.
InternalServerErrorException
- An error occurred on the server side.TargetInUseException
- You specified theSafe
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
- See Also:
- AWS API Documentation
-
deregisterTargetFromMaintenanceWindow
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 viaDeregisterTargetFromMaintenanceWindowRequest.builder()
- Parameters:
deregisterTargetFromMaintenanceWindowRequest
- AConsumer
that will call methods onDeregisterTargetFromMaintenanceWindowRequest.Builder
to create a request.- Returns:
- Result of the DeregisterTargetFromMaintenanceWindow operation returned by the service.
- Throws:
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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.
InternalServerErrorException
- An error occurred on the server side.TargetInUseException
- You specified theSafe
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
- See Also:
- AWS API Documentation
-
deregisterTaskFromMaintenanceWindow
default DeregisterTaskFromMaintenanceWindowResponse deregisterTaskFromMaintenanceWindow(DeregisterTaskFromMaintenanceWindowRequest deregisterTaskFromMaintenanceWindowRequest) throws DoesNotExistException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Removes a task from a maintenance window.
- Parameters:
deregisterTaskFromMaintenanceWindowRequest
-- Returns:
- Result of the DeregisterTaskFromMaintenanceWindow operation returned by the service.
- Throws:
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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services 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
- See Also:
- AWS API Documentation
-
deregisterTaskFromMaintenanceWindow
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 viaDeregisterTaskFromMaintenanceWindowRequest.builder()
- Parameters:
deregisterTaskFromMaintenanceWindowRequest
- AConsumer
that will call methods onDeregisterTaskFromMaintenanceWindowRequest.Builder
to create a request.- Returns:
- Result of the DeregisterTaskFromMaintenanceWindow operation returned by the service.
- Throws:
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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services 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
- See Also:
- AWS API Documentation
-
describeActivations
default 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 Identity and Access Management (IAM) role assigned to the managed nodes in the activation, and the number of nodes registered by using this activation.
- Parameters:
describeActivationsRequest
-- Returns:
- Result of the DescribeActivations operation returned by the service.
- Throws:
InvalidFilterException
- The filter name isn't valid. Verify the you entered the correct name and try again.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
describeActivations
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 Identity and Access Management (IAM) role assigned to the managed nodes in the activation, and the number of nodes registered by using this activation.
This is a convenience which creates an instance of the
DescribeActivationsRequest.Builder
avoiding the need to create one manually viaDescribeActivationsRequest.builder()
- Parameters:
describeActivationsRequest
- AConsumer
that will call methods onDescribeActivationsRequest.Builder
to create a request.- Returns:
- Result of the DescribeActivations operation returned by the service.
- Throws:
InvalidFilterException
- The filter name isn't valid. Verify the you entered the correct name and try again.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
describeActivations
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 Identity and Access Management (IAM) role assigned to the managed nodes in the activation, and the number of nodes registered by using this activation.
- Returns:
- Result of the DescribeActivations operation returned by the service.
- Throws:
InvalidFilterException
- The filter name isn't valid. Verify the you entered the correct name and try again.InvalidNextTokenException
- The specified token isn't 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
- See Also:
describeActivations(DescribeActivationsRequest)
, AWS API Documentation
-
describeActivationsPaginator
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 Identity and Access Management (IAM) role assigned to the managed nodes in the activation, and the number of nodes 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 Streamsoftware.amazon.awssdk.services.ssm.paginators.DescribeActivationsIterable responses = client.describeActivationsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidFilterException
- The filter name isn't valid. Verify the you entered the correct name and try again.InvalidNextTokenException
- The specified token isn't 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
- See Also:
describeActivationsPaginator(DescribeActivationsRequest)
, AWS API Documentation
-
describeActivationsPaginator
default 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 Identity and Access Management (IAM) role assigned to the managed nodes in the activation, and the number of nodes 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 Streamsoftware.amazon.awssdk.services.ssm.paginators.DescribeActivationsIterable responses = client.describeActivationsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
describeActivationsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidFilterException
- The filter name isn't valid. Verify the you entered the correct name and try again.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
describeActivationsPaginator
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 Identity and Access Management (IAM) role assigned to the managed nodes in the activation, and the number of nodes 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 Streamsoftware.amazon.awssdk.services.ssm.paginators.DescribeActivationsIterable responses = client.describeActivationsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaDescribeActivationsRequest.builder()
- Parameters:
describeActivationsRequest
- AConsumer
that will call methods onDescribeActivationsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidFilterException
- The filter name isn't valid. Verify the you entered the correct name and try again.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
describeAssociation
default DescribeAssociationResponse describeAssociation(DescribeAssociationRequest describeAssociationRequest) throws AssociationDoesNotExistException, InvalidAssociationVersionException, InternalServerErrorException, InvalidDocumentException, InvalidInstanceIdException, AwsServiceException, SdkClientException, SsmException
Describes the association for the specified target or managed node. If you created the association by using the
Targets
parameter, then you must retrieve the association by using the association ID.- Parameters:
describeAssociationRequest
-- Returns:
- Result of the DescribeAssociation operation returned by the service.
- Throws:
AssociationDoesNotExistException
- The specified association doesn't exist.InvalidAssociationVersionException
- The version you specified isn't 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 SSM document doesn't exist.InvalidInstanceIdException
- The following problems can cause this exception:-
You don't have permission to access the managed node.
-
Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running.
-
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
-
The managed node isn't in valid state. Valid states are:
Running
,Pending
,Stopped
, andStopping
. Invalid states are:Shutting-down
andTerminated
.
-
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeAssociation
default DescribeAssociationResponse describeAssociation(Consumer<DescribeAssociationRequest.Builder> describeAssociationRequest) throws AssociationDoesNotExistException, InvalidAssociationVersionException, InternalServerErrorException, InvalidDocumentException, InvalidInstanceIdException, AwsServiceException, SdkClientException, SsmException
Describes the association for the specified target or managed node. If you created the association by using the
Targets
parameter, then you must retrieve the association by using the association ID.
This is a convenience which creates an instance of the
DescribeAssociationRequest.Builder
avoiding the need to create one manually viaDescribeAssociationRequest.builder()
- Parameters:
describeAssociationRequest
- AConsumer
that will call methods onDescribeAssociationRequest.Builder
to create a request.- Returns:
- Result of the DescribeAssociation operation returned by the service.
- Throws:
AssociationDoesNotExistException
- The specified association doesn't exist.InvalidAssociationVersionException
- The version you specified isn't 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 SSM document doesn't exist.InvalidInstanceIdException
- The following problems can cause this exception:-
You don't have permission to access the managed node.
-
Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running.
-
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
-
The managed node isn't in valid state. Valid states are:
Running
,Pending
,Stopped
, andStopping
. Invalid states are:Shutting-down
andTerminated
.
-
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeAssociationExecutionTargets
default DescribeAssociationExecutionTargetsResponse describeAssociationExecutionTargets(DescribeAssociationExecutionTargetsRequest describeAssociationExecutionTargetsRequest) throws InternalServerErrorException, AssociationDoesNotExistException, InvalidNextTokenException, AssociationExecutionDoesNotExistException, AwsServiceException, SdkClientException, SsmException
Views information about a specific execution of a specific association.
- Parameters:
describeAssociationExecutionTargetsRequest
-- Returns:
- Result of the DescribeAssociationExecutionTargets operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.AssociationDoesNotExistException
- The specified association doesn't exist.InvalidNextTokenException
- The specified token isn't valid.AssociationExecutionDoesNotExistException
- The specified execution ID doesn't 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
- See Also:
- AWS API Documentation
-
describeAssociationExecutionTargets
default DescribeAssociationExecutionTargetsResponse describeAssociationExecutionTargets(Consumer<DescribeAssociationExecutionTargetsRequest.Builder> describeAssociationExecutionTargetsRequest) throws InternalServerErrorException, AssociationDoesNotExistException, InvalidNextTokenException, AssociationExecutionDoesNotExistException, AwsServiceException, SdkClientException, SsmException
Views 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 viaDescribeAssociationExecutionTargetsRequest.builder()
- Parameters:
describeAssociationExecutionTargetsRequest
- AConsumer
that will call methods onDescribeAssociationExecutionTargetsRequest.Builder
to create a request.- Returns:
- Result of the DescribeAssociationExecutionTargets operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.AssociationDoesNotExistException
- The specified association doesn't exist.InvalidNextTokenException
- The specified token isn't valid.AssociationExecutionDoesNotExistException
- The specified execution ID doesn't 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
- See Also:
- AWS API Documentation
-
describeAssociationExecutionTargetsPaginator
default DescribeAssociationExecutionTargetsIterable describeAssociationExecutionTargetsPaginator(DescribeAssociationExecutionTargetsRequest describeAssociationExecutionTargetsRequest) throws InternalServerErrorException, AssociationDoesNotExistException, InvalidNextTokenException, AssociationExecutionDoesNotExistException, AwsServiceException, SdkClientException, SsmException
Views 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 Streamsoftware.amazon.awssdk.services.ssm.paginators.DescribeAssociationExecutionTargetsIterable responses = client.describeAssociationExecutionTargetsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
describeAssociationExecutionTargetsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerErrorException
- An error occurred on the server side.AssociationDoesNotExistException
- The specified association doesn't exist.InvalidNextTokenException
- The specified token isn't valid.AssociationExecutionDoesNotExistException
- The specified execution ID doesn't 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
- See Also:
- AWS API Documentation
-
describeAssociationExecutionTargetsPaginator
default DescribeAssociationExecutionTargetsIterable describeAssociationExecutionTargetsPaginator(Consumer<DescribeAssociationExecutionTargetsRequest.Builder> describeAssociationExecutionTargetsRequest) throws InternalServerErrorException, AssociationDoesNotExistException, InvalidNextTokenException, AssociationExecutionDoesNotExistException, AwsServiceException, SdkClientException, SsmException
Views 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 Streamsoftware.amazon.awssdk.services.ssm.paginators.DescribeAssociationExecutionTargetsIterable responses = client.describeAssociationExecutionTargetsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaDescribeAssociationExecutionTargetsRequest.builder()
- Parameters:
describeAssociationExecutionTargetsRequest
- AConsumer
that will call methods onDescribeAssociationExecutionTargetsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerErrorException
- An error occurred on the server side.AssociationDoesNotExistException
- The specified association doesn't exist.InvalidNextTokenException
- The specified token isn't valid.AssociationExecutionDoesNotExistException
- The specified execution ID doesn't 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
- See Also:
- AWS API Documentation
-
describeAssociationExecutions
default DescribeAssociationExecutionsResponse describeAssociationExecutions(DescribeAssociationExecutionsRequest describeAssociationExecutionsRequest) throws InternalServerErrorException, AssociationDoesNotExistException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Views all executions for a specific association ID.
- Parameters:
describeAssociationExecutionsRequest
-- Returns:
- Result of the DescribeAssociationExecutions operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.AssociationDoesNotExistException
- The specified association doesn't exist.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
describeAssociationExecutions
default DescribeAssociationExecutionsResponse describeAssociationExecutions(Consumer<DescribeAssociationExecutionsRequest.Builder> describeAssociationExecutionsRequest) throws InternalServerErrorException, AssociationDoesNotExistException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Views 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 viaDescribeAssociationExecutionsRequest.builder()
- Parameters:
describeAssociationExecutionsRequest
- AConsumer
that will call methods onDescribeAssociationExecutionsRequest.Builder
to create a request.- Returns:
- Result of the DescribeAssociationExecutions operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.AssociationDoesNotExistException
- The specified association doesn't exist.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
describeAssociationExecutionsPaginator
default DescribeAssociationExecutionsIterable describeAssociationExecutionsPaginator(DescribeAssociationExecutionsRequest describeAssociationExecutionsRequest) throws InternalServerErrorException, AssociationDoesNotExistException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Views 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 Streamsoftware.amazon.awssdk.services.ssm.paginators.DescribeAssociationExecutionsIterable responses = client.describeAssociationExecutionsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
describeAssociationExecutionsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerErrorException
- An error occurred on the server side.AssociationDoesNotExistException
- The specified association doesn't exist.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
describeAssociationExecutionsPaginator
default DescribeAssociationExecutionsIterable describeAssociationExecutionsPaginator(Consumer<DescribeAssociationExecutionsRequest.Builder> describeAssociationExecutionsRequest) throws InternalServerErrorException, AssociationDoesNotExistException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Views 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 Streamsoftware.amazon.awssdk.services.ssm.paginators.DescribeAssociationExecutionsIterable responses = client.describeAssociationExecutionsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaDescribeAssociationExecutionsRequest.builder()
- Parameters:
describeAssociationExecutionsRequest
- AConsumer
that will call methods onDescribeAssociationExecutionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerErrorException
- An error occurred on the server side.AssociationDoesNotExistException
- The specified association doesn't exist.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
describeAutomationExecutions
default DescribeAutomationExecutionsResponse describeAutomationExecutions(DescribeAutomationExecutionsRequest describeAutomationExecutionsRequest) throws InvalidFilterKeyException, InvalidFilterValueException, InvalidNextTokenException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Provides details about all active and terminated Automation executions.
- Parameters:
describeAutomationExecutionsRequest
-- Returns:
- Result of the DescribeAutomationExecutions operation returned by the service.
- Throws:
InvalidFilterKeyException
- The specified key isn't valid.InvalidFilterValueException
- The filter value isn't valid. Verify the value and try again.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
describeAutomationExecutions
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 viaDescribeAutomationExecutionsRequest.builder()
- Parameters:
describeAutomationExecutionsRequest
- AConsumer
that will call methods onDescribeAutomationExecutionsRequest.Builder
to create a request.- Returns:
- Result of the DescribeAutomationExecutions operation returned by the service.
- Throws:
InvalidFilterKeyException
- The specified key isn't valid.InvalidFilterValueException
- The filter value isn't valid. Verify the value and try again.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
describeAutomationExecutions
default DescribeAutomationExecutionsResponse describeAutomationExecutions() throws InvalidFilterKeyException, InvalidFilterValueException, InvalidNextTokenException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Provides details about all active and terminated Automation executions.
- Returns:
- Result of the DescribeAutomationExecutions operation returned by the service.
- Throws:
InvalidFilterKeyException
- The specified key isn't valid.InvalidFilterValueException
- The filter value isn't valid. Verify the value and try again.InvalidNextTokenException
- The specified token isn't 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
- See Also:
describeAutomationExecutions(DescribeAutomationExecutionsRequest)
, AWS API Documentation
-
describeAutomationExecutionsPaginator
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 Streamsoftware.amazon.awssdk.services.ssm.paginators.DescribeAutomationExecutionsIterable responses = client.describeAutomationExecutionsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidFilterKeyException
- The specified key isn't valid.InvalidFilterValueException
- The filter value isn't valid. Verify the value and try again.InvalidNextTokenException
- The specified token isn't 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
- See Also:
describeAutomationExecutionsPaginator(DescribeAutomationExecutionsRequest)
, AWS API Documentation
-
describeAutomationExecutionsPaginator
default 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 Streamsoftware.amazon.awssdk.services.ssm.paginators.DescribeAutomationExecutionsIterable responses = client.describeAutomationExecutionsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
describeAutomationExecutionsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidFilterKeyException
- The specified key isn't valid.InvalidFilterValueException
- The filter value isn't valid. Verify the value and try again.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
describeAutomationExecutionsPaginator
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 Streamsoftware.amazon.awssdk.services.ssm.paginators.DescribeAutomationExecutionsIterable responses = client.describeAutomationExecutionsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaDescribeAutomationExecutionsRequest.builder()
- Parameters:
describeAutomationExecutionsRequest
- AConsumer
that will call methods onDescribeAutomationExecutionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidFilterKeyException
- The specified key isn't valid.InvalidFilterValueException
- The filter value isn't valid. Verify the value and try again.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
describeAutomationStepExecutions
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.
- Parameters:
describeAutomationStepExecutionsRequest
-- Returns:
- Result of the DescribeAutomationStepExecutions operation returned by the service.
- Throws:
AutomationExecutionNotFoundException
- There is no automation execution information for the requested automation execution ID.InvalidNextTokenException
- The specified token isn't valid.InvalidFilterKeyException
- The specified key isn't valid.InvalidFilterValueException
- The filter value isn't 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
- See Also:
- AWS API Documentation
-
describeAutomationStepExecutions
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 viaDescribeAutomationStepExecutionsRequest.builder()
- Parameters:
describeAutomationStepExecutionsRequest
- AConsumer
that will call methods onDescribeAutomationStepExecutionsRequest.Builder
to create a request.- Returns:
- Result of the DescribeAutomationStepExecutions operation returned by the service.
- Throws:
AutomationExecutionNotFoundException
- There is no automation execution information for the requested automation execution ID.InvalidNextTokenException
- The specified token isn't valid.InvalidFilterKeyException
- The specified key isn't valid.InvalidFilterValueException
- The filter value isn't 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
- See Also:
- AWS API Documentation
-
describeAutomationStepExecutionsPaginator
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 Streamsoftware.amazon.awssdk.services.ssm.paginators.DescribeAutomationStepExecutionsIterable responses = client.describeAutomationStepExecutionsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
describeAutomationStepExecutionsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
AutomationExecutionNotFoundException
- There is no automation execution information for the requested automation execution ID.InvalidNextTokenException
- The specified token isn't valid.InvalidFilterKeyException
- The specified key isn't valid.InvalidFilterValueException
- The filter value isn't 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
- See Also:
- AWS API Documentation
-
describeAutomationStepExecutionsPaginator
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 Streamsoftware.amazon.awssdk.services.ssm.paginators.DescribeAutomationStepExecutionsIterable responses = client.describeAutomationStepExecutionsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaDescribeAutomationStepExecutionsRequest.builder()
- Parameters:
describeAutomationStepExecutionsRequest
- AConsumer
that will call methods onDescribeAutomationStepExecutionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
AutomationExecutionNotFoundException
- There is no automation execution information for the requested automation execution ID.InvalidNextTokenException
- The specified token isn't valid.InvalidFilterKeyException
- The specified key isn't valid.InvalidFilterValueException
- The filter value isn't 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
- See Also:
- AWS API Documentation
-
describeAvailablePatches
default DescribeAvailablePatchesResponse describeAvailablePatches(DescribeAvailablePatchesRequest describeAvailablePatchesRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Lists all patches eligible to be included in a patch baseline.
- Parameters:
describeAvailablePatchesRequest
-- Returns:
- Result of the DescribeAvailablePatches operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
describeAvailablePatches
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 viaDescribeAvailablePatchesRequest.builder()
- Parameters:
describeAvailablePatchesRequest
- AConsumer
that will call methods onDescribeAvailablePatchesRequest.Builder
to create a request.- Returns:
- Result of the DescribeAvailablePatches operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
describeAvailablePatches
default DescribeAvailablePatchesResponse describeAvailablePatches() throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Lists all patches eligible to be included in a patch baseline.
- Returns:
- Result of the DescribeAvailablePatches operation returned by the service.
- Throws:
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
- See Also:
describeAvailablePatches(DescribeAvailablePatchesRequest)
, AWS API Documentation
-
describeAvailablePatchesPaginator
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 Streamsoftware.amazon.awssdk.services.ssm.paginators.DescribeAvailablePatchesIterable responses = client.describeAvailablePatchesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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
- See Also:
describeAvailablePatchesPaginator(DescribeAvailablePatchesRequest)
, AWS API Documentation
-
describeAvailablePatchesPaginator
default 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 Streamsoftware.amazon.awssdk.services.ssm.paginators.DescribeAvailablePatchesIterable responses = client.describeAvailablePatchesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
describeAvailablePatchesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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
- See Also:
- AWS API Documentation
-
describeAvailablePatchesPaginator
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 Streamsoftware.amazon.awssdk.services.ssm.paginators.DescribeAvailablePatchesIterable responses = client.describeAvailablePatchesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaDescribeAvailablePatchesRequest.builder()
- Parameters:
describeAvailablePatchesRequest
- AConsumer
that will call methods onDescribeAvailablePatchesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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
- See Also:
- AWS API Documentation
-
describeDocument
default DescribeDocumentResponse describeDocument(DescribeDocumentRequest describeDocumentRequest) throws InternalServerErrorException, InvalidDocumentException, InvalidDocumentVersionException, AwsServiceException, SdkClientException, SsmException
Describes the specified Amazon Web Services Systems Manager document (SSM document).
- Parameters:
describeDocumentRequest
-- Returns:
- Result of the DescribeDocument operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidDocumentException
- The specified SSM document doesn't exist.InvalidDocumentVersionException
- The document version isn't valid or doesn't 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
- See Also:
- AWS API Documentation
-
describeDocument
default DescribeDocumentResponse describeDocument(Consumer<DescribeDocumentRequest.Builder> describeDocumentRequest) throws InternalServerErrorException, InvalidDocumentException, InvalidDocumentVersionException, AwsServiceException, SdkClientException, SsmException
Describes the specified Amazon Web Services Systems Manager document (SSM document).
This is a convenience which creates an instance of the
DescribeDocumentRequest.Builder
avoiding the need to create one manually viaDescribeDocumentRequest.builder()
- Parameters:
describeDocumentRequest
- AConsumer
that will call methods onDescribeDocumentRequest.Builder
to create a request.- Returns:
- Result of the DescribeDocument operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidDocumentException
- The specified SSM document doesn't exist.InvalidDocumentVersionException
- The document version isn't valid or doesn't 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
- See Also:
- AWS API Documentation
-
describeDocumentPermission
default DescribeDocumentPermissionResponse describeDocumentPermission(DescribeDocumentPermissionRequest describeDocumentPermissionRequest) throws InternalServerErrorException, InvalidDocumentException, InvalidNextTokenException, InvalidPermissionTypeException, InvalidDocumentOperationException, AwsServiceException, SdkClientException, SsmException
Describes the permissions for a Amazon Web Services Systems Manager document (SSM document). If you created the document, you are the owner. If a document is shared, it can either be shared privately (by specifying a user's Amazon Web Services account ID) or publicly (All).
- Parameters:
describeDocumentPermissionRequest
-- Returns:
- Result of the DescribeDocumentPermission operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidDocumentException
- The specified SSM document doesn't exist.InvalidNextTokenException
- The specified token isn't valid.InvalidPermissionTypeException
- The permission type isn't supported. Share is the only supported permission type.InvalidDocumentOperationException
- You attempted to delete a document while it is still shared. You must stop sharing the document before you can delete it.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeDocumentPermission
default DescribeDocumentPermissionResponse describeDocumentPermission(Consumer<DescribeDocumentPermissionRequest.Builder> describeDocumentPermissionRequest) throws InternalServerErrorException, InvalidDocumentException, InvalidNextTokenException, InvalidPermissionTypeException, InvalidDocumentOperationException, AwsServiceException, SdkClientException, SsmException
Describes the permissions for a Amazon Web Services Systems Manager document (SSM document). If you created the document, you are the owner. If a document is shared, it can either be shared privately (by specifying a user's Amazon Web Services account ID) or publicly (All).
This is a convenience which creates an instance of the
DescribeDocumentPermissionRequest.Builder
avoiding the need to create one manually viaDescribeDocumentPermissionRequest.builder()
- Parameters:
describeDocumentPermissionRequest
- AConsumer
that will call methods onDescribeDocumentPermissionRequest.Builder
to create a request.- Returns:
- Result of the DescribeDocumentPermission operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidDocumentException
- The specified SSM document doesn't exist.InvalidNextTokenException
- The specified token isn't valid.InvalidPermissionTypeException
- The permission type isn't supported. Share is the only supported permission type.InvalidDocumentOperationException
- You attempted to delete a document while it is still shared. You must stop sharing the document before you can delete it.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeEffectiveInstanceAssociations
default DescribeEffectiveInstanceAssociationsResponse describeEffectiveInstanceAssociations(DescribeEffectiveInstanceAssociationsRequest describeEffectiveInstanceAssociationsRequest) throws InternalServerErrorException, InvalidInstanceIdException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
All associations for the managed node(s).
- Parameters:
describeEffectiveInstanceAssociationsRequest
-- Returns:
- Result of the DescribeEffectiveInstanceAssociations operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidInstanceIdException
- The following problems can cause this exception:-
You don't have permission to access the managed node.
-
Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running.
-
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
-
The managed node isn't in valid state. Valid states are:
Running
,Pending
,Stopped
, andStopping
. Invalid states are:Shutting-down
andTerminated
.
-
InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
describeEffectiveInstanceAssociations
default DescribeEffectiveInstanceAssociationsResponse describeEffectiveInstanceAssociations(Consumer<DescribeEffectiveInstanceAssociationsRequest.Builder> describeEffectiveInstanceAssociationsRequest) throws InternalServerErrorException, InvalidInstanceIdException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
All associations for the managed node(s).
This is a convenience which creates an instance of the
DescribeEffectiveInstanceAssociationsRequest.Builder
avoiding the need to create one manually viaDescribeEffectiveInstanceAssociationsRequest.builder()
- Parameters:
describeEffectiveInstanceAssociationsRequest
- AConsumer
that will call methods onDescribeEffectiveInstanceAssociationsRequest.Builder
to create a request.- Returns:
- Result of the DescribeEffectiveInstanceAssociations operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidInstanceIdException
- The following problems can cause this exception:-
You don't have permission to access the managed node.
-
Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running.
-
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
-
The managed node isn't in valid state. Valid states are:
Running
,Pending
,Stopped
, andStopping
. Invalid states are:Shutting-down
andTerminated
.
-
InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
describeEffectiveInstanceAssociationsPaginator
default DescribeEffectiveInstanceAssociationsIterable describeEffectiveInstanceAssociationsPaginator(DescribeEffectiveInstanceAssociationsRequest describeEffectiveInstanceAssociationsRequest) throws InternalServerErrorException, InvalidInstanceIdException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
All associations for the managed node(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 Streamsoftware.amazon.awssdk.services.ssm.paginators.DescribeEffectiveInstanceAssociationsIterable responses = client.describeEffectiveInstanceAssociationsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
describeEffectiveInstanceAssociationsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidInstanceIdException
- The following problems can cause this exception:-
You don't have permission to access the managed node.
-
Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running.
-
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
-
The managed node isn't in valid state. Valid states are:
Running
,Pending
,Stopped
, andStopping
. Invalid states are:Shutting-down
andTerminated
.
-
InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
describeEffectiveInstanceAssociationsPaginator
default DescribeEffectiveInstanceAssociationsIterable describeEffectiveInstanceAssociationsPaginator(Consumer<DescribeEffectiveInstanceAssociationsRequest.Builder> describeEffectiveInstanceAssociationsRequest) throws InternalServerErrorException, InvalidInstanceIdException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
All associations for the managed node(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 Streamsoftware.amazon.awssdk.services.ssm.paginators.DescribeEffectiveInstanceAssociationsIterable responses = client.describeEffectiveInstanceAssociationsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaDescribeEffectiveInstanceAssociationsRequest.builder()
- Parameters:
describeEffectiveInstanceAssociationsRequest
- AConsumer
that will call methods onDescribeEffectiveInstanceAssociationsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidInstanceIdException
- The following problems can cause this exception:-
You don't have permission to access the managed node.
-
Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running.
-
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
-
The managed node isn't in valid state. Valid states are:
Running
,Pending
,Stopped
, andStopping
. Invalid states are:Shutting-down
andTerminated
.
-
InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
describeEffectivePatchesForPatchBaseline
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. Applies to patch baselines for Windows only.
- Parameters:
describeEffectivePatchesForPatchBaselineRequest
-- Returns:
- Result of the DescribeEffectivePatchesForPatchBaseline operation returned by the service.
- Throws:
InvalidResourceIdException
- The resource ID isn't 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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.
UnsupportedOperatingSystemException
- The operating systems you specified isn't supported, or the operation isn't supported for the operating system.InternalServerErrorException
- An error occurred on the server side.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeEffectivePatchesForPatchBaseline
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. Applies to patch baselines for Windows only.
This is a convenience which creates an instance of the
DescribeEffectivePatchesForPatchBaselineRequest.Builder
avoiding the need to create one manually viaDescribeEffectivePatchesForPatchBaselineRequest.builder()
- Parameters:
describeEffectivePatchesForPatchBaselineRequest
- AConsumer
that will call methods onDescribeEffectivePatchesForPatchBaselineRequest.Builder
to create a request.- Returns:
- Result of the DescribeEffectivePatchesForPatchBaseline operation returned by the service.
- Throws:
InvalidResourceIdException
- The resource ID isn't 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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.
UnsupportedOperatingSystemException
- The operating systems you specified isn't supported, or the operation isn't supported for the operating system.InternalServerErrorException
- An error occurred on the server side.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeEffectivePatchesForPatchBaselinePaginator
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. Applies to patch baselines for Windows only.
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 Streamsoftware.amazon.awssdk.services.ssm.paginators.DescribeEffectivePatchesForPatchBaselineIterable responses = client.describeEffectivePatchesForPatchBaselinePaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
describeEffectivePatchesForPatchBaselineRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidResourceIdException
- The resource ID isn't 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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.
UnsupportedOperatingSystemException
- The operating systems you specified isn't supported, or the operation isn't supported for the operating system.InternalServerErrorException
- An error occurred on the server side.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeEffectivePatchesForPatchBaselinePaginator
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. Applies to patch baselines for Windows only.
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 Streamsoftware.amazon.awssdk.services.ssm.paginators.DescribeEffectivePatchesForPatchBaselineIterable responses = client.describeEffectivePatchesForPatchBaselinePaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaDescribeEffectivePatchesForPatchBaselineRequest.builder()
- Parameters:
describeEffectivePatchesForPatchBaselineRequest
- AConsumer
that will call methods onDescribeEffectivePatchesForPatchBaselineRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidResourceIdException
- The resource ID isn't 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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.
UnsupportedOperatingSystemException
- The operating systems you specified isn't supported, or the operation isn't supported for the operating system.InternalServerErrorException
- An error occurred on the server side.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeInstanceAssociationsStatus
default DescribeInstanceAssociationsStatusResponse describeInstanceAssociationsStatus(DescribeInstanceAssociationsStatusRequest describeInstanceAssociationsStatusRequest) throws InternalServerErrorException, InvalidInstanceIdException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
The status of the associations for the managed node(s).
- Parameters:
describeInstanceAssociationsStatusRequest
-- Returns:
- Result of the DescribeInstanceAssociationsStatus operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidInstanceIdException
- The following problems can cause this exception:-
You don't have permission to access the managed node.
-
Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running.
-
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
-
The managed node isn't in valid state. Valid states are:
Running
,Pending
,Stopped
, andStopping
. Invalid states are:Shutting-down
andTerminated
.
-
InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
describeInstanceAssociationsStatus
default DescribeInstanceAssociationsStatusResponse describeInstanceAssociationsStatus(Consumer<DescribeInstanceAssociationsStatusRequest.Builder> describeInstanceAssociationsStatusRequest) throws InternalServerErrorException, InvalidInstanceIdException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
The status of the associations for the managed node(s).
This is a convenience which creates an instance of the
DescribeInstanceAssociationsStatusRequest.Builder
avoiding the need to create one manually viaDescribeInstanceAssociationsStatusRequest.builder()
- Parameters:
describeInstanceAssociationsStatusRequest
- AConsumer
that will call methods onDescribeInstanceAssociationsStatusRequest.Builder
to create a request.- Returns:
- Result of the DescribeInstanceAssociationsStatus operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidInstanceIdException
- The following problems can cause this exception:-
You don't have permission to access the managed node.
-
Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running.
-
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
-
The managed node isn't in valid state. Valid states are:
Running
,Pending
,Stopped
, andStopping
. Invalid states are:Shutting-down
andTerminated
.
-
InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
describeInstanceAssociationsStatusPaginator
default DescribeInstanceAssociationsStatusIterable describeInstanceAssociationsStatusPaginator(DescribeInstanceAssociationsStatusRequest describeInstanceAssociationsStatusRequest) throws InternalServerErrorException, InvalidInstanceIdException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
The status of the associations for the managed node(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 Streamsoftware.amazon.awssdk.services.ssm.paginators.DescribeInstanceAssociationsStatusIterable responses = client.describeInstanceAssociationsStatusPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
describeInstanceAssociationsStatusRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidInstanceIdException
- The following problems can cause this exception:-
You don't have permission to access the managed node.
-
Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running.
-
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
-
The managed node isn't in valid state. Valid states are:
Running
,Pending
,Stopped
, andStopping
. Invalid states are:Shutting-down
andTerminated
.
-
InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
describeInstanceAssociationsStatusPaginator
default DescribeInstanceAssociationsStatusIterable describeInstanceAssociationsStatusPaginator(Consumer<DescribeInstanceAssociationsStatusRequest.Builder> describeInstanceAssociationsStatusRequest) throws InternalServerErrorException, InvalidInstanceIdException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
The status of the associations for the managed node(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 Streamsoftware.amazon.awssdk.services.ssm.paginators.DescribeInstanceAssociationsStatusIterable responses = client.describeInstanceAssociationsStatusPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaDescribeInstanceAssociationsStatusRequest.builder()
- Parameters:
describeInstanceAssociationsStatusRequest
- AConsumer
that will call methods onDescribeInstanceAssociationsStatusRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidInstanceIdException
- The following problems can cause this exception:-
You don't have permission to access the managed node.
-
Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running.
-
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
-
The managed node isn't in valid state. Valid states are:
Running
,Pending
,Stopped
, andStopping
. Invalid states are:Shutting-down
andTerminated
.
-
InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
describeInstanceInformation
default DescribeInstanceInformationResponse describeInstanceInformation(DescribeInstanceInformationRequest describeInstanceInformationRequest) throws InternalServerErrorException, InvalidInstanceIdException, InvalidNextTokenException, InvalidInstanceInformationFilterValueException, InvalidFilterKeyException, AwsServiceException, SdkClientException, SsmException
Provides information about one or more of your managed nodes, including the operating system platform, SSM Agent version, association status, and IP address. This operation does not return information for nodes that are either Stopped or Terminated.
If you specify one or more node IDs, the operation returns information for those managed nodes. If you don't specify node IDs, it returns information for all your managed nodes. If you specify a node ID that isn't valid or a node that you don't own, you receive an error.
The
IamRole
field returned for this API operation is the Identity and Access Management (IAM) role assigned to on-premises managed nodes. This operation does not return the IAM role for EC2 instances.- Parameters:
describeInstanceInformationRequest
-- Returns:
- Result of the DescribeInstanceInformation operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidInstanceIdException
- The following problems can cause this exception:-
You don't have permission to access the managed node.
-
Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running.
-
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
-
The managed node isn't in valid state. Valid states are:
Running
,Pending
,Stopped
, andStopping
. Invalid states are:Shutting-down
andTerminated
.
-
InvalidNextTokenException
- The specified token isn't valid.InvalidInstanceInformationFilterValueException
- The specified filter value isn't valid.InvalidFilterKeyException
- The specified key isn't 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
- See Also:
- AWS API Documentation
-
describeInstanceInformation
default DescribeInstanceInformationResponse describeInstanceInformation(Consumer<DescribeInstanceInformationRequest.Builder> describeInstanceInformationRequest) throws InternalServerErrorException, InvalidInstanceIdException, InvalidNextTokenException, InvalidInstanceInformationFilterValueException, InvalidFilterKeyException, AwsServiceException, SdkClientException, SsmException
Provides information about one or more of your managed nodes, including the operating system platform, SSM Agent version, association status, and IP address. This operation does not return information for nodes that are either Stopped or Terminated.
If you specify one or more node IDs, the operation returns information for those managed nodes. If you don't specify node IDs, it returns information for all your managed nodes. If you specify a node ID that isn't valid or a node that you don't own, you receive an error.
The
IamRole
field returned for this API operation is the Identity and Access Management (IAM) role assigned to on-premises managed nodes. This operation 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 viaDescribeInstanceInformationRequest.builder()
- Parameters:
describeInstanceInformationRequest
- AConsumer
that will call methods onDescribeInstanceInformationRequest.Builder
to create a request.- Returns:
- Result of the DescribeInstanceInformation operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidInstanceIdException
- The following problems can cause this exception:-
You don't have permission to access the managed node.
-
Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running.
-
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
-
The managed node isn't in valid state. Valid states are:
Running
,Pending
,Stopped
, andStopping
. Invalid states are:Shutting-down
andTerminated
.
-
InvalidNextTokenException
- The specified token isn't valid.InvalidInstanceInformationFilterValueException
- The specified filter value isn't valid.InvalidFilterKeyException
- The specified key isn't 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
- See Also:
- AWS API Documentation
-
describeInstanceInformation
default DescribeInstanceInformationResponse describeInstanceInformation() throws InternalServerErrorException, InvalidInstanceIdException, InvalidNextTokenException, InvalidInstanceInformationFilterValueException, InvalidFilterKeyException, AwsServiceException, SdkClientException, SsmException
Provides information about one or more of your managed nodes, including the operating system platform, SSM Agent version, association status, and IP address. This operation does not return information for nodes that are either Stopped or Terminated.
If you specify one or more node IDs, the operation returns information for those managed nodes. If you don't specify node IDs, it returns information for all your managed nodes. If you specify a node ID that isn't valid or a node that you don't own, you receive an error.
The
IamRole
field returned for this API operation is the Identity and Access Management (IAM) role assigned to on-premises managed nodes. This operation does not return the IAM role for EC2 instances.- Returns:
- Result of the DescribeInstanceInformation operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidInstanceIdException
- The following problems can cause this exception:-
You don't have permission to access the managed node.
-
Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running.
-
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
-
The managed node isn't in valid state. Valid states are:
Running
,Pending
,Stopped
, andStopping
. Invalid states are:Shutting-down
andTerminated
.
-
InvalidNextTokenException
- The specified token isn't valid.InvalidInstanceInformationFilterValueException
- The specified filter value isn't valid.InvalidFilterKeyException
- The specified key isn't 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
- See Also:
describeInstanceInformation(DescribeInstanceInformationRequest)
, AWS API Documentation
-
describeInstanceInformationPaginator
default DescribeInstanceInformationIterable describeInstanceInformationPaginator() throws InternalServerErrorException, InvalidInstanceIdException, InvalidNextTokenException, InvalidInstanceInformationFilterValueException, InvalidFilterKeyException, AwsServiceException, SdkClientException, SsmException
Provides information about one or more of your managed nodes, including the operating system platform, SSM Agent version, association status, and IP address. This operation does not return information for nodes that are either Stopped or Terminated.
If you specify one or more node IDs, the operation returns information for those managed nodes. If you don't specify node IDs, it returns information for all your managed nodes. If you specify a node ID that isn't valid or a node that you don't own, you receive an error.
The
IamRole
field returned for this API operation is the Identity and Access Management (IAM) role assigned to on-premises managed nodes. This operation 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 Streamsoftware.amazon.awssdk.services.ssm.paginators.DescribeInstanceInformationIterable responses = client.describeInstanceInformationPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidInstanceIdException
- The following problems can cause this exception:-
You don't have permission to access the managed node.
-
Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running.
-
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
-
The managed node isn't in valid state. Valid states are:
Running
,Pending
,Stopped
, andStopping
. Invalid states are:Shutting-down
andTerminated
.
-
InvalidNextTokenException
- The specified token isn't valid.InvalidInstanceInformationFilterValueException
- The specified filter value isn't valid.InvalidFilterKeyException
- The specified key isn't 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
- See Also:
describeInstanceInformationPaginator(DescribeInstanceInformationRequest)
, AWS API Documentation
-
describeInstanceInformationPaginator
default DescribeInstanceInformationIterable describeInstanceInformationPaginator(DescribeInstanceInformationRequest describeInstanceInformationRequest) throws InternalServerErrorException, InvalidInstanceIdException, InvalidNextTokenException, InvalidInstanceInformationFilterValueException, InvalidFilterKeyException, AwsServiceException, SdkClientException, SsmException
Provides information about one or more of your managed nodes, including the operating system platform, SSM Agent version, association status, and IP address. This operation does not return information for nodes that are either Stopped or Terminated.
If you specify one or more node IDs, the operation returns information for those managed nodes. If you don't specify node IDs, it returns information for all your managed nodes. If you specify a node ID that isn't valid or a node that you don't own, you receive an error.
The
IamRole
field returned for this API operation is the Identity and Access Management (IAM) role assigned to on-premises managed nodes. This operation 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 Streamsoftware.amazon.awssdk.services.ssm.paginators.DescribeInstanceInformationIterable responses = client.describeInstanceInformationPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
describeInstanceInformationRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidInstanceIdException
- The following problems can cause this exception:-
You don't have permission to access the managed node.
-
Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running.
-
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
-
The managed node isn't in valid state. Valid states are:
Running
,Pending
,Stopped
, andStopping
. Invalid states are:Shutting-down
andTerminated
.
-
InvalidNextTokenException
- The specified token isn't valid.InvalidInstanceInformationFilterValueException
- The specified filter value isn't valid.InvalidFilterKeyException
- The specified key isn't 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
- See Also:
- AWS API Documentation
-
describeInstanceInformationPaginator
default DescribeInstanceInformationIterable describeInstanceInformationPaginator(Consumer<DescribeInstanceInformationRequest.Builder> describeInstanceInformationRequest) throws InternalServerErrorException, InvalidInstanceIdException, InvalidNextTokenException, InvalidInstanceInformationFilterValueException, InvalidFilterKeyException, AwsServiceException, SdkClientException, SsmException
Provides information about one or more of your managed nodes, including the operating system platform, SSM Agent version, association status, and IP address. This operation does not return information for nodes that are either Stopped or Terminated.
If you specify one or more node IDs, the operation returns information for those managed nodes. If you don't specify node IDs, it returns information for all your managed nodes. If you specify a node ID that isn't valid or a node that you don't own, you receive an error.
The
IamRole
field returned for this API operation is the Identity and Access Management (IAM) role assigned to on-premises managed nodes. This operation 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 Streamsoftware.amazon.awssdk.services.ssm.paginators.DescribeInstanceInformationIterable responses = client.describeInstanceInformationPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaDescribeInstanceInformationRequest.builder()
- Parameters:
describeInstanceInformationRequest
- AConsumer
that will call methods onDescribeInstanceInformationRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidInstanceIdException
- The following problems can cause this exception:-
You don't have permission to access the managed node.
-
Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running.
-
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
-
The managed node isn't in valid state. Valid states are:
Running
,Pending
,Stopped
, andStopping
. Invalid states are:Shutting-down
andTerminated
.
-
InvalidNextTokenException
- The specified token isn't valid.InvalidInstanceInformationFilterValueException
- The specified filter value isn't valid.InvalidFilterKeyException
- The specified key isn't 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
- See Also:
- AWS API Documentation
-
describeInstancePatchStates
default DescribeInstancePatchStatesResponse describeInstancePatchStates(DescribeInstancePatchStatesRequest describeInstancePatchStatesRequest) throws InternalServerErrorException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Retrieves the high-level patch state of one or more managed nodes.
- Parameters:
describeInstancePatchStatesRequest
-- Returns:
- Result of the DescribeInstancePatchStates operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
describeInstancePatchStates
default DescribeInstancePatchStatesResponse describeInstancePatchStates(Consumer<DescribeInstancePatchStatesRequest.Builder> describeInstancePatchStatesRequest) throws InternalServerErrorException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Retrieves the high-level patch state of one or more managed nodes.
This is a convenience which creates an instance of the
DescribeInstancePatchStatesRequest.Builder
avoiding the need to create one manually viaDescribeInstancePatchStatesRequest.builder()
- Parameters:
describeInstancePatchStatesRequest
- AConsumer
that will call methods onDescribeInstancePatchStatesRequest.Builder
to create a request.- Returns:
- Result of the DescribeInstancePatchStates operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
describeInstancePatchStatesPaginator
default DescribeInstancePatchStatesIterable describeInstancePatchStatesPaginator(DescribeInstancePatchStatesRequest describeInstancePatchStatesRequest) throws InternalServerErrorException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Retrieves the high-level patch state of one or more managed nodes.
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 Streamsoftware.amazon.awssdk.services.ssm.paginators.DescribeInstancePatchStatesIterable responses = client.describeInstancePatchStatesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
describeInstancePatchStatesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
describeInstancePatchStatesPaginator
default DescribeInstancePatchStatesIterable describeInstancePatchStatesPaginator(Consumer<DescribeInstancePatchStatesRequest.Builder> describeInstancePatchStatesRequest) throws InternalServerErrorException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Retrieves the high-level patch state of one or more managed nodes.
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 Streamsoftware.amazon.awssdk.services.ssm.paginators.DescribeInstancePatchStatesIterable responses = client.describeInstancePatchStatesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaDescribeInstancePatchStatesRequest.builder()
- Parameters:
describeInstancePatchStatesRequest
- AConsumer
that will call methods onDescribeInstancePatchStatesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
describeInstancePatchStatesForPatchGroup
default DescribeInstancePatchStatesForPatchGroupResponse describeInstancePatchStatesForPatchGroup(DescribeInstancePatchStatesForPatchGroupRequest describeInstancePatchStatesForPatchGroupRequest) throws InternalServerErrorException, InvalidFilterException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Retrieves the high-level patch state for the managed nodes in the specified patch group.
- Parameters:
describeInstancePatchStatesForPatchGroupRequest
-- Returns:
- Result of the DescribeInstancePatchStatesForPatchGroup operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidFilterException
- The filter name isn't valid. Verify the you entered the correct name and try again.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
describeInstancePatchStatesForPatchGroup
default DescribeInstancePatchStatesForPatchGroupResponse describeInstancePatchStatesForPatchGroup(Consumer<DescribeInstancePatchStatesForPatchGroupRequest.Builder> describeInstancePatchStatesForPatchGroupRequest) throws InternalServerErrorException, InvalidFilterException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Retrieves the high-level patch state for the managed nodes in the specified patch group.
This is a convenience which creates an instance of the
DescribeInstancePatchStatesForPatchGroupRequest.Builder
avoiding the need to create one manually viaDescribeInstancePatchStatesForPatchGroupRequest.builder()
- Parameters:
describeInstancePatchStatesForPatchGroupRequest
- AConsumer
that will call methods onDescribeInstancePatchStatesForPatchGroupRequest.Builder
to create a request.- Returns:
- Result of the DescribeInstancePatchStatesForPatchGroup operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidFilterException
- The filter name isn't valid. Verify the you entered the correct name and try again.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
describeInstancePatchStatesForPatchGroupPaginator
default DescribeInstancePatchStatesForPatchGroupIterable describeInstancePatchStatesForPatchGroupPaginator(DescribeInstancePatchStatesForPatchGroupRequest describeInstancePatchStatesForPatchGroupRequest) throws InternalServerErrorException, InvalidFilterException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Retrieves the high-level patch state for the managed nodes 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 Streamsoftware.amazon.awssdk.services.ssm.paginators.DescribeInstancePatchStatesForPatchGroupIterable responses = client.describeInstancePatchStatesForPatchGroupPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
describeInstancePatchStatesForPatchGroupRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidFilterException
- The filter name isn't valid. Verify the you entered the correct name and try again.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
describeInstancePatchStatesForPatchGroupPaginator
default DescribeInstancePatchStatesForPatchGroupIterable describeInstancePatchStatesForPatchGroupPaginator(Consumer<DescribeInstancePatchStatesForPatchGroupRequest.Builder> describeInstancePatchStatesForPatchGroupRequest) throws InternalServerErrorException, InvalidFilterException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Retrieves the high-level patch state for the managed nodes 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 Streamsoftware.amazon.awssdk.services.ssm.paginators.DescribeInstancePatchStatesForPatchGroupIterable responses = client.describeInstancePatchStatesForPatchGroupPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaDescribeInstancePatchStatesForPatchGroupRequest.builder()
- Parameters:
describeInstancePatchStatesForPatchGroupRequest
- AConsumer
that will call methods onDescribeInstancePatchStatesForPatchGroupRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidFilterException
- The filter name isn't valid. Verify the you entered the correct name and try again.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
describeInstancePatches
default DescribeInstancePatchesResponse describeInstancePatches(DescribeInstancePatchesRequest describeInstancePatchesRequest) throws InternalServerErrorException, InvalidInstanceIdException, InvalidFilterException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Retrieves information about the patches on the specified managed node and their state relative to the patch baseline being used for the node.
- Parameters:
describeInstancePatchesRequest
-- Returns:
- Result of the DescribeInstancePatches operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidInstanceIdException
- The following problems can cause this exception:-
You don't have permission to access the managed node.
-
Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running.
-
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
-
The managed node isn't in valid state. Valid states are:
Running
,Pending
,Stopped
, andStopping
. Invalid states are:Shutting-down
andTerminated
.
-
InvalidFilterException
- The filter name isn't valid. Verify the you entered the correct name and try again.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
describeInstancePatches
default DescribeInstancePatchesResponse describeInstancePatches(Consumer<DescribeInstancePatchesRequest.Builder> describeInstancePatchesRequest) throws InternalServerErrorException, InvalidInstanceIdException, InvalidFilterException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Retrieves information about the patches on the specified managed node and their state relative to the patch baseline being used for the node.
This is a convenience which creates an instance of the
DescribeInstancePatchesRequest.Builder
avoiding the need to create one manually viaDescribeInstancePatchesRequest.builder()
- Parameters:
describeInstancePatchesRequest
- AConsumer
that will call methods onDescribeInstancePatchesRequest.Builder
to create a request.- Returns:
- Result of the DescribeInstancePatches operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidInstanceIdException
- The following problems can cause this exception:-
You don't have permission to access the managed node.
-
Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running.
-
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
-
The managed node isn't in valid state. Valid states are:
Running
,Pending
,Stopped
, andStopping
. Invalid states are:Shutting-down
andTerminated
.
-
InvalidFilterException
- The filter name isn't valid. Verify the you entered the correct name and try again.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
describeInstancePatchesPaginator
default DescribeInstancePatchesIterable describeInstancePatchesPaginator(DescribeInstancePatchesRequest describeInstancePatchesRequest) throws InternalServerErrorException, InvalidInstanceIdException, InvalidFilterException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Retrieves information about the patches on the specified managed node and their state relative to the patch baseline being used for the node.
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 Streamsoftware.amazon.awssdk.services.ssm.paginators.DescribeInstancePatchesIterable responses = client.describeInstancePatchesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
describeInstancePatchesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidInstanceIdException
- The following problems can cause this exception:-
You don't have permission to access the managed node.
-
Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running.
-
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
-
The managed node isn't in valid state. Valid states are:
Running
,Pending
,Stopped
, andStopping
. Invalid states are:Shutting-down
andTerminated
.
-
InvalidFilterException
- The filter name isn't valid. Verify the you entered the correct name and try again.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
describeInstancePatchesPaginator
default DescribeInstancePatchesIterable describeInstancePatchesPaginator(Consumer<DescribeInstancePatchesRequest.Builder> describeInstancePatchesRequest) throws InternalServerErrorException, InvalidInstanceIdException, InvalidFilterException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Retrieves information about the patches on the specified managed node and their state relative to the patch baseline being used for the node.
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 Streamsoftware.amazon.awssdk.services.ssm.paginators.DescribeInstancePatchesIterable responses = client.describeInstancePatchesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaDescribeInstancePatchesRequest.builder()
- Parameters:
describeInstancePatchesRequest
- AConsumer
that will call methods onDescribeInstancePatchesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidInstanceIdException
- The following problems can cause this exception:-
You don't have permission to access the managed node.
-
Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running.
-
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
-
The managed node isn't in valid state. Valid states are:
Running
,Pending
,Stopped
, andStopping
. Invalid states are:Shutting-down
andTerminated
.
-
InvalidFilterException
- The filter name isn't valid. Verify the you entered the correct name and try again.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
describeInventoryDeletions
default DescribeInventoryDeletionsResponse describeInventoryDeletions(DescribeInventoryDeletionsRequest describeInventoryDeletionsRequest) throws InternalServerErrorException, InvalidDeletionIdException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Describes a specific delete inventory operation.
- Parameters:
describeInventoryDeletionsRequest
-- Returns:
- Result of the DescribeInventoryDeletions operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidDeletionIdException
- The ID specified for the delete operation doesn't exist or isn't valid. Verify the ID and try again.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
describeInventoryDeletions
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 viaDescribeInventoryDeletionsRequest.builder()
- Parameters:
describeInventoryDeletionsRequest
- AConsumer
that will call methods onDescribeInventoryDeletionsRequest.Builder
to create a request.- Returns:
- Result of the DescribeInventoryDeletions operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidDeletionIdException
- The ID specified for the delete operation doesn't exist or isn't valid. Verify the ID and try again.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
describeInventoryDeletions
default DescribeInventoryDeletionsResponse describeInventoryDeletions() throws InternalServerErrorException, InvalidDeletionIdException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Describes a specific delete inventory operation.
- Returns:
- Result of the DescribeInventoryDeletions operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidDeletionIdException
- The ID specified for the delete operation doesn't exist or isn't valid. Verify the ID and try again.InvalidNextTokenException
- The specified token isn't 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
- See Also:
describeInventoryDeletions(DescribeInventoryDeletionsRequest)
, AWS API Documentation
-
describeInventoryDeletionsPaginator
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 Streamsoftware.amazon.awssdk.services.ssm.paginators.DescribeInventoryDeletionsIterable responses = client.describeInventoryDeletionsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidDeletionIdException
- The ID specified for the delete operation doesn't exist or isn't valid. Verify the ID and try again.InvalidNextTokenException
- The specified token isn't 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
- See Also:
describeInventoryDeletionsPaginator(DescribeInventoryDeletionsRequest)
, AWS API Documentation
-
describeInventoryDeletionsPaginator
default 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 Streamsoftware.amazon.awssdk.services.ssm.paginators.DescribeInventoryDeletionsIterable responses = client.describeInventoryDeletionsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
describeInventoryDeletionsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidDeletionIdException
- The ID specified for the delete operation doesn't exist or isn't valid. Verify the ID and try again.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
describeInventoryDeletionsPaginator
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 Streamsoftware.amazon.awssdk.services.ssm.paginators.DescribeInventoryDeletionsIterable responses = client.describeInventoryDeletionsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaDescribeInventoryDeletionsRequest.builder()
- Parameters:
describeInventoryDeletionsRequest
- AConsumer
that will call methods onDescribeInventoryDeletionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidDeletionIdException
- The ID specified for the delete operation doesn't exist or isn't valid. Verify the ID and try again.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
describeMaintenanceWindowExecutionTaskInvocations
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.
- Parameters:
describeMaintenanceWindowExecutionTaskInvocationsRequest
-- Returns:
- Result of the DescribeMaintenanceWindowExecutionTaskInvocations operation returned by the service.
- Throws:
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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services 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
- See Also:
- AWS API Documentation
-
describeMaintenanceWindowExecutionTaskInvocations
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 viaDescribeMaintenanceWindowExecutionTaskInvocationsRequest.builder()
- Parameters:
describeMaintenanceWindowExecutionTaskInvocationsRequest
- AConsumer
that will call methods onDescribeMaintenanceWindowExecutionTaskInvocationsRequest.Builder
to create a request.- Returns:
- Result of the DescribeMaintenanceWindowExecutionTaskInvocations operation returned by the service.
- Throws:
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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services 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
- See Also:
- AWS API Documentation
-
describeMaintenanceWindowExecutionTaskInvocationsPaginator
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 Streamsoftware.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowExecutionTaskInvocationsIterable responses = client.describeMaintenanceWindowExecutionTaskInvocationsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
describeMaintenanceWindowExecutionTaskInvocationsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services 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
- See Also:
- AWS API Documentation
-
describeMaintenanceWindowExecutionTaskInvocationsPaginator
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 Streamsoftware.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowExecutionTaskInvocationsIterable responses = client.describeMaintenanceWindowExecutionTaskInvocationsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaDescribeMaintenanceWindowExecutionTaskInvocationsRequest.builder()
- Parameters:
describeMaintenanceWindowExecutionTaskInvocationsRequest
- AConsumer
that will call methods onDescribeMaintenanceWindowExecutionTaskInvocationsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services 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
- See Also:
- AWS API Documentation
-
describeMaintenanceWindowExecutionTasks
default DescribeMaintenanceWindowExecutionTasksResponse describeMaintenanceWindowExecutionTasks(DescribeMaintenanceWindowExecutionTasksRequest describeMaintenanceWindowExecutionTasksRequest) throws DoesNotExistException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
For a given maintenance window execution, lists the tasks that were run.
- Parameters:
describeMaintenanceWindowExecutionTasksRequest
-- Returns:
- Result of the DescribeMaintenanceWindowExecutionTasks operation returned by the service.
- Throws:
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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services 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
- See Also:
- AWS API Documentation
-
describeMaintenanceWindowExecutionTasks
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 viaDescribeMaintenanceWindowExecutionTasksRequest.builder()
- Parameters:
describeMaintenanceWindowExecutionTasksRequest
- AConsumer
that will call methods onDescribeMaintenanceWindowExecutionTasksRequest.Builder
to create a request.- Returns:
- Result of the DescribeMaintenanceWindowExecutionTasks operation returned by the service.
- Throws:
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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services 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
- See Also:
- AWS API Documentation
-
describeMaintenanceWindowExecutionTasksPaginator
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 Streamsoftware.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowExecutionTasksIterable responses = client.describeMaintenanceWindowExecutionTasksPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
describeMaintenanceWindowExecutionTasksRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services 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
- See Also:
- AWS API Documentation
-
describeMaintenanceWindowExecutionTasksPaginator
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 Streamsoftware.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowExecutionTasksIterable responses = client.describeMaintenanceWindowExecutionTasksPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaDescribeMaintenanceWindowExecutionTasksRequest.builder()
- Parameters:
describeMaintenanceWindowExecutionTasksRequest
- AConsumer
that will call methods onDescribeMaintenanceWindowExecutionTasksRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services 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
- See Also:
- AWS API Documentation
-
describeMaintenanceWindowExecutions
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.
- Parameters:
describeMaintenanceWindowExecutionsRequest
-- Returns:
- Result of the DescribeMaintenanceWindowExecutions operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
describeMaintenanceWindowExecutions
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 viaDescribeMaintenanceWindowExecutionsRequest.builder()
- Parameters:
describeMaintenanceWindowExecutionsRequest
- AConsumer
that will call methods onDescribeMaintenanceWindowExecutionsRequest.Builder
to create a request.- Returns:
- Result of the DescribeMaintenanceWindowExecutions operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
describeMaintenanceWindowExecutionsPaginator
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 Streamsoftware.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowExecutionsIterable responses = client.describeMaintenanceWindowExecutionsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
describeMaintenanceWindowExecutionsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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
- See Also:
- AWS API Documentation
-
describeMaintenanceWindowExecutionsPaginator
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 Streamsoftware.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowExecutionsIterable responses = client.describeMaintenanceWindowExecutionsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaDescribeMaintenanceWindowExecutionsRequest.builder()
- Parameters:
describeMaintenanceWindowExecutionsRequest
- AConsumer
that will call methods onDescribeMaintenanceWindowExecutionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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
- See Also:
- AWS API Documentation
-
describeMaintenanceWindowSchedule
default DescribeMaintenanceWindowScheduleResponse describeMaintenanceWindowSchedule(DescribeMaintenanceWindowScheduleRequest describeMaintenanceWindowScheduleRequest) throws InternalServerErrorException, DoesNotExistException, AwsServiceException, SdkClientException, SsmException
Retrieves information about upcoming executions of a maintenance window.
- Parameters:
describeMaintenanceWindowScheduleRequest
-- Returns:
- Result of the DescribeMaintenanceWindowSchedule operation returned by the service.
- Throws:
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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services 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
- See Also:
- AWS API Documentation
-
describeMaintenanceWindowSchedule
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 viaDescribeMaintenanceWindowScheduleRequest.builder()
- Parameters:
describeMaintenanceWindowScheduleRequest
- AConsumer
that will call methods onDescribeMaintenanceWindowScheduleRequest.Builder
to create a request.- Returns:
- Result of the DescribeMaintenanceWindowSchedule operation returned by the service.
- Throws:
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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services 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
- See Also:
- AWS API Documentation
-
describeMaintenanceWindowSchedulePaginator
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 Streamsoftware.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowScheduleIterable responses = client.describeMaintenanceWindowSchedulePaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
describeMaintenanceWindowScheduleRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services 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
- See Also:
- AWS API Documentation
-
describeMaintenanceWindowSchedulePaginator
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 Streamsoftware.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowScheduleIterable responses = client.describeMaintenanceWindowSchedulePaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaDescribeMaintenanceWindowScheduleRequest.builder()
- Parameters:
describeMaintenanceWindowScheduleRequest
- AConsumer
that will call methods onDescribeMaintenanceWindowScheduleRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services 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
- See Also:
- AWS API Documentation
-
describeMaintenanceWindowTargets
default DescribeMaintenanceWindowTargetsResponse describeMaintenanceWindowTargets(DescribeMaintenanceWindowTargetsRequest describeMaintenanceWindowTargetsRequest) throws DoesNotExistException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Lists the targets registered with the maintenance window.
- Parameters:
describeMaintenanceWindowTargetsRequest
-- Returns:
- Result of the DescribeMaintenanceWindowTargets operation returned by the service.
- Throws:
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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services 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
- See Also:
- AWS API Documentation
-
describeMaintenanceWindowTargets
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 viaDescribeMaintenanceWindowTargetsRequest.builder()
- Parameters:
describeMaintenanceWindowTargetsRequest
- AConsumer
that will call methods onDescribeMaintenanceWindowTargetsRequest.Builder
to create a request.- Returns:
- Result of the DescribeMaintenanceWindowTargets operation returned by the service.
- Throws:
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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services 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
- See Also:
- AWS API Documentation
-
describeMaintenanceWindowTargetsPaginator
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 Streamsoftware.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowTargetsIterable responses = client.describeMaintenanceWindowTargetsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
describeMaintenanceWindowTargetsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services 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
- See Also:
- AWS API Documentation
-
describeMaintenanceWindowTargetsPaginator
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 Streamsoftware.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowTargetsIterable responses = client.describeMaintenanceWindowTargetsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaDescribeMaintenanceWindowTargetsRequest.builder()
- Parameters:
describeMaintenanceWindowTargetsRequest
- AConsumer
that will call methods onDescribeMaintenanceWindowTargetsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services 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
- See Also:
- AWS API Documentation
-
describeMaintenanceWindowTasks
default DescribeMaintenanceWindowTasksResponse describeMaintenanceWindowTasks(DescribeMaintenanceWindowTasksRequest describeMaintenanceWindowTasksRequest) throws DoesNotExistException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Lists the tasks in a maintenance window.
For maintenance window tasks without a specified target, you can't supply values for
--max-errors
and--max-concurrency
. Instead, the system inserts a placeholder value of1
, which may be reported in the response to this command. These values don't affect the running of your task and can be ignored.- Parameters:
describeMaintenanceWindowTasksRequest
-- Returns:
- Result of the DescribeMaintenanceWindowTasks operation returned by the service.
- Throws:
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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services 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
- See Also:
- AWS API Documentation
-
describeMaintenanceWindowTasks
default DescribeMaintenanceWindowTasksResponse describeMaintenanceWindowTasks(Consumer<DescribeMaintenanceWindowTasksRequest.Builder> describeMaintenanceWindowTasksRequest) throws DoesNotExistException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Lists the tasks in a maintenance window.
For maintenance window tasks without a specified target, you can't supply values for
--max-errors
and--max-concurrency
. Instead, the system inserts a placeholder value of1
, which may be reported in the response to this command. These values don't affect the running of your task and can be ignored.
This is a convenience which creates an instance of the
DescribeMaintenanceWindowTasksRequest.Builder
avoiding the need to create one manually viaDescribeMaintenanceWindowTasksRequest.builder()
- Parameters:
describeMaintenanceWindowTasksRequest
- AConsumer
that will call methods onDescribeMaintenanceWindowTasksRequest.Builder
to create a request.- Returns:
- Result of the DescribeMaintenanceWindowTasks operation returned by the service.
- Throws:
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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services 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
- See Also:
- AWS API Documentation
-
describeMaintenanceWindowTasksPaginator
default DescribeMaintenanceWindowTasksIterable describeMaintenanceWindowTasksPaginator(DescribeMaintenanceWindowTasksRequest describeMaintenanceWindowTasksRequest) throws DoesNotExistException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Lists the tasks in a maintenance window.
For maintenance window tasks without a specified target, you can't supply values for
--max-errors
and--max-concurrency
. Instead, the system inserts a placeholder value of1
, which may be reported in the response to this command. These values don't affect the running of your task and can be ignored.
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 Streamsoftware.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowTasksIterable responses = client.describeMaintenanceWindowTasksPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
describeMaintenanceWindowTasksRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services 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
- See Also:
- AWS API Documentation
-
describeMaintenanceWindowTasksPaginator
default DescribeMaintenanceWindowTasksIterable describeMaintenanceWindowTasksPaginator(Consumer<DescribeMaintenanceWindowTasksRequest.Builder> describeMaintenanceWindowTasksRequest) throws DoesNotExistException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Lists the tasks in a maintenance window.
For maintenance window tasks without a specified target, you can't supply values for
--max-errors
and--max-concurrency
. Instead, the system inserts a placeholder value of1
, which may be reported in the response to this command. These values don't affect the running of your task and can be ignored.
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 Streamsoftware.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowTasksIterable responses = client.describeMaintenanceWindowTasksPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaDescribeMaintenanceWindowTasksRequest.builder()
- Parameters:
describeMaintenanceWindowTasksRequest
- AConsumer
that will call methods onDescribeMaintenanceWindowTasksRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services 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
- See Also:
- AWS API Documentation
-
describeMaintenanceWindows
default DescribeMaintenanceWindowsResponse describeMaintenanceWindows(DescribeMaintenanceWindowsRequest describeMaintenanceWindowsRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Retrieves the maintenance windows in an Amazon Web Services account.
- Parameters:
describeMaintenanceWindowsRequest
-- Returns:
- Result of the DescribeMaintenanceWindows operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
describeMaintenanceWindows
default DescribeMaintenanceWindowsResponse describeMaintenanceWindows(Consumer<DescribeMaintenanceWindowsRequest.Builder> describeMaintenanceWindowsRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Retrieves the maintenance windows in an Amazon Web Services account.
This is a convenience which creates an instance of the
DescribeMaintenanceWindowsRequest.Builder
avoiding the need to create one manually viaDescribeMaintenanceWindowsRequest.builder()
- Parameters:
describeMaintenanceWindowsRequest
- AConsumer
that will call methods onDescribeMaintenanceWindowsRequest.Builder
to create a request.- Returns:
- Result of the DescribeMaintenanceWindows operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
describeMaintenanceWindows
default DescribeMaintenanceWindowsResponse describeMaintenanceWindows() throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Retrieves the maintenance windows in an Amazon Web Services account.
- Returns:
- Result of the DescribeMaintenanceWindows operation returned by the service.
- Throws:
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
- See Also:
describeMaintenanceWindows(DescribeMaintenanceWindowsRequest)
, AWS API Documentation
-
describeMaintenanceWindowsPaginator
default DescribeMaintenanceWindowsIterable describeMaintenanceWindowsPaginator() throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Retrieves the maintenance windows in an Amazon Web Services 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 Streamsoftware.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowsIterable responses = client.describeMaintenanceWindowsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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
- See Also:
describeMaintenanceWindowsPaginator(DescribeMaintenanceWindowsRequest)
, AWS API Documentation
-
describeMaintenanceWindowsPaginator
default DescribeMaintenanceWindowsIterable describeMaintenanceWindowsPaginator(DescribeMaintenanceWindowsRequest describeMaintenanceWindowsRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Retrieves the maintenance windows in an Amazon Web Services 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 Streamsoftware.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowsIterable responses = client.describeMaintenanceWindowsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
describeMaintenanceWindowsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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
- See Also:
- AWS API Documentation
-
describeMaintenanceWindowsPaginator
default DescribeMaintenanceWindowsIterable describeMaintenanceWindowsPaginator(Consumer<DescribeMaintenanceWindowsRequest.Builder> describeMaintenanceWindowsRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Retrieves the maintenance windows in an Amazon Web Services 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 Streamsoftware.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowsIterable responses = client.describeMaintenanceWindowsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaDescribeMaintenanceWindowsRequest.builder()
- Parameters:
describeMaintenanceWindowsRequest
- AConsumer
that will call methods onDescribeMaintenanceWindowsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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
- See Also:
- AWS API Documentation
-
describeMaintenanceWindowsForTarget
default DescribeMaintenanceWindowsForTargetResponse describeMaintenanceWindowsForTarget(DescribeMaintenanceWindowsForTargetRequest describeMaintenanceWindowsForTargetRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Retrieves information about the maintenance window targets or tasks that a managed node is associated with.
- Parameters:
describeMaintenanceWindowsForTargetRequest
-- Returns:
- Result of the DescribeMaintenanceWindowsForTarget operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
describeMaintenanceWindowsForTarget
default DescribeMaintenanceWindowsForTargetResponse describeMaintenanceWindowsForTarget(Consumer<DescribeMaintenanceWindowsForTargetRequest.Builder> describeMaintenanceWindowsForTargetRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Retrieves information about the maintenance window targets or tasks that a managed node is associated with.
This is a convenience which creates an instance of the
DescribeMaintenanceWindowsForTargetRequest.Builder
avoiding the need to create one manually viaDescribeMaintenanceWindowsForTargetRequest.builder()
- Parameters:
describeMaintenanceWindowsForTargetRequest
- AConsumer
that will call methods onDescribeMaintenanceWindowsForTargetRequest.Builder
to create a request.- Returns:
- Result of the DescribeMaintenanceWindowsForTarget operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
describeMaintenanceWindowsForTargetPaginator
default DescribeMaintenanceWindowsForTargetIterable describeMaintenanceWindowsForTargetPaginator(DescribeMaintenanceWindowsForTargetRequest describeMaintenanceWindowsForTargetRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Retrieves information about the maintenance window targets or tasks that a managed node 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 Streamsoftware.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowsForTargetIterable responses = client.describeMaintenanceWindowsForTargetPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
describeMaintenanceWindowsForTargetRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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
- See Also:
- AWS API Documentation
-
describeMaintenanceWindowsForTargetPaginator
default DescribeMaintenanceWindowsForTargetIterable describeMaintenanceWindowsForTargetPaginator(Consumer<DescribeMaintenanceWindowsForTargetRequest.Builder> describeMaintenanceWindowsForTargetRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Retrieves information about the maintenance window targets or tasks that a managed node 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 Streamsoftware.amazon.awssdk.services.ssm.paginators.DescribeMaintenanceWindowsForTargetIterable responses = client.describeMaintenanceWindowsForTargetPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaDescribeMaintenanceWindowsForTargetRequest.builder()
- Parameters:
describeMaintenanceWindowsForTargetRequest
- AConsumer
that will call methods onDescribeMaintenanceWindowsForTargetRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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
- See Also:
- AWS API Documentation
-
describeOpsItems
default DescribeOpsItemsResponse describeOpsItems(DescribeOpsItemsRequest describeOpsItemsRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Query a set of OpsItems. You must have permission in Identity and Access Management (IAM) to query a list of OpsItems. For more information, see Set up OpsCenter in the Amazon Web Services Systems Manager User Guide.
Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For more information, see OpsCenter in the Amazon Web Services Systems Manager User Guide.
- Parameters:
describeOpsItemsRequest
-- Returns:
- Result of the DescribeOpsItems operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
describeOpsItems
default DescribeOpsItemsResponse describeOpsItems(Consumer<DescribeOpsItemsRequest.Builder> describeOpsItemsRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Query a set of OpsItems. You must have permission in Identity and Access Management (IAM) to query a list of OpsItems. For more information, see Set up OpsCenter in the Amazon Web Services Systems Manager User Guide.
Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For more information, see OpsCenter in the Amazon Web Services Systems Manager User Guide.
This is a convenience which creates an instance of the
DescribeOpsItemsRequest.Builder
avoiding the need to create one manually viaDescribeOpsItemsRequest.builder()
- Parameters:
describeOpsItemsRequest
- AConsumer
that will call methods onDescribeOpsItemsRequest.Builder
to create a request.- Returns:
- Result of the DescribeOpsItems operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
describeOpsItemsPaginator
default DescribeOpsItemsIterable describeOpsItemsPaginator(DescribeOpsItemsRequest describeOpsItemsRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Query a set of OpsItems. You must have permission in Identity and Access Management (IAM) to query a list of OpsItems. For more information, see Set up OpsCenter in the Amazon Web Services Systems Manager User Guide.
Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For more information, see OpsCenter in the Amazon Web Services 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 Streamsoftware.amazon.awssdk.services.ssm.paginators.DescribeOpsItemsIterable responses = client.describeOpsItemsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
describeOpsItemsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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
- See Also:
- AWS API Documentation
-
describeOpsItemsPaginator
default DescribeOpsItemsIterable describeOpsItemsPaginator(Consumer<DescribeOpsItemsRequest.Builder> describeOpsItemsRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Query a set of OpsItems. You must have permission in Identity and Access Management (IAM) to query a list of OpsItems. For more information, see Set up OpsCenter in the Amazon Web Services Systems Manager User Guide.
Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For more information, see OpsCenter in the Amazon Web Services 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 Streamsoftware.amazon.awssdk.services.ssm.paginators.DescribeOpsItemsIterable responses = client.describeOpsItemsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaDescribeOpsItemsRequest.builder()
- Parameters:
describeOpsItemsRequest
- AConsumer
that will call methods onDescribeOpsItemsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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
- See Also:
- AWS API Documentation
-
describeParameters
default 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 ofMaxResults
. 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 aNextToken
. You can specify theNextToken
in a subsequent call to get the next set of results.If you change the KMS key alias for the KMS key used to encrypt a parameter, then you must also update the key alias the parameter uses to reference KMS. Otherwise,
DescribeParameters
retrieves whatever the original key alias was referencing.- Parameters:
describeParametersRequest
-- Returns:
- Result of the DescribeParameters operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidFilterKeyException
- The specified key isn't valid.InvalidFilterOptionException
- The specified filter option isn't valid. Valid options are Equals and BeginsWith. For Path filter, valid options are Recursive and OneLevel.InvalidFilterValueException
- The filter value isn't valid. Verify the value and try again.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
describeParameters
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 ofMaxResults
. 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 aNextToken
. You can specify theNextToken
in a subsequent call to get the next set of results.If you change the KMS key alias for the KMS key used to encrypt a parameter, then you must also update the key alias the parameter uses to reference KMS. Otherwise,
DescribeParameters
retrieves whatever the original key alias was referencing.
This is a convenience which creates an instance of the
DescribeParametersRequest.Builder
avoiding the need to create one manually viaDescribeParametersRequest.builder()
- Parameters:
describeParametersRequest
- AConsumer
that will call methods onDescribeParametersRequest.Builder
to create a request.- Returns:
- Result of the DescribeParameters operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidFilterKeyException
- The specified key isn't valid.InvalidFilterOptionException
- The specified filter option isn't valid. Valid options are Equals and BeginsWith. For Path filter, valid options are Recursive and OneLevel.InvalidFilterValueException
- The filter value isn't valid. Verify the value and try again.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
describeParameters
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 ofMaxResults
. 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 aNextToken
. You can specify theNextToken
in a subsequent call to get the next set of results.If you change the KMS key alias for the KMS key used to encrypt a parameter, then you must also update the key alias the parameter uses to reference KMS. Otherwise,
DescribeParameters
retrieves whatever the original key alias was referencing.- Returns:
- Result of the DescribeParameters operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidFilterKeyException
- The specified key isn't valid.InvalidFilterOptionException
- The specified filter option isn't valid. Valid options are Equals and BeginsWith. For Path filter, valid options are Recursive and OneLevel.InvalidFilterValueException
- The filter value isn't valid. Verify the value and try again.InvalidNextTokenException
- The specified token isn't 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
- See Also:
describeParameters(DescribeParametersRequest)
, AWS API Documentation
-
describeParametersPaginator
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 ofMaxResults
. 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 aNextToken
. You can specify theNextToken
in a subsequent call to get the next set of results.If you change the KMS key alias for the KMS key used to encrypt a parameter, then you must also update the key alias the parameter uses to reference KMS. Otherwise,
DescribeParameters
retrieves whatever the original key alias was referencing.
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 Streamsoftware.amazon.awssdk.services.ssm.paginators.DescribeParametersIterable responses = client.describeParametersPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidFilterKeyException
- The specified key isn't valid.InvalidFilterOptionException
- The specified filter option isn't valid. Valid options are Equals and BeginsWith. For Path filter, valid options are Recursive and OneLevel.InvalidFilterValueException
- The filter value isn't valid. Verify the value and try again.InvalidNextTokenException
- The specified token isn't 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
- See Also:
describeParametersPaginator(DescribeParametersRequest)
, AWS API Documentation
-
describeParametersPaginator
default 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 ofMaxResults
. 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 aNextToken
. You can specify theNextToken
in a subsequent call to get the next set of results.If you change the KMS key alias for the KMS key used to encrypt a parameter, then you must also update the key alias the parameter uses to reference KMS. Otherwise,
DescribeParameters
retrieves whatever the original key alias was referencing.
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 Streamsoftware.amazon.awssdk.services.ssm.paginators.DescribeParametersIterable responses = client.describeParametersPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
describeParametersRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidFilterKeyException
- The specified key isn't valid.InvalidFilterOptionException
- The specified filter option isn't valid. Valid options are Equals and BeginsWith. For Path filter, valid options are Recursive and OneLevel.InvalidFilterValueException
- The filter value isn't valid. Verify the value and try again.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
describeParametersPaginator
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 ofMaxResults
. 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 aNextToken
. You can specify theNextToken
in a subsequent call to get the next set of results.If you change the KMS key alias for the KMS key used to encrypt a parameter, then you must also update the key alias the parameter uses to reference KMS. Otherwise,
DescribeParameters
retrieves whatever the original key alias was referencing.
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 Streamsoftware.amazon.awssdk.services.ssm.paginators.DescribeParametersIterable responses = client.describeParametersPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaDescribeParametersRequest.builder()
- Parameters:
describeParametersRequest
- AConsumer
that will call methods onDescribeParametersRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidFilterKeyException
- The specified key isn't valid.InvalidFilterOptionException
- The specified filter option isn't valid. Valid options are Equals and BeginsWith. For Path filter, valid options are Recursive and OneLevel.InvalidFilterValueException
- The filter value isn't valid. Verify the value and try again.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
describePatchBaselines
default DescribePatchBaselinesResponse describePatchBaselines(DescribePatchBaselinesRequest describePatchBaselinesRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Lists the patch baselines in your Amazon Web Services account.
- Parameters:
describePatchBaselinesRequest
-- Returns:
- Result of the DescribePatchBaselines operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
describePatchBaselines
default DescribePatchBaselinesResponse describePatchBaselines(Consumer<DescribePatchBaselinesRequest.Builder> describePatchBaselinesRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Lists the patch baselines in your Amazon Web Services account.
This is a convenience which creates an instance of the
DescribePatchBaselinesRequest.Builder
avoiding the need to create one manually viaDescribePatchBaselinesRequest.builder()
- Parameters:
describePatchBaselinesRequest
- AConsumer
that will call methods onDescribePatchBaselinesRequest.Builder
to create a request.- Returns:
- Result of the DescribePatchBaselines operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
describePatchBaselines
default DescribePatchBaselinesResponse describePatchBaselines() throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Lists the patch baselines in your Amazon Web Services account.
- Returns:
- Result of the DescribePatchBaselines operation returned by the service.
- Throws:
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
- See Also:
describePatchBaselines(DescribePatchBaselinesRequest)
, AWS API Documentation
-
describePatchBaselinesPaginator
default DescribePatchBaselinesIterable describePatchBaselinesPaginator() throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Lists the patch baselines in your Amazon Web Services 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 Streamsoftware.amazon.awssdk.services.ssm.paginators.DescribePatchBaselinesIterable responses = client.describePatchBaselinesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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
- See Also:
describePatchBaselinesPaginator(DescribePatchBaselinesRequest)
, AWS API Documentation
-
describePatchBaselinesPaginator
default DescribePatchBaselinesIterable describePatchBaselinesPaginator(DescribePatchBaselinesRequest describePatchBaselinesRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Lists the patch baselines in your Amazon Web Services 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 Streamsoftware.amazon.awssdk.services.ssm.paginators.DescribePatchBaselinesIterable responses = client.describePatchBaselinesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
describePatchBaselinesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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
- See Also:
- AWS API Documentation
-
describePatchBaselinesPaginator
default DescribePatchBaselinesIterable describePatchBaselinesPaginator(Consumer<DescribePatchBaselinesRequest.Builder> describePatchBaselinesRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Lists the patch baselines in your Amazon Web Services 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 Streamsoftware.amazon.awssdk.services.ssm.paginators.DescribePatchBaselinesIterable responses = client.describePatchBaselinesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaDescribePatchBaselinesRequest.builder()
- Parameters:
describePatchBaselinesRequest
- AConsumer
that will call methods onDescribePatchBaselinesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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
- See Also:
- AWS API Documentation
-
describePatchGroupState
default DescribePatchGroupStateResponse describePatchGroupState(DescribePatchGroupStateRequest describePatchGroupStateRequest) throws InternalServerErrorException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Returns high-level aggregated patch compliance state information for a patch group.
- Parameters:
describePatchGroupStateRequest
-- Returns:
- Result of the DescribePatchGroupState operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
describePatchGroupState
default DescribePatchGroupStateResponse describePatchGroupState(Consumer<DescribePatchGroupStateRequest.Builder> describePatchGroupStateRequest) throws InternalServerErrorException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Returns high-level aggregated patch compliance state information for a patch group.
This is a convenience which creates an instance of the
DescribePatchGroupStateRequest.Builder
avoiding the need to create one manually viaDescribePatchGroupStateRequest.builder()
- Parameters:
describePatchGroupStateRequest
- AConsumer
that will call methods onDescribePatchGroupStateRequest.Builder
to create a request.- Returns:
- Result of the DescribePatchGroupState operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
describePatchGroups
default DescribePatchGroupsResponse describePatchGroups(DescribePatchGroupsRequest describePatchGroupsRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Lists all patch groups that have been registered with patch baselines.
- Parameters:
describePatchGroupsRequest
-- Returns:
- Result of the DescribePatchGroups operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
describePatchGroups
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 viaDescribePatchGroupsRequest.builder()
- Parameters:
describePatchGroupsRequest
- AConsumer
that will call methods onDescribePatchGroupsRequest.Builder
to create a request.- Returns:
- Result of the DescribePatchGroups operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
describePatchGroups
default DescribePatchGroupsResponse describePatchGroups() throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Lists all patch groups that have been registered with patch baselines.
- Returns:
- Result of the DescribePatchGroups operation returned by the service.
- Throws:
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
- See Also:
describePatchGroups(DescribePatchGroupsRequest)
, AWS API Documentation
-
describePatchGroupsPaginator
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 Streamsoftware.amazon.awssdk.services.ssm.paginators.DescribePatchGroupsIterable responses = client.describePatchGroupsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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
- See Also:
describePatchGroupsPaginator(DescribePatchGroupsRequest)
, AWS API Documentation
-
describePatchGroupsPaginator
default 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 Streamsoftware.amazon.awssdk.services.ssm.paginators.DescribePatchGroupsIterable responses = client.describePatchGroupsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
describePatchGroupsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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
- See Also:
- AWS API Documentation
-
describePatchGroupsPaginator
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 Streamsoftware.amazon.awssdk.services.ssm.paginators.DescribePatchGroupsIterable responses = client.describePatchGroupsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaDescribePatchGroupsRequest.builder()
- Parameters:
describePatchGroupsRequest
- AConsumer
that will call methods onDescribePatchGroupsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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
- See Also:
- AWS API Documentation
-
describePatchProperties
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 operations 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:
- AMAZON_LINUX
-
Valid properties:
PRODUCT
|CLASSIFICATION
|SEVERITY
- AMAZON_LINUX_2
-
Valid properties:
PRODUCT
|CLASSIFICATION
|SEVERITY
- CENTOS
-
Valid properties:
PRODUCT
|CLASSIFICATION
|SEVERITY
- DEBIAN
-
Valid properties:
PRODUCT
|PRIORITY
- MACOS
-
Valid properties:
PRODUCT
|CLASSIFICATION
- ORACLE_LINUX
-
Valid properties:
PRODUCT
|CLASSIFICATION
|SEVERITY
- REDHAT_ENTERPRISE_LINUX
-
Valid properties:
PRODUCT
|CLASSIFICATION
|SEVERITY
- SUSE
-
Valid properties:
PRODUCT
|CLASSIFICATION
|SEVERITY
- UBUNTU
-
Valid properties:
PRODUCT
|PRIORITY
- WINDOWS
-
Valid properties:
PRODUCT
|PRODUCT_FAMILY
|CLASSIFICATION
|MSRC_SEVERITY
- Parameters:
describePatchPropertiesRequest
-- Returns:
- Result of the DescribePatchProperties operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
describePatchProperties
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 operations 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:
- AMAZON_LINUX
-
Valid properties:
PRODUCT
|CLASSIFICATION
|SEVERITY
- AMAZON_LINUX_2
-
Valid properties:
PRODUCT
|CLASSIFICATION
|SEVERITY
- CENTOS
-
Valid properties:
PRODUCT
|CLASSIFICATION
|SEVERITY
- DEBIAN
-
Valid properties:
PRODUCT
|PRIORITY
- MACOS
-
Valid properties:
PRODUCT
|CLASSIFICATION
- ORACLE_LINUX
-
Valid properties:
PRODUCT
|CLASSIFICATION
|SEVERITY
- REDHAT_ENTERPRISE_LINUX
-
Valid properties:
PRODUCT
|CLASSIFICATION
|SEVERITY
- SUSE
-
Valid properties:
PRODUCT
|CLASSIFICATION
|SEVERITY
- UBUNTU
-
Valid properties:
PRODUCT
|PRIORITY
- WINDOWS
-
Valid properties:
PRODUCT
|PRODUCT_FAMILY
|CLASSIFICATION
|MSRC_SEVERITY
This is a convenience which creates an instance of the
DescribePatchPropertiesRequest.Builder
avoiding the need to create one manually viaDescribePatchPropertiesRequest.builder()
- Parameters:
describePatchPropertiesRequest
- AConsumer
that will call methods onDescribePatchPropertiesRequest.Builder
to create a request.- Returns:
- Result of the DescribePatchProperties operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
describePatchPropertiesPaginator
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 operations 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:
- AMAZON_LINUX
-
Valid properties:
PRODUCT
|CLASSIFICATION
|SEVERITY
- AMAZON_LINUX_2
-
Valid properties:
PRODUCT
|CLASSIFICATION
|SEVERITY
- CENTOS
-
Valid properties:
PRODUCT
|CLASSIFICATION
|SEVERITY
- DEBIAN
-
Valid properties:
PRODUCT
|PRIORITY
- MACOS
-
Valid properties:
PRODUCT
|CLASSIFICATION
- ORACLE_LINUX
-
Valid properties:
PRODUCT
|CLASSIFICATION
|SEVERITY
- REDHAT_ENTERPRISE_LINUX
-
Valid properties:
PRODUCT
|CLASSIFICATION
|SEVERITY
- SUSE
-
Valid properties:
PRODUCT
|CLASSIFICATION
|SEVERITY
- UBUNTU
-
Valid properties:
PRODUCT
|PRIORITY
- WINDOWS
-
Valid properties:
PRODUCT
|PRODUCT_FAMILY
|CLASSIFICATION
|MSRC_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 Streamsoftware.amazon.awssdk.services.ssm.paginators.DescribePatchPropertiesIterable responses = client.describePatchPropertiesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
describePatchPropertiesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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
- See Also:
- AWS API Documentation
-
describePatchPropertiesPaginator
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 operations 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:
- AMAZON_LINUX
-
Valid properties:
PRODUCT
|CLASSIFICATION
|SEVERITY
- AMAZON_LINUX_2
-
Valid properties:
PRODUCT
|CLASSIFICATION
|SEVERITY
- CENTOS
-
Valid properties:
PRODUCT
|CLASSIFICATION
|SEVERITY
- DEBIAN
-
Valid properties:
PRODUCT
|PRIORITY
- MACOS
-
Valid properties:
PRODUCT
|CLASSIFICATION
- ORACLE_LINUX
-
Valid properties:
PRODUCT
|CLASSIFICATION
|SEVERITY
- REDHAT_ENTERPRISE_LINUX
-
Valid properties:
PRODUCT
|CLASSIFICATION
|SEVERITY
- SUSE
-
Valid properties:
PRODUCT
|CLASSIFICATION
|SEVERITY
- UBUNTU
-
Valid properties:
PRODUCT
|PRIORITY
- WINDOWS
-
Valid properties:
PRODUCT
|PRODUCT_FAMILY
|CLASSIFICATION
|MSRC_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 Streamsoftware.amazon.awssdk.services.ssm.paginators.DescribePatchPropertiesIterable responses = client.describePatchPropertiesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaDescribePatchPropertiesRequest.builder()
- Parameters:
describePatchPropertiesRequest
- AConsumer
that will call methods onDescribePatchPropertiesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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
- See Also:
- AWS API Documentation
-
describeSessions
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.
- Parameters:
describeSessionsRequest
-- Returns:
- Result of the DescribeSessions operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidFilterKeyException
- The specified key isn't valid.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
describeSessions
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 viaDescribeSessionsRequest.builder()
- Parameters:
describeSessionsRequest
- AConsumer
that will call methods onDescribeSessionsRequest.Builder
to create a request.- Returns:
- Result of the DescribeSessions operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidFilterKeyException
- The specified key isn't valid.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
describeSessionsPaginator
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 Streamsoftware.amazon.awssdk.services.ssm.paginators.DescribeSessionsIterable responses = client.describeSessionsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
describeSessionsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidFilterKeyException
- The specified key isn't valid.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
describeSessionsPaginator
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 Streamsoftware.amazon.awssdk.services.ssm.paginators.DescribeSessionsIterable responses = client.describeSessionsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaDescribeSessionsRequest.builder()
- Parameters:
describeSessionsRequest
- AConsumer
that will call methods onDescribeSessionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidFilterKeyException
- The specified key isn't valid.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
disassociateOpsItemRelatedItem
default DisassociateOpsItemRelatedItemResponse disassociateOpsItemRelatedItem(DisassociateOpsItemRelatedItemRequest disassociateOpsItemRelatedItemRequest) throws InternalServerErrorException, OpsItemRelatedItemAssociationNotFoundException, OpsItemNotFoundException, OpsItemInvalidParameterException, OpsItemConflictException, AwsServiceException, SdkClientException, SsmException
Deletes the association between an OpsItem and a related item. For example, this API operation can delete an Incident Manager incident from an OpsItem. Incident Manager is a capability of Amazon Web Services Systems Manager.
- Parameters:
disassociateOpsItemRelatedItemRequest
-- Returns:
- Result of the DisassociateOpsItemRelatedItem operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.OpsItemRelatedItemAssociationNotFoundException
- The association wasn't found using the parameters you specified in the call. Verify the information and try again.OpsItemNotFoundException
- The specified OpsItem ID doesn't exist. Verify the ID and try again.OpsItemInvalidParameterException
- A specified parameter argument isn't valid. Verify the available arguments and try again.OpsItemConflictException
- The specified OpsItem is in the process of being deleted.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
disassociateOpsItemRelatedItem
default DisassociateOpsItemRelatedItemResponse disassociateOpsItemRelatedItem(Consumer<DisassociateOpsItemRelatedItemRequest.Builder> disassociateOpsItemRelatedItemRequest) throws InternalServerErrorException, OpsItemRelatedItemAssociationNotFoundException, OpsItemNotFoundException, OpsItemInvalidParameterException, OpsItemConflictException, AwsServiceException, SdkClientException, SsmException
Deletes the association between an OpsItem and a related item. For example, this API operation can delete an Incident Manager incident from an OpsItem. Incident Manager is a capability of Amazon Web Services Systems Manager.
This is a convenience which creates an instance of the
DisassociateOpsItemRelatedItemRequest.Builder
avoiding the need to create one manually viaDisassociateOpsItemRelatedItemRequest.builder()
- Parameters:
disassociateOpsItemRelatedItemRequest
- AConsumer
that will call methods onDisassociateOpsItemRelatedItemRequest.Builder
to create a request.- Returns:
- Result of the DisassociateOpsItemRelatedItem operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.OpsItemRelatedItemAssociationNotFoundException
- The association wasn't found using the parameters you specified in the call. Verify the information and try again.OpsItemNotFoundException
- The specified OpsItem ID doesn't exist. Verify the ID and try again.OpsItemInvalidParameterException
- A specified parameter argument isn't valid. Verify the available arguments and try again.OpsItemConflictException
- The specified OpsItem is in the process of being deleted.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
getAutomationExecution
default GetAutomationExecutionResponse getAutomationExecution(GetAutomationExecutionRequest getAutomationExecutionRequest) throws AutomationExecutionNotFoundException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Get detailed information about a particular Automation execution.
- Parameters:
getAutomationExecutionRequest
-- Returns:
- Result of the GetAutomationExecution operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
getAutomationExecution
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 viaGetAutomationExecutionRequest.builder()
- Parameters:
getAutomationExecutionRequest
- AConsumer
that will call methods onGetAutomationExecutionRequest.Builder
to create a request.- Returns:
- Result of the GetAutomationExecution operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
getCalendarState
default GetCalendarStateResponse getCalendarState(GetCalendarStateRequest getCalendarStateRequest) throws InternalServerErrorException, InvalidDocumentException, InvalidDocumentTypeException, UnsupportedCalendarException, AwsServiceException, SdkClientException, SsmException
Gets the state of a Amazon Web Services Systems Manager change calendar at the current time or a specified time. If you specify a time,
GetCalendarState
returns the state of the calendar at that specific time, and returns the next time that the change calendar state will transition. If you don't specify a time,GetCalendarState
uses the current time. Change Calendar entries have two possible states:OPEN
orCLOSED
.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 isCLOSED
.For more information about Change Calendar, a capability of Amazon Web Services Systems Manager, see Amazon Web Services Systems Manager Change Calendar in the Amazon Web Services Systems Manager User Guide.
- Parameters:
getCalendarStateRequest
-- Returns:
- Result of the GetCalendarState operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidDocumentException
- The specified SSM document doesn't exist.InvalidDocumentTypeException
- The SSM document type isn't valid. Valid document types are described in theDocumentType
property.UnsupportedCalendarException
- The calendar entry contained in the specified SSM document isn't 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
- See Also:
- AWS API Documentation
-
getCalendarState
default GetCalendarStateResponse getCalendarState(Consumer<GetCalendarStateRequest.Builder> getCalendarStateRequest) throws InternalServerErrorException, InvalidDocumentException, InvalidDocumentTypeException, UnsupportedCalendarException, AwsServiceException, SdkClientException, SsmException
Gets the state of a Amazon Web Services Systems Manager change calendar at the current time or a specified time. If you specify a time,
GetCalendarState
returns the state of the calendar at that specific time, and returns the next time that the change calendar state will transition. If you don't specify a time,GetCalendarState
uses the current time. Change Calendar entries have two possible states:OPEN
orCLOSED
.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 isCLOSED
.For more information about Change Calendar, a capability of Amazon Web Services Systems Manager, see Amazon Web Services Systems Manager Change Calendar in the Amazon Web Services Systems Manager User Guide.
This is a convenience which creates an instance of the
GetCalendarStateRequest.Builder
avoiding the need to create one manually viaGetCalendarStateRequest.builder()
- Parameters:
getCalendarStateRequest
- AConsumer
that will call methods onGetCalendarStateRequest.Builder
to create a request.- Returns:
- Result of the GetCalendarState operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidDocumentException
- The specified SSM document doesn't exist.InvalidDocumentTypeException
- The SSM document type isn't valid. Valid document types are described in theDocumentType
property.UnsupportedCalendarException
- The calendar entry contained in the specified SSM document isn't 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
- See Also:
- AWS API Documentation
-
getCommandInvocation
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.
GetCommandInvocation
only gives the execution status of a plugin in a document. To get the command execution status on a specific managed node, use ListCommandInvocations. To get the command execution status across managed nodes, use ListCommands.- Parameters:
getCommandInvocationRequest
-- Returns:
- Result of the GetCommandInvocation operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidCommandIdException
- The specified command ID isn't valid. Verify the ID and try again.InvalidInstanceIdException
- The following problems can cause this exception:-
You don't have permission to access the managed node.
-
Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running.
-
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
-
The managed node isn't in valid state. Valid states are:
Running
,Pending
,Stopped
, andStopping
. Invalid states are:Shutting-down
andTerminated
.
-
InvalidPluginNameException
- The plugin name isn't valid.InvocationDoesNotExistException
- The command ID and managed node ID you specified didn't match any invocations. Verify the command ID and the managed node 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
- See Also:
- AWS API Documentation
-
getCommandInvocation
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.
GetCommandInvocation
only gives the execution status of a plugin in a document. To get the command execution status on a specific managed node, use ListCommandInvocations. To get the command execution status across managed nodes, use ListCommands.
This is a convenience which creates an instance of the
GetCommandInvocationRequest.Builder
avoiding the need to create one manually viaGetCommandInvocationRequest.builder()
- Parameters:
getCommandInvocationRequest
- AConsumer
that will call methods onGetCommandInvocationRequest.Builder
to create a request.- Returns:
- Result of the GetCommandInvocation operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidCommandIdException
- The specified command ID isn't valid. Verify the ID and try again.InvalidInstanceIdException
- The following problems can cause this exception:-
You don't have permission to access the managed node.
-
Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running.
-
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
-
The managed node isn't in valid state. Valid states are:
Running
,Pending
,Stopped
, andStopping
. Invalid states are:Shutting-down
andTerminated
.
-
InvalidPluginNameException
- The plugin name isn't valid.InvocationDoesNotExistException
- The command ID and managed node ID you specified didn't match any invocations. Verify the command ID and the managed node 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
- See Also:
- AWS API Documentation
-
getConnectionStatus
default GetConnectionStatusResponse getConnectionStatus(GetConnectionStatusRequest getConnectionStatusRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Retrieves the Session Manager connection status for a managed node to determine whether it is running and ready to receive Session Manager connections.
- Parameters:
getConnectionStatusRequest
-- Returns:
- Result of the GetConnectionStatus operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
getConnectionStatus
default GetConnectionStatusResponse getConnectionStatus(Consumer<GetConnectionStatusRequest.Builder> getConnectionStatusRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Retrieves the Session Manager connection status for a managed node 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 viaGetConnectionStatusRequest.builder()
- Parameters:
getConnectionStatusRequest
- AConsumer
that will call methods onGetConnectionStatusRequest.Builder
to create a request.- Returns:
- Result of the GetConnectionStatus operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
getDefaultPatchBaseline
default GetDefaultPatchBaselineResponse getDefaultPatchBaseline(GetDefaultPatchBaselineRequest getDefaultPatchBaselineRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Retrieves the default patch baseline. Amazon Web Services Systems Manager supports creating multiple default patch baselines. For example, you can create a default patch baseline for each operating system.
If you don't specify an operating system value, the default patch baseline for Windows is returned.
- Parameters:
getDefaultPatchBaselineRequest
-- Returns:
- Result of the GetDefaultPatchBaseline operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
getDefaultPatchBaseline
default GetDefaultPatchBaselineResponse getDefaultPatchBaseline(Consumer<GetDefaultPatchBaselineRequest.Builder> getDefaultPatchBaselineRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Retrieves the default patch baseline. Amazon Web Services Systems Manager supports creating multiple default patch baselines. For example, you can create a default patch baseline for each operating system.
If you don't 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 viaGetDefaultPatchBaselineRequest.builder()
- Parameters:
getDefaultPatchBaselineRequest
- AConsumer
that will call methods onGetDefaultPatchBaselineRequest.Builder
to create a request.- Returns:
- Result of the GetDefaultPatchBaseline operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
getDefaultPatchBaseline
default GetDefaultPatchBaselineResponse getDefaultPatchBaseline() throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Retrieves the default patch baseline. Amazon Web Services Systems Manager supports creating multiple default patch baselines. For example, you can create a default patch baseline for each operating system.
If you don't specify an operating system value, the default patch baseline for Windows is returned.
- Returns:
- Result of the GetDefaultPatchBaseline operation returned by the service.
- Throws:
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
- See Also:
getDefaultPatchBaseline(GetDefaultPatchBaselineRequest)
, AWS API Documentation
-
getDeployablePatchSnapshotForInstance
default GetDeployablePatchSnapshotForInstanceResponse getDeployablePatchSnapshotForInstance(GetDeployablePatchSnapshotForInstanceRequest getDeployablePatchSnapshotForInstanceRequest) throws InternalServerErrorException, UnsupportedOperatingSystemException, UnsupportedFeatureRequiredException, AwsServiceException, SdkClientException, SsmException
Retrieves the current snapshot for the patch baseline the managed node uses. This API is primarily used by the
AWS-RunPatchBaseline
Systems Manager document (SSM document).If you run the command locally, such as with the Command Line Interface (CLI), the system attempts to use your local Amazon Web Services credentials and the operation fails. To avoid this, you can run the command in the Amazon Web Services Systems Manager console. Use Run Command, a capability of Amazon Web Services Systems Manager, with an SSM document that enables you to target a managed node with a script or command. For example, run the command using the
AWS-RunShellScript
document or theAWS-RunPowerShellScript
document.- Parameters:
getDeployablePatchSnapshotForInstanceRequest
-- Returns:
- Result of the GetDeployablePatchSnapshotForInstance operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.UnsupportedOperatingSystemException
- The operating systems you specified isn't supported, or the operation isn't supported for the operating system.UnsupportedFeatureRequiredException
- Patching for applications released by Microsoft is only available on EC2 instances and advanced instances. To patch applications released by Microsoft on on-premises servers and VMs, you must enable advanced instances. For more information, see Enabling the advanced-instances tier in the Amazon Web Services 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
- See Also:
- AWS API Documentation
-
getDeployablePatchSnapshotForInstance
default GetDeployablePatchSnapshotForInstanceResponse getDeployablePatchSnapshotForInstance(Consumer<GetDeployablePatchSnapshotForInstanceRequest.Builder> getDeployablePatchSnapshotForInstanceRequest) throws InternalServerErrorException, UnsupportedOperatingSystemException, UnsupportedFeatureRequiredException, AwsServiceException, SdkClientException, SsmException
Retrieves the current snapshot for the patch baseline the managed node uses. This API is primarily used by the
AWS-RunPatchBaseline
Systems Manager document (SSM document).If you run the command locally, such as with the Command Line Interface (CLI), the system attempts to use your local Amazon Web Services credentials and the operation fails. To avoid this, you can run the command in the Amazon Web Services Systems Manager console. Use Run Command, a capability of Amazon Web Services Systems Manager, with an SSM document that enables you to target a managed node with a script or command. For example, run the command using the
AWS-RunShellScript
document or theAWS-RunPowerShellScript
document.
This is a convenience which creates an instance of the
GetDeployablePatchSnapshotForInstanceRequest.Builder
avoiding the need to create one manually viaGetDeployablePatchSnapshotForInstanceRequest.builder()
- Parameters:
getDeployablePatchSnapshotForInstanceRequest
- AConsumer
that will call methods onGetDeployablePatchSnapshotForInstanceRequest.Builder
to create a request.- Returns:
- Result of the GetDeployablePatchSnapshotForInstance operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.UnsupportedOperatingSystemException
- The operating systems you specified isn't supported, or the operation isn't supported for the operating system.UnsupportedFeatureRequiredException
- Patching for applications released by Microsoft is only available on EC2 instances and advanced instances. To patch applications released by Microsoft on on-premises servers and VMs, you must enable advanced instances. For more information, see Enabling the advanced-instances tier in the Amazon Web Services 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
- See Also:
- AWS API Documentation
-
getDocument
default GetDocumentResponse getDocument(GetDocumentRequest getDocumentRequest) throws InternalServerErrorException, InvalidDocumentException, InvalidDocumentVersionException, AwsServiceException, SdkClientException, SsmException
Gets the contents of the specified Amazon Web Services Systems Manager document (SSM document).
- Parameters:
getDocumentRequest
-- Returns:
- Result of the GetDocument operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidDocumentException
- The specified SSM document doesn't exist.InvalidDocumentVersionException
- The document version isn't valid or doesn't 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
- See Also:
- AWS API Documentation
-
getDocument
default GetDocumentResponse getDocument(Consumer<GetDocumentRequest.Builder> getDocumentRequest) throws InternalServerErrorException, InvalidDocumentException, InvalidDocumentVersionException, AwsServiceException, SdkClientException, SsmException
Gets the contents of the specified Amazon Web Services Systems Manager document (SSM document).
This is a convenience which creates an instance of the
GetDocumentRequest.Builder
avoiding the need to create one manually viaGetDocumentRequest.builder()
- Parameters:
getDocumentRequest
- AConsumer
that will call methods onGetDocumentRequest.Builder
to create a request.- Returns:
- Result of the GetDocument operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidDocumentException
- The specified SSM document doesn't exist.InvalidDocumentVersionException
- The document version isn't valid or doesn't 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
- See Also:
- AWS API Documentation
-
getInventory
default GetInventoryResponse getInventory(GetInventoryRequest getInventoryRequest) throws InternalServerErrorException, InvalidFilterException, InvalidInventoryGroupException, InvalidNextTokenException, InvalidTypeNameException, InvalidAggregatorException, InvalidResultAttributeException, AwsServiceException, SdkClientException, SsmException
Query inventory information. This includes managed node status, such as
Stopped
orTerminated
.- Parameters:
getInventoryRequest
-- Returns:
- Result of the GetInventory operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidFilterException
- The filter name isn't valid. Verify the you entered the correct name and try again.InvalidInventoryGroupException
- The specified inventory group isn't valid.InvalidNextTokenException
- The specified token isn't valid.InvalidTypeNameException
- The parameter type name isn't valid.InvalidAggregatorException
- The specified aggregator isn't valid for inventory groups. Verify that the aggregator uses a valid inventory type such asAWS:Application
orAWS:InstanceInformation
.InvalidResultAttributeException
- The specified inventory item result attribute isn't 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
- See Also:
- AWS API Documentation
-
getInventory
default GetInventoryResponse getInventory(Consumer<GetInventoryRequest.Builder> getInventoryRequest) throws InternalServerErrorException, InvalidFilterException, InvalidInventoryGroupException, InvalidNextTokenException, InvalidTypeNameException, InvalidAggregatorException, InvalidResultAttributeException, AwsServiceException, SdkClientException, SsmException
Query inventory information. This includes managed node status, such as
Stopped
orTerminated
.
This is a convenience which creates an instance of the
GetInventoryRequest.Builder
avoiding the need to create one manually viaGetInventoryRequest.builder()
- Parameters:
getInventoryRequest
- AConsumer
that will call methods onGetInventoryRequest.Builder
to create a request.- Returns:
- Result of the GetInventory operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidFilterException
- The filter name isn't valid. Verify the you entered the correct name and try again.InvalidInventoryGroupException
- The specified inventory group isn't valid.InvalidNextTokenException
- The specified token isn't valid.InvalidTypeNameException
- The parameter type name isn't valid.InvalidAggregatorException
- The specified aggregator isn't valid for inventory groups. Verify that the aggregator uses a valid inventory type such asAWS:Application
orAWS:InstanceInformation
.InvalidResultAttributeException
- The specified inventory item result attribute isn't 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
- See Also:
- AWS API Documentation
-
getInventory
default GetInventoryResponse getInventory() throws InternalServerErrorException, InvalidFilterException, InvalidInventoryGroupException, InvalidNextTokenException, InvalidTypeNameException, InvalidAggregatorException, InvalidResultAttributeException, AwsServiceException, SdkClientException, SsmException
Query inventory information. This includes managed node status, such as
Stopped
orTerminated
.- Returns:
- Result of the GetInventory operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidFilterException
- The filter name isn't valid. Verify the you entered the correct name and try again.InvalidInventoryGroupException
- The specified inventory group isn't valid.InvalidNextTokenException
- The specified token isn't valid.InvalidTypeNameException
- The parameter type name isn't valid.InvalidAggregatorException
- The specified aggregator isn't valid for inventory groups. Verify that the aggregator uses a valid inventory type such asAWS:Application
orAWS:InstanceInformation
.InvalidResultAttributeException
- The specified inventory item result attribute isn't 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
- See Also:
getInventory(GetInventoryRequest)
, AWS API Documentation
-
getInventoryPaginator
default GetInventoryIterable getInventoryPaginator() throws InternalServerErrorException, InvalidFilterException, InvalidInventoryGroupException, InvalidNextTokenException, InvalidTypeNameException, InvalidAggregatorException, InvalidResultAttributeException, AwsServiceException, SdkClientException, SsmException
Query inventory information. This includes managed node status, such as
Stopped
orTerminated
.
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 Streamsoftware.amazon.awssdk.services.ssm.paginators.GetInventoryIterable responses = client.getInventoryPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidFilterException
- The filter name isn't valid. Verify the you entered the correct name and try again.InvalidInventoryGroupException
- The specified inventory group isn't valid.InvalidNextTokenException
- The specified token isn't valid.InvalidTypeNameException
- The parameter type name isn't valid.InvalidAggregatorException
- The specified aggregator isn't valid for inventory groups. Verify that the aggregator uses a valid inventory type such asAWS:Application
orAWS:InstanceInformation
.InvalidResultAttributeException
- The specified inventory item result attribute isn't 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
- See Also:
getInventoryPaginator(GetInventoryRequest)
, AWS API Documentation
-
getInventoryPaginator
default GetInventoryIterable getInventoryPaginator(GetInventoryRequest getInventoryRequest) throws InternalServerErrorException, InvalidFilterException, InvalidInventoryGroupException, InvalidNextTokenException, InvalidTypeNameException, InvalidAggregatorException, InvalidResultAttributeException, AwsServiceException, SdkClientException, SsmException
Query inventory information. This includes managed node status, such as
Stopped
orTerminated
.
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 Streamsoftware.amazon.awssdk.services.ssm.paginators.GetInventoryIterable responses = client.getInventoryPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
getInventoryRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidFilterException
- The filter name isn't valid. Verify the you entered the correct name and try again.InvalidInventoryGroupException
- The specified inventory group isn't valid.InvalidNextTokenException
- The specified token isn't valid.InvalidTypeNameException
- The parameter type name isn't valid.InvalidAggregatorException
- The specified aggregator isn't valid for inventory groups. Verify that the aggregator uses a valid inventory type such asAWS:Application
orAWS:InstanceInformation
.InvalidResultAttributeException
- The specified inventory item result attribute isn't 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
- See Also:
- AWS API Documentation
-
getInventoryPaginator
default GetInventoryIterable getInventoryPaginator(Consumer<GetInventoryRequest.Builder> getInventoryRequest) throws InternalServerErrorException, InvalidFilterException, InvalidInventoryGroupException, InvalidNextTokenException, InvalidTypeNameException, InvalidAggregatorException, InvalidResultAttributeException, AwsServiceException, SdkClientException, SsmException
Query inventory information. This includes managed node status, such as
Stopped
orTerminated
.
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 Streamsoftware.amazon.awssdk.services.ssm.paginators.GetInventoryIterable responses = client.getInventoryPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaGetInventoryRequest.builder()
- Parameters:
getInventoryRequest
- AConsumer
that will call methods onGetInventoryRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidFilterException
- The filter name isn't valid. Verify the you entered the correct name and try again.InvalidInventoryGroupException
- The specified inventory group isn't valid.InvalidNextTokenException
- The specified token isn't valid.InvalidTypeNameException
- The parameter type name isn't valid.InvalidAggregatorException
- The specified aggregator isn't valid for inventory groups. Verify that the aggregator uses a valid inventory type such asAWS:Application
orAWS:InstanceInformation
.InvalidResultAttributeException
- The specified inventory item result attribute isn't 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
- See Also:
- AWS API Documentation
-
getInventorySchema
default 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.
- Parameters:
getInventorySchemaRequest
-- Returns:
- Result of the GetInventorySchema operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidTypeNameException
- The parameter type name isn't valid.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
getInventorySchema
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 viaGetInventorySchemaRequest.builder()
- Parameters:
getInventorySchemaRequest
- AConsumer
that will call methods onGetInventorySchemaRequest.Builder
to create a request.- Returns:
- Result of the GetInventorySchema operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidTypeNameException
- The parameter type name isn't valid.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
getInventorySchema
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.
- Returns:
- Result of the GetInventorySchema operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidTypeNameException
- The parameter type name isn't valid.InvalidNextTokenException
- The specified token isn't 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
- See Also:
getInventorySchema(GetInventorySchemaRequest)
, AWS API Documentation
-
getInventorySchemaPaginator
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 Streamsoftware.amazon.awssdk.services.ssm.paginators.GetInventorySchemaIterable responses = client.getInventorySchemaPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidTypeNameException
- The parameter type name isn't valid.InvalidNextTokenException
- The specified token isn't 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
- See Also:
getInventorySchemaPaginator(GetInventorySchemaRequest)
, AWS API Documentation
-
getInventorySchemaPaginator
default 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 Streamsoftware.amazon.awssdk.services.ssm.paginators.GetInventorySchemaIterable responses = client.getInventorySchemaPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
getInventorySchemaRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidTypeNameException
- The parameter type name isn't valid.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
getInventorySchemaPaginator
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 Streamsoftware.amazon.awssdk.services.ssm.paginators.GetInventorySchemaIterable responses = client.getInventorySchemaPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaGetInventorySchemaRequest.builder()
- Parameters:
getInventorySchemaRequest
- AConsumer
that will call methods onGetInventorySchemaRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidTypeNameException
- The parameter type name isn't valid.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
getMaintenanceWindow
default GetMaintenanceWindowResponse getMaintenanceWindow(GetMaintenanceWindowRequest getMaintenanceWindowRequest) throws DoesNotExistException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Retrieves a maintenance window.
- Parameters:
getMaintenanceWindowRequest
-- Returns:
- Result of the GetMaintenanceWindow operation returned by the service.
- Throws:
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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services 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
- See Also:
- AWS API Documentation
-
getMaintenanceWindow
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 viaGetMaintenanceWindowRequest.builder()
- Parameters:
getMaintenanceWindowRequest
- AConsumer
that will call methods onGetMaintenanceWindowRequest.Builder
to create a request.- Returns:
- Result of the GetMaintenanceWindow operation returned by the service.
- Throws:
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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services 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
- See Also:
- AWS API Documentation
-
getMaintenanceWindowExecution
default GetMaintenanceWindowExecutionResponse getMaintenanceWindowExecution(GetMaintenanceWindowExecutionRequest getMaintenanceWindowExecutionRequest) throws DoesNotExistException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Retrieves details about a specific a maintenance window execution.
- Parameters:
getMaintenanceWindowExecutionRequest
-- Returns:
- Result of the GetMaintenanceWindowExecution operation returned by the service.
- Throws:
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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services 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
- See Also:
- AWS API Documentation
-
getMaintenanceWindowExecution
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 viaGetMaintenanceWindowExecutionRequest.builder()
- Parameters:
getMaintenanceWindowExecutionRequest
- AConsumer
that will call methods onGetMaintenanceWindowExecutionRequest.Builder
to create a request.- Returns:
- Result of the GetMaintenanceWindowExecution operation returned by the service.
- Throws:
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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services 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
- See Also:
- AWS API Documentation
-
getMaintenanceWindowExecutionTask
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.
- Parameters:
getMaintenanceWindowExecutionTaskRequest
-- Returns:
- Result of the GetMaintenanceWindowExecutionTask operation returned by the service.
- Throws:
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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services 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
- See Also:
- AWS API Documentation
-
getMaintenanceWindowExecutionTask
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 viaGetMaintenanceWindowExecutionTaskRequest.builder()
- Parameters:
getMaintenanceWindowExecutionTaskRequest
- AConsumer
that will call methods onGetMaintenanceWindowExecutionTaskRequest.Builder
to create a request.- Returns:
- Result of the GetMaintenanceWindowExecutionTask operation returned by the service.
- Throws:
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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services 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
- See Also:
- AWS API Documentation
-
getMaintenanceWindowExecutionTaskInvocation
default GetMaintenanceWindowExecutionTaskInvocationResponse getMaintenanceWindowExecutionTaskInvocation(GetMaintenanceWindowExecutionTaskInvocationRequest getMaintenanceWindowExecutionTaskInvocationRequest) throws DoesNotExistException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Retrieves information about a specific task running on a specific target.
- Parameters:
getMaintenanceWindowExecutionTaskInvocationRequest
-- Returns:
- Result of the GetMaintenanceWindowExecutionTaskInvocation operation returned by the service.
- Throws:
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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services 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
- See Also:
- AWS API Documentation
-
getMaintenanceWindowExecutionTaskInvocation
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 viaGetMaintenanceWindowExecutionTaskInvocationRequest.builder()
- Parameters:
getMaintenanceWindowExecutionTaskInvocationRequest
- AConsumer
that will call methods onGetMaintenanceWindowExecutionTaskInvocationRequest.Builder
to create a request.- Returns:
- Result of the GetMaintenanceWindowExecutionTaskInvocation operation returned by the service.
- Throws:
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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services 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
- See Also:
- AWS API Documentation
-
getMaintenanceWindowTask
default GetMaintenanceWindowTaskResponse getMaintenanceWindowTask(GetMaintenanceWindowTaskRequest getMaintenanceWindowTaskRequest) throws DoesNotExistException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Retrieves the details of a maintenance window task.
For maintenance window tasks without a specified target, you can't supply values for
--max-errors
and--max-concurrency
. Instead, the system inserts a placeholder value of1
, which may be reported in the response to this command. These values don't affect the running of your task and can be ignored.To retrieve a list of tasks in a maintenance window, instead use the DescribeMaintenanceWindowTasks command.
- Parameters:
getMaintenanceWindowTaskRequest
-- Returns:
- Result of the GetMaintenanceWindowTask operation returned by the service.
- Throws:
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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services 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
- See Also:
- AWS API Documentation
-
getMaintenanceWindowTask
default GetMaintenanceWindowTaskResponse getMaintenanceWindowTask(Consumer<GetMaintenanceWindowTaskRequest.Builder> getMaintenanceWindowTaskRequest) throws DoesNotExistException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Retrieves the details of a maintenance window task.
For maintenance window tasks without a specified target, you can't supply values for
--max-errors
and--max-concurrency
. Instead, the system inserts a placeholder value of1
, which may be reported in the response to this command. These values don't affect the running of your task and can be ignored.To retrieve a list of tasks in a maintenance window, instead use the DescribeMaintenanceWindowTasks command.
This is a convenience which creates an instance of the
GetMaintenanceWindowTaskRequest.Builder
avoiding the need to create one manually viaGetMaintenanceWindowTaskRequest.builder()
- Parameters:
getMaintenanceWindowTaskRequest
- AConsumer
that will call methods onGetMaintenanceWindowTaskRequest.Builder
to create a request.- Returns:
- Result of the GetMaintenanceWindowTask operation returned by the service.
- Throws:
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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services 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
- See Also:
- AWS API Documentation
-
getOpsItem
default GetOpsItemResponse getOpsItem(GetOpsItemRequest getOpsItemRequest) throws InternalServerErrorException, OpsItemNotFoundException, OpsItemAccessDeniedException, AwsServiceException, SdkClientException, SsmException
Get information about an OpsItem by using the ID. You must have permission in Identity and Access Management (IAM) to view information about an OpsItem. For more information, see Set up OpsCenter in the Amazon Web Services Systems Manager User Guide.
Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For more information, see OpsCenter in the Amazon Web Services Systems Manager User Guide.
- Parameters:
getOpsItemRequest
-- Returns:
- Result of the GetOpsItem operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.OpsItemNotFoundException
- The specified OpsItem ID doesn't exist. Verify the ID and try again.OpsItemAccessDeniedException
- You don't have permission to view OpsItems in the specified account. Verify that your account is configured either as a Systems Manager delegated administrator or that you are logged into the Organizations management account.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
getOpsItem
default GetOpsItemResponse getOpsItem(Consumer<GetOpsItemRequest.Builder> getOpsItemRequest) throws InternalServerErrorException, OpsItemNotFoundException, OpsItemAccessDeniedException, AwsServiceException, SdkClientException, SsmException
Get information about an OpsItem by using the ID. You must have permission in Identity and Access Management (IAM) to view information about an OpsItem. For more information, see Set up OpsCenter in the Amazon Web Services Systems Manager User Guide.
Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For more information, see OpsCenter in the Amazon Web Services Systems Manager User Guide.
This is a convenience which creates an instance of the
GetOpsItemRequest.Builder
avoiding the need to create one manually viaGetOpsItemRequest.builder()
- Parameters:
getOpsItemRequest
- AConsumer
that will call methods onGetOpsItemRequest.Builder
to create a request.- Returns:
- Result of the GetOpsItem operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.OpsItemNotFoundException
- The specified OpsItem ID doesn't exist. Verify the ID and try again.OpsItemAccessDeniedException
- You don't have permission to view OpsItems in the specified account. Verify that your account is configured either as a Systems Manager delegated administrator or that you are logged into the Organizations management account.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
getOpsMetadata
default GetOpsMetadataResponse getOpsMetadata(GetOpsMetadataRequest getOpsMetadataRequest) throws OpsMetadataNotFoundException, OpsMetadataInvalidArgumentException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
View operational metadata related to an application in Application Manager.
- Parameters:
getOpsMetadataRequest
-- Returns:
- Result of the GetOpsMetadata operation returned by the service.
- Throws:
OpsMetadataNotFoundException
- The OpsMetadata object doesn't exist.OpsMetadataInvalidArgumentException
- One of the arguments passed is invalid.InternalServerErrorException
- An error occurred on the server side.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
getOpsMetadata
default GetOpsMetadataResponse getOpsMetadata(Consumer<GetOpsMetadataRequest.Builder> getOpsMetadataRequest) throws OpsMetadataNotFoundException, OpsMetadataInvalidArgumentException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
View operational metadata related to an application in Application Manager.
This is a convenience which creates an instance of the
GetOpsMetadataRequest.Builder
avoiding the need to create one manually viaGetOpsMetadataRequest.builder()
- Parameters:
getOpsMetadataRequest
- AConsumer
that will call methods onGetOpsMetadataRequest.Builder
to create a request.- Returns:
- Result of the GetOpsMetadata operation returned by the service.
- Throws:
OpsMetadataNotFoundException
- The OpsMetadata object doesn't exist.OpsMetadataInvalidArgumentException
- One of the arguments passed is invalid.InternalServerErrorException
- An error occurred on the server side.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
getOpsSummary
default GetOpsSummaryResponse getOpsSummary(GetOpsSummaryRequest getOpsSummaryRequest) throws InternalServerErrorException, ResourceDataSyncNotFoundException, InvalidFilterException, InvalidNextTokenException, InvalidTypeNameException, InvalidAggregatorException, AwsServiceException, SdkClientException, SsmException
View a summary of operations metadata (OpsData) based on specified filters and aggregators. OpsData can include information about Amazon Web Services Systems Manager OpsCenter operational workitems (OpsItems) as well as information about any Amazon Web Services resource or service configured to report OpsData to Amazon Web Services Systems Manager Explorer.
- Parameters:
getOpsSummaryRequest
-- Returns:
- Result of the GetOpsSummary operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.ResourceDataSyncNotFoundException
- The specified sync name wasn't found.InvalidFilterException
- The filter name isn't valid. Verify the you entered the correct name and try again.InvalidNextTokenException
- The specified token isn't valid.InvalidTypeNameException
- The parameter type name isn't valid.InvalidAggregatorException
- The specified aggregator isn't valid for inventory groups. Verify that the aggregator uses a valid inventory type such asAWS:Application
orAWS: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
- See Also:
- AWS API Documentation
-
getOpsSummary
default GetOpsSummaryResponse getOpsSummary(Consumer<GetOpsSummaryRequest.Builder> getOpsSummaryRequest) throws InternalServerErrorException, ResourceDataSyncNotFoundException, InvalidFilterException, InvalidNextTokenException, InvalidTypeNameException, InvalidAggregatorException, AwsServiceException, SdkClientException, SsmException
View a summary of operations metadata (OpsData) based on specified filters and aggregators. OpsData can include information about Amazon Web Services Systems Manager OpsCenter operational workitems (OpsItems) as well as information about any Amazon Web Services resource or service configured to report OpsData to Amazon Web Services Systems Manager Explorer.
This is a convenience which creates an instance of the
GetOpsSummaryRequest.Builder
avoiding the need to create one manually viaGetOpsSummaryRequest.builder()
- Parameters:
getOpsSummaryRequest
- AConsumer
that will call methods onGetOpsSummaryRequest.Builder
to create a request.- Returns:
- Result of the GetOpsSummary operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.ResourceDataSyncNotFoundException
- The specified sync name wasn't found.InvalidFilterException
- The filter name isn't valid. Verify the you entered the correct name and try again.InvalidNextTokenException
- The specified token isn't valid.InvalidTypeNameException
- The parameter type name isn't valid.InvalidAggregatorException
- The specified aggregator isn't valid for inventory groups. Verify that the aggregator uses a valid inventory type such asAWS:Application
orAWS: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
- See Also:
- AWS API Documentation
-
getOpsSummaryPaginator
default GetOpsSummaryIterable getOpsSummaryPaginator(GetOpsSummaryRequest getOpsSummaryRequest) throws InternalServerErrorException, ResourceDataSyncNotFoundException, InvalidFilterException, InvalidNextTokenException, InvalidTypeNameException, InvalidAggregatorException, AwsServiceException, SdkClientException, SsmException
View a summary of operations metadata (OpsData) based on specified filters and aggregators. OpsData can include information about Amazon Web Services Systems Manager OpsCenter operational workitems (OpsItems) as well as information about any Amazon Web Services resource or service configured to report OpsData to Amazon Web Services Systems Manager Explorer.
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 Streamsoftware.amazon.awssdk.services.ssm.paginators.GetOpsSummaryIterable responses = client.getOpsSummaryPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
getOpsSummaryRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerErrorException
- An error occurred on the server side.ResourceDataSyncNotFoundException
- The specified sync name wasn't found.InvalidFilterException
- The filter name isn't valid. Verify the you entered the correct name and try again.InvalidNextTokenException
- The specified token isn't valid.InvalidTypeNameException
- The parameter type name isn't valid.InvalidAggregatorException
- The specified aggregator isn't valid for inventory groups. Verify that the aggregator uses a valid inventory type such asAWS:Application
orAWS: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
- See Also:
- AWS API Documentation
-
getOpsSummaryPaginator
default GetOpsSummaryIterable getOpsSummaryPaginator(Consumer<GetOpsSummaryRequest.Builder> getOpsSummaryRequest) throws InternalServerErrorException, ResourceDataSyncNotFoundException, InvalidFilterException, InvalidNextTokenException, InvalidTypeNameException, InvalidAggregatorException, AwsServiceException, SdkClientException, SsmException
View a summary of operations metadata (OpsData) based on specified filters and aggregators. OpsData can include information about Amazon Web Services Systems Manager OpsCenter operational workitems (OpsItems) as well as information about any Amazon Web Services resource or service configured to report OpsData to Amazon Web Services Systems Manager Explorer.
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 Streamsoftware.amazon.awssdk.services.ssm.paginators.GetOpsSummaryIterable responses = client.getOpsSummaryPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaGetOpsSummaryRequest.builder()
- Parameters:
getOpsSummaryRequest
- AConsumer
that will call methods onGetOpsSummaryRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerErrorException
- An error occurred on the server side.ResourceDataSyncNotFoundException
- The specified sync name wasn't found.InvalidFilterException
- The filter name isn't valid. Verify the you entered the correct name and try again.InvalidNextTokenException
- The specified token isn't valid.InvalidTypeNameException
- The parameter type name isn't valid.InvalidAggregatorException
- The specified aggregator isn't valid for inventory groups. Verify that the aggregator uses a valid inventory type such asAWS:Application
orAWS: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
- See Also:
- AWS API Documentation
-
getParameter
default GetParameterResponse getParameter(GetParameterRequest getParameterRequest) throws InternalServerErrorException, InvalidKeyIdException, ParameterNotFoundException, ParameterVersionNotFoundException, AwsServiceException, SdkClientException, SsmException
Get information about a single parameter by specifying the parameter name.
To get information about more than one parameter at a time, use the GetParameters operation.
- Parameters:
getParameterRequest
-- Returns:
- Result of the GetParameter operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidKeyIdException
- The query key ID isn't valid.ParameterNotFoundException
- The parameter couldn't be found. Verify the name and try again.ParameterVersionNotFoundException
- The specified parameter version wasn't 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
- See Also:
- AWS API Documentation
-
getParameter
default GetParameterResponse getParameter(Consumer<GetParameterRequest.Builder> getParameterRequest) throws InternalServerErrorException, InvalidKeyIdException, ParameterNotFoundException, ParameterVersionNotFoundException, AwsServiceException, SdkClientException, SsmException
Get information about a single parameter by specifying the parameter name.
To get information about more than one parameter at a time, use the GetParameters operation.
This is a convenience which creates an instance of the
GetParameterRequest.Builder
avoiding the need to create one manually viaGetParameterRequest.builder()
- Parameters:
getParameterRequest
- AConsumer
that will call methods onGetParameterRequest.Builder
to create a request.- Returns:
- Result of the GetParameter operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidKeyIdException
- The query key ID isn't valid.ParameterNotFoundException
- The parameter couldn't be found. Verify the name and try again.ParameterVersionNotFoundException
- The specified parameter version wasn't 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
- See Also:
- AWS API Documentation
-
getParameterHistory
default GetParameterHistoryResponse getParameterHistory(GetParameterHistoryRequest getParameterHistoryRequest) throws InternalServerErrorException, ParameterNotFoundException, InvalidNextTokenException, InvalidKeyIdException, AwsServiceException, SdkClientException, SsmException
Retrieves the history of all changes to a parameter.
If you change the KMS key alias for the KMS key used to encrypt a parameter, then you must also update the key alias the parameter uses to reference KMS. Otherwise,
GetParameterHistory
retrieves whatever the original key alias was referencing.- Parameters:
getParameterHistoryRequest
-- Returns:
- Result of the GetParameterHistory operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.ParameterNotFoundException
- The parameter couldn't be found. Verify the name and try again.InvalidNextTokenException
- The specified token isn't valid.InvalidKeyIdException
- The query key ID isn't 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
- See Also:
- AWS API Documentation
-
getParameterHistory
default GetParameterHistoryResponse getParameterHistory(Consumer<GetParameterHistoryRequest.Builder> getParameterHistoryRequest) throws InternalServerErrorException, ParameterNotFoundException, InvalidNextTokenException, InvalidKeyIdException, AwsServiceException, SdkClientException, SsmException
Retrieves the history of all changes to a parameter.
If you change the KMS key alias for the KMS key used to encrypt a parameter, then you must also update the key alias the parameter uses to reference KMS. Otherwise,
GetParameterHistory
retrieves whatever the original key alias was referencing.
This is a convenience which creates an instance of the
GetParameterHistoryRequest.Builder
avoiding the need to create one manually viaGetParameterHistoryRequest.builder()
- Parameters:
getParameterHistoryRequest
- AConsumer
that will call methods onGetParameterHistoryRequest.Builder
to create a request.- Returns:
- Result of the GetParameterHistory operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.ParameterNotFoundException
- The parameter couldn't be found. Verify the name and try again.InvalidNextTokenException
- The specified token isn't valid.InvalidKeyIdException
- The query key ID isn't 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
- See Also:
- AWS API Documentation
-
getParameterHistoryPaginator
default GetParameterHistoryIterable getParameterHistoryPaginator(GetParameterHistoryRequest getParameterHistoryRequest) throws InternalServerErrorException, ParameterNotFoundException, InvalidNextTokenException, InvalidKeyIdException, AwsServiceException, SdkClientException, SsmException
Retrieves the history of all changes to a parameter.
If you change the KMS key alias for the KMS key used to encrypt a parameter, then you must also update the key alias the parameter uses to reference KMS. Otherwise,
GetParameterHistory
retrieves whatever the original key alias was referencing.
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 Streamsoftware.amazon.awssdk.services.ssm.paginators.GetParameterHistoryIterable responses = client.getParameterHistoryPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
getParameterHistoryRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerErrorException
- An error occurred on the server side.ParameterNotFoundException
- The parameter couldn't be found. Verify the name and try again.InvalidNextTokenException
- The specified token isn't valid.InvalidKeyIdException
- The query key ID isn't 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
- See Also:
- AWS API Documentation
-
getParameterHistoryPaginator
default GetParameterHistoryIterable getParameterHistoryPaginator(Consumer<GetParameterHistoryRequest.Builder> getParameterHistoryRequest) throws InternalServerErrorException, ParameterNotFoundException, InvalidNextTokenException, InvalidKeyIdException, AwsServiceException, SdkClientException, SsmException
Retrieves the history of all changes to a parameter.
If you change the KMS key alias for the KMS key used to encrypt a parameter, then you must also update the key alias the parameter uses to reference KMS. Otherwise,
GetParameterHistory
retrieves whatever the original key alias was referencing.
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 Streamsoftware.amazon.awssdk.services.ssm.paginators.GetParameterHistoryIterable responses = client.getParameterHistoryPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaGetParameterHistoryRequest.builder()
- Parameters:
getParameterHistoryRequest
- AConsumer
that will call methods onGetParameterHistoryRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerErrorException
- An error occurred on the server side.ParameterNotFoundException
- The parameter couldn't be found. Verify the name and try again.InvalidNextTokenException
- The specified token isn't valid.InvalidKeyIdException
- The query key ID isn't 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
- See Also:
- AWS API Documentation
-
getParameters
default GetParametersResponse getParameters(GetParametersRequest getParametersRequest) throws InvalidKeyIdException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Get information about one or more parameters by specifying multiple parameter names.
To get information about a single parameter, you can use the GetParameter operation instead.
- Parameters:
getParametersRequest
-- Returns:
- Result of the GetParameters operation returned by the service.
- Throws:
InvalidKeyIdException
- The query key ID isn't 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
- See Also:
- AWS API Documentation
-
getParameters
default GetParametersResponse getParameters(Consumer<GetParametersRequest.Builder> getParametersRequest) throws InvalidKeyIdException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Get information about one or more parameters by specifying multiple parameter names.
To get information about a single parameter, you can use the GetParameter operation instead.
This is a convenience which creates an instance of the
GetParametersRequest.Builder
avoiding the need to create one manually viaGetParametersRequest.builder()
- Parameters:
getParametersRequest
- AConsumer
that will call methods onGetParametersRequest.Builder
to create a request.- Returns:
- Result of the GetParameters operation returned by the service.
- Throws:
InvalidKeyIdException
- The query key ID isn't 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
- See Also:
- AWS API Documentation
-
getParametersByPath
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 ofMaxResults
. 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 aNextToken
. You can specify theNextToken
in a subsequent call to get the next set of results.- Parameters:
getParametersByPathRequest
-- Returns:
- Result of the GetParametersByPath operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidFilterKeyException
- The specified key isn't valid.InvalidFilterOptionException
- The specified filter option isn't valid. Valid options are Equals and BeginsWith. For Path filter, valid options are Recursive and OneLevel.InvalidFilterValueException
- The filter value isn't valid. Verify the value and try again.InvalidKeyIdException
- The query key ID isn't valid.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
getParametersByPath
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 ofMaxResults
. 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 aNextToken
. You can specify theNextToken
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 viaGetParametersByPathRequest.builder()
- Parameters:
getParametersByPathRequest
- AConsumer
that will call methods onGetParametersByPathRequest.Builder
to create a request.- Returns:
- Result of the GetParametersByPath operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidFilterKeyException
- The specified key isn't valid.InvalidFilterOptionException
- The specified filter option isn't valid. Valid options are Equals and BeginsWith. For Path filter, valid options are Recursive and OneLevel.InvalidFilterValueException
- The filter value isn't valid. Verify the value and try again.InvalidKeyIdException
- The query key ID isn't valid.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
getParametersByPathPaginator
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 ofMaxResults
. 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 aNextToken
. You can specify theNextToken
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 Streamsoftware.amazon.awssdk.services.ssm.paginators.GetParametersByPathIterable responses = client.getParametersByPathPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
getParametersByPathRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidFilterKeyException
- The specified key isn't valid.InvalidFilterOptionException
- The specified filter option isn't valid. Valid options are Equals and BeginsWith. For Path filter, valid options are Recursive and OneLevel.InvalidFilterValueException
- The filter value isn't valid. Verify the value and try again.InvalidKeyIdException
- The query key ID isn't valid.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
getParametersByPathPaginator
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 ofMaxResults
. 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 aNextToken
. You can specify theNextToken
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 Streamsoftware.amazon.awssdk.services.ssm.paginators.GetParametersByPathIterable responses = client.getParametersByPathPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaGetParametersByPathRequest.builder()
- Parameters:
getParametersByPathRequest
- AConsumer
that will call methods onGetParametersByPathRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidFilterKeyException
- The specified key isn't valid.InvalidFilterOptionException
- The specified filter option isn't valid. Valid options are Equals and BeginsWith. For Path filter, valid options are Recursive and OneLevel.InvalidFilterValueException
- The filter value isn't valid. Verify the value and try again.InvalidKeyIdException
- The query key ID isn't valid.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
getPatchBaseline
default GetPatchBaselineResponse getPatchBaseline(GetPatchBaselineRequest getPatchBaselineRequest) throws DoesNotExistException, InvalidResourceIdException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Retrieves information about a patch baseline.
- Parameters:
getPatchBaselineRequest
-- Returns:
- Result of the GetPatchBaseline operation returned by the service.
- Throws:
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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.
InvalidResourceIdException
- The resource ID isn't 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
- See Also:
- AWS API Documentation
-
getPatchBaseline
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 viaGetPatchBaselineRequest.builder()
- Parameters:
getPatchBaselineRequest
- AConsumer
that will call methods onGetPatchBaselineRequest.Builder
to create a request.- Returns:
- Result of the GetPatchBaseline operation returned by the service.
- Throws:
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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.
InvalidResourceIdException
- The resource ID isn't 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
- See Also:
- AWS API Documentation
-
getPatchBaselineForPatchGroup
default GetPatchBaselineForPatchGroupResponse getPatchBaselineForPatchGroup(GetPatchBaselineForPatchGroupRequest getPatchBaselineForPatchGroupRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Retrieves the patch baseline that should be used for the specified patch group.
- Parameters:
getPatchBaselineForPatchGroupRequest
-- Returns:
- Result of the GetPatchBaselineForPatchGroup operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
getPatchBaselineForPatchGroup
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 viaGetPatchBaselineForPatchGroupRequest.builder()
- Parameters:
getPatchBaselineForPatchGroupRequest
- AConsumer
that will call methods onGetPatchBaselineForPatchGroupRequest.Builder
to create a request.- Returns:
- Result of the GetPatchBaselineForPatchGroup operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
getResourcePolicies
default GetResourcePoliciesResponse getResourcePolicies(GetResourcePoliciesRequest getResourcePoliciesRequest) throws InternalServerErrorException, ResourcePolicyInvalidParameterException, AwsServiceException, SdkClientException, SsmException
Returns an array of the
Policy
object.- Parameters:
getResourcePoliciesRequest
-- Returns:
- Result of the GetResourcePolicies operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.ResourcePolicyInvalidParameterException
- One or more parameters specified for the call aren't valid. Verify the parameters and their values 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
- See Also:
- AWS API Documentation
-
getResourcePolicies
default GetResourcePoliciesResponse getResourcePolicies(Consumer<GetResourcePoliciesRequest.Builder> getResourcePoliciesRequest) throws InternalServerErrorException, ResourcePolicyInvalidParameterException, AwsServiceException, SdkClientException, SsmException
Returns an array of the
Policy
object.
This is a convenience which creates an instance of the
GetResourcePoliciesRequest.Builder
avoiding the need to create one manually viaGetResourcePoliciesRequest.builder()
- Parameters:
getResourcePoliciesRequest
- AConsumer
that will call methods onGetResourcePoliciesRequest.Builder
to create a request.- Returns:
- Result of the GetResourcePolicies operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.ResourcePolicyInvalidParameterException
- One or more parameters specified for the call aren't valid. Verify the parameters and their values 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
- See Also:
- AWS API Documentation
-
getResourcePoliciesPaginator
default GetResourcePoliciesIterable getResourcePoliciesPaginator(GetResourcePoliciesRequest getResourcePoliciesRequest) throws InternalServerErrorException, ResourcePolicyInvalidParameterException, AwsServiceException, SdkClientException, SsmException
Returns an array of the
Policy
object.
This is a variant of
getResourcePolicies(software.amazon.awssdk.services.ssm.model.GetResourcePoliciesRequest)
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 Streamsoftware.amazon.awssdk.services.ssm.paginators.GetResourcePoliciesIterable responses = client.getResourcePoliciesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ssm.paginators.GetResourcePoliciesIterable responses = client .getResourcePoliciesPaginator(request); for (software.amazon.awssdk.services.ssm.model.GetResourcePoliciesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ssm.paginators.GetResourcePoliciesIterable responses = client.getResourcePoliciesPaginator(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
getResourcePolicies(software.amazon.awssdk.services.ssm.model.GetResourcePoliciesRequest)
operation.- Parameters:
getResourcePoliciesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerErrorException
- An error occurred on the server side.ResourcePolicyInvalidParameterException
- One or more parameters specified for the call aren't valid. Verify the parameters and their values 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
- See Also:
- AWS API Documentation
-
getResourcePoliciesPaginator
default GetResourcePoliciesIterable getResourcePoliciesPaginator(Consumer<GetResourcePoliciesRequest.Builder> getResourcePoliciesRequest) throws InternalServerErrorException, ResourcePolicyInvalidParameterException, AwsServiceException, SdkClientException, SsmException
Returns an array of the
Policy
object.
This is a variant of
getResourcePolicies(software.amazon.awssdk.services.ssm.model.GetResourcePoliciesRequest)
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 Streamsoftware.amazon.awssdk.services.ssm.paginators.GetResourcePoliciesIterable responses = client.getResourcePoliciesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ssm.paginators.GetResourcePoliciesIterable responses = client .getResourcePoliciesPaginator(request); for (software.amazon.awssdk.services.ssm.model.GetResourcePoliciesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ssm.paginators.GetResourcePoliciesIterable responses = client.getResourcePoliciesPaginator(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
getResourcePolicies(software.amazon.awssdk.services.ssm.model.GetResourcePoliciesRequest)
operation.This is a convenience which creates an instance of the
GetResourcePoliciesRequest.Builder
avoiding the need to create one manually viaGetResourcePoliciesRequest.builder()
- Parameters:
getResourcePoliciesRequest
- AConsumer
that will call methods onGetResourcePoliciesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerErrorException
- An error occurred on the server side.ResourcePolicyInvalidParameterException
- One or more parameters specified for the call aren't valid. Verify the parameters and their values 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
- See Also:
- AWS API Documentation
-
getServiceSetting
default GetServiceSettingResponse getServiceSetting(GetServiceSettingRequest getServiceSettingRequest) throws InternalServerErrorException, ServiceSettingNotFoundException, AwsServiceException, SdkClientException, SsmException
ServiceSetting
is an account-level setting for an Amazon Web Services service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an Amazon Web Services service charges money to the account based on feature or service usage, then the Amazon Web Services service team might create a default setting offalse
. This means the user can't use this feature unless they change the setting totrue
and intentionally opt in for a paid feature.Services map a
SettingId
object to a setting value. Amazon Web Services services teams define the default value for aSettingId
. You can't create a newSettingId
, but you can overwrite the default value if you have thessm:UpdateServiceSetting
permission for the setting. Use the UpdateServiceSetting API operation to change the default setting. Or use the ResetServiceSetting to change the value back to the original value defined by the Amazon Web Services service team.Query the current service setting for the Amazon Web Services account.
- Parameters:
getServiceSettingRequest
- The request body of the GetServiceSetting API operation.- Returns:
- Result of the GetServiceSetting operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.ServiceSettingNotFoundException
- The specified service setting wasn't found. Either the service name or the setting hasn't been provisioned by the Amazon Web Services 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
- See Also:
- AWS API Documentation
-
getServiceSetting
default GetServiceSettingResponse getServiceSetting(Consumer<GetServiceSettingRequest.Builder> getServiceSettingRequest) throws InternalServerErrorException, ServiceSettingNotFoundException, AwsServiceException, SdkClientException, SsmException
ServiceSetting
is an account-level setting for an Amazon Web Services service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an Amazon Web Services service charges money to the account based on feature or service usage, then the Amazon Web Services service team might create a default setting offalse
. This means the user can't use this feature unless they change the setting totrue
and intentionally opt in for a paid feature.Services map a
SettingId
object to a setting value. Amazon Web Services services teams define the default value for aSettingId
. You can't create a newSettingId
, but you can overwrite the default value if you have thessm:UpdateServiceSetting
permission for the setting. Use the UpdateServiceSetting API operation to change the default setting. Or use the ResetServiceSetting to change the value back to the original value defined by the Amazon Web Services service team.Query the current service setting for the Amazon Web Services account.
This is a convenience which creates an instance of the
GetServiceSettingRequest.Builder
avoiding the need to create one manually viaGetServiceSettingRequest.builder()
- Parameters:
getServiceSettingRequest
- AConsumer
that will call methods onGetServiceSettingRequest.Builder
to create a request. The request body of the GetServiceSetting API operation.- Returns:
- Result of the GetServiceSetting operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.ServiceSettingNotFoundException
- The specified service setting wasn't found. Either the service name or the setting hasn't been provisioned by the Amazon Web Services 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
- See Also:
- AWS API Documentation
-
labelParameterVersion
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, Amazon Web Services 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.
-
If you no longer want to use a parameter label, then you can either delete it or 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 isn't associated with a parameter and the system displays it in the list of InvalidLabels.
- Parameters:
labelParameterVersionRequest
-- Returns:
- Result of the LabelParameterVersion operation returned by the service.
- Throws:
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 couldn't be found. Verify the name and try again.ParameterVersionNotFoundException
- The specified parameter version wasn't 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
- See Also:
- AWS API Documentation
-
-
labelParameterVersion
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, Amazon Web Services 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.
-
If you no longer want to use a parameter label, then you can either delete it or 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 isn't 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 viaLabelParameterVersionRequest.builder()
- Parameters:
labelParameterVersionRequest
- AConsumer
that will call methods onLabelParameterVersionRequest.Builder
to create a request.- Returns:
- Result of the LabelParameterVersion operation returned by the service.
- Throws:
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 couldn't be found. Verify the name and try again.ParameterVersionNotFoundException
- The specified parameter version wasn't 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
- See Also:
- AWS API Documentation
-
-
listAssociationVersions
default ListAssociationVersionsResponse listAssociationVersions(ListAssociationVersionsRequest listAssociationVersionsRequest) throws InternalServerErrorException, InvalidNextTokenException, AssociationDoesNotExistException, AwsServiceException, SdkClientException, SsmException
Retrieves all versions of an association for a specific association ID.
- Parameters:
listAssociationVersionsRequest
-- Returns:
- Result of the ListAssociationVersions operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidNextTokenException
- The specified token isn't valid.AssociationDoesNotExistException
- The specified association doesn't 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
- See Also:
- AWS API Documentation
-
listAssociationVersions
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 viaListAssociationVersionsRequest.builder()
- Parameters:
listAssociationVersionsRequest
- AConsumer
that will call methods onListAssociationVersionsRequest.Builder
to create a request.- Returns:
- Result of the ListAssociationVersions operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidNextTokenException
- The specified token isn't valid.AssociationDoesNotExistException
- The specified association doesn't 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
- See Also:
- AWS API Documentation
-
listAssociationVersionsPaginator
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 Streamsoftware.amazon.awssdk.services.ssm.paginators.ListAssociationVersionsIterable responses = client.listAssociationVersionsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
listAssociationVersionsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidNextTokenException
- The specified token isn't valid.AssociationDoesNotExistException
- The specified association doesn't 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
- See Also:
- AWS API Documentation
-
listAssociationVersionsPaginator
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 Streamsoftware.amazon.awssdk.services.ssm.paginators.ListAssociationVersionsIterable responses = client.listAssociationVersionsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListAssociationVersionsRequest.builder()
- Parameters:
listAssociationVersionsRequest
- AConsumer
that will call methods onListAssociationVersionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidNextTokenException
- The specified token isn't valid.AssociationDoesNotExistException
- The specified association doesn't 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
- See Also:
- AWS API Documentation
-
listAssociations
default ListAssociationsResponse listAssociations(ListAssociationsRequest listAssociationsRequest) throws InternalServerErrorException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Returns all State Manager associations in the current Amazon Web Services account and Amazon Web Services Region. You can limit the results to a specific State Manager association document or managed node by specifying a filter. State Manager is a capability of Amazon Web Services Systems Manager.
- Parameters:
listAssociationsRequest
-- Returns:
- Result of the ListAssociations operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
listAssociations
default ListAssociationsResponse listAssociations(Consumer<ListAssociationsRequest.Builder> listAssociationsRequest) throws InternalServerErrorException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Returns all State Manager associations in the current Amazon Web Services account and Amazon Web Services Region. You can limit the results to a specific State Manager association document or managed node by specifying a filter. State Manager is a capability of Amazon Web Services Systems Manager.
This is a convenience which creates an instance of the
ListAssociationsRequest.Builder
avoiding the need to create one manually viaListAssociationsRequest.builder()
- Parameters:
listAssociationsRequest
- AConsumer
that will call methods onListAssociationsRequest.Builder
to create a request.- Returns:
- Result of the ListAssociations operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
listAssociations
default ListAssociationsResponse listAssociations() throws InternalServerErrorException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Returns all State Manager associations in the current Amazon Web Services account and Amazon Web Services Region. You can limit the results to a specific State Manager association document or managed node by specifying a filter. State Manager is a capability of Amazon Web Services Systems Manager.
- Returns:
- Result of the ListAssociations operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidNextTokenException
- The specified token isn't 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
- See Also:
listAssociations(ListAssociationsRequest)
, AWS API Documentation
-
listAssociationsPaginator
default ListAssociationsIterable listAssociationsPaginator() throws InternalServerErrorException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Returns all State Manager associations in the current Amazon Web Services account and Amazon Web Services Region. You can limit the results to a specific State Manager association document or managed node by specifying a filter. State Manager is a capability of Amazon Web Services Systems Manager.
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 Streamsoftware.amazon.awssdk.services.ssm.paginators.ListAssociationsIterable responses = client.listAssociationsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidNextTokenException
- The specified token isn't 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
- See Also:
listAssociationsPaginator(ListAssociationsRequest)
, AWS API Documentation
-
listAssociationsPaginator
default ListAssociationsIterable listAssociationsPaginator(ListAssociationsRequest listAssociationsRequest) throws InternalServerErrorException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Returns all State Manager associations in the current Amazon Web Services account and Amazon Web Services Region. You can limit the results to a specific State Manager association document or managed node by specifying a filter. State Manager is a capability of Amazon Web Services Systems Manager.
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 Streamsoftware.amazon.awssdk.services.ssm.paginators.ListAssociationsIterable responses = client.listAssociationsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
listAssociationsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
listAssociationsPaginator
default ListAssociationsIterable listAssociationsPaginator(Consumer<ListAssociationsRequest.Builder> listAssociationsRequest) throws InternalServerErrorException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Returns all State Manager associations in the current Amazon Web Services account and Amazon Web Services Region. You can limit the results to a specific State Manager association document or managed node by specifying a filter. State Manager is a capability of Amazon Web Services Systems Manager.
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 Streamsoftware.amazon.awssdk.services.ssm.paginators.ListAssociationsIterable responses = client.listAssociationsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListAssociationsRequest.builder()
- Parameters:
listAssociationsRequest
- AConsumer
that will call methods onListAssociationsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
listCommandInvocations
default ListCommandInvocationsResponse listCommandInvocations(ListCommandInvocationsRequest listCommandInvocationsRequest) throws InternalServerErrorException, InvalidCommandIdException, InvalidInstanceIdException, InvalidFilterKeyException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
An invocation is copy of a command sent to a specific managed node. A command can apply to one or more managed nodes. A command invocation applies to one managed node. For example, if a user runs
SendCommand
against three managed nodes, then a command invocation is created for each requested managed node ID.ListCommandInvocations
provide status about command execution.- Parameters:
listCommandInvocationsRequest
-- Returns:
- Result of the ListCommandInvocations operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidCommandIdException
- The specified command ID isn't valid. Verify the ID and try again.InvalidInstanceIdException
- The following problems can cause this exception:-
You don't have permission to access the managed node.
-
Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running.
-
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
-
The managed node isn't in valid state. Valid states are:
Running
,Pending
,Stopped
, andStopping
. Invalid states are:Shutting-down
andTerminated
.
-
InvalidFilterKeyException
- The specified key isn't valid.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
listCommandInvocations
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 managed node. A command can apply to one or more managed nodes. A command invocation applies to one managed node. For example, if a user runs
SendCommand
against three managed nodes, then a command invocation is created for each requested managed node 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 viaListCommandInvocationsRequest.builder()
- Parameters:
listCommandInvocationsRequest
- AConsumer
that will call methods onListCommandInvocationsRequest.Builder
to create a request.- Returns:
- Result of the ListCommandInvocations operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidCommandIdException
- The specified command ID isn't valid. Verify the ID and try again.InvalidInstanceIdException
- The following problems can cause this exception:-
You don't have permission to access the managed node.
-
Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running.
-
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
-
The managed node isn't in valid state. Valid states are:
Running
,Pending
,Stopped
, andStopping
. Invalid states are:Shutting-down
andTerminated
.
-
InvalidFilterKeyException
- The specified key isn't valid.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
listCommandInvocations
default ListCommandInvocationsResponse listCommandInvocations() throws InternalServerErrorException, InvalidCommandIdException, InvalidInstanceIdException, InvalidFilterKeyException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
An invocation is copy of a command sent to a specific managed node. A command can apply to one or more managed nodes. A command invocation applies to one managed node. For example, if a user runs
SendCommand
against three managed nodes, then a command invocation is created for each requested managed node ID.ListCommandInvocations
provide status about command execution.- Returns:
- Result of the ListCommandInvocations operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidCommandIdException
- The specified command ID isn't valid. Verify the ID and try again.InvalidInstanceIdException
- The following problems can cause this exception:-
You don't have permission to access the managed node.
-
Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running.
-
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
-
The managed node isn't in valid state. Valid states are:
Running
,Pending
,Stopped
, andStopping
. Invalid states are:Shutting-down
andTerminated
.
-
InvalidFilterKeyException
- The specified key isn't valid.InvalidNextTokenException
- The specified token isn't 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
- See Also:
listCommandInvocations(ListCommandInvocationsRequest)
, AWS API Documentation
-
listCommandInvocationsPaginator
default ListCommandInvocationsIterable listCommandInvocationsPaginator() throws InternalServerErrorException, InvalidCommandIdException, InvalidInstanceIdException, InvalidFilterKeyException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
An invocation is copy of a command sent to a specific managed node. A command can apply to one or more managed nodes. A command invocation applies to one managed node. For example, if a user runs
SendCommand
against three managed nodes, then a command invocation is created for each requested managed node 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 Streamsoftware.amazon.awssdk.services.ssm.paginators.ListCommandInvocationsIterable responses = client.listCommandInvocationsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidCommandIdException
- The specified command ID isn't valid. Verify the ID and try again.InvalidInstanceIdException
- The following problems can cause this exception:-
You don't have permission to access the managed node.
-
Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running.
-
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
-
The managed node isn't in valid state. Valid states are:
Running
,Pending
,Stopped
, andStopping
. Invalid states are:Shutting-down
andTerminated
.
-
InvalidFilterKeyException
- The specified key isn't valid.InvalidNextTokenException
- The specified token isn't 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
- See Also:
listCommandInvocationsPaginator(ListCommandInvocationsRequest)
, AWS API Documentation
-
listCommandInvocationsPaginator
default ListCommandInvocationsIterable listCommandInvocationsPaginator(ListCommandInvocationsRequest listCommandInvocationsRequest) throws InternalServerErrorException, InvalidCommandIdException, InvalidInstanceIdException, InvalidFilterKeyException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
An invocation is copy of a command sent to a specific managed node. A command can apply to one or more managed nodes. A command invocation applies to one managed node. For example, if a user runs
SendCommand
against three managed nodes, then a command invocation is created for each requested managed node 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 Streamsoftware.amazon.awssdk.services.ssm.paginators.ListCommandInvocationsIterable responses = client.listCommandInvocationsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
listCommandInvocationsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidCommandIdException
- The specified command ID isn't valid. Verify the ID and try again.InvalidInstanceIdException
- The following problems can cause this exception:-
You don't have permission to access the managed node.
-
Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running.
-
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
-
The managed node isn't in valid state. Valid states are:
Running
,Pending
,Stopped
, andStopping
. Invalid states are:Shutting-down
andTerminated
.
-
InvalidFilterKeyException
- The specified key isn't valid.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
listCommandInvocationsPaginator
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 managed node. A command can apply to one or more managed nodes. A command invocation applies to one managed node. For example, if a user runs
SendCommand
against three managed nodes, then a command invocation is created for each requested managed node 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 Streamsoftware.amazon.awssdk.services.ssm.paginators.ListCommandInvocationsIterable responses = client.listCommandInvocationsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListCommandInvocationsRequest.builder()
- Parameters:
listCommandInvocationsRequest
- AConsumer
that will call methods onListCommandInvocationsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidCommandIdException
- The specified command ID isn't valid. Verify the ID and try again.InvalidInstanceIdException
- The following problems can cause this exception:-
You don't have permission to access the managed node.
-
Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running.
-
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
-
The managed node isn't in valid state. Valid states are:
Running
,Pending
,Stopped
, andStopping
. Invalid states are:Shutting-down
andTerminated
.
-
InvalidFilterKeyException
- The specified key isn't valid.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
listCommands
default ListCommandsResponse listCommands(ListCommandsRequest listCommandsRequest) throws InternalServerErrorException, InvalidCommandIdException, InvalidInstanceIdException, InvalidFilterKeyException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Lists the commands requested by users of the Amazon Web Services account.
- Parameters:
listCommandsRequest
-- Returns:
- Result of the ListCommands operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidCommandIdException
- The specified command ID isn't valid. Verify the ID and try again.InvalidInstanceIdException
- The following problems can cause this exception:-
You don't have permission to access the managed node.
-
Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running.
-
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
-
The managed node isn't in valid state. Valid states are:
Running
,Pending
,Stopped
, andStopping
. Invalid states are:Shutting-down
andTerminated
.
-
InvalidFilterKeyException
- The specified key isn't valid.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
listCommands
default ListCommandsResponse listCommands(Consumer<ListCommandsRequest.Builder> listCommandsRequest) throws InternalServerErrorException, InvalidCommandIdException, InvalidInstanceIdException, InvalidFilterKeyException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Lists the commands requested by users of the Amazon Web Services account.
This is a convenience which creates an instance of the
ListCommandsRequest.Builder
avoiding the need to create one manually viaListCommandsRequest.builder()
- Parameters:
listCommandsRequest
- AConsumer
that will call methods onListCommandsRequest.Builder
to create a request.- Returns:
- Result of the ListCommands operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidCommandIdException
- The specified command ID isn't valid. Verify the ID and try again.InvalidInstanceIdException
- The following problems can cause this exception:-
You don't have permission to access the managed node.
-
Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running.
-
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
-
The managed node isn't in valid state. Valid states are:
Running
,Pending
,Stopped
, andStopping
. Invalid states are:Shutting-down
andTerminated
.
-
InvalidFilterKeyException
- The specified key isn't valid.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
listCommands
default ListCommandsResponse listCommands() throws InternalServerErrorException, InvalidCommandIdException, InvalidInstanceIdException, InvalidFilterKeyException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Lists the commands requested by users of the Amazon Web Services account.
- Returns:
- Result of the ListCommands operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidCommandIdException
- The specified command ID isn't valid. Verify the ID and try again.InvalidInstanceIdException
- The following problems can cause this exception:-
You don't have permission to access the managed node.
-
Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running.
-
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
-
The managed node isn't in valid state. Valid states are:
Running
,Pending
,Stopped
, andStopping
. Invalid states are:Shutting-down
andTerminated
.
-
InvalidFilterKeyException
- The specified key isn't valid.InvalidNextTokenException
- The specified token isn't 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
- See Also:
listCommands(ListCommandsRequest)
, AWS API Documentation
-
listCommandsPaginator
default ListCommandsIterable listCommandsPaginator() throws InternalServerErrorException, InvalidCommandIdException, InvalidInstanceIdException, InvalidFilterKeyException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Lists the commands requested by users of the Amazon Web Services 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 Streamsoftware.amazon.awssdk.services.ssm.paginators.ListCommandsIterable responses = client.listCommandsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidCommandIdException
- The specified command ID isn't valid. Verify the ID and try again.InvalidInstanceIdException
- The following problems can cause this exception:-
You don't have permission to access the managed node.
-
Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running.
-
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
-
The managed node isn't in valid state. Valid states are:
Running
,Pending
,Stopped
, andStopping
. Invalid states are:Shutting-down
andTerminated
.
-
InvalidFilterKeyException
- The specified key isn't valid.InvalidNextTokenException
- The specified token isn't 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
- See Also:
listCommandsPaginator(ListCommandsRequest)
, AWS API Documentation
-
listCommandsPaginator
default ListCommandsIterable listCommandsPaginator(ListCommandsRequest listCommandsRequest) throws InternalServerErrorException, InvalidCommandIdException, InvalidInstanceIdException, InvalidFilterKeyException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Lists the commands requested by users of the Amazon Web Services 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 Streamsoftware.amazon.awssdk.services.ssm.paginators.ListCommandsIterable responses = client.listCommandsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
listCommandsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidCommandIdException
- The specified command ID isn't valid. Verify the ID and try again.InvalidInstanceIdException
- The following problems can cause this exception:-
You don't have permission to access the managed node.
-
Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running.
-
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
-
The managed node isn't in valid state. Valid states are:
Running
,Pending
,Stopped
, andStopping
. Invalid states are:Shutting-down
andTerminated
.
-
InvalidFilterKeyException
- The specified key isn't valid.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
listCommandsPaginator
default ListCommandsIterable listCommandsPaginator(Consumer<ListCommandsRequest.Builder> listCommandsRequest) throws InternalServerErrorException, InvalidCommandIdException, InvalidInstanceIdException, InvalidFilterKeyException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Lists the commands requested by users of the Amazon Web Services 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 Streamsoftware.amazon.awssdk.services.ssm.paginators.ListCommandsIterable responses = client.listCommandsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListCommandsRequest.builder()
- Parameters:
listCommandsRequest
- AConsumer
that will call methods onListCommandsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidCommandIdException
- The specified command ID isn't valid. Verify the ID and try again.InvalidInstanceIdException
- The following problems can cause this exception:-
You don't have permission to access the managed node.
-
Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running.
-
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
-
The managed node isn't in valid state. Valid states are:
Running
,Pending
,Stopped
, andStopping
. Invalid states are:Shutting-down
andTerminated
.
-
InvalidFilterKeyException
- The specified key isn't valid.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
listComplianceItems
default ListComplianceItemsResponse listComplianceItems(ListComplianceItemsRequest listComplianceItemsRequest) throws InvalidResourceTypeException, InvalidResourceIdException, InternalServerErrorException, InvalidFilterException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
For a specified resource ID, this API operation 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.
- Parameters:
listComplianceItemsRequest
-- Returns:
- Result of the ListComplianceItems operation returned by the service.
- Throws:
InvalidResourceTypeException
- The resource type isn't valid. For example, if you are attempting to tag an EC2 instance, the instance must be a registered managed node.InvalidResourceIdException
- The resource ID isn't valid. Verify that you entered the correct ID and try again.InternalServerErrorException
- An error occurred on the server side.InvalidFilterException
- The filter name isn't valid. Verify the you entered the correct name and try again.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
listComplianceItems
default ListComplianceItemsResponse listComplianceItems(Consumer<ListComplianceItemsRequest.Builder> listComplianceItemsRequest) throws InvalidResourceTypeException, InvalidResourceIdException, InternalServerErrorException, InvalidFilterException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
For a specified resource ID, this API operation 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 viaListComplianceItemsRequest.builder()
- Parameters:
listComplianceItemsRequest
- AConsumer
that will call methods onListComplianceItemsRequest.Builder
to create a request.- Returns:
- Result of the ListComplianceItems operation returned by the service.
- Throws:
InvalidResourceTypeException
- The resource type isn't valid. For example, if you are attempting to tag an EC2 instance, the instance must be a registered managed node.InvalidResourceIdException
- The resource ID isn't valid. Verify that you entered the correct ID and try again.InternalServerErrorException
- An error occurred on the server side.InvalidFilterException
- The filter name isn't valid. Verify the you entered the correct name and try again.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
listComplianceItemsPaginator
default ListComplianceItemsIterable listComplianceItemsPaginator(ListComplianceItemsRequest listComplianceItemsRequest) throws InvalidResourceTypeException, InvalidResourceIdException, InternalServerErrorException, InvalidFilterException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
For a specified resource ID, this API operation 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 Streamsoftware.amazon.awssdk.services.ssm.paginators.ListComplianceItemsIterable responses = client.listComplianceItemsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
listComplianceItemsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidResourceTypeException
- The resource type isn't valid. For example, if you are attempting to tag an EC2 instance, the instance must be a registered managed node.InvalidResourceIdException
- The resource ID isn't valid. Verify that you entered the correct ID and try again.InternalServerErrorException
- An error occurred on the server side.InvalidFilterException
- The filter name isn't valid. Verify the you entered the correct name and try again.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
listComplianceItemsPaginator
default ListComplianceItemsIterable listComplianceItemsPaginator(Consumer<ListComplianceItemsRequest.Builder> listComplianceItemsRequest) throws InvalidResourceTypeException, InvalidResourceIdException, InternalServerErrorException, InvalidFilterException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
For a specified resource ID, this API operation 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 Streamsoftware.amazon.awssdk.services.ssm.paginators.ListComplianceItemsIterable responses = client.listComplianceItemsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListComplianceItemsRequest.builder()
- Parameters:
listComplianceItemsRequest
- AConsumer
that will call methods onListComplianceItemsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidResourceTypeException
- The resource type isn't valid. For example, if you are attempting to tag an EC2 instance, the instance must be a registered managed node.InvalidResourceIdException
- The resource ID isn't valid. Verify that you entered the correct ID and try again.InternalServerErrorException
- An error occurred on the server side.InvalidFilterException
- The filter name isn't valid. Verify the you entered the correct name and try again.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
listComplianceSummaries
default 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.
- Parameters:
listComplianceSummariesRequest
-- Returns:
- Result of the ListComplianceSummaries operation returned by the service.
- Throws:
InvalidFilterException
- The filter name isn't valid. Verify the you entered the correct name and try again.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
listComplianceSummaries
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 viaListComplianceSummariesRequest.builder()
- Parameters:
listComplianceSummariesRequest
- AConsumer
that will call methods onListComplianceSummariesRequest.Builder
to create a request.- Returns:
- Result of the ListComplianceSummaries operation returned by the service.
- Throws:
InvalidFilterException
- The filter name isn't valid. Verify the you entered the correct name and try again.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
listComplianceSummaries
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.
- Returns:
- Result of the ListComplianceSummaries operation returned by the service.
- Throws:
InvalidFilterException
- The filter name isn't valid. Verify the you entered the correct name and try again.InvalidNextTokenException
- The specified token isn't 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
- See Also:
listComplianceSummaries(ListComplianceSummariesRequest)
, AWS API Documentation
-
listComplianceSummariesPaginator
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 Streamsoftware.amazon.awssdk.services.ssm.paginators.ListComplianceSummariesIterable responses = client.listComplianceSummariesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidFilterException
- The filter name isn't valid. Verify the you entered the correct name and try again.InvalidNextTokenException
- The specified token isn't 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
- See Also:
listComplianceSummariesPaginator(ListComplianceSummariesRequest)
, AWS API Documentation
-
listComplianceSummariesPaginator
default 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 Streamsoftware.amazon.awssdk.services.ssm.paginators.ListComplianceSummariesIterable responses = client.listComplianceSummariesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
listComplianceSummariesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidFilterException
- The filter name isn't valid. Verify the you entered the correct name and try again.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
listComplianceSummariesPaginator
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 Streamsoftware.amazon.awssdk.services.ssm.paginators.ListComplianceSummariesIterable responses = client.listComplianceSummariesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListComplianceSummariesRequest.builder()
- Parameters:
listComplianceSummariesRequest
- AConsumer
that will call methods onListComplianceSummariesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidFilterException
- The filter name isn't valid. Verify the you entered the correct name and try again.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
listDocumentMetadataHistory
default ListDocumentMetadataHistoryResponse listDocumentMetadataHistory(ListDocumentMetadataHistoryRequest listDocumentMetadataHistoryRequest) throws InternalServerErrorException, InvalidDocumentException, InvalidDocumentVersionException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Information about approval reviews for a version of a change template in Change Manager.
- Parameters:
listDocumentMetadataHistoryRequest
-- Returns:
- Result of the ListDocumentMetadataHistory operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidDocumentException
- The specified SSM document doesn't exist.InvalidDocumentVersionException
- The document version isn't valid or doesn't exist.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
listDocumentMetadataHistory
default ListDocumentMetadataHistoryResponse listDocumentMetadataHistory(Consumer<ListDocumentMetadataHistoryRequest.Builder> listDocumentMetadataHistoryRequest) throws InternalServerErrorException, InvalidDocumentException, InvalidDocumentVersionException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
Information about approval reviews for a version of a change template in Change Manager.
This is a convenience which creates an instance of the
ListDocumentMetadataHistoryRequest.Builder
avoiding the need to create one manually viaListDocumentMetadataHistoryRequest.builder()
- Parameters:
listDocumentMetadataHistoryRequest
- AConsumer
that will call methods onListDocumentMetadataHistoryRequest.Builder
to create a request.- Returns:
- Result of the ListDocumentMetadataHistory operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidDocumentException
- The specified SSM document doesn't exist.InvalidDocumentVersionException
- The document version isn't valid or doesn't exist.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
listDocumentVersions
default ListDocumentVersionsResponse listDocumentVersions(ListDocumentVersionsRequest listDocumentVersionsRequest) throws InternalServerErrorException, InvalidNextTokenException, InvalidDocumentException, AwsServiceException, SdkClientException, SsmException
List all versions for a document.
- Parameters:
listDocumentVersionsRequest
-- Returns:
- Result of the ListDocumentVersions operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidNextTokenException
- The specified token isn't valid.InvalidDocumentException
- The specified SSM document doesn't 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
- See Also:
- AWS API Documentation
-
listDocumentVersions
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 viaListDocumentVersionsRequest.builder()
- Parameters:
listDocumentVersionsRequest
- AConsumer
that will call methods onListDocumentVersionsRequest.Builder
to create a request.- Returns:
- Result of the ListDocumentVersions operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidNextTokenException
- The specified token isn't valid.InvalidDocumentException
- The specified SSM document doesn't 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
- See Also:
- AWS API Documentation
-
listDocumentVersionsPaginator
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 Streamsoftware.amazon.awssdk.services.ssm.paginators.ListDocumentVersionsIterable responses = client.listDocumentVersionsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
listDocumentVersionsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidNextTokenException
- The specified token isn't valid.InvalidDocumentException
- The specified SSM document doesn't 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
- See Also:
- AWS API Documentation
-
listDocumentVersionsPaginator
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 Streamsoftware.amazon.awssdk.services.ssm.paginators.ListDocumentVersionsIterable responses = client.listDocumentVersionsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListDocumentVersionsRequest.builder()
- Parameters:
listDocumentVersionsRequest
- AConsumer
that will call methods onListDocumentVersionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidNextTokenException
- The specified token isn't valid.InvalidDocumentException
- The specified SSM document doesn't 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
- See Also:
- AWS API Documentation
-
listDocuments
default ListDocumentsResponse listDocuments(ListDocumentsRequest listDocumentsRequest) throws InternalServerErrorException, InvalidNextTokenException, InvalidFilterKeyException, AwsServiceException, SdkClientException, SsmException
Returns all Systems Manager (SSM) documents in the current Amazon Web Services account and Amazon Web Services Region. You can limit the results of this request by using a filter.
- Parameters:
listDocumentsRequest
-- Returns:
- Result of the ListDocuments operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidNextTokenException
- The specified token isn't valid.InvalidFilterKeyException
- The specified key isn't 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
- See Also:
- AWS API Documentation
-
listDocuments
default ListDocumentsResponse listDocuments(Consumer<ListDocumentsRequest.Builder> listDocumentsRequest) throws InternalServerErrorException, InvalidNextTokenException, InvalidFilterKeyException, AwsServiceException, SdkClientException, SsmException
Returns all Systems Manager (SSM) documents in the current Amazon Web Services account and Amazon Web Services 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 viaListDocumentsRequest.builder()
- Parameters:
listDocumentsRequest
- AConsumer
that will call methods onListDocumentsRequest.Builder
to create a request.- Returns:
- Result of the ListDocuments operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidNextTokenException
- The specified token isn't valid.InvalidFilterKeyException
- The specified key isn't 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
- See Also:
- AWS API Documentation
-
listDocuments
default ListDocumentsResponse listDocuments() throws InternalServerErrorException, InvalidNextTokenException, InvalidFilterKeyException, AwsServiceException, SdkClientException, SsmException
Returns all Systems Manager (SSM) documents in the current Amazon Web Services account and Amazon Web Services Region. You can limit the results of this request by using a filter.
- Returns:
- Result of the ListDocuments operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidNextTokenException
- The specified token isn't valid.InvalidFilterKeyException
- The specified key isn't 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
- See Also:
listDocuments(ListDocumentsRequest)
, AWS API Documentation
-
listDocumentsPaginator
default ListDocumentsIterable listDocumentsPaginator() throws InternalServerErrorException, InvalidNextTokenException, InvalidFilterKeyException, AwsServiceException, SdkClientException, SsmException
Returns all Systems Manager (SSM) documents in the current Amazon Web Services account and Amazon Web Services 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 Streamsoftware.amazon.awssdk.services.ssm.paginators.ListDocumentsIterable responses = client.listDocumentsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidNextTokenException
- The specified token isn't valid.InvalidFilterKeyException
- The specified key isn't 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
- See Also:
listDocumentsPaginator(ListDocumentsRequest)
, AWS API Documentation
-
listDocumentsPaginator
default ListDocumentsIterable listDocumentsPaginator(ListDocumentsRequest listDocumentsRequest) throws InternalServerErrorException, InvalidNextTokenException, InvalidFilterKeyException, AwsServiceException, SdkClientException, SsmException
Returns all Systems Manager (SSM) documents in the current Amazon Web Services account and Amazon Web Services 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 Streamsoftware.amazon.awssdk.services.ssm.paginators.ListDocumentsIterable responses = client.listDocumentsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
listDocumentsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidNextTokenException
- The specified token isn't valid.InvalidFilterKeyException
- The specified key isn't 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
- See Also:
- AWS API Documentation
-
listDocumentsPaginator
default ListDocumentsIterable listDocumentsPaginator(Consumer<ListDocumentsRequest.Builder> listDocumentsRequest) throws InternalServerErrorException, InvalidNextTokenException, InvalidFilterKeyException, AwsServiceException, SdkClientException, SsmException
Returns all Systems Manager (SSM) documents in the current Amazon Web Services account and Amazon Web Services 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 Streamsoftware.amazon.awssdk.services.ssm.paginators.ListDocumentsIterable responses = client.listDocumentsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListDocumentsRequest.builder()
- Parameters:
listDocumentsRequest
- AConsumer
that will call methods onListDocumentsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidNextTokenException
- The specified token isn't valid.InvalidFilterKeyException
- The specified key isn't 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
- See Also:
- AWS API Documentation
-
listInventoryEntries
default ListInventoryEntriesResponse listInventoryEntries(ListInventoryEntriesRequest listInventoryEntriesRequest) throws InternalServerErrorException, InvalidInstanceIdException, InvalidTypeNameException, InvalidFilterException, InvalidNextTokenException, AwsServiceException, SdkClientException, SsmException
A list of inventory items returned by the request.
- Parameters:
listInventoryEntriesRequest
-- Returns:
- Result of the ListInventoryEntries operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidInstanceIdException
- The following problems can cause this exception:-
You don't have permission to access the managed node.
-
Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running.
-
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
-
The managed node isn't in valid state. Valid states are:
Running
,Pending
,Stopped
, andStopping
. Invalid states are:Shutting-down
andTerminated
.
-
InvalidTypeNameException
- The parameter type name isn't valid.InvalidFilterException
- The filter name isn't valid. Verify the you entered the correct name and try again.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
listInventoryEntries
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 viaListInventoryEntriesRequest.builder()
- Parameters:
listInventoryEntriesRequest
- AConsumer
that will call methods onListInventoryEntriesRequest.Builder
to create a request.- Returns:
- Result of the ListInventoryEntries operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidInstanceIdException
- The following problems can cause this exception:-
You don't have permission to access the managed node.
-
Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running.
-
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
-
The managed node isn't in valid state. Valid states are:
Running
,Pending
,Stopped
, andStopping
. Invalid states are:Shutting-down
andTerminated
.
-
InvalidTypeNameException
- The parameter type name isn't valid.InvalidFilterException
- The filter name isn't valid. Verify the you entered the correct name and try again.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
listOpsItemEvents
default ListOpsItemEventsResponse listOpsItemEvents(ListOpsItemEventsRequest listOpsItemEventsRequest) throws InternalServerErrorException, OpsItemNotFoundException, OpsItemLimitExceededException, OpsItemInvalidParameterException, AwsServiceException, SdkClientException, SsmException
Returns a list of all OpsItem events in the current Amazon Web Services Region and Amazon Web Services account. You can limit the results to events associated with specific OpsItems by specifying a filter.
- Parameters:
listOpsItemEventsRequest
-- Returns:
- Result of the ListOpsItemEvents operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.OpsItemNotFoundException
- The specified OpsItem ID doesn't exist. Verify the ID and try again.OpsItemLimitExceededException
- The request caused OpsItems to exceed one or more quotas.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
- See Also:
- AWS API Documentation
-
listOpsItemEvents
default ListOpsItemEventsResponse listOpsItemEvents(Consumer<ListOpsItemEventsRequest.Builder> listOpsItemEventsRequest) throws InternalServerErrorException, OpsItemNotFoundException, OpsItemLimitExceededException, OpsItemInvalidParameterException, AwsServiceException, SdkClientException, SsmException
Returns a list of all OpsItem events in the current Amazon Web Services Region and Amazon Web Services account. You can limit the results to events associated with specific OpsItems by specifying a filter.
This is a convenience which creates an instance of the
ListOpsItemEventsRequest.Builder
avoiding the need to create one manually viaListOpsItemEventsRequest.builder()
- Parameters:
listOpsItemEventsRequest
- AConsumer
that will call methods onListOpsItemEventsRequest.Builder
to create a request.- Returns:
- Result of the ListOpsItemEvents operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.OpsItemNotFoundException
- The specified OpsItem ID doesn't exist. Verify the ID and try again.OpsItemLimitExceededException
- The request caused OpsItems to exceed one or more quotas.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
- See Also:
- AWS API Documentation
-
listOpsItemEventsPaginator
default ListOpsItemEventsIterable listOpsItemEventsPaginator(ListOpsItemEventsRequest listOpsItemEventsRequest) throws InternalServerErrorException, OpsItemNotFoundException, OpsItemLimitExceededException, OpsItemInvalidParameterException, AwsServiceException, SdkClientException, SsmException
Returns a list of all OpsItem events in the current Amazon Web Services Region and Amazon Web Services account. You can limit the results to events associated with specific OpsItems by specifying a filter.
This is a variant of
listOpsItemEvents(software.amazon.awssdk.services.ssm.model.ListOpsItemEventsRequest)
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 Streamsoftware.amazon.awssdk.services.ssm.paginators.ListOpsItemEventsIterable responses = client.listOpsItemEventsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ssm.paginators.ListOpsItemEventsIterable responses = client .listOpsItemEventsPaginator(request); for (software.amazon.awssdk.services.ssm.model.ListOpsItemEventsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ssm.paginators.ListOpsItemEventsIterable responses = client.listOpsItemEventsPaginator(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
listOpsItemEvents(software.amazon.awssdk.services.ssm.model.ListOpsItemEventsRequest)
operation.- Parameters:
listOpsItemEventsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerErrorException
- An error occurred on the server side.OpsItemNotFoundException
- The specified OpsItem ID doesn't exist. Verify the ID and try again.OpsItemLimitExceededException
- The request caused OpsItems to exceed one or more quotas.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
- See Also:
- AWS API Documentation
-
listOpsItemEventsPaginator
default ListOpsItemEventsIterable listOpsItemEventsPaginator(Consumer<ListOpsItemEventsRequest.Builder> listOpsItemEventsRequest) throws InternalServerErrorException, OpsItemNotFoundException, OpsItemLimitExceededException, OpsItemInvalidParameterException, AwsServiceException, SdkClientException, SsmException
Returns a list of all OpsItem events in the current Amazon Web Services Region and Amazon Web Services account. You can limit the results to events associated with specific OpsItems by specifying a filter.
This is a variant of
listOpsItemEvents(software.amazon.awssdk.services.ssm.model.ListOpsItemEventsRequest)
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 Streamsoftware.amazon.awssdk.services.ssm.paginators.ListOpsItemEventsIterable responses = client.listOpsItemEventsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ssm.paginators.ListOpsItemEventsIterable responses = client .listOpsItemEventsPaginator(request); for (software.amazon.awssdk.services.ssm.model.ListOpsItemEventsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ssm.paginators.ListOpsItemEventsIterable responses = client.listOpsItemEventsPaginator(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
listOpsItemEvents(software.amazon.awssdk.services.ssm.model.ListOpsItemEventsRequest)
operation.This is a convenience which creates an instance of the
ListOpsItemEventsRequest.Builder
avoiding the need to create one manually viaListOpsItemEventsRequest.builder()
- Parameters:
listOpsItemEventsRequest
- AConsumer
that will call methods onListOpsItemEventsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerErrorException
- An error occurred on the server side.OpsItemNotFoundException
- The specified OpsItem ID doesn't exist. Verify the ID and try again.OpsItemLimitExceededException
- The request caused OpsItems to exceed one or more quotas.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
- See Also:
- AWS API Documentation
-
listOpsItemRelatedItems
default ListOpsItemRelatedItemsResponse listOpsItemRelatedItems(ListOpsItemRelatedItemsRequest listOpsItemRelatedItemsRequest) throws InternalServerErrorException, OpsItemInvalidParameterException, AwsServiceException, SdkClientException, SsmException
Lists all related-item resources associated with a Systems Manager OpsCenter OpsItem. OpsCenter is a capability of Amazon Web Services Systems Manager.
- Parameters:
listOpsItemRelatedItemsRequest
-- Returns:
- Result of the ListOpsItemRelatedItems operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.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
- See Also:
- AWS API Documentation
-
listOpsItemRelatedItems
default ListOpsItemRelatedItemsResponse listOpsItemRelatedItems(Consumer<ListOpsItemRelatedItemsRequest.Builder> listOpsItemRelatedItemsRequest) throws InternalServerErrorException, OpsItemInvalidParameterException, AwsServiceException, SdkClientException, SsmException
Lists all related-item resources associated with a Systems Manager OpsCenter OpsItem. OpsCenter is a capability of Amazon Web Services Systems Manager.
This is a convenience which creates an instance of the
ListOpsItemRelatedItemsRequest.Builder
avoiding the need to create one manually viaListOpsItemRelatedItemsRequest.builder()
- Parameters:
listOpsItemRelatedItemsRequest
- AConsumer
that will call methods onListOpsItemRelatedItemsRequest.Builder
to create a request.- Returns:
- Result of the ListOpsItemRelatedItems operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.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
- See Also:
- AWS API Documentation
-
listOpsItemRelatedItemsPaginator
default ListOpsItemRelatedItemsIterable listOpsItemRelatedItemsPaginator(ListOpsItemRelatedItemsRequest listOpsItemRelatedItemsRequest) throws InternalServerErrorException, OpsItemInvalidParameterException, AwsServiceException, SdkClientException, SsmException
Lists all related-item resources associated with a Systems Manager OpsCenter OpsItem. OpsCenter is a capability of Amazon Web Services Systems Manager.
This is a variant of
listOpsItemRelatedItems(software.amazon.awssdk.services.ssm.model.ListOpsItemRelatedItemsRequest)
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 Streamsoftware.amazon.awssdk.services.ssm.paginators.ListOpsItemRelatedItemsIterable responses = client.listOpsItemRelatedItemsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ssm.paginators.ListOpsItemRelatedItemsIterable responses = client .listOpsItemRelatedItemsPaginator(request); for (software.amazon.awssdk.services.ssm.model.ListOpsItemRelatedItemsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ssm.paginators.ListOpsItemRelatedItemsIterable responses = client.listOpsItemRelatedItemsPaginator(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
listOpsItemRelatedItems(software.amazon.awssdk.services.ssm.model.ListOpsItemRelatedItemsRequest)
operation.- Parameters:
listOpsItemRelatedItemsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerErrorException
- An error occurred on the server side.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
- See Also:
- AWS API Documentation
-
listOpsItemRelatedItemsPaginator
default ListOpsItemRelatedItemsIterable listOpsItemRelatedItemsPaginator(Consumer<ListOpsItemRelatedItemsRequest.Builder> listOpsItemRelatedItemsRequest) throws InternalServerErrorException, OpsItemInvalidParameterException, AwsServiceException, SdkClientException, SsmException
Lists all related-item resources associated with a Systems Manager OpsCenter OpsItem. OpsCenter is a capability of Amazon Web Services Systems Manager.
This is a variant of
listOpsItemRelatedItems(software.amazon.awssdk.services.ssm.model.ListOpsItemRelatedItemsRequest)
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 Streamsoftware.amazon.awssdk.services.ssm.paginators.ListOpsItemRelatedItemsIterable responses = client.listOpsItemRelatedItemsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ssm.paginators.ListOpsItemRelatedItemsIterable responses = client .listOpsItemRelatedItemsPaginator(request); for (software.amazon.awssdk.services.ssm.model.ListOpsItemRelatedItemsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ssm.paginators.ListOpsItemRelatedItemsIterable responses = client.listOpsItemRelatedItemsPaginator(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
listOpsItemRelatedItems(software.amazon.awssdk.services.ssm.model.ListOpsItemRelatedItemsRequest)
operation.This is a convenience which creates an instance of the
ListOpsItemRelatedItemsRequest.Builder
avoiding the need to create one manually viaListOpsItemRelatedItemsRequest.builder()
- Parameters:
listOpsItemRelatedItemsRequest
- AConsumer
that will call methods onListOpsItemRelatedItemsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerErrorException
- An error occurred on the server side.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
- See Also:
- AWS API Documentation
-
listOpsMetadata
default ListOpsMetadataResponse listOpsMetadata(ListOpsMetadataRequest listOpsMetadataRequest) throws OpsMetadataInvalidArgumentException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Amazon Web Services Systems Manager calls this API operation when displaying all Application Manager OpsMetadata objects or blobs.
- Parameters:
listOpsMetadataRequest
-- Returns:
- Result of the ListOpsMetadata operation returned by the service.
- Throws:
OpsMetadataInvalidArgumentException
- One of the arguments passed is invalid.InternalServerErrorException
- An error occurred on the server side.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listOpsMetadata
default ListOpsMetadataResponse listOpsMetadata(Consumer<ListOpsMetadataRequest.Builder> listOpsMetadataRequest) throws OpsMetadataInvalidArgumentException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Amazon Web Services Systems Manager calls this API operation when displaying all Application Manager OpsMetadata objects or blobs.
This is a convenience which creates an instance of the
ListOpsMetadataRequest.Builder
avoiding the need to create one manually viaListOpsMetadataRequest.builder()
- Parameters:
listOpsMetadataRequest
- AConsumer
that will call methods onListOpsMetadataRequest.Builder
to create a request.- Returns:
- Result of the ListOpsMetadata operation returned by the service.
- Throws:
OpsMetadataInvalidArgumentException
- One of the arguments passed is invalid.InternalServerErrorException
- An error occurred on the server side.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listOpsMetadataPaginator
default ListOpsMetadataIterable listOpsMetadataPaginator(ListOpsMetadataRequest listOpsMetadataRequest) throws OpsMetadataInvalidArgumentException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Amazon Web Services Systems Manager calls this API operation when displaying all Application Manager OpsMetadata objects or blobs.
This is a variant of
listOpsMetadata(software.amazon.awssdk.services.ssm.model.ListOpsMetadataRequest)
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 Streamsoftware.amazon.awssdk.services.ssm.paginators.ListOpsMetadataIterable responses = client.listOpsMetadataPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ssm.paginators.ListOpsMetadataIterable responses = client.listOpsMetadataPaginator(request); for (software.amazon.awssdk.services.ssm.model.ListOpsMetadataResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ssm.paginators.ListOpsMetadataIterable responses = client.listOpsMetadataPaginator(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
listOpsMetadata(software.amazon.awssdk.services.ssm.model.ListOpsMetadataRequest)
operation.- Parameters:
listOpsMetadataRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
OpsMetadataInvalidArgumentException
- One of the arguments passed is invalid.InternalServerErrorException
- An error occurred on the server side.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listOpsMetadataPaginator
default ListOpsMetadataIterable listOpsMetadataPaginator(Consumer<ListOpsMetadataRequest.Builder> listOpsMetadataRequest) throws OpsMetadataInvalidArgumentException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Amazon Web Services Systems Manager calls this API operation when displaying all Application Manager OpsMetadata objects or blobs.
This is a variant of
listOpsMetadata(software.amazon.awssdk.services.ssm.model.ListOpsMetadataRequest)
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 Streamsoftware.amazon.awssdk.services.ssm.paginators.ListOpsMetadataIterable responses = client.listOpsMetadataPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ssm.paginators.ListOpsMetadataIterable responses = client.listOpsMetadataPaginator(request); for (software.amazon.awssdk.services.ssm.model.ListOpsMetadataResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ssm.paginators.ListOpsMetadataIterable responses = client.listOpsMetadataPaginator(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
listOpsMetadata(software.amazon.awssdk.services.ssm.model.ListOpsMetadataRequest)
operation.This is a convenience which creates an instance of the
ListOpsMetadataRequest.Builder
avoiding the need to create one manually viaListOpsMetadataRequest.builder()
- Parameters:
listOpsMetadataRequest
- AConsumer
that will call methods onListOpsMetadataRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
OpsMetadataInvalidArgumentException
- One of the arguments passed is invalid.InternalServerErrorException
- An error occurred on the server side.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listResourceComplianceSummaries
default 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.
- Parameters:
listResourceComplianceSummariesRequest
-- Returns:
- Result of the ListResourceComplianceSummaries operation returned by the service.
- Throws:
InvalidFilterException
- The filter name isn't valid. Verify the you entered the correct name and try again.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
listResourceComplianceSummaries
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 viaListResourceComplianceSummariesRequest.builder()
- Parameters:
listResourceComplianceSummariesRequest
- AConsumer
that will call methods onListResourceComplianceSummariesRequest.Builder
to create a request.- Returns:
- Result of the ListResourceComplianceSummaries operation returned by the service.
- Throws:
InvalidFilterException
- The filter name isn't valid. Verify the you entered the correct name and try again.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
listResourceComplianceSummaries
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.
- Returns:
- Result of the ListResourceComplianceSummaries operation returned by the service.
- Throws:
InvalidFilterException
- The filter name isn't valid. Verify the you entered the correct name and try again.InvalidNextTokenException
- The specified token isn't 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
- See Also:
listResourceComplianceSummaries(ListResourceComplianceSummariesRequest)
, AWS API Documentation
-
listResourceComplianceSummariesPaginator
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 Streamsoftware.amazon.awssdk.services.ssm.paginators.ListResourceComplianceSummariesIterable responses = client.listResourceComplianceSummariesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidFilterException
- The filter name isn't valid. Verify the you entered the correct name and try again.InvalidNextTokenException
- The specified token isn't 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
- See Also:
listResourceComplianceSummariesPaginator(ListResourceComplianceSummariesRequest)
, AWS API Documentation
-
listResourceComplianceSummariesPaginator
default 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 Streamsoftware.amazon.awssdk.services.ssm.paginators.ListResourceComplianceSummariesIterable responses = client.listResourceComplianceSummariesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
listResourceComplianceSummariesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidFilterException
- The filter name isn't valid. Verify the you entered the correct name and try again.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
listResourceComplianceSummariesPaginator
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 Streamsoftware.amazon.awssdk.services.ssm.paginators.ListResourceComplianceSummariesIterable responses = client.listResourceComplianceSummariesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListResourceComplianceSummariesRequest.builder()
- Parameters:
listResourceComplianceSummariesRequest
- AConsumer
that will call methods onListResourceComplianceSummariesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidFilterException
- The filter name isn't valid. Verify the you entered the correct name and try again.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
listResourceDataSync
default 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 theMaxResults
parameter. To determine whether there are more sync configurations to list, check the value ofNextToken
in the output. If there are more sync configurations to list, you can request them by specifying theNextToken
returned in the call to the parameter of a subsequent call.- Parameters:
listResourceDataSyncRequest
-- Returns:
- Result of the ListResourceDataSync operation returned by the service.
- Throws:
ResourceDataSyncInvalidConfigurationException
- The specified sync configuration is invalid.InternalServerErrorException
- An error occurred on the server side.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
listResourceDataSync
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 theMaxResults
parameter. To determine whether there are more sync configurations to list, check the value ofNextToken
in the output. If there are more sync configurations to list, you can request them by specifying theNextToken
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 viaListResourceDataSyncRequest.builder()
- Parameters:
listResourceDataSyncRequest
- AConsumer
that will call methods onListResourceDataSyncRequest.Builder
to create a request.- Returns:
- Result of the ListResourceDataSync operation returned by the service.
- Throws:
ResourceDataSyncInvalidConfigurationException
- The specified sync configuration is invalid.InternalServerErrorException
- An error occurred on the server side.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
listResourceDataSync
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 theMaxResults
parameter. To determine whether there are more sync configurations to list, check the value ofNextToken
in the output. If there are more sync configurations to list, you can request them by specifying theNextToken
returned in the call to the parameter of a subsequent call.- Returns:
- Result of the ListResourceDataSync operation returned by the service.
- Throws:
ResourceDataSyncInvalidConfigurationException
- The specified sync configuration is invalid.InternalServerErrorException
- An error occurred on the server side.InvalidNextTokenException
- The specified token isn't 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
- See Also:
listResourceDataSync(ListResourceDataSyncRequest)
, AWS API Documentation
-
listResourceDataSyncPaginator
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 theMaxResults
parameter. To determine whether there are more sync configurations to list, check the value ofNextToken
in the output. If there are more sync configurations to list, you can request them by specifying theNextToken
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 Streamsoftware.amazon.awssdk.services.ssm.paginators.ListResourceDataSyncIterable responses = client.listResourceDataSyncPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ResourceDataSyncInvalidConfigurationException
- The specified sync configuration is invalid.InternalServerErrorException
- An error occurred on the server side.InvalidNextTokenException
- The specified token isn't 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
- See Also:
listResourceDataSyncPaginator(ListResourceDataSyncRequest)
, AWS API Documentation
-
listResourceDataSyncPaginator
default 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 theMaxResults
parameter. To determine whether there are more sync configurations to list, check the value ofNextToken
in the output. If there are more sync configurations to list, you can request them by specifying theNextToken
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 Streamsoftware.amazon.awssdk.services.ssm.paginators.ListResourceDataSyncIterable responses = client.listResourceDataSyncPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
listResourceDataSyncRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ResourceDataSyncInvalidConfigurationException
- The specified sync configuration is invalid.InternalServerErrorException
- An error occurred on the server side.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
listResourceDataSyncPaginator
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 theMaxResults
parameter. To determine whether there are more sync configurations to list, check the value ofNextToken
in the output. If there are more sync configurations to list, you can request them by specifying theNextToken
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 Streamsoftware.amazon.awssdk.services.ssm.paginators.ListResourceDataSyncIterable responses = client.listResourceDataSyncPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListResourceDataSyncRequest.builder()
- Parameters:
listResourceDataSyncRequest
- AConsumer
that will call methods onListResourceDataSyncRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ResourceDataSyncInvalidConfigurationException
- The specified sync configuration is invalid.InternalServerErrorException
- An error occurred on the server side.InvalidNextTokenException
- The specified token isn't 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
- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws InvalidResourceTypeException, InvalidResourceIdException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Returns a list of the tags assigned to the specified resource.
For information about the ID format for each supported resource type, see AddTagsToResource.
- Parameters:
listTagsForResourceRequest
-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
InvalidResourceTypeException
- The resource type isn't valid. For example, if you are attempting to tag an EC2 instance, the instance must be a registered managed node.InvalidResourceIdException
- The resource ID isn't 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
- See Also:
- AWS API Documentation
-
listTagsForResource
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.
For information about the ID format for each supported resource type, see AddTagsToResource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
InvalidResourceTypeException
- The resource type isn't valid. For example, if you are attempting to tag an EC2 instance, the instance must be a registered managed node.InvalidResourceIdException
- The resource ID isn't 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
- See Also:
- AWS API Documentation
-
modifyDocumentPermission
default ModifyDocumentPermissionResponse modifyDocumentPermission(ModifyDocumentPermissionRequest modifyDocumentPermissionRequest) throws InternalServerErrorException, InvalidDocumentException, InvalidPermissionTypeException, DocumentPermissionLimitException, DocumentLimitExceededException, AwsServiceException, SdkClientException, SsmException
Shares a Amazon Web Services Systems Manager document (SSM document)publicly or privately. If you share a document privately, you must specify the Amazon Web Services user IDs for those people who can use the document. If you share a document publicly, you must specify All as the account ID.
- Parameters:
modifyDocumentPermissionRequest
-- Returns:
- Result of the ModifyDocumentPermission operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidDocumentException
- The specified SSM document doesn't exist.InvalidPermissionTypeException
- The permission type isn't supported. Share is the only supported permission type.DocumentPermissionLimitException
- The document can't be shared with more Amazon Web Services accounts. You can specify a maximum of 20 accounts per API operation to share a private document.By default, you can share a private document with a maximum of 1,000 accounts and publicly share up to five documents.
If you need to increase the quota for privately or publicly shared Systems Manager documents, contact Amazon Web Services Support.
DocumentLimitExceededException
- You can have at most 500 active SSM 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
- See Also:
- AWS API Documentation
-
modifyDocumentPermission
default ModifyDocumentPermissionResponse modifyDocumentPermission(Consumer<ModifyDocumentPermissionRequest.Builder> modifyDocumentPermissionRequest) throws InternalServerErrorException, InvalidDocumentException, InvalidPermissionTypeException, DocumentPermissionLimitException, DocumentLimitExceededException, AwsServiceException, SdkClientException, SsmException
Shares a Amazon Web Services Systems Manager document (SSM document)publicly or privately. If you share a document privately, you must specify the Amazon Web Services user 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 viaModifyDocumentPermissionRequest.builder()
- Parameters:
modifyDocumentPermissionRequest
- AConsumer
that will call methods onModifyDocumentPermissionRequest.Builder
to create a request.- Returns:
- Result of the ModifyDocumentPermission operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidDocumentException
- The specified SSM document doesn't exist.InvalidPermissionTypeException
- The permission type isn't supported. Share is the only supported permission type.DocumentPermissionLimitException
- The document can't be shared with more Amazon Web Services accounts. You can specify a maximum of 20 accounts per API operation to share a private document.By default, you can share a private document with a maximum of 1,000 accounts and publicly share up to five documents.
If you need to increase the quota for privately or publicly shared Systems Manager documents, contact Amazon Web Services Support.
DocumentLimitExceededException
- You can have at most 500 active SSM 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
- See Also:
- AWS API Documentation
-
putComplianceItems
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 operation 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 managed node.
-
Id: The patch, association, or custom compliance ID.
-
Title: A title.
-
Status: The status of the compliance item. For example,
approved
for patches, orFailed
for associations. -
Severity: A patch severity. For example,
Critical
. -
DocumentName: An 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'
- Parameters:
putComplianceItemsRequest
-- Returns:
- Result of the PutComplianceItems operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidItemContentException
- One or more content items isn't 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 isn't valid. For example, if you are attempting to tag an EC2 instance, the instance must be a registered managed node.InvalidResourceIdException
- The resource ID isn't 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
- See Also:
- AWS API Documentation
-
-
putComplianceItems
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 operation 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 managed node.
-
Id: The patch, association, or custom compliance ID.
-
Title: A title.
-
Status: The status of the compliance item. For example,
approved
for patches, orFailed
for associations. -
Severity: A patch severity. For example,
Critical
. -
DocumentName: An 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 viaPutComplianceItemsRequest.builder()
- Parameters:
putComplianceItemsRequest
- AConsumer
that will call methods onPutComplianceItemsRequest.Builder
to create a request.- Returns:
- Result of the PutComplianceItems operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidItemContentException
- One or more content items isn't 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 isn't valid. For example, if you are attempting to tag an EC2 instance, the instance must be a registered managed node.InvalidResourceIdException
- The resource ID isn't 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
- See Also:
- AWS API Documentation
-
-
putInventory
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 or more managed nodes. The request adds an inventory item, if it doesn't already exist, or updates an inventory item, if it does exist.
- Parameters:
putInventoryRequest
-- Returns:
- Result of the PutInventory operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidInstanceIdException
- The following problems can cause this exception:-
You don't have permission to access the managed node.
-
Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running.
-
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
-
The managed node isn't in valid state. Valid states are:
Running
,Pending
,Stopped
, andStopping
. Invalid states are:Shutting-down
andTerminated
.
-
InvalidTypeNameException
- The parameter type name isn't valid.InvalidItemContentException
- One or more content items isn't 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
- TheContext
attribute that you specified for theInventoryItem
isn't allowed for this inventory type. You can only use theContext
attribute with inventory types likeAWS:ComplianceItem
.InvalidInventoryItemContextException
- You specified invalid keys or values in theContext
attribute forInventoryItem
. 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
- See Also:
- AWS API Documentation
-
putInventory
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 or more managed nodes. 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 viaPutInventoryRequest.builder()
- Parameters:
putInventoryRequest
- AConsumer
that will call methods onPutInventoryRequest.Builder
to create a request.- Returns:
- Result of the PutInventory operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidInstanceIdException
- The following problems can cause this exception:-
You don't have permission to access the managed node.
-
Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running.
-
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
-
The managed node isn't in valid state. Valid states are:
Running
,Pending
,Stopped
, andStopping
. Invalid states are:Shutting-down
andTerminated
.
-
InvalidTypeNameException
- The parameter type name isn't valid.InvalidItemContentException
- One or more content items isn't 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
- TheContext
attribute that you specified for theInventoryItem
isn't allowed for this inventory type. You can only use theContext
attribute with inventory types likeAWS:ComplianceItem
.InvalidInventoryItemContextException
- You specified invalid keys or values in theContext
attribute forInventoryItem
. 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
- See Also:
- AWS API Documentation
-
putParameter
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.
- Parameters:
putParameterRequest
-- Returns:
- Result of the PutParameter operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidKeyIdException
- The query key ID isn't valid.ParameterLimitExceededException
- You have exceeded the number of parameters for this Amazon Web Services 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 Amazon Web Services Systems Manager User Guide.HierarchyTypeMismatchException
- Parameter Store doesn't support changing a parameter type in a hierarchy. For example, you can't change a parameter from aString
type to aSecureString
type. You must create a new, unique parameter.InvalidAllowedPatternException
- The request doesn't meet the regular expression requirement.ParameterMaxVersionLimitExceededException
- Parameter Store retains the 100 most recently created versions of a parameter. After this number of versions has been created, Parameter Store deletes the oldest version when a new one is created. However, if the oldest version has a label attached to it, Parameter Store won't delete the version and instead presents this error message:An error occurred (ParameterMaxVersionLimitExceeded) when calling the PutParameter operation: You attempted to create a new version of parameter-name by calling the PutParameter API with the overwrite flag. Version version-number, the oldest version, can't be deleted because it has a label associated with it. Move the label to another version of the parameter, and try again.
This safeguard is to prevent parameter versions with mission critical labels assigned to them from being deleted. To continue creating new parameters, first move the label from the oldest version of the parameter to a newer one for use in your operations. For information about moving parameter labels, see Move a parameter label (console) or Move a parameter label (CLI) in the Amazon Web Services Systems Manager User Guide.
ParameterPatternMismatchException
- The parameter name isn't valid.UnsupportedParameterTypeException
- The parameter type isn't supported.PoliciesLimitExceededException
- You specified more than the maximum number of allowed policies for the parameter. The maximum is 10.InvalidPolicyTypeException
- The policy type isn't 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
- See Also:
- AWS API Documentation
-
putParameter
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 viaPutParameterRequest.builder()
- Parameters:
putParameterRequest
- AConsumer
that will call methods onPutParameterRequest.Builder
to create a request.- Returns:
- Result of the PutParameter operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidKeyIdException
- The query key ID isn't valid.ParameterLimitExceededException
- You have exceeded the number of parameters for this Amazon Web Services 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 Amazon Web Services Systems Manager User Guide.HierarchyTypeMismatchException
- Parameter Store doesn't support changing a parameter type in a hierarchy. For example, you can't change a parameter from aString
type to aSecureString
type. You must create a new, unique parameter.InvalidAllowedPatternException
- The request doesn't meet the regular expression requirement.ParameterMaxVersionLimitExceededException
- Parameter Store retains the 100 most recently created versions of a parameter. After this number of versions has been created, Parameter Store deletes the oldest version when a new one is created. However, if the oldest version has a label attached to it, Parameter Store won't delete the version and instead presents this error message:An error occurred (ParameterMaxVersionLimitExceeded) when calling the PutParameter operation: You attempted to create a new version of parameter-name by calling the PutParameter API with the overwrite flag. Version version-number, the oldest version, can't be deleted because it has a label associated with it. Move the label to another version of the parameter, and try again.
This safeguard is to prevent parameter versions with mission critical labels assigned to them from being deleted. To continue creating new parameters, first move the label from the oldest version of the parameter to a newer one for use in your operations. For information about moving parameter labels, see Move a parameter label (console) or Move a parameter label (CLI) in the Amazon Web Services Systems Manager User Guide.
ParameterPatternMismatchException
- The parameter name isn't valid.UnsupportedParameterTypeException
- The parameter type isn't supported.PoliciesLimitExceededException
- You specified more than the maximum number of allowed policies for the parameter. The maximum is 10.InvalidPolicyTypeException
- The policy type isn't 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
- See Also:
- AWS API Documentation
-
putResourcePolicy
default PutResourcePolicyResponse putResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest) throws InternalServerErrorException, ResourcePolicyInvalidParameterException, ResourcePolicyLimitExceededException, ResourcePolicyConflictException, AwsServiceException, SdkClientException, SsmException
Creates or updates a Systems Manager resource policy. A resource policy helps you to define the IAM entity (for example, an Amazon Web Services account) that can manage your Systems Manager resources. Currently,
OpsItemGroup
is the only resource that supports Systems Manager resource policies. The resource policy forOpsItemGroup
enables Amazon Web Services accounts to view and interact with OpsCenter operational work items (OpsItems).- Parameters:
putResourcePolicyRequest
-- Returns:
- Result of the PutResourcePolicy operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.ResourcePolicyInvalidParameterException
- One or more parameters specified for the call aren't valid. Verify the parameters and their values and try again.ResourcePolicyLimitExceededException
- The PutResourcePolicy API action enforces two limits. A policy can't be greater than 1024 bytes in size. And only one policy can be attached toOpsItemGroup
. Verify these limits and try again.ResourcePolicyConflictException
- The hash provided in the call doesn't match the stored hash. This exception is thrown when trying to update an obsolete policy version or when multiple requests to update a policy are sent.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
putResourcePolicy
default PutResourcePolicyResponse putResourcePolicy(Consumer<PutResourcePolicyRequest.Builder> putResourcePolicyRequest) throws InternalServerErrorException, ResourcePolicyInvalidParameterException, ResourcePolicyLimitExceededException, ResourcePolicyConflictException, AwsServiceException, SdkClientException, SsmException
Creates or updates a Systems Manager resource policy. A resource policy helps you to define the IAM entity (for example, an Amazon Web Services account) that can manage your Systems Manager resources. Currently,
OpsItemGroup
is the only resource that supports Systems Manager resource policies. The resource policy forOpsItemGroup
enables Amazon Web Services accounts to view and interact with OpsCenter operational work items (OpsItems).
This is a convenience which creates an instance of the
PutResourcePolicyRequest.Builder
avoiding the need to create one manually viaPutResourcePolicyRequest.builder()
- Parameters:
putResourcePolicyRequest
- AConsumer
that will call methods onPutResourcePolicyRequest.Builder
to create a request.- Returns:
- Result of the PutResourcePolicy operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.ResourcePolicyInvalidParameterException
- One or more parameters specified for the call aren't valid. Verify the parameters and their values and try again.ResourcePolicyLimitExceededException
- The PutResourcePolicy API action enforces two limits. A policy can't be greater than 1024 bytes in size. And only one policy can be attached toOpsItemGroup
. Verify these limits and try again.ResourcePolicyConflictException
- The hash provided in the call doesn't match the stored hash. This exception is thrown when trying to update an obsolete policy version or when multiple requests to update a policy are sent.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
registerDefaultPatchBaseline
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 Amazon Web Services-predefined patch baseline as the default, specify the full patch baseline Amazon Resource Name (ARN) as the baseline ID value. For example, for CentOS, specify
arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-0574b43a65ea646ed
instead ofpb-0574b43a65ea646ed
.- Parameters:
registerDefaultPatchBaselineRequest
-- Returns:
- Result of the RegisterDefaultPatchBaseline operation returned by the service.
- Throws:
InvalidResourceIdException
- The resource ID isn't 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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services 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
- See Also:
- AWS API Documentation
-
registerDefaultPatchBaseline
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 Amazon Web Services-predefined patch baseline as the default, specify the full patch baseline Amazon Resource Name (ARN) as the baseline ID value. For example, for CentOS, specify
arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-0574b43a65ea646ed
instead ofpb-0574b43a65ea646ed
.
This is a convenience which creates an instance of the
RegisterDefaultPatchBaselineRequest.Builder
avoiding the need to create one manually viaRegisterDefaultPatchBaselineRequest.builder()
- Parameters:
registerDefaultPatchBaselineRequest
- AConsumer
that will call methods onRegisterDefaultPatchBaselineRequest.Builder
to create a request.- Returns:
- Result of the RegisterDefaultPatchBaseline operation returned by the service.
- Throws:
InvalidResourceIdException
- The resource ID isn't 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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services 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
- See Also:
- AWS API Documentation
-
registerPatchBaselineForPatchGroup
default RegisterPatchBaselineForPatchGroupResponse registerPatchBaselineForPatchGroup(RegisterPatchBaselineForPatchGroupRequest registerPatchBaselineForPatchGroupRequest) throws AlreadyExistsException, DoesNotExistException, InvalidResourceIdException, ResourceLimitExceededException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Registers a patch baseline for a patch group.
- Parameters:
registerPatchBaselineForPatchGroupRequest
-- Returns:
- Result of the RegisterPatchBaselineForPatchGroup operation returned by the service.
- Throws:
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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.
InvalidResourceIdException
- The resource ID isn't 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 Amazon Web Services 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
- See Also:
- AWS API Documentation
-
registerPatchBaselineForPatchGroup
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 viaRegisterPatchBaselineForPatchGroupRequest.builder()
- Parameters:
registerPatchBaselineForPatchGroupRequest
- AConsumer
that will call methods onRegisterPatchBaselineForPatchGroupRequest.Builder
to create a request.- Returns:
- Result of the RegisterPatchBaselineForPatchGroup operation returned by the service.
- Throws:
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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.
InvalidResourceIdException
- The resource ID isn't 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 Amazon Web Services 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
- See Also:
- AWS API Documentation
-
registerTargetWithMaintenanceWindow
default RegisterTargetWithMaintenanceWindowResponse registerTargetWithMaintenanceWindow(RegisterTargetWithMaintenanceWindowRequest registerTargetWithMaintenanceWindowRequest) throws IdempotentParameterMismatchException, DoesNotExistException, ResourceLimitExceededException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Registers a target with a maintenance window.
- Parameters:
registerTargetWithMaintenanceWindowRequest
-- Returns:
- Result of the RegisterTargetWithMaintenanceWindow operation returned by the service.
- Throws:
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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services 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 Amazon Web Services 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
- See Also:
- AWS API Documentation
-
registerTargetWithMaintenanceWindow
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 viaRegisterTargetWithMaintenanceWindowRequest.builder()
- Parameters:
registerTargetWithMaintenanceWindowRequest
- AConsumer
that will call methods onRegisterTargetWithMaintenanceWindowRequest.Builder
to create a request.- Returns:
- Result of the RegisterTargetWithMaintenanceWindow operation returned by the service.
- Throws:
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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services 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 Amazon Web Services 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
- See Also:
- AWS API Documentation
-
registerTaskWithMaintenanceWindow
default RegisterTaskWithMaintenanceWindowResponse registerTaskWithMaintenanceWindow(RegisterTaskWithMaintenanceWindowRequest registerTaskWithMaintenanceWindowRequest) throws IdempotentParameterMismatchException, DoesNotExistException, ResourceLimitExceededException, FeatureNotAvailableException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Adds a new task to a maintenance window.
- Parameters:
registerTaskWithMaintenanceWindowRequest
-- Returns:
- Result of the RegisterTaskWithMaintenanceWindow operation returned by the service.
- Throws:
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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services 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 Amazon Web Services General Reference.
FeatureNotAvailableException
- You attempted to register aLAMBDA
orSTEP_FUNCTIONS
task in a region where the corresponding service isn't 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
- See Also:
- AWS API Documentation
-
registerTaskWithMaintenanceWindow
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 viaRegisterTaskWithMaintenanceWindowRequest.builder()
- Parameters:
registerTaskWithMaintenanceWindowRequest
- AConsumer
that will call methods onRegisterTaskWithMaintenanceWindowRequest.Builder
to create a request.- Returns:
- Result of the RegisterTaskWithMaintenanceWindow operation returned by the service.
- Throws:
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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services 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 Amazon Web Services General Reference.
FeatureNotAvailableException
- You attempted to register aLAMBDA
orSTEP_FUNCTIONS
task in a region where the corresponding service isn't 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
- See Also:
- AWS API Documentation
-
removeTagsFromResource
default RemoveTagsFromResourceResponse removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest) throws InvalidResourceTypeException, InvalidResourceIdException, InternalServerErrorException, TooManyUpdatesException, AwsServiceException, SdkClientException, SsmException
Removes tag keys from the specified resource.
- Parameters:
removeTagsFromResourceRequest
-- Returns:
- Result of the RemoveTagsFromResource operation returned by the service.
- Throws:
InvalidResourceTypeException
- The resource type isn't valid. For example, if you are attempting to tag an EC2 instance, the instance must be a registered managed node.InvalidResourceIdException
- The resource ID isn't 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
- See Also:
- AWS API Documentation
-
removeTagsFromResource
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 viaRemoveTagsFromResourceRequest.builder()
- Parameters:
removeTagsFromResourceRequest
- AConsumer
that will call methods onRemoveTagsFromResourceRequest.Builder
to create a request.- Returns:
- Result of the RemoveTagsFromResource operation returned by the service.
- Throws:
InvalidResourceTypeException
- The resource type isn't valid. For example, if you are attempting to tag an EC2 instance, the instance must be a registered managed node.InvalidResourceIdException
- The resource ID isn't 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
- See Also:
- AWS API Documentation
-
resetServiceSetting
default ResetServiceSettingResponse resetServiceSetting(ResetServiceSettingRequest resetServiceSettingRequest) throws InternalServerErrorException, ServiceSettingNotFoundException, TooManyUpdatesException, AwsServiceException, SdkClientException, SsmException
ServiceSetting
is an account-level setting for an Amazon Web Services service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an Amazon Web Services service charges money to the account based on feature or service usage, then the Amazon Web Services 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. Amazon Web Services services teams define the default value for aSettingId
. You can't create a newSettingId
, but you can overwrite the default value if you have thessm:UpdateServiceSetting
permission for the setting. Use the GetServiceSetting API operation to view the current value. Use the UpdateServiceSetting API operation to change the default setting.Reset the service setting for the account to the default value as provisioned by the Amazon Web Services service team.
- Parameters:
resetServiceSettingRequest
- The request body of the ResetServiceSetting API operation.- Returns:
- Result of the ResetServiceSetting operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.ServiceSettingNotFoundException
- The specified service setting wasn't found. Either the service name or the setting hasn't been provisioned by the Amazon Web Services 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
- See Also:
- AWS API Documentation
-
resetServiceSetting
default ResetServiceSettingResponse resetServiceSetting(Consumer<ResetServiceSettingRequest.Builder> resetServiceSettingRequest) throws InternalServerErrorException, ServiceSettingNotFoundException, TooManyUpdatesException, AwsServiceException, SdkClientException, SsmException
ServiceSetting
is an account-level setting for an Amazon Web Services service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an Amazon Web Services service charges money to the account based on feature or service usage, then the Amazon Web Services 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. Amazon Web Services services teams define the default value for aSettingId
. You can't create a newSettingId
, but you can overwrite the default value if you have thessm:UpdateServiceSetting
permission for the setting. Use the GetServiceSetting API operation to view the current value. Use the UpdateServiceSetting API operation to change the default setting.Reset the service setting for the account to the default value as provisioned by the Amazon Web Services service team.
This is a convenience which creates an instance of the
ResetServiceSettingRequest.Builder
avoiding the need to create one manually viaResetServiceSettingRequest.builder()
- Parameters:
resetServiceSettingRequest
- AConsumer
that will call methods onResetServiceSettingRequest.Builder
to create a request. The request body of the ResetServiceSetting API operation.- Returns:
- Result of the ResetServiceSetting operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.ServiceSettingNotFoundException
- The specified service setting wasn't found. Either the service name or the setting hasn't been provisioned by the Amazon Web Services 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
- See Also:
- AWS API Documentation
-
resumeSession
default ResumeSessionResponse resumeSession(ResumeSessionRequest resumeSessionRequest) throws DoesNotExistException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Reconnects a session to a managed node 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 isn't intended for any other use.
- Parameters:
resumeSessionRequest
-- Returns:
- Result of the ResumeSession operation returned by the service.
- Throws:
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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services 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
- See Also:
- AWS API Documentation
-
resumeSession
default ResumeSessionResponse resumeSession(Consumer<ResumeSessionRequest.Builder> resumeSessionRequest) throws DoesNotExistException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Reconnects a session to a managed node 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 isn't intended for any other use.
This is a convenience which creates an instance of the
ResumeSessionRequest.Builder
avoiding the need to create one manually viaResumeSessionRequest.builder()
- Parameters:
resumeSessionRequest
- AConsumer
that will call methods onResumeSessionRequest.Builder
to create a request.- Returns:
- Result of the ResumeSession operation returned by the service.
- Throws:
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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services 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
- See Also:
- AWS API Documentation
-
sendAutomationSignal
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.
- Parameters:
sendAutomationSignalRequest
-- Returns:
- Result of the SendAutomationSignal operation returned by the service.
- Throws:
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 isn't 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
- See Also:
- AWS API Documentation
-
sendAutomationSignal
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 viaSendAutomationSignalRequest.builder()
- Parameters:
sendAutomationSignalRequest
- AConsumer
that will call methods onSendAutomationSignalRequest.Builder
to create a request.- Returns:
- Result of the SendAutomationSignal operation returned by the service.
- Throws:
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 isn't 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
- See Also:
- AWS API Documentation
-
sendCommand
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 nodes.
- Parameters:
sendCommandRequest
-- Returns:
- Result of the SendCommand operation returned by the service.
- Throws:
DuplicateInstanceIdException
- You can't specify a managed node ID in more than one association.InternalServerErrorException
- An error occurred on the server side.InvalidInstanceIdException
- The following problems can cause this exception:-
You don't have permission to access the managed node.
-
Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running.
-
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
-
The managed node isn't in valid state. Valid states are:
Running
,Pending
,Stopped
, andStopping
. Invalid states are:Shutting-down
andTerminated
.
-
InvalidDocumentException
- The specified SSM document doesn't exist.InvalidDocumentVersionException
- The document version isn't valid or doesn't exist.InvalidOutputFolderException
- The S3 bucket doesn't exist.InvalidParametersException
- You must specify values for all required parameters in the Amazon Web Services Systems Manager document (SSM document). You can only supply values to parameters defined in the SSM document.UnsupportedPlatformTypeException
- The document doesn't support the platform type of the given managed node ID(s). For example, you sent an document for a Windows managed node to a Linux node.MaxDocumentSizeExceededException
- The size limit of a document is 64 KB.InvalidRoleException
- The role name can't contain invalid characters. Also verify that you specified an IAM role for notifications that includes the required trust policy. For information about configuring the IAM role for Run Command notifications, see Configuring Amazon SNS Notifications for Run Command in the Amazon Web Services Systems Manager User Guide.InvalidNotificationConfigException
- One or more configuration items isn't valid. Verify that a valid Amazon Resource Name (ARN) was provided for an Amazon Simple Notification Service 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
- See Also:
- AWS API Documentation
-
sendCommand
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 nodes.
This is a convenience which creates an instance of the
SendCommandRequest.Builder
avoiding the need to create one manually viaSendCommandRequest.builder()
- Parameters:
sendCommandRequest
- AConsumer
that will call methods onSendCommandRequest.Builder
to create a request.- Returns:
- Result of the SendCommand operation returned by the service.
- Throws:
DuplicateInstanceIdException
- You can't specify a managed node ID in more than one association.InternalServerErrorException
- An error occurred on the server side.InvalidInstanceIdException
- The following problems can cause this exception:-
You don't have permission to access the managed node.
-
Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running.
-
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
-
The managed node isn't in valid state. Valid states are:
Running
,Pending
,Stopped
, andStopping
. Invalid states are:Shutting-down
andTerminated
.
-
InvalidDocumentException
- The specified SSM document doesn't exist.InvalidDocumentVersionException
- The document version isn't valid or doesn't exist.InvalidOutputFolderException
- The S3 bucket doesn't exist.InvalidParametersException
- You must specify values for all required parameters in the Amazon Web Services Systems Manager document (SSM document). You can only supply values to parameters defined in the SSM document.UnsupportedPlatformTypeException
- The document doesn't support the platform type of the given managed node ID(s). For example, you sent an document for a Windows managed node to a Linux node.MaxDocumentSizeExceededException
- The size limit of a document is 64 KB.InvalidRoleException
- The role name can't contain invalid characters. Also verify that you specified an IAM role for notifications that includes the required trust policy. For information about configuring the IAM role for Run Command notifications, see Configuring Amazon SNS Notifications for Run Command in the Amazon Web Services Systems Manager User Guide.InvalidNotificationConfigException
- One or more configuration items isn't valid. Verify that a valid Amazon Resource Name (ARN) was provided for an Amazon Simple Notification Service 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
- See Also:
- AWS API Documentation
-
startAssociationsOnce
default StartAssociationsOnceResponse startAssociationsOnce(StartAssociationsOnceRequest startAssociationsOnceRequest) throws InvalidAssociationException, AssociationDoesNotExistException, AwsServiceException, SdkClientException, SsmException
Runs an association immediately and only one time. This operation can be helpful when troubleshooting associations.
- Parameters:
startAssociationsOnceRequest
-- Returns:
- Result of the StartAssociationsOnce operation returned by the service.
- Throws:
InvalidAssociationException
- The association isn't valid or doesn't exist.AssociationDoesNotExistException
- The specified association doesn't 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
- See Also:
- AWS API Documentation
-
startAssociationsOnce
default StartAssociationsOnceResponse startAssociationsOnce(Consumer<StartAssociationsOnceRequest.Builder> startAssociationsOnceRequest) throws InvalidAssociationException, AssociationDoesNotExistException, AwsServiceException, SdkClientException, SsmException
Runs an association immediately and only one time. This operation 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 viaStartAssociationsOnceRequest.builder()
- Parameters:
startAssociationsOnceRequest
- AConsumer
that will call methods onStartAssociationsOnceRequest.Builder
to create a request.- Returns:
- Result of the StartAssociationsOnce operation returned by the service.
- Throws:
InvalidAssociationException
- The association isn't valid or doesn't exist.AssociationDoesNotExistException
- The specified association doesn't 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
- See Also:
- AWS API Documentation
-
startAutomationExecution
default StartAutomationExecutionResponse startAutomationExecution(StartAutomationExecutionRequest startAutomationExecutionRequest) throws AutomationDefinitionNotFoundException, InvalidAutomationExecutionParametersException, AutomationExecutionLimitExceededException, AutomationDefinitionVersionNotFoundException, IdempotentParameterMismatchException, InvalidTargetException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Initiates execution of an Automation runbook.
- Parameters:
startAutomationExecutionRequest
-- Returns:
- Result of the StartAutomationExecution operation returned by the service.
- Throws:
AutomationDefinitionNotFoundException
- An Automation runbook with the specified name couldn't be found.InvalidAutomationExecutionParametersException
- The supplied parameters for invoking the specified Automation runbook 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 runbook with the specified name and version couldn't 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 isn't valid or doesn't 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
- See Also:
- AWS API Documentation
-
startAutomationExecution
default StartAutomationExecutionResponse startAutomationExecution(Consumer<StartAutomationExecutionRequest.Builder> startAutomationExecutionRequest) throws AutomationDefinitionNotFoundException, InvalidAutomationExecutionParametersException, AutomationExecutionLimitExceededException, AutomationDefinitionVersionNotFoundException, IdempotentParameterMismatchException, InvalidTargetException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Initiates execution of an Automation runbook.
This is a convenience which creates an instance of the
StartAutomationExecutionRequest.Builder
avoiding the need to create one manually viaStartAutomationExecutionRequest.builder()
- Parameters:
startAutomationExecutionRequest
- AConsumer
that will call methods onStartAutomationExecutionRequest.Builder
to create a request.- Returns:
- Result of the StartAutomationExecution operation returned by the service.
- Throws:
AutomationDefinitionNotFoundException
- An Automation runbook with the specified name couldn't be found.InvalidAutomationExecutionParametersException
- The supplied parameters for invoking the specified Automation runbook 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 runbook with the specified name and version couldn't 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 isn't valid or doesn't 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
- See Also:
- AWS API Documentation
-
startChangeRequestExecution
default StartChangeRequestExecutionResponse startChangeRequestExecution(StartChangeRequestExecutionRequest startChangeRequestExecutionRequest) throws AutomationDefinitionNotFoundException, InvalidAutomationExecutionParametersException, AutomationExecutionLimitExceededException, AutomationDefinitionVersionNotFoundException, IdempotentParameterMismatchException, InternalServerErrorException, AutomationDefinitionNotApprovedException, AwsServiceException, SdkClientException, SsmException
Creates a change request for Change Manager. The Automation runbooks specified in the change request run only after all required approvals for the change request have been received.
- Parameters:
startChangeRequestExecutionRequest
-- Returns:
- Result of the StartChangeRequestExecution operation returned by the service.
- Throws:
AutomationDefinitionNotFoundException
- An Automation runbook with the specified name couldn't be found.InvalidAutomationExecutionParametersException
- The supplied parameters for invoking the specified Automation runbook 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 runbook with the specified name and version couldn't 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.InternalServerErrorException
- An error occurred on the server side.AutomationDefinitionNotApprovedException
- Indicates that the Change Manager change template used in the change request was rejected or is still in a pending state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
startChangeRequestExecution
default StartChangeRequestExecutionResponse startChangeRequestExecution(Consumer<StartChangeRequestExecutionRequest.Builder> startChangeRequestExecutionRequest) throws AutomationDefinitionNotFoundException, InvalidAutomationExecutionParametersException, AutomationExecutionLimitExceededException, AutomationDefinitionVersionNotFoundException, IdempotentParameterMismatchException, InternalServerErrorException, AutomationDefinitionNotApprovedException, AwsServiceException, SdkClientException, SsmException
Creates a change request for Change Manager. The Automation runbooks specified in the change request run only after all required approvals for the change request have been received.
This is a convenience which creates an instance of the
StartChangeRequestExecutionRequest.Builder
avoiding the need to create one manually viaStartChangeRequestExecutionRequest.builder()
- Parameters:
startChangeRequestExecutionRequest
- AConsumer
that will call methods onStartChangeRequestExecutionRequest.Builder
to create a request.- Returns:
- Result of the StartChangeRequestExecution operation returned by the service.
- Throws:
AutomationDefinitionNotFoundException
- An Automation runbook with the specified name couldn't be found.InvalidAutomationExecutionParametersException
- The supplied parameters for invoking the specified Automation runbook 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 runbook with the specified name and version couldn't 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.InternalServerErrorException
- An error occurred on the server side.AutomationDefinitionNotApprovedException
- Indicates that the Change Manager change template used in the change request was rejected or is still in a pending state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
startSession
default StartSessionResponse startSession(StartSessionRequest startSessionRequest) throws InvalidDocumentException, TargetNotConnectedException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Initiates a connection to a target (for example, a managed node) 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.
Amazon Web Services 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 Amazon Web Services CLI in the Amazon Web Services Systems Manager User Guide.Amazon Web Services Tools for PowerShell usage: Start-SSMSession isn't currently supported by Amazon Web Services Tools for PowerShell on Windows local machines.
- Parameters:
startSessionRequest
-- Returns:
- Result of the StartSession operation returned by the service.
- Throws:
InvalidDocumentException
- The specified SSM document doesn't exist.TargetNotConnectedException
- The specified target managed node for the session isn't fully configured for use with Session Manager. For more information, see Getting started with Session Manager in the Amazon Web Services Systems Manager User Guide. This error is also returned if you attempt to start a session on a managed node that is located in a different account or RegionInternalServerErrorException
- 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
- See Also:
- AWS API Documentation
-
startSession
default StartSessionResponse startSession(Consumer<StartSessionRequest.Builder> startSessionRequest) throws InvalidDocumentException, TargetNotConnectedException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Initiates a connection to a target (for example, a managed node) 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.
Amazon Web Services 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 Amazon Web Services CLI in the Amazon Web Services Systems Manager User Guide.Amazon Web Services Tools for PowerShell usage: Start-SSMSession isn't currently supported by Amazon Web Services 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 viaStartSessionRequest.builder()
- Parameters:
startSessionRequest
- AConsumer
that will call methods onStartSessionRequest.Builder
to create a request.- Returns:
- Result of the StartSession operation returned by the service.
- Throws:
InvalidDocumentException
- The specified SSM document doesn't exist.TargetNotConnectedException
- The specified target managed node for the session isn't fully configured for use with Session Manager. For more information, see Getting started with Session Manager in the Amazon Web Services Systems Manager User Guide. This error is also returned if you attempt to start a session on a managed node that is located in a different account or RegionInternalServerErrorException
- 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
- See Also:
- AWS API Documentation
-
stopAutomationExecution
default StopAutomationExecutionResponse stopAutomationExecution(StopAutomationExecutionRequest stopAutomationExecutionRequest) throws AutomationExecutionNotFoundException, InvalidAutomationStatusUpdateException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Stop an Automation that is currently running.
- Parameters:
stopAutomationExecutionRequest
-- Returns:
- Result of the StopAutomationExecution operation returned by the service.
- Throws:
AutomationExecutionNotFoundException
- There is no automation execution information for the requested automation execution ID.InvalidAutomationStatusUpdateException
- The specified update status operation isn't 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
- See Also:
- AWS API Documentation
-
stopAutomationExecution
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 viaStopAutomationExecutionRequest.builder()
- Parameters:
stopAutomationExecutionRequest
- AConsumer
that will call methods onStopAutomationExecutionRequest.Builder
to create a request.- Returns:
- Result of the StopAutomationExecution operation returned by the service.
- Throws:
AutomationExecutionNotFoundException
- There is no automation execution information for the requested automation execution ID.InvalidAutomationStatusUpdateException
- The specified update status operation isn't 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
- See Also:
- AWS API Documentation
-
terminateSession
default TerminateSessionResponse terminateSession(TerminateSessionRequest terminateSessionRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Permanently ends a session and closes the data connection between the Session Manager client and SSM Agent on the managed node. A terminated session can't be resumed.
- Parameters:
terminateSessionRequest
-- Returns:
- Result of the TerminateSession operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
terminateSession
default TerminateSessionResponse terminateSession(Consumer<TerminateSessionRequest.Builder> terminateSessionRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Permanently ends a session and closes the data connection between the Session Manager client and SSM Agent on the managed node. A terminated session can't be resumed.
This is a convenience which creates an instance of the
TerminateSessionRequest.Builder
avoiding the need to create one manually viaTerminateSessionRequest.builder()
- Parameters:
terminateSessionRequest
- AConsumer
that will call methods onTerminateSessionRequest.Builder
to create a request.- Returns:
- Result of the TerminateSession operation returned by the service.
- Throws:
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
- See Also:
- AWS API Documentation
-
unlabelParameterVersion
default UnlabelParameterVersionResponse unlabelParameterVersion(UnlabelParameterVersionRequest unlabelParameterVersionRequest) throws InternalServerErrorException, TooManyUpdatesException, ParameterNotFoundException, ParameterVersionNotFoundException, AwsServiceException, SdkClientException, SsmException
Remove a label or labels from a parameter.
- Parameters:
unlabelParameterVersionRequest
-- Returns:
- Result of the UnlabelParameterVersion operation returned by the service.
- Throws:
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 couldn't be found. Verify the name and try again.ParameterVersionNotFoundException
- The specified parameter version wasn't 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
- See Also:
- AWS API Documentation
-
unlabelParameterVersion
default UnlabelParameterVersionResponse unlabelParameterVersion(Consumer<UnlabelParameterVersionRequest.Builder> unlabelParameterVersionRequest) throws InternalServerErrorException, TooManyUpdatesException, ParameterNotFoundException, ParameterVersionNotFoundException, AwsServiceException, SdkClientException, SsmException
Remove a label or labels from a parameter.
This is a convenience which creates an instance of the
UnlabelParameterVersionRequest.Builder
avoiding the need to create one manually viaUnlabelParameterVersionRequest.builder()
- Parameters:
unlabelParameterVersionRequest
- AConsumer
that will call methods onUnlabelParameterVersionRequest.Builder
to create a request.- Returns:
- Result of the UnlabelParameterVersion operation returned by the service.
- Throws:
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 couldn't be found. Verify the name and try again.ParameterVersionNotFoundException
- The specified parameter version wasn't 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
- See Also:
- AWS API Documentation
-
updateAssociation
default UpdateAssociationResponse updateAssociation(UpdateAssociationRequest updateAssociationRequest) throws InternalServerErrorException, InvalidScheduleException, InvalidParametersException, InvalidOutputLocationException, InvalidDocumentVersionException, AssociationDoesNotExistException, InvalidUpdateException, TooManyUpdatesException, InvalidDocumentException, InvalidTargetException, InvalidAssociationVersionException, AssociationVersionLimitExceededException, InvalidTargetMapsException, AwsServiceException, SdkClientException, SsmException
Updates an association. You can update the association name and version, the document version, schedule, parameters, and Amazon Simple Storage Service (Amazon S3) output. When you call
UpdateAssociation
, the system removes all optional parameters from the request and overwrites the association with null values for those parameters. This is by design. You must specify all optional parameters in the call, even if you are not changing the parameters. This includes theName
parameter. Before calling this API action, we recommend that you call the DescribeAssociation API operation and make a note of all optional parameters required for yourUpdateAssociation
call.In order to call this API operation, a user, group, or role must be granted permission to call the DescribeAssociation API operation. 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> isn't authorized to perform: ssm:DescribeAssociation on resource: <resource_arn>
When you update an association, the association immediately runs against the specified targets. You can add the
ApplyOnlyAtCronInterval
parameter to run the association during the next schedule run.- Parameters:
updateAssociationRequest
-- Returns:
- Result of the UpdateAssociation operation returned by the service.
- Throws:
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 Amazon Web Services Systems Manager document (SSM document). You can only supply values to parameters defined in the SSM document.InvalidOutputLocationException
- The output location isn't valid or doesn't exist.InvalidDocumentVersionException
- The document version isn't valid or doesn't exist.AssociationDoesNotExistException
- The specified association doesn't exist.InvalidUpdateException
- The update isn't valid.TooManyUpdatesException
- There are concurrent updates for a resource that supports one update at a time.InvalidDocumentException
- The specified SSM document doesn't exist.InvalidTargetException
- The target isn't valid or doesn't exist. It might not be configured for Systems Manager or you might not have permission to perform the operation.InvalidAssociationVersionException
- The version you specified isn't 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.InvalidTargetMapsException
- TargetMap parameter isn't 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
- See Also:
- AWS API Documentation
-
updateAssociation
default UpdateAssociationResponse updateAssociation(Consumer<UpdateAssociationRequest.Builder> updateAssociationRequest) throws InternalServerErrorException, InvalidScheduleException, InvalidParametersException, InvalidOutputLocationException, InvalidDocumentVersionException, AssociationDoesNotExistException, InvalidUpdateException, TooManyUpdatesException, InvalidDocumentException, InvalidTargetException, InvalidAssociationVersionException, AssociationVersionLimitExceededException, InvalidTargetMapsException, AwsServiceException, SdkClientException, SsmException
Updates an association. You can update the association name and version, the document version, schedule, parameters, and Amazon Simple Storage Service (Amazon S3) output. When you call
UpdateAssociation
, the system removes all optional parameters from the request and overwrites the association with null values for those parameters. This is by design. You must specify all optional parameters in the call, even if you are not changing the parameters. This includes theName
parameter. Before calling this API action, we recommend that you call the DescribeAssociation API operation and make a note of all optional parameters required for yourUpdateAssociation
call.In order to call this API operation, a user, group, or role must be granted permission to call the DescribeAssociation API operation. 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> isn't authorized to perform: ssm:DescribeAssociation on resource: <resource_arn>
When you update an association, the association immediately runs against the specified targets. You can add the
ApplyOnlyAtCronInterval
parameter to run the association during the next schedule run.
This is a convenience which creates an instance of the
UpdateAssociationRequest.Builder
avoiding the need to create one manually viaUpdateAssociationRequest.builder()
- Parameters:
updateAssociationRequest
- AConsumer
that will call methods onUpdateAssociationRequest.Builder
to create a request.- Returns:
- Result of the UpdateAssociation operation returned by the service.
- Throws:
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 Amazon Web Services Systems Manager document (SSM document). You can only supply values to parameters defined in the SSM document.InvalidOutputLocationException
- The output location isn't valid or doesn't exist.InvalidDocumentVersionException
- The document version isn't valid or doesn't exist.AssociationDoesNotExistException
- The specified association doesn't exist.InvalidUpdateException
- The update isn't valid.TooManyUpdatesException
- There are concurrent updates for a resource that supports one update at a time.InvalidDocumentException
- The specified SSM document doesn't exist.InvalidTargetException
- The target isn't valid or doesn't exist. It might not be configured for Systems Manager or you might not have permission to perform the operation.InvalidAssociationVersionException
- The version you specified isn't 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.InvalidTargetMapsException
- TargetMap parameter isn't 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
- See Also:
- AWS API Documentation
-
updateAssociationStatus
default UpdateAssociationStatusResponse updateAssociationStatus(UpdateAssociationStatusRequest updateAssociationStatusRequest) throws InternalServerErrorException, InvalidInstanceIdException, InvalidDocumentException, AssociationDoesNotExistException, StatusUnchangedException, TooManyUpdatesException, AwsServiceException, SdkClientException, SsmException
Updates the status of the Amazon Web Services Systems Manager document (SSM document) associated with the specified managed node.
UpdateAssociationStatus
is primarily used by the Amazon Web Services Systems Manager Agent (SSM Agent) to report status updates about your associations and is only used for associations created with theInstanceId
legacy parameter.- Parameters:
updateAssociationStatusRequest
-- Returns:
- Result of the UpdateAssociationStatus operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidInstanceIdException
- The following problems can cause this exception:-
You don't have permission to access the managed node.
-
Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running.
-
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
-
The managed node isn't in valid state. Valid states are:
Running
,Pending
,Stopped
, andStopping
. Invalid states are:Shutting-down
andTerminated
.
-
InvalidDocumentException
- The specified SSM document doesn't exist.AssociationDoesNotExistException
- The specified association doesn't 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
- See Also:
- AWS API Documentation
-
updateAssociationStatus
default UpdateAssociationStatusResponse updateAssociationStatus(Consumer<UpdateAssociationStatusRequest.Builder> updateAssociationStatusRequest) throws InternalServerErrorException, InvalidInstanceIdException, InvalidDocumentException, AssociationDoesNotExistException, StatusUnchangedException, TooManyUpdatesException, AwsServiceException, SdkClientException, SsmException
Updates the status of the Amazon Web Services Systems Manager document (SSM document) associated with the specified managed node.
UpdateAssociationStatus
is primarily used by the Amazon Web Services Systems Manager Agent (SSM Agent) to report status updates about your associations and is only used for associations created with theInstanceId
legacy parameter.
This is a convenience which creates an instance of the
UpdateAssociationStatusRequest.Builder
avoiding the need to create one manually viaUpdateAssociationStatusRequest.builder()
- Parameters:
updateAssociationStatusRequest
- AConsumer
that will call methods onUpdateAssociationStatusRequest.Builder
to create a request.- Returns:
- Result of the UpdateAssociationStatus operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidInstanceIdException
- The following problems can cause this exception:-
You don't have permission to access the managed node.
-
Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running.
-
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
-
The managed node isn't in valid state. Valid states are:
Running
,Pending
,Stopped
, andStopping
. Invalid states are:Shutting-down
andTerminated
.
-
InvalidDocumentException
- The specified SSM document doesn't exist.AssociationDoesNotExistException
- The specified association doesn't 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
- See Also:
- AWS API Documentation
-
updateDocument
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.
- Parameters:
updateDocumentRequest
-- Returns:
- Result of the UpdateDocument operation returned by the service.
- Throws:
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 isn't valid.InvalidDocumentVersionException
- The document version isn't valid or doesn't exist.InvalidDocumentSchemaVersionException
- The version of the document schema isn't supported.InvalidDocumentException
- The specified SSM document doesn't 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
- See Also:
- AWS API Documentation
-
updateDocument
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 viaUpdateDocumentRequest.builder()
- Parameters:
updateDocumentRequest
- AConsumer
that will call methods onUpdateDocumentRequest.Builder
to create a request.- Returns:
- Result of the UpdateDocument operation returned by the service.
- Throws:
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 isn't valid.InvalidDocumentVersionException
- The document version isn't valid or doesn't exist.InvalidDocumentSchemaVersionException
- The version of the document schema isn't supported.InvalidDocumentException
- The specified SSM document doesn't 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
- See Also:
- AWS API Documentation
-
updateDocumentDefaultVersion
default UpdateDocumentDefaultVersionResponse updateDocumentDefaultVersion(UpdateDocumentDefaultVersionRequest updateDocumentDefaultVersionRequest) throws InternalServerErrorException, InvalidDocumentException, InvalidDocumentVersionException, InvalidDocumentSchemaVersionException, AwsServiceException, SdkClientException, SsmException
Set the default version of a document.
If you change a document version for a State Manager association, Systems Manager immediately runs the association unless you previously specifed the
apply-only-at-cron-interval
parameter.- Parameters:
updateDocumentDefaultVersionRequest
-- Returns:
- Result of the UpdateDocumentDefaultVersion operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidDocumentException
- The specified SSM document doesn't exist.InvalidDocumentVersionException
- The document version isn't valid or doesn't exist.InvalidDocumentSchemaVersionException
- The version of the document schema isn't 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
- See Also:
- AWS API Documentation
-
updateDocumentDefaultVersion
default UpdateDocumentDefaultVersionResponse updateDocumentDefaultVersion(Consumer<UpdateDocumentDefaultVersionRequest.Builder> updateDocumentDefaultVersionRequest) throws InternalServerErrorException, InvalidDocumentException, InvalidDocumentVersionException, InvalidDocumentSchemaVersionException, AwsServiceException, SdkClientException, SsmException
Set the default version of a document.
If you change a document version for a State Manager association, Systems Manager immediately runs the association unless you previously specifed the
apply-only-at-cron-interval
parameter.
This is a convenience which creates an instance of the
UpdateDocumentDefaultVersionRequest.Builder
avoiding the need to create one manually viaUpdateDocumentDefaultVersionRequest.builder()
- Parameters:
updateDocumentDefaultVersionRequest
- AConsumer
that will call methods onUpdateDocumentDefaultVersionRequest.Builder
to create a request.- Returns:
- Result of the UpdateDocumentDefaultVersion operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidDocumentException
- The specified SSM document doesn't exist.InvalidDocumentVersionException
- The document version isn't valid or doesn't exist.InvalidDocumentSchemaVersionException
- The version of the document schema isn't 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
- See Also:
- AWS API Documentation
-
updateDocumentMetadata
default UpdateDocumentMetadataResponse updateDocumentMetadata(UpdateDocumentMetadataRequest updateDocumentMetadataRequest) throws InternalServerErrorException, InvalidDocumentException, InvalidDocumentOperationException, InvalidDocumentVersionException, AwsServiceException, SdkClientException, SsmException
Updates information related to approval reviews for a specific version of a change template in Change Manager.
- Parameters:
updateDocumentMetadataRequest
-- Returns:
- Result of the UpdateDocumentMetadata operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidDocumentException
- The specified SSM document doesn't exist.InvalidDocumentOperationException
- You attempted to delete a document while it is still shared. You must stop sharing the document before you can delete it.InvalidDocumentVersionException
- The document version isn't valid or doesn't 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
- See Also:
- AWS API Documentation
-
updateDocumentMetadata
default UpdateDocumentMetadataResponse updateDocumentMetadata(Consumer<UpdateDocumentMetadataRequest.Builder> updateDocumentMetadataRequest) throws InternalServerErrorException, InvalidDocumentException, InvalidDocumentOperationException, InvalidDocumentVersionException, AwsServiceException, SdkClientException, SsmException
Updates information related to approval reviews for a specific version of a change template in Change Manager.
This is a convenience which creates an instance of the
UpdateDocumentMetadataRequest.Builder
avoiding the need to create one manually viaUpdateDocumentMetadataRequest.builder()
- Parameters:
updateDocumentMetadataRequest
- AConsumer
that will call methods onUpdateDocumentMetadataRequest.Builder
to create a request.- Returns:
- Result of the UpdateDocumentMetadata operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.InvalidDocumentException
- The specified SSM document doesn't exist.InvalidDocumentOperationException
- You attempted to delete a document while it is still shared. You must stop sharing the document before you can delete it.InvalidDocumentVersionException
- The document version isn't valid or doesn't 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
- See Also:
- AWS API Documentation
-
updateMaintenanceWindow
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 forCutoff
. For example, if the maintenance window starts at 3 PM, the duration is three hours, and the value you specify forCutoff
is one hour, no maintenance window tasks can start after 5 PM.- Parameters:
updateMaintenanceWindowRequest
-- Returns:
- Result of the UpdateMaintenanceWindow operation returned by the service.
- Throws:
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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services 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
- See Also:
- AWS API Documentation
-
updateMaintenanceWindow
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 forCutoff
. For example, if the maintenance window starts at 3 PM, the duration is three hours, and the value you specify forCutoff
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 viaUpdateMaintenanceWindowRequest.builder()
- Parameters:
updateMaintenanceWindowRequest
- AConsumer
that will call methods onUpdateMaintenanceWindowRequest.Builder
to create a request.- Returns:
- Result of the UpdateMaintenanceWindow operation returned by the service.
- Throws:
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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services 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
- See Also:
- AWS API Documentation
-
updateMaintenanceWindowTarget
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 isn't modified.
- Parameters:
updateMaintenanceWindowTargetRequest
-- Returns:
- Result of the UpdateMaintenanceWindowTarget operation returned by the service.
- Throws:
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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services 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
- See Also:
- AWS API Documentation
-
-
updateMaintenanceWindowTarget
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 isn't modified.
This is a convenience which creates an instance of the
UpdateMaintenanceWindowTargetRequest.Builder
avoiding the need to create one manually viaUpdateMaintenanceWindowTargetRequest.builder()
- Parameters:
updateMaintenanceWindowTargetRequest
- AConsumer
that will call methods onUpdateMaintenanceWindowTargetRequest.Builder
to create a request.- Returns:
- Result of the UpdateMaintenanceWindowTarget operation returned by the service.
- Throws:
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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services 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
- See Also:
- AWS API Documentation
-
-
updateMaintenanceWindowTask
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 aRUN_COMMAND
task fromAWS-RunPowerShellScript
toAWS-RunShellScript
. -
ServiceRoleArn
-
TaskInvocationParameters
-
Priority
-
MaxConcurrency
-
MaxErrors
One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, Lambda, and Step Functions). For more information about running tasks that don't specify targets, see Registering maintenance window tasks without targets in the Amazon Web Services Systems Manager User Guide.
If the value for a parameter in
UpdateMaintenanceWindowTask
is null, then the corresponding field isn't modified. If you setReplace
to true, then all fields required by the RegisterTaskWithMaintenanceWindow operation are required for this request. Optional fields that aren't specified are set to null.When you update a maintenance window task that has options specified in
TaskInvocationParameters
, you must provide again all theTaskInvocationParameters
values that you want to retain. The values you don't specify again are removed. For example, suppose that when you registered a Run Command task, you specifiedTaskInvocationParameters
values forComment
,NotificationConfig
, andOutputS3BucketName
. If you update the maintenance window task and specify only a differentOutputS3BucketName
value, the values forComment
andNotificationConfig
are removed.- Parameters:
updateMaintenanceWindowTaskRequest
-- Returns:
- Result of the UpdateMaintenanceWindowTask operation returned by the service.
- Throws:
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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services 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
- See Also:
- AWS API Documentation
-
-
updateMaintenanceWindowTask
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 aRUN_COMMAND
task fromAWS-RunPowerShellScript
toAWS-RunShellScript
. -
ServiceRoleArn
-
TaskInvocationParameters
-
Priority
-
MaxConcurrency
-
MaxErrors
One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, Lambda, and Step Functions). For more information about running tasks that don't specify targets, see Registering maintenance window tasks without targets in the Amazon Web Services Systems Manager User Guide.
If the value for a parameter in
UpdateMaintenanceWindowTask
is null, then the corresponding field isn't modified. If you setReplace
to true, then all fields required by the RegisterTaskWithMaintenanceWindow operation are required for this request. Optional fields that aren't specified are set to null.When you update a maintenance window task that has options specified in
TaskInvocationParameters
, you must provide again all theTaskInvocationParameters
values that you want to retain. The values you don't specify again are removed. For example, suppose that when you registered a Run Command task, you specifiedTaskInvocationParameters
values forComment
,NotificationConfig
, andOutputS3BucketName
. If you update the maintenance window task and specify only a differentOutputS3BucketName
value, the values forComment
andNotificationConfig
are removed.
This is a convenience which creates an instance of the
UpdateMaintenanceWindowTaskRequest.Builder
avoiding the need to create one manually viaUpdateMaintenanceWindowTaskRequest.builder()
- Parameters:
updateMaintenanceWindowTaskRequest
- AConsumer
that will call methods onUpdateMaintenanceWindowTaskRequest.Builder
to create a request.- Returns:
- Result of the UpdateMaintenanceWindowTask operation returned by the service.
- Throws:
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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services 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
- See Also:
- AWS API Documentation
-
-
updateManagedInstanceRole
default UpdateManagedInstanceRoleResponse updateManagedInstanceRole(UpdateManagedInstanceRoleRequest updateManagedInstanceRoleRequest) throws InvalidInstanceIdException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Changes the Identity and Access Management (IAM) role that is assigned to the on-premises server, edge device, or virtual machines (VM). IAM roles are first assigned to these hybrid nodes during the activation process. For more information, see CreateActivation.
- Parameters:
updateManagedInstanceRoleRequest
-- Returns:
- Result of the UpdateManagedInstanceRole operation returned by the service.
- Throws:
InvalidInstanceIdException
- The following problems can cause this exception:-
You don't have permission to access the managed node.
-
Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running.
-
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
-
The managed node isn't in valid state. Valid states are:
Running
,Pending
,Stopped
, andStopping
. Invalid states are:Shutting-down
andTerminated
.
-
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
- See Also:
- AWS API Documentation
-
updateManagedInstanceRole
default UpdateManagedInstanceRoleResponse updateManagedInstanceRole(Consumer<UpdateManagedInstanceRoleRequest.Builder> updateManagedInstanceRoleRequest) throws InvalidInstanceIdException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Changes the Identity and Access Management (IAM) role that is assigned to the on-premises server, edge device, or virtual machines (VM). IAM roles are first assigned to these hybrid nodes 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 viaUpdateManagedInstanceRoleRequest.builder()
- Parameters:
updateManagedInstanceRoleRequest
- AConsumer
that will call methods onUpdateManagedInstanceRoleRequest.Builder
to create a request.- Returns:
- Result of the UpdateManagedInstanceRole operation returned by the service.
- Throws:
InvalidInstanceIdException
- The following problems can cause this exception:-
You don't have permission to access the managed node.
-
Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is running.
-
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
-
The managed node isn't in valid state. Valid states are:
Running
,Pending
,Stopped
, andStopping
. Invalid states are:Shutting-down
andTerminated
.
-
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
- See Also:
- AWS API Documentation
-
updateOpsItem
default UpdateOpsItemResponse updateOpsItem(UpdateOpsItemRequest updateOpsItemRequest) throws InternalServerErrorException, OpsItemNotFoundException, OpsItemAlreadyExistsException, OpsItemLimitExceededException, OpsItemInvalidParameterException, OpsItemAccessDeniedException, OpsItemConflictException, AwsServiceException, SdkClientException, SsmException
Edit or change an OpsItem. You must have permission in Identity and Access Management (IAM) to update an OpsItem. For more information, see Set up OpsCenter in the Amazon Web Services Systems Manager User Guide.
Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For more information, see OpsCenter in the Amazon Web Services Systems Manager User Guide.
- Parameters:
updateOpsItemRequest
-- Returns:
- Result of the UpdateOpsItem operation returned by the service.
- Throws:
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.OpsItemInvalidParameterException
- A specified parameter argument isn't valid. Verify the available arguments and try again.OpsItemAccessDeniedException
- You don't have permission to view OpsItems in the specified account. Verify that your account is configured either as a Systems Manager delegated administrator or that you are logged into the Organizations management account.OpsItemConflictException
- The specified OpsItem is in the process of being deleted.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
updateOpsItem
default UpdateOpsItemResponse updateOpsItem(Consumer<UpdateOpsItemRequest.Builder> updateOpsItemRequest) throws InternalServerErrorException, OpsItemNotFoundException, OpsItemAlreadyExistsException, OpsItemLimitExceededException, OpsItemInvalidParameterException, OpsItemAccessDeniedException, OpsItemConflictException, AwsServiceException, SdkClientException, SsmException
Edit or change an OpsItem. You must have permission in Identity and Access Management (IAM) to update an OpsItem. For more information, see Set up OpsCenter in the Amazon Web Services Systems Manager User Guide.
Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For more information, see OpsCenter in the Amazon Web Services Systems Manager User Guide.
This is a convenience which creates an instance of the
UpdateOpsItemRequest.Builder
avoiding the need to create one manually viaUpdateOpsItemRequest.builder()
- Parameters:
updateOpsItemRequest
- AConsumer
that will call methods onUpdateOpsItemRequest.Builder
to create a request.- Returns:
- Result of the UpdateOpsItem operation returned by the service.
- Throws:
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.OpsItemInvalidParameterException
- A specified parameter argument isn't valid. Verify the available arguments and try again.OpsItemAccessDeniedException
- You don't have permission to view OpsItems in the specified account. Verify that your account is configured either as a Systems Manager delegated administrator or that you are logged into the Organizations management account.OpsItemConflictException
- The specified OpsItem is in the process of being deleted.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
updateOpsMetadata
default UpdateOpsMetadataResponse updateOpsMetadata(UpdateOpsMetadataRequest updateOpsMetadataRequest) throws OpsMetadataNotFoundException, OpsMetadataInvalidArgumentException, OpsMetadataKeyLimitExceededException, OpsMetadataTooManyUpdatesException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Amazon Web Services Systems Manager calls this API operation when you edit OpsMetadata in Application Manager.
- Parameters:
updateOpsMetadataRequest
-- Returns:
- Result of the UpdateOpsMetadata operation returned by the service.
- Throws:
OpsMetadataNotFoundException
- The OpsMetadata object doesn't exist.OpsMetadataInvalidArgumentException
- One of the arguments passed is invalid.OpsMetadataKeyLimitExceededException
- The OpsMetadata object exceeds the maximum number of OpsMetadata keys that you can assign to an application in Application Manager.OpsMetadataTooManyUpdatesException
- The system is processing too many concurrent updates. Wait a few moments 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
- See Also:
- AWS API Documentation
-
updateOpsMetadata
default UpdateOpsMetadataResponse updateOpsMetadata(Consumer<UpdateOpsMetadataRequest.Builder> updateOpsMetadataRequest) throws OpsMetadataNotFoundException, OpsMetadataInvalidArgumentException, OpsMetadataKeyLimitExceededException, OpsMetadataTooManyUpdatesException, InternalServerErrorException, AwsServiceException, SdkClientException, SsmException
Amazon Web Services Systems Manager calls this API operation when you edit OpsMetadata in Application Manager.
This is a convenience which creates an instance of the
UpdateOpsMetadataRequest.Builder
avoiding the need to create one manually viaUpdateOpsMetadataRequest.builder()
- Parameters:
updateOpsMetadataRequest
- AConsumer
that will call methods onUpdateOpsMetadataRequest.Builder
to create a request.- Returns:
- Result of the UpdateOpsMetadata operation returned by the service.
- Throws:
OpsMetadataNotFoundException
- The OpsMetadata object doesn't exist.OpsMetadataInvalidArgumentException
- One of the arguments passed is invalid.OpsMetadataKeyLimitExceededException
- The OpsMetadata object exceeds the maximum number of OpsMetadata keys that you can assign to an application in Application Manager.OpsMetadataTooManyUpdatesException
- The system is processing too many concurrent updates. Wait a few moments 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
- See Also:
- AWS API Documentation
-
updatePatchBaseline
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-value pairs in
PatchFilters
for each supported operating system type, see PatchFilter.- Parameters:
updatePatchBaselineRequest
-- Returns:
- Result of the UpdatePatchBaseline operation returned by the service.
- Throws:
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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services 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
- See Also:
- AWS API Documentation
-
updatePatchBaseline
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-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 viaUpdatePatchBaselineRequest.builder()
- Parameters:
updatePatchBaselineRequest
- AConsumer
that will call methods onUpdatePatchBaselineRequest.Builder
to create a request.- Returns:
- Result of the UpdatePatchBaseline operation returned by the service.
- Throws:
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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services 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
- See Also:
- AWS API Documentation
-
updateResourceDataSync
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 theInclude all accounts from my Organizations configuration
option. Instead, you must delete the first resource data sync, and create a new one.This API operation only supports a resource data sync that was created with a SyncFromSource
SyncType
.- Parameters:
updateResourceDataSyncRequest
-- Returns:
- Result of the UpdateResourceDataSync operation returned by the service.
- Throws:
ResourceDataSyncNotFoundException
- The specified sync name wasn't found.ResourceDataSyncInvalidConfigurationException
- The specified sync configuration is invalid.ResourceDataSyncConflictException
- AnotherUpdateResourceDataSync
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
- See Also:
- AWS API Documentation
-
updateResourceDataSync
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 theInclude all accounts from my Organizations configuration
option. Instead, you must delete the first resource data sync, and create a new one.This API operation 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 viaUpdateResourceDataSyncRequest.builder()
- Parameters:
updateResourceDataSyncRequest
- AConsumer
that will call methods onUpdateResourceDataSyncRequest.Builder
to create a request.- Returns:
- Result of the UpdateResourceDataSync operation returned by the service.
- Throws:
ResourceDataSyncNotFoundException
- The specified sync name wasn't found.ResourceDataSyncInvalidConfigurationException
- The specified sync configuration is invalid.ResourceDataSyncConflictException
- AnotherUpdateResourceDataSync
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
- See Also:
- AWS API Documentation
-
updateServiceSetting
default UpdateServiceSettingResponse updateServiceSetting(UpdateServiceSettingRequest updateServiceSettingRequest) throws InternalServerErrorException, ServiceSettingNotFoundException, TooManyUpdatesException, AwsServiceException, SdkClientException, SsmException
ServiceSetting
is an account-level setting for an Amazon Web Services service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an Amazon Web Services service charges money to the account based on feature or service usage, then the Amazon Web Services 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. Amazon Web Services services teams define the default value for aSettingId
. You can't create a newSettingId
, but you can overwrite the default value if you have thessm:UpdateServiceSetting
permission for the setting. Use the GetServiceSetting API operation to view the current value. Or, use the ResetServiceSetting to change the value back to the original value defined by the Amazon Web Services service team.Update the service setting for the account.
- Parameters:
updateServiceSettingRequest
- The request body of the UpdateServiceSetting API operation.- Returns:
- Result of the UpdateServiceSetting operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.ServiceSettingNotFoundException
- The specified service setting wasn't found. Either the service name or the setting hasn't been provisioned by the Amazon Web Services 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
- See Also:
- AWS API Documentation
-
updateServiceSetting
default UpdateServiceSettingResponse updateServiceSetting(Consumer<UpdateServiceSettingRequest.Builder> updateServiceSettingRequest) throws InternalServerErrorException, ServiceSettingNotFoundException, TooManyUpdatesException, AwsServiceException, SdkClientException, SsmException
ServiceSetting
is an account-level setting for an Amazon Web Services service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an Amazon Web Services service charges money to the account based on feature or service usage, then the Amazon Web Services 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. Amazon Web Services services teams define the default value for aSettingId
. You can't create a newSettingId
, but you can overwrite the default value if you have thessm:UpdateServiceSetting
permission for the setting. Use the GetServiceSetting API operation to view the current value. Or, use the ResetServiceSetting to change the value back to the original value defined by the Amazon Web Services 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 viaUpdateServiceSettingRequest.builder()
- Parameters:
updateServiceSettingRequest
- AConsumer
that will call methods onUpdateServiceSettingRequest.Builder
to create a request. The request body of the UpdateServiceSetting API operation.- Returns:
- Result of the UpdateServiceSetting operation returned by the service.
- Throws:
InternalServerErrorException
- An error occurred on the server side.ServiceSettingNotFoundException
- The specified service setting wasn't found. Either the service name or the setting hasn't been provisioned by the Amazon Web Services 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
- See Also:
- AWS API Documentation
-
waiter
default SsmWaiter waiter()
Create an instance ofSsmWaiter
using this client.Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.
- Returns:
- an instance of
SsmWaiter
-
create
static SsmClient create()
Create aSsmClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.
-
builder
static SsmClientBuilder builder()
Create a builder that can be used to configure and create aSsmClient
.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default SsmServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
-
-