marketplacecommerceanalytics.d.ts (13651B)
1 import {Request} from '../lib/request'; 2 import {Response} from '../lib/response'; 3 import {AWSError} from '../lib/error'; 4 import {Service} from '../lib/service'; 5 import {ServiceConfigurationOptions} from '../lib/service'; 6 import {ConfigBase as Config} from '../lib/config'; 7 interface Blob {} 8 declare class MarketplaceCommerceAnalytics extends Service { 9 /** 10 * Constructs a service object. This object has one method for each API operation. 11 */ 12 constructor(options?: MarketplaceCommerceAnalytics.Types.ClientConfiguration) 13 config: Config & MarketplaceCommerceAnalytics.Types.ClientConfiguration; 14 /** 15 * 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. 16 */ 17 generateDataSet(params: MarketplaceCommerceAnalytics.Types.GenerateDataSetRequest, callback?: (err: AWSError, data: MarketplaceCommerceAnalytics.Types.GenerateDataSetResult) => void): Request<MarketplaceCommerceAnalytics.Types.GenerateDataSetResult, AWSError>; 18 /** 19 * 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. 20 */ 21 generateDataSet(callback?: (err: AWSError, data: MarketplaceCommerceAnalytics.Types.GenerateDataSetResult) => void): Request<MarketplaceCommerceAnalytics.Types.GenerateDataSetResult, AWSError>; 22 /** 23 * 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. 24 */ 25 startSupportDataExport(params: MarketplaceCommerceAnalytics.Types.StartSupportDataExportRequest, callback?: (err: AWSError, data: MarketplaceCommerceAnalytics.Types.StartSupportDataExportResult) => void): Request<MarketplaceCommerceAnalytics.Types.StartSupportDataExportResult, AWSError>; 26 /** 27 * 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. 28 */ 29 startSupportDataExport(callback?: (err: AWSError, data: MarketplaceCommerceAnalytics.Types.StartSupportDataExportResult) => void): Request<MarketplaceCommerceAnalytics.Types.StartSupportDataExportResult, AWSError>; 30 } 31 declare namespace MarketplaceCommerceAnalytics.Types { 32 export type CustomerDefinedValues = {[key: string]: OptionalValue}; 33 export type DataSetPublicationDate = Date; 34 export type DataSetRequestId = string; 35 export type 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"|"disbursed_amount_by_product"|"disbursed_amount_by_product_with_uncollected_funds"|"disbursed_amount_by_customer_geo"|"disbursed_amount_by_age_of_uncollected_funds"|"disbursed_amount_by_age_of_disbursed_funds"|"customer_profile_by_industry"|"customer_profile_by_revenue"|"customer_profile_by_geography"|string; 36 export type DestinationS3BucketName = string; 37 export type DestinationS3Prefix = string; 38 export type ExceptionMessage = string; 39 export type FromDate = Date; 40 export interface GenerateDataSetRequest { 41 /** 42 * 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. 43 */ 44 dataSetType: DataSetType; 45 /** 46 * 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). 47 */ 48 dataSetPublicationDate: DataSetPublicationDate; 49 /** 50 * The Amazon Resource Name (ARN) of the Role with an attached permissions policy to interact with the provided AWS services. 51 */ 52 roleNameArn: RoleNameArn; 53 /** 54 * The name (friendly name, not ARN) of the destination S3 bucket. 55 */ 56 destinationS3BucketName: DestinationS3BucketName; 57 /** 58 * (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. 59 */ 60 destinationS3Prefix?: DestinationS3Prefix; 61 /** 62 * 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. 63 */ 64 snsTopicArn: SnsTopicArn; 65 /** 66 * (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. 67 */ 68 customerDefinedValues?: CustomerDefinedValues; 69 } 70 export interface GenerateDataSetResult { 71 /** 72 * 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. 73 */ 74 dataSetRequestId?: DataSetRequestId; 75 } 76 export type OptionalKey = string; 77 export type OptionalValue = string; 78 export type RoleNameArn = string; 79 export type SnsTopicArn = string; 80 export interface StartSupportDataExportRequest { 81 /** 82 * 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 83 */ 84 dataSetType: SupportDataSetType; 85 /** 86 * The start date from which to retrieve the data set. This parameter only affects the customer_support_contacts_data data set type. 87 */ 88 fromDate: FromDate; 89 /** 90 * The Amazon Resource Name (ARN) of the Role with an attached permissions policy to interact with the provided AWS services. 91 */ 92 roleNameArn: RoleNameArn; 93 /** 94 * The name (friendly name, not ARN) of the destination S3 bucket. 95 */ 96 destinationS3BucketName: DestinationS3BucketName; 97 /** 98 * (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. 99 */ 100 destinationS3Prefix?: DestinationS3Prefix; 101 /** 102 * 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. 103 */ 104 snsTopicArn: SnsTopicArn; 105 /** 106 * (Optional) Key-value pairs which will be returned, unmodified, in the Amazon SNS notification message and the data set metadata file. 107 */ 108 customerDefinedValues?: CustomerDefinedValues; 109 } 110 export interface StartSupportDataExportResult { 111 /** 112 * 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. 113 */ 114 dataSetRequestId?: DataSetRequestId; 115 } 116 export type SupportDataSetType = "customer_support_contacts_data"|"test_customer_support_contacts_data"|string; 117 /** 118 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. 119 */ 120 export type apiVersion = "2015-07-01"|"latest"|string; 121 export interface ClientApiVersions { 122 /** 123 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. 124 */ 125 apiVersion?: apiVersion; 126 } 127 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; 128 } 129 export = MarketplaceCommerceAnalytics;