Copyright	(c) 2013-2016 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.AWS.MarketplaceAnalytics.GenerateDataSet

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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.

Creating a Request

generateDataSet #

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:

gdsCustomerDefinedValues - (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 - (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 "myprefixmydatasets", the output file "outputfile" would be published to "s3:mybucketmyprefixmydatasetsoutputfile". 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 - 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 - 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 - The Amazon Resource Name (ARN) of the Role with an attached permissions policy to interact with the provided AWS services.
gdsDestinationS3BucketName - The name (friendly name, not ARN) of the destination S3 bucket.
gdsSnsTopicARN - 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.

data GenerateDataSet #

Container for the parameters to the GenerateDataSet operation.

See: generateDataSet smart constructor.

Instances

Eq GenerateDataSet #
Methods (==) :: GenerateDataSet -> GenerateDataSet -> Bool # (/=) :: GenerateDataSet -> GenerateDataSet -> Bool #
Data GenerateDataSet #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GenerateDataSet -> c GenerateDataSet # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GenerateDataSet # toConstr :: GenerateDataSet -> Constr # dataTypeOf :: GenerateDataSet -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c GenerateDataSet) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GenerateDataSet) # gmapT :: (forall b. Data b => b -> b) -> GenerateDataSet -> GenerateDataSet # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GenerateDataSet -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GenerateDataSet -> r # gmapQ :: (forall d. Data d => d -> u) -> GenerateDataSet -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> GenerateDataSet -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> GenerateDataSet -> m GenerateDataSet # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GenerateDataSet -> m GenerateDataSet # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GenerateDataSet -> m GenerateDataSet #
Read GenerateDataSet #
Methods readsPrec :: Int -> ReadS GenerateDataSet # readList :: ReadS [GenerateDataSet] # readPrec :: ReadPrec GenerateDataSet # readListPrec :: ReadPrec [GenerateDataSet] #
Show GenerateDataSet #
Methods showsPrec :: Int -> GenerateDataSet -> ShowS # show :: GenerateDataSet -> String # showList :: [GenerateDataSet] -> ShowS #
Generic GenerateDataSet #
Associated Types type Rep GenerateDataSet :: * -> * # Methods from :: GenerateDataSet -> Rep GenerateDataSet x # to :: Rep GenerateDataSet x -> GenerateDataSet #
Hashable GenerateDataSet #
Methods hashWithSalt :: Int -> GenerateDataSet -> Int # hash :: GenerateDataSet -> Int #
ToJSON GenerateDataSet #
Methods toJSON :: GenerateDataSet -> Value # toEncoding :: GenerateDataSet -> Encoding # toJSONList :: [GenerateDataSet] -> Value # toEncodingList :: [GenerateDataSet] -> Encoding #
NFData GenerateDataSet #
Methods rnf :: GenerateDataSet -> () #
AWSRequest GenerateDataSet #
Associated Types type Rs GenerateDataSet :: * # Methods request :: GenerateDataSet -> Request GenerateDataSet # response :: MonadResource m => Logger -> Service -> Proxy * GenerateDataSet -> ClientResponse -> m (Response GenerateDataSet) #
ToQuery GenerateDataSet #
Methods toQuery :: GenerateDataSet -> QueryString #
ToPath GenerateDataSet #
Methods toPath :: GenerateDataSet -> ByteString #
ToHeaders GenerateDataSet #
Methods toHeaders :: GenerateDataSet -> [Header] #
type Rep GenerateDataSet #
type Rep GenerateDataSet = D1 (MetaData "GenerateDataSet" "Network.AWS.MarketplaceAnalytics.GenerateDataSet" "amazonka-marketplace-analytics-1.4.5-1h6bdE0KbdBEkb6b3RmA1n" False) (C1 (MetaCons "GenerateDataSet'" PrefixI True) ((::) ((::) (S1 (MetaSel (Just Symbol "_gdsCustomerDefinedValues") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text)))) ((::) (S1 (MetaSel (Just Symbol "_gdsDestinationS3Prefix") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_gdsDataSetType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 DataSetType)))) ((::) ((::) (S1 (MetaSel (Just Symbol "_gdsDataSetPublicationDate") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 POSIX)) (S1 (MetaSel (Just Symbol "_gdsRoleNameARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) ((::) (S1 (MetaSel (Just Symbol "_gdsDestinationS3BucketName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_gdsSnsTopicARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))
type Rs GenerateDataSet #
type Rs GenerateDataSet = GenerateDataSetResponse

Request Lenses

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

(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) #

(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 "myprefixmydatasets", the output file "outputfile" would be published to "s3:mybucketmyprefixmydatasetsoutputfile". 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 #

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 #

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 #

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

gdsDestinationS3BucketName :: Lens' GenerateDataSet Text #

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

gdsSnsTopicARN :: Lens' GenerateDataSet Text #

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 #

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:

gdsrsDataSetRequestId - 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 - -- | The response status code.

data GenerateDataSetResponse #

Container for the result of the GenerateDataSet operation.

See: generateDataSetResponse smart constructor.

Instances

Eq GenerateDataSetResponse #
Methods (==) :: GenerateDataSetResponse -> GenerateDataSetResponse -> Bool # (/=) :: GenerateDataSetResponse -> GenerateDataSetResponse -> Bool #
Data GenerateDataSetResponse #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GenerateDataSetResponse -> c GenerateDataSetResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GenerateDataSetResponse # toConstr :: GenerateDataSetResponse -> Constr # dataTypeOf :: GenerateDataSetResponse -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c GenerateDataSetResponse) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GenerateDataSetResponse) # gmapT :: (forall b. Data b => b -> b) -> GenerateDataSetResponse -> GenerateDataSetResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GenerateDataSetResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GenerateDataSetResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> GenerateDataSetResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> GenerateDataSetResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> GenerateDataSetResponse -> m GenerateDataSetResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GenerateDataSetResponse -> m GenerateDataSetResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GenerateDataSetResponse -> m GenerateDataSetResponse #
Read GenerateDataSetResponse #
Methods readsPrec :: Int -> ReadS GenerateDataSetResponse # readList :: ReadS [GenerateDataSetResponse] # readPrec :: ReadPrec GenerateDataSetResponse # readListPrec :: ReadPrec [GenerateDataSetResponse] #
Show GenerateDataSetResponse #
Methods showsPrec :: Int -> GenerateDataSetResponse -> ShowS # show :: GenerateDataSetResponse -> String # showList :: [GenerateDataSetResponse] -> ShowS #
Generic GenerateDataSetResponse #
Associated Types type Rep GenerateDataSetResponse :: * -> * # Methods from :: GenerateDataSetResponse -> Rep GenerateDataSetResponse x # to :: Rep GenerateDataSetResponse x -> GenerateDataSetResponse #
NFData GenerateDataSetResponse #
Methods rnf :: GenerateDataSetResponse -> () #
type Rep GenerateDataSetResponse #
type Rep GenerateDataSetResponse = D1 (MetaData "GenerateDataSetResponse" "Network.AWS.MarketplaceAnalytics.GenerateDataSet" "amazonka-marketplace-analytics-1.4.5-1h6bdE0KbdBEkb6b3RmA1n" False) (C1 (MetaCons "GenerateDataSetResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_gdsrsDataSetRequestId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_gdsrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int))))

Response Lenses

gdsrsDataSetRequestId :: Lens' GenerateDataSetResponse (Maybe Text) #

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 #

- | The response status code.