AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the StartSupportDataExport operation. 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.AWSMarketplaceCommerceAnalytics.AmazonAWSMarketplaceCommerceAnalyticsRequest
      Amazon.AWSMarketplaceCommerceAnalytics.Model.StartSupportDataExportRequest

Namespace: Amazon.AWSMarketplaceCommerceAnalytics.Model
Assembly: AWSSDK.AWSMarketplaceCommerceAnalytics.dll
Version: 3.x.y.z

Syntax

C#
public class StartSupportDataExportRequest : AmazonAWSMarketplaceCommerceAnalyticsRequest
         IAmazonWebServiceRequest

The StartSupportDataExportRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property CustomerDefinedValues System.Collections.Generic.Dictionary<System.String, System.String>

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

Public Property DataSetType Amazon.AWSMarketplaceCommerceAnalytics.SupportDataSetType

Gets and sets the property 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

Public Property DestinationS3BucketName System.String

Gets and sets the property DestinationS3BucketName. The name (friendly name, not ARN) of the destination S3 bucket.

Public Property DestinationS3Prefix System.String

Gets and sets the property 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.

Public Property FromDate System.DateTime

Gets and sets the property 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.

Public Property RoleNameArn System.String

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

Public Property SnsTopicArn System.String

Gets and sets the property 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.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms