You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::MarketplaceCommerceAnalytics::Types::GenerateDataSetRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-marketplacecommerceanalytics/lib/aws-sdk-marketplacecommerceanalytics/types.rb

Overview

Note:

When making an API call, you may pass GenerateDataSetRequest data as a hash:

{
  data_set_type: "customer_subscriber_hourly_monthly_subscriptions", # required, accepts 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_instance_hours, 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, sales_compensation_billed_revenue, us_sales_and_use_tax_records
  data_set_publication_date: Time.now, # required
  role_name_arn: "RoleNameArn", # required
  destination_s3_bucket_name: "DestinationS3BucketName", # required
  destination_s3_prefix: "DestinationS3Prefix",
  sns_topic_arn: "SnsTopicArn", # required
  customer_defined_values: {
    "OptionalKey" => "OptionalValue",
  },
}

Container for the parameters to the GenerateDataSet operation.

Instance Attribute Summary collapse

Instance Attribute Details

#customer_defined_valuesHash<String,String>

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

Returns:

  • (Hash<String,String>)


186
187
188
189
190
191
192
193
194
195
# File 'gems/aws-sdk-marketplacecommerceanalytics/lib/aws-sdk-marketplacecommerceanalytics/types.rb', line 186

class GenerateDataSetRequest < Struct.new(
  :data_set_type,
  :data_set_publication_date,
  :role_name_arn,
  :destination_s3_bucket_name,
  :destination_s3_prefix,
  :sns_topic_arn,
  :customer_defined_values)
  include Aws::Structure
end

#data_set_publication_dateTime

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

Returns:

  • (Time)


186
187
188
189
190
191
192
193
194
195
# File 'gems/aws-sdk-marketplacecommerceanalytics/lib/aws-sdk-marketplacecommerceanalytics/types.rb', line 186

class GenerateDataSetRequest < Struct.new(
  :data_set_type,
  :data_set_publication_date,
  :role_name_arn,
  :destination_s3_bucket_name,
  :destination_s3_prefix,
  :sns_topic_arn,
  :customer_defined_values)
  include Aws::Structure
end

#data_set_typeString

The desired data set type.

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

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

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

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

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

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

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

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

  • monthly_revenue_billing_and_revenue_data From 2015-02 to 2017-06: Available monthly on the 4th day of the month by 5:00pm Pacific Time. Data includes metered transactions (e.g. hourly) from two months prior.

    From 2017-07 to present: Available monthly on the 15th day of the month by 5:00pm Pacific Time. Data includes metered transactions (e.g. hourly) from one month prior.

  • monthly_revenue_annual_subscriptions From 2015-02 to 2017-06: Available monthly on the 4th day of the month by 5:00pm Pacific Time. Data includes up-front software charges (e.g. annual) from one month prior.

    From 2017-07 to present: Available monthly on the 15th day of the month by 5:00pm Pacific Time. Data includes up-front software charges (e.g. annual) from one month prior.

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

  • disbursed_amount_by_product_with_uncollected_funds From 2012-04-19 to 2015-01-25: Available every 30 days by 5:00 PM Pacific Time.

    From 2015-01-26 to present: 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_instance_hours From 2012-09-04 to present: Available every 30 days by 5:00 PM Pacific Time.

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

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

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

  • customer_profile_by_industry From 2015-10-01 to 2017-06-29: Available daily by 5:00 PM Pacific Time.

    From 2017-06-30 to present: This data set is no longer available.

  • customer_profile_by_revenue From 2015-10-01 to 2017-06-29: Available daily by 5:00 PM Pacific Time.

    From 2017-06-30 to present: This data set is no longer available.

  • customer_profile_by_geography From 2015-10-01 to 2017-06-29: Available daily by 5:00 PM Pacific Time.

    From 2017-06-30 to present: This data set is no longer available.

  • sales_compensation_billed_revenue From 2016-12 to 2017-06: Available monthly on the 4th day of the month by 5:00pm Pacific Time. Data includes metered transactions (e.g. hourly) from two months prior, and up-front software charges (e.g. annual) from one month prior.

    From 2017-06 to present: Available monthly on the 15th day of the month by 5:00pm Pacific Time. Data includes metered transactions (e.g. hourly) from one month prior, and up-front software charges (e.g. annual) from one month prior.

  • us_sales_and_use_tax_records From 2017-02-15 to present: Available monthly on the 15th day of the month by 5:00 PM Pacific Time.

Returns:

  • (String)


186
187
188
189
190
191
192
193
194
195
# File 'gems/aws-sdk-marketplacecommerceanalytics/lib/aws-sdk-marketplacecommerceanalytics/types.rb', line 186

class GenerateDataSetRequest < Struct.new(
  :data_set_type,
  :data_set_publication_date,
  :role_name_arn,
  :destination_s3_bucket_name,
  :destination_s3_prefix,
  :sns_topic_arn,
  :customer_defined_values)
  include Aws::Structure
end

#destination_s3_bucket_nameString

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

Returns:

  • (String)


186
187
188
189
190
191
192
193
194
195
# File 'gems/aws-sdk-marketplacecommerceanalytics/lib/aws-sdk-marketplacecommerceanalytics/types.rb', line 186

class GenerateDataSetRequest < Struct.new(
  :data_set_type,
  :data_set_publication_date,
  :role_name_arn,
  :destination_s3_bucket_name,
  :destination_s3_prefix,
  :sns_topic_arn,
  :customer_defined_values)
  include Aws::Structure
end

#destination_s3_prefixString

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

Returns:

  • (String)


186
187
188
189
190
191
192
193
194
195
# File 'gems/aws-sdk-marketplacecommerceanalytics/lib/aws-sdk-marketplacecommerceanalytics/types.rb', line 186

class GenerateDataSetRequest < Struct.new(
  :data_set_type,
  :data_set_publication_date,
  :role_name_arn,
  :destination_s3_bucket_name,
  :destination_s3_prefix,
  :sns_topic_arn,
  :customer_defined_values)
  include Aws::Structure
end

#role_name_arnString

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

Returns:

  • (String)


186
187
188
189
190
191
192
193
194
195
# File 'gems/aws-sdk-marketplacecommerceanalytics/lib/aws-sdk-marketplacecommerceanalytics/types.rb', line 186

class GenerateDataSetRequest < Struct.new(
  :data_set_type,
  :data_set_publication_date,
  :role_name_arn,
  :destination_s3_bucket_name,
  :destination_s3_prefix,
  :sns_topic_arn,
  :customer_defined_values)
  include Aws::Structure
end

#sns_topic_arnString

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.

Returns:

  • (String)


186
187
188
189
190
191
192
193
194
195
# File 'gems/aws-sdk-marketplacecommerceanalytics/lib/aws-sdk-marketplacecommerceanalytics/types.rb', line 186

class GenerateDataSetRequest < Struct.new(
  :data_set_type,
  :data_set_publication_date,
  :role_name_arn,
  :destination_s3_bucket_name,
  :destination_s3_prefix,
  :sns_topic_arn,
  :customer_defined_values)
  include Aws::Structure
end