AWS SDK for C++  1.8.51
AWS SDK for C++
Public Member Functions | List of all members
Aws::MarketplaceCommerceAnalytics::Model::StartSupportDataExportRequest Class Reference

#include <StartSupportDataExportRequest.h>

+ Inheritance diagram for Aws::MarketplaceCommerceAnalytics::Model::StartSupportDataExportRequest:

Public Member Functions

 StartSupportDataExportRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const SupportDataSetTypeGetDataSetType () const
 
bool DataSetTypeHasBeenSet () const
 
void SetDataSetType (const SupportDataSetType &value)
 
void SetDataSetType (SupportDataSetType &&value)
 
StartSupportDataExportRequestWithDataSetType (const SupportDataSetType &value)
 
StartSupportDataExportRequestWithDataSetType (SupportDataSetType &&value)
 
const Aws::Utils::DateTimeGetFromDate () const
 
bool FromDateHasBeenSet () const
 
void SetFromDate (const Aws::Utils::DateTime &value)
 
void SetFromDate (Aws::Utils::DateTime &&value)
 
StartSupportDataExportRequestWithFromDate (const Aws::Utils::DateTime &value)
 
StartSupportDataExportRequestWithFromDate (Aws::Utils::DateTime &&value)
 
const Aws::StringGetRoleNameArn () const
 
bool RoleNameArnHasBeenSet () const
 
void SetRoleNameArn (const Aws::String &value)
 
void SetRoleNameArn (Aws::String &&value)
 
void SetRoleNameArn (const char *value)
 
StartSupportDataExportRequestWithRoleNameArn (const Aws::String &value)
 
StartSupportDataExportRequestWithRoleNameArn (Aws::String &&value)
 
StartSupportDataExportRequestWithRoleNameArn (const char *value)
 
const Aws::StringGetDestinationS3BucketName () const
 
bool DestinationS3BucketNameHasBeenSet () const
 
void SetDestinationS3BucketName (const Aws::String &value)
 
void SetDestinationS3BucketName (Aws::String &&value)
 
void SetDestinationS3BucketName (const char *value)
 
StartSupportDataExportRequestWithDestinationS3BucketName (const Aws::String &value)
 
StartSupportDataExportRequestWithDestinationS3BucketName (Aws::String &&value)
 
StartSupportDataExportRequestWithDestinationS3BucketName (const char *value)
 
const Aws::StringGetDestinationS3Prefix () const
 
bool DestinationS3PrefixHasBeenSet () const
 
void SetDestinationS3Prefix (const Aws::String &value)
 
void SetDestinationS3Prefix (Aws::String &&value)
 
void SetDestinationS3Prefix (const char *value)
 
StartSupportDataExportRequestWithDestinationS3Prefix (const Aws::String &value)
 
StartSupportDataExportRequestWithDestinationS3Prefix (Aws::String &&value)
 
StartSupportDataExportRequestWithDestinationS3Prefix (const char *value)
 
const Aws::StringGetSnsTopicArn () const
 
bool SnsTopicArnHasBeenSet () const
 
void SetSnsTopicArn (const Aws::String &value)
 
void SetSnsTopicArn (Aws::String &&value)
 
void SetSnsTopicArn (const char *value)
 
StartSupportDataExportRequestWithSnsTopicArn (const Aws::String &value)
 
StartSupportDataExportRequestWithSnsTopicArn (Aws::String &&value)
 
StartSupportDataExportRequestWithSnsTopicArn (const char *value)
 
const Aws::Map< Aws::String, Aws::String > & GetCustomerDefinedValues () const
 
bool CustomerDefinedValuesHasBeenSet () const
 
void SetCustomerDefinedValues (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetCustomerDefinedValues (Aws::Map< Aws::String, Aws::String > &&value)
 
StartSupportDataExportRequestWithCustomerDefinedValues (const Aws::Map< Aws::String, Aws::String > &value)
 
StartSupportDataExportRequestWithCustomerDefinedValues (Aws::Map< Aws::String, Aws::String > &&value)
 
StartSupportDataExportRequestAddCustomerDefinedValues (const Aws::String &key, const Aws::String &value)
 
StartSupportDataExportRequestAddCustomerDefinedValues (Aws::String &&key, const Aws::String &value)
 
StartSupportDataExportRequestAddCustomerDefinedValues (const Aws::String &key, Aws::String &&value)
 
StartSupportDataExportRequestAddCustomerDefinedValues (Aws::String &&key, Aws::String &&value)
 
StartSupportDataExportRequestAddCustomerDefinedValues (const char *key, Aws::String &&value)
 
StartSupportDataExportRequestAddCustomerDefinedValues (Aws::String &&key, const char *value)
 
StartSupportDataExportRequestAddCustomerDefinedValues (const char *key, const char *value)
 
- Public Member Functions inherited from Aws::MarketplaceCommerceAnalytics::MarketplaceCommerceAnalyticsRequest
virtual ~MarketplaceCommerceAnalyticsRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Container for the parameters to the StartSupportDataExport operation.

See Also:

AWS API Reference

Definition at line 28 of file StartSupportDataExportRequest.h.

Constructor & Destructor Documentation

◆ StartSupportDataExportRequest()

Aws::MarketplaceCommerceAnalytics::Model::StartSupportDataExportRequest::StartSupportDataExportRequest ( )

Member Function Documentation

◆ AddCustomerDefinedValues() [1/7]

StartSupportDataExportRequest& Aws::MarketplaceCommerceAnalytics::Model::StartSupportDataExportRequest::AddCustomerDefinedValues ( const Aws::String key,
const Aws::String value 
)
inline

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

Definition at line 438 of file StartSupportDataExportRequest.h.

◆ AddCustomerDefinedValues() [2/7]

StartSupportDataExportRequest& Aws::MarketplaceCommerceAnalytics::Model::StartSupportDataExportRequest::AddCustomerDefinedValues ( Aws::String &&  key,
const Aws::String value 
)
inline

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

Definition at line 444 of file StartSupportDataExportRequest.h.

◆ AddCustomerDefinedValues() [3/7]

StartSupportDataExportRequest& Aws::MarketplaceCommerceAnalytics::Model::StartSupportDataExportRequest::AddCustomerDefinedValues ( const Aws::String key,
Aws::String &&  value 
)
inline

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

Definition at line 450 of file StartSupportDataExportRequest.h.

◆ AddCustomerDefinedValues() [4/7]

StartSupportDataExportRequest& Aws::MarketplaceCommerceAnalytics::Model::StartSupportDataExportRequest::AddCustomerDefinedValues ( Aws::String &&  key,
Aws::String &&  value 
)
inline

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

Definition at line 456 of file StartSupportDataExportRequest.h.

◆ AddCustomerDefinedValues() [5/7]

StartSupportDataExportRequest& Aws::MarketplaceCommerceAnalytics::Model::StartSupportDataExportRequest::AddCustomerDefinedValues ( const char *  key,
Aws::String &&  value 
)
inline

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

Definition at line 462 of file StartSupportDataExportRequest.h.

◆ AddCustomerDefinedValues() [6/7]

StartSupportDataExportRequest& Aws::MarketplaceCommerceAnalytics::Model::StartSupportDataExportRequest::AddCustomerDefinedValues ( Aws::String &&  key,
const char *  value 
)
inline

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

Definition at line 468 of file StartSupportDataExportRequest.h.

◆ AddCustomerDefinedValues() [7/7]

StartSupportDataExportRequest& Aws::MarketplaceCommerceAnalytics::Model::StartSupportDataExportRequest::AddCustomerDefinedValues ( const char *  key,
const char *  value 
)
inline

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

Definition at line 474 of file StartSupportDataExportRequest.h.

◆ CustomerDefinedValuesHasBeenSet()

bool Aws::MarketplaceCommerceAnalytics::Model::StartSupportDataExportRequest::CustomerDefinedValuesHasBeenSet ( ) const
inline

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

Definition at line 408 of file StartSupportDataExportRequest.h.

◆ DataSetTypeHasBeenSet()

bool Aws::MarketplaceCommerceAnalytics::Model::StartSupportDataExportRequest::DataSetTypeHasBeenSet ( ) const
inline

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

Definition at line 74 of file StartSupportDataExportRequest.h.

◆ DestinationS3BucketNameHasBeenSet()

bool Aws::MarketplaceCommerceAnalytics::Model::StartSupportDataExportRequest::DestinationS3BucketNameHasBeenSet ( ) const
inline

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

Definition at line 235 of file StartSupportDataExportRequest.h.

◆ DestinationS3PrefixHasBeenSet()

bool Aws::MarketplaceCommerceAnalytics::Model::StartSupportDataExportRequest::DestinationS3PrefixHasBeenSet ( ) const
inline

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

Definition at line 286 of file StartSupportDataExportRequest.h.

◆ FromDateHasBeenSet()

bool Aws::MarketplaceCommerceAnalytics::Model::StartSupportDataExportRequest::FromDateHasBeenSet ( ) const
inline

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

Definition at line 151 of file StartSupportDataExportRequest.h.

◆ GetCustomerDefinedValues()

const Aws::Map<Aws::String, Aws::String>& Aws::MarketplaceCommerceAnalytics::Model::StartSupportDataExportRequest::GetCustomerDefinedValues ( ) const
inline

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

Definition at line 402 of file StartSupportDataExportRequest.h.

◆ GetDataSetType()

const SupportDataSetType& Aws::MarketplaceCommerceAnalytics::Model::StartSupportDataExportRequest::GetDataSetType ( ) const
inline

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

Definition at line 58 of file StartSupportDataExportRequest.h.

◆ GetDestinationS3BucketName()

const Aws::String& Aws::MarketplaceCommerceAnalytics::Model::StartSupportDataExportRequest::GetDestinationS3BucketName ( ) const
inline

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

Definition at line 230 of file StartSupportDataExportRequest.h.

◆ GetDestinationS3Prefix()

const Aws::String& Aws::MarketplaceCommerceAnalytics::Model::StartSupportDataExportRequest::GetDestinationS3Prefix ( ) const
inline

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

Definition at line 276 of file StartSupportDataExportRequest.h.

◆ GetFromDate()

const Aws::Utils::DateTime& Aws::MarketplaceCommerceAnalytics::Model::StartSupportDataExportRequest::GetFromDate ( ) const
inline

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

Definition at line 145 of file StartSupportDataExportRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::MarketplaceCommerceAnalytics::Model::StartSupportDataExportRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetRoleNameArn()

const Aws::String& Aws::MarketplaceCommerceAnalytics::Model::StartSupportDataExportRequest::GetRoleNameArn ( ) const
inline

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

Definition at line 182 of file StartSupportDataExportRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::MarketplaceCommerceAnalytics::Model::StartSupportDataExportRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 37 of file StartSupportDataExportRequest.h.

◆ GetSnsTopicArn()

const Aws::String& Aws::MarketplaceCommerceAnalytics::Model::StartSupportDataExportRequest::GetSnsTopicArn ( ) const
inline

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.

Definition at line 353 of file StartSupportDataExportRequest.h.

◆ RoleNameArnHasBeenSet()

bool Aws::MarketplaceCommerceAnalytics::Model::StartSupportDataExportRequest::RoleNameArnHasBeenSet ( ) const
inline

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

Definition at line 188 of file StartSupportDataExportRequest.h.

◆ SerializePayload()

Aws::String Aws::MarketplaceCommerceAnalytics::Model::StartSupportDataExportRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetCustomerDefinedValues() [1/2]

void Aws::MarketplaceCommerceAnalytics::Model::StartSupportDataExportRequest::SetCustomerDefinedValues ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

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

Definition at line 414 of file StartSupportDataExportRequest.h.

◆ SetCustomerDefinedValues() [2/2]

void Aws::MarketplaceCommerceAnalytics::Model::StartSupportDataExportRequest::SetCustomerDefinedValues ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

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

Definition at line 420 of file StartSupportDataExportRequest.h.

◆ SetDataSetType() [1/2]

void Aws::MarketplaceCommerceAnalytics::Model::StartSupportDataExportRequest::SetDataSetType ( const SupportDataSetType value)
inline

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

Definition at line 90 of file StartSupportDataExportRequest.h.

◆ SetDataSetType() [2/2]

void Aws::MarketplaceCommerceAnalytics::Model::StartSupportDataExportRequest::SetDataSetType ( SupportDataSetType &&  value)
inline

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

Definition at line 106 of file StartSupportDataExportRequest.h.

◆ SetDestinationS3BucketName() [1/3]

void Aws::MarketplaceCommerceAnalytics::Model::StartSupportDataExportRequest::SetDestinationS3BucketName ( const Aws::String value)
inline

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

Definition at line 240 of file StartSupportDataExportRequest.h.

◆ SetDestinationS3BucketName() [2/3]

void Aws::MarketplaceCommerceAnalytics::Model::StartSupportDataExportRequest::SetDestinationS3BucketName ( Aws::String &&  value)
inline

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

Definition at line 245 of file StartSupportDataExportRequest.h.

◆ SetDestinationS3BucketName() [3/3]

void Aws::MarketplaceCommerceAnalytics::Model::StartSupportDataExportRequest::SetDestinationS3BucketName ( const char *  value)
inline

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

Definition at line 250 of file StartSupportDataExportRequest.h.

◆ SetDestinationS3Prefix() [1/3]

void Aws::MarketplaceCommerceAnalytics::Model::StartSupportDataExportRequest::SetDestinationS3Prefix ( const Aws::String value)
inline

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

Definition at line 296 of file StartSupportDataExportRequest.h.

◆ SetDestinationS3Prefix() [2/3]

void Aws::MarketplaceCommerceAnalytics::Model::StartSupportDataExportRequest::SetDestinationS3Prefix ( Aws::String &&  value)
inline

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

Definition at line 306 of file StartSupportDataExportRequest.h.

◆ SetDestinationS3Prefix() [3/3]

void Aws::MarketplaceCommerceAnalytics::Model::StartSupportDataExportRequest::SetDestinationS3Prefix ( const char *  value)
inline

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

Definition at line 316 of file StartSupportDataExportRequest.h.

◆ SetFromDate() [1/2]

void Aws::MarketplaceCommerceAnalytics::Model::StartSupportDataExportRequest::SetFromDate ( const Aws::Utils::DateTime value)
inline

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

Definition at line 157 of file StartSupportDataExportRequest.h.

◆ SetFromDate() [2/2]

void Aws::MarketplaceCommerceAnalytics::Model::StartSupportDataExportRequest::SetFromDate ( Aws::Utils::DateTime &&  value)
inline

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

Definition at line 163 of file StartSupportDataExportRequest.h.

◆ SetRoleNameArn() [1/3]

void Aws::MarketplaceCommerceAnalytics::Model::StartSupportDataExportRequest::SetRoleNameArn ( const Aws::String value)
inline

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

Definition at line 194 of file StartSupportDataExportRequest.h.

◆ SetRoleNameArn() [2/3]

void Aws::MarketplaceCommerceAnalytics::Model::StartSupportDataExportRequest::SetRoleNameArn ( Aws::String &&  value)
inline

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

Definition at line 200 of file StartSupportDataExportRequest.h.

◆ SetRoleNameArn() [3/3]

void Aws::MarketplaceCommerceAnalytics::Model::StartSupportDataExportRequest::SetRoleNameArn ( const char *  value)
inline

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

Definition at line 206 of file StartSupportDataExportRequest.h.

◆ SetSnsTopicArn() [1/3]

void Aws::MarketplaceCommerceAnalytics::Model::StartSupportDataExportRequest::SetSnsTopicArn ( const Aws::String value)
inline

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.

Definition at line 365 of file StartSupportDataExportRequest.h.

◆ SetSnsTopicArn() [2/3]

void Aws::MarketplaceCommerceAnalytics::Model::StartSupportDataExportRequest::SetSnsTopicArn ( Aws::String &&  value)
inline

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.

Definition at line 371 of file StartSupportDataExportRequest.h.

◆ SetSnsTopicArn() [3/3]

void Aws::MarketplaceCommerceAnalytics::Model::StartSupportDataExportRequest::SetSnsTopicArn ( const char *  value)
inline

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.

Definition at line 377 of file StartSupportDataExportRequest.h.

◆ SnsTopicArnHasBeenSet()

bool Aws::MarketplaceCommerceAnalytics::Model::StartSupportDataExportRequest::SnsTopicArnHasBeenSet ( ) const
inline

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.

Definition at line 359 of file StartSupportDataExportRequest.h.

◆ WithCustomerDefinedValues() [1/2]

StartSupportDataExportRequest& Aws::MarketplaceCommerceAnalytics::Model::StartSupportDataExportRequest::WithCustomerDefinedValues ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

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

Definition at line 426 of file StartSupportDataExportRequest.h.

◆ WithCustomerDefinedValues() [2/2]

StartSupportDataExportRequest& Aws::MarketplaceCommerceAnalytics::Model::StartSupportDataExportRequest::WithCustomerDefinedValues ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

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

Definition at line 432 of file StartSupportDataExportRequest.h.

◆ WithDataSetType() [1/2]

StartSupportDataExportRequest& Aws::MarketplaceCommerceAnalytics::Model::StartSupportDataExportRequest::WithDataSetType ( const SupportDataSetType value)
inline

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

Definition at line 122 of file StartSupportDataExportRequest.h.

◆ WithDataSetType() [2/2]

StartSupportDataExportRequest& Aws::MarketplaceCommerceAnalytics::Model::StartSupportDataExportRequest::WithDataSetType ( SupportDataSetType &&  value)
inline

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

Definition at line 138 of file StartSupportDataExportRequest.h.

◆ WithDestinationS3BucketName() [1/3]

StartSupportDataExportRequest& Aws::MarketplaceCommerceAnalytics::Model::StartSupportDataExportRequest::WithDestinationS3BucketName ( const Aws::String value)
inline

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

Definition at line 255 of file StartSupportDataExportRequest.h.

◆ WithDestinationS3BucketName() [2/3]

StartSupportDataExportRequest& Aws::MarketplaceCommerceAnalytics::Model::StartSupportDataExportRequest::WithDestinationS3BucketName ( Aws::String &&  value)
inline

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

Definition at line 260 of file StartSupportDataExportRequest.h.

◆ WithDestinationS3BucketName() [3/3]

StartSupportDataExportRequest& Aws::MarketplaceCommerceAnalytics::Model::StartSupportDataExportRequest::WithDestinationS3BucketName ( const char *  value)
inline

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

Definition at line 265 of file StartSupportDataExportRequest.h.

◆ WithDestinationS3Prefix() [1/3]

StartSupportDataExportRequest& Aws::MarketplaceCommerceAnalytics::Model::StartSupportDataExportRequest::WithDestinationS3Prefix ( const Aws::String value)
inline

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

Definition at line 326 of file StartSupportDataExportRequest.h.

◆ WithDestinationS3Prefix() [2/3]

StartSupportDataExportRequest& Aws::MarketplaceCommerceAnalytics::Model::StartSupportDataExportRequest::WithDestinationS3Prefix ( Aws::String &&  value)
inline

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

Definition at line 336 of file StartSupportDataExportRequest.h.

◆ WithDestinationS3Prefix() [3/3]

StartSupportDataExportRequest& Aws::MarketplaceCommerceAnalytics::Model::StartSupportDataExportRequest::WithDestinationS3Prefix ( const char *  value)
inline

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

Definition at line 346 of file StartSupportDataExportRequest.h.

◆ WithFromDate() [1/2]

StartSupportDataExportRequest& Aws::MarketplaceCommerceAnalytics::Model::StartSupportDataExportRequest::WithFromDate ( const Aws::Utils::DateTime value)
inline

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

Definition at line 169 of file StartSupportDataExportRequest.h.

◆ WithFromDate() [2/2]

StartSupportDataExportRequest& Aws::MarketplaceCommerceAnalytics::Model::StartSupportDataExportRequest::WithFromDate ( Aws::Utils::DateTime &&  value)
inline

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

Definition at line 175 of file StartSupportDataExportRequest.h.

◆ WithRoleNameArn() [1/3]

StartSupportDataExportRequest& Aws::MarketplaceCommerceAnalytics::Model::StartSupportDataExportRequest::WithRoleNameArn ( const Aws::String value)
inline

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

Definition at line 212 of file StartSupportDataExportRequest.h.

◆ WithRoleNameArn() [2/3]

StartSupportDataExportRequest& Aws::MarketplaceCommerceAnalytics::Model::StartSupportDataExportRequest::WithRoleNameArn ( Aws::String &&  value)
inline

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

Definition at line 218 of file StartSupportDataExportRequest.h.

◆ WithRoleNameArn() [3/3]

StartSupportDataExportRequest& Aws::MarketplaceCommerceAnalytics::Model::StartSupportDataExportRequest::WithRoleNameArn ( const char *  value)
inline

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

Definition at line 224 of file StartSupportDataExportRequest.h.

◆ WithSnsTopicArn() [1/3]

StartSupportDataExportRequest& Aws::MarketplaceCommerceAnalytics::Model::StartSupportDataExportRequest::WithSnsTopicArn ( const Aws::String value)
inline

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.

Definition at line 383 of file StartSupportDataExportRequest.h.

◆ WithSnsTopicArn() [2/3]

StartSupportDataExportRequest& Aws::MarketplaceCommerceAnalytics::Model::StartSupportDataExportRequest::WithSnsTopicArn ( Aws::String &&  value)
inline

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.

Definition at line 389 of file StartSupportDataExportRequest.h.

◆ WithSnsTopicArn() [3/3]

StartSupportDataExportRequest& Aws::MarketplaceCommerceAnalytics::Model::StartSupportDataExportRequest::WithSnsTopicArn ( const char *  value)
inline

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.

Definition at line 395 of file StartSupportDataExportRequest.h.


The documentation for this class was generated from the following file: