Interface EndUserMessagingAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @SdkPublicApi @ThreadSafe public interface EndUserMessagingAsyncClient extends AwsClient
Service client for accessing AWS End User Messaging asynchronously. This can be created using the static builder() method.The asynchronous client performs non-blocking I/O when configured with any 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.

AWS End User Messaging provides a set of APIs to manage brand profiles, synchronize brand profile data with SMS and Rich Communication Services (RCS) registrations, and send and validate one-time passcodes across the SMS, voice, and WhatsApp channels.

  • Field Details

  • Method Details

    • createBrandProfile

      default CompletableFuture<CreateBrandProfileResponse> createBrandProfile(CreateBrandProfileRequest createBrandProfileRequest)

      Creates a brand profile. A brand profile is a lightweight container that holds your brand identity information as flexible attributes. After you create a brand profile, use the CreateBrandProfileAttributes operation to add company information, addresses, compliance documents, and logos.

      Parameters:
      createBrandProfileRequest -
      Returns:
      A Java Future containing the result of the CreateBrandProfile 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.
      • ValidationException A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.
      • ThrottlingException The request was denied because it exceeded the allowed request rate.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of the request.
      • ConflictException The request conflicts with the current state of the resource.
      • ServiceQuotaExceededException The request would exceed a service quota for your account.
      • 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.
      • EndUserMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createBrandProfile

      default CompletableFuture<CreateBrandProfileResponse> createBrandProfile(Consumer<CreateBrandProfileRequest.Builder> createBrandProfileRequest)

      Creates a brand profile. A brand profile is a lightweight container that holds your brand identity information as flexible attributes. After you create a brand profile, use the CreateBrandProfileAttributes operation to add company information, addresses, compliance documents, and logos.


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

      Parameters:
      createBrandProfileRequest - A Consumer that will call methods on CreateBrandProfileRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateBrandProfile 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.
      • ValidationException A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.
      • ThrottlingException The request was denied because it exceeded the allowed request rate.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of the request.
      • ConflictException The request conflicts with the current state of the resource.
      • ServiceQuotaExceededException The request would exceed a service quota for your account.
      • 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.
      • EndUserMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createBrandProfileAttributes

      default CompletableFuture<CreateBrandProfileAttributesResponse> createBrandProfileAttributes(CreateBrandProfileAttributesRequest createBrandProfileAttributesRequest)

      Creates up to 10 attributes for a brand profile in a single request. For attributes of type IMAGE or DOCUMENT, the response includes a presigned Amazon S3 URL that you use to upload the media. This operation is atomic: either all of the attributes are created, or none of them are.

      Parameters:
      createBrandProfileAttributesRequest -
      Returns:
      A Java Future containing the result of the CreateBrandProfileAttributes 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.
      • ValidationException A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.
      • ThrottlingException The request was denied because it exceeded the allowed request rate.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The request references a resource that does not exist. Verify that the resource identifier is correct and try your request again.
      • InternalServerException An unexpected error occurred during the processing of the request.
      • ConflictException The request conflicts with the current state of the resource.
      • ServiceQuotaExceededException The request would exceed a service quota for your account.
      • 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.
      • EndUserMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createBrandProfileAttributes

      default CompletableFuture<CreateBrandProfileAttributesResponse> createBrandProfileAttributes(Consumer<CreateBrandProfileAttributesRequest.Builder> createBrandProfileAttributesRequest)

      Creates up to 10 attributes for a brand profile in a single request. For attributes of type IMAGE or DOCUMENT, the response includes a presigned Amazon S3 URL that you use to upload the media. This operation is atomic: either all of the attributes are created, or none of them are.


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

      Parameters:
      createBrandProfileAttributesRequest - A Consumer that will call methods on CreateBrandProfileAttributesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateBrandProfileAttributes 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.
      • ValidationException A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.
      • ThrottlingException The request was denied because it exceeded the allowed request rate.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The request references a resource that does not exist. Verify that the resource identifier is correct and try your request again.
      • InternalServerException An unexpected error occurred during the processing of the request.
      • ConflictException The request conflicts with the current state of the resource.
      • ServiceQuotaExceededException The request would exceed a service quota for your account.
      • 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.
      • EndUserMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createBrandProfileFromRegistration

      default CompletableFuture<CreateBrandProfileFromRegistrationResponse> createBrandProfileFromRegistration(CreateBrandProfileFromRegistrationRequest createBrandProfileFromRegistrationRequest)

      Creates a brand profile and populates its attributes from an existing registration. This operation runs asynchronously. Use the GetJob operation to track its progress.

      Parameters:
      createBrandProfileFromRegistrationRequest -
      Returns:
      A Java Future containing the result of the CreateBrandProfileFromRegistration 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.
      • ValidationException A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.
      • ThrottlingException The request was denied because it exceeded the allowed request rate.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The request references a resource that does not exist. Verify that the resource identifier is correct and try your request again.
      • InternalServerException An unexpected error occurred during the processing of the request.
      • ConflictException The request conflicts with the current state of the resource.
      • ServiceQuotaExceededException The request would exceed a service quota for your account.
      • 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.
      • EndUserMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createBrandProfileFromRegistration

      default CompletableFuture<CreateBrandProfileFromRegistrationResponse> createBrandProfileFromRegistration(Consumer<CreateBrandProfileFromRegistrationRequest.Builder> createBrandProfileFromRegistrationRequest)

      Creates a brand profile and populates its attributes from an existing registration. This operation runs asynchronously. Use the GetJob operation to track its progress.


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

      Parameters:
      createBrandProfileFromRegistrationRequest - A Consumer that will call methods on CreateBrandProfileFromRegistrationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateBrandProfileFromRegistration 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.
      • ValidationException A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.
      • ThrottlingException The request was denied because it exceeded the allowed request rate.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The request references a resource that does not exist. Verify that the resource identifier is correct and try your request again.
      • InternalServerException An unexpected error occurred during the processing of the request.
      • ConflictException The request conflicts with the current state of the resource.
      • ServiceQuotaExceededException The request would exceed a service quota for your account.
      • 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.
      • EndUserMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createNotifyCodeConfiguration

      default CompletableFuture<CreateNotifyCodeConfigurationResponse> createNotifyCodeConfiguration(CreateNotifyCodeConfigurationRequest createNotifyCodeConfigurationRequest)

      Creates a notify code configuration. A notify code configuration is a reusable policy that defines how one-time passcodes are generated and rendered, including the code type, length, validity period, maximum number of attempts, and channel templates.

      Parameters:
      createNotifyCodeConfigurationRequest -
      Returns:
      A Java Future containing the result of the CreateNotifyCodeConfiguration 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.
      • ValidationException A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.
      • ThrottlingException The request was denied because it exceeded the allowed request rate.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of the request.
      • ConflictException The request conflicts with the current state of the resource.
      • ServiceQuotaExceededException The request would exceed a service quota for your account.
      • 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.
      • EndUserMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createNotifyCodeConfiguration

      default CompletableFuture<CreateNotifyCodeConfigurationResponse> createNotifyCodeConfiguration(Consumer<CreateNotifyCodeConfigurationRequest.Builder> createNotifyCodeConfigurationRequest)

      Creates a notify code configuration. A notify code configuration is a reusable policy that defines how one-time passcodes are generated and rendered, including the code type, length, validity period, maximum number of attempts, and channel templates.


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

      Parameters:
      createNotifyCodeConfigurationRequest - A Consumer that will call methods on CreateNotifyCodeConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateNotifyCodeConfiguration 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.
      • ValidationException A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.
      • ThrottlingException The request was denied because it exceeded the allowed request rate.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of the request.
      • ConflictException The request conflicts with the current state of the resource.
      • ServiceQuotaExceededException The request would exceed a service quota for your account.
      • 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.
      • EndUserMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createRegistrationsFromBrandProfile

      default CompletableFuture<CreateRegistrationsFromBrandProfileResponse> createRegistrationsFromBrandProfile(CreateRegistrationsFromBrandProfileRequest createRegistrationsFromBrandProfileRequest)

      Creates one or more registrations in the DRAFT state and prefills their fields from the attributes of a brand profile. This operation runs asynchronously. Use the GetJob operation to track its progress.

      Parameters:
      createRegistrationsFromBrandProfileRequest -
      Returns:
      A Java Future containing the result of the CreateRegistrationsFromBrandProfile 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.
      • ValidationException A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.
      • ThrottlingException The request was denied because it exceeded the allowed request rate.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The request references a resource that does not exist. Verify that the resource identifier is correct and try your request again.
      • InternalServerException An unexpected error occurred during the processing of the request.
      • ConflictException The request conflicts with the current state of the resource.
      • 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.
      • EndUserMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createRegistrationsFromBrandProfile

      default CompletableFuture<CreateRegistrationsFromBrandProfileResponse> createRegistrationsFromBrandProfile(Consumer<CreateRegistrationsFromBrandProfileRequest.Builder> createRegistrationsFromBrandProfileRequest)

      Creates one or more registrations in the DRAFT state and prefills their fields from the attributes of a brand profile. This operation runs asynchronously. Use the GetJob operation to track its progress.


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

      Parameters:
      createRegistrationsFromBrandProfileRequest - A Consumer that will call methods on CreateRegistrationsFromBrandProfileRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateRegistrationsFromBrandProfile 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.
      • ValidationException A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.
      • ThrottlingException The request was denied because it exceeded the allowed request rate.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The request references a resource that does not exist. Verify that the resource identifier is correct and try your request again.
      • InternalServerException An unexpected error occurred during the processing of the request.
      • ConflictException The request conflicts with the current state of the resource.
      • 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.
      • EndUserMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteBrandProfile

      default CompletableFuture<DeleteBrandProfileResponse> deleteBrandProfile(DeleteBrandProfileRequest deleteBrandProfileRequest)

      Deletes a brand profile. This operation also deletes the attributes of the profile and any associated media. The request fails if deletion protection is enabled for the profile.

      Parameters:
      deleteBrandProfileRequest -
      Returns:
      A Java Future containing the result of the DeleteBrandProfile 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.
      • ValidationException A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.
      • ThrottlingException The request was denied because it exceeded the allowed request rate.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The request references a resource that does not exist. Verify that the resource identifier is correct and try your request again.
      • InternalServerException An unexpected error occurred during the processing of the request.
      • ConflictException The request conflicts with the current state of the resource.
      • 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.
      • EndUserMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteBrandProfile

      default CompletableFuture<DeleteBrandProfileResponse> deleteBrandProfile(Consumer<DeleteBrandProfileRequest.Builder> deleteBrandProfileRequest)

      Deletes a brand profile. This operation also deletes the attributes of the profile and any associated media. The request fails if deletion protection is enabled for the profile.


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

      Parameters:
      deleteBrandProfileRequest - A Consumer that will call methods on DeleteBrandProfileRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteBrandProfile 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.
      • ValidationException A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.
      • ThrottlingException The request was denied because it exceeded the allowed request rate.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The request references a resource that does not exist. Verify that the resource identifier is correct and try your request again.
      • InternalServerException An unexpected error occurred during the processing of the request.
      • ConflictException The request conflicts with the current state of the resource.
      • 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.
      • EndUserMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteBrandProfileAttribute

      default CompletableFuture<DeleteBrandProfileAttributeResponse> deleteBrandProfileAttribute(DeleteBrandProfileAttributeRequest deleteBrandProfileAttributeRequest)

      Deletes a brand profile attribute. If the attribute stores media, this operation also deletes the associated media.

      Parameters:
      deleteBrandProfileAttributeRequest -
      Returns:
      A Java Future containing the result of the DeleteBrandProfileAttribute 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.
      • ValidationException A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.
      • ThrottlingException The request was denied because it exceeded the allowed request rate.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The request references a resource that does not exist. Verify that the resource identifier is correct and try your request again.
      • InternalServerException An unexpected error occurred during the processing of the request.
      • ConflictException The request conflicts with the current state of the resource.
      • 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.
      • EndUserMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteBrandProfileAttribute

      default CompletableFuture<DeleteBrandProfileAttributeResponse> deleteBrandProfileAttribute(Consumer<DeleteBrandProfileAttributeRequest.Builder> deleteBrandProfileAttributeRequest)

      Deletes a brand profile attribute. If the attribute stores media, this operation also deletes the associated media.


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

      Parameters:
      deleteBrandProfileAttributeRequest - A Consumer that will call methods on DeleteBrandProfileAttributeRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteBrandProfileAttribute 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.
      • ValidationException A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.
      • ThrottlingException The request was denied because it exceeded the allowed request rate.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The request references a resource that does not exist. Verify that the resource identifier is correct and try your request again.
      • InternalServerException An unexpected error occurred during the processing of the request.
      • ConflictException The request conflicts with the current state of the resource.
      • 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.
      • EndUserMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteNotifyCodeConfiguration

      default CompletableFuture<DeleteNotifyCodeConfigurationResponse> deleteNotifyCodeConfiguration(DeleteNotifyCodeConfigurationRequest deleteNotifyCodeConfigurationRequest)

      Deletes a notify code configuration. Verifications that are already in progress are not affected, because they capture the policy at the time that the passcode was sent.

      Parameters:
      deleteNotifyCodeConfigurationRequest -
      Returns:
      A Java Future containing the result of the DeleteNotifyCodeConfiguration 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.
      • ValidationException A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.
      • ThrottlingException The request was denied because it exceeded the allowed request rate.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The request references a resource that does not exist. Verify that the resource identifier is correct and try your request again.
      • InternalServerException An unexpected error occurred during the processing of the request.
      • ConflictException The request conflicts with the current state of the resource.
      • 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.
      • EndUserMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteNotifyCodeConfiguration

      default CompletableFuture<DeleteNotifyCodeConfigurationResponse> deleteNotifyCodeConfiguration(Consumer<DeleteNotifyCodeConfigurationRequest.Builder> deleteNotifyCodeConfigurationRequest)

      Deletes a notify code configuration. Verifications that are already in progress are not affected, because they capture the policy at the time that the passcode was sent.


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

      Parameters:
      deleteNotifyCodeConfigurationRequest - A Consumer that will call methods on DeleteNotifyCodeConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteNotifyCodeConfiguration 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.
      • ValidationException A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.
      • ThrottlingException The request was denied because it exceeded the allowed request rate.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The request references a resource that does not exist. Verify that the resource identifier is correct and try your request again.
      • InternalServerException An unexpected error occurred during the processing of the request.
      • ConflictException The request conflicts with the current state of the resource.
      • 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.
      • EndUserMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getBrandProfile

      default CompletableFuture<GetBrandProfileResponse> getBrandProfile(GetBrandProfileRequest getBrandProfileRequest)

      Retrieves the metadata for a brand profile, including its name, status, deletion protection setting, and timestamps. To retrieve the attributes of the profile, use the ListBrandProfileAttributes operation.

      Parameters:
      getBrandProfileRequest -
      Returns:
      A Java Future containing the result of the GetBrandProfile 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.
      • ValidationException A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.
      • ThrottlingException The request was denied because it exceeded the allowed request rate.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The request references a resource that does not exist. Verify that the resource identifier is correct and try your request again.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • EndUserMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getBrandProfile

      default CompletableFuture<GetBrandProfileResponse> getBrandProfile(Consumer<GetBrandProfileRequest.Builder> getBrandProfileRequest)

      Retrieves the metadata for a brand profile, including its name, status, deletion protection setting, and timestamps. To retrieve the attributes of the profile, use the ListBrandProfileAttributes operation.


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

      Parameters:
      getBrandProfileRequest - A Consumer that will call methods on GetBrandProfileRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetBrandProfile 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.
      • ValidationException A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.
      • ThrottlingException The request was denied because it exceeded the allowed request rate.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The request references a resource that does not exist. Verify that the resource identifier is correct and try your request again.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • EndUserMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getBrandProfileAttribute

      default CompletableFuture<GetBrandProfileAttributeResponse> getBrandProfileAttribute(GetBrandProfileAttributeRequest getBrandProfileAttributeRequest)

      Retrieves a single brand profile attribute.

      Parameters:
      getBrandProfileAttributeRequest -
      Returns:
      A Java Future containing the result of the GetBrandProfileAttribute 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.
      • ValidationException A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.
      • ThrottlingException The request was denied because it exceeded the allowed request rate.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The request references a resource that does not exist. Verify that the resource identifier is correct and try your request again.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • EndUserMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getBrandProfileAttribute

      default CompletableFuture<GetBrandProfileAttributeResponse> getBrandProfileAttribute(Consumer<GetBrandProfileAttributeRequest.Builder> getBrandProfileAttributeRequest)

      Retrieves a single brand profile attribute.


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

      Parameters:
      getBrandProfileAttributeRequest - A Consumer that will call methods on GetBrandProfileAttributeRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetBrandProfileAttribute 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.
      • ValidationException A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.
      • ThrottlingException The request was denied because it exceeded the allowed request rate.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The request references a resource that does not exist. Verify that the resource identifier is correct and try your request again.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • EndUserMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getJob

      default CompletableFuture<GetJobResponse> getJob(GetJobRequest getJobRequest)

      Retrieves the current state of an asynchronous job, including its status and any resources that it created or updated.

      Parameters:
      getJobRequest -
      Returns:
      A Java Future containing the result of the GetJob 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.
      • ValidationException A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.
      • ThrottlingException The request was denied because it exceeded the allowed request rate.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The request references a resource that does not exist. Verify that the resource identifier is correct and try your request again.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • EndUserMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getJob

      default CompletableFuture<GetJobResponse> getJob(Consumer<GetJobRequest.Builder> getJobRequest)

      Retrieves the current state of an asynchronous job, including its status and any resources that it created or updated.


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

      Parameters:
      getJobRequest - A Consumer that will call methods on GetJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetJob 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.
      • ValidationException A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.
      • ThrottlingException The request was denied because it exceeded the allowed request rate.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The request references a resource that does not exist. Verify that the resource identifier is correct and try your request again.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • EndUserMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getNotifyCodeConfiguration

      default CompletableFuture<GetNotifyCodeConfigurationResponse> getNotifyCodeConfiguration(GetNotifyCodeConfigurationRequest getNotifyCodeConfigurationRequest)

      Retrieves a notify code configuration.

      Parameters:
      getNotifyCodeConfigurationRequest -
      Returns:
      A Java Future containing the result of the GetNotifyCodeConfiguration 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.
      • ValidationException A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.
      • ThrottlingException The request was denied because it exceeded the allowed request rate.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The request references a resource that does not exist. Verify that the resource identifier is correct and try your request again.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • EndUserMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getNotifyCodeConfiguration

      default CompletableFuture<GetNotifyCodeConfigurationResponse> getNotifyCodeConfiguration(Consumer<GetNotifyCodeConfigurationRequest.Builder> getNotifyCodeConfigurationRequest)

      Retrieves a notify code configuration.


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

      Parameters:
      getNotifyCodeConfigurationRequest - A Consumer that will call methods on GetNotifyCodeConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetNotifyCodeConfiguration 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.
      • ValidationException A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.
      • ThrottlingException The request was denied because it exceeded the allowed request rate.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The request references a resource that does not exist. Verify that the resource identifier is correct and try your request again.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • EndUserMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listBrandProfileAttributes

      default CompletableFuture<ListBrandProfileAttributesResponse> listBrandProfileAttributes(ListBrandProfileAttributesRequest listBrandProfileAttributesRequest)

      Retrieves a paginated list of the attributes for a brand profile.

      Parameters:
      listBrandProfileAttributesRequest -
      Returns:
      A Java Future containing the result of the ListBrandProfileAttributes 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.
      • ValidationException A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.
      • ThrottlingException The request was denied because it exceeded the allowed request rate.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The request references a resource that does not exist. Verify that the resource identifier is correct and try your request again.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • EndUserMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listBrandProfileAttributes

      default CompletableFuture<ListBrandProfileAttributesResponse> listBrandProfileAttributes(Consumer<ListBrandProfileAttributesRequest.Builder> listBrandProfileAttributesRequest)

      Retrieves a paginated list of the attributes for a brand profile.


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

      Parameters:
      listBrandProfileAttributesRequest - A Consumer that will call methods on ListBrandProfileAttributesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListBrandProfileAttributes 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.
      • ValidationException A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.
      • ThrottlingException The request was denied because it exceeded the allowed request rate.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The request references a resource that does not exist. Verify that the resource identifier is correct and try your request again.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • EndUserMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listBrandProfileAttributesPaginator

      default ListBrandProfileAttributesPublisher listBrandProfileAttributesPaginator(ListBrandProfileAttributesRequest listBrandProfileAttributesRequest)

      This is a variant of listBrandProfileAttributes(software.amazon.awssdk.services.endusermessaging.model.ListBrandProfileAttributesRequest) 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.endusermessaging.paginators.ListBrandProfileAttributesPublisher publisher = client.listBrandProfileAttributesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.endusermessaging.paginators.ListBrandProfileAttributesPublisher publisher = client.listBrandProfileAttributesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.endusermessaging.model.ListBrandProfileAttributesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.endusermessaging.model.ListBrandProfileAttributesResponse 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 listBrandProfileAttributes(software.amazon.awssdk.services.endusermessaging.model.ListBrandProfileAttributesRequest) operation.

      Parameters:
      listBrandProfileAttributesRequest -
      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.
      • ValidationException A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.
      • ThrottlingException The request was denied because it exceeded the allowed request rate.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The request references a resource that does not exist. Verify that the resource identifier is correct and try your request again.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • EndUserMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listBrandProfileAttributesPaginator

      default ListBrandProfileAttributesPublisher listBrandProfileAttributesPaginator(Consumer<ListBrandProfileAttributesRequest.Builder> listBrandProfileAttributesRequest)

      This is a variant of listBrandProfileAttributes(software.amazon.awssdk.services.endusermessaging.model.ListBrandProfileAttributesRequest) 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.endusermessaging.paginators.ListBrandProfileAttributesPublisher publisher = client.listBrandProfileAttributesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.endusermessaging.paginators.ListBrandProfileAttributesPublisher publisher = client.listBrandProfileAttributesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.endusermessaging.model.ListBrandProfileAttributesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.endusermessaging.model.ListBrandProfileAttributesResponse 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 listBrandProfileAttributes(software.amazon.awssdk.services.endusermessaging.model.ListBrandProfileAttributesRequest) operation.


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

      Parameters:
      listBrandProfileAttributesRequest - A Consumer that will call methods on ListBrandProfileAttributesRequest.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.
      • ValidationException A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.
      • ThrottlingException The request was denied because it exceeded the allowed request rate.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The request references a resource that does not exist. Verify that the resource identifier is correct and try your request again.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • EndUserMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listBrandProfiles

      default CompletableFuture<ListBrandProfilesResponse> listBrandProfiles(ListBrandProfilesRequest listBrandProfilesRequest)

      Retrieves a paginated list of the brand profiles in your account. Use the nextToken parameter to retrieve additional results.

      Parameters:
      listBrandProfilesRequest -
      Returns:
      A Java Future containing the result of the ListBrandProfiles 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.
      • ValidationException A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.
      • ThrottlingException The request was denied because it exceeded the allowed request rate.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • EndUserMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listBrandProfiles

      default CompletableFuture<ListBrandProfilesResponse> listBrandProfiles(Consumer<ListBrandProfilesRequest.Builder> listBrandProfilesRequest)

      Retrieves a paginated list of the brand profiles in your account. Use the nextToken parameter to retrieve additional results.


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

      Parameters:
      listBrandProfilesRequest - A Consumer that will call methods on ListBrandProfilesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListBrandProfiles 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.
      • ValidationException A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.
      • ThrottlingException The request was denied because it exceeded the allowed request rate.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • EndUserMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listBrandProfilesPaginator

      default ListBrandProfilesPublisher listBrandProfilesPaginator(ListBrandProfilesRequest listBrandProfilesRequest)

      This is a variant of listBrandProfiles(software.amazon.awssdk.services.endusermessaging.model.ListBrandProfilesRequest) 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.endusermessaging.paginators.ListBrandProfilesPublisher publisher = client.listBrandProfilesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.endusermessaging.paginators.ListBrandProfilesPublisher publisher = client.listBrandProfilesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.endusermessaging.model.ListBrandProfilesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.endusermessaging.model.ListBrandProfilesResponse 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 listBrandProfiles(software.amazon.awssdk.services.endusermessaging.model.ListBrandProfilesRequest) operation.

      Parameters:
      listBrandProfilesRequest -
      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.
      • ValidationException A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.
      • ThrottlingException The request was denied because it exceeded the allowed request rate.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • EndUserMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listBrandProfilesPaginator

      default ListBrandProfilesPublisher listBrandProfilesPaginator(Consumer<ListBrandProfilesRequest.Builder> listBrandProfilesRequest)

      This is a variant of listBrandProfiles(software.amazon.awssdk.services.endusermessaging.model.ListBrandProfilesRequest) 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.endusermessaging.paginators.ListBrandProfilesPublisher publisher = client.listBrandProfilesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.endusermessaging.paginators.ListBrandProfilesPublisher publisher = client.listBrandProfilesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.endusermessaging.model.ListBrandProfilesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.endusermessaging.model.ListBrandProfilesResponse 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 listBrandProfiles(software.amazon.awssdk.services.endusermessaging.model.ListBrandProfilesRequest) operation.


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

      Parameters:
      listBrandProfilesRequest - A Consumer that will call methods on ListBrandProfilesRequest.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.
      • ValidationException A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.
      • ThrottlingException The request was denied because it exceeded the allowed request rate.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • EndUserMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listJobs

      default CompletableFuture<ListJobsResponse> listJobs(ListJobsRequest listJobsRequest)

      Retrieves a paginated list of the asynchronous jobs in your account. You can filter the results by status, brand profile, or operation type.

      Parameters:
      listJobsRequest -
      Returns:
      A Java Future containing the result of the ListJobs 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.
      • ValidationException A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.
      • ThrottlingException The request was denied because it exceeded the allowed request rate.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • EndUserMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listJobs

      default CompletableFuture<ListJobsResponse> listJobs(Consumer<ListJobsRequest.Builder> listJobsRequest)

      Retrieves a paginated list of the asynchronous jobs in your account. You can filter the results by status, brand profile, or operation type.


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

      Parameters:
      listJobsRequest - A Consumer that will call methods on ListJobsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListJobs 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.
      • ValidationException A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.
      • ThrottlingException The request was denied because it exceeded the allowed request rate.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • EndUserMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listJobsPaginator

      default ListJobsPublisher listJobsPaginator(ListJobsRequest listJobsRequest)

      This is a variant of listJobs(software.amazon.awssdk.services.endusermessaging.model.ListJobsRequest) 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.endusermessaging.paginators.ListJobsPublisher publisher = client.listJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.endusermessaging.paginators.ListJobsPublisher publisher = client.listJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.endusermessaging.model.ListJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.endusermessaging.model.ListJobsResponse 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 listJobs(software.amazon.awssdk.services.endusermessaging.model.ListJobsRequest) operation.

      Parameters:
      listJobsRequest -
      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.
      • ValidationException A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.
      • ThrottlingException The request was denied because it exceeded the allowed request rate.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • EndUserMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listJobsPaginator

      default ListJobsPublisher listJobsPaginator(Consumer<ListJobsRequest.Builder> listJobsRequest)

      This is a variant of listJobs(software.amazon.awssdk.services.endusermessaging.model.ListJobsRequest) 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.endusermessaging.paginators.ListJobsPublisher publisher = client.listJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.endusermessaging.paginators.ListJobsPublisher publisher = client.listJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.endusermessaging.model.ListJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.endusermessaging.model.ListJobsResponse 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 listJobs(software.amazon.awssdk.services.endusermessaging.model.ListJobsRequest) operation.


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

      Parameters:
      listJobsRequest - A Consumer that will call methods on ListJobsRequest.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.
      • ValidationException A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.
      • ThrottlingException The request was denied because it exceeded the allowed request rate.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • EndUserMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listNotifyCodeConfigurations

      default CompletableFuture<ListNotifyCodeConfigurationsResponse> listNotifyCodeConfigurations(ListNotifyCodeConfigurationsRequest listNotifyCodeConfigurationsRequest)

      Retrieves a paginated list of the notify code configurations in your account.

      Parameters:
      listNotifyCodeConfigurationsRequest -
      Returns:
      A Java Future containing the result of the ListNotifyCodeConfigurations 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.
      • ValidationException A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.
      • ThrottlingException The request was denied because it exceeded the allowed request rate.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • EndUserMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listNotifyCodeConfigurations

      default CompletableFuture<ListNotifyCodeConfigurationsResponse> listNotifyCodeConfigurations(Consumer<ListNotifyCodeConfigurationsRequest.Builder> listNotifyCodeConfigurationsRequest)

      Retrieves a paginated list of the notify code configurations in your account.


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

      Parameters:
      listNotifyCodeConfigurationsRequest - A Consumer that will call methods on ListNotifyCodeConfigurationsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListNotifyCodeConfigurations 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.
      • ValidationException A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.
      • ThrottlingException The request was denied because it exceeded the allowed request rate.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • EndUserMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listNotifyCodeConfigurationsPaginator

      default ListNotifyCodeConfigurationsPublisher listNotifyCodeConfigurationsPaginator(ListNotifyCodeConfigurationsRequest listNotifyCodeConfigurationsRequest)

      This is a variant of listNotifyCodeConfigurations(software.amazon.awssdk.services.endusermessaging.model.ListNotifyCodeConfigurationsRequest) 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.endusermessaging.paginators.ListNotifyCodeConfigurationsPublisher publisher = client.listNotifyCodeConfigurationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.endusermessaging.paginators.ListNotifyCodeConfigurationsPublisher publisher = client.listNotifyCodeConfigurationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.endusermessaging.model.ListNotifyCodeConfigurationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.endusermessaging.model.ListNotifyCodeConfigurationsResponse 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 listNotifyCodeConfigurations(software.amazon.awssdk.services.endusermessaging.model.ListNotifyCodeConfigurationsRequest) operation.

      Parameters:
      listNotifyCodeConfigurationsRequest -
      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.
      • ValidationException A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.
      • ThrottlingException The request was denied because it exceeded the allowed request rate.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • EndUserMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listNotifyCodeConfigurationsPaginator

      default ListNotifyCodeConfigurationsPublisher listNotifyCodeConfigurationsPaginator(Consumer<ListNotifyCodeConfigurationsRequest.Builder> listNotifyCodeConfigurationsRequest)

      This is a variant of listNotifyCodeConfigurations(software.amazon.awssdk.services.endusermessaging.model.ListNotifyCodeConfigurationsRequest) 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.endusermessaging.paginators.ListNotifyCodeConfigurationsPublisher publisher = client.listNotifyCodeConfigurationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.endusermessaging.paginators.ListNotifyCodeConfigurationsPublisher publisher = client.listNotifyCodeConfigurationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.endusermessaging.model.ListNotifyCodeConfigurationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.endusermessaging.model.ListNotifyCodeConfigurationsResponse 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 listNotifyCodeConfigurations(software.amazon.awssdk.services.endusermessaging.model.ListNotifyCodeConfigurationsRequest) operation.


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

      Parameters:
      listNotifyCodeConfigurationsRequest - A Consumer that will call methods on ListNotifyCodeConfigurationsRequest.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.
      • ValidationException A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.
      • ThrottlingException The request was denied because it exceeded the allowed request rate.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • EndUserMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRegistrationsFromBrandProfile

      default CompletableFuture<ListRegistrationsFromBrandProfileResponse> listRegistrationsFromBrandProfile(ListRegistrationsFromBrandProfileRequest listRegistrationsFromBrandProfileRequest)

      Retrieves a paginated list of the registrations that were created from a brand profile through the synchronization operations.

      Parameters:
      listRegistrationsFromBrandProfileRequest -
      Returns:
      A Java Future containing the result of the ListRegistrationsFromBrandProfile 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.
      • ValidationException A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.
      • ThrottlingException The request was denied because it exceeded the allowed request rate.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The request references a resource that does not exist. Verify that the resource identifier is correct and try your request again.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • EndUserMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRegistrationsFromBrandProfile

      default CompletableFuture<ListRegistrationsFromBrandProfileResponse> listRegistrationsFromBrandProfile(Consumer<ListRegistrationsFromBrandProfileRequest.Builder> listRegistrationsFromBrandProfileRequest)

      Retrieves a paginated list of the registrations that were created from a brand profile through the synchronization operations.


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

      Parameters:
      listRegistrationsFromBrandProfileRequest - A Consumer that will call methods on ListRegistrationsFromBrandProfileRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListRegistrationsFromBrandProfile 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.
      • ValidationException A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.
      • ThrottlingException The request was denied because it exceeded the allowed request rate.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The request references a resource that does not exist. Verify that the resource identifier is correct and try your request again.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • EndUserMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRegistrationsFromBrandProfilePaginator

      default ListRegistrationsFromBrandProfilePublisher listRegistrationsFromBrandProfilePaginator(ListRegistrationsFromBrandProfileRequest listRegistrationsFromBrandProfileRequest)

      This is a variant of listRegistrationsFromBrandProfile(software.amazon.awssdk.services.endusermessaging.model.ListRegistrationsFromBrandProfileRequest) 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.endusermessaging.paginators.ListRegistrationsFromBrandProfilePublisher publisher = client.listRegistrationsFromBrandProfilePaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.endusermessaging.paginators.ListRegistrationsFromBrandProfilePublisher publisher = client.listRegistrationsFromBrandProfilePaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.endusermessaging.model.ListRegistrationsFromBrandProfileResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.endusermessaging.model.ListRegistrationsFromBrandProfileResponse 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 listRegistrationsFromBrandProfile(software.amazon.awssdk.services.endusermessaging.model.ListRegistrationsFromBrandProfileRequest) operation.

      Parameters:
      listRegistrationsFromBrandProfileRequest -
      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.
      • ValidationException A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.
      • ThrottlingException The request was denied because it exceeded the allowed request rate.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The request references a resource that does not exist. Verify that the resource identifier is correct and try your request again.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • EndUserMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRegistrationsFromBrandProfilePaginator

      default ListRegistrationsFromBrandProfilePublisher listRegistrationsFromBrandProfilePaginator(Consumer<ListRegistrationsFromBrandProfileRequest.Builder> listRegistrationsFromBrandProfileRequest)

      This is a variant of listRegistrationsFromBrandProfile(software.amazon.awssdk.services.endusermessaging.model.ListRegistrationsFromBrandProfileRequest) 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.endusermessaging.paginators.ListRegistrationsFromBrandProfilePublisher publisher = client.listRegistrationsFromBrandProfilePaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.endusermessaging.paginators.ListRegistrationsFromBrandProfilePublisher publisher = client.listRegistrationsFromBrandProfilePaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.endusermessaging.model.ListRegistrationsFromBrandProfileResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.endusermessaging.model.ListRegistrationsFromBrandProfileResponse 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 listRegistrationsFromBrandProfile(software.amazon.awssdk.services.endusermessaging.model.ListRegistrationsFromBrandProfileRequest) operation.


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

      Parameters:
      listRegistrationsFromBrandProfileRequest - A Consumer that will call methods on ListRegistrationsFromBrandProfileRequest.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.
      • ValidationException A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.
      • ThrottlingException The request was denied because it exceeded the allowed request rate.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The request references a resource that does not exist. Verify that the resource identifier is correct and try your request again.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • EndUserMessagingException 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)

      Retrieves the tags that are associated with a resource.

      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.
      • ValidationException A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.
      • ThrottlingException The request was denied because it exceeded the allowed request rate.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The request references a resource that does not exist. Verify that the resource identifier is correct and try your request again.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • EndUserMessagingException 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)

      Retrieves the tags that are associated with a resource.


      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.
      • ValidationException A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.
      • ThrottlingException The request was denied because it exceeded the allowed request rate.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The request references a resource that does not exist. Verify that the resource identifier is correct and try your request again.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • EndUserMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • sendNotifyCodeVerification

      default CompletableFuture<SendNotifyCodeVerificationResponse> sendNotifyCodeVerification(SendNotifyCodeVerificationRequest sendNotifyCodeVerificationRequest)

      Generates a one-time passcode and delivers it to a recipient over the requested channel. The passcode policy is captured from the referenced notify code configuration at the time of the request, so later updates to the configuration do not affect verifications that are already in progress.

      Parameters:
      sendNotifyCodeVerificationRequest -
      Returns:
      A Java Future containing the result of the SendNotifyCodeVerification 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.
      • ValidationException A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.
      • ThrottlingException The request was denied because it exceeded the allowed request rate.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The request references a resource that does not exist. Verify that the resource identifier is correct and try your request again.
      • InternalServerException An unexpected error occurred during the processing of the request.
      • ConflictException The request conflicts with the current state of the resource.
      • ServiceQuotaExceededException The request would exceed a service quota for your account.
      • 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.
      • EndUserMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • sendNotifyCodeVerification

      default CompletableFuture<SendNotifyCodeVerificationResponse> sendNotifyCodeVerification(Consumer<SendNotifyCodeVerificationRequest.Builder> sendNotifyCodeVerificationRequest)

      Generates a one-time passcode and delivers it to a recipient over the requested channel. The passcode policy is captured from the referenced notify code configuration at the time of the request, so later updates to the configuration do not affect verifications that are already in progress.


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

      Parameters:
      sendNotifyCodeVerificationRequest - A Consumer that will call methods on SendNotifyCodeVerificationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the SendNotifyCodeVerification 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.
      • ValidationException A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.
      • ThrottlingException The request was denied because it exceeded the allowed request rate.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The request references a resource that does not exist. Verify that the resource identifier is correct and try your request again.
      • InternalServerException An unexpected error occurred during the processing of the request.
      • ConflictException The request conflicts with the current state of the resource.
      • ServiceQuotaExceededException The request would exceed a service quota for your account.
      • 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.
      • EndUserMessagingException 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)

      Adds or overwrites the tags on a resource.

      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.
      • ValidationException A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.
      • ThrottlingException The request was denied because it exceeded the allowed request rate.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The request references a resource that does not exist. Verify that the resource identifier is correct and try your request again.
      • InternalServerException An unexpected error occurred during the processing of the request.
      • ServiceQuotaExceededException The request would exceed a service quota for your account.
      • 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.
      • EndUserMessagingException 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)

      Adds or overwrites the tags on a resource.


      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.
      • ValidationException A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.
      • ThrottlingException The request was denied because it exceeded the allowed request rate.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The request references a resource that does not exist. Verify that the resource identifier is correct and try your request again.
      • InternalServerException An unexpected error occurred during the processing of the request.
      • ServiceQuotaExceededException The request would exceed a service quota for your account.
      • 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.
      • EndUserMessagingException 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 the specified tags from a 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.
      • ValidationException A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.
      • ThrottlingException The request was denied because it exceeded the allowed request rate.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The request references a resource that does not exist. Verify that the resource identifier is correct and try your request again.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • EndUserMessagingException 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 the specified tags from a 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.
      • ValidationException A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.
      • ThrottlingException The request was denied because it exceeded the allowed request rate.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The request references a resource that does not exist. Verify that the resource identifier is correct and try your request again.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • EndUserMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateBrandProfile

      default CompletableFuture<UpdateBrandProfileResponse> updateBrandProfile(UpdateBrandProfileRequest updateBrandProfileRequest)

      Updates the name or the deletion protection setting of a brand profile. To change the information that is stored in the profile, use the brand profile attribute operations.

      Parameters:
      updateBrandProfileRequest -
      Returns:
      A Java Future containing the result of the UpdateBrandProfile 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.
      • ValidationException A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.
      • ThrottlingException The request was denied because it exceeded the allowed request rate.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The request references a resource that does not exist. Verify that the resource identifier is correct and try your request again.
      • InternalServerException An unexpected error occurred during the processing of the request.
      • ConflictException The request conflicts with the current state of the resource.
      • 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.
      • EndUserMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateBrandProfile

      default CompletableFuture<UpdateBrandProfileResponse> updateBrandProfile(Consumer<UpdateBrandProfileRequest.Builder> updateBrandProfileRequest)

      Updates the name or the deletion protection setting of a brand profile. To change the information that is stored in the profile, use the brand profile attribute operations.


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

      Parameters:
      updateBrandProfileRequest - A Consumer that will call methods on UpdateBrandProfileRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateBrandProfile 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.
      • ValidationException A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.
      • ThrottlingException The request was denied because it exceeded the allowed request rate.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The request references a resource that does not exist. Verify that the resource identifier is correct and try your request again.
      • InternalServerException An unexpected error occurred during the processing of the request.
      • ConflictException The request conflicts with the current state of the resource.
      • 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.
      • EndUserMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateBrandProfileAttribute

      default CompletableFuture<UpdateBrandProfileAttributeResponse> updateBrandProfileAttribute(UpdateBrandProfileAttributeRequest updateBrandProfileAttributeRequest)

      Updates the value, description, or category of an existing brand profile attribute.

      Parameters:
      updateBrandProfileAttributeRequest -
      Returns:
      A Java Future containing the result of the UpdateBrandProfileAttribute 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.
      • ValidationException A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.
      • ThrottlingException The request was denied because it exceeded the allowed request rate.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The request references a resource that does not exist. Verify that the resource identifier is correct and try your request again.
      • InternalServerException An unexpected error occurred during the processing of the request.
      • ConflictException The request conflicts with the current state of the resource.
      • 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.
      • EndUserMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateBrandProfileAttribute

      default CompletableFuture<UpdateBrandProfileAttributeResponse> updateBrandProfileAttribute(Consumer<UpdateBrandProfileAttributeRequest.Builder> updateBrandProfileAttributeRequest)

      Updates the value, description, or category of an existing brand profile attribute.


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

      Parameters:
      updateBrandProfileAttributeRequest - A Consumer that will call methods on UpdateBrandProfileAttributeRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateBrandProfileAttribute 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.
      • ValidationException A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.
      • ThrottlingException The request was denied because it exceeded the allowed request rate.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The request references a resource that does not exist. Verify that the resource identifier is correct and try your request again.
      • InternalServerException An unexpected error occurred during the processing of the request.
      • ConflictException The request conflicts with the current state of the resource.
      • 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.
      • EndUserMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateBrandProfileFromRegistration

      default CompletableFuture<UpdateBrandProfileFromRegistrationResponse> updateBrandProfileFromRegistration(UpdateBrandProfileFromRegistrationRequest updateBrandProfileFromRegistrationRequest)

      Imports or refreshes the attributes of an existing brand profile from an existing registration. This operation runs asynchronously. Use the GetJob operation to track its progress.

      Parameters:
      updateBrandProfileFromRegistrationRequest -
      Returns:
      A Java Future containing the result of the UpdateBrandProfileFromRegistration 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.
      • ValidationException A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.
      • ThrottlingException The request was denied because it exceeded the allowed request rate.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The request references a resource that does not exist. Verify that the resource identifier is correct and try your request again.
      • InternalServerException An unexpected error occurred during the processing of the request.
      • ConflictException The request conflicts with the current state of the resource.
      • 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.
      • EndUserMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateBrandProfileFromRegistration

      default CompletableFuture<UpdateBrandProfileFromRegistrationResponse> updateBrandProfileFromRegistration(Consumer<UpdateBrandProfileFromRegistrationRequest.Builder> updateBrandProfileFromRegistrationRequest)

      Imports or refreshes the attributes of an existing brand profile from an existing registration. This operation runs asynchronously. Use the GetJob operation to track its progress.


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

      Parameters:
      updateBrandProfileFromRegistrationRequest - A Consumer that will call methods on UpdateBrandProfileFromRegistrationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateBrandProfileFromRegistration 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.
      • ValidationException A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.
      • ThrottlingException The request was denied because it exceeded the allowed request rate.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The request references a resource that does not exist. Verify that the resource identifier is correct and try your request again.
      • InternalServerException An unexpected error occurred during the processing of the request.
      • ConflictException The request conflicts with the current state of the resource.
      • 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.
      • EndUserMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateNotifyCodeConfiguration

      default CompletableFuture<UpdateNotifyCodeConfigurationResponse> updateNotifyCodeConfiguration(UpdateNotifyCodeConfigurationRequest updateNotifyCodeConfigurationRequest)

      Updates the mutable fields of a notify code configuration. Only the fields that you supply are changed. For the template and language fields, supplying an empty value clears the currently stored value.

      Parameters:
      updateNotifyCodeConfigurationRequest -
      Returns:
      A Java Future containing the result of the UpdateNotifyCodeConfiguration 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.
      • ValidationException A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.
      • ThrottlingException The request was denied because it exceeded the allowed request rate.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The request references a resource that does not exist. Verify that the resource identifier is correct and try your request again.
      • InternalServerException An unexpected error occurred during the processing of the request.
      • ConflictException The request conflicts with the current state of the resource.
      • 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.
      • EndUserMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateNotifyCodeConfiguration

      default CompletableFuture<UpdateNotifyCodeConfigurationResponse> updateNotifyCodeConfiguration(Consumer<UpdateNotifyCodeConfigurationRequest.Builder> updateNotifyCodeConfigurationRequest)

      Updates the mutable fields of a notify code configuration. Only the fields that you supply are changed. For the template and language fields, supplying an empty value clears the currently stored value.


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

      Parameters:
      updateNotifyCodeConfigurationRequest - A Consumer that will call methods on UpdateNotifyCodeConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateNotifyCodeConfiguration 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.
      • ValidationException A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.
      • ThrottlingException The request was denied because it exceeded the allowed request rate.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The request references a resource that does not exist. Verify that the resource identifier is correct and try your request again.
      • InternalServerException An unexpected error occurred during the processing of the request.
      • ConflictException The request conflicts with the current state of the resource.
      • 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.
      • EndUserMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateRegistrationsFromBrandProfile

      default CompletableFuture<UpdateRegistrationsFromBrandProfileResponse> updateRegistrationsFromBrandProfile(UpdateRegistrationsFromBrandProfileRequest updateRegistrationsFromBrandProfileRequest)

      Repushes the attributes of a brand profile into existing DRAFT registrations. This operation runs asynchronously. Use the GetJob operation to track its progress.

      Parameters:
      updateRegistrationsFromBrandProfileRequest -
      Returns:
      A Java Future containing the result of the UpdateRegistrationsFromBrandProfile 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.
      • ValidationException A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.
      • ThrottlingException The request was denied because it exceeded the allowed request rate.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The request references a resource that does not exist. Verify that the resource identifier is correct and try your request again.
      • InternalServerException An unexpected error occurred during the processing of the request.
      • ConflictException The request conflicts with the current state of the resource.
      • 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.
      • EndUserMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateRegistrationsFromBrandProfile

      default CompletableFuture<UpdateRegistrationsFromBrandProfileResponse> updateRegistrationsFromBrandProfile(Consumer<UpdateRegistrationsFromBrandProfileRequest.Builder> updateRegistrationsFromBrandProfileRequest)

      Repushes the attributes of a brand profile into existing DRAFT registrations. This operation runs asynchronously. Use the GetJob operation to track its progress.


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

      Parameters:
      updateRegistrationsFromBrandProfileRequest - A Consumer that will call methods on UpdateRegistrationsFromBrandProfileRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateRegistrationsFromBrandProfile 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.
      • ValidationException A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.
      • ThrottlingException The request was denied because it exceeded the allowed request rate.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The request references a resource that does not exist. Verify that the resource identifier is correct and try your request again.
      • InternalServerException An unexpected error occurred during the processing of the request.
      • ConflictException The request conflicts with the current state of the resource.
      • 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.
      • EndUserMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • validateNotifyCodeVerification

      default CompletableFuture<ValidateNotifyCodeVerificationResponse> validateNotifyCodeVerification(ValidateNotifyCodeVerificationRequest validateNotifyCodeVerificationRequest)

      Validates a one-time passcode that a recipient submitted. Validation succeeds when the passcode matches, the validity period has not elapsed, and the maximum number of attempts has not been exceeded.

      Parameters:
      validateNotifyCodeVerificationRequest -
      Returns:
      A Java Future containing the result of the ValidateNotifyCodeVerification 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.
      • ValidationException A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.
      • ThrottlingException The request was denied because it exceeded the allowed request rate.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • EndUserMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • validateNotifyCodeVerification

      default CompletableFuture<ValidateNotifyCodeVerificationResponse> validateNotifyCodeVerification(Consumer<ValidateNotifyCodeVerificationRequest.Builder> validateNotifyCodeVerificationRequest)

      Validates a one-time passcode that a recipient submitted. Validation succeeds when the passcode matches, the validity period has not elapsed, and the maximum number of attempts has not been exceeded.


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

      Parameters:
      validateNotifyCodeVerificationRequest - A Consumer that will call methods on ValidateNotifyCodeVerificationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ValidateNotifyCodeVerification 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.
      • ValidationException A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.
      • ThrottlingException The request was denied because it exceeded the allowed request rate.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An unexpected error occurred during the processing of 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.
      • EndUserMessagingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • waiter

      default EndUserMessagingAsyncWaiter waiter()
      Create an instance of EndUserMessagingAsyncWaiter using this client.

      Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.

      Returns:
      an instance of EndUserMessagingAsyncWaiter

    • serviceClientConfiguration

      default EndUserMessagingServiceClientConfiguration 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 EndUserMessagingAsyncClient create()
      Create a EndUserMessagingAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static EndUserMessagingAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a EndUserMessagingAsyncClient.