python-botocore/botocore/data/marketplacecommerceanalytics/2015-07-01/service-2.json

{
  "version":"2.0",
  "metadata":{
    "apiVersion":"2015-07-01",
    "endpointPrefix":"marketplacecommerceanalytics",
    "jsonVersion":"1.1",
    "serviceFullName":"AWS Marketplace Commerce Analytics",
    "signatureVersion":"v4",
    "signingName":"marketplacecommerceanalytics",
    "targetPrefix":"MarketplaceCommerceAnalytics20150701",
    "protocol":"json"
  },
  "documentation":"Provides AWS Marketplace business intelligence data on-demand.",
  "operations":{
    "GenerateDataSet":{
      "name":"GenerateDataSet",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{
        "shape":"GenerateDataSetRequest",
        "documentation":"Container for the parameters to the GenerateDataSet operation."
      },
      "output":{
        "shape":"GenerateDataSetResult",
        "documentation":"Container for the result of the GenerateDataSet operation."
      },
      "errors":[
        {
          "shape":"MarketplaceCommerceAnalyticsException",
          "exception":true,
          "fault":true,
          "documentation":"This exception is thrown when an internal service error occurs."
        }
      ],
      "documentation":"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:SetRegion, sns:ListTopics, sns:Publish, iam:GetRolePolicy."
    }
  },
  "shapes":{
    "DataSetPublicationDate":{
      "type":"timestamp",
      "documentation":"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)."
    },
    "DataSetRequestId":{
      "type":"string",
      "documentation":"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."
    },
    "DataSetType":{
      "type":"string",
      "enum":[
        "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_customer_geo",
        "disbursed_amount_by_age_of_uncollected_funds",
        "disbursed_amount_by_age_of_disbursed_funds",
        "customer_profile_by_industry",
        "customer_profile_by_revenue"
      ],
      "min":1,
      "max":255,
      "documentation":"The type of the data set to publish."
    },
    "DestinationS3BucketName":{
      "type":"string",
      "min":1,
      "documentation":"The name (friendly name, not ARN) of the destination S3 bucket."
    },
    "DestinationS3Prefix":{
      "type":"string",
      "documentation":"(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."
    },
    "ExceptionMessage":{"type":"string"},
    "GenerateDataSetRequest":{
      "type":"structure",
      "required":[
        "dataSetType",
        "dataSetPublicationDate",
        "roleNameArn",
        "destinationS3BucketName",
        "snsTopicArn"
      ],
      "members":{
        "dataSetType":{"shape":"DataSetType"},
        "dataSetPublicationDate":{"shape":"DataSetPublicationDate"},
        "roleNameArn":{"shape":"RoleNameArn"},
        "destinationS3BucketName":{"shape":"DestinationS3BucketName"},
        "destinationS3Prefix":{"shape":"DestinationS3Prefix"},
        "snsTopicArn":{"shape":"SnsTopicArn"}
      },
      "documentation":"Container for the parameters to the GenerateDataSet operation."
    },
    "GenerateDataSetResult":{
      "type":"structure",
      "members":{
        "dataSetRequestId":{"shape":"DataSetRequestId"}
      },
      "documentation":"Container for the result of the GenerateDataSet operation."
    },
    "MarketplaceCommerceAnalyticsException":{
      "type":"structure",
      "members":{
        "message":{"shape":"ExceptionMessage"}
      },
      "exception":true,
      "fault":true,
      "documentation":"This exception is thrown when an internal service error occurs."
    },
    "RoleNameArn":{
      "type":"string",
      "min":1,
      "documentation":"The Amazon Resource Name (ARN) of the Role with an attached permissions policy to interact with the provided AWS services."
    },
    "SnsTopicArn":{
      "type":"string",
      "min":1,
      "documentation":"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."
    }
  },
  "examples":{
  }
}