/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.ssmincidents; import javax.annotation.Generated; import com.amazonaws.services.ssmincidents.model.*; /** * Interface for accessing SSM Incidents asynchronously. Each asynchronous method will return a Java Future object * representing the asynchronous operation; overloads which accept an {@code AsyncHandler} can be used to receive * notification when an asynchronous operation completes. *
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from * {@link com.amazonaws.services.ssmincidents.AbstractAWSSSMIncidentsAsync} instead. *
**
* 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. *
*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") public interface AWSSSMIncidentsAsync extends AWSSSMIncidents { /** ** A replication set replicates and encrypts your data to the provided Regions with the provided KMS key. *
* * @param createReplicationSetRequest * @return A Java Future containing the result of the CreateReplicationSet operation returned by the service. * @sample AWSSSMIncidentsAsync.CreateReplicationSet * @see AWS API Documentation */ java.util.concurrent.Future* A replication set replicates and encrypts your data to the provided Regions with the provided KMS key. *
* * @param createReplicationSetRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CreateReplicationSet operation returned by the service. * @sample AWSSSMIncidentsAsyncHandler.CreateReplicationSet * @see AWS API Documentation */ java.util.concurrent.Future* 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. *
* * @param createResponsePlanRequest * @return A Java Future containing the result of the CreateResponsePlan operation returned by the service. * @sample AWSSSMIncidentsAsync.CreateResponsePlan * @see AWS API Documentation */ java.util.concurrent.Future* 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. *
* * @param createResponsePlanRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CreateResponsePlan operation returned by the service. * @sample AWSSSMIncidentsAsyncHandler.CreateResponsePlan * @see AWS API Documentation */ java.util.concurrent.Future* 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. *
* * @param createTimelineEventRequest * @return A Java Future containing the result of the CreateTimelineEvent operation returned by the service. * @sample AWSSSMIncidentsAsync.CreateTimelineEvent * @see AWS API Documentation */ java.util.concurrent.Future* 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. *
* * @param createTimelineEventRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CreateTimelineEvent operation returned by the service. * @sample AWSSSMIncidentsAsyncHandler.CreateTimelineEvent * @see AWS API Documentation */ java.util.concurrent.Future* Delete an incident record from Incident Manager. *
* * @param deleteIncidentRecordRequest * @return A Java Future containing the result of the DeleteIncidentRecord operation returned by the service. * @sample AWSSSMIncidentsAsync.DeleteIncidentRecord * @see AWS API Documentation */ java.util.concurrent.Future* Delete an incident record from Incident Manager. *
* * @param deleteIncidentRecordRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DeleteIncidentRecord operation returned by the service. * @sample AWSSSMIncidentsAsyncHandler.DeleteIncidentRecord * @see AWS API Documentation */ java.util.concurrent.Future* Deletes all Regions in your replication set. Deleting the replication set deletes all Incident Manager data. *
* * @param deleteReplicationSetRequest * @return A Java Future containing the result of the DeleteReplicationSet operation returned by the service. * @sample AWSSSMIncidentsAsync.DeleteReplicationSet * @see AWS API Documentation */ java.util.concurrent.Future* Deletes all Regions in your replication set. Deleting the replication set deletes all Incident Manager data. *
* * @param deleteReplicationSetRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DeleteReplicationSet operation returned by the service. * @sample AWSSSMIncidentsAsyncHandler.DeleteReplicationSet * @see AWS API Documentation */ java.util.concurrent.Future* Deletes the resource policy that Resource Access Manager uses to share your Incident Manager resource. *
* * @param deleteResourcePolicyRequest * @return A Java Future containing the result of the DeleteResourcePolicy operation returned by the service. * @sample AWSSSMIncidentsAsync.DeleteResourcePolicy * @see AWS API Documentation */ java.util.concurrent.Future* Deletes the resource policy that Resource Access Manager uses to share your Incident Manager resource. *
* * @param deleteResourcePolicyRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DeleteResourcePolicy operation returned by the service. * @sample AWSSSMIncidentsAsyncHandler.DeleteResourcePolicy * @see AWS API Documentation */ java.util.concurrent.Future* 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. *
* * @param deleteResponsePlanRequest * @return A Java Future containing the result of the DeleteResponsePlan operation returned by the service. * @sample AWSSSMIncidentsAsync.DeleteResponsePlan * @see AWS API Documentation */ java.util.concurrent.Future* 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. *
* * @param deleteResponsePlanRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DeleteResponsePlan operation returned by the service. * @sample AWSSSMIncidentsAsyncHandler.DeleteResponsePlan * @see AWS API Documentation */ java.util.concurrent.Future* Deletes a timeline event from an incident. *
* * @param deleteTimelineEventRequest * @return A Java Future containing the result of the DeleteTimelineEvent operation returned by the service. * @sample AWSSSMIncidentsAsync.DeleteTimelineEvent * @see AWS API Documentation */ java.util.concurrent.Future* Deletes a timeline event from an incident. *
* * @param deleteTimelineEventRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DeleteTimelineEvent operation returned by the service. * @sample AWSSSMIncidentsAsyncHandler.DeleteTimelineEvent * @see AWS API Documentation */ java.util.concurrent.Future* Returns the details for the specified incident record. *
* * @param getIncidentRecordRequest * @return A Java Future containing the result of the GetIncidentRecord operation returned by the service. * @sample AWSSSMIncidentsAsync.GetIncidentRecord * @see AWS API Documentation */ java.util.concurrent.Future* Returns the details for the specified incident record. *
* * @param getIncidentRecordRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the GetIncidentRecord operation returned by the service. * @sample AWSSSMIncidentsAsyncHandler.GetIncidentRecord * @see AWS API Documentation */ java.util.concurrent.Future* Retrieve your Incident Manager replication set. *
* * @param getReplicationSetRequest * @return A Java Future containing the result of the GetReplicationSet operation returned by the service. * @sample AWSSSMIncidentsAsync.GetReplicationSet * @see AWS API Documentation */ java.util.concurrent.Future* Retrieve your Incident Manager replication set. *
* * @param getReplicationSetRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the GetReplicationSet operation returned by the service. * @sample AWSSSMIncidentsAsyncHandler.GetReplicationSet * @see AWS API Documentation */ java.util.concurrent.Future* Retrieves the resource policies attached to the specified response plan. *
* * @param getResourcePoliciesRequest * @return A Java Future containing the result of the GetResourcePolicies operation returned by the service. * @sample AWSSSMIncidentsAsync.GetResourcePolicies * @see AWS API Documentation */ java.util.concurrent.Future* Retrieves the resource policies attached to the specified response plan. *
* * @param getResourcePoliciesRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the GetResourcePolicies operation returned by the service. * @sample AWSSSMIncidentsAsyncHandler.GetResourcePolicies * @see AWS API Documentation */ java.util.concurrent.Future* Retrieves the details of the specified response plan. *
* * @param getResponsePlanRequest * @return A Java Future containing the result of the GetResponsePlan operation returned by the service. * @sample AWSSSMIncidentsAsync.GetResponsePlan * @see AWS * API Documentation */ java.util.concurrent.Future* Retrieves the details of the specified response plan. *
* * @param getResponsePlanRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the GetResponsePlan operation returned by the service. * @sample AWSSSMIncidentsAsyncHandler.GetResponsePlan * @see AWS * API Documentation */ java.util.concurrent.Future* Retrieves a timeline event based on its ID and incident record. *
* * @param getTimelineEventRequest * @return A Java Future containing the result of the GetTimelineEvent operation returned by the service. * @sample AWSSSMIncidentsAsync.GetTimelineEvent * @see AWS * API Documentation */ java.util.concurrent.Future* Retrieves a timeline event based on its ID and incident record. *
* * @param getTimelineEventRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the GetTimelineEvent operation returned by the service. * @sample AWSSSMIncidentsAsyncHandler.GetTimelineEvent * @see AWS * API Documentation */ java.util.concurrent.Future* 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. *
* * @param listIncidentRecordsRequest * @return A Java Future containing the result of the ListIncidentRecords operation returned by the service. * @sample AWSSSMIncidentsAsync.ListIncidentRecords * @see AWS API Documentation */ java.util.concurrent.Future* 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. *
* * @param listIncidentRecordsRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListIncidentRecords operation returned by the service. * @sample AWSSSMIncidentsAsyncHandler.ListIncidentRecords * @see AWS API Documentation */ java.util.concurrent.Future* List all related items for an incident record. *
* * @param listRelatedItemsRequest * @return A Java Future containing the result of the ListRelatedItems operation returned by the service. * @sample AWSSSMIncidentsAsync.ListRelatedItems * @see AWS * API Documentation */ java.util.concurrent.Future* List all related items for an incident record. *
* * @param listRelatedItemsRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListRelatedItems operation returned by the service. * @sample AWSSSMIncidentsAsyncHandler.ListRelatedItems * @see AWS * API Documentation */ java.util.concurrent.Future* Lists details about the replication set configured in your account. *
* * @param listReplicationSetsRequest * @return A Java Future containing the result of the ListReplicationSets operation returned by the service. * @sample AWSSSMIncidentsAsync.ListReplicationSets * @see AWS API Documentation */ java.util.concurrent.Future* Lists details about the replication set configured in your account. *
* * @param listReplicationSetsRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListReplicationSets operation returned by the service. * @sample AWSSSMIncidentsAsyncHandler.ListReplicationSets * @see AWS API Documentation */ java.util.concurrent.Future* Lists all response plans in your account. *
* * @param listResponsePlansRequest * @return A Java Future containing the result of the ListResponsePlans operation returned by the service. * @sample AWSSSMIncidentsAsync.ListResponsePlans * @see AWS API Documentation */ java.util.concurrent.Future* Lists all response plans in your account. *
* * @param listResponsePlansRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListResponsePlans operation returned by the service. * @sample AWSSSMIncidentsAsyncHandler.ListResponsePlans * @see AWS API Documentation */ java.util.concurrent.Future* Lists the tags that are attached to the specified response plan. *
* * @param listTagsForResourceRequest * @return A Java Future containing the result of the ListTagsForResource operation returned by the service. * @sample AWSSSMIncidentsAsync.ListTagsForResource * @see AWS API Documentation */ java.util.concurrent.Future* Lists the tags that are attached to the specified response plan. *
* * @param listTagsForResourceRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListTagsForResource operation returned by the service. * @sample AWSSSMIncidentsAsyncHandler.ListTagsForResource * @see AWS API Documentation */ java.util.concurrent.Future* Lists timeline events for the specified incident record. *
* * @param listTimelineEventsRequest * @return A Java Future containing the result of the ListTimelineEvents operation returned by the service. * @sample AWSSSMIncidentsAsync.ListTimelineEvents * @see AWS API Documentation */ java.util.concurrent.Future* Lists timeline events for the specified incident record. *
* * @param listTimelineEventsRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListTimelineEvents operation returned by the service. * @sample AWSSSMIncidentsAsyncHandler.ListTimelineEvents * @see AWS API Documentation */ java.util.concurrent.Future* 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. *
* * @param putResourcePolicyRequest * @return A Java Future containing the result of the PutResourcePolicy operation returned by the service. * @sample AWSSSMIncidentsAsync.PutResourcePolicy * @see AWS API Documentation */ java.util.concurrent.Future* 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. *
* * @param putResourcePolicyRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the PutResourcePolicy operation returned by the service. * @sample AWSSSMIncidentsAsyncHandler.PutResourcePolicy * @see AWS API Documentation */ java.util.concurrent.Future* Used to start an incident from CloudWatch alarms, EventBridge events, or manually. *
* * @param startIncidentRequest * @return A Java Future containing the result of the StartIncident operation returned by the service. * @sample AWSSSMIncidentsAsync.StartIncident * @see AWS * API Documentation */ java.util.concurrent.Future* Used to start an incident from CloudWatch alarms, EventBridge events, or manually. *
* * @param startIncidentRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the StartIncident operation returned by the service. * @sample AWSSSMIncidentsAsyncHandler.StartIncident * @see AWS * API Documentation */ java.util.concurrent.Future* Adds a tag to a response plan. *
* * @param tagResourceRequest * @return A Java Future containing the result of the TagResource operation returned by the service. * @sample AWSSSMIncidentsAsync.TagResource * @see AWS API * Documentation */ java.util.concurrent.Future* Adds a tag to a response plan. *
* * @param tagResourceRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the TagResource operation returned by the service. * @sample AWSSSMIncidentsAsyncHandler.TagResource * @see AWS API * Documentation */ java.util.concurrent.Future* Removes a tag from a resource. *
* * @param untagResourceRequest * @return A Java Future containing the result of the UntagResource operation returned by the service. * @sample AWSSSMIncidentsAsync.UntagResource * @see AWS * API Documentation */ java.util.concurrent.Future* Removes a tag from a resource. *
* * @param untagResourceRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the UntagResource operation returned by the service. * @sample AWSSSMIncidentsAsyncHandler.UntagResource * @see AWS * API Documentation */ java.util.concurrent.Future* Update deletion protection to either allow or deny deletion of the final Region in a replication set. *
* * @param updateDeletionProtectionRequest * @return A Java Future containing the result of the UpdateDeletionProtection operation returned by the service. * @sample AWSSSMIncidentsAsync.UpdateDeletionProtection * @see AWS API Documentation */ java.util.concurrent.Future* Update deletion protection to either allow or deny deletion of the final Region in a replication set. *
* * @param updateDeletionProtectionRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the UpdateDeletionProtection operation returned by the service. * @sample AWSSSMIncidentsAsyncHandler.UpdateDeletionProtection * @see AWS API Documentation */ java.util.concurrent.Future* 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. *
* * @param updateIncidentRecordRequest * @return A Java Future containing the result of the UpdateIncidentRecord operation returned by the service. * @sample AWSSSMIncidentsAsync.UpdateIncidentRecord * @see AWS API Documentation */ java.util.concurrent.Future* 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. *
* * @param updateIncidentRecordRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the UpdateIncidentRecord operation returned by the service. * @sample AWSSSMIncidentsAsyncHandler.UpdateIncidentRecord * @see AWS API Documentation */ java.util.concurrent.Future* Add or remove related items from the related items tab of an incident record. *
* * @param updateRelatedItemsRequest * @return A Java Future containing the result of the UpdateRelatedItems operation returned by the service. * @sample AWSSSMIncidentsAsync.UpdateRelatedItems * @see AWS API Documentation */ java.util.concurrent.Future* Add or remove related items from the related items tab of an incident record. *
* * @param updateRelatedItemsRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the UpdateRelatedItems operation returned by the service. * @sample AWSSSMIncidentsAsyncHandler.UpdateRelatedItems * @see AWS API Documentation */ java.util.concurrent.Future* Add or delete Regions from your replication set. *
* * @param updateReplicationSetRequest * @return A Java Future containing the result of the UpdateReplicationSet operation returned by the service. * @sample AWSSSMIncidentsAsync.UpdateReplicationSet * @see AWS API Documentation */ java.util.concurrent.Future* Add or delete Regions from your replication set. *
* * @param updateReplicationSetRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the UpdateReplicationSet operation returned by the service. * @sample AWSSSMIncidentsAsyncHandler.UpdateReplicationSet * @see AWS API Documentation */ java.util.concurrent.Future* Updates the specified response plan. *
* * @param updateResponsePlanRequest * @return A Java Future containing the result of the UpdateResponsePlan operation returned by the service. * @sample AWSSSMIncidentsAsync.UpdateResponsePlan * @see AWS API Documentation */ java.util.concurrent.Future* Updates the specified response plan. *
* * @param updateResponsePlanRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the UpdateResponsePlan operation returned by the service. * @sample AWSSSMIncidentsAsyncHandler.UpdateResponsePlan * @see AWS API Documentation */ java.util.concurrent.Future
* Updates a timeline event. You can update events of type Custom Event
.
*
* Updates a timeline event. You can update events of type Custom Event
.
*