@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSSSMContactsClient extends AmazonWebServiceClient implements AWSSSMContacts
| Modifier and Type | Field and Description |
|---|---|
protected static ClientConfigurationFactory |
configFactory
Client configuration factory providing ClientConfigurations tailored to this client
|
client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffsetENDPOINT_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.
|
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.
|
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.
|
addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffsetprotected static final ClientConfigurationFactory configFactory
public static AWSSSMContactsClientBuilder builder()
public AcceptPageResult acceptPage(AcceptPageRequest request)
Used to acknowledge an engagement to a contact channel during an incident.
acceptPage in interface AWSSSMContactsacceptPageRequest - AccessDeniedException - You don't have sufficient access to perform this action.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 AWS service.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.
activateContactChannel in interface AWSSSMContactsactivateContactChannelRequest - AccessDeniedException - You don't have sufficient access to perform this action.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 AWS service.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.
createContact in interface AWSSSMContactscreateContactRequest - AccessDeniedException - You don't have sufficient access to perform this action.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 AWS service.DataEncryptionException - The action failed to due an encryption key error.public CreateContactChannelResult createContactChannel(CreateContactChannelRequest request)
A contact channel is the method that Incident Manager uses to engage your contact.
createContactChannel in interface AWSSSMContactscreateContactChannelRequest - AccessDeniedException - You don't have sufficient access to perform this action.ConflictException - Updating or deleting a resource causes an inconsistent state.DataEncryptionException - The action 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 AWS service.public DeactivateContactChannelResult deactivateContactChannel(DeactivateContactChannelRequest request)
To no longer receive Incident Manager engagements to a contact channel, you can deactivate the channel.
deactivateContactChannel in interface AWSSSMContactsdeactivateContactChannelRequest - AccessDeniedException - You don't have sufficient access to perform this action.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 AWS service.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.
deleteContact in interface AWSSSMContactsdeleteContactRequest - AccessDeniedException - You don't have sufficient access to perform this action.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 AWS service.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.
deleteContactChannel in interface AWSSSMContactsdeleteContactChannelRequest - AccessDeniedException - You don't have sufficient access to perform this action.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 AWS service.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.
describeEngagement in interface AWSSSMContactsdescribeEngagementRequest - AccessDeniedException - You don't have sufficient access to perform this action.DataEncryptionException - The action 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 AWS service.public DescribePageResult describePage(DescribePageRequest request)
Lists details of the engagement to a contact channel.
describePage in interface AWSSSMContactsdescribePageRequest - AccessDeniedException - You don't have sufficient access to perform this action.DataEncryptionException - The action 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 AWS service.public GetContactResult getContact(GetContactRequest request)
Retrieves information about the specified contact or escalation plan.
getContact in interface AWSSSMContactsgetContactRequest - AccessDeniedException - You don't have sufficient access to perform this action.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 AWS service.DataEncryptionException - The action failed to due an encryption key error.public GetContactChannelResult getContactChannel(GetContactChannelRequest request)
List details about a specific contact channel.
getContactChannel in interface AWSSSMContactsgetContactChannelRequest - AccessDeniedException - You don't have sufficient access to perform this action.DataEncryptionException - The action 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 AWS service.public GetContactPolicyResult getContactPolicy(GetContactPolicyRequest request)
Retrieves the resource policies attached to the specified contact or escalation plan.
getContactPolicy in interface AWSSSMContactsgetContactPolicyRequest - AccessDeniedException - You don't have sufficient access to perform this action.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 AWS service.public ListContactChannelsResult listContactChannels(ListContactChannelsRequest request)
Lists all contact channels for the specified contact.
listContactChannels in interface AWSSSMContactslistContactChannelsRequest - AccessDeniedException - You don't have sufficient access to perform this action.DataEncryptionException - The action 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 AWS service.public ListContactsResult listContacts(ListContactsRequest request)
Lists all contacts and escalation plans in Incident Manager.
listContacts in interface AWSSSMContactslistContactsRequest - AccessDeniedException - You don't have sufficient access to perform this action.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 AWS service.public ListEngagementsResult listEngagements(ListEngagementsRequest request)
Lists all engagements that have happened in an incident.
listEngagements in interface AWSSSMContactslistEngagementsRequest - AccessDeniedException - You don't have sufficient access to perform this action.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 AWS service.public ListPageReceiptsResult listPageReceipts(ListPageReceiptsRequest request)
Lists all of the engagements to contact channels that have been acknowledged.
listPageReceipts in interface AWSSSMContactslistPageReceiptsRequest - AccessDeniedException - You don't have sufficient access to perform this action.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 AWS service.public ListPagesByContactResult listPagesByContact(ListPagesByContactRequest request)
Lists the engagements to a contact's contact channels.
listPagesByContact in interface AWSSSMContactslistPagesByContactRequest - AccessDeniedException - You don't have sufficient access to perform this action.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 AWS service.public ListPagesByEngagementResult listPagesByEngagement(ListPagesByEngagementRequest request)
Lists the engagements to contact channels that occurred by engaging a contact.
listPagesByEngagement in interface AWSSSMContactslistPagesByEngagementRequest - AccessDeniedException - You don't have sufficient access to perform this action.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 AWS service.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Lists the tags of an escalation plan or contact.
listTagsForResource in interface AWSSSMContactslistTagsForResourceRequest - AccessDeniedException - You don't have sufficient access to perform this action.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.public PutContactPolicyResult putContactPolicy(PutContactPolicyRequest request)
Adds a resource to the specified contact or escalation plan.
putContactPolicy in interface AWSSSMContactsputContactPolicyRequest - AccessDeniedException - You don't have sufficient access to perform this action.ConflictException - Updating or deleting a resource causes an inconsistent state.ValidationException - The input fails to satisfy the constraints specified by an AWS 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.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 action. Incident Manager can't engage a contact channel
until it has been activated.
sendActivationCode in interface AWSSSMContactssendActivationCodeRequest - AccessDeniedException - You don't have sufficient access to perform this action.DataEncryptionException - The action 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 AWS service.public StartEngagementResult startEngagement(StartEngagementRequest request)
Starts an engagement to a contact or escalation plan. The engagement engages each contact specified in the incident.
startEngagement in interface AWSSSMContactsstartEngagementRequest - AccessDeniedException - You don't have sufficient access to perform this action.DataEncryptionException - The action 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 AWS service.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.
stopEngagement in interface AWSSSMContactsstopEngagementRequest - AccessDeniedException - You don't have sufficient access to perform this action.ValidationException - The input fails to satisfy the constraints specified by an AWS service.ResourceNotFoundException - Request references a resource that doesn't exist.InternalServerException - Unexpected error occurred while processing the request.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.
tagResource in interface AWSSSMContactstagResourceRequest - AccessDeniedException - You don't have sufficient access to perform this action.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 AWS service.public UntagResourceResult untagResource(UntagResourceRequest request)
Removes tags from the specified resource.
untagResource in interface AWSSSMContactsuntagResourceRequest - AccessDeniedException - You don't have sufficient access to perform this action.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.public UpdateContactResult updateContact(UpdateContactRequest request)
Updates the contact or escalation plan specified.
updateContact in interface AWSSSMContactsupdateContactRequest - AccessDeniedException - You don't have sufficient access to perform this action.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 AWS service.DataEncryptionException - The action failed to due an encryption key error.public UpdateContactChannelResult updateContactChannel(UpdateContactChannelRequest request)
Updates a contact's contact channel.
updateContactChannel in interface AWSSSMContactsupdateContactChannelRequest - AccessDeniedException - You don't have sufficient access to perform this action.ConflictException - Updating or deleting a resource causes an inconsistent state.DataEncryptionException - The action 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 AWS service.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
getCachedResponseMetadata in interface AWSSSMContactsrequest - The originally executed requestpublic void shutdown()
AWSSSMContactsshutdown in interface AWSSSMContactsshutdown in class AmazonWebServiceClientCopyright © 2021. All rights reserved.