Class AWSMarketplaceCommerceAnalyticsClient

    • Field Detail

      • configFactory

        protected static final ClientConfigurationFactory configFactory
        Client configuration factory providing ClientConfigurations tailored to this client
    • Constructor Detail

      • AWSMarketplaceCommerceAnalyticsClient

        public AWSMarketplaceCommerceAnalyticsClient()
        Constructs a new client to invoke service methods on AWS Marketplace Commerce Analytics. A credentials provider chain will be used that searches for credentials in this order:
        • Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
        • Java System Properties - aws.accessKeyId and aws.secretKey
        • Instance profile credentials delivered through the Amazon EC2 metadata service

        All service calls made using this new client object are blocking, and will not return until the service call completes.

        See Also:
        DefaultAWSCredentialsProviderChain
      • AWSMarketplaceCommerceAnalyticsClient

        public AWSMarketplaceCommerceAnalyticsClient​(ClientConfiguration clientConfiguration)
        Constructs a new client to invoke service methods on AWS Marketplace Commerce Analytics. A credentials provider chain will be used that searches for credentials in this order:
        • Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
        • Java System Properties - aws.accessKeyId and aws.secretKey
        • Instance profile credentials delivered through the Amazon EC2 metadata service

        All service calls made using this new client object are blocking, and will not return until the service call completes.

        Parameters:
        clientConfiguration - The client configuration options controlling how this client connects to AWS Marketplace Commerce Analytics (ex: proxy settings, retry counts, etc.).
        See Also:
        DefaultAWSCredentialsProviderChain
      • AWSMarketplaceCommerceAnalyticsClient

        public AWSMarketplaceCommerceAnalyticsClient​(AWSCredentials awsCredentials)
        Constructs a new client to invoke service methods on AWS Marketplace Commerce Analytics using the specified AWS account credentials.

        All service calls made using this new client object are blocking, and will not return until the service call completes.

        Parameters:
        awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
      • AWSMarketplaceCommerceAnalyticsClient

        public AWSMarketplaceCommerceAnalyticsClient​(AWSCredentials awsCredentials,
                                                     ClientConfiguration clientConfiguration)
        Constructs a new client to invoke service methods on AWS Marketplace Commerce Analytics using the specified AWS account credentials and client configuration options.

        All service calls made using this new client object are blocking, and will not return until the service call completes.

        Parameters:
        awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
        clientConfiguration - The client configuration options controlling how this client connects to AWS Marketplace Commerce Analytics (ex: proxy settings, retry counts, etc.).
      • AWSMarketplaceCommerceAnalyticsClient

        public AWSMarketplaceCommerceAnalyticsClient​(AWSCredentialsProvider awsCredentialsProvider)
        Constructs a new client to invoke service methods on AWS Marketplace Commerce Analytics using the specified AWS account credentials provider.

        All service calls made using this new client object are blocking, and will not return until the service call completes.

        Parameters:
        awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
      • AWSMarketplaceCommerceAnalyticsClient

        public AWSMarketplaceCommerceAnalyticsClient​(AWSCredentialsProvider awsCredentialsProvider,
                                                     ClientConfiguration clientConfiguration)
        Constructs a new client to invoke service methods on AWS Marketplace Commerce Analytics using the specified AWS account credentials provider and client configuration options.

        All service calls made using this new client object are blocking, and will not return until the service call completes.

        Parameters:
        awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
        clientConfiguration - The client configuration options controlling how this client connects to AWS Marketplace Commerce Analytics (ex: proxy settings, retry counts, etc.).
      • AWSMarketplaceCommerceAnalyticsClient

        public AWSMarketplaceCommerceAnalyticsClient​(AWSCredentialsProvider awsCredentialsProvider,
                                                     ClientConfiguration clientConfiguration,
                                                     RequestMetricCollector requestMetricCollector)
        Constructs a new client to invoke service methods on AWS Marketplace Commerce Analytics using the specified AWS account credentials provider, client configuration options, and request metric collector.

        All service calls made using this new client object are blocking, and will not return until the service call completes.

        Parameters:
        awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
        clientConfiguration - The client configuration options controlling how this client connects to AWS Marketplace Commerce Analytics (ex: proxy settings, retry counts, etc.).
        requestMetricCollector - optional request metric collector
    • Method Detail

      • generateDataSet

        public GenerateDataSetResult 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.
        Specified by:
        generateDataSet in interface AWSMarketplaceCommerceAnalytics
        Parameters:
        generateDataSetRequest - Container for the parameters to the GenerateDataSet operation.
        Returns:
        Result of the GenerateDataSet operation returned by the service.
        Throws:
        MarketplaceCommerceAnalyticsException - This exception is thrown when an internal service error occurs.
      • getCachedResponseMetadata

        public ResponseMetadata getCachedResponseMetadata​(AmazonWebServiceRequest request)
        Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

        Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

        Specified by:
        getCachedResponseMetadata in interface AWSMarketplaceCommerceAnalytics
        Parameters:
        request - The originally executed request
        Returns:
        The response metadata for the specified request, or null if none is available.