Package software.amazon.awssdk.services.ssmcontacts

Interface SsmContactsAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface SsmContactsAsyncClient extends AwsClient
Service client for accessing SSM Contacts asynchronously. This can be created using the static builder() method.The asynchronous client performs non-blocking I/O when configured with any
invalid reference 
SdkAsyncHttpClient
supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API call.

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 Details

  • Method Details

    • acceptPage

      default CompletableFuture<AcceptPageResponse> acceptPage(AcceptPageRequest acceptPageRequest)

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

      Parameters:
      acceptPageRequest -
      Returns:
      A Java Future containing the result of the AcceptPage operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • InternalServerException Unexpected error occurred while processing the request.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • acceptPage

      default CompletableFuture<AcceptPageResponse> acceptPage(Consumer<AcceptPageRequest.Builder> acceptPageRequest)

      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:
      A Java Future containing the result of the AcceptPage operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • InternalServerException Unexpected error occurred while processing the request.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • activateContactChannel

      default CompletableFuture<ActivateContactChannelResponse> activateContactChannel(ActivateContactChannelRequest activateContactChannelRequest)

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

      Parameters:
      activateContactChannelRequest -
      Returns:
      A Java Future containing the result of the ActivateContactChannel operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • InternalServerException Unexpected error occurred while processing the request.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • activateContactChannel

      default CompletableFuture<ActivateContactChannelResponse> activateContactChannel(Consumer<ActivateContactChannelRequest.Builder> activateContactChannelRequest)

      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:
      A Java Future containing the result of the ActivateContactChannel operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • InternalServerException Unexpected error occurred while processing the request.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createContact

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

      Parameters:
      createContactRequest -
      Returns:
      A Java Future containing the result of the CreateContact operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • ConflictException Updating or deleting a resource causes an inconsistent state.
      • InternalServerException Unexpected error occurred while processing the request.
      • ServiceQuotaExceededException Request would cause a service quota to be exceeded.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • DataEncryptionException The operation failed to due an encryption key error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createContact

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


      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:
      A Java Future containing the result of the CreateContact operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • ConflictException Updating or deleting a resource causes an inconsistent state.
      • InternalServerException Unexpected error occurred while processing the request.
      • ServiceQuotaExceededException Request would cause a service quota to be exceeded.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • DataEncryptionException The operation failed to due an encryption key error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createContactChannel

      default CompletableFuture<CreateContactChannelResponse> createContactChannel(CreateContactChannelRequest createContactChannelRequest)

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

      Parameters:
      createContactChannelRequest -
      Returns:
      A Java Future containing the result of the CreateContactChannel operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • ConflictException Updating or deleting a resource causes an inconsistent state.
      • DataEncryptionException The operation failed to due an encryption key error.
      • InternalServerException Unexpected error occurred while processing the request.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createContactChannel

      default CompletableFuture<CreateContactChannelResponse> createContactChannel(Consumer<CreateContactChannelRequest.Builder> createContactChannelRequest)

      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:
      A Java Future containing the result of the CreateContactChannel operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • ConflictException Updating or deleting a resource causes an inconsistent state.
      • DataEncryptionException The operation failed to due an encryption key error.
      • InternalServerException Unexpected error occurred while processing the request.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createRotation

      default CompletableFuture<CreateRotationResponse> createRotation(CreateRotationRequest createRotationRequest)

      Creates a rotation in an on-call schedule.

      Parameters:
      createRotationRequest -
      Returns:
      A Java Future containing the result of the CreateRotation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • InternalServerException Unexpected error occurred while processing the request.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ServiceQuotaExceededException Request would cause a service quota to be exceeded.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createRotation

      default CompletableFuture<CreateRotationResponse> createRotation(Consumer<CreateRotationRequest.Builder> createRotationRequest)

      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:
      A Java Future containing the result of the CreateRotation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • InternalServerException Unexpected error occurred while processing the request.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ServiceQuotaExceededException Request would cause a service quota to be exceeded.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createRotationOverride

      default CompletableFuture<CreateRotationOverrideResponse> createRotationOverride(CreateRotationOverrideRequest createRotationOverrideRequest)

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

      Parameters:
      createRotationOverrideRequest -
      Returns:
      A Java Future containing the result of the CreateRotationOverride operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • InternalServerException Unexpected error occurred while processing the request.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ServiceQuotaExceededException Request would cause a service quota to be exceeded.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createRotationOverride

      default CompletableFuture<CreateRotationOverrideResponse> createRotationOverride(Consumer<CreateRotationOverrideRequest.Builder> createRotationOverrideRequest)

      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:
      A Java Future containing the result of the CreateRotationOverride operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • InternalServerException Unexpected error occurred while processing the request.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ServiceQuotaExceededException Request would cause a service quota to be exceeded.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deactivateContactChannel

      default CompletableFuture<DeactivateContactChannelResponse> deactivateContactChannel(DeactivateContactChannelRequest deactivateContactChannelRequest)

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

      Parameters:
      deactivateContactChannelRequest -
      Returns:
      A Java Future containing the result of the DeactivateContactChannel operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • InternalServerException Unexpected error occurred while processing the request.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deactivateContactChannel

      default CompletableFuture<DeactivateContactChannelResponse> deactivateContactChannel(Consumer<DeactivateContactChannelRequest.Builder> deactivateContactChannelRequest)

      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:
      A Java Future containing the result of the DeactivateContactChannel operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • InternalServerException Unexpected error occurred while processing the request.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteContact

      default CompletableFuture<DeleteContactResponse> deleteContact(DeleteContactRequest deleteContactRequest)

      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:
      A Java Future containing the result of the DeleteContact operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • InternalServerException Unexpected error occurred while processing the request.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ConflictException Updating or deleting a resource causes an inconsistent state.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteContact

      default CompletableFuture<DeleteContactResponse> deleteContact(Consumer<DeleteContactRequest.Builder> deleteContactRequest)

      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:
      A Java Future containing the result of the DeleteContact operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • InternalServerException Unexpected error occurred while processing the request.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ConflictException Updating or deleting a resource causes an inconsistent state.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteContactChannel

      default CompletableFuture<DeleteContactChannelResponse> deleteContactChannel(DeleteContactChannelRequest deleteContactChannelRequest)

      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:
      A Java Future containing the result of the DeleteContactChannel operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • InternalServerException Unexpected error occurred while processing the request.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteContactChannel

      default CompletableFuture<DeleteContactChannelResponse> deleteContactChannel(Consumer<DeleteContactChannelRequest.Builder> deleteContactChannelRequest)

      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:
      A Java Future containing the result of the DeleteContactChannel operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • InternalServerException Unexpected error occurred while processing the request.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteRotation

      default CompletableFuture<DeleteRotationResponse> deleteRotation(DeleteRotationRequest deleteRotationRequest)

      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:
      A Java Future containing the result of the DeleteRotation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • ConflictException Updating or deleting a resource causes an inconsistent state.
      • InternalServerException Unexpected error occurred while processing the request.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteRotation

      default CompletableFuture<DeleteRotationResponse> deleteRotation(Consumer<DeleteRotationRequest.Builder> deleteRotationRequest)

      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:
      A Java Future containing the result of the DeleteRotation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • ConflictException Updating or deleting a resource causes an inconsistent state.
      • InternalServerException Unexpected error occurred while processing the request.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteRotationOverride

      default CompletableFuture<DeleteRotationOverrideResponse> deleteRotationOverride(DeleteRotationOverrideRequest deleteRotationOverrideRequest)

      Deletes an existing override for an on-call rotation.

      Parameters:
      deleteRotationOverrideRequest -
      Returns:
      A Java Future containing the result of the DeleteRotationOverride operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • InternalServerException Unexpected error occurred while processing the request.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteRotationOverride

      default CompletableFuture<DeleteRotationOverrideResponse> deleteRotationOverride(Consumer<DeleteRotationOverrideRequest.Builder> deleteRotationOverrideRequest)

      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:
      A Java Future containing the result of the DeleteRotationOverride operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • InternalServerException Unexpected error occurred while processing the request.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeEngagement

      default CompletableFuture<DescribeEngagementResponse> describeEngagement(DescribeEngagementRequest describeEngagementRequest)

      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:
      A Java Future containing the result of the DescribeEngagement operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • DataEncryptionException The operation failed to due an encryption key error.
      • InternalServerException Unexpected error occurred while processing the request.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeEngagement

      default CompletableFuture<DescribeEngagementResponse> describeEngagement(Consumer<DescribeEngagementRequest.Builder> describeEngagementRequest)

      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:
      A Java Future containing the result of the DescribeEngagement operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • DataEncryptionException The operation failed to due an encryption key error.
      • InternalServerException Unexpected error occurred while processing the request.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describePage

      default CompletableFuture<DescribePageResponse> describePage(DescribePageRequest describePageRequest)

      Lists details of the engagement to a contact channel.

      Parameters:
      describePageRequest -
      Returns:
      A Java Future containing the result of the DescribePage operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • DataEncryptionException The operation failed to due an encryption key error.
      • InternalServerException Unexpected error occurred while processing the request.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describePage

      default CompletableFuture<DescribePageResponse> describePage(Consumer<DescribePageRequest.Builder> describePageRequest)

      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:
      A Java Future containing the result of the DescribePage operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • DataEncryptionException The operation failed to due an encryption key error.
      • InternalServerException Unexpected error occurred while processing the request.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getContact

      default CompletableFuture<GetContactResponse> getContact(GetContactRequest getContactRequest)

      Retrieves information about the specified contact or escalation plan.

      Parameters:
      getContactRequest -
      Returns:
      A Java Future containing the result of the GetContact operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • InternalServerException Unexpected error occurred while processing the request.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • DataEncryptionException The operation failed to due an encryption key error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getContact

      default CompletableFuture<GetContactResponse> getContact(Consumer<GetContactRequest.Builder> getContactRequest)

      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:
      A Java Future containing the result of the GetContact operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • InternalServerException Unexpected error occurred while processing the request.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • DataEncryptionException The operation failed to due an encryption key error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getContactChannel

      default CompletableFuture<GetContactChannelResponse> getContactChannel(GetContactChannelRequest getContactChannelRequest)

      List details about a specific contact channel.

      Parameters:
      getContactChannelRequest -
      Returns:
      A Java Future containing the result of the GetContactChannel operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • DataEncryptionException The operation failed to due an encryption key error.
      • InternalServerException Unexpected error occurred while processing the request.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getContactChannel

      default CompletableFuture<GetContactChannelResponse> getContactChannel(Consumer<GetContactChannelRequest.Builder> getContactChannelRequest)

      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:
      A Java Future containing the result of the GetContactChannel operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • DataEncryptionException The operation failed to due an encryption key error.
      • InternalServerException Unexpected error occurred while processing the request.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getContactPolicy

      default CompletableFuture<GetContactPolicyResponse> getContactPolicy(GetContactPolicyRequest getContactPolicyRequest)

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

      Parameters:
      getContactPolicyRequest -
      Returns:
      A Java Future containing the result of the GetContactPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • InternalServerException Unexpected error occurred while processing the request.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getContactPolicy

      default CompletableFuture<GetContactPolicyResponse> getContactPolicy(Consumer<GetContactPolicyRequest.Builder> getContactPolicyRequest)

      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:
      A Java Future containing the result of the GetContactPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • InternalServerException Unexpected error occurred while processing the request.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getRotation

      default CompletableFuture<GetRotationResponse> getRotation(GetRotationRequest getRotationRequest)

      Retrieves information about an on-call rotation.

      Parameters:
      getRotationRequest -
      Returns:
      A Java Future containing the result of the GetRotation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • InternalServerException Unexpected error occurred while processing the request.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getRotation

      default CompletableFuture<GetRotationResponse> getRotation(Consumer<GetRotationRequest.Builder> getRotationRequest)

      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:
      A Java Future containing the result of the GetRotation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • InternalServerException Unexpected error occurred while processing the request.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getRotationOverride

      default CompletableFuture<GetRotationOverrideResponse> getRotationOverride(GetRotationOverrideRequest getRotationOverrideRequest)

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

      Parameters:
      getRotationOverrideRequest -
      Returns:
      A Java Future containing the result of the GetRotationOverride operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • InternalServerException Unexpected error occurred while processing the request.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getRotationOverride

      default CompletableFuture<GetRotationOverrideResponse> getRotationOverride(Consumer<GetRotationOverrideRequest.Builder> getRotationOverrideRequest)

      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:
      A Java Future containing the result of the GetRotationOverride operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • InternalServerException Unexpected error occurred while processing the request.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listContactChannels

      default CompletableFuture<ListContactChannelsResponse> listContactChannels(ListContactChannelsRequest listContactChannelsRequest)

      Lists all contact channels for the specified contact.

      Parameters:
      listContactChannelsRequest -
      Returns:
      A Java Future containing the result of the ListContactChannels operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • DataEncryptionException The operation failed to due an encryption key error.
      • InternalServerException Unexpected error occurred while processing the request.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listContactChannels

      default CompletableFuture<ListContactChannelsResponse> listContactChannels(Consumer<ListContactChannelsRequest.Builder> listContactChannelsRequest)

      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:
      A Java Future containing the result of the ListContactChannels operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • DataEncryptionException The operation failed to due an encryption key error.
      • InternalServerException Unexpected error occurred while processing the request.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listContactChannelsPaginator

      default ListContactChannelsPublisher listContactChannelsPaginator(ListContactChannelsRequest listContactChannelsRequest)

      This is a variant of listContactChannels(software.amazon.awssdk.services.ssmcontacts.model.ListContactChannelsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssmcontacts.paginators.ListContactChannelsPublisher publisher = client.listContactChannelsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssmcontacts.paginators.ListContactChannelsPublisher publisher = client.listContactChannelsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssmcontacts.model.ListContactChannelsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssmcontacts.model.ListContactChannelsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • DataEncryptionException The operation failed to due an encryption key error.
      • InternalServerException Unexpected error occurred while processing the request.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listContactChannelsPaginator

      default ListContactChannelsPublisher listContactChannelsPaginator(Consumer<ListContactChannelsRequest.Builder> listContactChannelsRequest)

      This is a variant of listContactChannels(software.amazon.awssdk.services.ssmcontacts.model.ListContactChannelsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssmcontacts.paginators.ListContactChannelsPublisher publisher = client.listContactChannelsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssmcontacts.paginators.ListContactChannelsPublisher publisher = client.listContactChannelsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssmcontacts.model.ListContactChannelsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssmcontacts.model.ListContactChannelsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • DataEncryptionException The operation failed to due an encryption key error.
      • InternalServerException Unexpected error occurred while processing the request.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listContacts

      default CompletableFuture<ListContactsResponse> listContacts(ListContactsRequest listContactsRequest)

      Lists all contacts and escalation plans in Incident Manager.

      Parameters:
      listContactsRequest -
      Returns:
      A Java Future containing the result of the ListContacts operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • InternalServerException Unexpected error occurred while processing the request.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listContacts

      default CompletableFuture<ListContactsResponse> listContacts(Consumer<ListContactsRequest.Builder> listContactsRequest)

      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:
      A Java Future containing the result of the ListContacts operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • InternalServerException Unexpected error occurred while processing the request.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listContactsPaginator

      default ListContactsPublisher listContactsPaginator(ListContactsRequest listContactsRequest)

      This is a variant of listContacts(software.amazon.awssdk.services.ssmcontacts.model.ListContactsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssmcontacts.paginators.ListContactsPublisher publisher = client.listContactsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssmcontacts.paginators.ListContactsPublisher publisher = client.listContactsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssmcontacts.model.ListContactsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssmcontacts.model.ListContactsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • InternalServerException Unexpected error occurred while processing the request.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listContactsPaginator

      default ListContactsPublisher listContactsPaginator(Consumer<ListContactsRequest.Builder> listContactsRequest)

      This is a variant of listContacts(software.amazon.awssdk.services.ssmcontacts.model.ListContactsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssmcontacts.paginators.ListContactsPublisher publisher = client.listContactsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssmcontacts.paginators.ListContactsPublisher publisher = client.listContactsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssmcontacts.model.ListContactsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssmcontacts.model.ListContactsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • InternalServerException Unexpected error occurred while processing the request.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEngagements

      default CompletableFuture<ListEngagementsResponse> listEngagements(ListEngagementsRequest listEngagementsRequest)

      Lists all engagements that have happened in an incident.

      Parameters:
      listEngagementsRequest -
      Returns:
      A Java Future containing the result of the ListEngagements operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • InternalServerException Unexpected error occurred while processing the request.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEngagements

      default CompletableFuture<ListEngagementsResponse> listEngagements(Consumer<ListEngagementsRequest.Builder> listEngagementsRequest)

      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:
      A Java Future containing the result of the ListEngagements operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • InternalServerException Unexpected error occurred while processing the request.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEngagementsPaginator

      default ListEngagementsPublisher listEngagementsPaginator(ListEngagementsRequest listEngagementsRequest)

      This is a variant of listEngagements(software.amazon.awssdk.services.ssmcontacts.model.ListEngagementsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssmcontacts.paginators.ListEngagementsPublisher publisher = client.listEngagementsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssmcontacts.paginators.ListEngagementsPublisher publisher = client.listEngagementsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssmcontacts.model.ListEngagementsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssmcontacts.model.ListEngagementsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • InternalServerException Unexpected error occurred while processing the request.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEngagementsPaginator

      default ListEngagementsPublisher listEngagementsPaginator(Consumer<ListEngagementsRequest.Builder> listEngagementsRequest)

      This is a variant of listEngagements(software.amazon.awssdk.services.ssmcontacts.model.ListEngagementsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssmcontacts.paginators.ListEngagementsPublisher publisher = client.listEngagementsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssmcontacts.paginators.ListEngagementsPublisher publisher = client.listEngagementsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssmcontacts.model.ListEngagementsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssmcontacts.model.ListEngagementsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • InternalServerException Unexpected error occurred while processing the request.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPageReceipts

      default CompletableFuture<ListPageReceiptsResponse> listPageReceipts(ListPageReceiptsRequest listPageReceiptsRequest)

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

      Parameters:
      listPageReceiptsRequest -
      Returns:
      A Java Future containing the result of the ListPageReceipts operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • InternalServerException Unexpected error occurred while processing the request.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPageReceipts

      default CompletableFuture<ListPageReceiptsResponse> listPageReceipts(Consumer<ListPageReceiptsRequest.Builder> listPageReceiptsRequest)

      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:
      A Java Future containing the result of the ListPageReceipts operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • InternalServerException Unexpected error occurred while processing the request.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPageReceiptsPaginator

      default ListPageReceiptsPublisher listPageReceiptsPaginator(ListPageReceiptsRequest listPageReceiptsRequest)

      This is a variant of listPageReceipts(software.amazon.awssdk.services.ssmcontacts.model.ListPageReceiptsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssmcontacts.paginators.ListPageReceiptsPublisher publisher = client.listPageReceiptsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssmcontacts.paginators.ListPageReceiptsPublisher publisher = client.listPageReceiptsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssmcontacts.model.ListPageReceiptsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssmcontacts.model.ListPageReceiptsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • InternalServerException Unexpected error occurred while processing the request.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPageReceiptsPaginator

      default ListPageReceiptsPublisher listPageReceiptsPaginator(Consumer<ListPageReceiptsRequest.Builder> listPageReceiptsRequest)

      This is a variant of listPageReceipts(software.amazon.awssdk.services.ssmcontacts.model.ListPageReceiptsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssmcontacts.paginators.ListPageReceiptsPublisher publisher = client.listPageReceiptsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssmcontacts.paginators.ListPageReceiptsPublisher publisher = client.listPageReceiptsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssmcontacts.model.ListPageReceiptsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssmcontacts.model.ListPageReceiptsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • InternalServerException Unexpected error occurred while processing the request.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPageResolutions

      default CompletableFuture<ListPageResolutionsResponse> listPageResolutions(ListPageResolutionsRequest listPageResolutionsRequest)

      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:
      A Java Future containing the result of the ListPageResolutions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • InternalServerException Unexpected error occurred while processing the request.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPageResolutions

      default CompletableFuture<ListPageResolutionsResponse> listPageResolutions(Consumer<ListPageResolutionsRequest.Builder> listPageResolutionsRequest)

      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:
      A Java Future containing the result of the ListPageResolutions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • InternalServerException Unexpected error occurred while processing the request.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPageResolutionsPaginator

      default ListPageResolutionsPublisher listPageResolutionsPaginator(ListPageResolutionsRequest listPageResolutionsRequest)

      This is a variant of listPageResolutions(software.amazon.awssdk.services.ssmcontacts.model.ListPageResolutionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssmcontacts.paginators.ListPageResolutionsPublisher publisher = client.listPageResolutionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssmcontacts.paginators.ListPageResolutionsPublisher publisher = client.listPageResolutionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssmcontacts.model.ListPageResolutionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssmcontacts.model.ListPageResolutionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • InternalServerException Unexpected error occurred while processing the request.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPageResolutionsPaginator

      default ListPageResolutionsPublisher listPageResolutionsPaginator(Consumer<ListPageResolutionsRequest.Builder> listPageResolutionsRequest)

      This is a variant of listPageResolutions(software.amazon.awssdk.services.ssmcontacts.model.ListPageResolutionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssmcontacts.paginators.ListPageResolutionsPublisher publisher = client.listPageResolutionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssmcontacts.paginators.ListPageResolutionsPublisher publisher = client.listPageResolutionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssmcontacts.model.ListPageResolutionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssmcontacts.model.ListPageResolutionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • InternalServerException Unexpected error occurred while processing the request.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPagesByContact

      default CompletableFuture<ListPagesByContactResponse> listPagesByContact(ListPagesByContactRequest listPagesByContactRequest)

      Lists the engagements to a contact's contact channels.

      Parameters:
      listPagesByContactRequest -
      Returns:
      A Java Future containing the result of the ListPagesByContact operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • InternalServerException Unexpected error occurred while processing the request.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPagesByContact

      default CompletableFuture<ListPagesByContactResponse> listPagesByContact(Consumer<ListPagesByContactRequest.Builder> listPagesByContactRequest)

      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:
      A Java Future containing the result of the ListPagesByContact operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • InternalServerException Unexpected error occurred while processing the request.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPagesByContactPaginator

      default ListPagesByContactPublisher listPagesByContactPaginator(ListPagesByContactRequest listPagesByContactRequest)

      This is a variant of listPagesByContact(software.amazon.awssdk.services.ssmcontacts.model.ListPagesByContactRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssmcontacts.paginators.ListPagesByContactPublisher publisher = client.listPagesByContactPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssmcontacts.paginators.ListPagesByContactPublisher publisher = client.listPagesByContactPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssmcontacts.model.ListPagesByContactResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssmcontacts.model.ListPagesByContactResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • InternalServerException Unexpected error occurred while processing the request.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPagesByContactPaginator

      default ListPagesByContactPublisher listPagesByContactPaginator(Consumer<ListPagesByContactRequest.Builder> listPagesByContactRequest)

      This is a variant of listPagesByContact(software.amazon.awssdk.services.ssmcontacts.model.ListPagesByContactRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssmcontacts.paginators.ListPagesByContactPublisher publisher = client.listPagesByContactPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssmcontacts.paginators.ListPagesByContactPublisher publisher = client.listPagesByContactPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssmcontacts.model.ListPagesByContactResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssmcontacts.model.ListPagesByContactResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • InternalServerException Unexpected error occurred while processing the request.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPagesByEngagement

      default CompletableFuture<ListPagesByEngagementResponse> listPagesByEngagement(ListPagesByEngagementRequest listPagesByEngagementRequest)

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

      Parameters:
      listPagesByEngagementRequest -
      Returns:
      A Java Future containing the result of the ListPagesByEngagement operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • InternalServerException Unexpected error occurred while processing the request.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPagesByEngagement

      default CompletableFuture<ListPagesByEngagementResponse> listPagesByEngagement(Consumer<ListPagesByEngagementRequest.Builder> listPagesByEngagementRequest)

      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:
      A Java Future containing the result of the ListPagesByEngagement operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • InternalServerException Unexpected error occurred while processing the request.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPagesByEngagementPaginator

      default ListPagesByEngagementPublisher listPagesByEngagementPaginator(ListPagesByEngagementRequest listPagesByEngagementRequest)

      This is a variant of listPagesByEngagement(software.amazon.awssdk.services.ssmcontacts.model.ListPagesByEngagementRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssmcontacts.paginators.ListPagesByEngagementPublisher publisher = client.listPagesByEngagementPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssmcontacts.paginators.ListPagesByEngagementPublisher publisher = client.listPagesByEngagementPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssmcontacts.model.ListPagesByEngagementResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssmcontacts.model.ListPagesByEngagementResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • InternalServerException Unexpected error occurred while processing the request.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPagesByEngagementPaginator

      default ListPagesByEngagementPublisher listPagesByEngagementPaginator(Consumer<ListPagesByEngagementRequest.Builder> listPagesByEngagementRequest)

      This is a variant of listPagesByEngagement(software.amazon.awssdk.services.ssmcontacts.model.ListPagesByEngagementRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssmcontacts.paginators.ListPagesByEngagementPublisher publisher = client.listPagesByEngagementPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssmcontacts.paginators.ListPagesByEngagementPublisher publisher = client.listPagesByEngagementPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssmcontacts.model.ListPagesByEngagementResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssmcontacts.model.ListPagesByEngagementResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • InternalServerException Unexpected error occurred while processing the request.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPreviewRotationShifts

      default CompletableFuture<ListPreviewRotationShiftsResponse> listPreviewRotationShifts(ListPreviewRotationShiftsRequest listPreviewRotationShiftsRequest)

      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:
      A Java Future containing the result of the ListPreviewRotationShifts operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • InternalServerException Unexpected error occurred while processing the request.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPreviewRotationShifts

      default CompletableFuture<ListPreviewRotationShiftsResponse> listPreviewRotationShifts(Consumer<ListPreviewRotationShiftsRequest.Builder> listPreviewRotationShiftsRequest)

      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:
      A Java Future containing the result of the ListPreviewRotationShifts operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • InternalServerException Unexpected error occurred while processing the request.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPreviewRotationShiftsPaginator

      default ListPreviewRotationShiftsPublisher listPreviewRotationShiftsPaginator(ListPreviewRotationShiftsRequest listPreviewRotationShiftsRequest)

      This is a variant of listPreviewRotationShifts(software.amazon.awssdk.services.ssmcontacts.model.ListPreviewRotationShiftsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssmcontacts.paginators.ListPreviewRotationShiftsPublisher publisher = client.listPreviewRotationShiftsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssmcontacts.paginators.ListPreviewRotationShiftsPublisher publisher = client.listPreviewRotationShiftsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssmcontacts.model.ListPreviewRotationShiftsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssmcontacts.model.ListPreviewRotationShiftsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • InternalServerException Unexpected error occurred while processing the request.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPreviewRotationShiftsPaginator

      default ListPreviewRotationShiftsPublisher listPreviewRotationShiftsPaginator(Consumer<ListPreviewRotationShiftsRequest.Builder> listPreviewRotationShiftsRequest)

      This is a variant of listPreviewRotationShifts(software.amazon.awssdk.services.ssmcontacts.model.ListPreviewRotationShiftsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssmcontacts.paginators.ListPreviewRotationShiftsPublisher publisher = client.listPreviewRotationShiftsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssmcontacts.paginators.ListPreviewRotationShiftsPublisher publisher = client.listPreviewRotationShiftsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssmcontacts.model.ListPreviewRotationShiftsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssmcontacts.model.ListPreviewRotationShiftsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • InternalServerException Unexpected error occurred while processing the request.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRotationOverrides

      default CompletableFuture<ListRotationOverridesResponse> listRotationOverrides(ListRotationOverridesRequest listRotationOverridesRequest)

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

      Parameters:
      listRotationOverridesRequest -
      Returns:
      A Java Future containing the result of the ListRotationOverrides operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • InternalServerException Unexpected error occurred while processing the request.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRotationOverrides

      default CompletableFuture<ListRotationOverridesResponse> listRotationOverrides(Consumer<ListRotationOverridesRequest.Builder> listRotationOverridesRequest)

      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:
      A Java Future containing the result of the ListRotationOverrides operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • InternalServerException Unexpected error occurred while processing the request.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRotationOverridesPaginator

      default ListRotationOverridesPublisher listRotationOverridesPaginator(ListRotationOverridesRequest listRotationOverridesRequest)

      This is a variant of listRotationOverrides(software.amazon.awssdk.services.ssmcontacts.model.ListRotationOverridesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssmcontacts.paginators.ListRotationOverridesPublisher publisher = client.listRotationOverridesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssmcontacts.paginators.ListRotationOverridesPublisher publisher = client.listRotationOverridesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssmcontacts.model.ListRotationOverridesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssmcontacts.model.ListRotationOverridesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • InternalServerException Unexpected error occurred while processing the request.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRotationOverridesPaginator

      default ListRotationOverridesPublisher listRotationOverridesPaginator(Consumer<ListRotationOverridesRequest.Builder> listRotationOverridesRequest)

      This is a variant of listRotationOverrides(software.amazon.awssdk.services.ssmcontacts.model.ListRotationOverridesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssmcontacts.paginators.ListRotationOverridesPublisher publisher = client.listRotationOverridesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssmcontacts.paginators.ListRotationOverridesPublisher publisher = client.listRotationOverridesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssmcontacts.model.ListRotationOverridesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssmcontacts.model.ListRotationOverridesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • InternalServerException Unexpected error occurred while processing the request.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRotationShifts

      default CompletableFuture<ListRotationShiftsResponse> listRotationShifts(ListRotationShiftsRequest listRotationShiftsRequest)

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

      Parameters:
      listRotationShiftsRequest -
      Returns:
      A Java Future containing the result of the ListRotationShifts operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • ConflictException Updating or deleting a resource causes an inconsistent state.
      • InternalServerException Unexpected error occurred while processing the request.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRotationShifts

      default CompletableFuture<ListRotationShiftsResponse> listRotationShifts(Consumer<ListRotationShiftsRequest.Builder> listRotationShiftsRequest)

      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:
      A Java Future containing the result of the ListRotationShifts operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • ConflictException Updating or deleting a resource causes an inconsistent state.
      • InternalServerException Unexpected error occurred while processing the request.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRotationShiftsPaginator

      default ListRotationShiftsPublisher listRotationShiftsPaginator(ListRotationShiftsRequest listRotationShiftsRequest)

      This is a variant of listRotationShifts(software.amazon.awssdk.services.ssmcontacts.model.ListRotationShiftsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssmcontacts.paginators.ListRotationShiftsPublisher publisher = client.listRotationShiftsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssmcontacts.paginators.ListRotationShiftsPublisher publisher = client.listRotationShiftsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssmcontacts.model.ListRotationShiftsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssmcontacts.model.ListRotationShiftsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • ConflictException Updating or deleting a resource causes an inconsistent state.
      • InternalServerException Unexpected error occurred while processing the request.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRotationShiftsPaginator

      default ListRotationShiftsPublisher listRotationShiftsPaginator(Consumer<ListRotationShiftsRequest.Builder> listRotationShiftsRequest)

      This is a variant of listRotationShifts(software.amazon.awssdk.services.ssmcontacts.model.ListRotationShiftsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssmcontacts.paginators.ListRotationShiftsPublisher publisher = client.listRotationShiftsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssmcontacts.paginators.ListRotationShiftsPublisher publisher = client.listRotationShiftsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssmcontacts.model.ListRotationShiftsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssmcontacts.model.ListRotationShiftsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • ConflictException Updating or deleting a resource causes an inconsistent state.
      • InternalServerException Unexpected error occurred while processing the request.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRotations

      default CompletableFuture<ListRotationsResponse> listRotations(ListRotationsRequest listRotationsRequest)

      Retrieves a list of on-call rotations.

      Parameters:
      listRotationsRequest -
      Returns:
      A Java Future containing the result of the ListRotations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • InternalServerException Unexpected error occurred while processing the request.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRotations

      default CompletableFuture<ListRotationsResponse> listRotations(Consumer<ListRotationsRequest.Builder> listRotationsRequest)

      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:
      A Java Future containing the result of the ListRotations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • InternalServerException Unexpected error occurred while processing the request.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRotationsPaginator

      default ListRotationsPublisher listRotationsPaginator(ListRotationsRequest listRotationsRequest)

      This is a variant of listRotations(software.amazon.awssdk.services.ssmcontacts.model.ListRotationsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssmcontacts.paginators.ListRotationsPublisher publisher = client.listRotationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssmcontacts.paginators.ListRotationsPublisher publisher = client.listRotationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssmcontacts.model.ListRotationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssmcontacts.model.ListRotationsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • InternalServerException Unexpected error occurred while processing the request.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRotationsPaginator

      default ListRotationsPublisher listRotationsPaginator(Consumer<ListRotationsRequest.Builder> listRotationsRequest)

      This is a variant of listRotations(software.amazon.awssdk.services.ssmcontacts.model.ListRotationsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssmcontacts.paginators.ListRotationsPublisher publisher = client.listRotationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssmcontacts.paginators.ListRotationsPublisher publisher = client.listRotationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssmcontacts.model.ListRotationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssmcontacts.model.ListRotationsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • InternalServerException Unexpected error occurred while processing the request.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

      Lists the tags of an escalation plan or contact.

      Parameters:
      listTagsForResourceRequest -
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • ThrottlingException The request was denied due to request throttling.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • InternalServerException Unexpected error occurred while processing the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)

      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:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • ThrottlingException The request was denied due to request throttling.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • InternalServerException Unexpected error occurred while processing the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putContactPolicy

      default CompletableFuture<PutContactPolicyResponse> putContactPolicy(PutContactPolicyRequest putContactPolicyRequest)

      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:
      A Java Future containing the result of the PutContactPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • ConflictException Updating or deleting a resource causes an inconsistent state.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServerException Unexpected error occurred while processing the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putContactPolicy

      default CompletableFuture<PutContactPolicyResponse> putContactPolicy(Consumer<PutContactPolicyRequest.Builder> putContactPolicyRequest)

      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:
      A Java Future containing the result of the PutContactPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • ConflictException Updating or deleting a resource causes an inconsistent state.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServerException Unexpected error occurred while processing the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • sendActivationCode

      default CompletableFuture<SendActivationCodeResponse> sendActivationCode(SendActivationCodeRequest sendActivationCodeRequest)

      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:
      A Java Future containing the result of the SendActivationCode operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • DataEncryptionException The operation failed to due an encryption key error.
      • InternalServerException Unexpected error occurred while processing the request.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ServiceQuotaExceededException Request would cause a service quota to be exceeded.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • sendActivationCode

      default CompletableFuture<SendActivationCodeResponse> sendActivationCode(Consumer<SendActivationCodeRequest.Builder> sendActivationCodeRequest)

      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:
      A Java Future containing the result of the SendActivationCode operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • DataEncryptionException The operation failed to due an encryption key error.
      • InternalServerException Unexpected error occurred while processing the request.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ServiceQuotaExceededException Request would cause a service quota to be exceeded.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startEngagement

      default CompletableFuture<StartEngagementResponse> startEngagement(StartEngagementRequest startEngagementRequest)

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

      Parameters:
      startEngagementRequest -
      Returns:
      A Java Future containing the result of the StartEngagement operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • DataEncryptionException The operation failed to due an encryption key error.
      • InternalServerException Unexpected error occurred while processing the request.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startEngagement

      default CompletableFuture<StartEngagementResponse> startEngagement(Consumer<StartEngagementRequest.Builder> startEngagementRequest)

      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:
      A Java Future containing the result of the StartEngagement operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • DataEncryptionException The operation failed to due an encryption key error.
      • InternalServerException Unexpected error occurred while processing the request.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopEngagement

      default CompletableFuture<StopEngagementResponse> stopEngagement(StopEngagementRequest stopEngagementRequest)

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

      Parameters:
      stopEngagementRequest -
      Returns:
      A Java Future containing the result of the StopEngagement operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServerException Unexpected error occurred while processing the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopEngagement

      default CompletableFuture<StopEngagementResponse> stopEngagement(Consumer<StopEngagementRequest.Builder> stopEngagementRequest)

      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:
      A Java Future containing the result of the StopEngagement operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServerException Unexpected error occurred while processing the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)

      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:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • ThrottlingException The request was denied due to request throttling.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • InternalServerException Unexpected error occurred while processing the request.
      • ServiceQuotaExceededException Request would cause a service quota to be exceeded.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)

      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:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • ThrottlingException The request was denied due to request throttling.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • InternalServerException Unexpected error occurred while processing the request.
      • ServiceQuotaExceededException Request would cause a service quota to be exceeded.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)

      Removes tags from the specified resource.

      Parameters:
      untagResourceRequest -
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • ThrottlingException The request was denied due to request throttling.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • InternalServerException Unexpected error occurred while processing the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)

      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:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • ThrottlingException The request was denied due to request throttling.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • InternalServerException Unexpected error occurred while processing the request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateContact

      default CompletableFuture<UpdateContactResponse> updateContact(UpdateContactRequest updateContactRequest)

      Updates the contact or escalation plan specified.

      Parameters:
      updateContactRequest -
      Returns:
      A Java Future containing the result of the UpdateContact operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • InternalServerException Unexpected error occurred while processing the request.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ServiceQuotaExceededException Request would cause a service quota to be exceeded.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • DataEncryptionException The operation failed to due an encryption key error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateContact

      default CompletableFuture<UpdateContactResponse> updateContact(Consumer<UpdateContactRequest.Builder> updateContactRequest)

      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:
      A Java Future containing the result of the UpdateContact operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • InternalServerException Unexpected error occurred while processing the request.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ServiceQuotaExceededException Request would cause a service quota to be exceeded.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • DataEncryptionException The operation failed to due an encryption key error.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateContactChannel

      default CompletableFuture<UpdateContactChannelResponse> updateContactChannel(UpdateContactChannelRequest updateContactChannelRequest)

      Updates a contact's contact channel.

      Parameters:
      updateContactChannelRequest -
      Returns:
      A Java Future containing the result of the UpdateContactChannel operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • ConflictException Updating or deleting a resource causes an inconsistent state.
      • DataEncryptionException The operation failed to due an encryption key error.
      • InternalServerException Unexpected error occurred while processing the request.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateContactChannel

      default CompletableFuture<UpdateContactChannelResponse> updateContactChannel(Consumer<UpdateContactChannelRequest.Builder> updateContactChannelRequest)

      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:
      A Java Future containing the result of the UpdateContactChannel operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • ConflictException Updating or deleting a resource causes an inconsistent state.
      • DataEncryptionException The operation failed to due an encryption key error.
      • InternalServerException Unexpected error occurred while processing the request.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateRotation

      default CompletableFuture<UpdateRotationResponse> updateRotation(UpdateRotationRequest updateRotationRequest)

      Updates the information specified for an on-call rotation.

      Parameters:
      updateRotationRequest -
      Returns:
      A Java Future containing the result of the UpdateRotation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • ConflictException Updating or deleting a resource causes an inconsistent state.
      • InternalServerException Unexpected error occurred while processing the request.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateRotation

      default CompletableFuture<UpdateRotationResponse> updateRotation(Consumer<UpdateRotationRequest.Builder> updateRotationRequest)

      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:
      A Java Future containing the result of the UpdateRotation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have sufficient access to perform this operation.
      • ConflictException Updating or deleting a resource causes an inconsistent state.
      • InternalServerException Unexpected error occurred while processing the request.
      • ResourceNotFoundException Request references a resource that doesn't exist.
      • ThrottlingException The request was denied due to request throttling.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • 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

    • create

      static SsmContactsAsyncClient create()
      Create a SsmContactsAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static SsmContactsAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a SsmContactsAsyncClient.