Package software.amazon.awssdk.services.pinpoint

Interface PinpointAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface PinpointAsyncClient extends AwsClient
Service client for accessing Amazon Pinpoint 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.

Doc Engage API - Amazon Pinpoint API

  • Field Details

  • Method Details

    • createApp

      default CompletableFuture<CreateAppResponse> createApp(CreateAppRequest createAppRequest)

      Creates an application.

      Parameters:
      createAppRequest -
      Returns:
      A Java Future containing the result of the CreateApp 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createApp

      default CompletableFuture<CreateAppResponse> createApp(Consumer<CreateAppRequest.Builder> createAppRequest)

      Creates an application.


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

      Parameters:
      createAppRequest - A Consumer that will call methods on CreateAppRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateApp 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createCampaign

      default CompletableFuture<CreateCampaignResponse> createCampaign(CreateCampaignRequest createCampaignRequest)

      Creates a new campaign for an application or updates the settings of an existing campaign for an application.

      Parameters:
      createCampaignRequest -
      Returns:
      A Java Future containing the result of the CreateCampaign 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createCampaign

      default CompletableFuture<CreateCampaignResponse> createCampaign(Consumer<CreateCampaignRequest.Builder> createCampaignRequest)

      Creates a new campaign for an application or updates the settings of an existing campaign for an application.


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

      Parameters:
      createCampaignRequest - A Consumer that will call methods on CreateCampaignRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateCampaign 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createEmailTemplate

      default CompletableFuture<CreateEmailTemplateResponse> createEmailTemplate(CreateEmailTemplateRequest createEmailTemplateRequest)

      Creates a message template for messages that are sent through the email channel.

      Parameters:
      createEmailTemplateRequest -
      Returns:
      A Java Future containing the result of the CreateEmailTemplate 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.
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createEmailTemplate

      default CompletableFuture<CreateEmailTemplateResponse> createEmailTemplate(Consumer<CreateEmailTemplateRequest.Builder> createEmailTemplateRequest)

      Creates a message template for messages that are sent through the email channel.


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

      Parameters:
      createEmailTemplateRequest - A Consumer that will call methods on CreateEmailTemplateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateEmailTemplate 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.
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createExportJob

      default CompletableFuture<CreateExportJobResponse> createExportJob(CreateExportJobRequest createExportJobRequest)

      Creates an export job for an application.

      Parameters:
      createExportJobRequest -
      Returns:
      A Java Future containing the result of the CreateExportJob 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createExportJob

      default CompletableFuture<CreateExportJobResponse> createExportJob(Consumer<CreateExportJobRequest.Builder> createExportJobRequest)

      Creates an export job for an application.


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

      Parameters:
      createExportJobRequest - A Consumer that will call methods on CreateExportJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateExportJob 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createImportJob

      default CompletableFuture<CreateImportJobResponse> createImportJob(CreateImportJobRequest createImportJobRequest)

      Creates an import job for an application.

      Parameters:
      createImportJobRequest -
      Returns:
      A Java Future containing the result of the CreateImportJob 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createImportJob

      default CompletableFuture<CreateImportJobResponse> createImportJob(Consumer<CreateImportJobRequest.Builder> createImportJobRequest)

      Creates an import job for an application.


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

      Parameters:
      createImportJobRequest - A Consumer that will call methods on CreateImportJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateImportJob 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createInAppTemplate

      default CompletableFuture<CreateInAppTemplateResponse> createInAppTemplate(CreateInAppTemplateRequest createInAppTemplateRequest)

      Creates a new message template for messages using the in-app message channel.

      Parameters:
      createInAppTemplateRequest -
      Returns:
      A Java Future containing the result of the CreateInAppTemplate 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.
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createInAppTemplate

      default CompletableFuture<CreateInAppTemplateResponse> createInAppTemplate(Consumer<CreateInAppTemplateRequest.Builder> createInAppTemplateRequest)

      Creates a new message template for messages using the in-app message channel.


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

      Parameters:
      createInAppTemplateRequest - A Consumer that will call methods on CreateInAppTemplateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateInAppTemplate 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.
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createJourney

      default CompletableFuture<CreateJourneyResponse> createJourney(CreateJourneyRequest createJourneyRequest)

      Creates a journey for an application.

      Parameters:
      createJourneyRequest -
      Returns:
      A Java Future containing the result of the CreateJourney 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createJourney

      default CompletableFuture<CreateJourneyResponse> createJourney(Consumer<CreateJourneyRequest.Builder> createJourneyRequest)

      Creates a journey for an application.


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

      Parameters:
      createJourneyRequest - A Consumer that will call methods on CreateJourneyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateJourney 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createPushTemplate

      default CompletableFuture<CreatePushTemplateResponse> createPushTemplate(CreatePushTemplateRequest createPushTemplateRequest)

      Creates a message template for messages that are sent through a push notification channel.

      Parameters:
      createPushTemplateRequest -
      Returns:
      A Java Future containing the result of the CreatePushTemplate 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.
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createPushTemplate

      default CompletableFuture<CreatePushTemplateResponse> createPushTemplate(Consumer<CreatePushTemplateRequest.Builder> createPushTemplateRequest)

      Creates a message template for messages that are sent through a push notification channel.


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

      Parameters:
      createPushTemplateRequest - A Consumer that will call methods on CreatePushTemplateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreatePushTemplate 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.
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createRecommenderConfiguration

      default CompletableFuture<CreateRecommenderConfigurationResponse> createRecommenderConfiguration(CreateRecommenderConfigurationRequest createRecommenderConfigurationRequest)

      Creates an Amazon Pinpoint configuration for a recommender model.

      Parameters:
      createRecommenderConfigurationRequest -
      Returns:
      A Java Future containing the result of the CreateRecommenderConfiguration 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createRecommenderConfiguration

      default CompletableFuture<CreateRecommenderConfigurationResponse> createRecommenderConfiguration(Consumer<CreateRecommenderConfigurationRequest.Builder> createRecommenderConfigurationRequest)

      Creates an Amazon Pinpoint configuration for a recommender model.


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

      Parameters:
      createRecommenderConfigurationRequest - A Consumer that will call methods on CreateRecommenderConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateRecommenderConfiguration 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createSegment

      default CompletableFuture<CreateSegmentResponse> createSegment(CreateSegmentRequest createSegmentRequest)

      Creates a new segment for an application or updates the configuration, dimension, and other settings for an existing segment that's associated with an application.

      Parameters:
      createSegmentRequest -
      Returns:
      A Java Future containing the result of the CreateSegment 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createSegment

      default CompletableFuture<CreateSegmentResponse> createSegment(Consumer<CreateSegmentRequest.Builder> createSegmentRequest)

      Creates a new segment for an application or updates the configuration, dimension, and other settings for an existing segment that's associated with an application.


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

      Parameters:
      createSegmentRequest - A Consumer that will call methods on CreateSegmentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateSegment 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createSmsTemplate

      default CompletableFuture<CreateSmsTemplateResponse> createSmsTemplate(CreateSmsTemplateRequest createSmsTemplateRequest)

      Creates a message template for messages that are sent through the SMS channel.

      Parameters:
      createSmsTemplateRequest -
      Returns:
      A Java Future containing the result of the CreateSmsTemplate 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.
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createSmsTemplate

      default CompletableFuture<CreateSmsTemplateResponse> createSmsTemplate(Consumer<CreateSmsTemplateRequest.Builder> createSmsTemplateRequest)

      Creates a message template for messages that are sent through the SMS channel.


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

      Parameters:
      createSmsTemplateRequest - A Consumer that will call methods on CreateSmsTemplateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateSmsTemplate 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.
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createVoiceTemplate

      default CompletableFuture<CreateVoiceTemplateResponse> createVoiceTemplate(CreateVoiceTemplateRequest createVoiceTemplateRequest)

      Creates a message template for messages that are sent through the voice channel.

      Parameters:
      createVoiceTemplateRequest -
      Returns:
      A Java Future containing the result of the CreateVoiceTemplate 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.
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createVoiceTemplate

      default CompletableFuture<CreateVoiceTemplateResponse> createVoiceTemplate(Consumer<CreateVoiceTemplateRequest.Builder> createVoiceTemplateRequest)

      Creates a message template for messages that are sent through the voice channel.


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

      Parameters:
      createVoiceTemplateRequest - A Consumer that will call methods on CreateVoiceTemplateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateVoiceTemplate 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.
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAdmChannel

      default CompletableFuture<DeleteAdmChannelResponse> deleteAdmChannel(DeleteAdmChannelRequest deleteAdmChannelRequest)

      Disables the ADM channel for an application and deletes any existing settings for the channel.

      Parameters:
      deleteAdmChannelRequest -
      Returns:
      A Java Future containing the result of the DeleteAdmChannel 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAdmChannel

      default CompletableFuture<DeleteAdmChannelResponse> deleteAdmChannel(Consumer<DeleteAdmChannelRequest.Builder> deleteAdmChannelRequest)

      Disables the ADM channel for an application and deletes any existing settings for the channel.


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

      Parameters:
      deleteAdmChannelRequest - A Consumer that will call methods on DeleteAdmChannelRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteAdmChannel 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteApnsChannel

      default CompletableFuture<DeleteApnsChannelResponse> deleteApnsChannel(DeleteApnsChannelRequest deleteApnsChannelRequest)

      Disables the APNs channel for an application and deletes any existing settings for the channel.

      Parameters:
      deleteApnsChannelRequest -
      Returns:
      A Java Future containing the result of the DeleteApnsChannel 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteApnsChannel

      default CompletableFuture<DeleteApnsChannelResponse> deleteApnsChannel(Consumer<DeleteApnsChannelRequest.Builder> deleteApnsChannelRequest)

      Disables the APNs channel for an application and deletes any existing settings for the channel.


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

      Parameters:
      deleteApnsChannelRequest - A Consumer that will call methods on DeleteApnsChannelRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteApnsChannel 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteApnsSandboxChannel

      default CompletableFuture<DeleteApnsSandboxChannelResponse> deleteApnsSandboxChannel(DeleteApnsSandboxChannelRequest deleteApnsSandboxChannelRequest)

      Disables the APNs sandbox channel for an application and deletes any existing settings for the channel.

      Parameters:
      deleteApnsSandboxChannelRequest -
      Returns:
      A Java Future containing the result of the DeleteApnsSandboxChannel 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteApnsSandboxChannel

      default CompletableFuture<DeleteApnsSandboxChannelResponse> deleteApnsSandboxChannel(Consumer<DeleteApnsSandboxChannelRequest.Builder> deleteApnsSandboxChannelRequest)

      Disables the APNs sandbox channel for an application and deletes any existing settings for the channel.


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

      Parameters:
      deleteApnsSandboxChannelRequest - A Consumer that will call methods on DeleteApnsSandboxChannelRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteApnsSandboxChannel 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteApnsVoipChannel

      default CompletableFuture<DeleteApnsVoipChannelResponse> deleteApnsVoipChannel(DeleteApnsVoipChannelRequest deleteApnsVoipChannelRequest)

      Disables the APNs VoIP channel for an application and deletes any existing settings for the channel.

      Parameters:
      deleteApnsVoipChannelRequest -
      Returns:
      A Java Future containing the result of the DeleteApnsVoipChannel 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteApnsVoipChannel

      default CompletableFuture<DeleteApnsVoipChannelResponse> deleteApnsVoipChannel(Consumer<DeleteApnsVoipChannelRequest.Builder> deleteApnsVoipChannelRequest)

      Disables the APNs VoIP channel for an application and deletes any existing settings for the channel.


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

      Parameters:
      deleteApnsVoipChannelRequest - A Consumer that will call methods on DeleteApnsVoipChannelRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteApnsVoipChannel 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteApnsVoipSandboxChannel

      default CompletableFuture<DeleteApnsVoipSandboxChannelResponse> deleteApnsVoipSandboxChannel(DeleteApnsVoipSandboxChannelRequest deleteApnsVoipSandboxChannelRequest)

      Disables the APNs VoIP sandbox channel for an application and deletes any existing settings for the channel.

      Parameters:
      deleteApnsVoipSandboxChannelRequest -
      Returns:
      A Java Future containing the result of the DeleteApnsVoipSandboxChannel 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteApnsVoipSandboxChannel

      default CompletableFuture<DeleteApnsVoipSandboxChannelResponse> deleteApnsVoipSandboxChannel(Consumer<DeleteApnsVoipSandboxChannelRequest.Builder> deleteApnsVoipSandboxChannelRequest)

      Disables the APNs VoIP sandbox channel for an application and deletes any existing settings for the channel.


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

      Parameters:
      deleteApnsVoipSandboxChannelRequest - A Consumer that will call methods on DeleteApnsVoipSandboxChannelRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteApnsVoipSandboxChannel 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteApp

      default CompletableFuture<DeleteAppResponse> deleteApp(DeleteAppRequest deleteAppRequest)

      Deletes an application.

      Parameters:
      deleteAppRequest -
      Returns:
      A Java Future containing the result of the DeleteApp 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteApp

      default CompletableFuture<DeleteAppResponse> deleteApp(Consumer<DeleteAppRequest.Builder> deleteAppRequest)

      Deletes an application.


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

      Parameters:
      deleteAppRequest - A Consumer that will call methods on DeleteAppRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteApp 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteBaiduChannel

      default CompletableFuture<DeleteBaiduChannelResponse> deleteBaiduChannel(DeleteBaiduChannelRequest deleteBaiduChannelRequest)

      Disables the Baidu channel for an application and deletes any existing settings for the channel.

      Parameters:
      deleteBaiduChannelRequest -
      Returns:
      A Java Future containing the result of the DeleteBaiduChannel 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteBaiduChannel

      default CompletableFuture<DeleteBaiduChannelResponse> deleteBaiduChannel(Consumer<DeleteBaiduChannelRequest.Builder> deleteBaiduChannelRequest)

      Disables the Baidu channel for an application and deletes any existing settings for the channel.


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

      Parameters:
      deleteBaiduChannelRequest - A Consumer that will call methods on DeleteBaiduChannelRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteBaiduChannel 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteCampaign

      default CompletableFuture<DeleteCampaignResponse> deleteCampaign(DeleteCampaignRequest deleteCampaignRequest)

      Deletes a campaign from an application.

      Parameters:
      deleteCampaignRequest -
      Returns:
      A Java Future containing the result of the DeleteCampaign 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteCampaign

      default CompletableFuture<DeleteCampaignResponse> deleteCampaign(Consumer<DeleteCampaignRequest.Builder> deleteCampaignRequest)

      Deletes a campaign from an application.


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

      Parameters:
      deleteCampaignRequest - A Consumer that will call methods on DeleteCampaignRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteCampaign 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteEmailChannel

      default CompletableFuture<DeleteEmailChannelResponse> deleteEmailChannel(DeleteEmailChannelRequest deleteEmailChannelRequest)

      Disables the email channel for an application and deletes any existing settings for the channel.

      Parameters:
      deleteEmailChannelRequest -
      Returns:
      A Java Future containing the result of the DeleteEmailChannel 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteEmailChannel

      default CompletableFuture<DeleteEmailChannelResponse> deleteEmailChannel(Consumer<DeleteEmailChannelRequest.Builder> deleteEmailChannelRequest)

      Disables the email channel for an application and deletes any existing settings for the channel.


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

      Parameters:
      deleteEmailChannelRequest - A Consumer that will call methods on DeleteEmailChannelRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteEmailChannel 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteEmailTemplate

      default CompletableFuture<DeleteEmailTemplateResponse> deleteEmailTemplate(DeleteEmailTemplateRequest deleteEmailTemplateRequest)

      Deletes a message template for messages that were sent through the email channel.

      Parameters:
      deleteEmailTemplateRequest -
      Returns:
      A Java Future containing the result of the DeleteEmailTemplate 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteEmailTemplate

      default CompletableFuture<DeleteEmailTemplateResponse> deleteEmailTemplate(Consumer<DeleteEmailTemplateRequest.Builder> deleteEmailTemplateRequest)

      Deletes a message template for messages that were sent through the email channel.


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

      Parameters:
      deleteEmailTemplateRequest - A Consumer that will call methods on DeleteEmailTemplateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteEmailTemplate 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteEndpoint

      default CompletableFuture<DeleteEndpointResponse> deleteEndpoint(DeleteEndpointRequest deleteEndpointRequest)

      Deletes an endpoint from an application.

      Parameters:
      deleteEndpointRequest -
      Returns:
      A Java Future containing the result of the DeleteEndpoint 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteEndpoint

      default CompletableFuture<DeleteEndpointResponse> deleteEndpoint(Consumer<DeleteEndpointRequest.Builder> deleteEndpointRequest)

      Deletes an endpoint from an application.


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

      Parameters:
      deleteEndpointRequest - A Consumer that will call methods on DeleteEndpointRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteEndpoint 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteEventStream

      default CompletableFuture<DeleteEventStreamResponse> deleteEventStream(DeleteEventStreamRequest deleteEventStreamRequest)

      Deletes the event stream for an application.

      Parameters:
      deleteEventStreamRequest -
      Returns:
      A Java Future containing the result of the DeleteEventStream 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteEventStream

      default CompletableFuture<DeleteEventStreamResponse> deleteEventStream(Consumer<DeleteEventStreamRequest.Builder> deleteEventStreamRequest)

      Deletes the event stream for an application.


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

      Parameters:
      deleteEventStreamRequest - A Consumer that will call methods on DeleteEventStreamRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteEventStream 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteGcmChannel

      default CompletableFuture<DeleteGcmChannelResponse> deleteGcmChannel(DeleteGcmChannelRequest deleteGcmChannelRequest)

      Disables the GCM channel for an application and deletes any existing settings for the channel.

      Parameters:
      deleteGcmChannelRequest -
      Returns:
      A Java Future containing the result of the DeleteGcmChannel 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteGcmChannel

      default CompletableFuture<DeleteGcmChannelResponse> deleteGcmChannel(Consumer<DeleteGcmChannelRequest.Builder> deleteGcmChannelRequest)

      Disables the GCM channel for an application and deletes any existing settings for the channel.


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

      Parameters:
      deleteGcmChannelRequest - A Consumer that will call methods on DeleteGcmChannelRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteGcmChannel 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteInAppTemplate

      default CompletableFuture<DeleteInAppTemplateResponse> deleteInAppTemplate(DeleteInAppTemplateRequest deleteInAppTemplateRequest)

      Deletes a message template for messages sent using the in-app message channel.

      Parameters:
      deleteInAppTemplateRequest -
      Returns:
      A Java Future containing the result of the DeleteInAppTemplate 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteInAppTemplate

      default CompletableFuture<DeleteInAppTemplateResponse> deleteInAppTemplate(Consumer<DeleteInAppTemplateRequest.Builder> deleteInAppTemplateRequest)

      Deletes a message template for messages sent using the in-app message channel.


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

      Parameters:
      deleteInAppTemplateRequest - A Consumer that will call methods on DeleteInAppTemplateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteInAppTemplate 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteJourney

      default CompletableFuture<DeleteJourneyResponse> deleteJourney(DeleteJourneyRequest deleteJourneyRequest)

      Deletes a journey from an application.

      Parameters:
      deleteJourneyRequest -
      Returns:
      A Java Future containing the result of the DeleteJourney 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteJourney

      default CompletableFuture<DeleteJourneyResponse> deleteJourney(Consumer<DeleteJourneyRequest.Builder> deleteJourneyRequest)

      Deletes a journey from an application.


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

      Parameters:
      deleteJourneyRequest - A Consumer that will call methods on DeleteJourneyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteJourney 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deletePushTemplate

      default CompletableFuture<DeletePushTemplateResponse> deletePushTemplate(DeletePushTemplateRequest deletePushTemplateRequest)

      Deletes a message template for messages that were sent through a push notification channel.

      Parameters:
      deletePushTemplateRequest -
      Returns:
      A Java Future containing the result of the DeletePushTemplate 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deletePushTemplate

      default CompletableFuture<DeletePushTemplateResponse> deletePushTemplate(Consumer<DeletePushTemplateRequest.Builder> deletePushTemplateRequest)

      Deletes a message template for messages that were sent through a push notification channel.


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

      Parameters:
      deletePushTemplateRequest - A Consumer that will call methods on DeletePushTemplateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeletePushTemplate 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteRecommenderConfiguration

      default CompletableFuture<DeleteRecommenderConfigurationResponse> deleteRecommenderConfiguration(DeleteRecommenderConfigurationRequest deleteRecommenderConfigurationRequest)

      Deletes an Amazon Pinpoint configuration for a recommender model.

      Parameters:
      deleteRecommenderConfigurationRequest -
      Returns:
      A Java Future containing the result of the DeleteRecommenderConfiguration 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteRecommenderConfiguration

      default CompletableFuture<DeleteRecommenderConfigurationResponse> deleteRecommenderConfiguration(Consumer<DeleteRecommenderConfigurationRequest.Builder> deleteRecommenderConfigurationRequest)

      Deletes an Amazon Pinpoint configuration for a recommender model.


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

      Parameters:
      deleteRecommenderConfigurationRequest - A Consumer that will call methods on DeleteRecommenderConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteRecommenderConfiguration 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteSegment

      default CompletableFuture<DeleteSegmentResponse> deleteSegment(DeleteSegmentRequest deleteSegmentRequest)

      Deletes a segment from an application.

      Parameters:
      deleteSegmentRequest -
      Returns:
      A Java Future containing the result of the DeleteSegment 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteSegment

      default CompletableFuture<DeleteSegmentResponse> deleteSegment(Consumer<DeleteSegmentRequest.Builder> deleteSegmentRequest)

      Deletes a segment from an application.


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

      Parameters:
      deleteSegmentRequest - A Consumer that will call methods on DeleteSegmentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteSegment 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteSmsChannel

      default CompletableFuture<DeleteSmsChannelResponse> deleteSmsChannel(DeleteSmsChannelRequest deleteSmsChannelRequest)

      Disables the SMS channel for an application and deletes any existing settings for the channel.

      Parameters:
      deleteSmsChannelRequest -
      Returns:
      A Java Future containing the result of the DeleteSmsChannel 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteSmsChannel

      default CompletableFuture<DeleteSmsChannelResponse> deleteSmsChannel(Consumer<DeleteSmsChannelRequest.Builder> deleteSmsChannelRequest)

      Disables the SMS channel for an application and deletes any existing settings for the channel.


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

      Parameters:
      deleteSmsChannelRequest - A Consumer that will call methods on DeleteSmsChannelRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteSmsChannel 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteSmsTemplate

      default CompletableFuture<DeleteSmsTemplateResponse> deleteSmsTemplate(DeleteSmsTemplateRequest deleteSmsTemplateRequest)

      Deletes a message template for messages that were sent through the SMS channel.

      Parameters:
      deleteSmsTemplateRequest -
      Returns:
      A Java Future containing the result of the DeleteSmsTemplate 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteSmsTemplate

      default CompletableFuture<DeleteSmsTemplateResponse> deleteSmsTemplate(Consumer<DeleteSmsTemplateRequest.Builder> deleteSmsTemplateRequest)

      Deletes a message template for messages that were sent through the SMS channel.


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

      Parameters:
      deleteSmsTemplateRequest - A Consumer that will call methods on DeleteSmsTemplateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteSmsTemplate 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteUserEndpoints

      default CompletableFuture<DeleteUserEndpointsResponse> deleteUserEndpoints(DeleteUserEndpointsRequest deleteUserEndpointsRequest)

      Deletes all the endpoints that are associated with a specific user ID.

      Parameters:
      deleteUserEndpointsRequest -
      Returns:
      A Java Future containing the result of the DeleteUserEndpoints 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteUserEndpoints

      default CompletableFuture<DeleteUserEndpointsResponse> deleteUserEndpoints(Consumer<DeleteUserEndpointsRequest.Builder> deleteUserEndpointsRequest)

      Deletes all the endpoints that are associated with a specific user ID.


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

      Parameters:
      deleteUserEndpointsRequest - A Consumer that will call methods on DeleteUserEndpointsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteUserEndpoints 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteVoiceChannel

      default CompletableFuture<DeleteVoiceChannelResponse> deleteVoiceChannel(DeleteVoiceChannelRequest deleteVoiceChannelRequest)

      Disables the voice channel for an application and deletes any existing settings for the channel.

      Parameters:
      deleteVoiceChannelRequest -
      Returns:
      A Java Future containing the result of the DeleteVoiceChannel 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteVoiceChannel

      default CompletableFuture<DeleteVoiceChannelResponse> deleteVoiceChannel(Consumer<DeleteVoiceChannelRequest.Builder> deleteVoiceChannelRequest)

      Disables the voice channel for an application and deletes any existing settings for the channel.


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

      Parameters:
      deleteVoiceChannelRequest - A Consumer that will call methods on DeleteVoiceChannelRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteVoiceChannel 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteVoiceTemplate

      default CompletableFuture<DeleteVoiceTemplateResponse> deleteVoiceTemplate(DeleteVoiceTemplateRequest deleteVoiceTemplateRequest)

      Deletes a message template for messages that were sent through the voice channel.

      Parameters:
      deleteVoiceTemplateRequest -
      Returns:
      A Java Future containing the result of the DeleteVoiceTemplate 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteVoiceTemplate

      default CompletableFuture<DeleteVoiceTemplateResponse> deleteVoiceTemplate(Consumer<DeleteVoiceTemplateRequest.Builder> deleteVoiceTemplateRequest)

      Deletes a message template for messages that were sent through the voice channel.


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

      Parameters:
      deleteVoiceTemplateRequest - A Consumer that will call methods on DeleteVoiceTemplateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteVoiceTemplate 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAdmChannel

      default CompletableFuture<GetAdmChannelResponse> getAdmChannel(GetAdmChannelRequest getAdmChannelRequest)

      Retrieves information about the status and settings of the ADM channel for an application.

      Parameters:
      getAdmChannelRequest -
      Returns:
      A Java Future containing the result of the GetAdmChannel 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAdmChannel

      default CompletableFuture<GetAdmChannelResponse> getAdmChannel(Consumer<GetAdmChannelRequest.Builder> getAdmChannelRequest)

      Retrieves information about the status and settings of the ADM channel for an application.


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

      Parameters:
      getAdmChannelRequest - A Consumer that will call methods on GetAdmChannelRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetAdmChannel 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getApnsChannel

      default CompletableFuture<GetApnsChannelResponse> getApnsChannel(GetApnsChannelRequest getApnsChannelRequest)

      Retrieves information about the status and settings of the APNs channel for an application.

      Parameters:
      getApnsChannelRequest -
      Returns:
      A Java Future containing the result of the GetApnsChannel 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getApnsChannel

      default CompletableFuture<GetApnsChannelResponse> getApnsChannel(Consumer<GetApnsChannelRequest.Builder> getApnsChannelRequest)

      Retrieves information about the status and settings of the APNs channel for an application.


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

      Parameters:
      getApnsChannelRequest - A Consumer that will call methods on GetApnsChannelRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetApnsChannel 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getApnsSandboxChannel

      default CompletableFuture<GetApnsSandboxChannelResponse> getApnsSandboxChannel(GetApnsSandboxChannelRequest getApnsSandboxChannelRequest)

      Retrieves information about the status and settings of the APNs sandbox channel for an application.

      Parameters:
      getApnsSandboxChannelRequest -
      Returns:
      A Java Future containing the result of the GetApnsSandboxChannel 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getApnsSandboxChannel

      default CompletableFuture<GetApnsSandboxChannelResponse> getApnsSandboxChannel(Consumer<GetApnsSandboxChannelRequest.Builder> getApnsSandboxChannelRequest)

      Retrieves information about the status and settings of the APNs sandbox channel for an application.


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

      Parameters:
      getApnsSandboxChannelRequest - A Consumer that will call methods on GetApnsSandboxChannelRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetApnsSandboxChannel 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getApnsVoipChannel

      default CompletableFuture<GetApnsVoipChannelResponse> getApnsVoipChannel(GetApnsVoipChannelRequest getApnsVoipChannelRequest)

      Retrieves information about the status and settings of the APNs VoIP channel for an application.

      Parameters:
      getApnsVoipChannelRequest -
      Returns:
      A Java Future containing the result of the GetApnsVoipChannel 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getApnsVoipChannel

      default CompletableFuture<GetApnsVoipChannelResponse> getApnsVoipChannel(Consumer<GetApnsVoipChannelRequest.Builder> getApnsVoipChannelRequest)

      Retrieves information about the status and settings of the APNs VoIP channel for an application.


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

      Parameters:
      getApnsVoipChannelRequest - A Consumer that will call methods on GetApnsVoipChannelRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetApnsVoipChannel 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getApnsVoipSandboxChannel

      default CompletableFuture<GetApnsVoipSandboxChannelResponse> getApnsVoipSandboxChannel(GetApnsVoipSandboxChannelRequest getApnsVoipSandboxChannelRequest)

      Retrieves information about the status and settings of the APNs VoIP sandbox channel for an application.

      Parameters:
      getApnsVoipSandboxChannelRequest -
      Returns:
      A Java Future containing the result of the GetApnsVoipSandboxChannel 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getApnsVoipSandboxChannel

      default CompletableFuture<GetApnsVoipSandboxChannelResponse> getApnsVoipSandboxChannel(Consumer<GetApnsVoipSandboxChannelRequest.Builder> getApnsVoipSandboxChannelRequest)

      Retrieves information about the status and settings of the APNs VoIP sandbox channel for an application.


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

      Parameters:
      getApnsVoipSandboxChannelRequest - A Consumer that will call methods on GetApnsVoipSandboxChannelRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetApnsVoipSandboxChannel 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getApp

      default CompletableFuture<GetAppResponse> getApp(GetAppRequest getAppRequest)

      Retrieves information about an application.

      Parameters:
      getAppRequest -
      Returns:
      A Java Future containing the result of the GetApp 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getApp

      default CompletableFuture<GetAppResponse> getApp(Consumer<GetAppRequest.Builder> getAppRequest)

      Retrieves information about an application.


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

      Parameters:
      getAppRequest - A Consumer that will call methods on GetAppRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetApp 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getApplicationDateRangeKpi

      default CompletableFuture<GetApplicationDateRangeKpiResponse> getApplicationDateRangeKpi(GetApplicationDateRangeKpiRequest getApplicationDateRangeKpiRequest)

      Retrieves (queries) pre-aggregated data for a standard metric that applies to an application.

      Parameters:
      getApplicationDateRangeKpiRequest -
      Returns:
      A Java Future containing the result of the GetApplicationDateRangeKpi 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getApplicationDateRangeKpi

      default CompletableFuture<GetApplicationDateRangeKpiResponse> getApplicationDateRangeKpi(Consumer<GetApplicationDateRangeKpiRequest.Builder> getApplicationDateRangeKpiRequest)

      Retrieves (queries) pre-aggregated data for a standard metric that applies to an application.


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

      Parameters:
      getApplicationDateRangeKpiRequest - A Consumer that will call methods on GetApplicationDateRangeKpiRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetApplicationDateRangeKpi 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getApplicationSettings

      default CompletableFuture<GetApplicationSettingsResponse> getApplicationSettings(GetApplicationSettingsRequest getApplicationSettingsRequest)

      Retrieves information about the settings for an application.

      Parameters:
      getApplicationSettingsRequest -
      Returns:
      A Java Future containing the result of the GetApplicationSettings 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getApplicationSettings

      default CompletableFuture<GetApplicationSettingsResponse> getApplicationSettings(Consumer<GetApplicationSettingsRequest.Builder> getApplicationSettingsRequest)

      Retrieves information about the settings for an application.


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

      Parameters:
      getApplicationSettingsRequest - A Consumer that will call methods on GetApplicationSettingsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetApplicationSettings 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getApps

      default CompletableFuture<GetAppsResponse> getApps(GetAppsRequest getAppsRequest)

      Retrieves information about all the applications that are associated with your Amazon Pinpoint account.

      Parameters:
      getAppsRequest -
      Returns:
      A Java Future containing the result of the GetApps 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getApps

      default CompletableFuture<GetAppsResponse> getApps(Consumer<GetAppsRequest.Builder> getAppsRequest)

      Retrieves information about all the applications that are associated with your Amazon Pinpoint account.


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

      Parameters:
      getAppsRequest - A Consumer that will call methods on GetAppsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetApps 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getBaiduChannel

      default CompletableFuture<GetBaiduChannelResponse> getBaiduChannel(GetBaiduChannelRequest getBaiduChannelRequest)

      Retrieves information about the status and settings of the Baidu channel for an application.

      Parameters:
      getBaiduChannelRequest -
      Returns:
      A Java Future containing the result of the GetBaiduChannel 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getBaiduChannel

      default CompletableFuture<GetBaiduChannelResponse> getBaiduChannel(Consumer<GetBaiduChannelRequest.Builder> getBaiduChannelRequest)

      Retrieves information about the status and settings of the Baidu channel for an application.


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

      Parameters:
      getBaiduChannelRequest - A Consumer that will call methods on GetBaiduChannelRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetBaiduChannel 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getCampaign

      default CompletableFuture<GetCampaignResponse> getCampaign(GetCampaignRequest getCampaignRequest)

      Retrieves information about the status, configuration, and other settings for a campaign.

      Parameters:
      getCampaignRequest -
      Returns:
      A Java Future containing the result of the GetCampaign 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getCampaign

      default CompletableFuture<GetCampaignResponse> getCampaign(Consumer<GetCampaignRequest.Builder> getCampaignRequest)

      Retrieves information about the status, configuration, and other settings for a campaign.


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

      Parameters:
      getCampaignRequest - A Consumer that will call methods on GetCampaignRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetCampaign 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getCampaignActivities

      default CompletableFuture<GetCampaignActivitiesResponse> getCampaignActivities(GetCampaignActivitiesRequest getCampaignActivitiesRequest)

      Retrieves information about all the activities for a campaign.

      Parameters:
      getCampaignActivitiesRequest -
      Returns:
      A Java Future containing the result of the GetCampaignActivities 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getCampaignActivities

      default CompletableFuture<GetCampaignActivitiesResponse> getCampaignActivities(Consumer<GetCampaignActivitiesRequest.Builder> getCampaignActivitiesRequest)

      Retrieves information about all the activities for a campaign.


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

      Parameters:
      getCampaignActivitiesRequest - A Consumer that will call methods on GetCampaignActivitiesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetCampaignActivities 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getCampaignDateRangeKpi

      default CompletableFuture<GetCampaignDateRangeKpiResponse> getCampaignDateRangeKpi(GetCampaignDateRangeKpiRequest getCampaignDateRangeKpiRequest)

      Retrieves (queries) pre-aggregated data for a standard metric that applies to a campaign.

      Parameters:
      getCampaignDateRangeKpiRequest -
      Returns:
      A Java Future containing the result of the GetCampaignDateRangeKpi 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getCampaignDateRangeKpi

      default CompletableFuture<GetCampaignDateRangeKpiResponse> getCampaignDateRangeKpi(Consumer<GetCampaignDateRangeKpiRequest.Builder> getCampaignDateRangeKpiRequest)

      Retrieves (queries) pre-aggregated data for a standard metric that applies to a campaign.


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

      Parameters:
      getCampaignDateRangeKpiRequest - A Consumer that will call methods on GetCampaignDateRangeKpiRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetCampaignDateRangeKpi 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getCampaignVersion

      default CompletableFuture<GetCampaignVersionResponse> getCampaignVersion(GetCampaignVersionRequest getCampaignVersionRequest)

      Retrieves information about the status, configuration, and other settings for a specific version of a campaign.

      Parameters:
      getCampaignVersionRequest -
      Returns:
      A Java Future containing the result of the GetCampaignVersion 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getCampaignVersion

      default CompletableFuture<GetCampaignVersionResponse> getCampaignVersion(Consumer<GetCampaignVersionRequest.Builder> getCampaignVersionRequest)

      Retrieves information about the status, configuration, and other settings for a specific version of a campaign.


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

      Parameters:
      getCampaignVersionRequest - A Consumer that will call methods on GetCampaignVersionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetCampaignVersion 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getCampaignVersions

      default CompletableFuture<GetCampaignVersionsResponse> getCampaignVersions(GetCampaignVersionsRequest getCampaignVersionsRequest)

      Retrieves information about the status, configuration, and other settings for all versions of a campaign.

      Parameters:
      getCampaignVersionsRequest -
      Returns:
      A Java Future containing the result of the GetCampaignVersions 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getCampaignVersions

      default CompletableFuture<GetCampaignVersionsResponse> getCampaignVersions(Consumer<GetCampaignVersionsRequest.Builder> getCampaignVersionsRequest)

      Retrieves information about the status, configuration, and other settings for all versions of a campaign.


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

      Parameters:
      getCampaignVersionsRequest - A Consumer that will call methods on GetCampaignVersionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetCampaignVersions 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getCampaigns

      default CompletableFuture<GetCampaignsResponse> getCampaigns(GetCampaignsRequest getCampaignsRequest)

      Retrieves information about the status, configuration, and other settings for all the campaigns that are associated with an application.

      Parameters:
      getCampaignsRequest -
      Returns:
      A Java Future containing the result of the GetCampaigns 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getCampaigns

      default CompletableFuture<GetCampaignsResponse> getCampaigns(Consumer<GetCampaignsRequest.Builder> getCampaignsRequest)

      Retrieves information about the status, configuration, and other settings for all the campaigns that are associated with an application.


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

      Parameters:
      getCampaignsRequest - A Consumer that will call methods on GetCampaignsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetCampaigns 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getChannels

      default CompletableFuture<GetChannelsResponse> getChannels(GetChannelsRequest getChannelsRequest)

      Retrieves information about the history and status of each channel for an application.

      Parameters:
      getChannelsRequest -
      Returns:
      A Java Future containing the result of the GetChannels 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getChannels

      default CompletableFuture<GetChannelsResponse> getChannels(Consumer<GetChannelsRequest.Builder> getChannelsRequest)

      Retrieves information about the history and status of each channel for an application.


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

      Parameters:
      getChannelsRequest - A Consumer that will call methods on GetChannelsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetChannels 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getEmailChannel

      default CompletableFuture<GetEmailChannelResponse> getEmailChannel(GetEmailChannelRequest getEmailChannelRequest)

      Retrieves information about the status and settings of the email channel for an application.

      Parameters:
      getEmailChannelRequest -
      Returns:
      A Java Future containing the result of the GetEmailChannel 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getEmailChannel

      default CompletableFuture<GetEmailChannelResponse> getEmailChannel(Consumer<GetEmailChannelRequest.Builder> getEmailChannelRequest)

      Retrieves information about the status and settings of the email channel for an application.


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

      Parameters:
      getEmailChannelRequest - A Consumer that will call methods on GetEmailChannelRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetEmailChannel 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getEmailTemplate

      default CompletableFuture<GetEmailTemplateResponse> getEmailTemplate(GetEmailTemplateRequest getEmailTemplateRequest)

      Retrieves the content and settings of a message template for messages that are sent through the email channel.

      Parameters:
      getEmailTemplateRequest -
      Returns:
      A Java Future containing the result of the GetEmailTemplate 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getEmailTemplate

      default CompletableFuture<GetEmailTemplateResponse> getEmailTemplate(Consumer<GetEmailTemplateRequest.Builder> getEmailTemplateRequest)

      Retrieves the content and settings of a message template for messages that are sent through the email channel.


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

      Parameters:
      getEmailTemplateRequest - A Consumer that will call methods on GetEmailTemplateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetEmailTemplate 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getEndpoint

      default CompletableFuture<GetEndpointResponse> getEndpoint(GetEndpointRequest getEndpointRequest)

      Retrieves information about the settings and attributes of a specific endpoint for an application.

      Parameters:
      getEndpointRequest -
      Returns:
      A Java Future containing the result of the GetEndpoint 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getEndpoint

      default CompletableFuture<GetEndpointResponse> getEndpoint(Consumer<GetEndpointRequest.Builder> getEndpointRequest)

      Retrieves information about the settings and attributes of a specific endpoint for an application.


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

      Parameters:
      getEndpointRequest - A Consumer that will call methods on GetEndpointRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetEndpoint 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getEventStream

      default CompletableFuture<GetEventStreamResponse> getEventStream(GetEventStreamRequest getEventStreamRequest)

      Retrieves information about the event stream settings for an application.

      Parameters:
      getEventStreamRequest -
      Returns:
      A Java Future containing the result of the GetEventStream 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getEventStream

      default CompletableFuture<GetEventStreamResponse> getEventStream(Consumer<GetEventStreamRequest.Builder> getEventStreamRequest)

      Retrieves information about the event stream settings for an application.


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

      Parameters:
      getEventStreamRequest - A Consumer that will call methods on GetEventStreamRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetEventStream 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getExportJob

      default CompletableFuture<GetExportJobResponse> getExportJob(GetExportJobRequest getExportJobRequest)

      Retrieves information about the status and settings of a specific export job for an application.

      Parameters:
      getExportJobRequest -
      Returns:
      A Java Future containing the result of the GetExportJob 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getExportJob

      default CompletableFuture<GetExportJobResponse> getExportJob(Consumer<GetExportJobRequest.Builder> getExportJobRequest)

      Retrieves information about the status and settings of a specific export job for an application.


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

      Parameters:
      getExportJobRequest - A Consumer that will call methods on GetExportJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetExportJob 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getExportJobs

      default CompletableFuture<GetExportJobsResponse> getExportJobs(GetExportJobsRequest getExportJobsRequest)

      Retrieves information about the status and settings of all the export jobs for an application.

      Parameters:
      getExportJobsRequest -
      Returns:
      A Java Future containing the result of the GetExportJobs 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getExportJobs

      default CompletableFuture<GetExportJobsResponse> getExportJobs(Consumer<GetExportJobsRequest.Builder> getExportJobsRequest)

      Retrieves information about the status and settings of all the export jobs for an application.


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

      Parameters:
      getExportJobsRequest - A Consumer that will call methods on GetExportJobsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetExportJobs 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getGcmChannel

      default CompletableFuture<GetGcmChannelResponse> getGcmChannel(GetGcmChannelRequest getGcmChannelRequest)

      Retrieves information about the status and settings of the GCM channel for an application.

      Parameters:
      getGcmChannelRequest -
      Returns:
      A Java Future containing the result of the GetGcmChannel 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getGcmChannel

      default CompletableFuture<GetGcmChannelResponse> getGcmChannel(Consumer<GetGcmChannelRequest.Builder> getGcmChannelRequest)

      Retrieves information about the status and settings of the GCM channel for an application.


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

      Parameters:
      getGcmChannelRequest - A Consumer that will call methods on GetGcmChannelRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetGcmChannel 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getImportJob

      default CompletableFuture<GetImportJobResponse> getImportJob(GetImportJobRequest getImportJobRequest)

      Retrieves information about the status and settings of a specific import job for an application.

      Parameters:
      getImportJobRequest -
      Returns:
      A Java Future containing the result of the GetImportJob 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getImportJob

      default CompletableFuture<GetImportJobResponse> getImportJob(Consumer<GetImportJobRequest.Builder> getImportJobRequest)

      Retrieves information about the status and settings of a specific import job for an application.


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

      Parameters:
      getImportJobRequest - A Consumer that will call methods on GetImportJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetImportJob 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getImportJobs

      default CompletableFuture<GetImportJobsResponse> getImportJobs(GetImportJobsRequest getImportJobsRequest)

      Retrieves information about the status and settings of all the import jobs for an application.

      Parameters:
      getImportJobsRequest -
      Returns:
      A Java Future containing the result of the GetImportJobs 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getImportJobs

      default CompletableFuture<GetImportJobsResponse> getImportJobs(Consumer<GetImportJobsRequest.Builder> getImportJobsRequest)

      Retrieves information about the status and settings of all the import jobs for an application.


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

      Parameters:
      getImportJobsRequest - A Consumer that will call methods on GetImportJobsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetImportJobs 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getInAppMessages

      default CompletableFuture<GetInAppMessagesResponse> getInAppMessages(GetInAppMessagesRequest getInAppMessagesRequest)

      Retrieves the in-app messages targeted for the provided endpoint ID.

      Parameters:
      getInAppMessagesRequest -
      Returns:
      A Java Future containing the result of the GetInAppMessages 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getInAppMessages

      default CompletableFuture<GetInAppMessagesResponse> getInAppMessages(Consumer<GetInAppMessagesRequest.Builder> getInAppMessagesRequest)

      Retrieves the in-app messages targeted for the provided endpoint ID.


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

      Parameters:
      getInAppMessagesRequest - A Consumer that will call methods on GetInAppMessagesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetInAppMessages 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getInAppTemplate

      default CompletableFuture<GetInAppTemplateResponse> getInAppTemplate(GetInAppTemplateRequest getInAppTemplateRequest)

      Retrieves the content and settings of a message template for messages sent through the in-app channel.

      Parameters:
      getInAppTemplateRequest -
      Returns:
      A Java Future containing the result of the GetInAppTemplate 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getInAppTemplate

      default CompletableFuture<GetInAppTemplateResponse> getInAppTemplate(Consumer<GetInAppTemplateRequest.Builder> getInAppTemplateRequest)

      Retrieves the content and settings of a message template for messages sent through the in-app channel.


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

      Parameters:
      getInAppTemplateRequest - A Consumer that will call methods on GetInAppTemplateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetInAppTemplate 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getJourney

      default CompletableFuture<GetJourneyResponse> getJourney(GetJourneyRequest getJourneyRequest)

      Retrieves information about the status, configuration, and other settings for a journey.

      Parameters:
      getJourneyRequest -
      Returns:
      A Java Future containing the result of the GetJourney 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getJourney

      default CompletableFuture<GetJourneyResponse> getJourney(Consumer<GetJourneyRequest.Builder> getJourneyRequest)

      Retrieves information about the status, configuration, and other settings for a journey.


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

      Parameters:
      getJourneyRequest - A Consumer that will call methods on GetJourneyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetJourney 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getJourneyDateRangeKpi

      default CompletableFuture<GetJourneyDateRangeKpiResponse> getJourneyDateRangeKpi(GetJourneyDateRangeKpiRequest getJourneyDateRangeKpiRequest)

      Retrieves (queries) pre-aggregated data for a standard engagement metric that applies to a journey.

      Parameters:
      getJourneyDateRangeKpiRequest -
      Returns:
      A Java Future containing the result of the GetJourneyDateRangeKpi 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getJourneyDateRangeKpi

      default CompletableFuture<GetJourneyDateRangeKpiResponse> getJourneyDateRangeKpi(Consumer<GetJourneyDateRangeKpiRequest.Builder> getJourneyDateRangeKpiRequest)

      Retrieves (queries) pre-aggregated data for a standard engagement metric that applies to a journey.


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

      Parameters:
      getJourneyDateRangeKpiRequest - A Consumer that will call methods on GetJourneyDateRangeKpiRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetJourneyDateRangeKpi 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getJourneyExecutionActivityMetrics

      default CompletableFuture<GetJourneyExecutionActivityMetricsResponse> getJourneyExecutionActivityMetrics(GetJourneyExecutionActivityMetricsRequest getJourneyExecutionActivityMetricsRequest)

      Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey activity.

      Parameters:
      getJourneyExecutionActivityMetricsRequest -
      Returns:
      A Java Future containing the result of the GetJourneyExecutionActivityMetrics 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getJourneyExecutionActivityMetrics

      default CompletableFuture<GetJourneyExecutionActivityMetricsResponse> getJourneyExecutionActivityMetrics(Consumer<GetJourneyExecutionActivityMetricsRequest.Builder> getJourneyExecutionActivityMetricsRequest)

      Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey activity.


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

      Parameters:
      getJourneyExecutionActivityMetricsRequest - A Consumer that will call methods on GetJourneyExecutionActivityMetricsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetJourneyExecutionActivityMetrics 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getJourneyExecutionMetrics

      default CompletableFuture<GetJourneyExecutionMetricsResponse> getJourneyExecutionMetrics(GetJourneyExecutionMetricsRequest getJourneyExecutionMetricsRequest)

      Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey.

      Parameters:
      getJourneyExecutionMetricsRequest -
      Returns:
      A Java Future containing the result of the GetJourneyExecutionMetrics 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getJourneyExecutionMetrics

      default CompletableFuture<GetJourneyExecutionMetricsResponse> getJourneyExecutionMetrics(Consumer<GetJourneyExecutionMetricsRequest.Builder> getJourneyExecutionMetricsRequest)

      Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey.


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

      Parameters:
      getJourneyExecutionMetricsRequest - A Consumer that will call methods on GetJourneyExecutionMetricsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetJourneyExecutionMetrics 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getJourneyRunExecutionActivityMetrics

      default CompletableFuture<GetJourneyRunExecutionActivityMetricsResponse> getJourneyRunExecutionActivityMetrics(GetJourneyRunExecutionActivityMetricsRequest getJourneyRunExecutionActivityMetricsRequest)

      Retrieves (queries) pre-aggregated data for a standard run execution metric that applies to a journey activity.

      Parameters:
      getJourneyRunExecutionActivityMetricsRequest -
      Returns:
      A Java Future containing the result of the GetJourneyRunExecutionActivityMetrics 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getJourneyRunExecutionActivityMetrics

      default CompletableFuture<GetJourneyRunExecutionActivityMetricsResponse> getJourneyRunExecutionActivityMetrics(Consumer<GetJourneyRunExecutionActivityMetricsRequest.Builder> getJourneyRunExecutionActivityMetricsRequest)

      Retrieves (queries) pre-aggregated data for a standard run execution metric that applies to a journey activity.


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

      Parameters:
      getJourneyRunExecutionActivityMetricsRequest - A Consumer that will call methods on GetJourneyRunExecutionActivityMetricsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetJourneyRunExecutionActivityMetrics 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getJourneyRunExecutionMetrics

      default CompletableFuture<GetJourneyRunExecutionMetricsResponse> getJourneyRunExecutionMetrics(GetJourneyRunExecutionMetricsRequest getJourneyRunExecutionMetricsRequest)

      Retrieves (queries) pre-aggregated data for a standard run execution metric that applies to a journey.

      Parameters:
      getJourneyRunExecutionMetricsRequest -
      Returns:
      A Java Future containing the result of the GetJourneyRunExecutionMetrics 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getJourneyRunExecutionMetrics

      default CompletableFuture<GetJourneyRunExecutionMetricsResponse> getJourneyRunExecutionMetrics(Consumer<GetJourneyRunExecutionMetricsRequest.Builder> getJourneyRunExecutionMetricsRequest)

      Retrieves (queries) pre-aggregated data for a standard run execution metric that applies to a journey.


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

      Parameters:
      getJourneyRunExecutionMetricsRequest - A Consumer that will call methods on GetJourneyRunExecutionMetricsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetJourneyRunExecutionMetrics 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getJourneyRuns

      default CompletableFuture<GetJourneyRunsResponse> getJourneyRuns(GetJourneyRunsRequest getJourneyRunsRequest)

      Provides information about the runs of a journey.

      Parameters:
      getJourneyRunsRequest -
      Returns:
      A Java Future containing the result of the GetJourneyRuns 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getJourneyRuns

      default CompletableFuture<GetJourneyRunsResponse> getJourneyRuns(Consumer<GetJourneyRunsRequest.Builder> getJourneyRunsRequest)

      Provides information about the runs of a journey.


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

      Parameters:
      getJourneyRunsRequest - A Consumer that will call methods on GetJourneyRunsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetJourneyRuns 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getPushTemplate

      default CompletableFuture<GetPushTemplateResponse> getPushTemplate(GetPushTemplateRequest getPushTemplateRequest)

      Retrieves the content and settings of a message template for messages that are sent through a push notification channel.

      Parameters:
      getPushTemplateRequest -
      Returns:
      A Java Future containing the result of the GetPushTemplate 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getPushTemplate

      default CompletableFuture<GetPushTemplateResponse> getPushTemplate(Consumer<GetPushTemplateRequest.Builder> getPushTemplateRequest)

      Retrieves the content and settings of a message template for messages that are sent through a push notification channel.


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

      Parameters:
      getPushTemplateRequest - A Consumer that will call methods on GetPushTemplateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetPushTemplate 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getRecommenderConfiguration

      default CompletableFuture<GetRecommenderConfigurationResponse> getRecommenderConfiguration(GetRecommenderConfigurationRequest getRecommenderConfigurationRequest)

      Retrieves information about an Amazon Pinpoint configuration for a recommender model.

      Parameters:
      getRecommenderConfigurationRequest -
      Returns:
      A Java Future containing the result of the GetRecommenderConfiguration 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getRecommenderConfiguration

      default CompletableFuture<GetRecommenderConfigurationResponse> getRecommenderConfiguration(Consumer<GetRecommenderConfigurationRequest.Builder> getRecommenderConfigurationRequest)

      Retrieves information about an Amazon Pinpoint configuration for a recommender model.


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

      Parameters:
      getRecommenderConfigurationRequest - A Consumer that will call methods on GetRecommenderConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetRecommenderConfiguration 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getRecommenderConfigurations

      default CompletableFuture<GetRecommenderConfigurationsResponse> getRecommenderConfigurations(GetRecommenderConfigurationsRequest getRecommenderConfigurationsRequest)

      Retrieves information about all the recommender model configurations that are associated with your Amazon Pinpoint account.

      Parameters:
      getRecommenderConfigurationsRequest -
      Returns:
      A Java Future containing the result of the GetRecommenderConfigurations 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getRecommenderConfigurations

      default CompletableFuture<GetRecommenderConfigurationsResponse> getRecommenderConfigurations(Consumer<GetRecommenderConfigurationsRequest.Builder> getRecommenderConfigurationsRequest)

      Retrieves information about all the recommender model configurations that are associated with your Amazon Pinpoint account.


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

      Parameters:
      getRecommenderConfigurationsRequest - A Consumer that will call methods on GetRecommenderConfigurationsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetRecommenderConfigurations 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSegment

      default CompletableFuture<GetSegmentResponse> getSegment(GetSegmentRequest getSegmentRequest)

      Retrieves information about the configuration, dimension, and other settings for a specific segment that's associated with an application.

      Parameters:
      getSegmentRequest -
      Returns:
      A Java Future containing the result of the GetSegment 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSegment

      default CompletableFuture<GetSegmentResponse> getSegment(Consumer<GetSegmentRequest.Builder> getSegmentRequest)

      Retrieves information about the configuration, dimension, and other settings for a specific segment that's associated with an application.


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

      Parameters:
      getSegmentRequest - A Consumer that will call methods on GetSegmentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetSegment 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSegmentExportJobs

      default CompletableFuture<GetSegmentExportJobsResponse> getSegmentExportJobs(GetSegmentExportJobsRequest getSegmentExportJobsRequest)

      Retrieves information about the status and settings of the export jobs for a segment.

      Parameters:
      getSegmentExportJobsRequest -
      Returns:
      A Java Future containing the result of the GetSegmentExportJobs 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSegmentExportJobs

      default CompletableFuture<GetSegmentExportJobsResponse> getSegmentExportJobs(Consumer<GetSegmentExportJobsRequest.Builder> getSegmentExportJobsRequest)

      Retrieves information about the status and settings of the export jobs for a segment.


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

      Parameters:
      getSegmentExportJobsRequest - A Consumer that will call methods on GetSegmentExportJobsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetSegmentExportJobs 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSegmentImportJobs

      default CompletableFuture<GetSegmentImportJobsResponse> getSegmentImportJobs(GetSegmentImportJobsRequest getSegmentImportJobsRequest)

      Retrieves information about the status and settings of the import jobs for a segment.

      Parameters:
      getSegmentImportJobsRequest -
      Returns:
      A Java Future containing the result of the GetSegmentImportJobs 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSegmentImportJobs

      default CompletableFuture<GetSegmentImportJobsResponse> getSegmentImportJobs(Consumer<GetSegmentImportJobsRequest.Builder> getSegmentImportJobsRequest)

      Retrieves information about the status and settings of the import jobs for a segment.


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

      Parameters:
      getSegmentImportJobsRequest - A Consumer that will call methods on GetSegmentImportJobsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetSegmentImportJobs 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSegmentVersion

      default CompletableFuture<GetSegmentVersionResponse> getSegmentVersion(GetSegmentVersionRequest getSegmentVersionRequest)

      Retrieves information about the configuration, dimension, and other settings for a specific version of a segment that's associated with an application.

      Parameters:
      getSegmentVersionRequest -
      Returns:
      A Java Future containing the result of the GetSegmentVersion 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSegmentVersion

      default CompletableFuture<GetSegmentVersionResponse> getSegmentVersion(Consumer<GetSegmentVersionRequest.Builder> getSegmentVersionRequest)

      Retrieves information about the configuration, dimension, and other settings for a specific version of a segment that's associated with an application.


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

      Parameters:
      getSegmentVersionRequest - A Consumer that will call methods on GetSegmentVersionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetSegmentVersion 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSegmentVersions

      default CompletableFuture<GetSegmentVersionsResponse> getSegmentVersions(GetSegmentVersionsRequest getSegmentVersionsRequest)

      Retrieves information about the configuration, dimension, and other settings for all the versions of a specific segment that's associated with an application.

      Parameters:
      getSegmentVersionsRequest -
      Returns:
      A Java Future containing the result of the GetSegmentVersions 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSegmentVersions

      default CompletableFuture<GetSegmentVersionsResponse> getSegmentVersions(Consumer<GetSegmentVersionsRequest.Builder> getSegmentVersionsRequest)

      Retrieves information about the configuration, dimension, and other settings for all the versions of a specific segment that's associated with an application.


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

      Parameters:
      getSegmentVersionsRequest - A Consumer that will call methods on GetSegmentVersionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetSegmentVersions 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSegments

      default CompletableFuture<GetSegmentsResponse> getSegments(GetSegmentsRequest getSegmentsRequest)

      Retrieves information about the configuration, dimension, and other settings for all the segments that are associated with an application.

      Parameters:
      getSegmentsRequest -
      Returns:
      A Java Future containing the result of the GetSegments 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSegments

      default CompletableFuture<GetSegmentsResponse> getSegments(Consumer<GetSegmentsRequest.Builder> getSegmentsRequest)

      Retrieves information about the configuration, dimension, and other settings for all the segments that are associated with an application.


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

      Parameters:
      getSegmentsRequest - A Consumer that will call methods on GetSegmentsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetSegments 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSmsChannel

      default CompletableFuture<GetSmsChannelResponse> getSmsChannel(GetSmsChannelRequest getSmsChannelRequest)

      Retrieves information about the status and settings of the SMS channel for an application.

      Parameters:
      getSmsChannelRequest -
      Returns:
      A Java Future containing the result of the GetSmsChannel 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSmsChannel

      default CompletableFuture<GetSmsChannelResponse> getSmsChannel(Consumer<GetSmsChannelRequest.Builder> getSmsChannelRequest)

      Retrieves information about the status and settings of the SMS channel for an application.


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

      Parameters:
      getSmsChannelRequest - A Consumer that will call methods on GetSmsChannelRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetSmsChannel 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSmsTemplate

      default CompletableFuture<GetSmsTemplateResponse> getSmsTemplate(GetSmsTemplateRequest getSmsTemplateRequest)

      Retrieves the content and settings of a message template for messages that are sent through the SMS channel.

      Parameters:
      getSmsTemplateRequest -
      Returns:
      A Java Future containing the result of the GetSmsTemplate 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSmsTemplate

      default CompletableFuture<GetSmsTemplateResponse> getSmsTemplate(Consumer<GetSmsTemplateRequest.Builder> getSmsTemplateRequest)

      Retrieves the content and settings of a message template for messages that are sent through the SMS channel.


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

      Parameters:
      getSmsTemplateRequest - A Consumer that will call methods on GetSmsTemplateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetSmsTemplate 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getUserEndpoints

      default CompletableFuture<GetUserEndpointsResponse> getUserEndpoints(GetUserEndpointsRequest getUserEndpointsRequest)

      Retrieves information about all the endpoints that are associated with a specific user ID.

      Parameters:
      getUserEndpointsRequest -
      Returns:
      A Java Future containing the result of the GetUserEndpoints 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getUserEndpoints

      default CompletableFuture<GetUserEndpointsResponse> getUserEndpoints(Consumer<GetUserEndpointsRequest.Builder> getUserEndpointsRequest)

      Retrieves information about all the endpoints that are associated with a specific user ID.


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

      Parameters:
      getUserEndpointsRequest - A Consumer that will call methods on GetUserEndpointsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetUserEndpoints 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getVoiceChannel

      default CompletableFuture<GetVoiceChannelResponse> getVoiceChannel(GetVoiceChannelRequest getVoiceChannelRequest)

      Retrieves information about the status and settings of the voice channel for an application.

      Parameters:
      getVoiceChannelRequest -
      Returns:
      A Java Future containing the result of the GetVoiceChannel 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getVoiceChannel

      default CompletableFuture<GetVoiceChannelResponse> getVoiceChannel(Consumer<GetVoiceChannelRequest.Builder> getVoiceChannelRequest)

      Retrieves information about the status and settings of the voice channel for an application.


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

      Parameters:
      getVoiceChannelRequest - A Consumer that will call methods on GetVoiceChannelRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetVoiceChannel 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getVoiceTemplate

      default CompletableFuture<GetVoiceTemplateResponse> getVoiceTemplate(GetVoiceTemplateRequest getVoiceTemplateRequest)

      Retrieves the content and settings of a message template for messages that are sent through the voice channel.

      Parameters:
      getVoiceTemplateRequest -
      Returns:
      A Java Future containing the result of the GetVoiceTemplate 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getVoiceTemplate

      default CompletableFuture<GetVoiceTemplateResponse> getVoiceTemplate(Consumer<GetVoiceTemplateRequest.Builder> getVoiceTemplateRequest)

      Retrieves the content and settings of a message template for messages that are sent through the voice channel.


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

      Parameters:
      getVoiceTemplateRequest - A Consumer that will call methods on GetVoiceTemplateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetVoiceTemplate 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listJourneys

      default CompletableFuture<ListJourneysResponse> listJourneys(ListJourneysRequest listJourneysRequest)

      Retrieves information about the status, configuration, and other settings for all the journeys that are associated with an application.

      Parameters:
      listJourneysRequest -
      Returns:
      A Java Future containing the result of the ListJourneys 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listJourneys

      default CompletableFuture<ListJourneysResponse> listJourneys(Consumer<ListJourneysRequest.Builder> listJourneysRequest)

      Retrieves information about the status, configuration, and other settings for all the journeys that are associated with an application.


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

      Parameters:
      listJourneysRequest - A Consumer that will call methods on ListJourneysRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListJourneys 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException 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 all the tags (keys and values) that are associated with an application, campaign, message template, or segment.

      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.
      • 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.
      • PinpointException 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 all the tags (keys and values) that are associated with an application, campaign, message template, or segment.


      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.
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTemplateVersions

      default CompletableFuture<ListTemplateVersionsResponse> listTemplateVersions(ListTemplateVersionsRequest listTemplateVersionsRequest)

      Retrieves information about all the versions of a specific message template.

      Parameters:
      listTemplateVersionsRequest -
      Returns:
      A Java Future containing the result of the ListTemplateVersions 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTemplateVersions

      default CompletableFuture<ListTemplateVersionsResponse> listTemplateVersions(Consumer<ListTemplateVersionsRequest.Builder> listTemplateVersionsRequest)

      Retrieves information about all the versions of a specific message template.


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

      Parameters:
      listTemplateVersionsRequest - A Consumer that will call methods on ListTemplateVersionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListTemplateVersions 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTemplates

      default CompletableFuture<ListTemplatesResponse> listTemplates(ListTemplatesRequest listTemplatesRequest)

      Retrieves information about all the message templates that are associated with your Amazon Pinpoint account.

      Parameters:
      listTemplatesRequest -
      Returns:
      A Java Future containing the result of the ListTemplates 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.
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTemplates

      default CompletableFuture<ListTemplatesResponse> listTemplates(Consumer<ListTemplatesRequest.Builder> listTemplatesRequest)

      Retrieves information about all the message templates that are associated with your Amazon Pinpoint account.


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

      Parameters:
      listTemplatesRequest - A Consumer that will call methods on ListTemplatesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListTemplates 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.
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • phoneNumberValidate

      default CompletableFuture<PhoneNumberValidateResponse> phoneNumberValidate(PhoneNumberValidateRequest phoneNumberValidateRequest)

      Retrieves information about a phone number.

      Parameters:
      phoneNumberValidateRequest -
      Returns:
      A Java Future containing the result of the PhoneNumberValidate 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • phoneNumberValidate

      default CompletableFuture<PhoneNumberValidateResponse> phoneNumberValidate(Consumer<PhoneNumberValidateRequest.Builder> phoneNumberValidateRequest)

      Retrieves information about a phone number.


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

      Parameters:
      phoneNumberValidateRequest - A Consumer that will call methods on PhoneNumberValidateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PhoneNumberValidate 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putEventStream

      default CompletableFuture<PutEventStreamResponse> putEventStream(PutEventStreamRequest putEventStreamRequest)

      Creates a new event stream for an application or updates the settings of an existing event stream for an application.

      Parameters:
      putEventStreamRequest -
      Returns:
      A Java Future containing the result of the PutEventStream 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putEventStream

      default CompletableFuture<PutEventStreamResponse> putEventStream(Consumer<PutEventStreamRequest.Builder> putEventStreamRequest)

      Creates a new event stream for an application or updates the settings of an existing event stream for an application.


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

      Parameters:
      putEventStreamRequest - A Consumer that will call methods on PutEventStreamRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutEventStream 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putEvents

      default CompletableFuture<PutEventsResponse> putEvents(PutEventsRequest putEventsRequest)

      Creates a new event to record for endpoints, or creates or updates endpoint data that existing events are associated with.

      Parameters:
      putEventsRequest -
      Returns:
      A Java Future containing the result of the PutEvents 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putEvents

      default CompletableFuture<PutEventsResponse> putEvents(Consumer<PutEventsRequest.Builder> putEventsRequest)

      Creates a new event to record for endpoints, or creates or updates endpoint data that existing events are associated with.


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

      Parameters:
      putEventsRequest - A Consumer that will call methods on PutEventsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutEvents 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • removeAttributes

      default CompletableFuture<RemoveAttributesResponse> removeAttributes(RemoveAttributesRequest removeAttributesRequest)

      Removes one or more custom attributes, of the same attribute type, from the application. Existing endpoints still have the attributes but Amazon Pinpoint will stop capturing new or changed values for these attributes.

      Parameters:
      removeAttributesRequest -
      Returns:
      A Java Future containing the result of the RemoveAttributes 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • removeAttributes

      default CompletableFuture<RemoveAttributesResponse> removeAttributes(Consumer<RemoveAttributesRequest.Builder> removeAttributesRequest)

      Removes one or more custom attributes, of the same attribute type, from the application. Existing endpoints still have the attributes but Amazon Pinpoint will stop capturing new or changed values for these attributes.


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

      Parameters:
      removeAttributesRequest - A Consumer that will call methods on RemoveAttributesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the RemoveAttributes 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • sendMessages

      default CompletableFuture<SendMessagesResponse> sendMessages(SendMessagesRequest sendMessagesRequest)

      Creates and sends a direct message.

      Parameters:
      sendMessagesRequest -
      Returns:
      A Java Future containing the result of the SendMessages 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • sendMessages

      default CompletableFuture<SendMessagesResponse> sendMessages(Consumer<SendMessagesRequest.Builder> sendMessagesRequest)

      Creates and sends a direct message.


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

      Parameters:
      sendMessagesRequest - A Consumer that will call methods on SendMessagesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the SendMessages 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • sendOTPMessage

      default CompletableFuture<SendOtpMessageResponse> sendOTPMessage(SendOtpMessageRequest sendOtpMessageRequest)

      Send an OTP message

      Parameters:
      sendOtpMessageRequest -
      Returns:
      A Java Future containing the result of the SendOTPMessage 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.
      • BadRequestException 400 response
      • InternalServerErrorException 500 response
      • PayloadTooLargeException 413 response
      • ForbiddenException 403 response
      • NotFoundException 404 response
      • MethodNotAllowedException 405 response
      • TooManyRequestsException 429 response
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • sendOTPMessage

      default CompletableFuture<SendOtpMessageResponse> sendOTPMessage(Consumer<SendOtpMessageRequest.Builder> sendOtpMessageRequest)

      Send an OTP message


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

      Parameters:
      sendOtpMessageRequest - A Consumer that will call methods on SendOtpMessageRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the SendOTPMessage 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.
      • BadRequestException 400 response
      • InternalServerErrorException 500 response
      • PayloadTooLargeException 413 response
      • ForbiddenException 403 response
      • NotFoundException 404 response
      • MethodNotAllowedException 405 response
      • TooManyRequestsException 429 response
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • sendUsersMessages

      default CompletableFuture<SendUsersMessagesResponse> sendUsersMessages(SendUsersMessagesRequest sendUsersMessagesRequest)

      Creates and sends a message to a list of users.

      Parameters:
      sendUsersMessagesRequest -
      Returns:
      A Java Future containing the result of the SendUsersMessages 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • sendUsersMessages

      default CompletableFuture<SendUsersMessagesResponse> sendUsersMessages(Consumer<SendUsersMessagesRequest.Builder> sendUsersMessagesRequest)

      Creates and sends a message to a list of users.


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

      Parameters:
      sendUsersMessagesRequest - A Consumer that will call methods on SendUsersMessagesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the SendUsersMessages 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException 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 one or more tags (keys and values) to an application, campaign, message template, or segment.

      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.
      • 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.
      • PinpointException 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 one or more tags (keys and values) to an application, campaign, message template, or segment.


      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.
      • 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.
      • PinpointException 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 one or more tags (keys and values) from an application, campaign, message template, or segment.

      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.
      • 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.
      • PinpointException 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 one or more tags (keys and values) from an application, campaign, message template, or segment.


      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.
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateAdmChannel

      default CompletableFuture<UpdateAdmChannelResponse> updateAdmChannel(UpdateAdmChannelRequest updateAdmChannelRequest)

      Enables the ADM channel for an application or updates the status and settings of the ADM channel for an application.

      Parameters:
      updateAdmChannelRequest -
      Returns:
      A Java Future containing the result of the UpdateAdmChannel 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateAdmChannel

      default CompletableFuture<UpdateAdmChannelResponse> updateAdmChannel(Consumer<UpdateAdmChannelRequest.Builder> updateAdmChannelRequest)

      Enables the ADM channel for an application or updates the status and settings of the ADM channel for an application.


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

      Parameters:
      updateAdmChannelRequest - A Consumer that will call methods on UpdateAdmChannelRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateAdmChannel 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateApnsChannel

      default CompletableFuture<UpdateApnsChannelResponse> updateApnsChannel(UpdateApnsChannelRequest updateApnsChannelRequest)

      Enables the APNs channel for an application or updates the status and settings of the APNs channel for an application.

      Parameters:
      updateApnsChannelRequest -
      Returns:
      A Java Future containing the result of the UpdateApnsChannel 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateApnsChannel

      default CompletableFuture<UpdateApnsChannelResponse> updateApnsChannel(Consumer<UpdateApnsChannelRequest.Builder> updateApnsChannelRequest)

      Enables the APNs channel for an application or updates the status and settings of the APNs channel for an application.


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

      Parameters:
      updateApnsChannelRequest - A Consumer that will call methods on UpdateApnsChannelRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateApnsChannel 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateApnsSandboxChannel

      default CompletableFuture<UpdateApnsSandboxChannelResponse> updateApnsSandboxChannel(UpdateApnsSandboxChannelRequest updateApnsSandboxChannelRequest)

      Enables the APNs sandbox channel for an application or updates the status and settings of the APNs sandbox channel for an application.

      Parameters:
      updateApnsSandboxChannelRequest -
      Returns:
      A Java Future containing the result of the UpdateApnsSandboxChannel 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateApnsSandboxChannel

      default CompletableFuture<UpdateApnsSandboxChannelResponse> updateApnsSandboxChannel(Consumer<UpdateApnsSandboxChannelRequest.Builder> updateApnsSandboxChannelRequest)

      Enables the APNs sandbox channel for an application or updates the status and settings of the APNs sandbox channel for an application.


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

      Parameters:
      updateApnsSandboxChannelRequest - A Consumer that will call methods on UpdateApnsSandboxChannelRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateApnsSandboxChannel 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateApnsVoipChannel

      default CompletableFuture<UpdateApnsVoipChannelResponse> updateApnsVoipChannel(UpdateApnsVoipChannelRequest updateApnsVoipChannelRequest)

      Enables the APNs VoIP channel for an application or updates the status and settings of the APNs VoIP channel for an application.

      Parameters:
      updateApnsVoipChannelRequest -
      Returns:
      A Java Future containing the result of the UpdateApnsVoipChannel 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateApnsVoipChannel

      default CompletableFuture<UpdateApnsVoipChannelResponse> updateApnsVoipChannel(Consumer<UpdateApnsVoipChannelRequest.Builder> updateApnsVoipChannelRequest)

      Enables the APNs VoIP channel for an application or updates the status and settings of the APNs VoIP channel for an application.


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

      Parameters:
      updateApnsVoipChannelRequest - A Consumer that will call methods on UpdateApnsVoipChannelRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateApnsVoipChannel 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateApnsVoipSandboxChannel

      default CompletableFuture<UpdateApnsVoipSandboxChannelResponse> updateApnsVoipSandboxChannel(UpdateApnsVoipSandboxChannelRequest updateApnsVoipSandboxChannelRequest)

      Enables the APNs VoIP sandbox channel for an application or updates the status and settings of the APNs VoIP sandbox channel for an application.

      Parameters:
      updateApnsVoipSandboxChannelRequest -
      Returns:
      A Java Future containing the result of the UpdateApnsVoipSandboxChannel 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateApnsVoipSandboxChannel

      default CompletableFuture<UpdateApnsVoipSandboxChannelResponse> updateApnsVoipSandboxChannel(Consumer<UpdateApnsVoipSandboxChannelRequest.Builder> updateApnsVoipSandboxChannelRequest)

      Enables the APNs VoIP sandbox channel for an application or updates the status and settings of the APNs VoIP sandbox channel for an application.


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

      Parameters:
      updateApnsVoipSandboxChannelRequest - A Consumer that will call methods on UpdateApnsVoipSandboxChannelRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateApnsVoipSandboxChannel 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateApplicationSettings

      default CompletableFuture<UpdateApplicationSettingsResponse> updateApplicationSettings(UpdateApplicationSettingsRequest updateApplicationSettingsRequest)

      Updates the settings for an application.

      Parameters:
      updateApplicationSettingsRequest -
      Returns:
      A Java Future containing the result of the UpdateApplicationSettings 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateApplicationSettings

      default CompletableFuture<UpdateApplicationSettingsResponse> updateApplicationSettings(Consumer<UpdateApplicationSettingsRequest.Builder> updateApplicationSettingsRequest)

      Updates the settings for an application.


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

      Parameters:
      updateApplicationSettingsRequest - A Consumer that will call methods on UpdateApplicationSettingsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateApplicationSettings 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateBaiduChannel

      default CompletableFuture<UpdateBaiduChannelResponse> updateBaiduChannel(UpdateBaiduChannelRequest updateBaiduChannelRequest)

      Enables the Baidu channel for an application or updates the status and settings of the Baidu channel for an application.

      Parameters:
      updateBaiduChannelRequest -
      Returns:
      A Java Future containing the result of the UpdateBaiduChannel 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateBaiduChannel

      default CompletableFuture<UpdateBaiduChannelResponse> updateBaiduChannel(Consumer<UpdateBaiduChannelRequest.Builder> updateBaiduChannelRequest)

      Enables the Baidu channel for an application or updates the status and settings of the Baidu channel for an application.


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

      Parameters:
      updateBaiduChannelRequest - A Consumer that will call methods on UpdateBaiduChannelRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateBaiduChannel 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateCampaign

      default CompletableFuture<UpdateCampaignResponse> updateCampaign(UpdateCampaignRequest updateCampaignRequest)

      Updates the configuration and other settings for a campaign.

      Parameters:
      updateCampaignRequest -
      Returns:
      A Java Future containing the result of the UpdateCampaign 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateCampaign

      default CompletableFuture<UpdateCampaignResponse> updateCampaign(Consumer<UpdateCampaignRequest.Builder> updateCampaignRequest)

      Updates the configuration and other settings for a campaign.


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

      Parameters:
      updateCampaignRequest - A Consumer that will call methods on UpdateCampaignRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateCampaign 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateEmailChannel

      default CompletableFuture<UpdateEmailChannelResponse> updateEmailChannel(UpdateEmailChannelRequest updateEmailChannelRequest)

      Enables the email channel for an application or updates the status and settings of the email channel for an application.

      Parameters:
      updateEmailChannelRequest -
      Returns:
      A Java Future containing the result of the UpdateEmailChannel 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateEmailChannel

      default CompletableFuture<UpdateEmailChannelResponse> updateEmailChannel(Consumer<UpdateEmailChannelRequest.Builder> updateEmailChannelRequest)

      Enables the email channel for an application or updates the status and settings of the email channel for an application.


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

      Parameters:
      updateEmailChannelRequest - A Consumer that will call methods on UpdateEmailChannelRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateEmailChannel 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateEmailTemplate

      default CompletableFuture<UpdateEmailTemplateResponse> updateEmailTemplate(UpdateEmailTemplateRequest updateEmailTemplateRequest)

      Updates an existing message template for messages that are sent through the email channel.

      Parameters:
      updateEmailTemplateRequest -
      Returns:
      A Java Future containing the result of the UpdateEmailTemplate 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateEmailTemplate

      default CompletableFuture<UpdateEmailTemplateResponse> updateEmailTemplate(Consumer<UpdateEmailTemplateRequest.Builder> updateEmailTemplateRequest)

      Updates an existing message template for messages that are sent through the email channel.


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

      Parameters:
      updateEmailTemplateRequest - A Consumer that will call methods on UpdateEmailTemplateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateEmailTemplate 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateEndpoint

      default CompletableFuture<UpdateEndpointResponse> updateEndpoint(UpdateEndpointRequest updateEndpointRequest)

      Creates a new endpoint for an application or updates the settings and attributes of an existing endpoint for an application. You can also use this operation to define custom attributes for an endpoint. If an update includes one or more values for a custom attribute, Amazon Pinpoint replaces (overwrites) any existing values with the new values.

      Parameters:
      updateEndpointRequest -
      Returns:
      A Java Future containing the result of the UpdateEndpoint 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateEndpoint

      default CompletableFuture<UpdateEndpointResponse> updateEndpoint(Consumer<UpdateEndpointRequest.Builder> updateEndpointRequest)

      Creates a new endpoint for an application or updates the settings and attributes of an existing endpoint for an application. You can also use this operation to define custom attributes for an endpoint. If an update includes one or more values for a custom attribute, Amazon Pinpoint replaces (overwrites) any existing values with the new values.


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

      Parameters:
      updateEndpointRequest - A Consumer that will call methods on UpdateEndpointRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateEndpoint 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateEndpointsBatch

      default CompletableFuture<UpdateEndpointsBatchResponse> updateEndpointsBatch(UpdateEndpointsBatchRequest updateEndpointsBatchRequest)

      Creates a new batch of endpoints for an application or updates the settings and attributes of a batch of existing endpoints for an application. You can also use this operation to define custom attributes for a batch of endpoints. If an update includes one or more values for a custom attribute, Amazon Pinpoint replaces (overwrites) any existing values with the new values.

      Parameters:
      updateEndpointsBatchRequest -
      Returns:
      A Java Future containing the result of the UpdateEndpointsBatch 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateEndpointsBatch

      default CompletableFuture<UpdateEndpointsBatchResponse> updateEndpointsBatch(Consumer<UpdateEndpointsBatchRequest.Builder> updateEndpointsBatchRequest)

      Creates a new batch of endpoints for an application or updates the settings and attributes of a batch of existing endpoints for an application. You can also use this operation to define custom attributes for a batch of endpoints. If an update includes one or more values for a custom attribute, Amazon Pinpoint replaces (overwrites) any existing values with the new values.


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

      Parameters:
      updateEndpointsBatchRequest - A Consumer that will call methods on UpdateEndpointsBatchRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateEndpointsBatch 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateGcmChannel

      default CompletableFuture<UpdateGcmChannelResponse> updateGcmChannel(UpdateGcmChannelRequest updateGcmChannelRequest)

      Enables the GCM channel for an application or updates the status and settings of the GCM channel for an application.

      Parameters:
      updateGcmChannelRequest -
      Returns:
      A Java Future containing the result of the UpdateGcmChannel 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateGcmChannel

      default CompletableFuture<UpdateGcmChannelResponse> updateGcmChannel(Consumer<UpdateGcmChannelRequest.Builder> updateGcmChannelRequest)

      Enables the GCM channel for an application or updates the status and settings of the GCM channel for an application.


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

      Parameters:
      updateGcmChannelRequest - A Consumer that will call methods on UpdateGcmChannelRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateGcmChannel 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateInAppTemplate

      default CompletableFuture<UpdateInAppTemplateResponse> updateInAppTemplate(UpdateInAppTemplateRequest updateInAppTemplateRequest)

      Updates an existing message template for messages sent through the in-app message channel.

      Parameters:
      updateInAppTemplateRequest -
      Returns:
      A Java Future containing the result of the UpdateInAppTemplate 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateInAppTemplate

      default CompletableFuture<UpdateInAppTemplateResponse> updateInAppTemplate(Consumer<UpdateInAppTemplateRequest.Builder> updateInAppTemplateRequest)

      Updates an existing message template for messages sent through the in-app message channel.


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

      Parameters:
      updateInAppTemplateRequest - A Consumer that will call methods on UpdateInAppTemplateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateInAppTemplate 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateJourney

      default CompletableFuture<UpdateJourneyResponse> updateJourney(UpdateJourneyRequest updateJourneyRequest)

      Updates the configuration and other settings for a journey.

      Parameters:
      updateJourneyRequest -
      Returns:
      A Java Future containing the result of the UpdateJourney 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • ConflictException The request failed due to a conflict with the current state of the specified resource (ConflictException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateJourney

      default CompletableFuture<UpdateJourneyResponse> updateJourney(Consumer<UpdateJourneyRequest.Builder> updateJourneyRequest)

      Updates the configuration and other settings for a journey.


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

      Parameters:
      updateJourneyRequest - A Consumer that will call methods on UpdateJourneyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateJourney 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • ConflictException The request failed due to a conflict with the current state of the specified resource (ConflictException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateJourneyState

      default CompletableFuture<UpdateJourneyStateResponse> updateJourneyState(UpdateJourneyStateRequest updateJourneyStateRequest)

      Cancels (stops) an active journey.

      Parameters:
      updateJourneyStateRequest -
      Returns:
      A Java Future containing the result of the UpdateJourneyState 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateJourneyState

      default CompletableFuture<UpdateJourneyStateResponse> updateJourneyState(Consumer<UpdateJourneyStateRequest.Builder> updateJourneyStateRequest)

      Cancels (stops) an active journey.


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

      Parameters:
      updateJourneyStateRequest - A Consumer that will call methods on UpdateJourneyStateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateJourneyState 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updatePushTemplate

      default CompletableFuture<UpdatePushTemplateResponse> updatePushTemplate(UpdatePushTemplateRequest updatePushTemplateRequest)

      Updates an existing message template for messages that are sent through a push notification channel.

      Parameters:
      updatePushTemplateRequest -
      Returns:
      A Java Future containing the result of the UpdatePushTemplate 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updatePushTemplate

      default CompletableFuture<UpdatePushTemplateResponse> updatePushTemplate(Consumer<UpdatePushTemplateRequest.Builder> updatePushTemplateRequest)

      Updates an existing message template for messages that are sent through a push notification channel.


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

      Parameters:
      updatePushTemplateRequest - A Consumer that will call methods on UpdatePushTemplateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdatePushTemplate 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateRecommenderConfiguration

      default CompletableFuture<UpdateRecommenderConfigurationResponse> updateRecommenderConfiguration(UpdateRecommenderConfigurationRequest updateRecommenderConfigurationRequest)

      Updates an Amazon Pinpoint configuration for a recommender model.

      Parameters:
      updateRecommenderConfigurationRequest -
      Returns:
      A Java Future containing the result of the UpdateRecommenderConfiguration 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateRecommenderConfiguration

      default CompletableFuture<UpdateRecommenderConfigurationResponse> updateRecommenderConfiguration(Consumer<UpdateRecommenderConfigurationRequest.Builder> updateRecommenderConfigurationRequest)

      Updates an Amazon Pinpoint configuration for a recommender model.


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

      Parameters:
      updateRecommenderConfigurationRequest - A Consumer that will call methods on UpdateRecommenderConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateRecommenderConfiguration 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateSegment

      default CompletableFuture<UpdateSegmentResponse> updateSegment(UpdateSegmentRequest updateSegmentRequest)

      Creates a new segment for an application or updates the configuration, dimension, and other settings for an existing segment that's associated with an application.

      Parameters:
      updateSegmentRequest -
      Returns:
      A Java Future containing the result of the UpdateSegment 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateSegment

      default CompletableFuture<UpdateSegmentResponse> updateSegment(Consumer<UpdateSegmentRequest.Builder> updateSegmentRequest)

      Creates a new segment for an application or updates the configuration, dimension, and other settings for an existing segment that's associated with an application.


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

      Parameters:
      updateSegmentRequest - A Consumer that will call methods on UpdateSegmentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateSegment 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateSmsChannel

      default CompletableFuture<UpdateSmsChannelResponse> updateSmsChannel(UpdateSmsChannelRequest updateSmsChannelRequest)

      Enables the SMS channel for an application or updates the status and settings of the SMS channel for an application.

      Parameters:
      updateSmsChannelRequest -
      Returns:
      A Java Future containing the result of the UpdateSmsChannel 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateSmsChannel

      default CompletableFuture<UpdateSmsChannelResponse> updateSmsChannel(Consumer<UpdateSmsChannelRequest.Builder> updateSmsChannelRequest)

      Enables the SMS channel for an application or updates the status and settings of the SMS channel for an application.


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

      Parameters:
      updateSmsChannelRequest - A Consumer that will call methods on UpdateSmsChannelRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateSmsChannel 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateSmsTemplate

      default CompletableFuture<UpdateSmsTemplateResponse> updateSmsTemplate(UpdateSmsTemplateRequest updateSmsTemplateRequest)

      Updates an existing message template for messages that are sent through the SMS channel.

      Parameters:
      updateSmsTemplateRequest -
      Returns:
      A Java Future containing the result of the UpdateSmsTemplate 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateSmsTemplate

      default CompletableFuture<UpdateSmsTemplateResponse> updateSmsTemplate(Consumer<UpdateSmsTemplateRequest.Builder> updateSmsTemplateRequest)

      Updates an existing message template for messages that are sent through the SMS channel.


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

      Parameters:
      updateSmsTemplateRequest - A Consumer that will call methods on UpdateSmsTemplateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateSmsTemplate 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateTemplateActiveVersion

      default CompletableFuture<UpdateTemplateActiveVersionResponse> updateTemplateActiveVersion(UpdateTemplateActiveVersionRequest updateTemplateActiveVersionRequest)

      Changes the status of a specific version of a message template to active.

      Parameters:
      updateTemplateActiveVersionRequest -
      Returns:
      A Java Future containing the result of the UpdateTemplateActiveVersion 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateTemplateActiveVersion

      default CompletableFuture<UpdateTemplateActiveVersionResponse> updateTemplateActiveVersion(Consumer<UpdateTemplateActiveVersionRequest.Builder> updateTemplateActiveVersionRequest)

      Changes the status of a specific version of a message template to active.


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

      Parameters:
      updateTemplateActiveVersionRequest - A Consumer that will call methods on UpdateTemplateActiveVersionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateTemplateActiveVersion 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateVoiceChannel

      default CompletableFuture<UpdateVoiceChannelResponse> updateVoiceChannel(UpdateVoiceChannelRequest updateVoiceChannelRequest)

      Enables the voice channel for an application or updates the status and settings of the voice channel for an application.

      Parameters:
      updateVoiceChannelRequest -
      Returns:
      A Java Future containing the result of the UpdateVoiceChannel 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateVoiceChannel

      default CompletableFuture<UpdateVoiceChannelResponse> updateVoiceChannel(Consumer<UpdateVoiceChannelRequest.Builder> updateVoiceChannelRequest)

      Enables the voice channel for an application or updates the status and settings of the voice channel for an application.


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

      Parameters:
      updateVoiceChannelRequest - A Consumer that will call methods on UpdateVoiceChannelRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateVoiceChannel 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateVoiceTemplate

      default CompletableFuture<UpdateVoiceTemplateResponse> updateVoiceTemplate(UpdateVoiceTemplateRequest updateVoiceTemplateRequest)

      Updates an existing message template for messages that are sent through the voice channel.

      Parameters:
      updateVoiceTemplateRequest -
      Returns:
      A Java Future containing the result of the UpdateVoiceTemplate 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateVoiceTemplate

      default CompletableFuture<UpdateVoiceTemplateResponse> updateVoiceTemplate(Consumer<UpdateVoiceTemplateRequest.Builder> updateVoiceTemplateRequest)

      Updates an existing message template for messages that are sent through the voice channel.


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

      Parameters:
      updateVoiceTemplateRequest - A Consumer that will call methods on UpdateVoiceTemplateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateVoiceTemplate 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.
      • BadRequestException The request contains a syntax error (BadRequestException).
      • InternalServerErrorException The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
      • PayloadTooLargeException The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
      • ForbiddenException The request was denied because access to the specified resource is forbidden (ForbiddenException).
      • NotFoundException The request failed because the specified resource was not found (NotFoundException).
      • MethodNotAllowedException The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
      • TooManyRequestsException The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • verifyOTPMessage

      default CompletableFuture<VerifyOtpMessageResponse> verifyOTPMessage(VerifyOtpMessageRequest verifyOtpMessageRequest)

      Verify an OTP

      Parameters:
      verifyOtpMessageRequest -
      Returns:
      A Java Future containing the result of the VerifyOTPMessage 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.
      • BadRequestException 400 response
      • InternalServerErrorException 500 response
      • PayloadTooLargeException 413 response
      • ForbiddenException 403 response
      • NotFoundException 404 response
      • MethodNotAllowedException 405 response
      • TooManyRequestsException 429 response
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • verifyOTPMessage

      default CompletableFuture<VerifyOtpMessageResponse> verifyOTPMessage(Consumer<VerifyOtpMessageRequest.Builder> verifyOtpMessageRequest)

      Verify an OTP


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

      Parameters:
      verifyOtpMessageRequest - A Consumer that will call methods on VerifyOtpMessageRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the VerifyOTPMessage 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.
      • BadRequestException 400 response
      • InternalServerErrorException 500 response
      • PayloadTooLargeException 413 response
      • ForbiddenException 403 response
      • NotFoundException 404 response
      • MethodNotAllowedException 405 response
      • TooManyRequestsException 429 response
      • 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.
      • PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • serviceClientConfiguration

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

    • builder

      static PinpointAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a PinpointAsyncClient.