/* * 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.ssmcontacts; import javax.annotation.Generated; import com.amazonaws.*; import com.amazonaws.regions.*; import com.amazonaws.services.ssmcontacts.model.*; /** * Interface for accessing SSM Contacts. *

* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from * {@link com.amazonaws.services.ssmcontacts.AbstractAWSSSMContacts} 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 AWSSSMContacts { /** * The region metadata service name for computing region endpoints. You can use this value to retrieve metadata * (such as supported regions) of the service. * * @see RegionUtils#getRegionsForService(String) */ String ENDPOINT_PREFIX = "ssm-contacts"; /** *

* Used to acknowledge an engagement to a contact channel during an incident. *

* * @param acceptPageRequest * @return Result of the AcceptPage operation returned by the service. * @throws AccessDeniedException * You don't have sufficient access to perform this operation. * @throws InternalServerException * Unexpected error occurred while processing the request. * @throws ResourceNotFoundException * Request references a resource that doesn't exist. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ValidationException * The input fails to satisfy the constraints specified by an Amazon Web Services service. * @sample AWSSSMContacts.AcceptPage * @see AWS API * Documentation */ AcceptPageResult acceptPage(AcceptPageRequest acceptPageRequest); /** *

* Activates a contact's contact channel. Incident Manager can't engage a contact until the contact channel has been * activated. *

* * @param activateContactChannelRequest * @return Result of the ActivateContactChannel operation returned by the service. * @throws AccessDeniedException * You don't have sufficient access to perform this operation. * @throws InternalServerException * Unexpected error occurred while processing the request. * @throws ResourceNotFoundException * Request references a resource that doesn't exist. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ValidationException * The input fails to satisfy the constraints specified by an Amazon Web Services service. * @sample AWSSSMContacts.ActivateContactChannel * @see AWS API Documentation */ ActivateContactChannelResult activateContactChannel(ActivateContactChannelRequest activateContactChannelRequest); /** *

* 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 Result of the CreateContact operation returned by the service. * @throws AccessDeniedException * You don't have sufficient access to perform this operation. * @throws ConflictException * Updating or deleting a resource causes an inconsistent state. * @throws InternalServerException * Unexpected error occurred while processing the request. * @throws ServiceQuotaExceededException * Request would cause a service quota to be exceeded. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ValidationException * The input fails to satisfy the constraints specified by an Amazon Web Services service. * @throws DataEncryptionException * The operation failed to due an encryption key error. * @sample AWSSSMContacts.CreateContact * @see AWS API * Documentation */ CreateContactResult createContact(CreateContactRequest createContactRequest); /** *

* A contact channel is the method that Incident Manager uses to engage your contact. *

* * @param createContactChannelRequest * @return Result of the CreateContactChannel operation returned by the service. * @throws AccessDeniedException * You don't have sufficient access to perform this operation. * @throws ConflictException * Updating or deleting a resource causes an inconsistent state. * @throws DataEncryptionException * The operation failed to due an encryption key error. * @throws InternalServerException * Unexpected error occurred while processing the request. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ValidationException * The input fails to satisfy the constraints specified by an Amazon Web Services service. * @sample AWSSSMContacts.CreateContactChannel * @see AWS API Documentation */ CreateContactChannelResult createContactChannel(CreateContactChannelRequest createContactChannelRequest); /** *

* Creates a rotation in an on-call schedule. *

* * @param createRotationRequest * @return Result of the CreateRotation operation returned by the service. * @throws AccessDeniedException * You don't have sufficient access to perform this operation. * @throws InternalServerException * Unexpected error occurred while processing the request. * @throws ResourceNotFoundException * Request references a resource that doesn't exist. * @throws ServiceQuotaExceededException * Request would cause a service quota to be exceeded. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ValidationException * The input fails to satisfy the constraints specified by an Amazon Web Services service. * @sample AWSSSMContacts.CreateRotation * @see AWS * API Documentation */ CreateRotationResult createRotation(CreateRotationRequest createRotationRequest); /** *

* Creates an override for a rotation in an on-call schedule. *

* * @param createRotationOverrideRequest * @return Result of the CreateRotationOverride operation returned by the service. * @throws AccessDeniedException * You don't have sufficient access to perform this operation. * @throws InternalServerException * Unexpected error occurred while processing the request. * @throws ResourceNotFoundException * Request references a resource that doesn't exist. * @throws ServiceQuotaExceededException * Request would cause a service quota to be exceeded. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ValidationException * The input fails to satisfy the constraints specified by an Amazon Web Services service. * @sample AWSSSMContacts.CreateRotationOverride * @see AWS API Documentation */ CreateRotationOverrideResult createRotationOverride(CreateRotationOverrideRequest createRotationOverrideRequest); /** *

* To no longer receive Incident Manager engagements to a contact channel, you can deactivate the channel. *

* * @param deactivateContactChannelRequest * @return Result of the DeactivateContactChannel operation returned by the service. * @throws AccessDeniedException * You don't have sufficient access to perform this operation. * @throws InternalServerException * Unexpected error occurred while processing the request. * @throws ResourceNotFoundException * Request references a resource that doesn't exist. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ValidationException * The input fails to satisfy the constraints specified by an Amazon Web Services service. * @sample AWSSSMContacts.DeactivateContactChannel * @see AWS API Documentation */ DeactivateContactChannelResult deactivateContactChannel(DeactivateContactChannelRequest deactivateContactChannelRequest); /** *

* 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 Result of the DeleteContact operation returned by the service. * @throws AccessDeniedException * You don't have sufficient access to perform this operation. * @throws InternalServerException * Unexpected error occurred while processing the request. * @throws ResourceNotFoundException * Request references a resource that doesn't exist. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ConflictException * Updating or deleting a resource causes an inconsistent state. * @throws ValidationException * The input fails to satisfy the constraints specified by an Amazon Web Services service. * @sample AWSSSMContacts.DeleteContact * @see AWS API * Documentation */ DeleteContactResult deleteContact(DeleteContactRequest deleteContactRequest); /** *

* 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 Result of the DeleteContactChannel operation returned by the service. * @throws AccessDeniedException * You don't have sufficient access to perform this operation. * @throws InternalServerException * Unexpected error occurred while processing the request. * @throws ResourceNotFoundException * Request references a resource that doesn't exist. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ValidationException * The input fails to satisfy the constraints specified by an Amazon Web Services service. * @sample AWSSSMContacts.DeleteContactChannel * @see AWS API Documentation */ DeleteContactChannelResult deleteContactChannel(DeleteContactChannelRequest deleteContactChannelRequest); /** *

* 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 Result of the DeleteRotation operation returned by the service. * @throws AccessDeniedException * You don't have sufficient access to perform this operation. * @throws ConflictException * Updating or deleting a resource causes an inconsistent state. * @throws InternalServerException * Unexpected error occurred while processing the request. * @throws ResourceNotFoundException * Request references a resource that doesn't exist. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ValidationException * The input fails to satisfy the constraints specified by an Amazon Web Services service. * @sample AWSSSMContacts.DeleteRotation * @see AWS * API Documentation */ DeleteRotationResult deleteRotation(DeleteRotationRequest deleteRotationRequest); /** *

* Deletes an existing override for an on-call rotation. *

* * @param deleteRotationOverrideRequest * @return Result of the DeleteRotationOverride operation returned by the service. * @throws AccessDeniedException * You don't have sufficient access to perform this operation. * @throws InternalServerException * Unexpected error occurred while processing the request. * @throws ResourceNotFoundException * Request references a resource that doesn't exist. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ValidationException * The input fails to satisfy the constraints specified by an Amazon Web Services service. * @sample AWSSSMContacts.DeleteRotationOverride * @see AWS API Documentation */ DeleteRotationOverrideResult deleteRotationOverride(DeleteRotationOverrideRequest deleteRotationOverrideRequest); /** *

* 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 Result of the DescribeEngagement operation returned by the service. * @throws AccessDeniedException * You don't have sufficient access to perform this operation. * @throws DataEncryptionException * The operation failed to due an encryption key error. * @throws InternalServerException * Unexpected error occurred while processing the request. * @throws ResourceNotFoundException * Request references a resource that doesn't exist. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ValidationException * The input fails to satisfy the constraints specified by an Amazon Web Services service. * @sample AWSSSMContacts.DescribeEngagement * @see AWS API Documentation */ DescribeEngagementResult describeEngagement(DescribeEngagementRequest describeEngagementRequest); /** *

* Lists details of the engagement to a contact channel. *

* * @param describePageRequest * @return Result of the DescribePage operation returned by the service. * @throws AccessDeniedException * You don't have sufficient access to perform this operation. * @throws DataEncryptionException * The operation failed to due an encryption key error. * @throws InternalServerException * Unexpected error occurred while processing the request. * @throws ResourceNotFoundException * Request references a resource that doesn't exist. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ValidationException * The input fails to satisfy the constraints specified by an Amazon Web Services service. * @sample AWSSSMContacts.DescribePage * @see AWS API * Documentation */ DescribePageResult describePage(DescribePageRequest describePageRequest); /** *

* Retrieves information about the specified contact or escalation plan. *

* * @param getContactRequest * @return Result of the GetContact operation returned by the service. * @throws AccessDeniedException * You don't have sufficient access to perform this operation. * @throws InternalServerException * Unexpected error occurred while processing the request. * @throws ResourceNotFoundException * Request references a resource that doesn't exist. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ValidationException * The input fails to satisfy the constraints specified by an Amazon Web Services service. * @throws DataEncryptionException * The operation failed to due an encryption key error. * @sample AWSSSMContacts.GetContact * @see AWS API * Documentation */ GetContactResult getContact(GetContactRequest getContactRequest); /** *

* List details about a specific contact channel. *

* * @param getContactChannelRequest * @return Result of the GetContactChannel operation returned by the service. * @throws AccessDeniedException * You don't have sufficient access to perform this operation. * @throws DataEncryptionException * The operation failed to due an encryption key error. * @throws InternalServerException * Unexpected error occurred while processing the request. * @throws ResourceNotFoundException * Request references a resource that doesn't exist. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ValidationException * The input fails to satisfy the constraints specified by an Amazon Web Services service. * @sample AWSSSMContacts.GetContactChannel * @see AWS * API Documentation */ GetContactChannelResult getContactChannel(GetContactChannelRequest getContactChannelRequest); /** *

* Retrieves the resource policies attached to the specified contact or escalation plan. *

* * @param getContactPolicyRequest * @return Result of the GetContactPolicy operation returned by the service. * @throws AccessDeniedException * You don't have sufficient access to perform this operation. * @throws InternalServerException * Unexpected error occurred while processing the request. * @throws ResourceNotFoundException * Request references a resource that doesn't exist. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ValidationException * The input fails to satisfy the constraints specified by an Amazon Web Services service. * @sample AWSSSMContacts.GetContactPolicy * @see AWS * API Documentation */ GetContactPolicyResult getContactPolicy(GetContactPolicyRequest getContactPolicyRequest); /** *

* Retrieves information about an on-call rotation. *

* * @param getRotationRequest * @return Result of the GetRotation operation returned by the service. * @throws AccessDeniedException * You don't have sufficient access to perform this operation. * @throws InternalServerException * Unexpected error occurred while processing the request. * @throws ResourceNotFoundException * Request references a resource that doesn't exist. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ValidationException * The input fails to satisfy the constraints specified by an Amazon Web Services service. * @sample AWSSSMContacts.GetRotation * @see AWS API * Documentation */ GetRotationResult getRotation(GetRotationRequest getRotationRequest); /** *

* Retrieves information about an override to an on-call rotation. *

* * @param getRotationOverrideRequest * @return Result of the GetRotationOverride operation returned by the service. * @throws AccessDeniedException * You don't have sufficient access to perform this operation. * @throws InternalServerException * Unexpected error occurred while processing the request. * @throws ResourceNotFoundException * Request references a resource that doesn't exist. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ValidationException * The input fails to satisfy the constraints specified by an Amazon Web Services service. * @sample AWSSSMContacts.GetRotationOverride * @see AWS API Documentation */ GetRotationOverrideResult getRotationOverride(GetRotationOverrideRequest getRotationOverrideRequest); /** *

* Lists all contact channels for the specified contact. *

* * @param listContactChannelsRequest * @return Result of the ListContactChannels operation returned by the service. * @throws AccessDeniedException * You don't have sufficient access to perform this operation. * @throws DataEncryptionException * The operation failed to due an encryption key error. * @throws InternalServerException * Unexpected error occurred while processing the request. * @throws ResourceNotFoundException * Request references a resource that doesn't exist. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ValidationException * The input fails to satisfy the constraints specified by an Amazon Web Services service. * @sample AWSSSMContacts.ListContactChannels * @see AWS API Documentation */ ListContactChannelsResult listContactChannels(ListContactChannelsRequest listContactChannelsRequest); /** *

* Lists all contacts and escalation plans in Incident Manager. *

* * @param listContactsRequest * @return Result of the ListContacts operation returned by the service. * @throws AccessDeniedException * You don't have sufficient access to perform this operation. * @throws InternalServerException * Unexpected error occurred while processing the request. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ValidationException * The input fails to satisfy the constraints specified by an Amazon Web Services service. * @sample AWSSSMContacts.ListContacts * @see AWS API * Documentation */ ListContactsResult listContacts(ListContactsRequest listContactsRequest); /** *

* Lists all engagements that have happened in an incident. *

* * @param listEngagementsRequest * @return Result of the ListEngagements operation returned by the service. * @throws AccessDeniedException * You don't have sufficient access to perform this operation. * @throws InternalServerException * Unexpected error occurred while processing the request. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ValidationException * The input fails to satisfy the constraints specified by an Amazon Web Services service. * @sample AWSSSMContacts.ListEngagements * @see AWS * API Documentation */ ListEngagementsResult listEngagements(ListEngagementsRequest listEngagementsRequest); /** *

* Lists all of the engagements to contact channels that have been acknowledged. *

* * @param listPageReceiptsRequest * @return Result of the ListPageReceipts operation returned by the service. * @throws AccessDeniedException * You don't have sufficient access to perform this operation. * @throws InternalServerException * Unexpected error occurred while processing the request. * @throws ResourceNotFoundException * Request references a resource that doesn't exist. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ValidationException * The input fails to satisfy the constraints specified by an Amazon Web Services service. * @sample AWSSSMContacts.ListPageReceipts * @see AWS * API Documentation */ ListPageReceiptsResult listPageReceipts(ListPageReceiptsRequest listPageReceiptsRequest); /** *

* 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 Result of the ListPageResolutions operation returned by the service. * @throws AccessDeniedException * You don't have sufficient access to perform this operation. * @throws InternalServerException * Unexpected error occurred while processing the request. * @throws ResourceNotFoundException * Request references a resource that doesn't exist. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ValidationException * The input fails to satisfy the constraints specified by an Amazon Web Services service. * @sample AWSSSMContacts.ListPageResolutions * @see AWS API Documentation */ ListPageResolutionsResult listPageResolutions(ListPageResolutionsRequest listPageResolutionsRequest); /** *

* Lists the engagements to a contact's contact channels. *

* * @param listPagesByContactRequest * @return Result of the ListPagesByContact operation returned by the service. * @throws AccessDeniedException * You don't have sufficient access to perform this operation. * @throws InternalServerException * Unexpected error occurred while processing the request. * @throws ResourceNotFoundException * Request references a resource that doesn't exist. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ValidationException * The input fails to satisfy the constraints specified by an Amazon Web Services service. * @sample AWSSSMContacts.ListPagesByContact * @see AWS API Documentation */ ListPagesByContactResult listPagesByContact(ListPagesByContactRequest listPagesByContactRequest); /** *

* Lists the engagements to contact channels that occurred by engaging a contact. *

* * @param listPagesByEngagementRequest * @return Result of the ListPagesByEngagement operation returned by the service. * @throws AccessDeniedException * You don't have sufficient access to perform this operation. * @throws InternalServerException * Unexpected error occurred while processing the request. * @throws ResourceNotFoundException * Request references a resource that doesn't exist. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ValidationException * The input fails to satisfy the constraints specified by an Amazon Web Services service. * @sample AWSSSMContacts.ListPagesByEngagement * @see AWS API Documentation */ ListPagesByEngagementResult listPagesByEngagement(ListPagesByEngagementRequest listPagesByEngagementRequest); /** *

* 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 Result of the ListPreviewRotationShifts operation returned by the service. * @throws AccessDeniedException * You don't have sufficient access to perform this operation. * @throws InternalServerException * Unexpected error occurred while processing the request. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ValidationException * The input fails to satisfy the constraints specified by an Amazon Web Services service. * @sample AWSSSMContacts.ListPreviewRotationShifts * @see AWS API Documentation */ ListPreviewRotationShiftsResult listPreviewRotationShifts(ListPreviewRotationShiftsRequest listPreviewRotationShiftsRequest); /** *

* Retrieves a list of overrides currently specified for an on-call rotation. *

* * @param listRotationOverridesRequest * @return Result of the ListRotationOverrides operation returned by the service. * @throws AccessDeniedException * You don't have sufficient access to perform this operation. * @throws InternalServerException * Unexpected error occurred while processing the request. * @throws ResourceNotFoundException * Request references a resource that doesn't exist. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ValidationException * The input fails to satisfy the constraints specified by an Amazon Web Services service. * @sample AWSSSMContacts.ListRotationOverrides * @see AWS API Documentation */ ListRotationOverridesResult listRotationOverrides(ListRotationOverridesRequest listRotationOverridesRequest); /** *

* Returns a list of shifts generated by an existing rotation in the system. *

* * @param listRotationShiftsRequest * @return Result of the ListRotationShifts operation returned by the service. * @throws AccessDeniedException * You don't have sufficient access to perform this operation. * @throws ConflictException * Updating or deleting a resource causes an inconsistent state. * @throws InternalServerException * Unexpected error occurred while processing the request. * @throws ResourceNotFoundException * Request references a resource that doesn't exist. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ValidationException * The input fails to satisfy the constraints specified by an Amazon Web Services service. * @sample AWSSSMContacts.ListRotationShifts * @see AWS API Documentation */ ListRotationShiftsResult listRotationShifts(ListRotationShiftsRequest listRotationShiftsRequest); /** *

* Retrieves a list of on-call rotations. *

* * @param listRotationsRequest * @return Result of the ListRotations operation returned by the service. * @throws AccessDeniedException * You don't have sufficient access to perform this operation. * @throws InternalServerException * Unexpected error occurred while processing the request. * @throws ResourceNotFoundException * Request references a resource that doesn't exist. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ValidationException * The input fails to satisfy the constraints specified by an Amazon Web Services service. * @sample AWSSSMContacts.ListRotations * @see AWS API * Documentation */ ListRotationsResult listRotations(ListRotationsRequest listRotationsRequest); /** *

* Lists the tags of an escalation plan or contact. *

* * @param listTagsForResourceRequest * @return Result of the ListTagsForResource operation returned by the service. * @throws AccessDeniedException * You don't have sufficient access to perform this operation. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ResourceNotFoundException * Request references a resource that doesn't exist. * @throws ValidationException * The input fails to satisfy the constraints specified by an Amazon Web Services service. * @throws InternalServerException * Unexpected error occurred while processing the request. * @sample AWSSSMContacts.ListTagsForResource * @see AWS API Documentation */ ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest); /** *

* 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 Result of the PutContactPolicy operation returned by the service. * @throws AccessDeniedException * You don't have sufficient access to perform this operation. * @throws ConflictException * Updating or deleting a resource causes an inconsistent state. * @throws ValidationException * The input fails to satisfy the constraints specified by an Amazon Web Services service. * @throws ResourceNotFoundException * Request references a resource that doesn't exist. * @throws ThrottlingException * The request was denied due to request throttling. * @throws InternalServerException * Unexpected error occurred while processing the request. * @sample AWSSSMContacts.PutContactPolicy * @see AWS * API Documentation */ PutContactPolicyResult putContactPolicy(PutContactPolicyRequest putContactPolicyRequest); /** *

* 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 Result of the SendActivationCode operation returned by the service. * @throws AccessDeniedException * You don't have sufficient access to perform this operation. * @throws DataEncryptionException * The operation failed to due an encryption key error. * @throws InternalServerException * Unexpected error occurred while processing the request. * @throws ResourceNotFoundException * Request references a resource that doesn't exist. * @throws ServiceQuotaExceededException * Request would cause a service quota to be exceeded. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ValidationException * The input fails to satisfy the constraints specified by an Amazon Web Services service. * @sample AWSSSMContacts.SendActivationCode * @see AWS API Documentation */ SendActivationCodeResult sendActivationCode(SendActivationCodeRequest sendActivationCodeRequest); /** *

* Starts an engagement to a contact or escalation plan. The engagement engages each contact specified in the * incident. *

* * @param startEngagementRequest * @return Result of the StartEngagement operation returned by the service. * @throws AccessDeniedException * You don't have sufficient access to perform this operation. * @throws DataEncryptionException * The operation failed to due an encryption key error. * @throws InternalServerException * Unexpected error occurred while processing the request. * @throws ResourceNotFoundException * Request references a resource that doesn't exist. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ValidationException * The input fails to satisfy the constraints specified by an Amazon Web Services service. * @sample AWSSSMContacts.StartEngagement * @see AWS * API Documentation */ StartEngagementResult startEngagement(StartEngagementRequest startEngagementRequest); /** *

* Stops an engagement before it finishes the final stage of the escalation plan or engagement plan. Further * contacts aren't engaged. *

* * @param stopEngagementRequest * @return Result of the StopEngagement operation returned by the service. * @throws AccessDeniedException * You don't have sufficient access to perform this operation. * @throws ValidationException * The input fails to satisfy the constraints specified by an Amazon Web Services service. * @throws ResourceNotFoundException * Request references a resource that doesn't exist. * @throws ThrottlingException * The request was denied due to request throttling. * @throws InternalServerException * Unexpected error occurred while processing the request. * @sample AWSSSMContacts.StopEngagement * @see AWS * API Documentation */ StopEngagementResult stopEngagement(StopEngagementRequest stopEngagementRequest); /** *

* 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 Result of the TagResource operation returned by the service. * @throws AccessDeniedException * You don't have sufficient access to perform this operation. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ResourceNotFoundException * Request references a resource that doesn't exist. * @throws InternalServerException * Unexpected error occurred while processing the request. * @throws ServiceQuotaExceededException * Request would cause a service quota to be exceeded. * @throws ValidationException * The input fails to satisfy the constraints specified by an Amazon Web Services service. * @sample AWSSSMContacts.TagResource * @see AWS API * Documentation */ TagResourceResult tagResource(TagResourceRequest tagResourceRequest); /** *

* Removes tags from the specified resource. *

* * @param untagResourceRequest * @return Result of the UntagResource operation returned by the service. * @throws AccessDeniedException * You don't have sufficient access to perform this operation. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ResourceNotFoundException * Request references a resource that doesn't exist. * @throws ValidationException * The input fails to satisfy the constraints specified by an Amazon Web Services service. * @throws InternalServerException * Unexpected error occurred while processing the request. * @sample AWSSSMContacts.UntagResource * @see AWS API * Documentation */ UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest); /** *

* Updates the contact or escalation plan specified. *

* * @param updateContactRequest * @return Result of the UpdateContact operation returned by the service. * @throws AccessDeniedException * You don't have sufficient access to perform this operation. * @throws InternalServerException * Unexpected error occurred while processing the request. * @throws ResourceNotFoundException * Request references a resource that doesn't exist. * @throws ServiceQuotaExceededException * Request would cause a service quota to be exceeded. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ValidationException * The input fails to satisfy the constraints specified by an Amazon Web Services service. * @throws DataEncryptionException * The operation failed to due an encryption key error. * @sample AWSSSMContacts.UpdateContact * @see AWS API * Documentation */ UpdateContactResult updateContact(UpdateContactRequest updateContactRequest); /** *

* Updates a contact's contact channel. *

* * @param updateContactChannelRequest * @return Result of the UpdateContactChannel operation returned by the service. * @throws AccessDeniedException * You don't have sufficient access to perform this operation. * @throws ConflictException * Updating or deleting a resource causes an inconsistent state. * @throws DataEncryptionException * The operation failed to due an encryption key error. * @throws InternalServerException * Unexpected error occurred while processing the request. * @throws ResourceNotFoundException * Request references a resource that doesn't exist. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ValidationException * The input fails to satisfy the constraints specified by an Amazon Web Services service. * @sample AWSSSMContacts.UpdateContactChannel * @see AWS API Documentation */ UpdateContactChannelResult updateContactChannel(UpdateContactChannelRequest updateContactChannelRequest); /** *

* Updates the information specified for an on-call rotation. *

* * @param updateRotationRequest * @return Result of the UpdateRotation operation returned by the service. * @throws AccessDeniedException * You don't have sufficient access to perform this operation. * @throws ConflictException * Updating or deleting a resource causes an inconsistent state. * @throws InternalServerException * Unexpected error occurred while processing the request. * @throws ResourceNotFoundException * Request references a resource that doesn't exist. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ValidationException * The input fails to satisfy the constraints specified by an Amazon Web Services service. * @sample AWSSSMContacts.UpdateRotation * @see AWS * API Documentation */ UpdateRotationResult updateRotation(UpdateRotationRequest updateRotationRequest); /** * Shuts down this client object, releasing any resources that might be held open. This is an optional method, and * callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client * has been shutdown, it should not be used to make any more requests. */ void shutdown(); /** * Returns additional metadata for a previously executed successful request, typically used for debugging issues * where a service isn't acting as expected. This data isn't considered part of the result data returned by an * operation, so it's available through this separate, diagnostic interface. *

* Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic * information for an executed request, you should use this method to retrieve it as soon as possible after * executing a request. * * @param request * The originally executed request. * * @return The response metadata for the specified request, or null if none is available. */ ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request); }