« blib/lib/Paws/MarketplaceCommerceAnalytics/GenerateDataSetResult.pm
↑ Summary
blib/lib/Paws/MarketplaceCommerceAnalytics/StartSupportDataExportResult.pm »
| 1 | |||
| 2 | package Paws::MarketplaceCommerceAnalytics::StartSupportDataExport; | ||
| 3 | use Moose; | ||
| 4 | has CustomerDefinedValues => (is => 'ro', isa => 'Paws::MarketplaceCommerceAnalytics::CustomerDefinedValues', traits => ['NameInRequest'], request_name => 'customerDefinedValues' ); | ||
| 5 | has DataSetType => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'dataSetType' , required => 1); | ||
| 6 | has DestinationS3BucketName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'destinationS3BucketName' , required => 1); | ||
| 7 | has DestinationS3Prefix => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'destinationS3Prefix' ); | ||
| 8 | has FromDate => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'fromDate' , required => 1); | ||
| 9 | has RoleNameArn => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'roleNameArn' , required => 1); | ||
| 10 | has SnsTopicArn => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'snsTopicArn' , required => 1); | ||
| 11 | |||
| 12 | use MooseX::ClassAttribute; | ||
| 13 | |||
| 14 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'StartSupportDataExport'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::MarketplaceCommerceAnalytics::StartSupportDataExportResult'); | ||
| 16 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::MarketplaceCommerceAnalytics::StartSupportDataExport - Arguments for method StartSupportDataExport on L<Paws::MarketplaceCommerceAnalytics> | ||
| 24 | |||
| 25 | =head1 DESCRIPTION | ||
| 26 | |||
| 27 | This class represents the parameters used for calling the method StartSupportDataExport on the | ||
| 28 | L<AWS Marketplace Commerce Analytics|Paws::MarketplaceCommerceAnalytics> service. Use the attributes of this class | ||
| 29 | as arguments to method StartSupportDataExport. | ||
| 30 | |||
| 31 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to StartSupportDataExport. | ||
| 32 | |||
| 33 | =head1 SYNOPSIS | ||
| 34 | |||
| 35 | my $marketplacecommerceanalytics = Paws->service('MarketplaceCommerceAnalytics'); | ||
| 36 | my $StartSupportDataExportResult = | ||
| 37 | $marketplacecommerceanalytics->StartSupportDataExport( | ||
| 38 | DataSetType => 'customer_support_contacts_data', | ||
| 39 | DestinationS3BucketName => 'MyDestinationS3BucketName', | ||
| 40 | FromDate => '1970-01-01T01:00:00', | ||
| 41 | RoleNameArn => 'MyRoleNameArn', | ||
| 42 | SnsTopicArn => 'MySnsTopicArn', | ||
| 43 | CustomerDefinedValues => { | ||
| 44 | 'MyOptionalKey' => | ||
| 45 | 'MyOptionalValue', # key: min: 1, max: 255, value: min: 1, max: 255 | ||
| 46 | }, # OPTIONAL | ||
| 47 | DestinationS3Prefix => 'MyDestinationS3Prefix', # OPTIONAL | ||
| 48 | ); | ||
| 49 | |||
| 50 | # Results: | ||
| 51 | my $DataSetRequestId = $StartSupportDataExportResult->DataSetRequestId; | ||
| 52 | |||
| 53 | # Returns a L<Paws::MarketplaceCommerceAnalytics::StartSupportDataExportResult> object. | ||
| 54 | |||
| 55 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 56 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/marketplacecommerceanalytics/StartSupportDataExport> | ||
| 57 | |||
| 58 | =head1 ATTRIBUTES | ||
| 59 | |||
| 60 | |||
| 61 | =head2 CustomerDefinedValues => L<Paws::MarketplaceCommerceAnalytics::CustomerDefinedValues> | ||
| 62 | |||
| 63 | (Optional) Key-value pairs which will be returned, unmodified, in the | ||
| 64 | Amazon SNS notification message and the data set metadata file. | ||
| 65 | |||
| 66 | |||
| 67 | |||
| 68 | =head2 B<REQUIRED> DataSetType => Str | ||
| 69 | |||
| 70 | Specifies the data set type to be written to the output csv file. The | ||
| 71 | data set types customer_support_contacts_data and | ||
| 72 | test_customer_support_contacts_data both result in a csv file | ||
| 73 | containing the following fields: Product Id, Product Code, Customer | ||
| 74 | Guid, Subscription Guid, Subscription Start Date, Organization, AWS | ||
| 75 | Account Id, Given Name, Surname, Telephone Number, Email, Title, | ||
| 76 | Country Code, ZIP Code, Operation Type, and Operation Time. | ||
| 77 | |||
| 78 | =over | ||
| 79 | |||
| 80 | =item * I<customer_support_contacts_data> Customer support contact | ||
| 81 | data. The data set will contain all changes (Creates, Updates, and | ||
| 82 | Deletes) to customer support contact data from the date specified in | ||
| 83 | the from_date parameter. | ||
| 84 | |||
| 85 | =item * I<test_customer_support_contacts_data> An example data set | ||
| 86 | containing static test data in the same format as | ||
| 87 | customer_support_contacts_data | ||
| 88 | |||
| 89 | =back | ||
| 90 | |||
| 91 | |||
| 92 | Valid values are: C<"customer_support_contacts_data">, C<"test_customer_support_contacts_data"> | ||
| 93 | |||
| 94 | =head2 B<REQUIRED> DestinationS3BucketName => Str | ||
| 95 | |||
| 96 | The name (friendly name, not ARN) of the destination S3 bucket. | ||
| 97 | |||
| 98 | |||
| 99 | |||
| 100 | =head2 DestinationS3Prefix => Str | ||
| 101 | |||
| 102 | (Optional) The desired S3 prefix for the published data set, similar to | ||
| 103 | a directory path in standard file systems. For example, if given the | ||
| 104 | bucket name "mybucket" and the prefix "myprefix/mydatasets", the output | ||
| 105 | file "outputfile" would be published to | ||
| 106 | "s3://mybucket/myprefix/mydatasets/outputfile". If the prefix directory | ||
| 107 | structure does not exist, it will be created. If no prefix is provided, | ||
| 108 | the data set will be published to the S3 bucket root. | ||
| 109 | |||
| 110 | |||
| 111 | |||
| 112 | =head2 B<REQUIRED> FromDate => Str | ||
| 113 | |||
| 114 | The start date from which to retrieve the data set in UTC. This | ||
| 115 | parameter only affects the customer_support_contacts_data data set | ||
| 116 | type. | ||
| 117 | |||
| 118 | |||
| 119 | |||
| 120 | =head2 B<REQUIRED> RoleNameArn => Str | ||
| 121 | |||
| 122 | The Amazon Resource Name (ARN) of the Role with an attached permissions | ||
| 123 | policy to interact with the provided AWS services. | ||
| 124 | |||
| 125 | |||
| 126 | |||
| 127 | =head2 B<REQUIRED> SnsTopicArn => Str | ||
| 128 | |||
| 129 | Amazon Resource Name (ARN) for the SNS Topic that will be notified when | ||
| 130 | the data set has been published or if an error has occurred. | ||
| 131 | |||
| 132 | |||
| 133 | |||
| 134 | |||
| 135 | =head1 SEE ALSO | ||
| 136 | |||
| 137 | This class forms part of L<Paws>, documenting arguments for method StartSupportDataExport in L<Paws::MarketplaceCommerceAnalytics> | ||
| 138 | |||
| 139 | =head1 BUGS and CONTRIBUTIONS | ||
| 140 | |||
| 141 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 142 | |||
| 143 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 144 | |||
| 145 | =cut | ||
| 146 |