com.amazonaws.services.ssmcontacts.AWSSSMContactsAsync Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ssmcontacts Show documentation
/*
* Copyright 2019-2024 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.ssmcontacts;
import javax.annotation.Generated;
import com.amazonaws.services.ssmcontacts.model.*;
/**
* Interface for accessing SSM Contacts 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.ssmcontacts.AbstractAWSSSMContactsAsync} 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 AWSSSMContactsAsync extends AWSSSMContacts {
/**
*
* Used to acknowledge an engagement to a contact channel during an incident.
*
*
* @param acceptPageRequest
* @return A Java Future containing the result of the AcceptPage operation returned by the service.
* @sample AWSSSMContactsAsync.AcceptPage
* @see AWS API
* Documentation
*/
java.util.concurrent.Future acceptPageAsync(AcceptPageRequest acceptPageRequest);
/**
*
* Used to acknowledge an engagement to a contact channel during an incident.
*
*
* @param acceptPageRequest
* @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 AcceptPage operation returned by the service.
* @sample AWSSSMContactsAsyncHandler.AcceptPage
* @see AWS API
* Documentation
*/
java.util.concurrent.Future acceptPageAsync(AcceptPageRequest acceptPageRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Activates a contact's contact channel. Incident Manager can't engage a contact until the contact channel has been
* activated.
*
*
* @param activateContactChannelRequest
* @return A Java Future containing the result of the ActivateContactChannel operation returned by the service.
* @sample AWSSSMContactsAsync.ActivateContactChannel
* @see AWS API Documentation
*/
java.util.concurrent.Future activateContactChannelAsync(ActivateContactChannelRequest activateContactChannelRequest);
/**
*
* Activates a contact's contact channel. Incident Manager can't engage a contact until the contact channel has been
* activated.
*
*
* @param activateContactChannelRequest
* @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 ActivateContactChannel operation returned by the service.
* @sample AWSSSMContactsAsyncHandler.ActivateContactChannel
* @see AWS API Documentation
*/
java.util.concurrent.Future activateContactChannelAsync(ActivateContactChannelRequest activateContactChannelRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Contacts are either the contacts that Incident Manager engages during an incident or the escalation plans that
* Incident Manager uses to engage contacts in phases during an incident.
*
*
* @param createContactRequest
* @return A Java Future containing the result of the CreateContact operation returned by the service.
* @sample AWSSSMContactsAsync.CreateContact
* @see AWS API
* Documentation
*/
java.util.concurrent.Future createContactAsync(CreateContactRequest createContactRequest);
/**
*
* Contacts are either the contacts that Incident Manager engages during an incident or the escalation plans that
* Incident Manager uses to engage contacts in phases during an incident.
*
*
* @param createContactRequest
* @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 CreateContact operation returned by the service.
* @sample AWSSSMContactsAsyncHandler.CreateContact
* @see AWS API
* Documentation
*/
java.util.concurrent.Future createContactAsync(CreateContactRequest createContactRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* A contact channel is the method that Incident Manager uses to engage your contact.
*
*
* @param createContactChannelRequest
* @return A Java Future containing the result of the CreateContactChannel operation returned by the service.
* @sample AWSSSMContactsAsync.CreateContactChannel
* @see AWS API Documentation
*/
java.util.concurrent.Future createContactChannelAsync(CreateContactChannelRequest createContactChannelRequest);
/**
*
* A contact channel is the method that Incident Manager uses to engage your contact.
*
*
* @param createContactChannelRequest
* @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 CreateContactChannel operation returned by the service.
* @sample AWSSSMContactsAsyncHandler.CreateContactChannel
* @see AWS API Documentation
*/
java.util.concurrent.Future createContactChannelAsync(CreateContactChannelRequest createContactChannelRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Creates a rotation in an on-call schedule.
*
*
* @param createRotationRequest
* @return A Java Future containing the result of the CreateRotation operation returned by the service.
* @sample AWSSSMContactsAsync.CreateRotation
* @see AWS
* API Documentation
*/
java.util.concurrent.Future createRotationAsync(CreateRotationRequest createRotationRequest);
/**
*
* Creates a rotation in an on-call schedule.
*
*
* @param createRotationRequest
* @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 CreateRotation operation returned by the service.
* @sample AWSSSMContactsAsyncHandler.CreateRotation
* @see AWS
* API Documentation
*/
java.util.concurrent.Future createRotationAsync(CreateRotationRequest createRotationRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Creates an override for a rotation in an on-call schedule.
*
*
* @param createRotationOverrideRequest
* @return A Java Future containing the result of the CreateRotationOverride operation returned by the service.
* @sample AWSSSMContactsAsync.CreateRotationOverride
* @see AWS API Documentation
*/
java.util.concurrent.Future createRotationOverrideAsync(CreateRotationOverrideRequest createRotationOverrideRequest);
/**
*
* Creates an override for a rotation in an on-call schedule.
*
*
* @param createRotationOverrideRequest
* @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 CreateRotationOverride operation returned by the service.
* @sample AWSSSMContactsAsyncHandler.CreateRotationOverride
* @see AWS API Documentation
*/
java.util.concurrent.Future createRotationOverrideAsync(CreateRotationOverrideRequest createRotationOverrideRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* To no longer receive Incident Manager engagements to a contact channel, you can deactivate the channel.
*
*
* @param deactivateContactChannelRequest
* @return A Java Future containing the result of the DeactivateContactChannel operation returned by the service.
* @sample AWSSSMContactsAsync.DeactivateContactChannel
* @see AWS API Documentation
*/
java.util.concurrent.Future deactivateContactChannelAsync(DeactivateContactChannelRequest deactivateContactChannelRequest);
/**
*
* To no longer receive Incident Manager engagements to a contact channel, you can deactivate the channel.
*
*
* @param deactivateContactChannelRequest
* @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 DeactivateContactChannel operation returned by the service.
* @sample AWSSSMContactsAsyncHandler.DeactivateContactChannel
* @see AWS API Documentation
*/
java.util.concurrent.Future deactivateContactChannelAsync(DeactivateContactChannelRequest deactivateContactChannelRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* To remove a contact from Incident Manager, you can delete the contact. Deleting a contact removes them from all
* escalation plans and related response plans. Deleting an escalation plan removes it from all related response
* plans. You will have to recreate the contact and its contact channels before you can use it again.
*
*
* @param deleteContactRequest
* @return A Java Future containing the result of the DeleteContact operation returned by the service.
* @sample AWSSSMContactsAsync.DeleteContact
* @see AWS API
* Documentation
*/
java.util.concurrent.Future deleteContactAsync(DeleteContactRequest deleteContactRequest);
/**
*
* To remove a contact from Incident Manager, you can delete the contact. Deleting a contact removes them from all
* escalation plans and related response plans. Deleting an escalation plan removes it from all related response
* plans. You will have to recreate the contact and its contact channels before you can use it again.
*
*
* @param deleteContactRequest
* @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 DeleteContact operation returned by the service.
* @sample AWSSSMContactsAsyncHandler.DeleteContact
* @see AWS API
* Documentation
*/
java.util.concurrent.Future deleteContactAsync(DeleteContactRequest deleteContactRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* To no longer receive engagements on a contact channel, you can delete the channel from a contact. Deleting the
* contact channel removes it from the contact's engagement plan. If you delete the only contact channel for a
* contact, you won't be able to engage that contact during an incident.
*
*
* @param deleteContactChannelRequest
* @return A Java Future containing the result of the DeleteContactChannel operation returned by the service.
* @sample AWSSSMContactsAsync.DeleteContactChannel
* @see AWS API Documentation
*/
java.util.concurrent.Future deleteContactChannelAsync(DeleteContactChannelRequest deleteContactChannelRequest);
/**
*
* To no longer receive engagements on a contact channel, you can delete the channel from a contact. Deleting the
* contact channel removes it from the contact's engagement plan. If you delete the only contact channel for a
* contact, you won't be able to engage that contact during an incident.
*
*
* @param deleteContactChannelRequest
* @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 DeleteContactChannel operation returned by the service.
* @sample AWSSSMContactsAsyncHandler.DeleteContactChannel
* @see AWS API Documentation
*/
java.util.concurrent.Future deleteContactChannelAsync(DeleteContactChannelRequest deleteContactChannelRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Deletes a rotation from the system. If a rotation belongs to more than one on-call schedule, this operation
* deletes it from all of them.
*
*
* @param deleteRotationRequest
* @return A Java Future containing the result of the DeleteRotation operation returned by the service.
* @sample AWSSSMContactsAsync.DeleteRotation
* @see AWS
* API Documentation
*/
java.util.concurrent.Future deleteRotationAsync(DeleteRotationRequest deleteRotationRequest);
/**
*
* Deletes a rotation from the system. If a rotation belongs to more than one on-call schedule, this operation
* deletes it from all of them.
*
*
* @param deleteRotationRequest
* @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 DeleteRotation operation returned by the service.
* @sample AWSSSMContactsAsyncHandler.DeleteRotation
* @see AWS
* API Documentation
*/
java.util.concurrent.Future deleteRotationAsync(DeleteRotationRequest deleteRotationRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Deletes an existing override for an on-call rotation.
*
*
* @param deleteRotationOverrideRequest
* @return A Java Future containing the result of the DeleteRotationOverride operation returned by the service.
* @sample AWSSSMContactsAsync.DeleteRotationOverride
* @see AWS API Documentation
*/
java.util.concurrent.Future deleteRotationOverrideAsync(DeleteRotationOverrideRequest deleteRotationOverrideRequest);
/**
*
* Deletes an existing override for an on-call rotation.
*
*
* @param deleteRotationOverrideRequest
* @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 DeleteRotationOverride operation returned by the service.
* @sample AWSSSMContactsAsyncHandler.DeleteRotationOverride
* @see AWS API Documentation
*/
java.util.concurrent.Future deleteRotationOverrideAsync(DeleteRotationOverrideRequest deleteRotationOverrideRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Incident Manager uses engagements to engage contacts and escalation plans during an incident. Use this command to
* describe the engagement that occurred during an incident.
*
*
* @param describeEngagementRequest
* @return A Java Future containing the result of the DescribeEngagement operation returned by the service.
* @sample AWSSSMContactsAsync.DescribeEngagement
* @see AWS API Documentation
*/
java.util.concurrent.Future describeEngagementAsync(DescribeEngagementRequest describeEngagementRequest);
/**
*
* Incident Manager uses engagements to engage contacts and escalation plans during an incident. Use this command to
* describe the engagement that occurred during an incident.
*
*
* @param describeEngagementRequest
* @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 DescribeEngagement operation returned by the service.
* @sample AWSSSMContactsAsyncHandler.DescribeEngagement
* @see AWS API Documentation
*/
java.util.concurrent.Future describeEngagementAsync(DescribeEngagementRequest describeEngagementRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Lists details of the engagement to a contact channel.
*
*
* @param describePageRequest
* @return A Java Future containing the result of the DescribePage operation returned by the service.
* @sample AWSSSMContactsAsync.DescribePage
* @see AWS API
* Documentation
*/
java.util.concurrent.Future describePageAsync(DescribePageRequest describePageRequest);
/**
*
* Lists details of the engagement to a contact channel.
*
*
* @param describePageRequest
* @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 DescribePage operation returned by the service.
* @sample AWSSSMContactsAsyncHandler.DescribePage
* @see AWS API
* Documentation
*/
java.util.concurrent.Future describePageAsync(DescribePageRequest describePageRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Retrieves information about the specified contact or escalation plan.
*
*
* @param getContactRequest
* @return A Java Future containing the result of the GetContact operation returned by the service.
* @sample AWSSSMContactsAsync.GetContact
* @see AWS API
* Documentation
*/
java.util.concurrent.Future getContactAsync(GetContactRequest getContactRequest);
/**
*
* Retrieves information about the specified contact or escalation plan.
*
*
* @param getContactRequest
* @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 GetContact operation returned by the service.
* @sample AWSSSMContactsAsyncHandler.GetContact
* @see AWS API
* Documentation
*/
java.util.concurrent.Future getContactAsync(GetContactRequest getContactRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* List details about a specific contact channel.
*
*
* @param getContactChannelRequest
* @return A Java Future containing the result of the GetContactChannel operation returned by the service.
* @sample AWSSSMContactsAsync.GetContactChannel
* @see AWS
* API Documentation
*/
java.util.concurrent.Future getContactChannelAsync(GetContactChannelRequest getContactChannelRequest);
/**
*
* List details about a specific contact channel.
*
*
* @param getContactChannelRequest
* @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 GetContactChannel operation returned by the service.
* @sample AWSSSMContactsAsyncHandler.GetContactChannel
* @see AWS
* API Documentation
*/
java.util.concurrent.Future getContactChannelAsync(GetContactChannelRequest getContactChannelRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Retrieves the resource policies attached to the specified contact or escalation plan.
*
*
* @param getContactPolicyRequest
* @return A Java Future containing the result of the GetContactPolicy operation returned by the service.
* @sample AWSSSMContactsAsync.GetContactPolicy
* @see AWS
* API Documentation
*/
java.util.concurrent.Future getContactPolicyAsync(GetContactPolicyRequest getContactPolicyRequest);
/**
*
* Retrieves the resource policies attached to the specified contact or escalation plan.
*
*
* @param getContactPolicyRequest
* @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 GetContactPolicy operation returned by the service.
* @sample AWSSSMContactsAsyncHandler.GetContactPolicy
* @see AWS
* API Documentation
*/
java.util.concurrent.Future getContactPolicyAsync(GetContactPolicyRequest getContactPolicyRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Retrieves information about an on-call rotation.
*
*
* @param getRotationRequest
* @return A Java Future containing the result of the GetRotation operation returned by the service.
* @sample AWSSSMContactsAsync.GetRotation
* @see AWS API
* Documentation
*/
java.util.concurrent.Future getRotationAsync(GetRotationRequest getRotationRequest);
/**
*
* Retrieves information about an on-call rotation.
*
*
* @param getRotationRequest
* @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 GetRotation operation returned by the service.
* @sample AWSSSMContactsAsyncHandler.GetRotation
* @see AWS API
* Documentation
*/
java.util.concurrent.Future getRotationAsync(GetRotationRequest getRotationRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Retrieves information about an override to an on-call rotation.
*
*
* @param getRotationOverrideRequest
* @return A Java Future containing the result of the GetRotationOverride operation returned by the service.
* @sample AWSSSMContactsAsync.GetRotationOverride
* @see AWS API Documentation
*/
java.util.concurrent.Future getRotationOverrideAsync(GetRotationOverrideRequest getRotationOverrideRequest);
/**
*
* Retrieves information about an override to an on-call rotation.
*
*
* @param getRotationOverrideRequest
* @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 GetRotationOverride operation returned by the service.
* @sample AWSSSMContactsAsyncHandler.GetRotationOverride
* @see AWS API Documentation
*/
java.util.concurrent.Future getRotationOverrideAsync(GetRotationOverrideRequest getRotationOverrideRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Lists all contact channels for the specified contact.
*
*
* @param listContactChannelsRequest
* @return A Java Future containing the result of the ListContactChannels operation returned by the service.
* @sample AWSSSMContactsAsync.ListContactChannels
* @see AWS API Documentation
*/
java.util.concurrent.Future listContactChannelsAsync(ListContactChannelsRequest listContactChannelsRequest);
/**
*
* Lists all contact channels for the specified contact.
*
*
* @param listContactChannelsRequest
* @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 ListContactChannels operation returned by the service.
* @sample AWSSSMContactsAsyncHandler.ListContactChannels
* @see AWS API Documentation
*/
java.util.concurrent.Future listContactChannelsAsync(ListContactChannelsRequest listContactChannelsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Lists all contacts and escalation plans in Incident Manager.
*
*
* @param listContactsRequest
* @return A Java Future containing the result of the ListContacts operation returned by the service.
* @sample AWSSSMContactsAsync.ListContacts
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listContactsAsync(ListContactsRequest listContactsRequest);
/**
*
* Lists all contacts and escalation plans in Incident Manager.
*
*
* @param listContactsRequest
* @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 ListContacts operation returned by the service.
* @sample AWSSSMContactsAsyncHandler.ListContacts
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listContactsAsync(ListContactsRequest listContactsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Lists all engagements that have happened in an incident.
*
*
* @param listEngagementsRequest
* @return A Java Future containing the result of the ListEngagements operation returned by the service.
* @sample AWSSSMContactsAsync.ListEngagements
* @see AWS
* API Documentation
*/
java.util.concurrent.Future listEngagementsAsync(ListEngagementsRequest listEngagementsRequest);
/**
*
* Lists all engagements that have happened in an incident.
*
*
* @param listEngagementsRequest
* @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 ListEngagements operation returned by the service.
* @sample AWSSSMContactsAsyncHandler.ListEngagements
* @see AWS
* API Documentation
*/
java.util.concurrent.Future listEngagementsAsync(ListEngagementsRequest listEngagementsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Lists all of the engagements to contact channels that have been acknowledged.
*
*
* @param listPageReceiptsRequest
* @return A Java Future containing the result of the ListPageReceipts operation returned by the service.
* @sample AWSSSMContactsAsync.ListPageReceipts
* @see AWS
* API Documentation
*/
java.util.concurrent.Future listPageReceiptsAsync(ListPageReceiptsRequest listPageReceiptsRequest);
/**
*
* Lists all of the engagements to contact channels that have been acknowledged.
*
*
* @param listPageReceiptsRequest
* @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 ListPageReceipts operation returned by the service.
* @sample AWSSSMContactsAsyncHandler.ListPageReceipts
* @see AWS
* API Documentation
*/
java.util.concurrent.Future listPageReceiptsAsync(ListPageReceiptsRequest listPageReceiptsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Returns the resolution path of an engagement. For example, the escalation plan engaged in an incident might
* target an on-call schedule that includes several contacts in a rotation, but just one contact on-call when the
* incident starts. The resolution path indicates the hierarchy of escalation plan > on-call schedule >
* contact.
*
*
* @param listPageResolutionsRequest
* @return A Java Future containing the result of the ListPageResolutions operation returned by the service.
* @sample AWSSSMContactsAsync.ListPageResolutions
* @see AWS API Documentation
*/
java.util.concurrent.Future listPageResolutionsAsync(ListPageResolutionsRequest listPageResolutionsRequest);
/**
*
* Returns the resolution path of an engagement. For example, the escalation plan engaged in an incident might
* target an on-call schedule that includes several contacts in a rotation, but just one contact on-call when the
* incident starts. The resolution path indicates the hierarchy of escalation plan > on-call schedule >
* contact.
*
*
* @param listPageResolutionsRequest
* @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 ListPageResolutions operation returned by the service.
* @sample AWSSSMContactsAsyncHandler.ListPageResolutions
* @see AWS API Documentation
*/
java.util.concurrent.Future listPageResolutionsAsync(ListPageResolutionsRequest listPageResolutionsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Lists the engagements to a contact's contact channels.
*
*
* @param listPagesByContactRequest
* @return A Java Future containing the result of the ListPagesByContact operation returned by the service.
* @sample AWSSSMContactsAsync.ListPagesByContact
* @see AWS API Documentation
*/
java.util.concurrent.Future listPagesByContactAsync(ListPagesByContactRequest listPagesByContactRequest);
/**
*
* Lists the engagements to a contact's contact channels.
*
*
* @param listPagesByContactRequest
* @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 ListPagesByContact operation returned by the service.
* @sample AWSSSMContactsAsyncHandler.ListPagesByContact
* @see AWS API Documentation
*/
java.util.concurrent.Future listPagesByContactAsync(ListPagesByContactRequest listPagesByContactRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Lists the engagements to contact channels that occurred by engaging a contact.
*
*
* @param listPagesByEngagementRequest
* @return A Java Future containing the result of the ListPagesByEngagement operation returned by the service.
* @sample AWSSSMContactsAsync.ListPagesByEngagement
* @see AWS API Documentation
*/
java.util.concurrent.Future listPagesByEngagementAsync(ListPagesByEngagementRequest listPagesByEngagementRequest);
/**
*
* Lists the engagements to contact channels that occurred by engaging a contact.
*
*
* @param listPagesByEngagementRequest
* @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 ListPagesByEngagement operation returned by the service.
* @sample AWSSSMContactsAsyncHandler.ListPagesByEngagement
* @see AWS API Documentation
*/
java.util.concurrent.Future listPagesByEngagementAsync(ListPagesByEngagementRequest listPagesByEngagementRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Returns a list of shifts based on rotation configuration parameters.
*
*
*
* The Incident Manager primarily uses this operation to populate the Preview calendar. It is not typically
* run by end users.
*
*
*
* @param listPreviewRotationShiftsRequest
* @return A Java Future containing the result of the ListPreviewRotationShifts operation returned by the service.
* @sample AWSSSMContactsAsync.ListPreviewRotationShifts
* @see AWS API Documentation
*/
java.util.concurrent.Future listPreviewRotationShiftsAsync(
ListPreviewRotationShiftsRequest listPreviewRotationShiftsRequest);
/**
*
* Returns a list of shifts based on rotation configuration parameters.
*
*
*
* The Incident Manager primarily uses this operation to populate the Preview calendar. It is not typically
* run by end users.
*
*
*
* @param listPreviewRotationShiftsRequest
* @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 ListPreviewRotationShifts operation returned by the service.
* @sample AWSSSMContactsAsyncHandler.ListPreviewRotationShifts
* @see AWS API Documentation
*/
java.util.concurrent.Future listPreviewRotationShiftsAsync(
ListPreviewRotationShiftsRequest listPreviewRotationShiftsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Retrieves a list of overrides currently specified for an on-call rotation.
*
*
* @param listRotationOverridesRequest
* @return A Java Future containing the result of the ListRotationOverrides operation returned by the service.
* @sample AWSSSMContactsAsync.ListRotationOverrides
* @see AWS API Documentation
*/
java.util.concurrent.Future listRotationOverridesAsync(ListRotationOverridesRequest listRotationOverridesRequest);
/**
*
* Retrieves a list of overrides currently specified for an on-call rotation.
*
*
* @param listRotationOverridesRequest
* @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 ListRotationOverrides operation returned by the service.
* @sample AWSSSMContactsAsyncHandler.ListRotationOverrides
* @see AWS API Documentation
*/
java.util.concurrent.Future listRotationOverridesAsync(ListRotationOverridesRequest listRotationOverridesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Returns a list of shifts generated by an existing rotation in the system.
*
*
* @param listRotationShiftsRequest
* @return A Java Future containing the result of the ListRotationShifts operation returned by the service.
* @sample AWSSSMContactsAsync.ListRotationShifts
* @see AWS API Documentation
*/
java.util.concurrent.Future listRotationShiftsAsync(ListRotationShiftsRequest listRotationShiftsRequest);
/**
*
* Returns a list of shifts generated by an existing rotation in the system.
*
*
* @param listRotationShiftsRequest
* @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 ListRotationShifts operation returned by the service.
* @sample AWSSSMContactsAsyncHandler.ListRotationShifts
* @see AWS API Documentation
*/
java.util.concurrent.Future listRotationShiftsAsync(ListRotationShiftsRequest listRotationShiftsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Retrieves a list of on-call rotations.
*
*
* @param listRotationsRequest
* @return A Java Future containing the result of the ListRotations operation returned by the service.
* @sample AWSSSMContactsAsync.ListRotations
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listRotationsAsync(ListRotationsRequest listRotationsRequest);
/**
*
* Retrieves a list of on-call rotations.
*
*
* @param listRotationsRequest
* @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 ListRotations operation returned by the service.
* @sample AWSSSMContactsAsyncHandler.ListRotations
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listRotationsAsync(ListRotationsRequest listRotationsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Lists the tags of an escalation plan or contact.
*
*
* @param listTagsForResourceRequest
* @return A Java Future containing the result of the ListTagsForResource operation returned by the service.
* @sample AWSSSMContactsAsync.ListTagsForResource
* @see AWS API Documentation
*/
java.util.concurrent.Future listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* Lists the tags of an escalation plan or contact.
*
*
* @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 AWSSSMContactsAsyncHandler.ListTagsForResource
* @see AWS API Documentation
*/
java.util.concurrent.Future listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Adds a resource policy to the specified contact or escalation plan. The resource policy is used to share the
* contact or escalation plan using Resource Access Manager (RAM). For more information about cross-account sharing,
* see Setting up cross-account
* functionality.
*
*
* @param putContactPolicyRequest
* @return A Java Future containing the result of the PutContactPolicy operation returned by the service.
* @sample AWSSSMContactsAsync.PutContactPolicy
* @see AWS
* API Documentation
*/
java.util.concurrent.Future putContactPolicyAsync(PutContactPolicyRequest putContactPolicyRequest);
/**
*
* Adds a resource policy to the specified contact or escalation plan. The resource policy is used to share the
* contact or escalation plan using Resource Access Manager (RAM). For more information about cross-account sharing,
* see Setting up cross-account
* functionality.
*
*
* @param putContactPolicyRequest
* @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 PutContactPolicy operation returned by the service.
* @sample AWSSSMContactsAsyncHandler.PutContactPolicy
* @see AWS
* API Documentation
*/
java.util.concurrent.Future putContactPolicyAsync(PutContactPolicyRequest putContactPolicyRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Sends an activation code to a contact channel. The contact can use this code to activate the contact channel in
* the console or with the ActivateChannel operation. Incident Manager can't engage a contact channel
* until it has been activated.
*
*
* @param sendActivationCodeRequest
* @return A Java Future containing the result of the SendActivationCode operation returned by the service.
* @sample AWSSSMContactsAsync.SendActivationCode
* @see AWS API Documentation
*/
java.util.concurrent.Future sendActivationCodeAsync(SendActivationCodeRequest sendActivationCodeRequest);
/**
*
* Sends an activation code to a contact channel. The contact can use this code to activate the contact channel in
* the console or with the ActivateChannel operation. Incident Manager can't engage a contact channel
* until it has been activated.
*
*
* @param sendActivationCodeRequest
* @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 SendActivationCode operation returned by the service.
* @sample AWSSSMContactsAsyncHandler.SendActivationCode
* @see AWS API Documentation
*/
java.util.concurrent.Future sendActivationCodeAsync(SendActivationCodeRequest sendActivationCodeRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Starts an engagement to a contact or escalation plan. The engagement engages each contact specified in the
* incident.
*
*
* @param startEngagementRequest
* @return A Java Future containing the result of the StartEngagement operation returned by the service.
* @sample AWSSSMContactsAsync.StartEngagement
* @see AWS
* API Documentation
*/
java.util.concurrent.Future startEngagementAsync(StartEngagementRequest startEngagementRequest);
/**
*
* Starts an engagement to a contact or escalation plan. The engagement engages each contact specified in the
* incident.
*
*
* @param startEngagementRequest
* @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 StartEngagement operation returned by the service.
* @sample AWSSSMContactsAsyncHandler.StartEngagement
* @see AWS
* API Documentation
*/
java.util.concurrent.Future startEngagementAsync(StartEngagementRequest startEngagementRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Stops an engagement before it finishes the final stage of the escalation plan or engagement plan. Further
* contacts aren't engaged.
*
*
* @param stopEngagementRequest
* @return A Java Future containing the result of the StopEngagement operation returned by the service.
* @sample AWSSSMContactsAsync.StopEngagement
* @see AWS
* API Documentation
*/
java.util.concurrent.Future stopEngagementAsync(StopEngagementRequest stopEngagementRequest);
/**
*
* Stops an engagement before it finishes the final stage of the escalation plan or engagement plan. Further
* contacts aren't engaged.
*
*
* @param stopEngagementRequest
* @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 StopEngagement operation returned by the service.
* @sample AWSSSMContactsAsyncHandler.StopEngagement
* @see AWS
* API Documentation
*/
java.util.concurrent.Future stopEngagementAsync(StopEngagementRequest stopEngagementRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Tags a contact or escalation plan. You can tag only contacts and escalation plans in the first region of your
* replication set.
*
*
* @param tagResourceRequest
* @return A Java Future containing the result of the TagResource operation returned by the service.
* @sample AWSSSMContactsAsync.TagResource
* @see AWS API
* Documentation
*/
java.util.concurrent.Future tagResourceAsync(TagResourceRequest tagResourceRequest);
/**
*
* Tags a contact or escalation plan. You can tag only contacts and escalation plans in the first region of your
* replication set.
*
*
* @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 AWSSSMContactsAsyncHandler.TagResource
* @see AWS API
* Documentation
*/
java.util.concurrent.Future tagResourceAsync(TagResourceRequest tagResourceRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Removes tags from the specified resource.
*
*
* @param untagResourceRequest
* @return A Java Future containing the result of the UntagResource operation returned by the service.
* @sample AWSSSMContactsAsync.UntagResource
* @see AWS API
* Documentation
*/
java.util.concurrent.Future untagResourceAsync(UntagResourceRequest untagResourceRequest);
/**
*
* Removes tags from the specified 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 AWSSSMContactsAsyncHandler.UntagResource
* @see AWS API
* Documentation
*/
java.util.concurrent.Future untagResourceAsync(UntagResourceRequest untagResourceRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Updates the contact or escalation plan specified.
*
*
* @param updateContactRequest
* @return A Java Future containing the result of the UpdateContact operation returned by the service.
* @sample AWSSSMContactsAsync.UpdateContact
* @see AWS API
* Documentation
*/
java.util.concurrent.Future updateContactAsync(UpdateContactRequest updateContactRequest);
/**
*
* Updates the contact or escalation plan specified.
*
*
* @param updateContactRequest
* @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 UpdateContact operation returned by the service.
* @sample AWSSSMContactsAsyncHandler.UpdateContact
* @see AWS API
* Documentation
*/
java.util.concurrent.Future updateContactAsync(UpdateContactRequest updateContactRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Updates a contact's contact channel.
*
*
* @param updateContactChannelRequest
* @return A Java Future containing the result of the UpdateContactChannel operation returned by the service.
* @sample AWSSSMContactsAsync.UpdateContactChannel
* @see AWS API Documentation
*/
java.util.concurrent.Future updateContactChannelAsync(UpdateContactChannelRequest updateContactChannelRequest);
/**
*
* Updates a contact's contact channel.
*
*
* @param updateContactChannelRequest
* @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 UpdateContactChannel operation returned by the service.
* @sample AWSSSMContactsAsyncHandler.UpdateContactChannel
* @see AWS API Documentation
*/
java.util.concurrent.Future updateContactChannelAsync(UpdateContactChannelRequest updateContactChannelRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Updates the information specified for an on-call rotation.
*
*
* @param updateRotationRequest
* @return A Java Future containing the result of the UpdateRotation operation returned by the service.
* @sample AWSSSMContactsAsync.UpdateRotation
* @see AWS
* API Documentation
*/
java.util.concurrent.Future updateRotationAsync(UpdateRotationRequest updateRotationRequest);
/**
*
* Updates the information specified for an on-call rotation.
*
*
* @param updateRotationRequest
* @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 UpdateRotation operation returned by the service.
* @sample AWSSSMContactsAsyncHandler.UpdateRotation
* @see AWS
* API Documentation
*/
java.util.concurrent.Future updateRotationAsync(UpdateRotationRequest updateRotationRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
}