Marketplace Commerce Analytics

This page documents function available when using the Marketplace_Commerce_Analytics module, created with @service Marketplace_Commerce_Analytics.

Index

Documentation

Main.Marketplace_Commerce_Analytics.generate_data_setMethod
generate_data_set(data_set_publication_date, data_set_type, destination_s3_bucket_name, role_name_arn, sns_topic_arn)
generate_data_set(data_set_publication_date, data_set_type, destination_s3_bucket_name, role_name_arn, sns_topic_arn, params::Dict{String,<:Any})

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 {datasettype}_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.

Arguments

  • data_set_publication_date: The date a data set was published. For daily data sets, provide a date with day-level granularity for the desired day. For monthly data sets except those with prefix disbursedamount, provide a date with month-level granularity for the desired month (the day value will be ignored). For data sets with prefix disbursedamount, provide a date with day-level granularity for the desired day. For these data sets we will look backwards in time over the range of 31 days until the first data set is found (the latest one).
  • data_set_type: The desired data set type. customersubscriberhourlymonthlysubscriptions From 2017-09-15 to present: Available daily by 24:00 UTC. customersubscriberannualsubscriptions From 2017-09-15 to present: Available daily by 24:00 UTC. dailybusinessusagebyinstancetype From 2017-09-15 to present: Available daily by 24:00 UTC. dailybusinessfees From 2017-09-15 to present: Available daily by 24:00 UTC. dailybusinessfreetrialconversions From 2017-09-15 to present: Available daily by 24:00 UTC. dailybusinessnewinstances From 2017-09-15 to present: Available daily by 24:00 UTC. dailybusinessnewproductsubscribers From 2017-09-15 to present: Available daily by 24:00 UTC. dailybusinesscanceledproductsubscribers From 2017-09-15 to present: Available daily by 24:00 UTC. monthlyrevenuebillingandrevenuedata From 2017-09-15 to present: Available monthly on the 15th day of the month by 24:00 UTC. Data includes metered transactions (e.g. hourly) from one month prior. monthlyrevenueannualsubscriptions From 2017-09-15 to present: Available monthly on the 15th day of the month by 24:00 UTC. Data includes up-front software charges (e.g. annual) from one month prior. monthlyrevenuefielddemonstrationusage From 2018-03-15 to present: Available monthly on the 15th day of the month by 24:00 UTC. monthlyrevenueflexiblepaymentschedule From 2018-11-15 to present: Available monthly on the 15th day of the month by 24:00 UTC. disbursedamountbyproduct From 2017-09-15 to present: Available every 30 days by 24:00 UTC. disbursedamountbyinstancehours From 2017-09-15 to present: Available every 30 days by 24:00 UTC. disbursedamountbycustomergeo From 2017-09-15 to present: Available every 30 days by 24:00 UTC. disbursedamountbyageofuncollectedfunds From 2017-09-15 to present: Available every 30 days by 24:00 UTC. disbursedamountbyageofdisbursedfunds From 2017-09-15 to present: Available every 30 days by 24:00 UTC. disbursedamountbyageofpastduefunds From 2018-04-07 to present: Available every 30 days by 24:00 UTC. disbursedamountbyuncollectedfundsbreakdown From 2019-10-04 to present: Available every 30 days by 24:00 UTC. salescompensationbilledrevenue From 2017-09-15 to present: Available monthly on the 15th day of the month by 24:00 UTC. Data includes metered transactions (e.g. hourly) from one month prior, and up-front software charges (e.g. annual) from one month prior. ussalesandusetaxrecords From 2017-09-15 to present: Available monthly on the 15th day of the month by 24:00 UTC. disbursedamountbyproductwithuncollectedfunds This data set is deprecated. Download related reports from AMMP instead! customerprofilebyindustry This data set is deprecated. Download related reports from AMMP instead! customerprofilebyrevenue This data set is deprecated. Download related reports from AMMP instead! customerprofileby_geography This data set is deprecated. Download related reports from AMMP instead!
  • destination_s3_bucket_name: The name (friendly name, not ARN) of the destination S3 bucket.
  • role_name_arn: The Amazon Resource Name (ARN) of the Role with an attached permissions policy to interact with the provided AWS services.
  • sns_topic_arn: 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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "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.
  • "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.
Main.Marketplace_Commerce_Analytics.start_support_data_exportMethod
start_support_data_export(data_set_type, destination_s3_bucket_name, from_date, role_name_arn, sns_topic_arn)
start_support_data_export(data_set_type, destination_s3_bucket_name, from_date, role_name_arn, sns_topic_arn, params::Dict{String,<:Any})

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 {datasettype}_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.

Arguments

  • data_set_type: Specifies the data set type to be written to the output csv file. The data set types customersupportcontactsdata and testcustomersupportcontactsdata both result in a csv file containing the following fields: Product Id, Product Code, Customer Guid, Subscription Guid, Subscription Start Date, Organization, AWS Account Id, Given Name, Surname, Telephone Number, Email, Title, Country Code, ZIP Code, Operation Type, and Operation Time. customersupportcontactsdata Customer support contact data. The data set will contain all changes (Creates, Updates, and Deletes) to customer support contact data from the date specified in the fromdate parameter. testcustomersupportcontactsdata An example data set containing static test data in the same format as customersupportcontactsdata
  • destination_s3_bucket_name: The name (friendly name, not ARN) of the destination S3 bucket.
  • from_date: The start date from which to retrieve the data set in UTC. This parameter only affects the customersupportcontacts_data data set type.
  • role_name_arn: The Amazon Resource Name (ARN) of the Role with an attached permissions policy to interact with the provided AWS services.
  • sns_topic_arn: 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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "customerDefinedValues": (Optional) Key-value pairs which will be returned, unmodified, in the Amazon SNS notification message and the data set metadata file.
  • "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.