startSupportDataExport method

Future<StartSupportDataExportResult> startSupportDataExport({ required SupportDataSetType dataSetType, required String destinationS3BucketName, required DateTime fromDate, required String roleNameArn, required String snsTopicArn, Map<String, String>? customerDefinedValues, String? destinationS3Prefix, })

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.

May throw MarketplaceCommerceAnalyticsException.

Parameter dataSetType : Specifies the data set type to be written to the output csv file. The data set types customer_support_contacts_data and test_customer_support_contacts_data 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.

• customer_support_contacts_data 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 from_date parameter.
• test_customer_support_contacts_data An example data set containing static test data in the same format as customer_support_contacts_data

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

Parameter fromDate : The start date from which to retrieve the data set in UTC. This parameter only affects the customer_support_contacts_data data set type.

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.

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<StartSupportDataExportResult> startSupportDataExport({
  required SupportDataSetType dataSetType,
  required String destinationS3BucketName,
  required DateTime fromDate,
  required String roleNameArn,
  required String snsTopicArn,
  Map<String, String>? customerDefinedValues,
  String? destinationS3Prefix,
}) async {
  ArgumentError.checkNotNull(dataSetType, 'dataSetType');
  ArgumentError.checkNotNull(
      destinationS3BucketName, 'destinationS3BucketName');
  _s.validateStringLength(
    'destinationS3BucketName',
    destinationS3BucketName,
    1,
    1152921504606846976,
    isRequired: true,
  );
  ArgumentError.checkNotNull(fromDate, 'fromDate');
  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.StartSupportDataExport'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'dataSetType': dataSetType.toValue(),
      'destinationS3BucketName': destinationS3BucketName,
      'fromDate': unixTimestampToJson(fromDate),
      'roleNameArn': roleNameArn,
      'snsTopicArn': snsTopicArn,
      if (customerDefinedValues != null)
        'customerDefinedValues': customerDefinedValues,
      if (destinationS3Prefix != null)
        'destinationS3Prefix': destinationS3Prefix,
    },
  );

  return StartSupportDataExportResult.fromJson(jsonResponse.body);
}