« blib/lib/Paws/MarketplaceCommerceAnalytics/CustomerDefinedValues.pm
↑ Summary
blib/lib/Paws/MarketplaceCommerceAnalytics/GenerateDataSetResult.pm »
| 1 | |||
| 2 | package Paws::MarketplaceCommerceAnalytics::GenerateDataSet; | ||
| 3 | use Moose; | ||
| 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 | use MooseX::ClassAttribute; | ||
| 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 L<Paws::MarketplaceCommerceAnalytics> | ||
| 24 | |||
| 25 | =head1 DESCRIPTION | ||
| 26 | |||
| 27 | This class represents the parameters used for calling the method GenerateDataSet on the | ||
| 28 | L<AWS Marketplace Commerce Analytics|Paws::MarketplaceCommerceAnalytics> 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 | =head1 SYNOPSIS | ||
| 34 | |||
| 35 | my $marketplacecommerceanalytics = Paws->service('MarketplaceCommerceAnalytics'); | ||
| 36 | my $GenerateDataSetResult = $marketplacecommerceanalytics->GenerateDataSet( | ||
| 37 | DataSetPublicationDate => '1970-01-01T01:00:00', | ||
| 38 | DataSetType => 'customer_subscriber_hourly_monthly_subscriptions', | ||
| 39 | DestinationS3BucketName => 'MyDestinationS3BucketName', | ||
| 40 | RoleNameArn => 'MyRoleNameArn', | ||
| 41 | SnsTopicArn => 'MySnsTopicArn', | ||
| 42 | CustomerDefinedValues => { | ||
| 43 | 'MyOptionalKey' => | ||
| 44 | 'MyOptionalValue', # key: min: 1, max: 255, value: min: 1, max: 255 | ||
| 45 | }, # OPTIONAL | ||
| 46 | DestinationS3Prefix => 'MyDestinationS3Prefix', # OPTIONAL | ||
| 47 | ); | ||
| 48 | |||
| 49 | # Results: | ||
| 50 | my $DataSetRequestId = $GenerateDataSetResult->DataSetRequestId; | ||
| 51 | |||
| 52 | # Returns a L<Paws::MarketplaceCommerceAnalytics::GenerateDataSetResult> object. | ||
| 53 | |||
| 54 | 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. | ||
| 55 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/marketplacecommerceanalytics/GenerateDataSet> | ||
| 56 | |||
| 57 | =head1 ATTRIBUTES | ||
| 58 | |||
| 59 | |||
| 60 | =head2 CustomerDefinedValues => L<Paws::MarketplaceCommerceAnalytics::CustomerDefinedValues> | ||
| 61 | |||
| 62 | (Optional) Key-value pairs which will be returned, unmodified, in the | ||
| 63 | Amazon SNS notification message and the data set metadata file. These | ||
| 64 | key-value pairs can be used to correlated responses with tracking | ||
| 65 | information from other systems. | ||
| 66 | |||
| 67 | |||
| 68 | |||
| 69 | =head2 B<REQUIRED> DataSetPublicationDate => Str | ||
| 70 | |||
| 71 | The date a data set was published. For daily data sets, provide a date | ||
| 72 | with day-level granularity for the desired day. For monthly data sets | ||
| 73 | except those with prefix disbursed_amount, provide a date with | ||
| 74 | month-level granularity for the desired month (the day value will be | ||
| 75 | ignored). For data sets with prefix disbursed_amount, provide a date | ||
| 76 | with day-level granularity for the desired day. For these data sets we | ||
| 77 | will look backwards in time over the range of 31 days until the first | ||
| 78 | data set is found (the latest one). | ||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | =head2 B<REQUIRED> DataSetType => Str | ||
| 83 | |||
| 84 | The desired data set type. | ||
| 85 | |||
| 86 | =over | ||
| 87 | |||
| 88 | =item * B<customer_subscriber_hourly_monthly_subscriptions> | ||
| 89 | |||
| 90 | From 2017-09-15 to present: Available daily by 24:00 UTC. | ||
| 91 | |||
| 92 | =item * B<customer_subscriber_annual_subscriptions> | ||
| 93 | |||
| 94 | From 2017-09-15 to present: Available daily by 24:00 UTC. | ||
| 95 | |||
| 96 | =item * B<daily_business_usage_by_instance_type> | ||
| 97 | |||
| 98 | From 2017-09-15 to present: Available daily by 24:00 UTC. | ||
| 99 | |||
| 100 | =item * B<daily_business_fees> | ||
| 101 | |||
| 102 | From 2017-09-15 to present: Available daily by 24:00 UTC. | ||
| 103 | |||
| 104 | =item * B<daily_business_free_trial_conversions> | ||
| 105 | |||
| 106 | From 2017-09-15 to present: Available daily by 24:00 UTC. | ||
| 107 | |||
| 108 | =item * B<daily_business_new_instances> | ||
| 109 | |||
| 110 | From 2017-09-15 to present: Available daily by 24:00 UTC. | ||
| 111 | |||
| 112 | =item * B<daily_business_new_product_subscribers> | ||
| 113 | |||
| 114 | From 2017-09-15 to present: Available daily by 24:00 UTC. | ||
| 115 | |||
| 116 | =item * B<daily_business_canceled_product_subscribers> | ||
| 117 | |||
| 118 | From 2017-09-15 to present: Available daily by 24:00 UTC. | ||
| 119 | |||
| 120 | =item * B<monthly_revenue_billing_and_revenue_data> | ||
| 121 | |||
| 122 | From 2017-09-15 to present: Available monthly on the 15th day of the | ||
| 123 | month by 24:00 UTC. Data includes metered transactions (e.g. hourly) | ||
| 124 | from one month prior. | ||
| 125 | |||
| 126 | =item * B<monthly_revenue_annual_subscriptions> | ||
| 127 | |||
| 128 | From 2017-09-15 to present: Available monthly on the 15th day of the | ||
| 129 | month by 24:00 UTC. Data includes up-front software charges (e.g. | ||
| 130 | annual) from one month prior. | ||
| 131 | |||
| 132 | =item * B<monthly_revenue_field_demonstration_usage> | ||
| 133 | |||
| 134 | From 2018-03-15 to present: Available monthly on the 15th day of the | ||
| 135 | month by 24:00 UTC. | ||
| 136 | |||
| 137 | =item * B<monthly_revenue_flexible_payment_schedule> | ||
| 138 | |||
| 139 | From 2018-11-15 to present: Available monthly on the 15th day of the | ||
| 140 | month by 24:00 UTC. | ||
| 141 | |||
| 142 | =item * B<disbursed_amount_by_product> | ||
| 143 | |||
| 144 | From 2017-09-15 to present: Available every 30 days by 24:00 UTC. | ||
| 145 | |||
| 146 | =item * B<disbursed_amount_by_instance_hours> | ||
| 147 | |||
| 148 | From 2017-09-15 to present: Available every 30 days by 24:00 UTC. | ||
| 149 | |||
| 150 | =item * B<disbursed_amount_by_customer_geo> | ||
| 151 | |||
| 152 | From 2017-09-15 to present: Available every 30 days by 24:00 UTC. | ||
| 153 | |||
| 154 | =item * B<disbursed_amount_by_age_of_uncollected_funds> | ||
| 155 | |||
| 156 | From 2017-09-15 to present: Available every 30 days by 24:00 UTC. | ||
| 157 | |||
| 158 | =item * B<disbursed_amount_by_age_of_disbursed_funds> | ||
| 159 | |||
| 160 | From 2017-09-15 to present: Available every 30 days by 24:00 UTC. | ||
| 161 | |||
| 162 | =item * B<disbursed_amount_by_age_of_past_due_funds> | ||
| 163 | |||
| 164 | From 2018-04-07 to present: Available every 30 days by 24:00 UTC. | ||
| 165 | |||
| 166 | =item * B<disbursed_amount_by_uncollected_funds_breakdown> | ||
| 167 | |||
| 168 | From 2019-10-04 to present: Available every 30 days by 24:00 UTC. | ||
| 169 | |||
| 170 | =item * B<sales_compensation_billed_revenue> | ||
| 171 | |||
| 172 | From 2017-09-15 to present: Available monthly on the 15th day of the | ||
| 173 | month by 24:00 UTC. Data includes metered transactions (e.g. hourly) | ||
| 174 | from one month prior, and up-front software charges (e.g. annual) from | ||
| 175 | one month prior. | ||
| 176 | |||
| 177 | =item * B<us_sales_and_use_tax_records> | ||
| 178 | |||
| 179 | From 2017-09-15 to present: Available monthly on the 15th day of the | ||
| 180 | month by 24:00 UTC. | ||
| 181 | |||
| 182 | =item * B<disbursed_amount_by_product_with_uncollected_funds> | ||
| 183 | |||
| 184 | This data set is deprecated. Download related reports from AMMP | ||
| 185 | instead! | ||
| 186 | |||
| 187 | =item * B<customer_profile_by_industry> | ||
| 188 | |||
| 189 | This data set is deprecated. Download related reports from AMMP | ||
| 190 | instead! | ||
| 191 | |||
| 192 | =item * B<customer_profile_by_revenue> | ||
| 193 | |||
| 194 | This data set is deprecated. Download related reports from AMMP | ||
| 195 | instead! | ||
| 196 | |||
| 197 | =item * B<customer_profile_by_geography> | ||
| 198 | |||
| 199 | This data set is deprecated. Download related reports from AMMP | ||
| 200 | instead! | ||
| 201 | |||
| 202 | =back | ||
| 203 | |||
| 204 | |||
| 205 | 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<"monthly_revenue_field_demonstration_usage">, C<"monthly_revenue_flexible_payment_schedule">, 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<"disbursed_amount_by_age_of_past_due_funds">, C<"disbursed_amount_by_uncollected_funds_breakdown">, 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"> | ||
| 206 | |||
| 207 | =head2 B<REQUIRED> DestinationS3BucketName => Str | ||
| 208 | |||
| 209 | The name (friendly name, not ARN) of the destination S3 bucket. | ||
| 210 | |||
| 211 | |||
| 212 | |||
| 213 | =head2 DestinationS3Prefix => Str | ||
| 214 | |||
| 215 | (Optional) The desired S3 prefix for the published data set, similar to | ||
| 216 | a directory path in standard file systems. For example, if given the | ||
| 217 | bucket name "mybucket" and the prefix "myprefix/mydatasets", the output | ||
| 218 | file "outputfile" would be published to | ||
| 219 | "s3://mybucket/myprefix/mydatasets/outputfile". If the prefix directory | ||
| 220 | structure does not exist, it will be created. If no prefix is provided, | ||
| 221 | the data set will be published to the S3 bucket root. | ||
| 222 | |||
| 223 | |||
| 224 | |||
| 225 | =head2 B<REQUIRED> RoleNameArn => Str | ||
| 226 | |||
| 227 | The Amazon Resource Name (ARN) of the Role with an attached permissions | ||
| 228 | policy to interact with the provided AWS services. | ||
| 229 | |||
| 230 | |||
| 231 | |||
| 232 | =head2 B<REQUIRED> SnsTopicArn => Str | ||
| 233 | |||
| 234 | Amazon Resource Name (ARN) for the SNS Topic that will be notified when | ||
| 235 | the data set has been published or if an error has occurred. | ||
| 236 | |||
| 237 | |||
| 238 | |||
| 239 | |||
| 240 | =head1 SEE ALSO | ||
| 241 | |||
| 242 | This class forms part of L<Paws>, documenting arguments for method GenerateDataSet in L<Paws::MarketplaceCommerceAnalytics> | ||
| 243 | |||
| 244 | =head1 BUGS and CONTRIBUTIONS | ||
| 245 | |||
| 246 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 247 | |||
| 248 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 249 | |||
| 250 | =cut | ||
| 251 |