generateDataSet method

Future<GenerateDataSetResult> generateDataSet({
  1. required DateTime dataSetPublicationDate,
  2. required DataSetType dataSetType,
  3. required String destinationS3BucketName,
  4. required String roleNameArn,
  5. required String snsTopicArn,
  6. Map<String, String>? customerDefinedValues,
  7. String? destinationS3Prefix,
})

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.

May throw MarketplaceCommerceAnalyticsException.

Parameter dataSetPublicationDate : 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 disbursed_amount, provide a date with month-level granularity for the desired month (the day value will be ignored). For data sets with prefix disbursed_amount, 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).

Parameter dataSetType : The desired data set type.

  • customer_subscriber_hourly_monthly_subscriptions From 2017-09-15 to present: Available daily by 24:00 UTC.
  • customer_subscriber_annual_subscriptions From 2017-09-15 to present: Available daily by 24:00 UTC.
  • daily_business_usage_by_instance_type From 2017-09-15 to present: Available daily by 24:00 UTC.
  • daily_business_fees From 2017-09-15 to present: Available daily by 24:00 UTC.
  • daily_business_free_trial_conversions From 2017-09-15 to present: Available daily by 24:00 UTC.
  • daily_business_new_instances From 2017-09-15 to present: Available daily by 24:00 UTC.
  • daily_business_new_product_subscribers From 2017-09-15 to present: Available daily by 24:00 UTC.
  • daily_business_canceled_product_subscribers From 2017-09-15 to present: Available daily by 24:00 UTC.
  • monthly_revenue_billing_and_revenue_data 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.
  • monthly_revenue_annual_subscriptions 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.
  • monthly_revenue_field_demonstration_usage From 2018-03-15 to present: Available monthly on the 15th day of the month by 24:00 UTC.
  • monthly_revenue_flexible_payment_schedule From 2018-11-15 to present: Available monthly on the 15th day of the month by 24:00 UTC.
  • disbursed_amount_by_product From 2017-09-15 to present: Available every 30 days by 24:00 UTC.
  • disbursed_amount_by_instance_hours From 2017-09-15 to present: Available every 30 days by 24:00 UTC.
  • disbursed_amount_by_customer_geo From 2017-09-15 to present: Available every 30 days by 24:00 UTC.
  • disbursed_amount_by_age_of_uncollected_funds From 2017-09-15 to present: Available every 30 days by 24:00 UTC.
  • disbursed_amount_by_age_of_disbursed_funds From 2017-09-15 to present: Available every 30 days by 24:00 UTC.
  • disbursed_amount_by_age_of_past_due_funds From 2018-04-07 to present: Available every 30 days by 24:00 UTC.
  • disbursed_amount_by_uncollected_funds_breakdown From 2019-10-04 to present: Available every 30 days by 24:00 UTC.
  • sales_compensation_billed_revenue 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.
  • us_sales_and_use_tax_records From 2017-09-15 to present: Available monthly on the 15th day of the month by 24:00 UTC.
  • disbursed_amount_by_product_with_uncollected_funds This data set is deprecated. Download related reports from AMMP instead!
  • customer_profile_by_industry This data set is deprecated. Download related reports from AMMP instead!
  • customer_profile_by_revenue This data set is deprecated. Download related reports from AMMP instead!
  • customer_profile_by_geography This data set is deprecated. Download related reports from AMMP instead!

Parameter destinationS3BucketName : The name (friendly name, not ARN) of the destination S3 bucket.

Parameter roleNameArn : The Amazon Resource Name (ARN) of the Role with an attached permissions policy to interact with the provided AWS services.

Parameter snsTopicArn : 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.

Parameter 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.

Parameter 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.

Implementation

Future<GenerateDataSetResult> generateDataSet({
  required DateTime dataSetPublicationDate,
  required DataSetType dataSetType,
  required String destinationS3BucketName,
  required String roleNameArn,
  required String snsTopicArn,
  Map<String, String>? customerDefinedValues,
  String? destinationS3Prefix,
}) async {
  ArgumentError.checkNotNull(
      dataSetPublicationDate, 'dataSetPublicationDate');
  ArgumentError.checkNotNull(dataSetType, 'dataSetType');
  ArgumentError.checkNotNull(
      destinationS3BucketName, 'destinationS3BucketName');
  _s.validateStringLength(
    'destinationS3BucketName',
    destinationS3BucketName,
    1,
    1152921504606846976,
    isRequired: true,
  );
  ArgumentError.checkNotNull(roleNameArn, 'roleNameArn');
  _s.validateStringLength(
    'roleNameArn',
    roleNameArn,
    1,
    1152921504606846976,
    isRequired: true,
  );
  ArgumentError.checkNotNull(snsTopicArn, 'snsTopicArn');
  _s.validateStringLength(
    'snsTopicArn',
    snsTopicArn,
    1,
    1152921504606846976,
    isRequired: true,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'MarketplaceCommerceAnalytics20150701.GenerateDataSet'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'dataSetPublicationDate': unixTimestampToJson(dataSetPublicationDate),
      'dataSetType': dataSetType.toValue(),
      'destinationS3BucketName': destinationS3BucketName,
      'roleNameArn': roleNameArn,
      'snsTopicArn': snsTopicArn,
      if (customerDefinedValues != null)
        'customerDefinedValues': customerDefinedValues,
      if (destinationS3Prefix != null)
        'destinationS3Prefix': destinationS3Prefix,
    },
  );

  return GenerateDataSetResult.fromJson(jsonResponse.body);
}