AWS.MarketplaceCommerceAnalytics — AWS SDK for JavaScript (original) (raw)

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Inherits:

AWS.Service

Identifier:

marketplacecommerceanalytics

API Version:

2015-07-01

Defined in:

(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

Provides AWS Marketplace business intelligence data on-demand.

Sending a Request Using MarketplaceCommerceAnalytics

var marketplacecommerceanalytics = new AWS.MarketplaceCommerceAnalytics();
marketplacecommerceanalytics.generateDataSet(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the MarketplaceCommerceAnalytics object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var marketplacecommerceanalytics = new AWS.MarketplaceCommerceAnalytics({apiVersion: '2015-07-01'});

You can also set the API version globally in AWS.config.apiVersions using the marketplacecommerceanalytics service identifier:

AWS.config.apiVersions = {
  marketplacecommerceanalytics: '2015-07-01',
  // other service API versions
};

var marketplacecommerceanalytics = new AWS.MarketplaceCommerceAnalytics();

Constructor Summarycollapse

Property Summarycollapse

Properties inherited from AWS.Service

apiVersions

Method Summarycollapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.MarketplaceCommerceAnalytics(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

generateDataSet(params = {}, callback) ⇒ AWS.Request

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.

startSupportDataExport(params = {}, callback) ⇒ AWS.Request

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.