Package software.amazon.awssdk.services.marketplacecommerceanalytics

Interface MarketplaceCommerceAnalyticsAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface MarketplaceCommerceAnalyticsAsyncClient extends AwsClient
Service client for accessing AWS Marketplace Commerce Analytics 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. Provides AWS Marketplace business intelligence data on-demand.

  • Field Details

  • Method Details

    • generateDataSet

      default CompletableFuture<GenerateDataSetResponse> generateDataSet(GenerateDataSetRequest generateDataSetRequest)
      Given a data set type and data set publication date, asynchronously publishes the requested data set to the specified S3 bucket and notifies the specified SNS topic once the data is available. Returns a unique request identifier that can be used to correlate requests with notifications from the SNS topic. Data sets will be published in comma-separated values (CSV) format with the file name {data_set_type}_YYYY-MM-DD.csv. If a file with the same name already exists (e.g. if the same data set is requested twice), the original file will be overwritten by the new file. Requires a Role with an attached permissions policy providing Allow permissions for the following actions: s3:PutObject, s3:GetBucketLocation, sns:GetTopicAttributes, sns:Publish, iam:GetRolePolicy.
      Parameters:
      generateDataSetRequest - Container for the parameters to the GenerateDataSet operation.
      Returns:
      A Java Future containing the result of the GenerateDataSet operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • MarketplaceCommerceAnalyticsServiceException This exception is thrown when an internal service error occurs.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • MarketplaceCommerceAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • generateDataSet

      default CompletableFuture<GenerateDataSetResponse> generateDataSet(Consumer<GenerateDataSetRequest.Builder> generateDataSetRequest)
      Given a data set type and data set publication date, asynchronously publishes the requested data set to the specified S3 bucket and notifies the specified SNS topic once the data is available. Returns a unique request identifier that can be used to correlate requests with notifications from the SNS topic. Data sets will be published in comma-separated values (CSV) format with the file name {data_set_type}_YYYY-MM-DD.csv. If a file with the same name already exists (e.g. if the same data set is requested twice), the original file will be overwritten by the new file. Requires a Role with an attached permissions policy providing Allow permissions for the following actions: s3:PutObject, s3:GetBucketLocation, sns:GetTopicAttributes, sns:Publish, iam:GetRolePolicy.

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

      Parameters:
      generateDataSetRequest - A Consumer that will call methods on GenerateDataSetRequest.Builder to create a request. Container for the parameters to the GenerateDataSet operation.
      Returns:
      A Java Future containing the result of the GenerateDataSet operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • MarketplaceCommerceAnalyticsServiceException This exception is thrown when an internal service error occurs.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • MarketplaceCommerceAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startSupportDataExport

      @Deprecated default CompletableFuture<StartSupportDataExportResponse> startSupportDataExport(StartSupportDataExportRequest startSupportDataExportRequest)
      Deprecated.
      This target has been deprecated. As of December 2022 Product Support Connection is no longer supported.
      This target has been deprecated. Given a data set type and a from date, asynchronously publishes the requested customer support data to the specified S3 bucket and notifies the specified SNS topic once the data is available. Returns a unique request identifier that can be used to correlate requests with notifications from the SNS topic. Data sets will be published in comma-separated values (CSV) format with the file name {data_set_type}_YYYY-MM-DD'T'HH-mm-ss'Z'.csv. If a file with the same name already exists (e.g. if the same data set is requested twice), the original file will be overwritten by the new file. Requires a Role with an attached permissions policy providing Allow permissions for the following actions: s3:PutObject, s3:GetBucketLocation, sns:GetTopicAttributes, sns:Publish, iam:GetRolePolicy.
      Parameters:
      startSupportDataExportRequest - This target has been deprecated.
      Returns:
      A Java Future containing the result of the StartSupportDataExport operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • MarketplaceCommerceAnalyticsServiceException This exception is thrown when an internal service error occurs.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • MarketplaceCommerceAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startSupportDataExport

      @Deprecated default CompletableFuture<StartSupportDataExportResponse> startSupportDataExport(Consumer<StartSupportDataExportRequest.Builder> startSupportDataExportRequest)
      Deprecated.
      This target has been deprecated. As of December 2022 Product Support Connection is no longer supported.
      This target has been deprecated. Given a data set type and a from date, asynchronously publishes the requested customer support data to the specified S3 bucket and notifies the specified SNS topic once the data is available. Returns a unique request identifier that can be used to correlate requests with notifications from the SNS topic. Data sets will be published in comma-separated values (CSV) format with the file name {data_set_type}_YYYY-MM-DD'T'HH-mm-ss'Z'.csv. If a file with the same name already exists (e.g. if the same data set is requested twice), the original file will be overwritten by the new file. Requires a Role with an attached permissions policy providing Allow permissions for the following actions: s3:PutObject, s3:GetBucketLocation, sns:GetTopicAttributes, sns:Publish, iam:GetRolePolicy.

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

      Parameters:
      startSupportDataExportRequest - A Consumer that will call methods on StartSupportDataExportRequest.Builder to create a request. This target has been deprecated.
      Returns:
      A Java Future containing the result of the StartSupportDataExport operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • MarketplaceCommerceAnalyticsServiceException This exception is thrown when an internal service error occurs.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • MarketplaceCommerceAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • serviceClientConfiguration

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

    • builder

      static MarketplaceCommerceAnalyticsAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a MarketplaceCommerceAnalyticsAsyncClient.