You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::MarketplaceCommerceAnalytics::Types::StartSupportDataExportRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-marketplacecommerceanalytics/lib/aws-sdk-marketplacecommerceanalytics/types.rb

Overview

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",
  },
}

Container for the parameters to the StartSupportDataExport operation.

Instance Attribute Summary collapse

Instance Attribute Details

#customer_defined_valuesHash<String,String>

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

Returns:

  • (Hash<String,String>)


284
285
286
287
288
289
290
291
292
293
# File 'gems/aws-sdk-marketplacecommerceanalytics/lib/aws-sdk-marketplacecommerceanalytics/types.rb', line 284

class StartSupportDataExportRequest < Struct.new(
  :data_set_type,
  :from_date,
  :role_name_arn,
  :destination_s3_bucket_name,
  :destination_s3_prefix,
  :sns_topic_arn,
  :customer_defined_values)
  include Aws::Structure
end

#data_set_typeString

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

Returns:

  • (String)


284
285
286
287
288
289
290
291
292
293
# File 'gems/aws-sdk-marketplacecommerceanalytics/lib/aws-sdk-marketplacecommerceanalytics/types.rb', line 284

class StartSupportDataExportRequest < Struct.new(
  :data_set_type,
  :from_date,
  :role_name_arn,
  :destination_s3_bucket_name,
  :destination_s3_prefix,
  :sns_topic_arn,
  :customer_defined_values)
  include Aws::Structure
end

#destination_s3_bucket_nameString

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

Returns:

  • (String)


284
285
286
287
288
289
290
291
292
293
# File 'gems/aws-sdk-marketplacecommerceanalytics/lib/aws-sdk-marketplacecommerceanalytics/types.rb', line 284

class StartSupportDataExportRequest < Struct.new(
  :data_set_type,
  :from_date,
  :role_name_arn,
  :destination_s3_bucket_name,
  :destination_s3_prefix,
  :sns_topic_arn,
  :customer_defined_values)
  include Aws::Structure
end

#destination_s3_prefixString

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

Returns:

  • (String)


284
285
286
287
288
289
290
291
292
293
# File 'gems/aws-sdk-marketplacecommerceanalytics/lib/aws-sdk-marketplacecommerceanalytics/types.rb', line 284

class StartSupportDataExportRequest < Struct.new(
  :data_set_type,
  :from_date,
  :role_name_arn,
  :destination_s3_bucket_name,
  :destination_s3_prefix,
  :sns_topic_arn,
  :customer_defined_values)
  include Aws::Structure
end

#from_dateTime

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

Returns:

  • (Time)


284
285
286
287
288
289
290
291
292
293
# File 'gems/aws-sdk-marketplacecommerceanalytics/lib/aws-sdk-marketplacecommerceanalytics/types.rb', line 284

class StartSupportDataExportRequest < Struct.new(
  :data_set_type,
  :from_date,
  :role_name_arn,
  :destination_s3_bucket_name,
  :destination_s3_prefix,
  :sns_topic_arn,
  :customer_defined_values)
  include Aws::Structure
end

#role_name_arnString

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

Returns:

  • (String)


284
285
286
287
288
289
290
291
292
293
# File 'gems/aws-sdk-marketplacecommerceanalytics/lib/aws-sdk-marketplacecommerceanalytics/types.rb', line 284

class StartSupportDataExportRequest < Struct.new(
  :data_set_type,
  :from_date,
  :role_name_arn,
  :destination_s3_bucket_name,
  :destination_s3_prefix,
  :sns_topic_arn,
  :customer_defined_values)
  include Aws::Structure
end

#sns_topic_arnString

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.

Returns:

  • (String)


284
285
286
287
288
289
290
291
292
293
# File 'gems/aws-sdk-marketplacecommerceanalytics/lib/aws-sdk-marketplacecommerceanalytics/types.rb', line 284

class StartSupportDataExportRequest < Struct.new(
  :data_set_type,
  :from_date,
  :role_name_arn,
  :destination_s3_bucket_name,
  :destination_s3_prefix,
  :sns_topic_arn,
  :customer_defined_values)
  include Aws::Structure
end