com.amazonaws.services.marketplacecommerceanalytics

Class AWSMarketplaceCommerceAnalyticsClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.marketplacecommerceanalytics.AWSMarketplaceCommerceAnalyticsClient

All Implemented Interfaces:

AWSMarketplaceCommerceAnalytics

Direct Known Subclasses:

AWSMarketplaceCommerceAnalyticsAsyncClient

@ThreadSafe
public class AWSMarketplaceCommerceAnalyticsClient
extends AmazonWebServiceClient
implements AWSMarketplaceCommerceAnalytics

Client for accessing AWS Marketplace Commerce Analytics. All service calls made using this client are blocking, and will not return until the service call completes.

Provides AWS Marketplace business intelligence data on-demand.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.marketplacecommerceanalytics.AWSMarketplaceCommerceAnalytics

ENDPOINT_PREFIX

Constructor Summary

Constructors

Constructor and Description
AWSMarketplaceCommerceAnalyticsClient() Constructs a new client to invoke service methods on AWS Marketplace Commerce Analytics.
AWSMarketplaceCommerceAnalyticsClient(AWSCredentials awsCredentials) Constructs a new client to invoke service methods on AWS Marketplace Commerce Analytics using the specified AWS account credentials.
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.
AWSMarketplaceCommerceAnalyticsClient(AWSCredentialsProvider awsCredentialsProvider) Constructs a new client to invoke service methods on AWS Marketplace Commerce Analytics using the specified AWS account credentials provider.
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.
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.
AWSMarketplaceCommerceAnalyticsClient(ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AWS Marketplace Commerce Analytics.

Method Summary

Modifier and Type	Method and Description
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.
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.
StartSupportDataExportResult	startSupportDataExport(StartSupportDataExportRequest startSupportDataExportRequest) 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.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getEndpointPrefix, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.marketplacecommerceanalytics.AWSMarketplaceCommerceAnalytics

setEndpoint, setRegion, shutdown

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.

startSupportDataExport

public StartSupportDataExportResult startSupportDataExport(StartSupportDataExportRequest startSupportDataExportRequest)

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.

Specified by:

startSupportDataExport in interface AWSMarketplaceCommerceAnalytics

Parameters:

startSupportDataExportRequest - Container for the parameters to the StartSupportDataExport operation.

Returns:

Result of the StartSupportDataExport 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.