class Aws::MarketplaceCommerceAnalytics::Types::StartSupportDataExportRequest
Container for the parameters to the StartSupportDataExport operation.
@note When making an API call, you may pass StartSupportDataExportRequest
data as a hash: { data_set_type: "customer_support_contacts_data", # required, accepts customer_support_contacts_data, test_customer_support_contacts_data from_date: Time.now, # required role_name_arn: "RoleNameArn", # required destination_s3_bucket_name: "DestinationS3BucketName", # required destination_s3_prefix: "DestinationS3Prefix", sns_topic_arn: "SnsTopicArn", # required customer_defined_values: { "OptionalKey" => "OptionalValue", }, }
@!attribute [rw] data_set_type
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 @return [String]
@!attribute [rw] from_date
The start date from which to retrieve the data set in UTC. This parameter only affects the customer\_support\_contacts\_data data set type. @return [Time]
@!attribute [rw] role_name_arn
The Amazon Resource Name (ARN) of the Role with an attached permissions policy to interact with the provided AWS services. @return [String]
@!attribute [rw] destination_s3_bucket_name
The name (friendly name, not ARN) of the destination S3 bucket. @return [String]
@!attribute [rw] destination_s3_prefix
(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. @return [String]
@!attribute [rw] 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. @return [String]
@!attribute [rw] customer_defined_values
(Optional) Key-value pairs which will be returned, unmodified, in the Amazon SNS notification message and the data set metadata file. @return [Hash<String,String>]
@see docs.aws.amazon.com/goto/WebAPI/marketplacecommerceanalytics-2015-07-01/StartSupportDataExportRequest AWS API Documentation
Constants
- SENSITIVE