com.amazonaws.services.ssmcontacts

Class AWSSSMContactsClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.ssmcontacts.AWSSSMContactsClient

All Implemented Interfaces:

AWSSSMContacts

Direct Known Subclasses:

AWSSSMContactsAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSSSMContactsClient
extends AmazonWebServiceClient
implements AWSSSMContacts

Client for accessing SSM Contacts. All service calls made using this client are blocking, and will not return until the service call completes.

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 inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.ssmcontacts.AWSSSMContacts

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
AcceptPageResult	acceptPage(AcceptPageRequest request) Used to acknowledge an engagement to a contact channel during an incident.
ActivateContactChannelResult	activateContactChannel(ActivateContactChannelRequest request) Activates a contact's contact channel.
static AWSSSMContactsClientBuilder	builder()
CreateContactResult	createContact(CreateContactRequest request) 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 request) A contact channel is the method that Incident Manager uses to engage your contact.
CreateRotationResult	createRotation(CreateRotationRequest request) Creates a rotation in an on-call schedule.
CreateRotationOverrideResult	createRotationOverride(CreateRotationOverrideRequest request) Creates an override for a rotation in an on-call schedule.
DeactivateContactChannelResult	deactivateContactChannel(DeactivateContactChannelRequest request) To no longer receive Incident Manager engagements to a contact channel, you can deactivate the channel.
DeleteContactResult	deleteContact(DeleteContactRequest request) To remove a contact from Incident Manager, you can delete the contact.
DeleteContactChannelResult	deleteContactChannel(DeleteContactChannelRequest request) To no longer receive engagements on a contact channel, you can delete the channel from a contact.
DeleteRotationResult	deleteRotation(DeleteRotationRequest request) Deletes a rotation from the system.
DeleteRotationOverrideResult	deleteRotationOverride(DeleteRotationOverrideRequest request) Deletes an existing override for an on-call rotation.
DescribeEngagementResult	describeEngagement(DescribeEngagementRequest request) Incident Manager uses engagements to engage contacts and escalation plans during an incident.
DescribePageResult	describePage(DescribePageRequest request) 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 request) Retrieves information about the specified contact or escalation plan.
GetContactChannelResult	getContactChannel(GetContactChannelRequest request) List details about a specific contact channel.
GetContactPolicyResult	getContactPolicy(GetContactPolicyRequest request) Retrieves the resource policies attached to the specified contact or escalation plan.
GetRotationResult	getRotation(GetRotationRequest request) Retrieves information about an on-call rotation.
GetRotationOverrideResult	getRotationOverride(GetRotationOverrideRequest request) Retrieves information about an override to an on-call rotation.
ListContactChannelsResult	listContactChannels(ListContactChannelsRequest request) Lists all contact channels for the specified contact.
ListContactsResult	listContacts(ListContactsRequest request) Lists all contacts and escalation plans in Incident Manager.
ListEngagementsResult	listEngagements(ListEngagementsRequest request) Lists all engagements that have happened in an incident.
ListPageReceiptsResult	listPageReceipts(ListPageReceiptsRequest request) Lists all of the engagements to contact channels that have been acknowledged.
ListPageResolutionsResult	listPageResolutions(ListPageResolutionsRequest request) Returns the resolution path of an engagement.
ListPagesByContactResult	listPagesByContact(ListPagesByContactRequest request) Lists the engagements to a contact's contact channels.
ListPagesByEngagementResult	listPagesByEngagement(ListPagesByEngagementRequest request) Lists the engagements to contact channels that occurred by engaging a contact.
ListPreviewRotationShiftsResult	listPreviewRotationShifts(ListPreviewRotationShiftsRequest request) Returns a list of shifts based on rotation configuration parameters.
ListRotationOverridesResult	listRotationOverrides(ListRotationOverridesRequest request) Retrieves a list of overrides currently specified for an on-call rotation.
ListRotationsResult	listRotations(ListRotationsRequest request) Retrieves a list of on-call rotations.
ListRotationShiftsResult	listRotationShifts(ListRotationShiftsRequest request) Returns a list of shifts generated by an existing rotation in the system.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) Lists the tags of an escalation plan or contact.
PutContactPolicyResult	putContactPolicy(PutContactPolicyRequest request) Adds a resource policy to the specified contact or escalation plan.
SendActivationCodeResult	sendActivationCode(SendActivationCodeRequest request) 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 request) Starts an engagement to a contact or escalation plan.
StopEngagementResult	stopEngagement(StopEngagementRequest request) Stops an engagement before it finishes the final stage of the escalation plan or engagement plan.
TagResourceResult	tagResource(TagResourceRequest request) Tags a contact or escalation plan.
UntagResourceResult	untagResource(UntagResourceRequest request) Removes tags from the specified resource.
UpdateContactResult	updateContact(UpdateContactRequest request) Updates the contact or escalation plan specified.
UpdateContactChannelResult	updateContactChannel(UpdateContactChannelRequest request) Updates a contact's contact channel.
UpdateRotationResult	updateRotation(UpdateRotationRequest request) Updates the information specified for an on-call rotation.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static AWSSSMContactsClientBuilder builder()

acceptPage

public AcceptPageResult acceptPage(AcceptPageRequest request)

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

Specified by:

acceptPage in interface AWSSSMContacts

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

public ActivateContactChannelResult activateContactChannel(ActivateContactChannelRequest request)

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

Specified by:

activateContactChannel in interface AWSSSMContacts

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

public CreateContactResult createContact(CreateContactRequest request)

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.

Specified by:

createContact in interface AWSSSMContacts

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

public CreateContactChannelResult createContactChannel(CreateContactChannelRequest request)

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

Specified by:

createContactChannel in interface AWSSSMContacts

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

public CreateRotationResult createRotation(CreateRotationRequest request)

Creates a rotation in an on-call schedule.

Specified by:

createRotation in interface AWSSSMContacts

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

public CreateRotationOverrideResult createRotationOverride(CreateRotationOverrideRequest request)

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

Specified by:

createRotationOverride in interface AWSSSMContacts

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

public DeactivateContactChannelResult deactivateContactChannel(DeactivateContactChannelRequest request)

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

Specified by:

deactivateContactChannel in interface AWSSSMContacts

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

public DeleteContactResult deleteContact(DeleteContactRequest request)

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.

Specified by:

deleteContact in interface AWSSSMContacts

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

public DeleteContactChannelResult deleteContactChannel(DeleteContactChannelRequest request)

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.

Specified by:

deleteContactChannel in interface AWSSSMContacts

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

public DeleteRotationResult deleteRotation(DeleteRotationRequest request)

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.

Specified by:

deleteRotation in interface AWSSSMContacts

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

public DeleteRotationOverrideResult deleteRotationOverride(DeleteRotationOverrideRequest request)

Deletes an existing override for an on-call rotation.

Specified by:

deleteRotationOverride in interface AWSSSMContacts

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

public DescribeEngagementResult describeEngagement(DescribeEngagementRequest request)

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.

Specified by:

describeEngagement in interface AWSSSMContacts

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

public DescribePageResult describePage(DescribePageRequest request)

Lists details of the engagement to a contact channel.

Specified by:

describePage in interface AWSSSMContacts

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

public GetContactResult getContact(GetContactRequest request)

Retrieves information about the specified contact or escalation plan.

Specified by:

getContact in interface AWSSSMContacts

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

public GetContactChannelResult getContactChannel(GetContactChannelRequest request)

List details about a specific contact channel.

Specified by:

getContactChannel in interface AWSSSMContacts

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

public GetContactPolicyResult getContactPolicy(GetContactPolicyRequest request)

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

Specified by:

getContactPolicy in interface AWSSSMContacts

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

public GetRotationResult getRotation(GetRotationRequest request)

Retrieves information about an on-call rotation.

Specified by:

getRotation in interface AWSSSMContacts

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

public GetRotationOverrideResult getRotationOverride(GetRotationOverrideRequest request)

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

Specified by:

getRotationOverride in interface AWSSSMContacts

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

public ListContactChannelsResult listContactChannels(ListContactChannelsRequest request)

Lists all contact channels for the specified contact.

Specified by:

listContactChannels in interface AWSSSMContacts

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

public ListContactsResult listContacts(ListContactsRequest request)

Lists all contacts and escalation plans in Incident Manager.

Specified by:

listContacts in interface AWSSSMContacts

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

public ListEngagementsResult listEngagements(ListEngagementsRequest request)

Lists all engagements that have happened in an incident.

Specified by:

listEngagements in interface AWSSSMContacts

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

public ListPageReceiptsResult listPageReceipts(ListPageReceiptsRequest request)

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

Specified by:

listPageReceipts in interface AWSSSMContacts

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

public ListPageResolutionsResult listPageResolutions(ListPageResolutionsRequest request)

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.

Specified by:

listPageResolutions in interface AWSSSMContacts

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

public ListPagesByContactResult listPagesByContact(ListPagesByContactRequest request)

Lists the engagements to a contact's contact channels.

Specified by:

listPagesByContact in interface AWSSSMContacts

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

public ListPagesByEngagementResult listPagesByEngagement(ListPagesByEngagementRequest request)

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

Specified by:

listPagesByEngagement in interface AWSSSMContacts

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

public ListPreviewRotationShiftsResult listPreviewRotationShifts(ListPreviewRotationShiftsRequest request)

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.

Specified by:

listPreviewRotationShifts in interface AWSSSMContacts

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

public ListRotationOverridesResult listRotationOverrides(ListRotationOverridesRequest request)

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

Specified by:

listRotationOverrides in interface AWSSSMContacts

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

public ListRotationShiftsResult listRotationShifts(ListRotationShiftsRequest request)

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

Specified by:

listRotationShifts in interface AWSSSMContacts

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

public ListRotationsResult listRotations(ListRotationsRequest request)

Retrieves a list of on-call rotations.

Specified by:

listRotations in interface AWSSSMContacts

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

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

Lists the tags of an escalation plan or contact.

Specified by:

listTagsForResource in interface AWSSSMContacts

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

public PutContactPolicyResult putContactPolicy(PutContactPolicyRequest request)

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.

Specified by:

putContactPolicy in interface AWSSSMContacts

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

public SendActivationCodeResult sendActivationCode(SendActivationCodeRequest request)

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.

Specified by:

sendActivationCode in interface AWSSSMContacts

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

public StartEngagementResult startEngagement(StartEngagementRequest request)

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

Specified by:

startEngagement in interface AWSSSMContacts

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

public StopEngagementResult stopEngagement(StopEngagementRequest request)

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

Specified by:

stopEngagement in interface AWSSSMContacts

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

public TagResourceResult tagResource(TagResourceRequest request)

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

Specified by:

tagResource in interface AWSSSMContacts

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

public UntagResourceResult untagResource(UntagResourceRequest request)

Removes tags from the specified resource.

Specified by:

untagResource in interface AWSSSMContacts

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

public UpdateContactResult updateContact(UpdateContactRequest request)

Updates the contact or escalation plan specified.

Specified by:

updateContact in interface AWSSSMContacts

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

public UpdateContactChannelResult updateContactChannel(UpdateContactChannelRequest request)

Updates a contact's contact channel.

Specified by:

updateContactChannel in interface AWSSSMContacts

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

public UpdateRotationResult updateRotation(UpdateRotationRequest request)

Updates the information specified for an on-call rotation.

Specified by:

updateRotation in interface AWSSSMContacts

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

getCachedResponseMetadata

public 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 the request.

Specified by:

getCachedResponseMetadata in interface AWSSSMContacts

Parameters:

request - The originally executed request

Returns:

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

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AWSSSMContacts

Overrides:

shutdown in class AmazonWebServiceClient