diff --git a/README.md b/README.md --- a/README.md +++ b/README.md @@ -8,24 +8,27 @@ ## Version -`1.4.4` +`1.4.5` ## Description -Provides AWS Marketplace business intelligence data on-demand. - Documentation is available via [Hackage](http://hackage.haskell.org/package/amazonka-marketplace-analytics) and the [AWS API Reference](https://aws.amazon.com/documentation/). The types from this library are intended to be used with [amazonka](http://hackage.haskell.org/package/amazonka), -which provides mechanisms for specifying AuthN/AuthZ information and sending requests. +which provides mechanisms for specifying AuthN/AuthZ information, sending requests, +and receiving responses. -Use of lenses is required for constructing and manipulating types. -This is due to the amount of nesting of AWS types and transparency regarding +Lenses are used for constructing and manipulating types, +due to the depth of nesting of AWS types and transparency regarding de/serialisation into more palatable Haskell values. The provided lenses should be compatible with any of the major lens libraries [lens](http://hackage.haskell.org/package/lens) or [lens-family-core](http://hackage.haskell.org/package/lens-family-core). + +See [Network.AWS.MarketplaceAnalytics](http://hackage.haskell.org/package/amazonka-marketplace-analytics/docs/Network-AWS-MarketplaceAnalytics.html) +or [the AWS documentation](https://aws.amazon.com/documentation/) to get started. + ## Contribute diff --git a/amazonka-marketplace-analytics.cabal b/amazonka-marketplace-analytics.cabal --- a/amazonka-marketplace-analytics.cabal +++ b/amazonka-marketplace-analytics.cabal @@ -1,5 +1,5 @@ name: amazonka-marketplace-analytics -version: 1.4.4 +version: 1.4.5 synopsis: Amazon Marketplace Commerce Analytics SDK. homepage: https://github.com/brendanhay/amazonka bug-reports: https://github.com/brendanhay/amazonka/issues @@ -13,20 +13,19 @@ cabal-version: >= 1.10 extra-source-files: README.md fixture/*.yaml fixture/*.proto src/.gitkeep description: - Provides AWS Marketplace business intelligence data on-demand. - . The types from this library are intended to be used with , which provides - mechanisms for specifying AuthN/AuthZ information and sending requests. + mechanisms for specifying AuthN/AuthZ information, sending requests, + and receiving responses. . - Use of lenses is required for constructing and manipulating types. - This is due to the amount of nesting of AWS types and transparency regarding + Lenses are used for constructing and manipulating types, + due to the depth of nesting of AWS types and transparency regarding de/serialisation into more palatable Haskell values. The provided lenses should be compatible with any of the major lens libraries such as or . . - See "Network.AWS.MarketplaceAnalytics" or + See "Network.AWS.MarketplaceAnalytics" or to get started. source-repository head @@ -51,7 +50,7 @@ , Network.AWS.MarketplaceAnalytics.Types.Sum build-depends: - amazonka-core == 1.4.4.* + amazonka-core == 1.4.5.* , base >= 4.7 && < 5 test-suite amazonka-marketplace-analytics-test @@ -71,9 +70,9 @@ , Test.AWS.MarketplaceAnalytics.Internal build-depends: - amazonka-core == 1.4.4.* - , amazonka-test == 1.4.4.* - , amazonka-marketplace-analytics == 1.4.4.* + amazonka-core == 1.4.5.* + , amazonka-test == 1.4.5.* + , amazonka-marketplace-analytics == 1.4.5.* , base , bytestring , tasty diff --git a/gen/Network/AWS/MarketplaceAnalytics/GenerateDataSet.hs b/gen/Network/AWS/MarketplaceAnalytics/GenerateDataSet.hs --- a/gen/Network/AWS/MarketplaceAnalytics/GenerateDataSet.hs +++ b/gen/Network/AWS/MarketplaceAnalytics/GenerateDataSet.hs @@ -65,19 +65,19 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'gdsCustomerDefinedValues' +-- * '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' +-- * '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 "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' +-- * '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' +-- * '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' +-- * 'gdsRoleNameARN' - The Amazon Resource Name (ARN) of the Role with an attached permissions policy to interact with the provided AWS services. -- --- * 'gdsDestinationS3BucketName' +-- * 'gdsDestinationS3BucketName' - The name (friendly name, not ARN) of the destination S3 bucket. -- --- * 'gdsSnsTopicARN' +-- * '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. generateDataSet :: DataSetType -- ^ 'gdsDataSetType' -> UTCTime -- ^ 'gdsDataSetPublicationDate' @@ -100,30 +100,11 @@ gdsCustomerDefinedValues :: Lens' GenerateDataSet (HashMap Text Text) gdsCustomerDefinedValues = lens _gdsCustomerDefinedValues (\ s a -> s{_gdsCustomerDefinedValues = a}) . _Default . _Map; --- | (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. +-- | (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. gdsDestinationS3Prefix :: Lens' GenerateDataSet (Maybe Text) gdsDestinationS3Prefix = lens _gdsDestinationS3Prefix (\ s a -> s{_gdsDestinationS3Prefix = a}); --- | 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. +-- | 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. gdsDataSetType :: Lens' GenerateDataSet DataSetType gdsDataSetType = lens _gdsDataSetType (\ s a -> s{_gdsDataSetType = a}); @@ -202,9 +183,9 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'gdsrsDataSetRequestId' +-- * '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' +-- * 'gdsrsResponseStatus' - -- | The response status code. generateDataSetResponse :: Int -- ^ 'gdsrsResponseStatus' -> GenerateDataSetResponse @@ -218,7 +199,7 @@ gdsrsDataSetRequestId :: Lens' GenerateDataSetResponse (Maybe Text) gdsrsDataSetRequestId = lens _gdsrsDataSetRequestId (\ s a -> s{_gdsrsDataSetRequestId = a}); --- | The response status code. +-- | -- | The response status code. gdsrsResponseStatus :: Lens' GenerateDataSetResponse Int gdsrsResponseStatus = lens _gdsrsResponseStatus (\ s a -> s{_gdsrsResponseStatus = a}); diff --git a/gen/Network/AWS/MarketplaceAnalytics/StartSupportDataExport.hs b/gen/Network/AWS/MarketplaceAnalytics/StartSupportDataExport.hs --- a/gen/Network/AWS/MarketplaceAnalytics/StartSupportDataExport.hs +++ b/gen/Network/AWS/MarketplaceAnalytics/StartSupportDataExport.hs @@ -18,7 +18,7 @@ -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- --- Given a data set type and a from date, asynchronously publishes the requested customer support data 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\'T\'HH-mm-ss\'Z\'.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. +-- Given a data set type and a from date, asynchronously publishes the requested customer support data 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'T'HH-mm-ss'Z'.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. module Network.AWS.MarketplaceAnalytics.StartSupportDataExport ( -- * Creating a Request @@ -65,19 +65,19 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'ssdeCustomerDefinedValues' +-- * 'ssdeCustomerDefinedValues' - (Optional) Key-value pairs which will be returned, unmodified, in the Amazon SNS notification message and the data set metadata file. -- --- * 'ssdeDestinationS3Prefix' +-- * 'ssdeDestinationS3Prefix' - (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. -- --- * 'ssdeDataSetType' +-- * 'ssdeDataSetType' - Specifies the data set type to be written to the output csv file. The data set types customer_support_contacts_data and test_customer_support_contacts_data both result in a csv file containing the following fields: Product Id, Customer Guid, Subscription Guid, Subscription Start Date, Organization, AWS Account Id, Given Name, Surname, Telephone Number, Email, Title, Country Code, ZIP Code, Operation Type, and Operation Time. Currently, only the test_customer_support_contacts_data value is supported * /customer_support_contacts_data/ Customer support contact data. The data set will contain all changes (Creates, Updates, and Deletes) to customer support contact data from the date specified in the from_date parameter. * /test_customer_support_contacts_data/ An example data set containing static test data in the same format as customer_support_contacts_data -- --- * 'ssdeFromDate' +-- * 'ssdeFromDate' - The start date from which to retrieve the data set. This parameter only affects the customer_support_contacts_data data set type. -- --- * 'ssdeRoleNameARN' +-- * 'ssdeRoleNameARN' - The Amazon Resource Name (ARN) of the Role with an attached permissions policy to interact with the provided AWS services. -- --- * 'ssdeDestinationS3BucketName' +-- * 'ssdeDestinationS3BucketName' - The name (friendly name, not ARN) of the destination S3 bucket. -- --- * 'ssdeSnsTopicARN' +-- * 'ssdeSnsTopicARN' - 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. startSupportDataExport :: SupportDataSetType -- ^ 'ssdeDataSetType' -> UTCTime -- ^ 'ssdeFromDate' @@ -100,14 +100,11 @@ ssdeCustomerDefinedValues :: Lens' StartSupportDataExport (HashMap Text Text) ssdeCustomerDefinedValues = lens _ssdeCustomerDefinedValues (\ s a -> s{_ssdeCustomerDefinedValues = a}) . _Default . _Map; --- | (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. +-- | (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. ssdeDestinationS3Prefix :: Lens' StartSupportDataExport (Maybe Text) ssdeDestinationS3Prefix = lens _ssdeDestinationS3Prefix (\ s a -> s{_ssdeDestinationS3Prefix = a}); --- | Specifies the data set type to be written to the output csv file. The data set types customer_support_contacts_data and test_customer_support_contacts_data both result in a csv file containing the following fields: Product Id, Customer Guid, Subscription Guid, Subscription Start Date, Organization, AWS Account Id, Given Name, Surname, Telephone Number, Email, Title, Country Code, ZIP Code, Operation Type, and Operation Time. Currently, only the test_customer_support_contacts_data value is supported --- --- - /customer_support_contacts_data/ Customer support contact data. The data set will contain all changes (Creates, Updates, and Deletes) to customer support contact data from the date specified in the from_date parameter. --- - /test_customer_support_contacts_data/ An example data set containing static test data in the same format as customer_support_contacts_data +-- | Specifies the data set type to be written to the output csv file. The data set types customer_support_contacts_data and test_customer_support_contacts_data both result in a csv file containing the following fields: Product Id, Customer Guid, Subscription Guid, Subscription Start Date, Organization, AWS Account Id, Given Name, Surname, Telephone Number, Email, Title, Country Code, ZIP Code, Operation Type, and Operation Time. Currently, only the test_customer_support_contacts_data value is supported * /customer_support_contacts_data/ Customer support contact data. The data set will contain all changes (Creates, Updates, and Deletes) to customer support contact data from the date specified in the from_date parameter. * /test_customer_support_contacts_data/ An example data set containing static test data in the same format as customer_support_contacts_data ssdeDataSetType :: Lens' StartSupportDataExport SupportDataSetType ssdeDataSetType = lens _ssdeDataSetType (\ s a -> s{_ssdeDataSetType = a}); @@ -185,9 +182,9 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'ssdersDataSetRequestId' +-- * 'ssdersDataSetRequestId' - A unique identifier representing a specific request to the StartSupportDataExport operation. This identifier can be used to correlate a request with notifications from the SNS topic. -- --- * 'ssdersResponseStatus' +-- * 'ssdersResponseStatus' - -- | The response status code. startSupportDataExportResponse :: Int -- ^ 'ssdersResponseStatus' -> StartSupportDataExportResponse @@ -201,7 +198,7 @@ ssdersDataSetRequestId :: Lens' StartSupportDataExportResponse (Maybe Text) ssdersDataSetRequestId = lens _ssdersDataSetRequestId (\ s a -> s{_ssdersDataSetRequestId = a}); --- | The response status code. +-- | -- | The response status code. ssdersResponseStatus :: Lens' StartSupportDataExportResponse Int ssdersResponseStatus = lens _ssdersResponseStatus (\ s a -> s{_ssdersResponseStatus = a}); diff --git a/gen/Network/AWS/MarketplaceAnalytics/Types.hs b/gen/Network/AWS/MarketplaceAnalytics/Types.hs --- a/gen/Network/AWS/MarketplaceAnalytics/Types.hs +++ b/gen/Network/AWS/MarketplaceAnalytics/Types.hs @@ -31,7 +31,7 @@ import Network.AWS.Prelude import Network.AWS.Sign.V4 --- | API version '2015-07-01' of the Amazon Marketplace Commerce Analytics SDK configuration. +-- | API version @2015-07-01@ of the Amazon Marketplace Commerce Analytics SDK configuration. marketplaceAnalytics :: Service marketplaceAnalytics = Service