SDK for PHP 3.x

AWS Marketplace Commerce Analytics 2015-07-01

Client: Aws\MarketplaceCommerceAnalytics\MarketplaceCommerceAnalyticsClient
Service ID: marketplacecommerceanalytics
Version: 2015-07-01

This page describes the parameters and results for the operations of the AWS Marketplace Commerce Analytics (2015-07-01), and shows how to use the Aws\MarketplaceCommerceAnalytics\MarketplaceCommerceAnalyticsClient object to call the described operations. This documentation is specific to the 2015-07-01 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

GenerateDataSet ( array $params = [] )
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.
StartSupportDataExport ( array $params = [] )
This target has been deprecated.

Operations

GenerateDataSet 

$result = $client->generateDataSet([/* ... */]);
$promise = $client->generateDataSetAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->generateDataSet([
    'customerDefinedValues' => ['<string>', ...],
    'dataSetPublicationDate' => <integer || string || DateTime>, // REQUIRED
    'dataSetType' => '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|monthly_revenue_field_demonstration_usage|monthly_revenue_flexible_payment_schedule|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|disbursed_amount_by_age_of_past_due_funds|disbursed_amount_by_uncollected_funds_breakdown|customer_profile_by_industry|customer_profile_by_revenue|customer_profile_by_geography|sales_compensation_billed_revenue|us_sales_and_use_tax_records', // REQUIRED
    'destinationS3BucketName' => '<string>', // REQUIRED
    'destinationS3Prefix' => '<string>',
    'roleNameArn' => '<string>', // REQUIRED
    'snsTopicArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
customerDefinedValues
Type: Associative array of custom strings keys (OptionalKey) to strings
(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.
dataSetPublicationDate
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)
The date a data set was published. For daily data sets, provide a date with day-level granularity for the desired day. For monthly data sets except those with prefix disbursed_amount, provide a date with month-level granularity for the desired month (the day value will be ignored). For data sets with prefix disbursed_amount, provide a date with day-level granularity for the desired day. For these data sets we will look backwards in time over the range of 31 days until the first data set is found (the latest one).
dataSetType
Required: Yes
Type: string

The desired data set type.

  • customer_subscriber_hourly_monthly_subscriptions

    From 2017-09-15 to present: Available daily by 24:00 UTC.

  • customer_subscriber_annual_subscriptions

    From 2017-09-15 to present: Available daily by 24:00 UTC.

  • daily_business_usage_by_instance_type

    From 2017-09-15 to present: Available daily by 24:00 UTC.

  • daily_business_fees

    From 2017-09-15 to present: Available daily by 24:00 UTC.

  • daily_business_free_trial_conversions

    From 2017-09-15 to present: Available daily by 24:00 UTC.

  • daily_business_new_instances

    From 2017-09-15 to present: Available daily by 24:00 UTC.

  • daily_business_new_product_subscribers

    From 2017-09-15 to present: Available daily by 24:00 UTC.

  • daily_business_canceled_product_subscribers

    From 2017-09-15 to present: Available daily by 24:00 UTC.

  • monthly_revenue_billing_and_revenue_data

    From 2017-09-15 to present: Available monthly on the 15th day of the month by 24:00 UTC. Data includes metered transactions (e.g. hourly) from one month prior.

  • monthly_revenue_annual_subscriptions

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

  • monthly_revenue_field_demonstration_usage

    From 2018-03-15 to present: Available monthly on the 15th day of the month by 24:00 UTC.

  • monthly_revenue_flexible_payment_schedule

    From 2018-11-15 to present: Available monthly on the 15th day of the month by 24:00 UTC.

  • disbursed_amount_by_product

    From 2017-09-15 to present: Available every 30 days by 24:00 UTC.

  • disbursed_amount_by_instance_hours

    From 2017-09-15 to present: Available every 30 days by 24:00 UTC.

  • disbursed_amount_by_customer_geo

    From 2017-09-15 to present: Available every 30 days by 24:00 UTC.

  • disbursed_amount_by_age_of_uncollected_funds

    From 2017-09-15 to present: Available every 30 days by 24:00 UTC.

  • disbursed_amount_by_age_of_disbursed_funds

    From 2017-09-15 to present: Available every 30 days by 24:00 UTC.

  • disbursed_amount_by_age_of_past_due_funds

    From 2018-04-07 to present: Available every 30 days by 24:00 UTC.

  • disbursed_amount_by_uncollected_funds_breakdown

    From 2019-10-04 to present: Available every 30 days by 24:00 UTC.

  • sales_compensation_billed_revenue

    From 2017-09-15 to present: Available monthly on the 15th day of the month by 24:00 UTC. 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-09-15 to present: Available monthly on the 15th day of the month by 24:00 UTC.

  • disbursed_amount_by_product_with_uncollected_funds

    This data set is deprecated. Download related reports from AMMP instead!

  • customer_profile_by_industry

    This data set is deprecated. Download related reports from AMMP instead!

  • customer_profile_by_revenue

    This data set is deprecated. Download related reports from AMMP instead!

  • customer_profile_by_geography

    This data set is deprecated. Download related reports from AMMP instead!

destinationS3BucketName
Required: Yes
Type: string
The name (friendly name, not ARN) of the destination S3 bucket.
destinationS3Prefix
Type: string
(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.
roleNameArn
Required: Yes
Type: string
The Amazon Resource Name (ARN) of the Role with an attached permissions policy to interact with the provided AWS services.
snsTopicArn
Required: Yes
Type: string
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.

Result Syntax

[
    'dataSetRequestId' => '<string>',
]

Result Details

Members
dataSetRequestId
Type: string
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.

Errors

MarketplaceCommerceAnalyticsException:
This exception is thrown when an internal service error occurs.

StartSupportDataExport 

$result = $client->startSupportDataExport([/* ... */]);
$promise = $client->startSupportDataExportAsync([/* ... */]);

This target has been deprecated. 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.

Parameter Syntax

$result = $client->startSupportDataExport([
    'customerDefinedValues' => ['<string>', ...],
    'dataSetType' => 'customer_support_contacts_data|test_customer_support_contacts_data', // REQUIRED
    'destinationS3BucketName' => '<string>', // REQUIRED
    'destinationS3Prefix' => '<string>',
    'fromDate' => <integer || string || DateTime>, // REQUIRED
    'roleNameArn' => '<string>', // REQUIRED
    'snsTopicArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
customerDefinedValues
Type: Associative array of custom strings keys (OptionalKey) to strings
This target has been deprecated. (Optional) Key-value pairs which will be returned, unmodified, in the Amazon SNS notification message and the data set metadata file.
dataSetType
Required: Yes
Type: string

This target has been deprecated. 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, Product Code, 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.

  • 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

destinationS3BucketName
Required: Yes
Type: string
This target has been deprecated. The name (friendly name, not ARN) of the destination S3 bucket.
destinationS3Prefix
Type: string
This target has been deprecated. (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.
fromDate
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)
This target has been deprecated. The start date from which to retrieve the data set in UTC. This parameter only affects the customer_support_contacts_data data set type.
roleNameArn
Required: Yes
Type: string
This target has been deprecated. The Amazon Resource Name (ARN) of the Role with an attached permissions policy to interact with the provided AWS services.
snsTopicArn
Required: Yes
Type: string
This target has been deprecated. 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.

Result Syntax

[
    'dataSetRequestId' => '<string>',
]

Result Details

Members
dataSetRequestId
Type: string
This target has been deprecated. 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.

Errors

MarketplaceCommerceAnalyticsException:
This exception is thrown when an internal service error occurs.

Shapes

MarketplaceCommerceAnalyticsException

Description
This exception is thrown when an internal service error occurs.
Members
message
Type: string
This message describes details of the error.