Interface SsmContactsClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface SsmContactsClient
extends AwsClient

Service client for accessing SSM Contacts. This can be created using the static 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.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
default AcceptPageResponse	acceptPage(Consumer<AcceptPageRequest.Builder> acceptPageRequest)	Used to acknowledge an engagement to a contact channel during an incident.
default AcceptPageResponse	acceptPage(AcceptPageRequest acceptPageRequest)	Used to acknowledge an engagement to a contact channel during an incident.
default ActivateContactChannelResponse	activateContactChannel(Consumer<ActivateContactChannelRequest.Builder> activateContactChannelRequest)	Activates a contact's contact channel.
default ActivateContactChannelResponse	activateContactChannel(ActivateContactChannelRequest 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 CreateRotationResponse	createRotation(Consumer<CreateRotationRequest.Builder> createRotationRequest)	Creates a rotation in an on-call schedule.
default CreateRotationResponse	createRotation(CreateRotationRequest createRotationRequest)	Creates a rotation in an on-call schedule.
default CreateRotationOverrideResponse	createRotationOverride(Consumer<CreateRotationOverrideRequest.Builder> createRotationOverrideRequest)	Creates an override for a rotation in an on-call schedule.
default CreateRotationOverrideResponse	createRotationOverride(CreateRotationOverrideRequest createRotationOverrideRequest)	Creates an override for a rotation in an on-call schedule.
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 DeleteRotationResponse	deleteRotation(Consumer<DeleteRotationRequest.Builder> deleteRotationRequest)	Deletes a rotation from the system.
default DeleteRotationResponse	deleteRotation(DeleteRotationRequest deleteRotationRequest)	Deletes a rotation from the system.
default DeleteRotationOverrideResponse	deleteRotationOverride(Consumer<DeleteRotationOverrideRequest.Builder> deleteRotationOverrideRequest)	Deletes an existing override for an on-call rotation.
default DeleteRotationOverrideResponse	deleteRotationOverride(DeleteRotationOverrideRequest deleteRotationOverrideRequest)	Deletes an existing override for an on-call rotation.
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 GetRotationResponse	getRotation(Consumer<GetRotationRequest.Builder> getRotationRequest)	Retrieves information about an on-call rotation.
default GetRotationResponse	getRotation(GetRotationRequest getRotationRequest)	Retrieves information about an on-call rotation.
default GetRotationOverrideResponse	getRotationOverride(Consumer<GetRotationOverrideRequest.Builder> getRotationOverrideRequest)	Retrieves information about an override to an on-call rotation.
default GetRotationOverrideResponse	getRotationOverride(GetRotationOverrideRequest getRotationOverrideRequest)	Retrieves information about an override to an on-call rotation.
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)	This is a variant of listContactChannels(software.amazon.awssdk.services.ssmcontacts.model.ListContactChannelsRequest) operation.
default ListContactChannelsIterable	listContactChannelsPaginator(ListContactChannelsRequest listContactChannelsRequest)	This is a variant of listContactChannels(software.amazon.awssdk.services.ssmcontacts.model.ListContactChannelsRequest) operation.
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)	This is a variant of listContacts(software.amazon.awssdk.services.ssmcontacts.model.ListContactsRequest) operation.
default ListContactsIterable	listContactsPaginator(ListContactsRequest listContactsRequest)	This is a variant of listContacts(software.amazon.awssdk.services.ssmcontacts.model.ListContactsRequest) operation.
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)	This is a variant of listEngagements(software.amazon.awssdk.services.ssmcontacts.model.ListEngagementsRequest) operation.
default ListEngagementsIterable	listEngagementsPaginator(ListEngagementsRequest listEngagementsRequest)	This is a variant of listEngagements(software.amazon.awssdk.services.ssmcontacts.model.ListEngagementsRequest) operation.
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)	This is a variant of listPageReceipts(software.amazon.awssdk.services.ssmcontacts.model.ListPageReceiptsRequest) operation.
default ListPageReceiptsIterable	listPageReceiptsPaginator(ListPageReceiptsRequest listPageReceiptsRequest)	This is a variant of listPageReceipts(software.amazon.awssdk.services.ssmcontacts.model.ListPageReceiptsRequest) operation.
default ListPageResolutionsResponse	listPageResolutions(Consumer<ListPageResolutionsRequest.Builder> listPageResolutionsRequest)	Returns the resolution path of an engagement.
default ListPageResolutionsResponse	listPageResolutions(ListPageResolutionsRequest listPageResolutionsRequest)	Returns the resolution path of an engagement.
default ListPageResolutionsIterable	listPageResolutionsPaginator(Consumer<ListPageResolutionsRequest.Builder> listPageResolutionsRequest)	This is a variant of listPageResolutions(software.amazon.awssdk.services.ssmcontacts.model.ListPageResolutionsRequest) operation.
default ListPageResolutionsIterable	listPageResolutionsPaginator(ListPageResolutionsRequest listPageResolutionsRequest)	This is a variant of listPageResolutions(software.amazon.awssdk.services.ssmcontacts.model.ListPageResolutionsRequest) operation.
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)	This is a variant of listPagesByContact(software.amazon.awssdk.services.ssmcontacts.model.ListPagesByContactRequest) operation.
default ListPagesByContactIterable	listPagesByContactPaginator(ListPagesByContactRequest listPagesByContactRequest)	This is a variant of listPagesByContact(software.amazon.awssdk.services.ssmcontacts.model.ListPagesByContactRequest) operation.
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)	This is a variant of listPagesByEngagement(software.amazon.awssdk.services.ssmcontacts.model.ListPagesByEngagementRequest) operation.
default ListPagesByEngagementIterable	listPagesByEngagementPaginator(ListPagesByEngagementRequest listPagesByEngagementRequest)	This is a variant of listPagesByEngagement(software.amazon.awssdk.services.ssmcontacts.model.ListPagesByEngagementRequest) operation.
default ListPreviewRotationShiftsResponse	listPreviewRotationShifts(Consumer<ListPreviewRotationShiftsRequest.Builder> listPreviewRotationShiftsRequest)	Returns a list of shifts based on rotation configuration parameters.
default ListPreviewRotationShiftsResponse	listPreviewRotationShifts(ListPreviewRotationShiftsRequest listPreviewRotationShiftsRequest)	Returns a list of shifts based on rotation configuration parameters.
default ListPreviewRotationShiftsIterable	listPreviewRotationShiftsPaginator(Consumer<ListPreviewRotationShiftsRequest.Builder> listPreviewRotationShiftsRequest)	This is a variant of listPreviewRotationShifts(software.amazon.awssdk.services.ssmcontacts.model.ListPreviewRotationShiftsRequest) operation.
default ListPreviewRotationShiftsIterable	listPreviewRotationShiftsPaginator(ListPreviewRotationShiftsRequest listPreviewRotationShiftsRequest)	This is a variant of listPreviewRotationShifts(software.amazon.awssdk.services.ssmcontacts.model.ListPreviewRotationShiftsRequest) operation.
default ListRotationOverridesResponse	listRotationOverrides(Consumer<ListRotationOverridesRequest.Builder> listRotationOverridesRequest)	Retrieves a list of overrides currently specified for an on-call rotation.
default ListRotationOverridesResponse	listRotationOverrides(ListRotationOverridesRequest listRotationOverridesRequest)	Retrieves a list of overrides currently specified for an on-call rotation.
default ListRotationOverridesIterable	listRotationOverridesPaginator(Consumer<ListRotationOverridesRequest.Builder> listRotationOverridesRequest)	This is a variant of listRotationOverrides(software.amazon.awssdk.services.ssmcontacts.model.ListRotationOverridesRequest) operation.
default ListRotationOverridesIterable	listRotationOverridesPaginator(ListRotationOverridesRequest listRotationOverridesRequest)	This is a variant of listRotationOverrides(software.amazon.awssdk.services.ssmcontacts.model.ListRotationOverridesRequest) operation.
default ListRotationsResponse	listRotations(Consumer<ListRotationsRequest.Builder> listRotationsRequest)	Retrieves a list of on-call rotations.
default ListRotationsResponse	listRotations(ListRotationsRequest listRotationsRequest)	Retrieves a list of on-call rotations.
default ListRotationShiftsResponse	listRotationShifts(Consumer<ListRotationShiftsRequest.Builder> listRotationShiftsRequest)	Returns a list of shifts generated by an existing rotation in the system.
default ListRotationShiftsResponse	listRotationShifts(ListRotationShiftsRequest listRotationShiftsRequest)	Returns a list of shifts generated by an existing rotation in the system.
default ListRotationShiftsIterable	listRotationShiftsPaginator(Consumer<ListRotationShiftsRequest.Builder> listRotationShiftsRequest)	This is a variant of listRotationShifts(software.amazon.awssdk.services.ssmcontacts.model.ListRotationShiftsRequest) operation.
default ListRotationShiftsIterable	listRotationShiftsPaginator(ListRotationShiftsRequest listRotationShiftsRequest)	This is a variant of listRotationShifts(software.amazon.awssdk.services.ssmcontacts.model.ListRotationShiftsRequest) operation.
default ListRotationsIterable	listRotationsPaginator(Consumer<ListRotationsRequest.Builder> listRotationsRequest)	This is a variant of listRotations(software.amazon.awssdk.services.ssmcontacts.model.ListRotationsRequest) operation.
default ListRotationsIterable	listRotationsPaginator(ListRotationsRequest listRotationsRequest)	This is a variant of listRotations(software.amazon.awssdk.services.ssmcontacts.model.ListRotationsRequest) operation.
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.
default SsmContactsServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
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.
default UpdateRotationResponse	updateRotation(Consumer<UpdateRotationRequest.Builder> updateRotationRequest)	Updates the information specified for an on-call rotation.
default UpdateRotationResponse	updateRotation(UpdateRotationRequest updateRotationRequest)	Updates the information specified for an on-call rotation.

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

acceptPage

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.

Parameters:

acceptPageRequest -

Returns:

Result of the AcceptPage operation returned by the service.

See Also:

• AWS API Documentation

acceptPage

default 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()

Parameters:

acceptPageRequest - A Consumer that will call methods on AcceptPageRequest.Builder to create a request.

Returns:

Result of the AcceptPage operation returned by the service.

See Also:

• AWS API Documentation

activateContactChannel

default 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.

Parameters:

activateContactChannelRequest -

Returns:

Result of the ActivateContactChannel operation returned by the service.

See Also:

• AWS API Documentation

activateContactChannel

default 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()

Parameters:

activateContactChannelRequest - A Consumer that will call methods on ActivateContactChannelRequest.Builder to create a request.

Returns:

Result of the ActivateContactChannel operation returned by the service.

See Also:

• AWS API Documentation

createContact

default 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.

Parameters:

createContactRequest -

Returns:

Result of the CreateContact operation returned by the service.

See Also:

• AWS API Documentation

createContact

default 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()

Parameters:

createContactRequest - A Consumer that will call methods on CreateContactRequest.Builder to create a request.

Returns:

Result of the CreateContact operation returned by the service.

See Also:

• AWS API Documentation

createContactChannel

default 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.

Parameters:

createContactChannelRequest -

Returns:

Result of the CreateContactChannel operation returned by the service.

See Also:

• AWS API Documentation

createContactChannel

default 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()

Parameters:

createContactChannelRequest - A Consumer that will call methods on CreateContactChannelRequest.Builder to create a request.

Returns:

Result of the CreateContactChannel operation returned by the service.

See Also:

• AWS API Documentation

createRotation

default CreateRotationResponse createRotation(CreateRotationRequest createRotationRequest)
                                       throws AccessDeniedException,
InternalServerException,
ResourceNotFoundException,
ServiceQuotaExceededException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
SsmContactsException

Creates a rotation in an on-call schedule.

Parameters:

createRotationRequest -

Returns:

Result of the CreateRotation operation returned by the service.

See Also:

• AWS API Documentation

createRotation

default CreateRotationResponse createRotation(Consumer<CreateRotationRequest.Builder> createRotationRequest)
                                       throws AccessDeniedException,
InternalServerException,
ResourceNotFoundException,
ServiceQuotaExceededException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
SsmContactsException

Creates a rotation in an on-call schedule.

This is a convenience which creates an instance of the CreateRotationRequest.Builder avoiding the need to create one manually via CreateRotationRequest.builder()

Parameters:

createRotationRequest - A Consumer that will call methods on CreateRotationRequest.Builder to create a request.

Returns:

Result of the CreateRotation operation returned by the service.

See Also:

• AWS API Documentation

createRotationOverride

default CreateRotationOverrideResponse createRotationOverride(CreateRotationOverrideRequest createRotationOverrideRequest)
                                                       throws AccessDeniedException,
InternalServerException,
ResourceNotFoundException,
ServiceQuotaExceededException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
SsmContactsException

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

Parameters:

createRotationOverrideRequest -

Returns:

Result of the CreateRotationOverride operation returned by the service.

See Also:

• AWS API Documentation

createRotationOverride

default CreateRotationOverrideResponse createRotationOverride(Consumer<CreateRotationOverrideRequest.Builder> createRotationOverrideRequest)
                                                       throws AccessDeniedException,
InternalServerException,
ResourceNotFoundException,
ServiceQuotaExceededException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
SsmContactsException

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

This is a convenience which creates an instance of the CreateRotationOverrideRequest.Builder avoiding the need to create one manually via CreateRotationOverrideRequest.builder()

Parameters:

createRotationOverrideRequest - A Consumer that will call methods on CreateRotationOverrideRequest.Builder to create a request.

Returns:

Result of the CreateRotationOverride operation returned by the service.

See Also:

• AWS API Documentation

deactivateContactChannel

default 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.

Parameters:

deactivateContactChannelRequest -

Returns:

Result of the DeactivateContactChannel operation returned by the service.

See Also:

• AWS API Documentation

deactivateContactChannel

default 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()

Parameters:

deactivateContactChannelRequest - A Consumer that will call methods on DeactivateContactChannelRequest.Builder to create a request.

Returns:

Result of the DeactivateContactChannel operation returned by the service.

See Also:

• AWS API Documentation

deleteContact

default DeleteContactResponse deleteContact(DeleteContactRequest deleteContactRequest)
                                     throws AccessDeniedException,
InternalServerException,
ResourceNotFoundException,
ThrottlingException,
ConflictException,
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.

Parameters:

deleteContactRequest -

Returns:

Result of the DeleteContact operation returned by the service.

See Also:

• AWS API Documentation

deleteContact

default DeleteContactResponse deleteContact(Consumer<DeleteContactRequest.Builder> deleteContactRequest)
                                     throws AccessDeniedException,
InternalServerException,
ResourceNotFoundException,
ThrottlingException,
ConflictException,
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()

Parameters:

deleteContactRequest - A Consumer that will call methods on DeleteContactRequest.Builder to create a request.

Returns:

Result of the DeleteContact operation returned by the service.

See Also:

• AWS API Documentation

deleteContactChannel

default 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.

Parameters:

deleteContactChannelRequest -

Returns:

Result of the DeleteContactChannel operation returned by the service.

See Also:

• AWS API Documentation

deleteContactChannel

default 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()

Parameters:

deleteContactChannelRequest - A Consumer that will call methods on DeleteContactChannelRequest.Builder to create a request.

Returns:

Result of the DeleteContactChannel operation returned by the service.

See Also:

• AWS API Documentation

deleteRotation

default DeleteRotationResponse deleteRotation(DeleteRotationRequest deleteRotationRequest)
                                       throws AccessDeniedException,
ConflictException,
InternalServerException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
SsmContactsException

Deletes a rotation from the system. If a rotation belongs to more than one on-call schedule, this operation deletes it from all of them.

Parameters:

deleteRotationRequest -

Returns:

Result of the DeleteRotation operation returned by the service.

See Also:

• AWS API Documentation

deleteRotation

default DeleteRotationResponse deleteRotation(Consumer<DeleteRotationRequest.Builder> deleteRotationRequest)
                                       throws AccessDeniedException,
ConflictException,
InternalServerException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
SsmContactsException

Deletes a rotation from the system. If a rotation belongs to more than one on-call schedule, this operation deletes it from all of them.

This is a convenience which creates an instance of the DeleteRotationRequest.Builder avoiding the need to create one manually via DeleteRotationRequest.builder()

Parameters:

deleteRotationRequest - A Consumer that will call methods on DeleteRotationRequest.Builder to create a request.

Returns:

Result of the DeleteRotation operation returned by the service.

See Also:

• AWS API Documentation

deleteRotationOverride

default DeleteRotationOverrideResponse deleteRotationOverride(DeleteRotationOverrideRequest deleteRotationOverrideRequest)
                                                       throws AccessDeniedException,
InternalServerException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
SsmContactsException

Deletes an existing override for an on-call rotation.

Parameters:

deleteRotationOverrideRequest -

Returns:

Result of the DeleteRotationOverride operation returned by the service.

See Also:

• AWS API Documentation

deleteRotationOverride

default DeleteRotationOverrideResponse deleteRotationOverride(Consumer<DeleteRotationOverrideRequest.Builder> deleteRotationOverrideRequest)
                                                       throws AccessDeniedException,
InternalServerException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
SsmContactsException

Deletes an existing override for an on-call rotation.

This is a convenience which creates an instance of the DeleteRotationOverrideRequest.Builder avoiding the need to create one manually via DeleteRotationOverrideRequest.builder()

Parameters:

deleteRotationOverrideRequest - A Consumer that will call methods on DeleteRotationOverrideRequest.Builder to create a request.

Returns:

Result of the DeleteRotationOverride operation returned by the service.

See Also:

• AWS API Documentation

describeEngagement

default 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.

Parameters:

describeEngagementRequest -

Returns:

Result of the DescribeEngagement operation returned by the service.

See Also:

• AWS API Documentation

describeEngagement

default 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()

Parameters:

describeEngagementRequest - A Consumer that will call methods on DescribeEngagementRequest.Builder to create a request.

Returns:

Result of the DescribeEngagement operation returned by the service.

See Also:

• AWS API Documentation

describePage

default DescribePageResponse describePage(DescribePageRequest describePageRequest)
                                   throws AccessDeniedException,
DataEncryptionException,
InternalServerException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
SsmContactsException

Lists details of the engagement to a contact channel.

Parameters:

describePageRequest -

Returns:

Result of the DescribePage operation returned by the service.

See Also:

• AWS API Documentation

describePage

default 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()

Parameters:

describePageRequest - A Consumer that will call methods on DescribePageRequest.Builder to create a request.

Returns:

Result of the DescribePage operation returned by the service.

See Also:

• AWS API Documentation

getContact

default GetContactResponse getContact(GetContactRequest getContactRequest)
                               throws AccessDeniedException,
InternalServerException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
DataEncryptionException,
AwsServiceException,
SdkClientException,
SsmContactsException

Retrieves information about the specified contact or escalation plan.

Parameters:

getContactRequest -

Returns:

Result of the GetContact operation returned by the service.

See Also:

• AWS API Documentation

getContact

default 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()

Parameters:

getContactRequest - A Consumer that will call methods on GetContactRequest.Builder to create a request.

Returns:

Result of the GetContact operation returned by the service.

See Also:

• AWS API Documentation

getContactChannel

default GetContactChannelResponse getContactChannel(GetContactChannelRequest getContactChannelRequest)
                                             throws AccessDeniedException,
DataEncryptionException,
InternalServerException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
SsmContactsException

List details about a specific contact channel.

Parameters:

getContactChannelRequest -

Returns:

Result of the GetContactChannel operation returned by the service.

See Also:

• AWS API Documentation

getContactChannel

default 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()

Parameters:

getContactChannelRequest - A Consumer that will call methods on GetContactChannelRequest.Builder to create a request.

Returns:

Result of the GetContactChannel operation returned by the service.

See Also:

• AWS API Documentation

getContactPolicy

default 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.

Parameters:

getContactPolicyRequest -

Returns:

Result of the GetContactPolicy operation returned by the service.

See Also:

• AWS API Documentation

getContactPolicy

default 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()

Parameters:

getContactPolicyRequest - A Consumer that will call methods on GetContactPolicyRequest.Builder to create a request.

Returns:

Result of the GetContactPolicy operation returned by the service.

See Also:

• AWS API Documentation

getRotation

default GetRotationResponse getRotation(GetRotationRequest getRotationRequest)
                                 throws AccessDeniedException,
InternalServerException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
SsmContactsException

Retrieves information about an on-call rotation.

Parameters:

getRotationRequest -

Returns:

Result of the GetRotation operation returned by the service.

See Also:

• AWS API Documentation

getRotation

default GetRotationResponse getRotation(Consumer<GetRotationRequest.Builder> getRotationRequest)
                                 throws AccessDeniedException,
InternalServerException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
SsmContactsException

Retrieves information about an on-call rotation.

This is a convenience which creates an instance of the GetRotationRequest.Builder avoiding the need to create one manually via GetRotationRequest.builder()

Parameters:

getRotationRequest - A Consumer that will call methods on GetRotationRequest.Builder to create a request.

Returns:

Result of the GetRotation operation returned by the service.

See Also:

• AWS API Documentation

getRotationOverride

default GetRotationOverrideResponse getRotationOverride(GetRotationOverrideRequest getRotationOverrideRequest)
                                                 throws AccessDeniedException,
InternalServerException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
SsmContactsException

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

Parameters:

getRotationOverrideRequest -

Returns:

Result of the GetRotationOverride operation returned by the service.

See Also:

• AWS API Documentation

getRotationOverride

default GetRotationOverrideResponse getRotationOverride(Consumer<GetRotationOverrideRequest.Builder> getRotationOverrideRequest)
                                                 throws AccessDeniedException,
InternalServerException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
SsmContactsException

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

This is a convenience which creates an instance of the GetRotationOverrideRequest.Builder avoiding the need to create one manually via GetRotationOverrideRequest.builder()

Parameters:

getRotationOverrideRequest - A Consumer that will call methods on GetRotationOverrideRequest.Builder to create a request.

Returns:

Result of the GetRotationOverride operation returned by the service.

See Also:

• AWS API Documentation

listContactChannels

default ListContactChannelsResponse listContactChannels(ListContactChannelsRequest listContactChannelsRequest)
                                                 throws AccessDeniedException,
DataEncryptionException,
InternalServerException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
SsmContactsException

Lists all contact channels for the specified contact.

Parameters:

listContactChannelsRequest -

Returns:

Result of the ListContactChannels operation returned by the service.

See Also:

• AWS API Documentation

listContactChannels

default 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()

Parameters:

listContactChannelsRequest - A Consumer that will call methods on ListContactChannelsRequest.Builder to create a request.

Returns:

Result of the ListContactChannels operation returned by the service.

See Also:

• AWS API Documentation

listContactChannelsPaginator

default ListContactChannelsIterable listContactChannelsPaginator(ListContactChannelsRequest listContactChannelsRequest)
                                                          throws AccessDeniedException,
DataEncryptionException,
InternalServerException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
SsmContactsException

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.

Parameters:

listContactChannelsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listContactChannelsPaginator

default ListContactChannelsIterable listContactChannelsPaginator(Consumer<ListContactChannelsRequest.Builder> listContactChannelsRequest)
                                                          throws AccessDeniedException,
DataEncryptionException,
InternalServerException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
SsmContactsException

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()

Parameters:

listContactChannelsRequest - A Consumer that will call methods on ListContactChannelsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listContacts

default ListContactsResponse listContacts(ListContactsRequest listContactsRequest)
                                   throws AccessDeniedException,
InternalServerException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
SsmContactsException

Lists all contacts and escalation plans in Incident Manager.

Parameters:

listContactsRequest -

Returns:

Result of the ListContacts operation returned by the service.

See Also:

• AWS API Documentation

listContacts

default 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()

Parameters:

listContactsRequest - A Consumer that will call methods on ListContactsRequest.Builder to create a request.

Returns:

Result of the ListContacts operation returned by the service.

See Also:

• AWS API Documentation

listContactsPaginator

default ListContactsIterable listContactsPaginator(ListContactsRequest listContactsRequest)
                                            throws AccessDeniedException,
InternalServerException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
SsmContactsException

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.

Parameters:

listContactsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listContactsPaginator

default ListContactsIterable listContactsPaginator(Consumer<ListContactsRequest.Builder> listContactsRequest)
                                            throws AccessDeniedException,
InternalServerException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
SsmContactsException

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()

Parameters:

listContactsRequest - A Consumer that will call methods on ListContactsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listEngagements

default ListEngagementsResponse listEngagements(ListEngagementsRequest listEngagementsRequest)
                                         throws AccessDeniedException,
InternalServerException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
SsmContactsException

Lists all engagements that have happened in an incident.

Parameters:

listEngagementsRequest -

Returns:

Result of the ListEngagements operation returned by the service.

See Also:

• AWS API Documentation

listEngagements

default 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()

Parameters:

listEngagementsRequest - A Consumer that will call methods on ListEngagementsRequest.Builder to create a request.

Returns:

Result of the ListEngagements operation returned by the service.

See Also:

• AWS API Documentation

listEngagementsPaginator

default ListEngagementsIterable listEngagementsPaginator(ListEngagementsRequest listEngagementsRequest)
                                                  throws AccessDeniedException,
InternalServerException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
SsmContactsException

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.

Parameters:

listEngagementsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listEngagementsPaginator

default ListEngagementsIterable listEngagementsPaginator(Consumer<ListEngagementsRequest.Builder> listEngagementsRequest)
                                                  throws AccessDeniedException,
InternalServerException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
SsmContactsException

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()

Parameters:

listEngagementsRequest - A Consumer that will call methods on ListEngagementsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listPageReceipts

default 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.

Parameters:

listPageReceiptsRequest -

Returns:

Result of the ListPageReceipts operation returned by the service.

See Also:

• AWS API Documentation

listPageReceipts

default 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()

Parameters:

listPageReceiptsRequest - A Consumer that will call methods on ListPageReceiptsRequest.Builder to create a request.

Returns:

Result of the ListPageReceipts operation returned by the service.

See Also:

• AWS API Documentation

listPageReceiptsPaginator

default ListPageReceiptsIterable listPageReceiptsPaginator(ListPageReceiptsRequest listPageReceiptsRequest)
                                                    throws AccessDeniedException,
InternalServerException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
SsmContactsException

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.

Parameters:

listPageReceiptsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listPageReceiptsPaginator

default ListPageReceiptsIterable listPageReceiptsPaginator(Consumer<ListPageReceiptsRequest.Builder> listPageReceiptsRequest)
                                                    throws AccessDeniedException,
InternalServerException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
SsmContactsException

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()

Parameters:

listPageReceiptsRequest - A Consumer that will call methods on ListPageReceiptsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listPageResolutions

default ListPageResolutionsResponse listPageResolutions(ListPageResolutionsRequest listPageResolutionsRequest)
                                                 throws AccessDeniedException,
InternalServerException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
SsmContactsException

Returns the resolution path of an engagement. For example, the escalation plan engaged in an incident might target an on-call schedule that includes several contacts in a rotation, but just one contact on-call when the incident starts. The resolution path indicates the hierarchy of escalation plan > on-call schedule > contact.

Parameters:

listPageResolutionsRequest -

Returns:

Result of the ListPageResolutions operation returned by the service.

See Also:

• AWS API Documentation

listPageResolutions

default ListPageResolutionsResponse listPageResolutions(Consumer<ListPageResolutionsRequest.Builder> listPageResolutionsRequest)
                                                 throws AccessDeniedException,
InternalServerException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
SsmContactsException

Returns the resolution path of an engagement. For example, the escalation plan engaged in an incident might target an on-call schedule that includes several contacts in a rotation, but just one contact on-call when the incident starts. The resolution path indicates the hierarchy of escalation plan > on-call schedule > contact.

This is a convenience which creates an instance of the ListPageResolutionsRequest.Builder avoiding the need to create one manually via ListPageResolutionsRequest.builder()

Parameters:

listPageResolutionsRequest - A Consumer that will call methods on ListPageResolutionsRequest.Builder to create a request.

Returns:

Result of the ListPageResolutions operation returned by the service.

See Also:

• AWS API Documentation

listPageResolutionsPaginator

default ListPageResolutionsIterable listPageResolutionsPaginator(ListPageResolutionsRequest listPageResolutionsRequest)
                                                          throws AccessDeniedException,
InternalServerException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
SsmContactsException

This is a variant of listPageResolutions(software.amazon.awssdk.services.ssmcontacts.model.ListPageResolutionsRequest) 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.ListPageResolutionsIterable responses = client.listPageResolutionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssmcontacts.paginators.ListPageResolutionsIterable responses = client
             .listPageResolutionsPaginator(request);
     for (software.amazon.awssdk.services.ssmcontacts.model.ListPageResolutionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssmcontacts.paginators.ListPageResolutionsIterable responses = client.listPageResolutionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of null 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 listPageResolutions(software.amazon.awssdk.services.ssmcontacts.model.ListPageResolutionsRequest) operation.

Parameters:

listPageResolutionsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listPageResolutionsPaginator

default ListPageResolutionsIterable listPageResolutionsPaginator(Consumer<ListPageResolutionsRequest.Builder> listPageResolutionsRequest)
                                                          throws AccessDeniedException,
InternalServerException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
SsmContactsException

This is a variant of listPageResolutions(software.amazon.awssdk.services.ssmcontacts.model.ListPageResolutionsRequest) 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.ListPageResolutionsIterable responses = client.listPageResolutionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssmcontacts.paginators.ListPageResolutionsIterable responses = client
             .listPageResolutionsPaginator(request);
     for (software.amazon.awssdk.services.ssmcontacts.model.ListPageResolutionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssmcontacts.paginators.ListPageResolutionsIterable responses = client.listPageResolutionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of null 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 listPageResolutions(software.amazon.awssdk.services.ssmcontacts.model.ListPageResolutionsRequest) operation.

This is a convenience which creates an instance of the ListPageResolutionsRequest.Builder avoiding the need to create one manually via ListPageResolutionsRequest.builder()

Parameters:

listPageResolutionsRequest - A Consumer that will call methods on ListPageResolutionsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listPagesByContact

default ListPagesByContactResponse listPagesByContact(ListPagesByContactRequest listPagesByContactRequest)
                                               throws AccessDeniedException,
InternalServerException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
SsmContactsException

Lists the engagements to a contact's contact channels.

Parameters:

listPagesByContactRequest -

Returns:

Result of the ListPagesByContact operation returned by the service.

See Also:

• AWS API Documentation

listPagesByContact

default 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()

Parameters:

listPagesByContactRequest - A Consumer that will call methods on ListPagesByContactRequest.Builder to create a request.

Returns:

Result of the ListPagesByContact operation returned by the service.

See Also:

• AWS API Documentation

listPagesByContactPaginator

default ListPagesByContactIterable listPagesByContactPaginator(ListPagesByContactRequest listPagesByContactRequest)
                                                        throws AccessDeniedException,
InternalServerException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
SsmContactsException

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.

Parameters:

listPagesByContactRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listPagesByContactPaginator

default ListPagesByContactIterable listPagesByContactPaginator(Consumer<ListPagesByContactRequest.Builder> listPagesByContactRequest)
                                                        throws AccessDeniedException,
InternalServerException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
SsmContactsException

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()

Parameters:

listPagesByContactRequest - A Consumer that will call methods on ListPagesByContactRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listPagesByEngagement

default 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.

Parameters:

listPagesByEngagementRequest -

Returns:

Result of the ListPagesByEngagement operation returned by the service.

See Also:

• AWS API Documentation

listPagesByEngagement

default 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()

Parameters:

listPagesByEngagementRequest - A Consumer that will call methods on ListPagesByEngagementRequest.Builder to create a request.

Returns:

Result of the ListPagesByEngagement operation returned by the service.

See Also:

• AWS API Documentation

listPagesByEngagementPaginator

default ListPagesByEngagementIterable listPagesByEngagementPaginator(ListPagesByEngagementRequest listPagesByEngagementRequest)
                                                              throws AccessDeniedException,
InternalServerException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
SsmContactsException

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.

Parameters:

listPagesByEngagementRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listPagesByEngagementPaginator

default ListPagesByEngagementIterable listPagesByEngagementPaginator(Consumer<ListPagesByEngagementRequest.Builder> listPagesByEngagementRequest)
                                                              throws AccessDeniedException,
InternalServerException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
SsmContactsException

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()

Parameters:

listPagesByEngagementRequest - A Consumer that will call methods on ListPagesByEngagementRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listPreviewRotationShifts

default ListPreviewRotationShiftsResponse listPreviewRotationShifts(ListPreviewRotationShiftsRequest listPreviewRotationShiftsRequest)
                                                             throws AccessDeniedException,
InternalServerException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
SsmContactsException

Returns a list of shifts based on rotation configuration parameters.

The Incident Manager primarily uses this operation to populate the Preview calendar. It is not typically run by end users.

Parameters:

listPreviewRotationShiftsRequest -

Returns:

Result of the ListPreviewRotationShifts operation returned by the service.

See Also:

• AWS API Documentation

listPreviewRotationShifts

default ListPreviewRotationShiftsResponse listPreviewRotationShifts(Consumer<ListPreviewRotationShiftsRequest.Builder> listPreviewRotationShiftsRequest)
                                                             throws AccessDeniedException,
InternalServerException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
SsmContactsException

Returns a list of shifts based on rotation configuration parameters.

The Incident Manager primarily uses this operation to populate the Preview calendar. It is not typically run by end users.

This is a convenience which creates an instance of the ListPreviewRotationShiftsRequest.Builder avoiding the need to create one manually via ListPreviewRotationShiftsRequest.builder()

Parameters:

listPreviewRotationShiftsRequest - A Consumer that will call methods on ListPreviewRotationShiftsRequest.Builder to create a request.

Returns:

Result of the ListPreviewRotationShifts operation returned by the service.

See Also:

• AWS API Documentation

listPreviewRotationShiftsPaginator

default ListPreviewRotationShiftsIterable listPreviewRotationShiftsPaginator(ListPreviewRotationShiftsRequest listPreviewRotationShiftsRequest)
                                                                      throws AccessDeniedException,
InternalServerException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
SsmContactsException

This is a variant of listPreviewRotationShifts(software.amazon.awssdk.services.ssmcontacts.model.ListPreviewRotationShiftsRequest) 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.ListPreviewRotationShiftsIterable responses = client.listPreviewRotationShiftsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssmcontacts.paginators.ListPreviewRotationShiftsIterable responses = client
             .listPreviewRotationShiftsPaginator(request);
     for (software.amazon.awssdk.services.ssmcontacts.model.ListPreviewRotationShiftsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssmcontacts.paginators.ListPreviewRotationShiftsIterable responses = client.listPreviewRotationShiftsPaginator(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 listPreviewRotationShifts(software.amazon.awssdk.services.ssmcontacts.model.ListPreviewRotationShiftsRequest) operation.

Parameters:

listPreviewRotationShiftsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listPreviewRotationShiftsPaginator

default ListPreviewRotationShiftsIterable listPreviewRotationShiftsPaginator(Consumer<ListPreviewRotationShiftsRequest.Builder> listPreviewRotationShiftsRequest)
                                                                      throws AccessDeniedException,
InternalServerException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
SsmContactsException

This is a variant of listPreviewRotationShifts(software.amazon.awssdk.services.ssmcontacts.model.ListPreviewRotationShiftsRequest) 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.ListPreviewRotationShiftsIterable responses = client.listPreviewRotationShiftsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssmcontacts.paginators.ListPreviewRotationShiftsIterable responses = client
             .listPreviewRotationShiftsPaginator(request);
     for (software.amazon.awssdk.services.ssmcontacts.model.ListPreviewRotationShiftsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssmcontacts.paginators.ListPreviewRotationShiftsIterable responses = client.listPreviewRotationShiftsPaginator(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 listPreviewRotationShifts(software.amazon.awssdk.services.ssmcontacts.model.ListPreviewRotationShiftsRequest) operation.

This is a convenience which creates an instance of the ListPreviewRotationShiftsRequest.Builder avoiding the need to create one manually via ListPreviewRotationShiftsRequest.builder()

Parameters:

listPreviewRotationShiftsRequest - A Consumer that will call methods on ListPreviewRotationShiftsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listRotationOverrides

default ListRotationOverridesResponse listRotationOverrides(ListRotationOverridesRequest listRotationOverridesRequest)
                                                     throws AccessDeniedException,
InternalServerException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
SsmContactsException

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

Parameters:

listRotationOverridesRequest -

Returns:

Result of the ListRotationOverrides operation returned by the service.

See Also:

• AWS API Documentation

listRotationOverrides

default ListRotationOverridesResponse listRotationOverrides(Consumer<ListRotationOverridesRequest.Builder> listRotationOverridesRequest)
                                                     throws AccessDeniedException,
InternalServerException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
SsmContactsException

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

This is a convenience which creates an instance of the ListRotationOverridesRequest.Builder avoiding the need to create one manually via ListRotationOverridesRequest.builder()

Parameters:

listRotationOverridesRequest - A Consumer that will call methods on ListRotationOverridesRequest.Builder to create a request.

Returns:

Result of the ListRotationOverrides operation returned by the service.

See Also:

• AWS API Documentation

listRotationOverridesPaginator

default ListRotationOverridesIterable listRotationOverridesPaginator(ListRotationOverridesRequest listRotationOverridesRequest)
                                                              throws AccessDeniedException,
InternalServerException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
SsmContactsException

This is a variant of listRotationOverrides(software.amazon.awssdk.services.ssmcontacts.model.ListRotationOverridesRequest) 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.ListRotationOverridesIterable responses = client.listRotationOverridesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssmcontacts.paginators.ListRotationOverridesIterable responses = client
             .listRotationOverridesPaginator(request);
     for (software.amazon.awssdk.services.ssmcontacts.model.ListRotationOverridesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssmcontacts.paginators.ListRotationOverridesIterable responses = client.listRotationOverridesPaginator(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 listRotationOverrides(software.amazon.awssdk.services.ssmcontacts.model.ListRotationOverridesRequest) operation.

Parameters:

listRotationOverridesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listRotationOverridesPaginator

default ListRotationOverridesIterable listRotationOverridesPaginator(Consumer<ListRotationOverridesRequest.Builder> listRotationOverridesRequest)
                                                              throws AccessDeniedException,
InternalServerException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
SsmContactsException

This is a variant of listRotationOverrides(software.amazon.awssdk.services.ssmcontacts.model.ListRotationOverridesRequest) 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.ListRotationOverridesIterable responses = client.listRotationOverridesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssmcontacts.paginators.ListRotationOverridesIterable responses = client
             .listRotationOverridesPaginator(request);
     for (software.amazon.awssdk.services.ssmcontacts.model.ListRotationOverridesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssmcontacts.paginators.ListRotationOverridesIterable responses = client.listRotationOverridesPaginator(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 listRotationOverrides(software.amazon.awssdk.services.ssmcontacts.model.ListRotationOverridesRequest) operation.

This is a convenience which creates an instance of the ListRotationOverridesRequest.Builder avoiding the need to create one manually via ListRotationOverridesRequest.builder()

Parameters:

listRotationOverridesRequest - A Consumer that will call methods on ListRotationOverridesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listRotationShifts

default ListRotationShiftsResponse listRotationShifts(ListRotationShiftsRequest listRotationShiftsRequest)
                                               throws AccessDeniedException,
ConflictException,
InternalServerException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
SsmContactsException

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

Parameters:

listRotationShiftsRequest -

Returns:

Result of the ListRotationShifts operation returned by the service.

See Also:

• AWS API Documentation

listRotationShifts

default ListRotationShiftsResponse listRotationShifts(Consumer<ListRotationShiftsRequest.Builder> listRotationShiftsRequest)
                                               throws AccessDeniedException,
ConflictException,
InternalServerException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
SsmContactsException

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

This is a convenience which creates an instance of the ListRotationShiftsRequest.Builder avoiding the need to create one manually via ListRotationShiftsRequest.builder()

Parameters:

listRotationShiftsRequest - A Consumer that will call methods on ListRotationShiftsRequest.Builder to create a request.

Returns:

Result of the ListRotationShifts operation returned by the service.

See Also:

• AWS API Documentation

listRotationShiftsPaginator

default ListRotationShiftsIterable listRotationShiftsPaginator(ListRotationShiftsRequest listRotationShiftsRequest)
                                                        throws AccessDeniedException,
ConflictException,
InternalServerException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
SsmContactsException

This is a variant of listRotationShifts(software.amazon.awssdk.services.ssmcontacts.model.ListRotationShiftsRequest) 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.ListRotationShiftsIterable responses = client.listRotationShiftsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssmcontacts.paginators.ListRotationShiftsIterable responses = client
             .listRotationShiftsPaginator(request);
     for (software.amazon.awssdk.services.ssmcontacts.model.ListRotationShiftsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssmcontacts.paginators.ListRotationShiftsIterable responses = client.listRotationShiftsPaginator(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 listRotationShifts(software.amazon.awssdk.services.ssmcontacts.model.ListRotationShiftsRequest) operation.

Parameters:

listRotationShiftsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listRotationShiftsPaginator

default ListRotationShiftsIterable listRotationShiftsPaginator(Consumer<ListRotationShiftsRequest.Builder> listRotationShiftsRequest)
                                                        throws AccessDeniedException,
ConflictException,
InternalServerException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
SsmContactsException

This is a variant of listRotationShifts(software.amazon.awssdk.services.ssmcontacts.model.ListRotationShiftsRequest) 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.ListRotationShiftsIterable responses = client.listRotationShiftsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssmcontacts.paginators.ListRotationShiftsIterable responses = client
             .listRotationShiftsPaginator(request);
     for (software.amazon.awssdk.services.ssmcontacts.model.ListRotationShiftsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssmcontacts.paginators.ListRotationShiftsIterable responses = client.listRotationShiftsPaginator(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 listRotationShifts(software.amazon.awssdk.services.ssmcontacts.model.ListRotationShiftsRequest) operation.

This is a convenience which creates an instance of the ListRotationShiftsRequest.Builder avoiding the need to create one manually via ListRotationShiftsRequest.builder()

Parameters:

listRotationShiftsRequest - A Consumer that will call methods on ListRotationShiftsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listRotations

default ListRotationsResponse listRotations(ListRotationsRequest listRotationsRequest)
                                     throws AccessDeniedException,
InternalServerException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
SsmContactsException

Retrieves a list of on-call rotations.

Parameters:

listRotationsRequest -

Returns:

Result of the ListRotations operation returned by the service.

See Also:

• AWS API Documentation

listRotations

default ListRotationsResponse listRotations(Consumer<ListRotationsRequest.Builder> listRotationsRequest)
                                     throws AccessDeniedException,
InternalServerException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
SsmContactsException

Retrieves a list of on-call rotations.

This is a convenience which creates an instance of the ListRotationsRequest.Builder avoiding the need to create one manually via ListRotationsRequest.builder()

Parameters:

listRotationsRequest - A Consumer that will call methods on ListRotationsRequest.Builder to create a request.

Returns:

Result of the ListRotations operation returned by the service.

See Also:

• AWS API Documentation

listRotationsPaginator

default ListRotationsIterable listRotationsPaginator(ListRotationsRequest listRotationsRequest)
                                              throws AccessDeniedException,
InternalServerException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
SsmContactsException

This is a variant of listRotations(software.amazon.awssdk.services.ssmcontacts.model.ListRotationsRequest) 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.ListRotationsIterable responses = client.listRotationsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssmcontacts.paginators.ListRotationsIterable responses = client
             .listRotationsPaginator(request);
     for (software.amazon.awssdk.services.ssmcontacts.model.ListRotationsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssmcontacts.paginators.ListRotationsIterable responses = client.listRotationsPaginator(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 listRotations(software.amazon.awssdk.services.ssmcontacts.model.ListRotationsRequest) operation.

Parameters:

listRotationsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listRotationsPaginator

default ListRotationsIterable listRotationsPaginator(Consumer<ListRotationsRequest.Builder> listRotationsRequest)
                                              throws AccessDeniedException,
InternalServerException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
SsmContactsException

This is a variant of listRotations(software.amazon.awssdk.services.ssmcontacts.model.ListRotationsRequest) 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.ListRotationsIterable responses = client.listRotationsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.ssmcontacts.paginators.ListRotationsIterable responses = client
             .listRotationsPaginator(request);
     for (software.amazon.awssdk.services.ssmcontacts.model.ListRotationsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.ssmcontacts.paginators.ListRotationsIterable responses = client.listRotationsPaginator(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 listRotations(software.amazon.awssdk.services.ssmcontacts.model.ListRotationsRequest) operation.

This is a convenience which creates an instance of the ListRotationsRequest.Builder avoiding the need to create one manually via ListRotationsRequest.builder()

Parameters:

listRotationsRequest - A Consumer that will call methods on ListRotationsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws AccessDeniedException,
ThrottlingException,
ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
SsmContactsException

Lists the tags of an escalation plan or contact.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

listTagsForResource

default 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()

Parameters:

listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

putContactPolicy

default 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.

Parameters:

putContactPolicyRequest -

Returns:

Result of the PutContactPolicy operation returned by the service.

See Also:

• AWS API Documentation

putContactPolicy

default 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()

Parameters:

putContactPolicyRequest - A Consumer that will call methods on PutContactPolicyRequest.Builder to create a request.

Returns:

Result of the PutContactPolicy operation returned by the service.

See Also:

• AWS API Documentation

sendActivationCode

default 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.

Parameters:

sendActivationCodeRequest -

Returns:

Result of the SendActivationCode operation returned by the service.

See Also:

• AWS API Documentation

sendActivationCode

default 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()

Parameters:

sendActivationCodeRequest - A Consumer that will call methods on SendActivationCodeRequest.Builder to create a request.

Returns:

Result of the SendActivationCode operation returned by the service.

See Also:

• AWS API Documentation

startEngagement

default 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.

Parameters:

startEngagementRequest -

Returns:

Result of the StartEngagement operation returned by the service.

See Also:

• AWS API Documentation

startEngagement

default 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()

Parameters:

startEngagementRequest - A Consumer that will call methods on StartEngagementRequest.Builder to create a request.

Returns:

Result of the StartEngagement operation returned by the service.

See Also:

• AWS API Documentation

stopEngagement

default 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.

Parameters:

stopEngagementRequest -

Returns:

Result of the StopEngagement operation returned by the service.

See Also:

• AWS API Documentation

stopEngagement

default 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()

Parameters:

stopEngagementRequest - A Consumer that will call methods on StopEngagementRequest.Builder to create a request.

Returns:

Result of the StopEngagement operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default 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.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default 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()

Parameters:

tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws AccessDeniedException,
ThrottlingException,
ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
SsmContactsException

Removes tags from the specified resource.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default 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()

Parameters:

untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

updateContact

default UpdateContactResponse updateContact(UpdateContactRequest updateContactRequest)
                                     throws AccessDeniedException,
InternalServerException,
ResourceNotFoundException,
ServiceQuotaExceededException,
ThrottlingException,
ValidationException,
DataEncryptionException,
AwsServiceException,
SdkClientException,
SsmContactsException

Updates the contact or escalation plan specified.

Parameters:

updateContactRequest -

Returns:

Result of the UpdateContact operation returned by the service.

See Also:

• AWS API Documentation

updateContact

default 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()

Parameters:

updateContactRequest - A Consumer that will call methods on UpdateContactRequest.Builder to create a request.

Returns:

Result of the UpdateContact operation returned by the service.

See Also:

• AWS API Documentation

updateContactChannel

default UpdateContactChannelResponse updateContactChannel(UpdateContactChannelRequest updateContactChannelRequest)
                                                   throws AccessDeniedException,
ConflictException,
DataEncryptionException,
InternalServerException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
SsmContactsException

Updates a contact's contact channel.

Parameters:

updateContactChannelRequest -

Returns:

Result of the UpdateContactChannel operation returned by the service.

See Also:

• AWS API Documentation

updateContactChannel

default 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()

Parameters:

updateContactChannelRequest - A Consumer that will call methods on UpdateContactChannelRequest.Builder to create a request.

Returns:

Result of the UpdateContactChannel operation returned by the service.

See Also:

• AWS API Documentation

updateRotation

default UpdateRotationResponse updateRotation(UpdateRotationRequest updateRotationRequest)
                                       throws AccessDeniedException,
ConflictException,
InternalServerException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
SsmContactsException

Updates the information specified for an on-call rotation.

Parameters:

updateRotationRequest -

Returns:

Result of the UpdateRotation operation returned by the service.

See Also:

• AWS API Documentation

updateRotation

default UpdateRotationResponse updateRotation(Consumer<UpdateRotationRequest.Builder> updateRotationRequest)
                                       throws AccessDeniedException,
ConflictException,
InternalServerException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
SsmContactsException

Updates the information specified for an on-call rotation.

This is a convenience which creates an instance of the UpdateRotationRequest.Builder avoiding the need to create one manually via UpdateRotationRequest.builder()

Parameters:

updateRotationRequest - A Consumer that will call methods on UpdateRotationRequest.Builder to create a request.

Returns:

Result of the UpdateRotation operation returned by the service.

See Also:

• AWS API Documentation

create

static SsmContactsClient create()

Create a SsmContactsClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static SsmContactsClientBuilder builder()

Create a builder that can be used to configure and create a SsmContactsClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default SsmContactsServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration