@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAWSSSMContacts extends Object implements AWSSSMContacts
AWSSSMContacts. Convenient method forms pass through to the corresponding overload
that takes a request object, which throws an UnsupportedOperationException.ENDPOINT_PREFIX| 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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Lists the tags of an escalation plan or contact.
|
PutContactPolicyResult |
putContactPolicy(PutContactPolicyRequest request)
Adds a resource 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.
|
public AcceptPageResult acceptPage(AcceptPageRequest request)
AWSSSMContactsUsed to acknowledge an engagement to a contact channel during an incident.
acceptPage in interface AWSSSMContactspublic ActivateContactChannelResult activateContactChannel(ActivateContactChannelRequest request)
AWSSSMContactsActivates a contact's contact channel. Incident Manager can't engage a contact until the contact channel has been activated.
activateContactChannel in interface AWSSSMContactspublic CreateContactResult createContact(CreateContactRequest request)
AWSSSMContactsContacts 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.
createContact in interface AWSSSMContactspublic CreateContactChannelResult createContactChannel(CreateContactChannelRequest request)
AWSSSMContactsA contact channel is the method that Incident Manager uses to engage your contact.
createContactChannel in interface AWSSSMContactspublic DeactivateContactChannelResult deactivateContactChannel(DeactivateContactChannelRequest request)
AWSSSMContactsTo no longer receive Incident Manager engagements to a contact channel, you can deactivate the channel.
deactivateContactChannel in interface AWSSSMContactspublic DeleteContactResult deleteContact(DeleteContactRequest request)
AWSSSMContactsTo 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.
deleteContact in interface AWSSSMContactspublic DeleteContactChannelResult deleteContactChannel(DeleteContactChannelRequest request)
AWSSSMContactsTo 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.
deleteContactChannel in interface AWSSSMContactspublic DescribeEngagementResult describeEngagement(DescribeEngagementRequest request)
AWSSSMContactsIncident Manager uses engagements to engage contacts and escalation plans during an incident. Use this command to describe the engagement that occurred during an incident.
describeEngagement in interface AWSSSMContactspublic DescribePageResult describePage(DescribePageRequest request)
AWSSSMContactsLists details of the engagement to a contact channel.
describePage in interface AWSSSMContactspublic GetContactResult getContact(GetContactRequest request)
AWSSSMContactsRetrieves information about the specified contact or escalation plan.
getContact in interface AWSSSMContactspublic GetContactChannelResult getContactChannel(GetContactChannelRequest request)
AWSSSMContactsList details about a specific contact channel.
getContactChannel in interface AWSSSMContactspublic GetContactPolicyResult getContactPolicy(GetContactPolicyRequest request)
AWSSSMContactsRetrieves the resource policies attached to the specified contact or escalation plan.
getContactPolicy in interface AWSSSMContactspublic ListContactChannelsResult listContactChannels(ListContactChannelsRequest request)
AWSSSMContactsLists all contact channels for the specified contact.
listContactChannels in interface AWSSSMContactspublic ListContactsResult listContacts(ListContactsRequest request)
AWSSSMContactsLists all contacts and escalation plans in Incident Manager.
listContacts in interface AWSSSMContactspublic ListEngagementsResult listEngagements(ListEngagementsRequest request)
AWSSSMContactsLists all engagements that have happened in an incident.
listEngagements in interface AWSSSMContactspublic ListPageReceiptsResult listPageReceipts(ListPageReceiptsRequest request)
AWSSSMContactsLists all of the engagements to contact channels that have been acknowledged.
listPageReceipts in interface AWSSSMContactspublic ListPagesByContactResult listPagesByContact(ListPagesByContactRequest request)
AWSSSMContactsLists the engagements to a contact's contact channels.
listPagesByContact in interface AWSSSMContactspublic ListPagesByEngagementResult listPagesByEngagement(ListPagesByEngagementRequest request)
AWSSSMContactsLists the engagements to contact channels that occurred by engaging a contact.
listPagesByEngagement in interface AWSSSMContactspublic ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AWSSSMContactsLists the tags of an escalation plan or contact.
listTagsForResource in interface AWSSSMContactspublic PutContactPolicyResult putContactPolicy(PutContactPolicyRequest request)
AWSSSMContactsAdds a resource to the specified contact or escalation plan.
putContactPolicy in interface AWSSSMContactspublic SendActivationCodeResult sendActivationCode(SendActivationCodeRequest request)
AWSSSMContacts
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.
sendActivationCode in interface AWSSSMContactspublic StartEngagementResult startEngagement(StartEngagementRequest request)
AWSSSMContactsStarts an engagement to a contact or escalation plan. The engagement engages each contact specified in the incident.
startEngagement in interface AWSSSMContactspublic StopEngagementResult stopEngagement(StopEngagementRequest request)
AWSSSMContactsStops an engagement before it finishes the final stage of the escalation plan or engagement plan. Further contacts aren't engaged.
stopEngagement in interface AWSSSMContactspublic TagResourceResult tagResource(TagResourceRequest request)
AWSSSMContactsTags a contact or escalation plan. You can tag only contacts and escalation plans in the first region of your replication set.
tagResource in interface AWSSSMContactspublic UntagResourceResult untagResource(UntagResourceRequest request)
AWSSSMContactsRemoves tags from the specified resource.
untagResource in interface AWSSSMContactspublic UpdateContactResult updateContact(UpdateContactRequest request)
AWSSSMContactsUpdates the contact or escalation plan specified.
updateContact in interface AWSSSMContactspublic UpdateContactChannelResult updateContactChannel(UpdateContactChannelRequest request)
AWSSSMContactsUpdates a contact's contact channel.
updateContactChannel in interface AWSSSMContactspublic void shutdown()
AWSSSMContactsshutdown in interface AWSSSMContactspublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSSSMContactsResponse 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.
getCachedResponseMetadata in interface AWSSSMContactsrequest - The originally executed request.