/ 
Paws-0.22
River stage two • 9 direct dependents • 11 total dependents
⭐ Starred 171 GitHub stars
/ Paws::MarketplaceCommerceAnalytics::GenerateDataSet

NAME

Paws::MarketplaceCommerceAnalytics::GenerateDataSet - Arguments for method GenerateDataSet on Paws::MarketplaceCommerceAnalytics

DESCRIPTION

This class represents the parameters used for calling the method GenerateDataSet on the AWS Marketplace Commerce Analytics service. Use the attributes of this class as arguments to method GenerateDataSet.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GenerateDataSet.

As an example:

$service_obj->GenerateDataSet(Att1 => $value1, Att2 => $value2, ...);

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.

ATTRIBUTES

CustomerDefinedValues => Paws::MarketplaceCommerceAnalytics::CustomerDefinedValues

(Optional) Key-value pairs which will be returned, unmodified, in the Amazon SNS notification message and the data set metadata file. These key-value pairs can be used to correlated responses with tracking information from other systems.

REQUIRED DataSetPublicationDate => Str

The date a data set was published. For daily data sets, provide a date with day-level granularity for the desired day. For weekly data sets, provide a date with day-level granularity within the desired week (the day value will be ignored). For monthly data sets, provide a date with month-level granularity for the desired month (the day value will be ignored).

REQUIRED DataSetType => Str

The desired data set type.

  • customer_subscriber_hourly_monthly_subscriptions - Available daily by 5:00 PM Pacific Time since 2014-07-21.

  • customer_subscriber_annual_subscriptions - Available daily by 5:00 PM Pacific Time since 2014-07-21.

  • daily_business_usage_by_instance_type - Available daily by 5:00 PM Pacific Time since 2015-01-26.

  • daily_business_fees - Available daily by 5:00 PM Pacific Time since 2015-01-26.

  • daily_business_free_trial_conversions - Available daily by 5:00 PM Pacific Time since 2015-01-26.

  • daily_business_new_instances - Available daily by 5:00 PM Pacific Time since 2015-01-26.

  • daily_business_new_product_subscribers - Available daily by 5:00 PM Pacific Time since 2015-01-26.

  • daily_business_canceled_product_subscribers - Available daily by 5:00 PM Pacific Time since 2015-01-26.

  • monthly_revenue_billing_and_revenue_data - Available monthly on the 4th day of the month by 5:00 PM Pacific Time since 2015-02.

  • monthly_revenue_annual_subscriptions - Available monthly on the 4th day of the month by 5:00 PM Pacific Time since 2015-02.

  • disbursed_amount_by_product - Available every 30 days by 5:00 PM Pacific Time since 2015-01-26.

  • disbursed_amount_by_product_with_uncollected_funds -This data set is only available from 2012-04-19 until 2015-01-25. After 2015-01-25, this data set was split into three data sets: disbursed_amount_by_product, disbursed_amount_by_age_of_uncollected_funds, and disbursed_amount_by_age_of_disbursed_funds.

  • disbursed_amount_by_customer_geo - Available every 30 days by 5:00 PM Pacific Time since 2012-04-19.

  • disbursed_amount_by_age_of_uncollected_funds - Available every 30 days by 5:00 PM Pacific Time since 2015-01-26.

  • disbursed_amount_by_age_of_disbursed_funds - Available every 30 days by 5:00 PM Pacific Time since 2015-01-26.

  • customer_profile_by_industry - Available daily by 5:00 PM Pacific Time since 2015-10-01.

  • customer_profile_by_revenue - Available daily by 5:00 PM Pacific Time since 2015-10-01.

  • customer_profile_by_geography - Available daily by 5:00 PM Pacific Time since 2015-10-01.

Valid values are: "customer_subscriber_hourly_monthly_subscriptions", "customer_subscriber_annual_subscriptions", "daily_business_usage_by_instance_type", "daily_business_fees", "daily_business_free_trial_conversions", "daily_business_new_instances", "daily_business_new_product_subscribers", "daily_business_canceled_product_subscribers", "monthly_revenue_billing_and_revenue_data", "monthly_revenue_annual_subscriptions", "disbursed_amount_by_product", "disbursed_amount_by_product_with_uncollected_funds", "disbursed_amount_by_customer_geo", "disbursed_amount_by_age_of_uncollected_funds", "disbursed_amount_by_age_of_disbursed_funds", "customer_profile_by_industry", "customer_profile_by_revenue", "customer_profile_by_geography"

REQUIRED DestinationS3BucketName => Str

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

DestinationS3Prefix => Str

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

REQUIRED RoleNameArn => Str

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

REQUIRED SnsTopicArn => Str

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.

SEE ALSO

This class forms part of Paws, documenting arguments for method GenerateDataSet in Paws::MarketplaceCommerceAnalytics

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues