Interface SsmIncidentsAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient
supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in
some cases such as credentials retrieval and endpoint discovery as part of the async API call.
Systems Manager Incident Manager is an incident management console designed to help users mitigate and recover from incidents affecting their Amazon Web Services-hosted applications. An incident is any unplanned interruption or reduction in quality of services.
Incident Manager increases incident resolution by notifying responders of impact, highlighting relevant troubleshooting data, and providing collaboration tools to get services back up and running. To achieve the primary goal of reducing the time-to-resolution of critical incidents, Incident Manager automates response plans and enables responder team escalation.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionbatchGetIncidentFindings
(Consumer<BatchGetIncidentFindingsRequest.Builder> batchGetIncidentFindingsRequest) Retrieves details about all specified findings for an incident, including descriptive details about each finding.batchGetIncidentFindings
(BatchGetIncidentFindingsRequest batchGetIncidentFindingsRequest) Retrieves details about all specified findings for an incident, including descriptive details about each finding.builder()
Create a builder that can be used to configure and create aSsmIncidentsAsyncClient
.static SsmIncidentsAsyncClient
create()
Create aSsmIncidentsAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.createReplicationSet
(Consumer<CreateReplicationSetRequest.Builder> createReplicationSetRequest) A replication set replicates and encrypts your data to the provided Regions with the provided KMS key.createReplicationSet
(CreateReplicationSetRequest createReplicationSetRequest) A replication set replicates and encrypts your data to the provided Regions with the provided KMS key.createResponsePlan
(Consumer<CreateResponsePlanRequest.Builder> createResponsePlanRequest) Creates a response plan that automates the initial response to incidents.createResponsePlan
(CreateResponsePlanRequest createResponsePlanRequest) Creates a response plan that automates the initial response to incidents.createTimelineEvent
(Consumer<CreateTimelineEventRequest.Builder> createTimelineEventRequest) Creates a custom timeline event on the incident details page of an incident record.createTimelineEvent
(CreateTimelineEventRequest createTimelineEventRequest) Creates a custom timeline event on the incident details page of an incident record.deleteIncidentRecord
(Consumer<DeleteIncidentRecordRequest.Builder> deleteIncidentRecordRequest) Delete an incident record from Incident Manager.deleteIncidentRecord
(DeleteIncidentRecordRequest deleteIncidentRecordRequest) Delete an incident record from Incident Manager.deleteReplicationSet
(Consumer<DeleteReplicationSetRequest.Builder> deleteReplicationSetRequest) Deletes all Regions in your replication set.deleteReplicationSet
(DeleteReplicationSetRequest deleteReplicationSetRequest) Deletes all Regions in your replication set.deleteResourcePolicy
(Consumer<DeleteResourcePolicyRequest.Builder> deleteResourcePolicyRequest) Deletes the resource policy that Resource Access Manager uses to share your Incident Manager resource.deleteResourcePolicy
(DeleteResourcePolicyRequest deleteResourcePolicyRequest) Deletes the resource policy that Resource Access Manager uses to share your Incident Manager resource.deleteResponsePlan
(Consumer<DeleteResponsePlanRequest.Builder> deleteResponsePlanRequest) Deletes the specified response plan.deleteResponsePlan
(DeleteResponsePlanRequest deleteResponsePlanRequest) Deletes the specified response plan.deleteTimelineEvent
(Consumer<DeleteTimelineEventRequest.Builder> deleteTimelineEventRequest) Deletes a timeline event from an incident.deleteTimelineEvent
(DeleteTimelineEventRequest deleteTimelineEventRequest) Deletes a timeline event from an incident.getIncidentRecord
(Consumer<GetIncidentRecordRequest.Builder> getIncidentRecordRequest) Returns the details for the specified incident record.getIncidentRecord
(GetIncidentRecordRequest getIncidentRecordRequest) Returns the details for the specified incident record.getReplicationSet
(Consumer<GetReplicationSetRequest.Builder> getReplicationSetRequest) Retrieve your Incident Manager replication set.getReplicationSet
(GetReplicationSetRequest getReplicationSetRequest) Retrieve your Incident Manager replication set.getResourcePolicies
(Consumer<GetResourcePoliciesRequest.Builder> getResourcePoliciesRequest) Retrieves the resource policies attached to the specified response plan.getResourcePolicies
(GetResourcePoliciesRequest getResourcePoliciesRequest) Retrieves the resource policies attached to the specified response plan.default GetResourcePoliciesPublisher
getResourcePoliciesPaginator
(Consumer<GetResourcePoliciesRequest.Builder> getResourcePoliciesRequest) This is a variant ofgetResourcePolicies(software.amazon.awssdk.services.ssmincidents.model.GetResourcePoliciesRequest)
operation.default GetResourcePoliciesPublisher
getResourcePoliciesPaginator
(GetResourcePoliciesRequest getResourcePoliciesRequest) This is a variant ofgetResourcePolicies(software.amazon.awssdk.services.ssmincidents.model.GetResourcePoliciesRequest)
operation.default CompletableFuture
<GetResponsePlanResponse> getResponsePlan
(Consumer<GetResponsePlanRequest.Builder> getResponsePlanRequest) Retrieves the details of the specified response plan.default CompletableFuture
<GetResponsePlanResponse> getResponsePlan
(GetResponsePlanRequest getResponsePlanRequest) Retrieves the details of the specified response plan.getTimelineEvent
(Consumer<GetTimelineEventRequest.Builder> getTimelineEventRequest) Retrieves a timeline event based on its ID and incident record.getTimelineEvent
(GetTimelineEventRequest getTimelineEventRequest) Retrieves a timeline event based on its ID and incident record.listIncidentFindings
(Consumer<ListIncidentFindingsRequest.Builder> listIncidentFindingsRequest) Retrieves a list of the IDs of findings, plus their last modified times, that have been identified for a specified incident.listIncidentFindings
(ListIncidentFindingsRequest listIncidentFindingsRequest) Retrieves a list of the IDs of findings, plus their last modified times, that have been identified for a specified incident.default ListIncidentFindingsPublisher
listIncidentFindingsPaginator
(Consumer<ListIncidentFindingsRequest.Builder> listIncidentFindingsRequest) This is a variant oflistIncidentFindings(software.amazon.awssdk.services.ssmincidents.model.ListIncidentFindingsRequest)
operation.default ListIncidentFindingsPublisher
listIncidentFindingsPaginator
(ListIncidentFindingsRequest listIncidentFindingsRequest) This is a variant oflistIncidentFindings(software.amazon.awssdk.services.ssmincidents.model.ListIncidentFindingsRequest)
operation.listIncidentRecords
(Consumer<ListIncidentRecordsRequest.Builder> listIncidentRecordsRequest) Lists all incident records in your account.listIncidentRecords
(ListIncidentRecordsRequest listIncidentRecordsRequest) Lists all incident records in your account.default ListIncidentRecordsPublisher
listIncidentRecordsPaginator
(Consumer<ListIncidentRecordsRequest.Builder> listIncidentRecordsRequest) This is a variant oflistIncidentRecords(software.amazon.awssdk.services.ssmincidents.model.ListIncidentRecordsRequest)
operation.default ListIncidentRecordsPublisher
listIncidentRecordsPaginator
(ListIncidentRecordsRequest listIncidentRecordsRequest) This is a variant oflistIncidentRecords(software.amazon.awssdk.services.ssmincidents.model.ListIncidentRecordsRequest)
operation.listRelatedItems
(Consumer<ListRelatedItemsRequest.Builder> listRelatedItemsRequest) List all related items for an incident record.listRelatedItems
(ListRelatedItemsRequest listRelatedItemsRequest) List all related items for an incident record.default ListRelatedItemsPublisher
listRelatedItemsPaginator
(Consumer<ListRelatedItemsRequest.Builder> listRelatedItemsRequest) This is a variant oflistRelatedItems(software.amazon.awssdk.services.ssmincidents.model.ListRelatedItemsRequest)
operation.default ListRelatedItemsPublisher
listRelatedItemsPaginator
(ListRelatedItemsRequest listRelatedItemsRequest) This is a variant oflistRelatedItems(software.amazon.awssdk.services.ssmincidents.model.ListRelatedItemsRequest)
operation.listReplicationSets
(Consumer<ListReplicationSetsRequest.Builder> listReplicationSetsRequest) Lists details about the replication set configured in your account.listReplicationSets
(ListReplicationSetsRequest listReplicationSetsRequest) Lists details about the replication set configured in your account.default ListReplicationSetsPublisher
listReplicationSetsPaginator
(Consumer<ListReplicationSetsRequest.Builder> listReplicationSetsRequest) This is a variant oflistReplicationSets(software.amazon.awssdk.services.ssmincidents.model.ListReplicationSetsRequest)
operation.default ListReplicationSetsPublisher
listReplicationSetsPaginator
(ListReplicationSetsRequest listReplicationSetsRequest) This is a variant oflistReplicationSets(software.amazon.awssdk.services.ssmincidents.model.ListReplicationSetsRequest)
operation.listResponsePlans
(Consumer<ListResponsePlansRequest.Builder> listResponsePlansRequest) Lists all response plans in your account.listResponsePlans
(ListResponsePlansRequest listResponsePlansRequest) Lists all response plans in your account.default ListResponsePlansPublisher
listResponsePlansPaginator
(Consumer<ListResponsePlansRequest.Builder> listResponsePlansRequest) This is a variant oflistResponsePlans(software.amazon.awssdk.services.ssmincidents.model.ListResponsePlansRequest)
operation.default ListResponsePlansPublisher
listResponsePlansPaginator
(ListResponsePlansRequest listResponsePlansRequest) This is a variant oflistResponsePlans(software.amazon.awssdk.services.ssmincidents.model.ListResponsePlansRequest)
operation.listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the tags that are attached to the specified response plan or incident.listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags that are attached to the specified response plan or incident.listTimelineEvents
(Consumer<ListTimelineEventsRequest.Builder> listTimelineEventsRequest) Lists timeline events for the specified incident record.listTimelineEvents
(ListTimelineEventsRequest listTimelineEventsRequest) Lists timeline events for the specified incident record.default ListTimelineEventsPublisher
listTimelineEventsPaginator
(Consumer<ListTimelineEventsRequest.Builder> listTimelineEventsRequest) This is a variant oflistTimelineEvents(software.amazon.awssdk.services.ssmincidents.model.ListTimelineEventsRequest)
operation.default ListTimelineEventsPublisher
listTimelineEventsPaginator
(ListTimelineEventsRequest listTimelineEventsRequest) This is a variant oflistTimelineEvents(software.amazon.awssdk.services.ssmincidents.model.ListTimelineEventsRequest)
operation.putResourcePolicy
(Consumer<PutResourcePolicyRequest.Builder> putResourcePolicyRequest) Adds a resource policy to the specified response plan.putResourcePolicy
(PutResourcePolicyRequest putResourcePolicyRequest) Adds a resource policy to the specified response plan.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationdefault CompletableFuture
<StartIncidentResponse> startIncident
(Consumer<StartIncidentRequest.Builder> startIncidentRequest) Used to start an incident from CloudWatch alarms, EventBridge events, or manually.default CompletableFuture
<StartIncidentResponse> startIncident
(StartIncidentRequest startIncidentRequest) Used to start an incident from CloudWatch alarms, EventBridge events, or manually.default CompletableFuture
<TagResourceResponse> tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds a tag to a response plan.default CompletableFuture
<TagResourceResponse> tagResource
(TagResourceRequest tagResourceRequest) Adds a tag to a response plan.default CompletableFuture
<UntagResourceResponse> untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes a tag from a resource.default CompletableFuture
<UntagResourceResponse> untagResource
(UntagResourceRequest untagResourceRequest) Removes a tag from a resource.updateDeletionProtection
(Consumer<UpdateDeletionProtectionRequest.Builder> updateDeletionProtectionRequest) Update deletion protection to either allow or deny deletion of the final Region in a replication set.updateDeletionProtection
(UpdateDeletionProtectionRequest updateDeletionProtectionRequest) Update deletion protection to either allow or deny deletion of the final Region in a replication set.updateIncidentRecord
(Consumer<UpdateIncidentRecordRequest.Builder> updateIncidentRecordRequest) Update the details of an incident record.updateIncidentRecord
(UpdateIncidentRecordRequest updateIncidentRecordRequest) Update the details of an incident record.updateRelatedItems
(Consumer<UpdateRelatedItemsRequest.Builder> updateRelatedItemsRequest) Add or remove related items from the related items tab of an incident record.updateRelatedItems
(UpdateRelatedItemsRequest updateRelatedItemsRequest) Add or remove related items from the related items tab of an incident record.updateReplicationSet
(Consumer<UpdateReplicationSetRequest.Builder> updateReplicationSetRequest) Add or delete Regions from your replication set.updateReplicationSet
(UpdateReplicationSetRequest updateReplicationSetRequest) Add or delete Regions from your replication set.updateResponsePlan
(Consumer<UpdateResponsePlanRequest.Builder> updateResponsePlanRequest) Updates the specified response plan.updateResponsePlan
(UpdateResponsePlanRequest updateResponsePlanRequest) Updates the specified response plan.updateTimelineEvent
(Consumer<UpdateTimelineEventRequest.Builder> updateTimelineEventRequest) Updates a timeline event.updateTimelineEvent
(UpdateTimelineEventRequest updateTimelineEventRequest) Updates a timeline event.default SsmIncidentsAsyncWaiter
waiter()
Create an instance ofSsmIncidentsAsyncWaiter
using this client.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
batchGetIncidentFindings
default CompletableFuture<BatchGetIncidentFindingsResponse> batchGetIncidentFindings(BatchGetIncidentFindingsRequest batchGetIncidentFindingsRequest) Retrieves details about all specified findings for an incident, including descriptive details about each finding. A finding represents a recent application environment change made by an CodeDeploy deployment or an CloudFormation stack creation or update that can be investigated as a potential cause of the incident.
- Parameters:
batchGetIncidentFindingsRequest
-- Returns:
- A Java Future containing the result of the BatchGetIncidentFindings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which doesn't exist.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchGetIncidentFindings
default CompletableFuture<BatchGetIncidentFindingsResponse> batchGetIncidentFindings(Consumer<BatchGetIncidentFindingsRequest.Builder> batchGetIncidentFindingsRequest) Retrieves details about all specified findings for an incident, including descriptive details about each finding. A finding represents a recent application environment change made by an CodeDeploy deployment or an CloudFormation stack creation or update that can be investigated as a potential cause of the incident.
This is a convenience which creates an instance of the
BatchGetIncidentFindingsRequest.Builder
avoiding the need to create one manually viaBatchGetIncidentFindingsRequest.builder()
- Parameters:
batchGetIncidentFindingsRequest
- AConsumer
that will call methods onBatchGetIncidentFindingsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the BatchGetIncidentFindings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which doesn't exist.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createReplicationSet
default CompletableFuture<CreateReplicationSetResponse> createReplicationSet(CreateReplicationSetRequest createReplicationSetRequest) A replication set replicates and encrypts your data to the provided Regions with the provided KMS key.
- Parameters:
createReplicationSetRequest
-- Returns:
- A Java Future containing the result of the CreateReplicationSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException Request would cause a service quota to be exceeded.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ConflictException Updating or deleting a resource causes an inconsistent state.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createReplicationSet
default CompletableFuture<CreateReplicationSetResponse> createReplicationSet(Consumer<CreateReplicationSetRequest.Builder> createReplicationSetRequest) A replication set replicates and encrypts your data to the provided Regions with the provided KMS key.
This is a convenience which creates an instance of the
CreateReplicationSetRequest.Builder
avoiding the need to create one manually viaCreateReplicationSetRequest.builder()
- Parameters:
createReplicationSetRequest
- AConsumer
that will call methods onCreateReplicationSetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateReplicationSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException Request would cause a service quota to be exceeded.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ConflictException Updating or deleting a resource causes an inconsistent state.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createResponsePlan
default CompletableFuture<CreateResponsePlanResponse> createResponsePlan(CreateResponsePlanRequest createResponsePlanRequest) Creates a response plan that automates the initial response to incidents. A response plan engages contacts, starts chat channel collaboration, and initiates runbooks at the beginning of an incident.
- Parameters:
createResponsePlanRequest
-- Returns:
- A Java Future containing the result of the CreateResponsePlan operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which doesn't exist.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ConflictException Updating or deleting a resource causes an inconsistent state.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createResponsePlan
default CompletableFuture<CreateResponsePlanResponse> createResponsePlan(Consumer<CreateResponsePlanRequest.Builder> createResponsePlanRequest) Creates a response plan that automates the initial response to incidents. A response plan engages contacts, starts chat channel collaboration, and initiates runbooks at the beginning of an incident.
This is a convenience which creates an instance of the
CreateResponsePlanRequest.Builder
avoiding the need to create one manually viaCreateResponsePlanRequest.builder()
- Parameters:
createResponsePlanRequest
- AConsumer
that will call methods onCreateResponsePlanRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateResponsePlan operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which doesn't exist.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ConflictException Updating or deleting a resource causes an inconsistent state.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createTimelineEvent
default CompletableFuture<CreateTimelineEventResponse> createTimelineEvent(CreateTimelineEventRequest createTimelineEventRequest) Creates a custom timeline event on the incident details page of an incident record. Incident Manager automatically creates timeline events that mark key moments during an incident. You can create custom timeline events to mark important events that Incident Manager can detect automatically.
- Parameters:
createTimelineEventRequest
-- Returns:
- A Java Future containing the result of the CreateTimelineEvent operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which doesn't exist.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ConflictException Updating or deleting a resource causes an inconsistent state.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createTimelineEvent
default CompletableFuture<CreateTimelineEventResponse> createTimelineEvent(Consumer<CreateTimelineEventRequest.Builder> createTimelineEventRequest) Creates a custom timeline event on the incident details page of an incident record. Incident Manager automatically creates timeline events that mark key moments during an incident. You can create custom timeline events to mark important events that Incident Manager can detect automatically.
This is a convenience which creates an instance of the
CreateTimelineEventRequest.Builder
avoiding the need to create one manually viaCreateTimelineEventRequest.builder()
- Parameters:
createTimelineEventRequest
- AConsumer
that will call methods onCreateTimelineEventRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateTimelineEvent operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which doesn't exist.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ConflictException Updating or deleting a resource causes an inconsistent state.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteIncidentRecord
default CompletableFuture<DeleteIncidentRecordResponse> deleteIncidentRecord(DeleteIncidentRecordRequest deleteIncidentRecordRequest) Delete an incident record from Incident Manager.
- Parameters:
deleteIncidentRecordRequest
-- Returns:
- A Java Future containing the result of the DeleteIncidentRecord operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteIncidentRecord
default CompletableFuture<DeleteIncidentRecordResponse> deleteIncidentRecord(Consumer<DeleteIncidentRecordRequest.Builder> deleteIncidentRecordRequest) Delete an incident record from Incident Manager.
This is a convenience which creates an instance of the
DeleteIncidentRecordRequest.Builder
avoiding the need to create one manually viaDeleteIncidentRecordRequest.builder()
- Parameters:
deleteIncidentRecordRequest
- AConsumer
that will call methods onDeleteIncidentRecordRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteIncidentRecord operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteReplicationSet
default CompletableFuture<DeleteReplicationSetResponse> deleteReplicationSet(DeleteReplicationSetRequest deleteReplicationSetRequest) Deletes all Regions in your replication set. Deleting the replication set deletes all Incident Manager data.
- Parameters:
deleteReplicationSetRequest
-- Returns:
- A Java Future containing the result of the DeleteReplicationSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which doesn't exist.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteReplicationSet
default CompletableFuture<DeleteReplicationSetResponse> deleteReplicationSet(Consumer<DeleteReplicationSetRequest.Builder> deleteReplicationSetRequest) Deletes all Regions in your replication set. Deleting the replication set deletes all Incident Manager data.
This is a convenience which creates an instance of the
DeleteReplicationSetRequest.Builder
avoiding the need to create one manually viaDeleteReplicationSetRequest.builder()
- Parameters:
deleteReplicationSetRequest
- AConsumer
that will call methods onDeleteReplicationSetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteReplicationSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which doesn't exist.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteResourcePolicy
default CompletableFuture<DeleteResourcePolicyResponse> deleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest) Deletes the resource policy that Resource Access Manager uses to share your Incident Manager resource.
- Parameters:
deleteResourcePolicyRequest
-- Returns:
- A Java Future containing the result of the DeleteResourcePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which doesn't exist.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteResourcePolicy
default CompletableFuture<DeleteResourcePolicyResponse> deleteResourcePolicy(Consumer<DeleteResourcePolicyRequest.Builder> deleteResourcePolicyRequest) Deletes the resource policy that Resource Access Manager uses to share your Incident Manager resource.
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:
- A Java Future containing the result of the DeleteResourcePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which doesn't exist.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteResponsePlan
default CompletableFuture<DeleteResponsePlanResponse> deleteResponsePlan(DeleteResponsePlanRequest deleteResponsePlanRequest) Deletes the specified response plan. Deleting a response plan stops all linked CloudWatch alarms and EventBridge events from creating an incident with this response plan.
- Parameters:
deleteResponsePlanRequest
-- Returns:
- A Java Future containing the result of the DeleteResponsePlan operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteResponsePlan
default CompletableFuture<DeleteResponsePlanResponse> deleteResponsePlan(Consumer<DeleteResponsePlanRequest.Builder> deleteResponsePlanRequest) Deletes the specified response plan. Deleting a response plan stops all linked CloudWatch alarms and EventBridge events from creating an incident with this response plan.
This is a convenience which creates an instance of the
DeleteResponsePlanRequest.Builder
avoiding the need to create one manually viaDeleteResponsePlanRequest.builder()
- Parameters:
deleteResponsePlanRequest
- AConsumer
that will call methods onDeleteResponsePlanRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteResponsePlan operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteTimelineEvent
default CompletableFuture<DeleteTimelineEventResponse> deleteTimelineEvent(DeleteTimelineEventRequest deleteTimelineEventRequest) Deletes a timeline event from an incident.
- Parameters:
deleteTimelineEventRequest
-- Returns:
- A Java Future containing the result of the DeleteTimelineEvent operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteTimelineEvent
default CompletableFuture<DeleteTimelineEventResponse> deleteTimelineEvent(Consumer<DeleteTimelineEventRequest.Builder> deleteTimelineEventRequest) Deletes a timeline event from an incident.
This is a convenience which creates an instance of the
DeleteTimelineEventRequest.Builder
avoiding the need to create one manually viaDeleteTimelineEventRequest.builder()
- Parameters:
deleteTimelineEventRequest
- AConsumer
that will call methods onDeleteTimelineEventRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteTimelineEvent operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getIncidentRecord
default CompletableFuture<GetIncidentRecordResponse> getIncidentRecord(GetIncidentRecordRequest getIncidentRecordRequest) Returns the details for the specified incident record.
- Parameters:
getIncidentRecordRequest
-- Returns:
- A Java Future containing the result of the GetIncidentRecord operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which doesn't exist.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getIncidentRecord
default CompletableFuture<GetIncidentRecordResponse> getIncidentRecord(Consumer<GetIncidentRecordRequest.Builder> getIncidentRecordRequest) Returns the details for the specified incident record.
This is a convenience which creates an instance of the
GetIncidentRecordRequest.Builder
avoiding the need to create one manually viaGetIncidentRecordRequest.builder()
- Parameters:
getIncidentRecordRequest
- AConsumer
that will call methods onGetIncidentRecordRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetIncidentRecord operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which doesn't exist.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getReplicationSet
default CompletableFuture<GetReplicationSetResponse> getReplicationSet(GetReplicationSetRequest getReplicationSetRequest) Retrieve your Incident Manager replication set.
- Parameters:
getReplicationSetRequest
-- Returns:
- A Java Future containing the result of the GetReplicationSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which doesn't exist.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getReplicationSet
default CompletableFuture<GetReplicationSetResponse> getReplicationSet(Consumer<GetReplicationSetRequest.Builder> getReplicationSetRequest) Retrieve your Incident Manager replication set.
This is a convenience which creates an instance of the
GetReplicationSetRequest.Builder
avoiding the need to create one manually viaGetReplicationSetRequest.builder()
- Parameters:
getReplicationSetRequest
- AConsumer
that will call methods onGetReplicationSetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetReplicationSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which doesn't exist.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getResourcePolicies
default CompletableFuture<GetResourcePoliciesResponse> getResourcePolicies(GetResourcePoliciesRequest getResourcePoliciesRequest) Retrieves the resource policies attached to the specified response plan.
- Parameters:
getResourcePoliciesRequest
-- Returns:
- A Java Future containing the result of the GetResourcePolicies operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which doesn't exist.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getResourcePolicies
default CompletableFuture<GetResourcePoliciesResponse> getResourcePolicies(Consumer<GetResourcePoliciesRequest.Builder> getResourcePoliciesRequest) Retrieves the resource policies attached to the specified response plan.
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 Java Future containing the result of the GetResourcePolicies operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which doesn't exist.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getResourcePoliciesPaginator
default GetResourcePoliciesPublisher getResourcePoliciesPaginator(GetResourcePoliciesRequest getResourcePoliciesRequest) This is a variant of
getResourcePolicies(software.amazon.awssdk.services.ssmincidents.model.GetResourcePoliciesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ssmincidents.paginators.GetResourcePoliciesPublisher publisher = client.getResourcePoliciesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ssmincidents.paginators.GetResourcePoliciesPublisher publisher = client.getResourcePoliciesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssmincidents.model.GetResourcePoliciesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ssmincidents.model.GetResourcePoliciesResponse response) { //... }; });
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.ssmincidents.model.GetResourcePoliciesRequest)
operation.- Parameters:
getResourcePoliciesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which doesn't exist.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getResourcePoliciesPaginator
default GetResourcePoliciesPublisher getResourcePoliciesPaginator(Consumer<GetResourcePoliciesRequest.Builder> getResourcePoliciesRequest) This is a variant of
getResourcePolicies(software.amazon.awssdk.services.ssmincidents.model.GetResourcePoliciesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ssmincidents.paginators.GetResourcePoliciesPublisher publisher = client.getResourcePoliciesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ssmincidents.paginators.GetResourcePoliciesPublisher publisher = client.getResourcePoliciesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssmincidents.model.GetResourcePoliciesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ssmincidents.model.GetResourcePoliciesResponse response) { //... }; });
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.ssmincidents.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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which doesn't exist.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getResponsePlan
default CompletableFuture<GetResponsePlanResponse> getResponsePlan(GetResponsePlanRequest getResponsePlanRequest) Retrieves the details of the specified response plan.
- Parameters:
getResponsePlanRequest
-- Returns:
- A Java Future containing the result of the GetResponsePlan operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which doesn't exist.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getResponsePlan
default CompletableFuture<GetResponsePlanResponse> getResponsePlan(Consumer<GetResponsePlanRequest.Builder> getResponsePlanRequest) Retrieves the details of the specified response plan.
This is a convenience which creates an instance of the
GetResponsePlanRequest.Builder
avoiding the need to create one manually viaGetResponsePlanRequest.builder()
- Parameters:
getResponsePlanRequest
- AConsumer
that will call methods onGetResponsePlanRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetResponsePlan operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which doesn't exist.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getTimelineEvent
default CompletableFuture<GetTimelineEventResponse> getTimelineEvent(GetTimelineEventRequest getTimelineEventRequest) Retrieves a timeline event based on its ID and incident record.
- Parameters:
getTimelineEventRequest
-- Returns:
- A Java Future containing the result of the GetTimelineEvent operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which doesn't exist.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getTimelineEvent
default CompletableFuture<GetTimelineEventResponse> getTimelineEvent(Consumer<GetTimelineEventRequest.Builder> getTimelineEventRequest) Retrieves a timeline event based on its ID and incident record.
This is a convenience which creates an instance of the
GetTimelineEventRequest.Builder
avoiding the need to create one manually viaGetTimelineEventRequest.builder()
- Parameters:
getTimelineEventRequest
- AConsumer
that will call methods onGetTimelineEventRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetTimelineEvent operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which doesn't exist.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listIncidentFindings
default CompletableFuture<ListIncidentFindingsResponse> listIncidentFindings(ListIncidentFindingsRequest listIncidentFindingsRequest) Retrieves a list of the IDs of findings, plus their last modified times, that have been identified for a specified incident. A finding represents a recent application environment change made by an CloudFormation stack creation or update or an CodeDeploy deployment that can be investigated as a potential cause of the incident.
- Parameters:
listIncidentFindingsRequest
-- Returns:
- A Java Future containing the result of the ListIncidentFindings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which doesn't exist.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listIncidentFindings
default CompletableFuture<ListIncidentFindingsResponse> listIncidentFindings(Consumer<ListIncidentFindingsRequest.Builder> listIncidentFindingsRequest) Retrieves a list of the IDs of findings, plus their last modified times, that have been identified for a specified incident. A finding represents a recent application environment change made by an CloudFormation stack creation or update or an CodeDeploy deployment that can be investigated as a potential cause of the incident.
This is a convenience which creates an instance of the
ListIncidentFindingsRequest.Builder
avoiding the need to create one manually viaListIncidentFindingsRequest.builder()
- Parameters:
listIncidentFindingsRequest
- AConsumer
that will call methods onListIncidentFindingsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListIncidentFindings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which doesn't exist.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listIncidentFindingsPaginator
default ListIncidentFindingsPublisher listIncidentFindingsPaginator(ListIncidentFindingsRequest listIncidentFindingsRequest) This is a variant of
listIncidentFindings(software.amazon.awssdk.services.ssmincidents.model.ListIncidentFindingsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ssmincidents.paginators.ListIncidentFindingsPublisher publisher = client.listIncidentFindingsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ssmincidents.paginators.ListIncidentFindingsPublisher publisher = client.listIncidentFindingsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssmincidents.model.ListIncidentFindingsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ssmincidents.model.ListIncidentFindingsResponse response) { //... }; });
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
listIncidentFindings(software.amazon.awssdk.services.ssmincidents.model.ListIncidentFindingsRequest)
operation.- Parameters:
listIncidentFindingsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which doesn't exist.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listIncidentFindingsPaginator
default ListIncidentFindingsPublisher listIncidentFindingsPaginator(Consumer<ListIncidentFindingsRequest.Builder> listIncidentFindingsRequest) This is a variant of
listIncidentFindings(software.amazon.awssdk.services.ssmincidents.model.ListIncidentFindingsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ssmincidents.paginators.ListIncidentFindingsPublisher publisher = client.listIncidentFindingsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ssmincidents.paginators.ListIncidentFindingsPublisher publisher = client.listIncidentFindingsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssmincidents.model.ListIncidentFindingsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ssmincidents.model.ListIncidentFindingsResponse response) { //... }; });
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
listIncidentFindings(software.amazon.awssdk.services.ssmincidents.model.ListIncidentFindingsRequest)
operation.
This is a convenience which creates an instance of the
ListIncidentFindingsRequest.Builder
avoiding the need to create one manually viaListIncidentFindingsRequest.builder()
- Parameters:
listIncidentFindingsRequest
- AConsumer
that will call methods onListIncidentFindingsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which doesn't exist.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listIncidentRecords
default CompletableFuture<ListIncidentRecordsResponse> listIncidentRecords(ListIncidentRecordsRequest listIncidentRecordsRequest) Lists all incident records in your account. Use this command to retrieve the Amazon Resource Name (ARN) of the incident record you want to update.
- Parameters:
listIncidentRecordsRequest
-- Returns:
- A Java Future containing the result of the ListIncidentRecords operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listIncidentRecords
default CompletableFuture<ListIncidentRecordsResponse> listIncidentRecords(Consumer<ListIncidentRecordsRequest.Builder> listIncidentRecordsRequest) Lists all incident records in your account. Use this command to retrieve the Amazon Resource Name (ARN) of the incident record you want to update.
This is a convenience which creates an instance of the
ListIncidentRecordsRequest.Builder
avoiding the need to create one manually viaListIncidentRecordsRequest.builder()
- Parameters:
listIncidentRecordsRequest
- AConsumer
that will call methods onListIncidentRecordsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListIncidentRecords operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listIncidentRecordsPaginator
default ListIncidentRecordsPublisher listIncidentRecordsPaginator(ListIncidentRecordsRequest listIncidentRecordsRequest) This is a variant of
listIncidentRecords(software.amazon.awssdk.services.ssmincidents.model.ListIncidentRecordsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ssmincidents.paginators.ListIncidentRecordsPublisher publisher = client.listIncidentRecordsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ssmincidents.paginators.ListIncidentRecordsPublisher publisher = client.listIncidentRecordsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssmincidents.model.ListIncidentRecordsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ssmincidents.model.ListIncidentRecordsResponse response) { //... }; });
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
listIncidentRecords(software.amazon.awssdk.services.ssmincidents.model.ListIncidentRecordsRequest)
operation.- Parameters:
listIncidentRecordsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listIncidentRecordsPaginator
default ListIncidentRecordsPublisher listIncidentRecordsPaginator(Consumer<ListIncidentRecordsRequest.Builder> listIncidentRecordsRequest) This is a variant of
listIncidentRecords(software.amazon.awssdk.services.ssmincidents.model.ListIncidentRecordsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ssmincidents.paginators.ListIncidentRecordsPublisher publisher = client.listIncidentRecordsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ssmincidents.paginators.ListIncidentRecordsPublisher publisher = client.listIncidentRecordsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssmincidents.model.ListIncidentRecordsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ssmincidents.model.ListIncidentRecordsResponse response) { //... }; });
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
listIncidentRecords(software.amazon.awssdk.services.ssmincidents.model.ListIncidentRecordsRequest)
operation.
This is a convenience which creates an instance of the
ListIncidentRecordsRequest.Builder
avoiding the need to create one manually viaListIncidentRecordsRequest.builder()
- Parameters:
listIncidentRecordsRequest
- AConsumer
that will call methods onListIncidentRecordsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRelatedItems
default CompletableFuture<ListRelatedItemsResponse> listRelatedItems(ListRelatedItemsRequest listRelatedItemsRequest) List all related items for an incident record.
- Parameters:
listRelatedItemsRequest
-- Returns:
- A Java Future containing the result of the ListRelatedItems operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRelatedItems
default CompletableFuture<ListRelatedItemsResponse> listRelatedItems(Consumer<ListRelatedItemsRequest.Builder> listRelatedItemsRequest) List all related items for an incident record.
This is a convenience which creates an instance of the
ListRelatedItemsRequest.Builder
avoiding the need to create one manually viaListRelatedItemsRequest.builder()
- Parameters:
listRelatedItemsRequest
- AConsumer
that will call methods onListRelatedItemsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListRelatedItems operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRelatedItemsPaginator
default ListRelatedItemsPublisher listRelatedItemsPaginator(ListRelatedItemsRequest listRelatedItemsRequest) This is a variant of
listRelatedItems(software.amazon.awssdk.services.ssmincidents.model.ListRelatedItemsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ssmincidents.paginators.ListRelatedItemsPublisher publisher = client.listRelatedItemsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ssmincidents.paginators.ListRelatedItemsPublisher publisher = client.listRelatedItemsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssmincidents.model.ListRelatedItemsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ssmincidents.model.ListRelatedItemsResponse response) { //... }; });
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
listRelatedItems(software.amazon.awssdk.services.ssmincidents.model.ListRelatedItemsRequest)
operation.- Parameters:
listRelatedItemsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRelatedItemsPaginator
default ListRelatedItemsPublisher listRelatedItemsPaginator(Consumer<ListRelatedItemsRequest.Builder> listRelatedItemsRequest) This is a variant of
listRelatedItems(software.amazon.awssdk.services.ssmincidents.model.ListRelatedItemsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ssmincidents.paginators.ListRelatedItemsPublisher publisher = client.listRelatedItemsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ssmincidents.paginators.ListRelatedItemsPublisher publisher = client.listRelatedItemsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssmincidents.model.ListRelatedItemsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ssmincidents.model.ListRelatedItemsResponse response) { //... }; });
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
listRelatedItems(software.amazon.awssdk.services.ssmincidents.model.ListRelatedItemsRequest)
operation.
This is a convenience which creates an instance of the
ListRelatedItemsRequest.Builder
avoiding the need to create one manually viaListRelatedItemsRequest.builder()
- Parameters:
listRelatedItemsRequest
- AConsumer
that will call methods onListRelatedItemsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listReplicationSets
default CompletableFuture<ListReplicationSetsResponse> listReplicationSets(ListReplicationSetsRequest listReplicationSetsRequest) Lists details about the replication set configured in your account.
- Parameters:
listReplicationSetsRequest
-- Returns:
- A Java Future containing the result of the ListReplicationSets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listReplicationSets
default CompletableFuture<ListReplicationSetsResponse> listReplicationSets(Consumer<ListReplicationSetsRequest.Builder> listReplicationSetsRequest) Lists details about the replication set configured in your account.
This is a convenience which creates an instance of the
ListReplicationSetsRequest.Builder
avoiding the need to create one manually viaListReplicationSetsRequest.builder()
- Parameters:
listReplicationSetsRequest
- AConsumer
that will call methods onListReplicationSetsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListReplicationSets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listReplicationSetsPaginator
default ListReplicationSetsPublisher listReplicationSetsPaginator(ListReplicationSetsRequest listReplicationSetsRequest) This is a variant of
listReplicationSets(software.amazon.awssdk.services.ssmincidents.model.ListReplicationSetsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ssmincidents.paginators.ListReplicationSetsPublisher publisher = client.listReplicationSetsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ssmincidents.paginators.ListReplicationSetsPublisher publisher = client.listReplicationSetsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssmincidents.model.ListReplicationSetsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ssmincidents.model.ListReplicationSetsResponse response) { //... }; });
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
listReplicationSets(software.amazon.awssdk.services.ssmincidents.model.ListReplicationSetsRequest)
operation.- Parameters:
listReplicationSetsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listReplicationSetsPaginator
default ListReplicationSetsPublisher listReplicationSetsPaginator(Consumer<ListReplicationSetsRequest.Builder> listReplicationSetsRequest) This is a variant of
listReplicationSets(software.amazon.awssdk.services.ssmincidents.model.ListReplicationSetsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ssmincidents.paginators.ListReplicationSetsPublisher publisher = client.listReplicationSetsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ssmincidents.paginators.ListReplicationSetsPublisher publisher = client.listReplicationSetsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssmincidents.model.ListReplicationSetsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ssmincidents.model.ListReplicationSetsResponse response) { //... }; });
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
listReplicationSets(software.amazon.awssdk.services.ssmincidents.model.ListReplicationSetsRequest)
operation.
This is a convenience which creates an instance of the
ListReplicationSetsRequest.Builder
avoiding the need to create one manually viaListReplicationSetsRequest.builder()
- Parameters:
listReplicationSetsRequest
- AConsumer
that will call methods onListReplicationSetsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listResponsePlans
default CompletableFuture<ListResponsePlansResponse> listResponsePlans(ListResponsePlansRequest listResponsePlansRequest) Lists all response plans in your account.
- Parameters:
listResponsePlansRequest
-- Returns:
- A Java Future containing the result of the ListResponsePlans operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listResponsePlans
default CompletableFuture<ListResponsePlansResponse> listResponsePlans(Consumer<ListResponsePlansRequest.Builder> listResponsePlansRequest) Lists all response plans in your account.
This is a convenience which creates an instance of the
ListResponsePlansRequest.Builder
avoiding the need to create one manually viaListResponsePlansRequest.builder()
- Parameters:
listResponsePlansRequest
- AConsumer
that will call methods onListResponsePlansRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListResponsePlans operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listResponsePlansPaginator
default ListResponsePlansPublisher listResponsePlansPaginator(ListResponsePlansRequest listResponsePlansRequest) This is a variant of
listResponsePlans(software.amazon.awssdk.services.ssmincidents.model.ListResponsePlansRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ssmincidents.paginators.ListResponsePlansPublisher publisher = client.listResponsePlansPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ssmincidents.paginators.ListResponsePlansPublisher publisher = client.listResponsePlansPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssmincidents.model.ListResponsePlansResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ssmincidents.model.ListResponsePlansResponse response) { //... }; });
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
listResponsePlans(software.amazon.awssdk.services.ssmincidents.model.ListResponsePlansRequest)
operation.- Parameters:
listResponsePlansRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listResponsePlansPaginator
default ListResponsePlansPublisher listResponsePlansPaginator(Consumer<ListResponsePlansRequest.Builder> listResponsePlansRequest) This is a variant of
listResponsePlans(software.amazon.awssdk.services.ssmincidents.model.ListResponsePlansRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ssmincidents.paginators.ListResponsePlansPublisher publisher = client.listResponsePlansPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ssmincidents.paginators.ListResponsePlansPublisher publisher = client.listResponsePlansPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssmincidents.model.ListResponsePlansResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ssmincidents.model.ListResponsePlansResponse response) { //... }; });
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
listResponsePlans(software.amazon.awssdk.services.ssmincidents.model.ListResponsePlansRequest)
operation.
This is a convenience which creates an instance of the
ListResponsePlansRequest.Builder
avoiding the need to create one manually viaListResponsePlansRequest.builder()
- Parameters:
listResponsePlansRequest
- AConsumer
that will call methods onListResponsePlansRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags that are attached to the specified response plan or incident.
- Parameters:
listTagsForResourceRequest
-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which doesn't exist.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the tags that are attached to the specified response plan or incident.
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:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which doesn't exist.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTimelineEvents
default CompletableFuture<ListTimelineEventsResponse> listTimelineEvents(ListTimelineEventsRequest listTimelineEventsRequest) Lists timeline events for the specified incident record.
- Parameters:
listTimelineEventsRequest
-- Returns:
- A Java Future containing the result of the ListTimelineEvents operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTimelineEvents
default CompletableFuture<ListTimelineEventsResponse> listTimelineEvents(Consumer<ListTimelineEventsRequest.Builder> listTimelineEventsRequest) Lists timeline events for the specified incident record.
This is a convenience which creates an instance of the
ListTimelineEventsRequest.Builder
avoiding the need to create one manually viaListTimelineEventsRequest.builder()
- Parameters:
listTimelineEventsRequest
- AConsumer
that will call methods onListTimelineEventsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTimelineEvents operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTimelineEventsPaginator
default ListTimelineEventsPublisher listTimelineEventsPaginator(ListTimelineEventsRequest listTimelineEventsRequest) This is a variant of
listTimelineEvents(software.amazon.awssdk.services.ssmincidents.model.ListTimelineEventsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ssmincidents.paginators.ListTimelineEventsPublisher publisher = client.listTimelineEventsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ssmincidents.paginators.ListTimelineEventsPublisher publisher = client.listTimelineEventsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssmincidents.model.ListTimelineEventsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ssmincidents.model.ListTimelineEventsResponse response) { //... }; });
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
listTimelineEvents(software.amazon.awssdk.services.ssmincidents.model.ListTimelineEventsRequest)
operation.- Parameters:
listTimelineEventsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTimelineEventsPaginator
default ListTimelineEventsPublisher listTimelineEventsPaginator(Consumer<ListTimelineEventsRequest.Builder> listTimelineEventsRequest) This is a variant of
listTimelineEvents(software.amazon.awssdk.services.ssmincidents.model.ListTimelineEventsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ssmincidents.paginators.ListTimelineEventsPublisher publisher = client.listTimelineEventsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ssmincidents.paginators.ListTimelineEventsPublisher publisher = client.listTimelineEventsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssmincidents.model.ListTimelineEventsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ssmincidents.model.ListTimelineEventsResponse response) { //... }; });
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
listTimelineEvents(software.amazon.awssdk.services.ssmincidents.model.ListTimelineEventsRequest)
operation.
This is a convenience which creates an instance of the
ListTimelineEventsRequest.Builder
avoiding the need to create one manually viaListTimelineEventsRequest.builder()
- Parameters:
listTimelineEventsRequest
- AConsumer
that will call methods onListTimelineEventsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putResourcePolicy
default CompletableFuture<PutResourcePolicyResponse> putResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest) Adds a resource policy to the specified response plan. The resource policy is used to share the response plan using Resource Access Manager (RAM). For more information about cross-account sharing, see Cross-Region and cross-account incident management.
- Parameters:
putResourcePolicyRequest
-- Returns:
- A Java Future containing the result of the PutResourcePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which doesn't exist.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putResourcePolicy
default CompletableFuture<PutResourcePolicyResponse> putResourcePolicy(Consumer<PutResourcePolicyRequest.Builder> putResourcePolicyRequest) Adds a resource policy to the specified response plan. The resource policy is used to share the response plan using Resource Access Manager (RAM). For more information about cross-account sharing, see Cross-Region and cross-account incident management.
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:
- A Java Future containing the result of the PutResourcePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which doesn't exist.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startIncident
default CompletableFuture<StartIncidentResponse> startIncident(StartIncidentRequest startIncidentRequest) Used to start an incident from CloudWatch alarms, EventBridge events, or manually.
- Parameters:
startIncidentRequest
-- Returns:
- A Java Future containing the result of the StartIncident operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which doesn't exist.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ConflictException Updating or deleting a resource causes an inconsistent state.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startIncident
default CompletableFuture<StartIncidentResponse> startIncident(Consumer<StartIncidentRequest.Builder> startIncidentRequest) Used to start an incident from CloudWatch alarms, EventBridge events, or manually.
This is a convenience which creates an instance of the
StartIncidentRequest.Builder
avoiding the need to create one manually viaStartIncidentRequest.builder()
- Parameters:
startIncidentRequest
- AConsumer
that will call methods onStartIncidentRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartIncident operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which doesn't exist.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ConflictException Updating or deleting a resource causes an inconsistent state.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
Adds a tag to a response plan.
- Parameters:
tagResourceRequest
-- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException Request would cause a service quota to be exceeded.
- ThrottlingException The request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which doesn't exist.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ConflictException Updating or deleting a resource causes an inconsistent state.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds a tag to a response plan.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException Request would cause a service quota to be exceeded.
- ThrottlingException The request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which doesn't exist.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ConflictException Updating or deleting a resource causes an inconsistent state.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Removes a tag from a resource.
- Parameters:
untagResourceRequest
-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which doesn't exist.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ConflictException Updating or deleting a resource causes an inconsistent state.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes a tag from a resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which doesn't exist.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ConflictException Updating or deleting a resource causes an inconsistent state.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateDeletionProtection
default CompletableFuture<UpdateDeletionProtectionResponse> updateDeletionProtection(UpdateDeletionProtectionRequest updateDeletionProtectionRequest) Update deletion protection to either allow or deny deletion of the final Region in a replication set.
- Parameters:
updateDeletionProtectionRequest
-- Returns:
- A Java Future containing the result of the UpdateDeletionProtection operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which doesn't exist.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateDeletionProtection
default CompletableFuture<UpdateDeletionProtectionResponse> updateDeletionProtection(Consumer<UpdateDeletionProtectionRequest.Builder> updateDeletionProtectionRequest) Update deletion protection to either allow or deny deletion of the final Region in a replication set.
This is a convenience which creates an instance of the
UpdateDeletionProtectionRequest.Builder
avoiding the need to create one manually viaUpdateDeletionProtectionRequest.builder()
- Parameters:
updateDeletionProtectionRequest
- AConsumer
that will call methods onUpdateDeletionProtectionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateDeletionProtection operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which doesn't exist.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateIncidentRecord
default CompletableFuture<UpdateIncidentRecordResponse> updateIncidentRecord(UpdateIncidentRecordRequest updateIncidentRecordRequest) Update the details of an incident record. You can use this operation to update an incident record from the defined chat channel. For more information about using actions in chat channels, see Interacting through chat.
- Parameters:
updateIncidentRecordRequest
-- Returns:
- A Java Future containing the result of the UpdateIncidentRecord operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which doesn't exist.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ConflictException Updating or deleting a resource causes an inconsistent state.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateIncidentRecord
default CompletableFuture<UpdateIncidentRecordResponse> updateIncidentRecord(Consumer<UpdateIncidentRecordRequest.Builder> updateIncidentRecordRequest) Update the details of an incident record. You can use this operation to update an incident record from the defined chat channel. For more information about using actions in chat channels, see Interacting through chat.
This is a convenience which creates an instance of the
UpdateIncidentRecordRequest.Builder
avoiding the need to create one manually viaUpdateIncidentRecordRequest.builder()
- Parameters:
updateIncidentRecordRequest
- AConsumer
that will call methods onUpdateIncidentRecordRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateIncidentRecord operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which doesn't exist.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ConflictException Updating or deleting a resource causes an inconsistent state.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateRelatedItems
default CompletableFuture<UpdateRelatedItemsResponse> updateRelatedItems(UpdateRelatedItemsRequest updateRelatedItemsRequest) Add or remove related items from the related items tab of an incident record.
- Parameters:
updateRelatedItemsRequest
-- Returns:
- A Java Future containing the result of the UpdateRelatedItems operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which doesn't exist.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ConflictException Updating or deleting a resource causes an inconsistent state.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateRelatedItems
default CompletableFuture<UpdateRelatedItemsResponse> updateRelatedItems(Consumer<UpdateRelatedItemsRequest.Builder> updateRelatedItemsRequest) Add or remove related items from the related items tab of an incident record.
This is a convenience which creates an instance of the
UpdateRelatedItemsRequest.Builder
avoiding the need to create one manually viaUpdateRelatedItemsRequest.builder()
- Parameters:
updateRelatedItemsRequest
- AConsumer
that will call methods onUpdateRelatedItemsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateRelatedItems operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which doesn't exist.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ConflictException Updating or deleting a resource causes an inconsistent state.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateReplicationSet
default CompletableFuture<UpdateReplicationSetResponse> updateReplicationSet(UpdateReplicationSetRequest updateReplicationSetRequest) Add or delete Regions from your replication set.
- Parameters:
updateReplicationSetRequest
-- Returns:
- A Java Future containing the result of the UpdateReplicationSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which doesn't exist.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ConflictException Updating or deleting a resource causes an inconsistent state.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateReplicationSet
default CompletableFuture<UpdateReplicationSetResponse> updateReplicationSet(Consumer<UpdateReplicationSetRequest.Builder> updateReplicationSetRequest) Add or delete Regions from your replication set.
This is a convenience which creates an instance of the
UpdateReplicationSetRequest.Builder
avoiding the need to create one manually viaUpdateReplicationSetRequest.builder()
- Parameters:
updateReplicationSetRequest
- AConsumer
that will call methods onUpdateReplicationSetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateReplicationSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which doesn't exist.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ConflictException Updating or deleting a resource causes an inconsistent state.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateResponsePlan
default CompletableFuture<UpdateResponsePlanResponse> updateResponsePlan(UpdateResponsePlanRequest updateResponsePlanRequest) Updates the specified response plan.
- Parameters:
updateResponsePlanRequest
-- Returns:
- A Java Future containing the result of the UpdateResponsePlan operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which doesn't exist.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ConflictException Updating or deleting a resource causes an inconsistent state.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateResponsePlan
default CompletableFuture<UpdateResponsePlanResponse> updateResponsePlan(Consumer<UpdateResponsePlanRequest.Builder> updateResponsePlanRequest) Updates the specified response plan.
This is a convenience which creates an instance of the
UpdateResponsePlanRequest.Builder
avoiding the need to create one manually viaUpdateResponsePlanRequest.builder()
- Parameters:
updateResponsePlanRequest
- AConsumer
that will call methods onUpdateResponsePlanRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateResponsePlan operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which doesn't exist.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ConflictException Updating or deleting a resource causes an inconsistent state.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateTimelineEvent
default CompletableFuture<UpdateTimelineEventResponse> updateTimelineEvent(UpdateTimelineEventRequest updateTimelineEventRequest) Updates a timeline event. You can update events of type
Custom Event
.- Parameters:
updateTimelineEventRequest
-- Returns:
- A Java Future containing the result of the UpdateTimelineEvent operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which doesn't exist.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ConflictException Updating or deleting a resource causes an inconsistent state.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateTimelineEvent
default CompletableFuture<UpdateTimelineEventResponse> updateTimelineEvent(Consumer<UpdateTimelineEventRequest.Builder> updateTimelineEventRequest) Updates a timeline event. You can update events of type
Custom Event
.
This is a convenience which creates an instance of the
UpdateTimelineEventRequest.Builder
avoiding the need to create one manually viaUpdateTimelineEventRequest.builder()
- Parameters:
updateTimelineEventRequest
- AConsumer
that will call methods onUpdateTimelineEventRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateTimelineEvent operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which doesn't exist.
- AccessDeniedException You don't have sufficient access to perform this operation.
- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ConflictException Updating or deleting a resource causes an inconsistent state.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SsmIncidentsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
waiter
Create an instance ofSsmIncidentsAsyncWaiter
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
SsmIncidentsAsyncWaiter
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aSsmIncidentsAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aSsmIncidentsAsyncClient
.
-