Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface StartSupportDataExportRequest

Container for the parameters to the StartSupportDataExport operation.

Hierarchy

Index

Properties

Optional customerDefinedValues

customerDefinedValues: Record<string, string>

(Optional) Key-value pairs which will be returned, unmodified, in the Amazon SNS notification message and the data set metadata file.

dataSetType

dataSetType: SupportDataSetType | string | undefined

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

destinationS3BucketName

destinationS3BucketName: string | undefined

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

Optional destinationS3Prefix

destinationS3Prefix: undefined | string

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

fromDate

fromDate: Date | undefined

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

roleNameArn

roleNameArn: string | undefined

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

snsTopicArn

snsTopicArn: string | undefined

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.