@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface SsmContactsClient extends SdkClient
builder() method.
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.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
default AcceptPageResponse |
acceptPage(AcceptPageRequest acceptPageRequest)
Used to acknowledge an engagement to a contact channel during an incident.
|
default AcceptPageResponse |
acceptPage(Consumer<AcceptPageRequest.Builder> acceptPageRequest)
Used to acknowledge an engagement to a contact channel during an incident.
|
default ActivateContactChannelResponse |
activateContactChannel(ActivateContactChannelRequest activateContactChannelRequest)
Activates a contact's contact channel.
|
default ActivateContactChannelResponse |
activateContactChannel(Consumer<ActivateContactChannelRequest.Builder> activateContactChannelRequest)
Activates a contact's contact channel.
|
static SsmContactsClientBuilder |
builder()
Create a builder that can be used to configure and create a
SsmContactsClient. |
static SsmContactsClient |
create()
Create a
SsmContactsClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CreateContactResponse |
createContact(Consumer<CreateContactRequest.Builder> 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.
|
default CreateContactResponse |
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.
|
default CreateContactChannelResponse |
createContactChannel(Consumer<CreateContactChannelRequest.Builder> createContactChannelRequest)
A contact channel is the method that Incident Manager uses to engage your contact.
|
default CreateContactChannelResponse |
createContactChannel(CreateContactChannelRequest createContactChannelRequest)
A contact channel is the method that Incident Manager uses to engage your contact.
|
default DeactivateContactChannelResponse |
deactivateContactChannel(Consumer<DeactivateContactChannelRequest.Builder> deactivateContactChannelRequest)
To no longer receive Incident Manager engagements to a contact channel, you can deactivate the channel.
|
default DeactivateContactChannelResponse |
deactivateContactChannel(DeactivateContactChannelRequest deactivateContactChannelRequest)
To no longer receive Incident Manager engagements to a contact channel, you can deactivate the channel.
|
default DeleteContactResponse |
deleteContact(Consumer<DeleteContactRequest.Builder> deleteContactRequest)
To remove a contact from Incident Manager, you can delete the contact.
|
default DeleteContactResponse |
deleteContact(DeleteContactRequest deleteContactRequest)
To remove a contact from Incident Manager, you can delete the contact.
|
default DeleteContactChannelResponse |
deleteContactChannel(Consumer<DeleteContactChannelRequest.Builder> deleteContactChannelRequest)
To no longer receive engagements on a contact channel, you can delete the channel from a contact.
|
default DeleteContactChannelResponse |
deleteContactChannel(DeleteContactChannelRequest deleteContactChannelRequest)
To no longer receive engagements on a contact channel, you can delete the channel from a contact.
|
default DescribeEngagementResponse |
describeEngagement(Consumer<DescribeEngagementRequest.Builder> describeEngagementRequest)
Incident Manager uses engagements to engage contacts and escalation plans during an incident.
|
default DescribeEngagementResponse |
describeEngagement(DescribeEngagementRequest describeEngagementRequest)
Incident Manager uses engagements to engage contacts and escalation plans during an incident.
|
default DescribePageResponse |
describePage(Consumer<DescribePageRequest.Builder> describePageRequest)
Lists details of the engagement to a contact channel.
|
default DescribePageResponse |
describePage(DescribePageRequest describePageRequest)
Lists details of the engagement to a contact channel.
|
default GetContactResponse |
getContact(Consumer<GetContactRequest.Builder> getContactRequest)
Retrieves information about the specified contact or escalation plan.
|
default GetContactResponse |
getContact(GetContactRequest getContactRequest)
Retrieves information about the specified contact or escalation plan.
|
default GetContactChannelResponse |
getContactChannel(Consumer<GetContactChannelRequest.Builder> getContactChannelRequest)
List details about a specific contact channel.
|
default GetContactChannelResponse |
getContactChannel(GetContactChannelRequest getContactChannelRequest)
List details about a specific contact channel.
|
default GetContactPolicyResponse |
getContactPolicy(Consumer<GetContactPolicyRequest.Builder> getContactPolicyRequest)
Retrieves the resource policies attached to the specified contact or escalation plan.
|
default GetContactPolicyResponse |
getContactPolicy(GetContactPolicyRequest getContactPolicyRequest)
Retrieves the resource policies attached to the specified contact or escalation plan.
|
default ListContactChannelsResponse |
listContactChannels(Consumer<ListContactChannelsRequest.Builder> listContactChannelsRequest)
Lists all contact channels for the specified contact.
|
default ListContactChannelsResponse |
listContactChannels(ListContactChannelsRequest listContactChannelsRequest)
Lists all contact channels for the specified contact.
|
default ListContactChannelsIterable |
listContactChannelsPaginator(Consumer<ListContactChannelsRequest.Builder> listContactChannelsRequest)
Lists all contact channels for the specified contact.
|
default ListContactChannelsIterable |
listContactChannelsPaginator(ListContactChannelsRequest listContactChannelsRequest)
Lists all contact channels for the specified contact.
|
default ListContactsResponse |
listContacts(Consumer<ListContactsRequest.Builder> listContactsRequest)
Lists all contacts and escalation plans in Incident Manager.
|
default ListContactsResponse |
listContacts(ListContactsRequest listContactsRequest)
Lists all contacts and escalation plans in Incident Manager.
|
default ListContactsIterable |
listContactsPaginator(Consumer<ListContactsRequest.Builder> listContactsRequest)
Lists all contacts and escalation plans in Incident Manager.
|
default ListContactsIterable |
listContactsPaginator(ListContactsRequest listContactsRequest)
Lists all contacts and escalation plans in Incident Manager.
|
default ListEngagementsResponse |
listEngagements(Consumer<ListEngagementsRequest.Builder> listEngagementsRequest)
Lists all engagements that have happened in an incident.
|
default ListEngagementsResponse |
listEngagements(ListEngagementsRequest listEngagementsRequest)
Lists all engagements that have happened in an incident.
|
default ListEngagementsIterable |
listEngagementsPaginator(Consumer<ListEngagementsRequest.Builder> listEngagementsRequest)
Lists all engagements that have happened in an incident.
|
default ListEngagementsIterable |
listEngagementsPaginator(ListEngagementsRequest listEngagementsRequest)
Lists all engagements that have happened in an incident.
|
default ListPageReceiptsResponse |
listPageReceipts(Consumer<ListPageReceiptsRequest.Builder> listPageReceiptsRequest)
Lists all of the engagements to contact channels that have been acknowledged.
|
default ListPageReceiptsResponse |
listPageReceipts(ListPageReceiptsRequest listPageReceiptsRequest)
Lists all of the engagements to contact channels that have been acknowledged.
|
default ListPageReceiptsIterable |
listPageReceiptsPaginator(Consumer<ListPageReceiptsRequest.Builder> listPageReceiptsRequest)
Lists all of the engagements to contact channels that have been acknowledged.
|
default ListPageReceiptsIterable |
listPageReceiptsPaginator(ListPageReceiptsRequest listPageReceiptsRequest)
Lists all of the engagements to contact channels that have been acknowledged.
|
default ListPagesByContactResponse |
listPagesByContact(Consumer<ListPagesByContactRequest.Builder> listPagesByContactRequest)
Lists the engagements to a contact's contact channels.
|
default ListPagesByContactResponse |
listPagesByContact(ListPagesByContactRequest listPagesByContactRequest)
Lists the engagements to a contact's contact channels.
|
default ListPagesByContactIterable |
listPagesByContactPaginator(Consumer<ListPagesByContactRequest.Builder> listPagesByContactRequest)
Lists the engagements to a contact's contact channels.
|
default ListPagesByContactIterable |
listPagesByContactPaginator(ListPagesByContactRequest listPagesByContactRequest)
Lists the engagements to a contact's contact channels.
|
default ListPagesByEngagementResponse |
listPagesByEngagement(Consumer<ListPagesByEngagementRequest.Builder> listPagesByEngagementRequest)
Lists the engagements to contact channels that occurred by engaging a contact.
|
default ListPagesByEngagementResponse |
listPagesByEngagement(ListPagesByEngagementRequest listPagesByEngagementRequest)
Lists the engagements to contact channels that occurred by engaging a contact.
|
default ListPagesByEngagementIterable |
listPagesByEngagementPaginator(Consumer<ListPagesByEngagementRequest.Builder> listPagesByEngagementRequest)
Lists the engagements to contact channels that occurred by engaging a contact.
|
default ListPagesByEngagementIterable |
listPagesByEngagementPaginator(ListPagesByEngagementRequest listPagesByEngagementRequest)
Lists the engagements to contact channels that occurred by engaging a contact.
|
default ListTagsForResourceResponse |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists the tags of an escalation plan or contact.
|
default ListTagsForResourceResponse |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags of an escalation plan or contact.
|
default PutContactPolicyResponse |
putContactPolicy(Consumer<PutContactPolicyRequest.Builder> putContactPolicyRequest)
Adds a resource policy to the specified contact or escalation plan.
|
default PutContactPolicyResponse |
putContactPolicy(PutContactPolicyRequest putContactPolicyRequest)
Adds a resource policy to the specified contact or escalation plan.
|
default SendActivationCodeResponse |
sendActivationCode(Consumer<SendActivationCodeRequest.Builder> sendActivationCodeRequest)
Sends an activation code to a contact channel.
|
default SendActivationCodeResponse |
sendActivationCode(SendActivationCodeRequest sendActivationCodeRequest)
Sends an activation code to a contact channel.
|
static ServiceMetadata |
serviceMetadata() |
default StartEngagementResponse |
startEngagement(Consumer<StartEngagementRequest.Builder> startEngagementRequest)
Starts an engagement to a contact or escalation plan.
|
default StartEngagementResponse |
startEngagement(StartEngagementRequest startEngagementRequest)
Starts an engagement to a contact or escalation plan.
|
default StopEngagementResponse |
stopEngagement(Consumer<StopEngagementRequest.Builder> stopEngagementRequest)
Stops an engagement before it finishes the final stage of the escalation plan or engagement plan.
|
default StopEngagementResponse |
stopEngagement(StopEngagementRequest stopEngagementRequest)
Stops an engagement before it finishes the final stage of the escalation plan or engagement plan.
|
default TagResourceResponse |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Tags a contact or escalation plan.
|
default TagResourceResponse |
tagResource(TagResourceRequest tagResourceRequest)
Tags a contact or escalation plan.
|
default UntagResourceResponse |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes tags from the specified resource.
|
default UntagResourceResponse |
untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from the specified resource.
|
default UpdateContactResponse |
updateContact(Consumer<UpdateContactRequest.Builder> updateContactRequest)
Updates the contact or escalation plan specified.
|
default UpdateContactResponse |
updateContact(UpdateContactRequest updateContactRequest)
Updates the contact or escalation plan specified.
|
default UpdateContactChannelResponse |
updateContactChannel(Consumer<UpdateContactChannelRequest.Builder> updateContactChannelRequest)
Updates a contact's contact channel.
|
default UpdateContactChannelResponse |
updateContactChannel(UpdateContactChannelRequest updateContactChannelRequest)
Updates a contact's contact channel.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.static SsmContactsClient create()
SsmContactsClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static SsmContactsClientBuilder builder()
SsmContactsClient.default AcceptPageResponse acceptPage(AcceptPageRequest acceptPageRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Used to acknowledge an engagement to a contact channel during an incident.
acceptPageRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmContactsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault AcceptPageResponse acceptPage(Consumer<AcceptPageRequest.Builder> acceptPageRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Used to acknowledge an engagement to a contact channel during an incident.
This is a convenience which creates an instance of the AcceptPageRequest.Builder avoiding the need to
create one manually via AcceptPageRequest.builder()
acceptPageRequest - A Consumer that will call methods on AcceptPageRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmContactsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ActivateContactChannelResponse activateContactChannel(ActivateContactChannelRequest activateContactChannelRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Activates a contact's contact channel. Incident Manager can't engage a contact until the contact channel has been activated.
activateContactChannelRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmContactsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ActivateContactChannelResponse activateContactChannel(Consumer<ActivateContactChannelRequest.Builder> activateContactChannelRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Activates a contact's contact channel. Incident Manager can't engage a contact until the contact channel has been activated.
This is a convenience which creates an instance of the ActivateContactChannelRequest.Builder avoiding the
need to create one manually via ActivateContactChannelRequest.builder()
activateContactChannelRequest - A Consumer that will call methods on ActivateContactChannelRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmContactsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateContactResponse createContact(CreateContactRequest createContactRequest) throws AccessDeniedException, ConflictException, InternalServerException, ServiceQuotaExceededException, ThrottlingException, ValidationException, DataEncryptionException, AwsServiceException, SdkClientException, SsmContactsException
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.
createContactRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmContactsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateContactResponse createContact(Consumer<CreateContactRequest.Builder> createContactRequest) throws AccessDeniedException, ConflictException, InternalServerException, ServiceQuotaExceededException, ThrottlingException, ValidationException, DataEncryptionException, AwsServiceException, SdkClientException, SsmContactsException
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.
This is a convenience which creates an instance of the CreateContactRequest.Builder avoiding the need to
create one manually via CreateContactRequest.builder()
createContactRequest - A Consumer that will call methods on CreateContactRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmContactsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateContactChannelResponse createContactChannel(CreateContactChannelRequest createContactChannelRequest) throws AccessDeniedException, ConflictException, DataEncryptionException, InternalServerException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
A contact channel is the method that Incident Manager uses to engage your contact.
createContactChannelRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmContactsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateContactChannelResponse createContactChannel(Consumer<CreateContactChannelRequest.Builder> createContactChannelRequest) throws AccessDeniedException, ConflictException, DataEncryptionException, InternalServerException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
A contact channel is the method that Incident Manager uses to engage your contact.
This is a convenience which creates an instance of the CreateContactChannelRequest.Builder avoiding the
need to create one manually via CreateContactChannelRequest.builder()
createContactChannelRequest - A Consumer that will call methods on CreateContactChannelRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmContactsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeactivateContactChannelResponse deactivateContactChannel(DeactivateContactChannelRequest deactivateContactChannelRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
To no longer receive Incident Manager engagements to a contact channel, you can deactivate the channel.
deactivateContactChannelRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmContactsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeactivateContactChannelResponse deactivateContactChannel(Consumer<DeactivateContactChannelRequest.Builder> deactivateContactChannelRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
To no longer receive Incident Manager engagements to a contact channel, you can deactivate the channel.
This is a convenience which creates an instance of the DeactivateContactChannelRequest.Builder avoiding
the need to create one manually via DeactivateContactChannelRequest.builder()
deactivateContactChannelRequest - A Consumer that will call methods on DeactivateContactChannelRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmContactsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteContactResponse deleteContact(DeleteContactRequest deleteContactRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
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.
deleteContactRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmContactsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteContactResponse deleteContact(Consumer<DeleteContactRequest.Builder> deleteContactRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
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.
This is a convenience which creates an instance of the DeleteContactRequest.Builder avoiding the need to
create one manually via DeleteContactRequest.builder()
deleteContactRequest - A Consumer that will call methods on DeleteContactRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmContactsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteContactChannelResponse deleteContactChannel(DeleteContactChannelRequest deleteContactChannelRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
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.
deleteContactChannelRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmContactsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteContactChannelResponse deleteContactChannel(Consumer<DeleteContactChannelRequest.Builder> deleteContactChannelRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
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.
This is a convenience which creates an instance of the DeleteContactChannelRequest.Builder avoiding the
need to create one manually via DeleteContactChannelRequest.builder()
deleteContactChannelRequest - A Consumer that will call methods on DeleteContactChannelRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmContactsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeEngagementResponse describeEngagement(DescribeEngagementRequest describeEngagementRequest) throws AccessDeniedException, DataEncryptionException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
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.
describeEngagementRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmContactsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeEngagementResponse describeEngagement(Consumer<DescribeEngagementRequest.Builder> describeEngagementRequest) throws AccessDeniedException, DataEncryptionException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
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.
This is a convenience which creates an instance of the DescribeEngagementRequest.Builder avoiding the
need to create one manually via DescribeEngagementRequest.builder()
describeEngagementRequest - A Consumer that will call methods on DescribeEngagementRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmContactsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribePageResponse describePage(DescribePageRequest describePageRequest) throws AccessDeniedException, DataEncryptionException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Lists details of the engagement to a contact channel.
describePageRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmContactsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribePageResponse describePage(Consumer<DescribePageRequest.Builder> describePageRequest) throws AccessDeniedException, DataEncryptionException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Lists details of the engagement to a contact channel.
This is a convenience which creates an instance of the DescribePageRequest.Builder avoiding the need to
create one manually via DescribePageRequest.builder()
describePageRequest - A Consumer that will call methods on DescribePageRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmContactsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetContactResponse getContact(GetContactRequest getContactRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, DataEncryptionException, AwsServiceException, SdkClientException, SsmContactsException
Retrieves information about the specified contact or escalation plan.
getContactRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmContactsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetContactResponse getContact(Consumer<GetContactRequest.Builder> getContactRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, DataEncryptionException, AwsServiceException, SdkClientException, SsmContactsException
Retrieves information about the specified contact or escalation plan.
This is a convenience which creates an instance of the GetContactRequest.Builder avoiding the need to
create one manually via GetContactRequest.builder()
getContactRequest - A Consumer that will call methods on GetContactRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmContactsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetContactChannelResponse getContactChannel(GetContactChannelRequest getContactChannelRequest) throws AccessDeniedException, DataEncryptionException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
List details about a specific contact channel.
getContactChannelRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmContactsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetContactChannelResponse getContactChannel(Consumer<GetContactChannelRequest.Builder> getContactChannelRequest) throws AccessDeniedException, DataEncryptionException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
List details about a specific contact channel.
This is a convenience which creates an instance of the GetContactChannelRequest.Builder avoiding the need
to create one manually via GetContactChannelRequest.builder()
getContactChannelRequest - A Consumer that will call methods on GetContactChannelRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmContactsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetContactPolicyResponse getContactPolicy(GetContactPolicyRequest getContactPolicyRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Retrieves the resource policies attached to the specified contact or escalation plan.
getContactPolicyRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmContactsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetContactPolicyResponse getContactPolicy(Consumer<GetContactPolicyRequest.Builder> getContactPolicyRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Retrieves the resource policies attached to the specified contact or escalation plan.
This is a convenience which creates an instance of the GetContactPolicyRequest.Builder avoiding the need
to create one manually via GetContactPolicyRequest.builder()
getContactPolicyRequest - A Consumer that will call methods on GetContactPolicyRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmContactsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListContactChannelsResponse listContactChannels(ListContactChannelsRequest listContactChannelsRequest) throws AccessDeniedException, DataEncryptionException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Lists all contact channels for the specified contact.
listContactChannelsRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmContactsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListContactChannelsResponse listContactChannels(Consumer<ListContactChannelsRequest.Builder> listContactChannelsRequest) throws AccessDeniedException, DataEncryptionException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Lists all contact channels for the specified contact.
This is a convenience which creates an instance of the ListContactChannelsRequest.Builder avoiding the
need to create one manually via ListContactChannelsRequest.builder()
listContactChannelsRequest - A Consumer that will call methods on ListContactChannelsRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmContactsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListContactChannelsIterable listContactChannelsPaginator(ListContactChannelsRequest listContactChannelsRequest) throws AccessDeniedException, DataEncryptionException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Lists all contact channels for the specified contact.
This is a variant of
listContactChannels(software.amazon.awssdk.services.ssmcontacts.model.ListContactChannelsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ssmcontacts.paginators.ListContactChannelsIterable responses = client.listContactChannelsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.ssmcontacts.paginators.ListContactChannelsIterable responses = client
.listContactChannelsPaginator(request);
for (software.amazon.awssdk.services.ssmcontacts.model.ListContactChannelsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.ssmcontacts.paginators.ListContactChannelsIterable responses = client.listContactChannelsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listContactChannels(software.amazon.awssdk.services.ssmcontacts.model.ListContactChannelsRequest)
operation.
listContactChannelsRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmContactsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListContactChannelsIterable listContactChannelsPaginator(Consumer<ListContactChannelsRequest.Builder> listContactChannelsRequest) throws AccessDeniedException, DataEncryptionException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Lists all contact channels for the specified contact.
This is a variant of
listContactChannels(software.amazon.awssdk.services.ssmcontacts.model.ListContactChannelsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ssmcontacts.paginators.ListContactChannelsIterable responses = client.listContactChannelsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.ssmcontacts.paginators.ListContactChannelsIterable responses = client
.listContactChannelsPaginator(request);
for (software.amazon.awssdk.services.ssmcontacts.model.ListContactChannelsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.ssmcontacts.paginators.ListContactChannelsIterable responses = client.listContactChannelsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listContactChannels(software.amazon.awssdk.services.ssmcontacts.model.ListContactChannelsRequest)
operation.
This is a convenience which creates an instance of the ListContactChannelsRequest.Builder avoiding the
need to create one manually via ListContactChannelsRequest.builder()
listContactChannelsRequest - A Consumer that will call methods on ListContactChannelsRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmContactsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListContactsResponse listContacts(ListContactsRequest listContactsRequest) throws AccessDeniedException, InternalServerException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Lists all contacts and escalation plans in Incident Manager.
listContactsRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmContactsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListContactsResponse listContacts(Consumer<ListContactsRequest.Builder> listContactsRequest) throws AccessDeniedException, InternalServerException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Lists all contacts and escalation plans in Incident Manager.
This is a convenience which creates an instance of the ListContactsRequest.Builder avoiding the need to
create one manually via ListContactsRequest.builder()
listContactsRequest - A Consumer that will call methods on ListContactsRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmContactsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListContactsIterable listContactsPaginator(ListContactsRequest listContactsRequest) throws AccessDeniedException, InternalServerException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Lists all contacts and escalation plans in Incident Manager.
This is a variant of listContacts(software.amazon.awssdk.services.ssmcontacts.model.ListContactsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ssmcontacts.paginators.ListContactsIterable responses = client.listContactsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.ssmcontacts.paginators.ListContactsIterable responses = client.listContactsPaginator(request);
for (software.amazon.awssdk.services.ssmcontacts.model.ListContactsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.ssmcontacts.paginators.ListContactsIterable responses = client.listContactsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listContacts(software.amazon.awssdk.services.ssmcontacts.model.ListContactsRequest) operation.
listContactsRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmContactsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListContactsIterable listContactsPaginator(Consumer<ListContactsRequest.Builder> listContactsRequest) throws AccessDeniedException, InternalServerException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Lists all contacts and escalation plans in Incident Manager.
This is a variant of listContacts(software.amazon.awssdk.services.ssmcontacts.model.ListContactsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ssmcontacts.paginators.ListContactsIterable responses = client.listContactsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.ssmcontacts.paginators.ListContactsIterable responses = client.listContactsPaginator(request);
for (software.amazon.awssdk.services.ssmcontacts.model.ListContactsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.ssmcontacts.paginators.ListContactsIterable responses = client.listContactsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listContacts(software.amazon.awssdk.services.ssmcontacts.model.ListContactsRequest) operation.
This is a convenience which creates an instance of the ListContactsRequest.Builder avoiding the need to
create one manually via ListContactsRequest.builder()
listContactsRequest - A Consumer that will call methods on ListContactsRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmContactsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListEngagementsResponse listEngagements(ListEngagementsRequest listEngagementsRequest) throws AccessDeniedException, InternalServerException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Lists all engagements that have happened in an incident.
listEngagementsRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmContactsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListEngagementsResponse listEngagements(Consumer<ListEngagementsRequest.Builder> listEngagementsRequest) throws AccessDeniedException, InternalServerException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Lists all engagements that have happened in an incident.
This is a convenience which creates an instance of the ListEngagementsRequest.Builder avoiding the need
to create one manually via ListEngagementsRequest.builder()
listEngagementsRequest - A Consumer that will call methods on ListEngagementsRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmContactsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListEngagementsIterable listEngagementsPaginator(ListEngagementsRequest listEngagementsRequest) throws AccessDeniedException, InternalServerException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Lists all engagements that have happened in an incident.
This is a variant of
listEngagements(software.amazon.awssdk.services.ssmcontacts.model.ListEngagementsRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ssmcontacts.paginators.ListEngagementsIterable responses = client.listEngagementsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.ssmcontacts.paginators.ListEngagementsIterable responses = client
.listEngagementsPaginator(request);
for (software.amazon.awssdk.services.ssmcontacts.model.ListEngagementsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.ssmcontacts.paginators.ListEngagementsIterable responses = client.listEngagementsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEngagements(software.amazon.awssdk.services.ssmcontacts.model.ListEngagementsRequest) operation.
listEngagementsRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmContactsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListEngagementsIterable listEngagementsPaginator(Consumer<ListEngagementsRequest.Builder> listEngagementsRequest) throws AccessDeniedException, InternalServerException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Lists all engagements that have happened in an incident.
This is a variant of
listEngagements(software.amazon.awssdk.services.ssmcontacts.model.ListEngagementsRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ssmcontacts.paginators.ListEngagementsIterable responses = client.listEngagementsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.ssmcontacts.paginators.ListEngagementsIterable responses = client
.listEngagementsPaginator(request);
for (software.amazon.awssdk.services.ssmcontacts.model.ListEngagementsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.ssmcontacts.paginators.ListEngagementsIterable responses = client.listEngagementsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEngagements(software.amazon.awssdk.services.ssmcontacts.model.ListEngagementsRequest) operation.
This is a convenience which creates an instance of the ListEngagementsRequest.Builder avoiding the need
to create one manually via ListEngagementsRequest.builder()
listEngagementsRequest - A Consumer that will call methods on ListEngagementsRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmContactsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPageReceiptsResponse listPageReceipts(ListPageReceiptsRequest listPageReceiptsRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Lists all of the engagements to contact channels that have been acknowledged.
listPageReceiptsRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmContactsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPageReceiptsResponse listPageReceipts(Consumer<ListPageReceiptsRequest.Builder> listPageReceiptsRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Lists all of the engagements to contact channels that have been acknowledged.
This is a convenience which creates an instance of the ListPageReceiptsRequest.Builder avoiding the need
to create one manually via ListPageReceiptsRequest.builder()
listPageReceiptsRequest - A Consumer that will call methods on ListPageReceiptsRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmContactsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPageReceiptsIterable listPageReceiptsPaginator(ListPageReceiptsRequest listPageReceiptsRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Lists all of the engagements to contact channels that have been acknowledged.
This is a variant of
listPageReceipts(software.amazon.awssdk.services.ssmcontacts.model.ListPageReceiptsRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ssmcontacts.paginators.ListPageReceiptsIterable responses = client.listPageReceiptsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.ssmcontacts.paginators.ListPageReceiptsIterable responses = client
.listPageReceiptsPaginator(request);
for (software.amazon.awssdk.services.ssmcontacts.model.ListPageReceiptsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.ssmcontacts.paginators.ListPageReceiptsIterable responses = client.listPageReceiptsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPageReceipts(software.amazon.awssdk.services.ssmcontacts.model.ListPageReceiptsRequest)
operation.
listPageReceiptsRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmContactsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPageReceiptsIterable listPageReceiptsPaginator(Consumer<ListPageReceiptsRequest.Builder> listPageReceiptsRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Lists all of the engagements to contact channels that have been acknowledged.
This is a variant of
listPageReceipts(software.amazon.awssdk.services.ssmcontacts.model.ListPageReceiptsRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ssmcontacts.paginators.ListPageReceiptsIterable responses = client.listPageReceiptsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.ssmcontacts.paginators.ListPageReceiptsIterable responses = client
.listPageReceiptsPaginator(request);
for (software.amazon.awssdk.services.ssmcontacts.model.ListPageReceiptsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.ssmcontacts.paginators.ListPageReceiptsIterable responses = client.listPageReceiptsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPageReceipts(software.amazon.awssdk.services.ssmcontacts.model.ListPageReceiptsRequest)
operation.
This is a convenience which creates an instance of the ListPageReceiptsRequest.Builder avoiding the need
to create one manually via ListPageReceiptsRequest.builder()
listPageReceiptsRequest - A Consumer that will call methods on ListPageReceiptsRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmContactsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPagesByContactResponse listPagesByContact(ListPagesByContactRequest listPagesByContactRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Lists the engagements to a contact's contact channels.
listPagesByContactRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmContactsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPagesByContactResponse listPagesByContact(Consumer<ListPagesByContactRequest.Builder> listPagesByContactRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Lists the engagements to a contact's contact channels.
This is a convenience which creates an instance of the ListPagesByContactRequest.Builder avoiding the
need to create one manually via ListPagesByContactRequest.builder()
listPagesByContactRequest - A Consumer that will call methods on ListPagesByContactRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmContactsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPagesByContactIterable listPagesByContactPaginator(ListPagesByContactRequest listPagesByContactRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Lists the engagements to a contact's contact channels.
This is a variant of
listPagesByContact(software.amazon.awssdk.services.ssmcontacts.model.ListPagesByContactRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ssmcontacts.paginators.ListPagesByContactIterable responses = client.listPagesByContactPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.ssmcontacts.paginators.ListPagesByContactIterable responses = client
.listPagesByContactPaginator(request);
for (software.amazon.awssdk.services.ssmcontacts.model.ListPagesByContactResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.ssmcontacts.paginators.ListPagesByContactIterable responses = client.listPagesByContactPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPagesByContact(software.amazon.awssdk.services.ssmcontacts.model.ListPagesByContactRequest)
operation.
listPagesByContactRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmContactsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPagesByContactIterable listPagesByContactPaginator(Consumer<ListPagesByContactRequest.Builder> listPagesByContactRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Lists the engagements to a contact's contact channels.
This is a variant of
listPagesByContact(software.amazon.awssdk.services.ssmcontacts.model.ListPagesByContactRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ssmcontacts.paginators.ListPagesByContactIterable responses = client.listPagesByContactPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.ssmcontacts.paginators.ListPagesByContactIterable responses = client
.listPagesByContactPaginator(request);
for (software.amazon.awssdk.services.ssmcontacts.model.ListPagesByContactResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.ssmcontacts.paginators.ListPagesByContactIterable responses = client.listPagesByContactPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPagesByContact(software.amazon.awssdk.services.ssmcontacts.model.ListPagesByContactRequest)
operation.
This is a convenience which creates an instance of the ListPagesByContactRequest.Builder avoiding the
need to create one manually via ListPagesByContactRequest.builder()
listPagesByContactRequest - A Consumer that will call methods on ListPagesByContactRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmContactsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPagesByEngagementResponse listPagesByEngagement(ListPagesByEngagementRequest listPagesByEngagementRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Lists the engagements to contact channels that occurred by engaging a contact.
listPagesByEngagementRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmContactsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPagesByEngagementResponse listPagesByEngagement(Consumer<ListPagesByEngagementRequest.Builder> listPagesByEngagementRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Lists the engagements to contact channels that occurred by engaging a contact.
This is a convenience which creates an instance of the ListPagesByEngagementRequest.Builder avoiding the
need to create one manually via ListPagesByEngagementRequest.builder()
listPagesByEngagementRequest - A Consumer that will call methods on ListPagesByEngagementRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmContactsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPagesByEngagementIterable listPagesByEngagementPaginator(ListPagesByEngagementRequest listPagesByEngagementRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Lists the engagements to contact channels that occurred by engaging a contact.
This is a variant of
listPagesByEngagement(software.amazon.awssdk.services.ssmcontacts.model.ListPagesByEngagementRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ssmcontacts.paginators.ListPagesByEngagementIterable responses = client.listPagesByEngagementPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.ssmcontacts.paginators.ListPagesByEngagementIterable responses = client
.listPagesByEngagementPaginator(request);
for (software.amazon.awssdk.services.ssmcontacts.model.ListPagesByEngagementResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.ssmcontacts.paginators.ListPagesByEngagementIterable responses = client.listPagesByEngagementPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPagesByEngagement(software.amazon.awssdk.services.ssmcontacts.model.ListPagesByEngagementRequest)
operation.
listPagesByEngagementRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmContactsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPagesByEngagementIterable listPagesByEngagementPaginator(Consumer<ListPagesByEngagementRequest.Builder> listPagesByEngagementRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Lists the engagements to contact channels that occurred by engaging a contact.
This is a variant of
listPagesByEngagement(software.amazon.awssdk.services.ssmcontacts.model.ListPagesByEngagementRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ssmcontacts.paginators.ListPagesByEngagementIterable responses = client.listPagesByEngagementPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.ssmcontacts.paginators.ListPagesByEngagementIterable responses = client
.listPagesByEngagementPaginator(request);
for (software.amazon.awssdk.services.ssmcontacts.model.ListPagesByEngagementResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.ssmcontacts.paginators.ListPagesByEngagementIterable responses = client.listPagesByEngagementPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPagesByEngagement(software.amazon.awssdk.services.ssmcontacts.model.ListPagesByEngagementRequest)
operation.
This is a convenience which creates an instance of the ListPagesByEngagementRequest.Builder avoiding the
need to create one manually via ListPagesByEngagementRequest.builder()
listPagesByEngagementRequest - A Consumer that will call methods on ListPagesByEngagementRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmContactsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws AccessDeniedException, ThrottlingException, ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, SsmContactsException
Lists the tags of an escalation plan or contact.
listTagsForResourceRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmContactsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws AccessDeniedException, ThrottlingException, ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, SsmContactsException
Lists the tags of an escalation plan or contact.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmContactsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutContactPolicyResponse putContactPolicy(PutContactPolicyRequest putContactPolicyRequest) throws AccessDeniedException, ConflictException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, SsmContactsException
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.
putContactPolicyRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmContactsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutContactPolicyResponse putContactPolicy(Consumer<PutContactPolicyRequest.Builder> putContactPolicyRequest) throws AccessDeniedException, ConflictException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, SsmContactsException
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.
This is a convenience which creates an instance of the PutContactPolicyRequest.Builder avoiding the need
to create one manually via PutContactPolicyRequest.builder()
putContactPolicyRequest - A Consumer that will call methods on PutContactPolicyRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmContactsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SendActivationCodeResponse sendActivationCode(SendActivationCodeRequest sendActivationCodeRequest) throws AccessDeniedException, DataEncryptionException, InternalServerException, ResourceNotFoundException, ServiceQuotaExceededException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
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.
sendActivationCodeRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmContactsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SendActivationCodeResponse sendActivationCode(Consumer<SendActivationCodeRequest.Builder> sendActivationCodeRequest) throws AccessDeniedException, DataEncryptionException, InternalServerException, ResourceNotFoundException, ServiceQuotaExceededException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
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.
This is a convenience which creates an instance of the SendActivationCodeRequest.Builder avoiding the
need to create one manually via SendActivationCodeRequest.builder()
sendActivationCodeRequest - A Consumer that will call methods on SendActivationCodeRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmContactsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StartEngagementResponse startEngagement(StartEngagementRequest startEngagementRequest) throws AccessDeniedException, DataEncryptionException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Starts an engagement to a contact or escalation plan. The engagement engages each contact specified in the incident.
startEngagementRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmContactsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StartEngagementResponse startEngagement(Consumer<StartEngagementRequest.Builder> startEngagementRequest) throws AccessDeniedException, DataEncryptionException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Starts an engagement to a contact or escalation plan. The engagement engages each contact specified in the incident.
This is a convenience which creates an instance of the StartEngagementRequest.Builder avoiding the need
to create one manually via StartEngagementRequest.builder()
startEngagementRequest - A Consumer that will call methods on StartEngagementRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmContactsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StopEngagementResponse stopEngagement(StopEngagementRequest stopEngagementRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, SsmContactsException
Stops an engagement before it finishes the final stage of the escalation plan or engagement plan. Further contacts aren't engaged.
stopEngagementRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmContactsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StopEngagementResponse stopEngagement(Consumer<StopEngagementRequest.Builder> stopEngagementRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, SsmContactsException
Stops an engagement before it finishes the final stage of the escalation plan or engagement plan. Further contacts aren't engaged.
This is a convenience which creates an instance of the StopEngagementRequest.Builder avoiding the need to
create one manually via StopEngagementRequest.builder()
stopEngagementRequest - A Consumer that will call methods on StopEngagementRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmContactsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, ServiceQuotaExceededException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Tags a contact or escalation plan. You can tag only contacts and escalation plans in the first region of your replication set.
tagResourceRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmContactsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, ServiceQuotaExceededException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Tags a contact or escalation plan. You can tag only contacts and escalation plans in the first region of your replication set.
This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmContactsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws AccessDeniedException, ThrottlingException, ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, SsmContactsException
Removes tags from the specified resource.
untagResourceRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmContactsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws AccessDeniedException, ThrottlingException, ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, SsmContactsException
Removes tags from the specified resource.
This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmContactsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateContactResponse updateContact(UpdateContactRequest updateContactRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ServiceQuotaExceededException, ThrottlingException, ValidationException, DataEncryptionException, AwsServiceException, SdkClientException, SsmContactsException
Updates the contact or escalation plan specified.
updateContactRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmContactsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateContactResponse updateContact(Consumer<UpdateContactRequest.Builder> updateContactRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ServiceQuotaExceededException, ThrottlingException, ValidationException, DataEncryptionException, AwsServiceException, SdkClientException, SsmContactsException
Updates the contact or escalation plan specified.
This is a convenience which creates an instance of the UpdateContactRequest.Builder avoiding the need to
create one manually via UpdateContactRequest.builder()
updateContactRequest - A Consumer that will call methods on UpdateContactRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmContactsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateContactChannelResponse updateContactChannel(UpdateContactChannelRequest updateContactChannelRequest) throws AccessDeniedException, ConflictException, DataEncryptionException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Updates a contact's contact channel.
updateContactChannelRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmContactsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateContactChannelResponse updateContactChannel(Consumer<UpdateContactChannelRequest.Builder> updateContactChannelRequest) throws AccessDeniedException, ConflictException, DataEncryptionException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Updates a contact's contact channel.
This is a convenience which creates an instance of the UpdateContactChannelRequest.Builder avoiding the
need to create one manually via UpdateContactChannelRequest.builder()
updateContactChannelRequest - A Consumer that will call methods on UpdateContactChannelRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SsmContactsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionstatic ServiceMetadata serviceMetadata()
Copyright © 2022. All rights reserved.