{ "smithy": "1.0", "metadata": { "suppressions": [ { "id": "HttpMethodSemantics", "namespace": "*" }, { "id": "HttpResponseCodeSemantics", "namespace": "*" }, { "id": "PaginatedTrait", "namespace": "*" }, { "id": "HttpHeaderTrait", "namespace": "*" }, { "id": "HttpUriConflict", "namespace": "*" }, { "id": "Service", "namespace": "*" } ] }, "shapes": { "com.amazonaws.marketplacecommerceanalytics#CustomerDefinedValues": { "type": "map", "key": { "target": "com.amazonaws.marketplacecommerceanalytics#OptionalKey" }, "value": { "target": "com.amazonaws.marketplacecommerceanalytics#OptionalValue" }, "traits": { "smithy.api#length": { "min": 1, "max": 5 } } }, "com.amazonaws.marketplacecommerceanalytics#DataSetPublicationDate": { "type": "timestamp" }, "com.amazonaws.marketplacecommerceanalytics#DataSetRequestId": { "type": "string" }, "com.amazonaws.marketplacecommerceanalytics#DataSetType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "customer_subscriber_hourly_monthly_subscriptions", "name": "CUSTOMER_SUBSCRIBER_HOURLY_MONTHLY_SUBSCRIPTIONS" }, { "value": "customer_subscriber_annual_subscriptions", "name": "CUSTOMER_SUBSCRIBER_ANNUAL_SUBSCRIPTIONS" }, { "value": "daily_business_usage_by_instance_type", "name": "DAILY_BUSINESS_USAGE_BY_INSTANCE_TYPE" }, { "value": "daily_business_fees", "name": "DAILY_BUSINESS_FEES" }, { "value": "daily_business_free_trial_conversions", "name": "DAILY_BUSINESS_FREE_TRIAL_CONVERSIONS" }, { "value": "daily_business_new_instances", "name": "DAILY_BUSINESS_NEW_INSTANCES" }, { "value": "daily_business_new_product_subscribers", "name": "DAILY_BUSINESS_NEW_PRODUCT_SUBSCRIBERS" }, { "value": "daily_business_canceled_product_subscribers", "name": "DAILY_BUSINESS_CANCELED_PRODUCT_SUBSCRIBERS" }, { "value": "monthly_revenue_billing_and_revenue_data", "name": "MONTHLY_REVENUE_BILLING_AND_REVENUE_DATA" }, { "value": "monthly_revenue_annual_subscriptions", "name": "MONTHLY_REVENUE_ANNUAL_SUBSCRIPTIONS" }, { "value": "monthly_revenue_field_demonstration_usage", "name": "MONTHLY_REVENUE_FIELD_DEMONSTRATION_USAGE" }, { "value": "monthly_revenue_flexible_payment_schedule", "name": "MONTHLY_REVENUE_FLEXIBLE_PAYMENT_SCHEDULE" }, { "value": "disbursed_amount_by_product", "name": "DISBURSED_AMOUNT_BY_PRODUCT" }, { "value": "disbursed_amount_by_product_with_uncollected_funds", "name": "DISBURSED_AMOUNT_BY_PRODUCT_WITH_UNCOLLECTED_FUNDS" }, { "value": "disbursed_amount_by_instance_hours", "name": "DISBURSED_AMOUNT_BY_INSTANCE_HOURS" }, { "value": "disbursed_amount_by_customer_geo", "name": "DISBURSED_AMOUNT_BY_CUSTOMER_GEO" }, { "value": "disbursed_amount_by_age_of_uncollected_funds", "name": "DISBURSED_AMOUNT_BY_AGE_OF_UNCOLLECTED_FUNDS" }, { "value": "disbursed_amount_by_age_of_disbursed_funds", "name": "DISBURSED_AMOUNT_BY_AGE_OF_DISBURSED_FUNDS" }, { "value": "disbursed_amount_by_age_of_past_due_funds", "name": "DISBURSED_AMOUNT_BY_AGE_OF_PAST_DUE_FUNDS" }, { "value": "disbursed_amount_by_uncollected_funds_breakdown", "name": "DISBURSED_AMOUNT_BY_UNCOLLECTED_FUNDS_BREAKDOWN" }, { "value": "customer_profile_by_industry", "name": "CUSTOMER_PROFILE_BY_INDUSTRY" }, { "value": "customer_profile_by_revenue", "name": "CUSTOMER_PROFILE_BY_REVENUE" }, { "value": "customer_profile_by_geography", "name": "CUSTOMER_PROFILE_BY_GEOGRAPHY" }, { "value": "sales_compensation_billed_revenue", "name": "SALES_COMPENSATION_BILLED_REVENUE" }, { "value": "us_sales_and_use_tax_records", "name": "US_SALES_AND_USE_TAX_RECORDS" } ], "smithy.api#length": { "min": 1, "max": 255 } } }, "com.amazonaws.marketplacecommerceanalytics#DestinationS3BucketName": { "type": "string", "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.marketplacecommerceanalytics#DestinationS3Prefix": { "type": "string" }, "com.amazonaws.marketplacecommerceanalytics#ExceptionMessage": { "type": "string" }, "com.amazonaws.marketplacecommerceanalytics#FromDate": { "type": "timestamp" }, "com.amazonaws.marketplacecommerceanalytics#GenerateDataSet": { "type": "operation", "input": { "target": "com.amazonaws.marketplacecommerceanalytics#GenerateDataSetRequest" }, "output": { "target": "com.amazonaws.marketplacecommerceanalytics#GenerateDataSetResult" }, "errors": [ { "target": "com.amazonaws.marketplacecommerceanalytics#MarketplaceCommerceAnalyticsException" } ], "traits": { "smithy.api#documentation": "Given a data set type and data set publication date, asynchronously publishes the requested data set to the specified\n S3 bucket and notifies the specified SNS topic once the data is available. Returns a unique request identifier that\n can be used to correlate requests with notifications from the SNS topic.\n Data sets will be published in comma-separated values (CSV) format with the file name {data_set_type}_YYYY-MM-DD.csv.\n If a file with the same name already exists (e.g. if the same data set is requested twice), the original file will\n be overwritten by the new file.\n Requires a Role with an attached permissions policy providing Allow permissions for the following actions:\n s3:PutObject, s3:GetBucketLocation, sns:GetTopicAttributes, sns:Publish, iam:GetRolePolicy." } }, "com.amazonaws.marketplacecommerceanalytics#GenerateDataSetRequest": { "type": "structure", "members": { "dataSetType": { "target": "com.amazonaws.marketplacecommerceanalytics#DataSetType", "traits": { "smithy.api#documentation": "

The desired data set type.

\n

\n

\n

", "smithy.api#required": {} } }, "dataSetPublicationDate": { "target": "com.amazonaws.marketplacecommerceanalytics#DataSetPublicationDate", "traits": { "smithy.api#documentation": "The date a data set was published.\n For daily data sets, provide a date with day-level granularity for the desired day.\n 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).\n 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).", "smithy.api#required": {} } }, "roleNameArn": { "target": "com.amazonaws.marketplacecommerceanalytics#RoleNameArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Role with an attached permissions policy to interact with the provided\n AWS services.", "smithy.api#required": {} } }, "destinationS3BucketName": { "target": "com.amazonaws.marketplacecommerceanalytics#DestinationS3BucketName", "traits": { "smithy.api#documentation": "The name (friendly name, not ARN) of the destination S3 bucket.", "smithy.api#required": {} } }, "destinationS3Prefix": { "target": "com.amazonaws.marketplacecommerceanalytics#DestinationS3Prefix", "traits": { "smithy.api#documentation": "(Optional) The desired S3 prefix for the published data set, similar to a directory path in standard file systems.\n For example, if given the bucket name \"mybucket\" and the prefix \"myprefix/mydatasets\", the output file\n \"outputfile\" would be published to \"s3://mybucket/myprefix/mydatasets/outputfile\".\n If the prefix directory structure does not exist, it will be created.\n If no prefix is provided, the data set will be published to the S3 bucket root." } }, "snsTopicArn": { "target": "com.amazonaws.marketplacecommerceanalytics#SnsTopicArn", "traits": { "smithy.api#documentation": "Amazon Resource Name (ARN) for the SNS Topic that will be notified when the data set has been published or if an\n error has occurred.", "smithy.api#required": {} } }, "customerDefinedValues": { "target": "com.amazonaws.marketplacecommerceanalytics#CustomerDefinedValues", "traits": { "smithy.api#documentation": "(Optional) Key-value pairs which will be returned, unmodified, in the\n Amazon SNS notification message and the data set metadata file. These\n key-value pairs can be used to correlated responses with tracking\n information from other systems." } } }, "traits": { "smithy.api#documentation": "Container for the parameters to the GenerateDataSet operation." } }, "com.amazonaws.marketplacecommerceanalytics#GenerateDataSetResult": { "type": "structure", "members": { "dataSetRequestId": { "target": "com.amazonaws.marketplacecommerceanalytics#DataSetRequestId", "traits": { "smithy.api#documentation": "A unique identifier representing a specific request to the GenerateDataSet operation. This identifier can be\n used to correlate a request with notifications from the SNS topic." } } }, "traits": { "smithy.api#documentation": "Container for the result of the GenerateDataSet operation." } }, "com.amazonaws.marketplacecommerceanalytics#MarketplaceCommerceAnalytics20150701": { "type": "service", "version": "2015-07-01", "operations": [ { "target": "com.amazonaws.marketplacecommerceanalytics#GenerateDataSet" }, { "target": "com.amazonaws.marketplacecommerceanalytics#StartSupportDataExport" } ], "traits": { "aws.api#service": { "sdkId": "Marketplace Commerce Analytics", "arnNamespace": "marketplacecommerceanalytics", "cloudFormationName": "MarketplaceCommerceAnalytics", "cloudTrailEventSource": "marketplacecommerceanalytics.amazonaws.com", "endpointPrefix": "marketplacecommerceanalytics" }, "aws.auth#sigv4": { "name": "marketplacecommerceanalytics" }, "aws.protocols#awsJson1_1": {}, "smithy.api#documentation": "Provides AWS Marketplace business intelligence data on-demand.", "smithy.api#title": "AWS Marketplace Commerce Analytics" } }, "com.amazonaws.marketplacecommerceanalytics#MarketplaceCommerceAnalyticsException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.marketplacecommerceanalytics#ExceptionMessage", "traits": { "smithy.api#documentation": "This message describes details of the error." } } }, "traits": { "smithy.api#documentation": "This exception is thrown when an internal service error occurs.", "smithy.api#error": "server" } }, "com.amazonaws.marketplacecommerceanalytics#OptionalKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 } } }, "com.amazonaws.marketplacecommerceanalytics#OptionalValue": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 } } }, "com.amazonaws.marketplacecommerceanalytics#RoleNameArn": { "type": "string", "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.marketplacecommerceanalytics#SnsTopicArn": { "type": "string", "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.marketplacecommerceanalytics#StartSupportDataExport": { "type": "operation", "input": { "target": "com.amazonaws.marketplacecommerceanalytics#StartSupportDataExportRequest" }, "output": { "target": "com.amazonaws.marketplacecommerceanalytics#StartSupportDataExportResult" }, "errors": [ { "target": "com.amazonaws.marketplacecommerceanalytics#MarketplaceCommerceAnalyticsException" } ], "traits": { "smithy.api#documentation": "Given a data set type and a from date, asynchronously publishes the requested customer support data\n to the specified S3 bucket and notifies the specified SNS topic once the data is available. Returns a unique request\n identifier that can be used to correlate requests with notifications from the SNS topic.\n 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.\n If a file with the same name already exists (e.g. if the same data set is requested twice), the original file will\n be overwritten by the new file.\n Requires a Role with an attached permissions policy providing Allow permissions for the following actions:\n s3:PutObject, s3:GetBucketLocation, sns:GetTopicAttributes, sns:Publish, iam:GetRolePolicy." } }, "com.amazonaws.marketplacecommerceanalytics#StartSupportDataExportRequest": { "type": "structure", "members": { "dataSetType": { "target": "com.amazonaws.marketplacecommerceanalytics#SupportDataSetType", "traits": { "smithy.api#documentation": "

\n Specifies the data set type to be written to the output csv file. The data set types customer_support_contacts_data and\n test_customer_support_contacts_data both result in a csv file containing the following fields: Product Id, Product Code, Customer Guid,\n Subscription Guid, Subscription Start Date, Organization, AWS Account Id, Given Name, Surname, Telephone Number, Email, Title,\n Country Code, ZIP Code, Operation Type, and Operation Time.\n

\n

\n

\n

", "smithy.api#required": {} } }, "fromDate": { "target": "com.amazonaws.marketplacecommerceanalytics#FromDate", "traits": { "smithy.api#documentation": "The start date from which to retrieve the data set in UTC. This parameter only affects the customer_support_contacts_data data set type.", "smithy.api#required": {} } }, "roleNameArn": { "target": "com.amazonaws.marketplacecommerceanalytics#RoleNameArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Role with an attached permissions policy to interact with the provided\n AWS services.", "smithy.api#required": {} } }, "destinationS3BucketName": { "target": "com.amazonaws.marketplacecommerceanalytics#DestinationS3BucketName", "traits": { "smithy.api#documentation": "The name (friendly name, not ARN) of the destination S3 bucket.", "smithy.api#required": {} } }, "destinationS3Prefix": { "target": "com.amazonaws.marketplacecommerceanalytics#DestinationS3Prefix", "traits": { "smithy.api#documentation": "(Optional) The desired S3 prefix for the published data set, similar to a directory path in standard file systems.\n For example, if given the bucket name \"mybucket\" and the prefix \"myprefix/mydatasets\", the output file\n \"outputfile\" would be published to \"s3://mybucket/myprefix/mydatasets/outputfile\".\n If the prefix directory structure does not exist, it will be created.\n If no prefix is provided, the data set will be published to the S3 bucket root." } }, "snsTopicArn": { "target": "com.amazonaws.marketplacecommerceanalytics#SnsTopicArn", "traits": { "smithy.api#documentation": "Amazon Resource Name (ARN) for the SNS Topic that will be notified when the data set has been published or if an\n error has occurred.", "smithy.api#required": {} } }, "customerDefinedValues": { "target": "com.amazonaws.marketplacecommerceanalytics#CustomerDefinedValues", "traits": { "smithy.api#documentation": "(Optional) Key-value pairs which will be returned, unmodified, in the\n Amazon SNS notification message and the data set metadata file." } } }, "traits": { "smithy.api#documentation": "Container for the parameters to the StartSupportDataExport operation." } }, "com.amazonaws.marketplacecommerceanalytics#StartSupportDataExportResult": { "type": "structure", "members": { "dataSetRequestId": { "target": "com.amazonaws.marketplacecommerceanalytics#DataSetRequestId", "traits": { "smithy.api#documentation": "A unique identifier representing a specific request to the StartSupportDataExport operation. This identifier can be\n used to correlate a request with notifications from the SNS topic." } } }, "traits": { "smithy.api#documentation": "Container for the result of the StartSupportDataExport operation." } }, "com.amazonaws.marketplacecommerceanalytics#SupportDataSetType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "customer_support_contacts_data", "name": "customer_support_contacts_data" }, { "value": "test_customer_support_contacts_data", "name": "test_customer_support_contacts_data" } ], "smithy.api#length": { "min": 1, "max": 255 } } } } }