amazonka-marketplace-analytics-1.4.0: Amazon Marketplace Commerce Analytics SDK.

Copyright(c) 2013-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.MarketplaceAnalytics.GenerateDataSet

Contents

Description

Given a data set type and data set publication date, asynchronously publishes the requested data set to the specified S3 bucket and notifies the specified SNS topic once the data is available. Returns a unique request identifier that can be used to correlate requests with notifications from the SNS topic. Data sets will be published in comma-separated values (CSV) format with the file name {data_set_type}_YYYY-MM-DD.csv. If a file with the same name already exists (e.g. if the same data set is requested twice), the original file will be overwritten by the new file. Requires a Role with an attached permissions policy providing Allow permissions for the following actions: s3:PutObject, s3:GetBucketLocation, sns:GetTopicAttributes, sns:Publish, iam:GetRolePolicy.

Synopsis

Creating a Request

generateDataSet Source

Arguments

:: DataSetType

gdsDataSetType

-> UTCTime

gdsDataSetPublicationDate

-> Text

gdsRoleNameARN

-> Text

gdsDestinationS3BucketName

-> Text

gdsSnsTopicARN

-> GenerateDataSet 

Creates a value of GenerateDataSet with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data GenerateDataSet Source

Container for the parameters to the GenerateDataSet operation.

See: generateDataSet smart constructor.

Instances

Request Lenses

gdsCustomerDefinedValues :: Lens' GenerateDataSet (HashMap Text Text) Source

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

gdsDestinationS3Prefix :: Lens' GenerateDataSet (Maybe Text) Source

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

gdsDataSetType :: Lens' GenerateDataSet DataSetType Source

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.

gdsDataSetPublicationDate :: Lens' GenerateDataSet UTCTime Source

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

gdsRoleNameARN :: Lens' GenerateDataSet Text Source

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

gdsDestinationS3BucketName :: Lens' GenerateDataSet Text Source

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

gdsSnsTopicARN :: Lens' GenerateDataSet Text Source

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.

Destructuring the Response

generateDataSetResponse Source

Arguments

:: Int

gdsrsResponseStatus

-> GenerateDataSetResponse 

Creates a value of GenerateDataSetResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data GenerateDataSetResponse Source

Container for the result of the GenerateDataSet operation.

See: generateDataSetResponse smart constructor.

Instances

Response Lenses

gdsrsDataSetRequestId :: Lens' GenerateDataSetResponse (Maybe Text) Source

A unique identifier representing a specific request to the GenerateDataSet operation. This identifier can be used to correlate a request with notifications from the SNS topic.

gdsrsResponseStatus :: Lens' GenerateDataSetResponse Int Source

The response status code.