File Coverage

blib/lib/Paws/MarketplaceCommerceAnalytics/GenerateDataSet.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::GenerateDataSet;
3 1     1   781 use Moose;
  1         4  
  1         11  
4             has CustomerDefinedValues => (is => 'ro', isa => 'Paws::MarketplaceCommerceAnalytics::CustomerDefinedValues', traits => ['NameInRequest'], request_name => 'customerDefinedValues' );
5             has DataSetPublicationDate => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'dataSetPublicationDate' , required => 1);
6             has DataSetType => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'dataSetType' , required => 1);
7             has DestinationS3BucketName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'destinationS3BucketName' , required => 1);
8             has DestinationS3Prefix => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'destinationS3Prefix' );
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   10188 use MooseX::ClassAttribute;
  1         7  
  1         16  
13              
14             class_has _api_call => (isa => 'Str', is => 'ro', default => 'GenerateDataSet');
15             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::MarketplaceCommerceAnalytics::GenerateDataSetResult');
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::GenerateDataSet - Arguments for method GenerateDataSet on Paws::MarketplaceCommerceAnalytics
24              
25             =head1 DESCRIPTION
26              
27             This class represents the parameters used for calling the method GenerateDataSet on the
28             AWS Marketplace Commerce Analytics service. Use the attributes of this class
29             as arguments to method GenerateDataSet.
30              
31             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GenerateDataSet.
32              
33             As an example:
34              
35             $service_obj->GenerateDataSet(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. These
46             key-value pairs can be used to correlated responses with tracking
47             information from other systems.
48              
49              
50              
51             =head2 B<REQUIRED> DataSetPublicationDate => Str
52              
53             The date a data set was published. For daily data sets, provide a date
54             with day-level granularity for the desired day. For weekly data sets,
55             provide a date with day-level granularity within the desired week (the
56             day value will be ignored). For monthly data sets, provide a date with
57             month-level granularity for the desired month (the day value will be
58             ignored).
59              
60              
61              
62             =head2 B<REQUIRED> DataSetType => Str
63              
64             The desired data set type.
65              
66             =over
67              
68             =item * B<customer_subscriber_hourly_monthly_subscriptions>
69              
70             From 2014-07-21 to present: Available daily by 5:00 PM Pacific Time.
71              
72             =item * B<customer_subscriber_annual_subscriptions>
73              
74             From 2014-07-21 to present: Available daily by 5:00 PM Pacific Time.
75              
76             =item * B<daily_business_usage_by_instance_type>
77              
78             From 2015-01-26 to present: Available daily by 5:00 PM Pacific Time.
79              
80             =item * B<daily_business_fees>
81              
82             From 2015-01-26 to present: Available daily by 5:00 PM Pacific Time.
83              
84             =item * B<daily_business_free_trial_conversions>
85              
86             From 2015-01-26 to present: Available daily by 5:00 PM Pacific Time.
87              
88             =item * B<daily_business_new_instances>
89              
90             From 2015-01-26 to present: Available daily by 5:00 PM Pacific Time.
91              
92             =item * B<daily_business_new_product_subscribers>
93              
94             From 2015-01-26 to present: Available daily by 5:00 PM Pacific Time.
95              
96             =item * B<daily_business_canceled_product_subscribers>
97              
98             From 2015-01-26 to present: Available daily by 5:00 PM Pacific Time.
99              
100             =item * B<monthly_revenue_billing_and_revenue_data>
101              
102             From 2015-02 to 2017-06: Available monthly on the 4th day of the month
103             by 5:00pm Pacific Time. Data includes metered transactions (e.g.
104             hourly) from two months prior.
105              
106             From 2017-07 to present: Available monthly on the 15th day of the month
107             by 5:00pm Pacific Time. Data includes metered transactions (e.g.
108             hourly) from one month prior.
109              
110             =item * B<monthly_revenue_annual_subscriptions>
111              
112             From 2015-02 to 2017-06: Available monthly on the 4th day of the month
113             by 5:00pm Pacific Time. Data includes up-front software charges (e.g.
114             annual) from one month prior.
115              
116             From 2017-07 to present: Available monthly on the 15th day of the month
117             by 5:00pm Pacific Time. Data includes up-front software charges (e.g.
118             annual) from one month prior.
119              
120             =item * B<disbursed_amount_by_product>
121              
122             From 2015-01-26 to present: Available every 30 days by 5:00 PM Pacific
123             Time.
124              
125             =item * B<disbursed_amount_by_product_with_uncollected_funds>
126              
127             From 2012-04-19 to 2015-01-25: Available every 30 days by 5:00 PM
128             Pacific Time.
129              
130             From 2015-01-26 to present: This data set was split into three data
131             sets: disbursed_amount_by_product,
132             disbursed_amount_by_age_of_uncollected_funds, and
133             disbursed_amount_by_age_of_disbursed_funds.
134              
135             =item * B<disbursed_amount_by_instance_hours>
136              
137             From 2012-09-04 to present: Available every 30 days by 5:00 PM Pacific
138             Time.
139              
140             =item * B<disbursed_amount_by_customer_geo>
141              
142             From 2012-04-19 to present: Available every 30 days by 5:00 PM Pacific
143             Time.
144              
145             =item * B<disbursed_amount_by_age_of_uncollected_funds>
146              
147             From 2015-01-26 to present: Available every 30 days by 5:00 PM Pacific
148             Time.
149              
150             =item * B<disbursed_amount_by_age_of_disbursed_funds>
151              
152             From 2015-01-26 to present: Available every 30 days by 5:00 PM Pacific
153             Time.
154              
155             =item * B<customer_profile_by_industry>
156              
157             From 2015-10-01 to 2017-06-29: Available daily by 5:00 PM Pacific Time.
158              
159             From 2017-06-30 to present: This data set is no longer available.
160              
161             =item * B<customer_profile_by_revenue>
162              
163             From 2015-10-01 to 2017-06-29: Available daily by 5:00 PM Pacific Time.
164              
165             From 2017-06-30 to present: This data set is no longer available.
166              
167             =item * B<customer_profile_by_geography>
168              
169             From 2015-10-01 to 2017-06-29: Available daily by 5:00 PM Pacific Time.
170              
171             From 2017-06-30 to present: This data set is no longer available.
172              
173             =item * B<sales_compensation_billed_revenue>
174              
175             From 2016-12 to 2017-06: Available monthly on the 4th day of the month
176             by 5:00pm Pacific Time. Data includes metered transactions (e.g.
177             hourly) from two months prior, and up-front software charges (e.g.
178             annual) from one month prior.
179              
180             From 2017-06 to present: Available monthly on the 15th day of the month
181             by 5:00pm Pacific Time. Data includes metered transactions (e.g.
182             hourly) from one month prior, and up-front software charges (e.g.
183             annual) from one month prior.
184              
185             =item * B<us_sales_and_use_tax_records>
186              
187             From 2017-02-15 to present: Available monthly on the 15th day of the
188             month by 5:00 PM Pacific Time.
189              
190             =back
191              
192              
193             Valid values are: C<"customer_subscriber_hourly_monthly_subscriptions">, C<"customer_subscriber_annual_subscriptions">, C<"daily_business_usage_by_instance_type">, C<"daily_business_fees">, C<"daily_business_free_trial_conversions">, C<"daily_business_new_instances">, C<"daily_business_new_product_subscribers">, C<"daily_business_canceled_product_subscribers">, C<"monthly_revenue_billing_and_revenue_data">, C<"monthly_revenue_annual_subscriptions">, C<"disbursed_amount_by_product">, C<"disbursed_amount_by_product_with_uncollected_funds">, C<"disbursed_amount_by_instance_hours">, C<"disbursed_amount_by_customer_geo">, C<"disbursed_amount_by_age_of_uncollected_funds">, C<"disbursed_amount_by_age_of_disbursed_funds">, C<"customer_profile_by_industry">, C<"customer_profile_by_revenue">, C<"customer_profile_by_geography">, C<"sales_compensation_billed_revenue">, C<"us_sales_and_use_tax_records">
194              
195             =head2 B<REQUIRED> DestinationS3BucketName => Str
196              
197             The name (friendly name, not ARN) of the destination S3 bucket.
198              
199              
200              
201             =head2 DestinationS3Prefix => Str
202              
203             (Optional) The desired S3 prefix for the published data set, similar to
204             a directory path in standard file systems. For example, if given the
205             bucket name "mybucket" and the prefix "myprefix/mydatasets", the output
206             file "outputfile" would be published to
207             "s3://mybucket/myprefix/mydatasets/outputfile". If the prefix directory
208             structure does not exist, it will be created. If no prefix is provided,
209             the data set will be published to the S3 bucket root.
210              
211              
212              
213             =head2 B<REQUIRED> RoleNameArn => Str
214              
215             The Amazon Resource Name (ARN) of the Role with an attached permissions
216             policy to interact with the provided AWS services.
217              
218              
219              
220             =head2 B<REQUIRED> SnsTopicArn => Str
221              
222             Amazon Resource Name (ARN) for the SNS Topic that will be notified when
223             the data set has been published or if an error has occurred.
224              
225              
226              
227              
228             =head1 SEE ALSO
229              
230             This class forms part of L<Paws>, documenting arguments for method GenerateDataSet in L<Paws::MarketplaceCommerceAnalytics>
231              
232             =head1 BUGS and CONTRIBUTIONS
233              
234             The source code is located here: https://github.com/pplu/aws-sdk-perl
235              
236             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
237              
238             =cut
239