com.amazonaws.services.ssmcontacts

Interface AWSSSMContacts

All Known Subinterfaces:

AWSSSMContactsAsync

All Known Implementing Classes:

AbstractAWSSSMContacts, AbstractAWSSSMContactsAsync, AWSSSMContactsAsyncClient, AWSSSMContactsClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSSSMContacts

Interface for accessing SSM Contacts.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from 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.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
AcceptPageResult	acceptPage(AcceptPageRequest acceptPageRequest) Used to acknowledge an engagement to a contact channel during an incident.
ActivateContactChannelResult	activateContactChannel(ActivateContactChannelRequest activateContactChannelRequest) Activates a contact's contact channel.
CreateContactResult	createContact(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.
CreateContactChannelResult	createContactChannel(CreateContactChannelRequest createContactChannelRequest) A contact channel is the method that Incident Manager uses to engage your contact.
CreateRotationResult	createRotation(CreateRotationRequest createRotationRequest) Creates a rotation in an on-call schedule.
CreateRotationOverrideResult	createRotationOverride(CreateRotationOverrideRequest createRotationOverrideRequest) Creates an override for a rotation in an on-call schedule.
DeactivateContactChannelResult	deactivateContactChannel(DeactivateContactChannelRequest deactivateContactChannelRequest) To no longer receive Incident Manager engagements to a contact channel, you can deactivate the channel.
DeleteContactResult	deleteContact(DeleteContactRequest deleteContactRequest) To remove a contact from Incident Manager, you can delete the contact.
DeleteContactChannelResult	deleteContactChannel(DeleteContactChannelRequest deleteContactChannelRequest) To no longer receive engagements on a contact channel, you can delete the channel from a contact.
DeleteRotationResult	deleteRotation(DeleteRotationRequest deleteRotationRequest) Deletes a rotation from the system.
DeleteRotationOverrideResult	deleteRotationOverride(DeleteRotationOverrideRequest deleteRotationOverrideRequest) Deletes an existing override for an on-call rotation.
DescribeEngagementResult	describeEngagement(DescribeEngagementRequest describeEngagementRequest) Incident Manager uses engagements to engage contacts and escalation plans during an incident.
DescribePageResult	describePage(DescribePageRequest describePageRequest) Lists details of the engagement to a contact channel.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
GetContactResult	getContact(GetContactRequest getContactRequest) Retrieves information about the specified contact or escalation plan.
GetContactChannelResult	getContactChannel(GetContactChannelRequest getContactChannelRequest) List details about a specific contact channel.
GetContactPolicyResult	getContactPolicy(GetContactPolicyRequest getContactPolicyRequest) Retrieves the resource policies attached to the specified contact or escalation plan.
GetRotationResult	getRotation(GetRotationRequest getRotationRequest) Retrieves information about an on-call rotation.
GetRotationOverrideResult	getRotationOverride(GetRotationOverrideRequest getRotationOverrideRequest) Retrieves information about an override to an on-call rotation.
ListContactChannelsResult	listContactChannels(ListContactChannelsRequest listContactChannelsRequest) Lists all contact channels for the specified contact.
ListContactsResult	listContacts(ListContactsRequest listContactsRequest) Lists all contacts and escalation plans in Incident Manager.
ListEngagementsResult	listEngagements(ListEngagementsRequest listEngagementsRequest) Lists all engagements that have happened in an incident.
ListPageReceiptsResult	listPageReceipts(ListPageReceiptsRequest listPageReceiptsRequest) Lists all of the engagements to contact channels that have been acknowledged.
ListPageResolutionsResult	listPageResolutions(ListPageResolutionsRequest listPageResolutionsRequest) Returns the resolution path of an engagement.
ListPagesByContactResult	listPagesByContact(ListPagesByContactRequest listPagesByContactRequest) Lists the engagements to a contact's contact channels.
ListPagesByEngagementResult	listPagesByEngagement(ListPagesByEngagementRequest listPagesByEngagementRequest) Lists the engagements to contact channels that occurred by engaging a contact.
ListPreviewRotationShiftsResult	listPreviewRotationShifts(ListPreviewRotationShiftsRequest listPreviewRotationShiftsRequest) Returns a list of shifts based on rotation configuration parameters.
ListRotationOverridesResult	listRotationOverrides(ListRotationOverridesRequest listRotationOverridesRequest) Retrieves a list of overrides currently specified for an on-call rotation.
ListRotationsResult	listRotations(ListRotationsRequest listRotationsRequest) Retrieves a list of on-call rotations.
ListRotationShiftsResult	listRotationShifts(ListRotationShiftsRequest listRotationShiftsRequest) Returns a list of shifts generated by an existing rotation in the system.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags of an escalation plan or contact.
PutContactPolicyResult	putContactPolicy(PutContactPolicyRequest putContactPolicyRequest) Adds a resource policy to the specified contact or escalation plan.
SendActivationCodeResult	sendActivationCode(SendActivationCodeRequest sendActivationCodeRequest) Sends an activation code to a contact channel.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartEngagementResult	startEngagement(StartEngagementRequest startEngagementRequest) Starts an engagement to a contact or escalation plan.
StopEngagementResult	stopEngagement(StopEngagementRequest stopEngagementRequest) Stops an engagement before it finishes the final stage of the escalation plan or engagement plan.
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) Tags a contact or escalation plan.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Removes tags from the specified resource.
UpdateContactResult	updateContact(UpdateContactRequest updateContactRequest) Updates the contact or escalation plan specified.
UpdateContactChannelResult	updateContactChannel(UpdateContactChannelRequest updateContactChannelRequest) Updates a contact's contact channel.
UpdateRotationResult	updateRotation(UpdateRotationRequest updateRotationRequest) Updates the information specified for an on-call rotation.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

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 Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

acceptPage

AcceptPageResult acceptPage(AcceptPageRequest acceptPageRequest)

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

Parameters:

acceptPageRequest -

Returns:

Result of the AcceptPage operation returned by the service.

Throws:

AccessDeniedException - You don't have sufficient access to perform this operation.

InternalServerException - Unexpected error occurred while processing the request.

ResourceNotFoundException - Request references a resource that doesn't exist.

ThrottlingException - The request was denied due to request throttling.

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

See Also:

AWS API Documentation

activateContactChannel

ActivateContactChannelResult activateContactChannel(ActivateContactChannelRequest activateContactChannelRequest)

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

Parameters:

activateContactChannelRequest -

Returns:

Result of the ActivateContactChannel operation returned by the service.

Throws:

AccessDeniedException - You don't have sufficient access to perform this operation.

InternalServerException - Unexpected error occurred while processing the request.

ResourceNotFoundException - Request references a resource that doesn't exist.

ThrottlingException - The request was denied due to request throttling.

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

See Also:

AWS API Documentation

createContact

CreateContactResult createContact(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.

Parameters:

createContactRequest -

Returns:

Result of the CreateContact operation returned by the service.

Throws:

AccessDeniedException - You don't have sufficient access to perform this operation.

ConflictException - Updating or deleting a resource causes an inconsistent state.

InternalServerException - Unexpected error occurred while processing the request.

ServiceQuotaExceededException - Request would cause a service quota to be exceeded.

ThrottlingException - The request was denied due to request throttling.

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

DataEncryptionException - The operation failed to due an encryption key error.

See Also:

AWS API Documentation

createContactChannel

CreateContactChannelResult createContactChannel(CreateContactChannelRequest createContactChannelRequest)

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

Parameters:

createContactChannelRequest -

Returns:

Result of the CreateContactChannel operation returned by the service.

Throws:

AccessDeniedException - You don't have sufficient access to perform this operation.

ConflictException - Updating or deleting a resource causes an inconsistent state.

DataEncryptionException - The operation failed to due an encryption key error.

InternalServerException - Unexpected error occurred while processing the request.

ThrottlingException - The request was denied due to request throttling.

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

See Also:

AWS API Documentation

createRotation

CreateRotationResult createRotation(CreateRotationRequest createRotationRequest)

Creates a rotation in an on-call schedule.

Parameters:

createRotationRequest -

Returns:

Result of the CreateRotation operation returned by the service.

Throws:

AccessDeniedException - You don't have sufficient access to perform this operation.

InternalServerException - Unexpected error occurred while processing the request.

ResourceNotFoundException - Request references a resource that doesn't exist.

ServiceQuotaExceededException - Request would cause a service quota to be exceeded.

ThrottlingException - The request was denied due to request throttling.

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

See Also:

AWS API Documentation

createRotationOverride

CreateRotationOverrideResult createRotationOverride(CreateRotationOverrideRequest createRotationOverrideRequest)

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

Parameters:

createRotationOverrideRequest -

Returns:

Result of the CreateRotationOverride operation returned by the service.

Throws:

AccessDeniedException - You don't have sufficient access to perform this operation.

InternalServerException - Unexpected error occurred while processing the request.

ResourceNotFoundException - Request references a resource that doesn't exist.

ServiceQuotaExceededException - Request would cause a service quota to be exceeded.

ThrottlingException - The request was denied due to request throttling.

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

See Also:

AWS API Documentation

deactivateContactChannel

DeactivateContactChannelResult deactivateContactChannel(DeactivateContactChannelRequest deactivateContactChannelRequest)

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

Parameters:

deactivateContactChannelRequest -

Returns:

Result of the DeactivateContactChannel operation returned by the service.

Throws:

AccessDeniedException - You don't have sufficient access to perform this operation.

InternalServerException - Unexpected error occurred while processing the request.

ResourceNotFoundException - Request references a resource that doesn't exist.

ThrottlingException - The request was denied due to request throttling.

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

See Also:

AWS API Documentation

deleteContact

DeleteContactResult deleteContact(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.

Parameters:

deleteContactRequest -

Returns:

Result of the DeleteContact operation returned by the service.

Throws:

AccessDeniedException - You don't have sufficient access to perform this operation.

InternalServerException - Unexpected error occurred while processing the request.

ResourceNotFoundException - Request references a resource that doesn't exist.

ThrottlingException - The request was denied due to request throttling.

ConflictException - Updating or deleting a resource causes an inconsistent state.

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

See Also:

AWS API Documentation

deleteContactChannel

DeleteContactChannelResult deleteContactChannel(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.

Parameters:

deleteContactChannelRequest -

Returns:

Result of the DeleteContactChannel operation returned by the service.

Throws:

AccessDeniedException - You don't have sufficient access to perform this operation.

InternalServerException - Unexpected error occurred while processing the request.

ResourceNotFoundException - Request references a resource that doesn't exist.

ThrottlingException - The request was denied due to request throttling.

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

See Also:

AWS API Documentation

deleteRotation

DeleteRotationResult deleteRotation(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.

Parameters:

deleteRotationRequest -

Returns:

Result of the DeleteRotation operation returned by the service.

Throws:

AccessDeniedException - You don't have sufficient access to perform this operation.

ConflictException - Updating or deleting a resource causes an inconsistent state.

InternalServerException - Unexpected error occurred while processing the request.

ResourceNotFoundException - Request references a resource that doesn't exist.

ThrottlingException - The request was denied due to request throttling.

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

See Also:

AWS API Documentation

deleteRotationOverride

DeleteRotationOverrideResult deleteRotationOverride(DeleteRotationOverrideRequest deleteRotationOverrideRequest)

Deletes an existing override for an on-call rotation.

Parameters:

deleteRotationOverrideRequest -

Returns:

Result of the DeleteRotationOverride operation returned by the service.

Throws:

AccessDeniedException - You don't have sufficient access to perform this operation.

InternalServerException - Unexpected error occurred while processing the request.

ResourceNotFoundException - Request references a resource that doesn't exist.

ThrottlingException - The request was denied due to request throttling.

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

See Also:

AWS API Documentation

describeEngagement

DescribeEngagementResult describeEngagement(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.

Parameters:

describeEngagementRequest -

Returns:

Result of the DescribeEngagement operation returned by the service.

Throws:

AccessDeniedException - You don't have sufficient access to perform this operation.

DataEncryptionException - The operation failed to due an encryption key error.

InternalServerException - Unexpected error occurred while processing the request.

ResourceNotFoundException - Request references a resource that doesn't exist.

ThrottlingException - The request was denied due to request throttling.

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

See Also:

AWS API Documentation

describePage

DescribePageResult describePage(DescribePageRequest describePageRequest)

Lists details of the engagement to a contact channel.

Parameters:

describePageRequest -

Returns:

Result of the DescribePage operation returned by the service.

Throws:

AccessDeniedException - You don't have sufficient access to perform this operation.

DataEncryptionException - The operation failed to due an encryption key error.

InternalServerException - Unexpected error occurred while processing the request.

ResourceNotFoundException - Request references a resource that doesn't exist.

ThrottlingException - The request was denied due to request throttling.

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

See Also:

AWS API Documentation

getContact

GetContactResult getContact(GetContactRequest getContactRequest)

Retrieves information about the specified contact or escalation plan.

Parameters:

getContactRequest -

Returns:

Result of the GetContact operation returned by the service.

Throws:

AccessDeniedException - You don't have sufficient access to perform this operation.

InternalServerException - Unexpected error occurred while processing the request.

ResourceNotFoundException - Request references a resource that doesn't exist.

ThrottlingException - The request was denied due to request throttling.

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

DataEncryptionException - The operation failed to due an encryption key error.

See Also:

AWS API Documentation

getContactChannel

GetContactChannelResult getContactChannel(GetContactChannelRequest getContactChannelRequest)

List details about a specific contact channel.

Parameters:

getContactChannelRequest -

Returns:

Result of the GetContactChannel operation returned by the service.

Throws:

AccessDeniedException - You don't have sufficient access to perform this operation.

DataEncryptionException - The operation failed to due an encryption key error.

InternalServerException - Unexpected error occurred while processing the request.

ResourceNotFoundException - Request references a resource that doesn't exist.

ThrottlingException - The request was denied due to request throttling.

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

See Also:

AWS API Documentation

getContactPolicy

GetContactPolicyResult getContactPolicy(GetContactPolicyRequest getContactPolicyRequest)

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

Parameters:

getContactPolicyRequest -

Returns:

Result of the GetContactPolicy operation returned by the service.

Throws:

AccessDeniedException - You don't have sufficient access to perform this operation.

InternalServerException - Unexpected error occurred while processing the request.

ResourceNotFoundException - Request references a resource that doesn't exist.

ThrottlingException - The request was denied due to request throttling.

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

See Also:

AWS API Documentation

getRotation

GetRotationResult getRotation(GetRotationRequest getRotationRequest)

Retrieves information about an on-call rotation.

Parameters:

getRotationRequest -

Returns:

Result of the GetRotation operation returned by the service.

Throws:

AccessDeniedException - You don't have sufficient access to perform this operation.

InternalServerException - Unexpected error occurred while processing the request.

ResourceNotFoundException - Request references a resource that doesn't exist.

ThrottlingException - The request was denied due to request throttling.

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

See Also:

AWS API Documentation

getRotationOverride

GetRotationOverrideResult getRotationOverride(GetRotationOverrideRequest getRotationOverrideRequest)

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

Parameters:

getRotationOverrideRequest -

Returns:

Result of the GetRotationOverride operation returned by the service.

Throws:

AccessDeniedException - You don't have sufficient access to perform this operation.

InternalServerException - Unexpected error occurred while processing the request.

ResourceNotFoundException - Request references a resource that doesn't exist.

ThrottlingException - The request was denied due to request throttling.

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

See Also:

AWS API Documentation

listContactChannels

ListContactChannelsResult listContactChannels(ListContactChannelsRequest listContactChannelsRequest)

Lists all contact channels for the specified contact.

Parameters:

listContactChannelsRequest -

Returns:

Result of the ListContactChannels operation returned by the service.

Throws:

AccessDeniedException - You don't have sufficient access to perform this operation.

DataEncryptionException - The operation failed to due an encryption key error.

InternalServerException - Unexpected error occurred while processing the request.

ResourceNotFoundException - Request references a resource that doesn't exist.

ThrottlingException - The request was denied due to request throttling.

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

See Also:

AWS API Documentation

listContacts

ListContactsResult listContacts(ListContactsRequest listContactsRequest)

Lists all contacts and escalation plans in Incident Manager.

Parameters:

listContactsRequest -

Returns:

Result of the ListContacts operation returned by the service.

Throws:

AccessDeniedException - You don't have sufficient access to perform this operation.

InternalServerException - Unexpected error occurred while processing the request.

ThrottlingException - The request was denied due to request throttling.

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

See Also:

AWS API Documentation

listEngagements

ListEngagementsResult listEngagements(ListEngagementsRequest listEngagementsRequest)

Lists all engagements that have happened in an incident.

Parameters:

listEngagementsRequest -

Returns:

Result of the ListEngagements operation returned by the service.

Throws:

AccessDeniedException - You don't have sufficient access to perform this operation.

InternalServerException - Unexpected error occurred while processing the request.

ThrottlingException - The request was denied due to request throttling.

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

See Also:

AWS API Documentation

listPageReceipts

ListPageReceiptsResult listPageReceipts(ListPageReceiptsRequest listPageReceiptsRequest)

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

Parameters:

listPageReceiptsRequest -

Returns:

Result of the ListPageReceipts operation returned by the service.

Throws:

AccessDeniedException - You don't have sufficient access to perform this operation.

InternalServerException - Unexpected error occurred while processing the request.

ResourceNotFoundException - Request references a resource that doesn't exist.

ThrottlingException - The request was denied due to request throttling.

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

See Also:

AWS API Documentation

listPageResolutions

ListPageResolutionsResult listPageResolutions(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.

Parameters:

listPageResolutionsRequest -

Returns:

Result of the ListPageResolutions operation returned by the service.

Throws:

AccessDeniedException - You don't have sufficient access to perform this operation.

InternalServerException - Unexpected error occurred while processing the request.

ResourceNotFoundException - Request references a resource that doesn't exist.

ThrottlingException - The request was denied due to request throttling.

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

See Also:

AWS API Documentation

listPagesByContact

ListPagesByContactResult listPagesByContact(ListPagesByContactRequest listPagesByContactRequest)

Lists the engagements to a contact's contact channels.

Parameters:

listPagesByContactRequest -

Returns:

Result of the ListPagesByContact operation returned by the service.

Throws:

AccessDeniedException - You don't have sufficient access to perform this operation.

InternalServerException - Unexpected error occurred while processing the request.

ResourceNotFoundException - Request references a resource that doesn't exist.

ThrottlingException - The request was denied due to request throttling.

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

See Also:

AWS API Documentation

listPagesByEngagement

ListPagesByEngagementResult listPagesByEngagement(ListPagesByEngagementRequest listPagesByEngagementRequest)

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

Parameters:

listPagesByEngagementRequest -

Returns:

Result of the ListPagesByEngagement operation returned by the service.

Throws:

AccessDeniedException - You don't have sufficient access to perform this operation.

InternalServerException - Unexpected error occurred while processing the request.

ResourceNotFoundException - Request references a resource that doesn't exist.

ThrottlingException - The request was denied due to request throttling.

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

See Also:

AWS API Documentation

listPreviewRotationShifts

ListPreviewRotationShiftsResult listPreviewRotationShifts(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.

Parameters:

listPreviewRotationShiftsRequest -

Returns:

Result of the ListPreviewRotationShifts operation returned by the service.

Throws:

AccessDeniedException - You don't have sufficient access to perform this operation.

InternalServerException - Unexpected error occurred while processing the request.

ThrottlingException - The request was denied due to request throttling.

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

See Also:

AWS API Documentation

listRotationOverrides

ListRotationOverridesResult listRotationOverrides(ListRotationOverridesRequest listRotationOverridesRequest)

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

Parameters:

listRotationOverridesRequest -

Returns:

Result of the ListRotationOverrides operation returned by the service.

Throws:

AccessDeniedException - You don't have sufficient access to perform this operation.

InternalServerException - Unexpected error occurred while processing the request.

ResourceNotFoundException - Request references a resource that doesn't exist.

ThrottlingException - The request was denied due to request throttling.

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

See Also:

AWS API Documentation

listRotationShifts

ListRotationShiftsResult listRotationShifts(ListRotationShiftsRequest listRotationShiftsRequest)

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

Parameters:

listRotationShiftsRequest -

Returns:

Result of the ListRotationShifts operation returned by the service.

Throws:

AccessDeniedException - You don't have sufficient access to perform this operation.

ConflictException - Updating or deleting a resource causes an inconsistent state.

InternalServerException - Unexpected error occurred while processing the request.

ResourceNotFoundException - Request references a resource that doesn't exist.

ThrottlingException - The request was denied due to request throttling.

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

See Also:

AWS API Documentation

listRotations

ListRotationsResult listRotations(ListRotationsRequest listRotationsRequest)

Retrieves a list of on-call rotations.

Parameters:

listRotationsRequest -

Returns:

Result of the ListRotations operation returned by the service.

Throws:

AccessDeniedException - You don't have sufficient access to perform this operation.

InternalServerException - Unexpected error occurred while processing the request.

ResourceNotFoundException - Request references a resource that doesn't exist.

ThrottlingException - The request was denied due to request throttling.

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

See Also:

AWS API Documentation

listTagsForResource

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

Lists the tags of an escalation plan or contact.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

AccessDeniedException - You don't have sufficient access to perform this operation.

ThrottlingException - The request was denied due to request throttling.

ResourceNotFoundException - Request references a resource that doesn't exist.

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException - Unexpected error occurred while processing the request.

See Also:

AWS API Documentation

putContactPolicy

PutContactPolicyResult putContactPolicy(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.

Parameters:

putContactPolicyRequest -

Returns:

Result of the PutContactPolicy operation returned by the service.

Throws:

AccessDeniedException - You don't have sufficient access to perform this operation.

ConflictException - Updating or deleting a resource causes an inconsistent state.

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

ResourceNotFoundException - Request references a resource that doesn't exist.

ThrottlingException - The request was denied due to request throttling.

InternalServerException - Unexpected error occurred while processing the request.

See Also:

AWS API Documentation

sendActivationCode

SendActivationCodeResult sendActivationCode(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.

Parameters:

sendActivationCodeRequest -

Returns:

Result of the SendActivationCode operation returned by the service.

Throws:

AccessDeniedException - You don't have sufficient access to perform this operation.

DataEncryptionException - The operation failed to due an encryption key error.

InternalServerException - Unexpected error occurred while processing the request.

ResourceNotFoundException - Request references a resource that doesn't exist.

ServiceQuotaExceededException - Request would cause a service quota to be exceeded.

ThrottlingException - The request was denied due to request throttling.

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

See Also:

AWS API Documentation

startEngagement

StartEngagementResult startEngagement(StartEngagementRequest startEngagementRequest)

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

Parameters:

startEngagementRequest -

Returns:

Result of the StartEngagement operation returned by the service.

Throws:

AccessDeniedException - You don't have sufficient access to perform this operation.

DataEncryptionException - The operation failed to due an encryption key error.

InternalServerException - Unexpected error occurred while processing the request.

ResourceNotFoundException - Request references a resource that doesn't exist.

ThrottlingException - The request was denied due to request throttling.

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

See Also:

AWS API Documentation

stopEngagement

StopEngagementResult stopEngagement(StopEngagementRequest stopEngagementRequest)

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

Parameters:

stopEngagementRequest -

Returns:

Result of the StopEngagement operation returned by the service.

Throws:

AccessDeniedException - You don't have sufficient access to perform this operation.

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

ResourceNotFoundException - Request references a resource that doesn't exist.

ThrottlingException - The request was denied due to request throttling.

InternalServerException - Unexpected error occurred while processing the request.

See Also:

AWS API Documentation

tagResource

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

Tags a contact or escalation plan. You can tag only contacts and escalation plans in the first region of your replication set.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

AccessDeniedException - You don't have sufficient access to perform this operation.

ThrottlingException - The request was denied due to request throttling.

ResourceNotFoundException - Request references a resource that doesn't exist.

InternalServerException - Unexpected error occurred while processing the request.

ServiceQuotaExceededException - Request would cause a service quota to be exceeded.

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

See Also:

AWS API Documentation

untagResource

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

Removes tags from the specified resource.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

AccessDeniedException - You don't have sufficient access to perform this operation.

ThrottlingException - The request was denied due to request throttling.

ResourceNotFoundException - Request references a resource that doesn't exist.

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException - Unexpected error occurred while processing the request.

See Also:

AWS API Documentation

updateContact

UpdateContactResult updateContact(UpdateContactRequest updateContactRequest)

Updates the contact or escalation plan specified.

Parameters:

updateContactRequest -

Returns:

Result of the UpdateContact operation returned by the service.

Throws:

AccessDeniedException - You don't have sufficient access to perform this operation.

InternalServerException - Unexpected error occurred while processing the request.

ResourceNotFoundException - Request references a resource that doesn't exist.

ServiceQuotaExceededException - Request would cause a service quota to be exceeded.

ThrottlingException - The request was denied due to request throttling.

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

DataEncryptionException - The operation failed to due an encryption key error.

See Also:

AWS API Documentation

updateContactChannel

UpdateContactChannelResult updateContactChannel(UpdateContactChannelRequest updateContactChannelRequest)

Updates a contact's contact channel.

Parameters:

updateContactChannelRequest -

Returns:

Result of the UpdateContactChannel operation returned by the service.

Throws:

AccessDeniedException - You don't have sufficient access to perform this operation.

ConflictException - Updating or deleting a resource causes an inconsistent state.

DataEncryptionException - The operation failed to due an encryption key error.

InternalServerException - Unexpected error occurred while processing the request.

ResourceNotFoundException - Request references a resource that doesn't exist.

ThrottlingException - The request was denied due to request throttling.

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

See Also:

AWS API Documentation

updateRotation

UpdateRotationResult updateRotation(UpdateRotationRequest updateRotationRequest)

Updates the information specified for an on-call rotation.

Parameters:

updateRotationRequest -

Returns:

Result of the UpdateRotation operation returned by the service.

Throws:

AccessDeniedException - You don't have sufficient access to perform this operation.

ConflictException - Updating or deleting a resource causes an inconsistent state.

InternalServerException - Unexpected error occurred while processing the request.

ResourceNotFoundException - Request references a resource that doesn't exist.

ThrottlingException - The request was denied due to request throttling.

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

See Also:

AWS API Documentation

shutdown

void shutdown()

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.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

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.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.