File Coverage

blib/lib/Paws/MarketplaceCommerceAnalytics/StartSupportDataExport.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::MarketplaceCommerceAnalytics::StartSupportDataExport;
3 1     1   532 use Moose;
  1         2  
  1         9  
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 1     1   7209 use MooseX::ClassAttribute;
  1         3  
  1         15  
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 Paws::MarketplaceCommerceAnalytics
24              
25             =head1 DESCRIPTION
26              
27             This class represents the parameters used for calling the method StartSupportDataExport on the
28             AWS Marketplace Commerce Analytics 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             As an example:
34              
35             $service_obj->StartSupportDataExport(Att1 => $value1, Att2 => $value2, ...);
36              
37             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.
38              
39             =head1 ATTRIBUTES
40              
41              
42             =head2 CustomerDefinedValues => L<Paws::MarketplaceCommerceAnalytics::CustomerDefinedValues>
43              
44             (Optional) Key-value pairs which will be returned, unmodified, in the
45             Amazon SNS notification message and the data set metadata file.
46              
47              
48              
49             =head2 B<REQUIRED> DataSetType => Str
50              
51             Specifies the data set type to be written to the output csv file. The
52             data set types customer_support_contacts_data and
53             test_customer_support_contacts_data both result in a csv file
54             containing the following fields: Product Id, Product Code, Customer
55             Guid, Subscription Guid, Subscription Start Date, Organization, AWS
56             Account Id, Given Name, Surname, Telephone Number, Email, Title,
57             Country Code, ZIP Code, Operation Type, and Operation Time.
58              
59             =over
60              
61             =item * I<customer_support_contacts_data> Customer support contact
62             data. The data set will contain all changes (Creates, Updates, and
63             Deletes) to customer support contact data from the date specified in
64             the from_date parameter.
65              
66             =item * I<test_customer_support_contacts_data> An example data set
67             containing static test data in the same format as
68             customer_support_contacts_data
69              
70             =back
71              
72              
73             Valid values are: C<"customer_support_contacts_data">, C<"test_customer_support_contacts_data">
74              
75             =head2 B<REQUIRED> DestinationS3BucketName => Str
76              
77             The name (friendly name, not ARN) of the destination S3 bucket.
78              
79              
80              
81             =head2 DestinationS3Prefix => Str
82              
83             (Optional) The desired S3 prefix for the published data set, similar to
84             a directory path in standard file systems. For example, if given the
85             bucket name "mybucket" and the prefix "myprefix/mydatasets", the output
86             file "outputfile" would be published to
87             "s3://mybucket/myprefix/mydatasets/outputfile". If the prefix directory
88             structure does not exist, it will be created. If no prefix is provided,
89             the data set will be published to the S3 bucket root.
90              
91              
92              
93             =head2 B<REQUIRED> FromDate => Str
94              
95             The start date from which to retrieve the data set in UTC. This
96             parameter only affects the customer_support_contacts_data data set
97             type.
98              
99              
100              
101             =head2 B<REQUIRED> RoleNameArn => Str
102              
103             The Amazon Resource Name (ARN) of the Role with an attached permissions
104             policy to interact with the provided AWS services.
105              
106              
107              
108             =head2 B<REQUIRED> SnsTopicArn => Str
109              
110             Amazon Resource Name (ARN) for the SNS Topic that will be notified when
111             the data set has been published or if an error has occurred.
112              
113              
114              
115              
116             =head1 SEE ALSO
117              
118             This class forms part of L<Paws>, documenting arguments for method StartSupportDataExport in L<Paws::MarketplaceCommerceAnalytics>
119              
120             =head1 BUGS and CONTRIBUTIONS
121              
122             The source code is located here: https://github.com/pplu/aws-sdk-perl
123              
124             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
125              
126             =cut
127