AWS Marketplace Commerce Analytics

2017/01/04 - AWS Marketplace Commerce Analytics - 1 updated api methods

Changes  Added support for data set disbursed_amount_by_instance_hours, with historical data available starting 2012-09-04. New data is published to this data set every 30 days.

GenerateDataSet (updated) Link ΒΆ
Changes (request) 
{'dataSetType': {'disbursed_amount_by_instance_hours'}}

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.

See also: AWS API Documentation

Request Syntax

client.generate_data_set(
    dataSetType='customer_subscriber_hourly_monthly_subscriptions'|'customer_subscriber_annual_subscriptions'|'daily_business_usage_by_instance_type'|'daily_business_fees'|'daily_business_free_trial_conversions'|'daily_business_new_instances'|'daily_business_new_product_subscribers'|'daily_business_canceled_product_subscribers'|'monthly_revenue_billing_and_revenue_data'|'monthly_revenue_annual_subscriptions'|'disbursed_amount_by_product'|'disbursed_amount_by_product_with_uncollected_funds'|'disbursed_amount_by_instance_hours'|'disbursed_amount_by_customer_geo'|'disbursed_amount_by_age_of_uncollected_funds'|'disbursed_amount_by_age_of_disbursed_funds'|'customer_profile_by_industry'|'customer_profile_by_revenue'|'customer_profile_by_geography'|'sales_compensation_billed_revenue',
    dataSetPublicationDate=datetime(2015, 1, 1),
    roleNameArn='string',
    destinationS3BucketName='string',
    destinationS3Prefix='string',
    snsTopicArn='string',
    customerDefinedValues={
        'string': 'string'
    }
)
type dataSetType

string

param dataSetType

[REQUIRED]

The desired data set type.

  • customer_subscriber_hourly_monthly_subscriptions - Available daily by 5:00 PM Pacific Time since 2014-07-21.

  • customer_subscriber_annual_subscriptions - Available daily by 5:00 PM Pacific Time since 2014-07-21.

  • daily_business_usage_by_instance_type - Available daily by 5:00 PM Pacific Time since 2015-01-26.

  • daily_business_fees - Available daily by 5:00 PM Pacific Time since 2015-01-26.

  • daily_business_free_trial_conversions - Available daily by 5:00 PM Pacific Time since 2015-01-26.

  • daily_business_new_instances - Available daily by 5:00 PM Pacific Time since 2015-01-26.

  • daily_business_new_product_subscribers - Available daily by 5:00 PM Pacific Time since 2015-01-26.

  • daily_business_canceled_product_subscribers - Available daily by 5:00 PM Pacific Time since 2015-01-26.

  • monthly_revenue_billing_and_revenue_data - Available monthly on the 4th day of the month by 5:00 PM Pacific Time since 2015-02.

  • monthly_revenue_annual_subscriptions - Available monthly on the 4th day of the month by 5:00 PM Pacific Time since 2015-02.

  • disbursed_amount_by_product - Available every 30 days by 5:00 PM Pacific Time since 2015-01-26.

  • disbursed_amount_by_product_with_uncollected_funds -This data set is only available from 2012-04-19 until 2015-01-25. After 2015-01-25, this data set was split into three data sets: disbursed_amount_by_product, disbursed_amount_by_age_of_uncollected_funds, and disbursed_amount_by_age_of_disbursed_funds.

  • disbursed_amount_by_instance_hours - Available every 30 days by 5:00 PM Pacific Time since 2012-09-04.

  • disbursed_amount_by_customer_geo - Available every 30 days by 5:00 PM Pacific Time since 2012-04-19.

  • disbursed_amount_by_age_of_uncollected_funds - Available every 30 days by 5:00 PM Pacific Time since 2015-01-26.

  • disbursed_amount_by_age_of_disbursed_funds - Available every 30 days by 5:00 PM Pacific Time since 2015-01-26.

  • customer_profile_by_industry - Available daily by 5:00 PM Pacific Time since 2015-10-01.

  • customer_profile_by_revenue - Available daily by 5:00 PM Pacific Time since 2015-10-01.

  • customer_profile_by_geography - Available daily by 5:00 PM Pacific Time since 2015-10-01.

  • sales_compensation_billed_revenue - Available monthly on the 4th day of the month by 5:00 PM Pacific Time since 2016-12.

type dataSetPublicationDate

datetime

param dataSetPublicationDate

[REQUIRED] The date a data set was published. For daily data sets, provide a date with day-level granularity for the desired day. For weekly data sets, provide a date with day-level granularity within the desired week (the day value will be ignored). For monthly data sets, provide a date with month-level granularity for the desired month (the day value will be ignored).

type roleNameArn

string

param roleNameArn

[REQUIRED] The Amazon Resource Name (ARN) of the Role with an attached permissions policy to interact with the provided AWS services.

type destinationS3BucketName

string

param destinationS3BucketName

[REQUIRED] The name (friendly name, not ARN) of the destination S3 bucket.

type destinationS3Prefix

string

param destinationS3Prefix

(Optional) The desired S3 prefix for the published data set, similar to a directory path in standard file systems. For example, if given the bucket name "mybucket" and the prefix "myprefix/mydatasets", the output file "outputfile" would be published to "s3://mybucket/myprefix/mydatasets/outputfile". If the prefix directory structure does not exist, it will be created. If no prefix is provided, the data set will be published to the S3 bucket root.

type snsTopicArn

string

param snsTopicArn

[REQUIRED] Amazon Resource Name (ARN) for the SNS Topic that will be notified when the data set has been published or if an error has occurred.

type customerDefinedValues

dict

param customerDefinedValues

(Optional) Key-value pairs which will be returned, unmodified, in the Amazon SNS notification message and the data set metadata file. These key-value pairs can be used to correlated responses with tracking information from other systems.

  • (string) --

    • (string) --

rtype

dict

returns

Response Syntax

{
    'dataSetRequestId': 'string'
}

Response Structure

  • (dict) -- Container for the result of the GenerateDataSet operation.

    • dataSetRequestId (string) -- A unique identifier representing a specific request to the GenerateDataSet operation. This identifier can be used to correlate a request with notifications from the SNS topic.