Interface AWSMarketplaceCommerceAnalytics

All Known Subinterfaces:
AWSMarketplaceCommerceAnalyticsAsync
All Known Implementing Classes:
AbstractAWSMarketplaceCommerceAnalytics, AbstractAWSMarketplaceCommerceAnalyticsAsync, AWSMarketplaceCommerceAnalyticsAsyncClient, AWSMarketplaceCommerceAnalyticsClient

public interface AWSMarketplaceCommerceAnalytics
Interface for accessing AWS Marketplace Commerce Analytics.

Provides AWS Marketplace business intelligence data on-demand.

  • Method Summary

    Modifier and Type
    Method
    Description
    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 additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
    void
    setEndpoint(String endpoint)
    Overrides the default endpoint for this client ("https://marketplacecommerceanalytics.us-east-1.amazonaws.com").
    void
    setRegion(Region region)
    An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls.
    void
    Shuts down this client object, releasing any resources that might be held open.
  • Method Details

    • setEndpoint

      void setEndpoint(String endpoint)
      Overrides the default endpoint for this client ("https://marketplacecommerceanalytics.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.

      Callers can pass in just the endpoint (ex: "marketplacecommerceanalytics.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://marketplacecommerceanalytics.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

      For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912

      This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

      Parameters:
      endpoint - The endpoint (ex: "marketplacecommerceanalytics.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://marketplacecommerceanalytics.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.
    • setRegion

      void setRegion(Region region)
      An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.

      By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.

      This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

      Parameters:
      region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region. Must not be null and must be a region where the service is available.
      See Also:
    • generateDataSet

      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.
      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.
    • shutdown

      void shutdown()
      Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
    • getCachedResponseMetadata

      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 a request.

      Parameters:
      request - The originally executed request.
      Returns:
      The response metadata for the specified request, or null if none is available.