models.marketplacecommerceanalytics-2015-07-01-model.json Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-osgi Show documentation
The AWS SDK for Java with support for OSGi. The AWS SDK for Java provides Java APIs for building software on AWS' cost-effective, scalable, and reliable infrastructure products. The AWS Java SDK allows developers to code against APIs for all of Amazon's infrastructure web services (Amazon S3, Amazon EC2, Amazon SQS, Amazon Relational Database Service, Amazon AutoScaling, etc).
There is a newer version: 1.11.60
Show newest version
{
  "version":"2.0",
  "metadata":{
    "apiVersion":"2015-07-01",
    "endpointPrefix":"marketplacecommerceanalytics",
    "jsonVersion":"1.1",
    "protocol":"json",
    "serviceFullName":"AWS Marketplace Commerce Analytics",
    "signatureVersion":"v4",
    "signingName":"marketplacecommerceanalytics",
    "targetPrefix":"MarketplaceCommerceAnalytics20150701"
  },
  "operations":{
    "GenerateDataSet":{
      "name":"GenerateDataSet",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{"shape":"GenerateDataSetRequest"},
      "output":{"shape":"GenerateDataSetResult"},
      "errors":[
        {"shape":"MarketplaceCommerceAnalyticsException"}
      ],
      "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:GetTopicAttributes, sns:Publish, iam:GetRolePolicy."
    }
  },
  "shapes":{
    "CustomerDefinedValues":{
      "type":"map",
      "key":{"shape":"OptionalKey"},
      "value":{"shape":"OptionalValue"},
      "max":5,
      "min":1
    },
    "DataSetPublicationDate":{"type":"timestamp"},
    "DataSetRequestId":{"type":"string"},
    "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_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"
      ],
      "max":255,
      "min":1
    },
    "DestinationS3BucketName":{
      "type":"string",
      "min":1
    },
    "DestinationS3Prefix":{"type":"string"},
    "ExceptionMessage":{"type":"string"},
    "GenerateDataSetRequest":{
      "type":"structure",
      "required":[
        "dataSetType",
        "dataSetPublicationDate",
        "roleNameArn",
        "destinationS3BucketName",
        "snsTopicArn"
      ],
      "members":{
        "dataSetType":{
          "shape":"DataSetType",
          "documentation":"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.
 
 "
        },
        "dataSetPublicationDate":{
          "shape":"DataSetPublicationDate",
          "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)."
        },
        "roleNameArn":{
          "shape":"RoleNameArn",
          "documentation":"The Amazon Resource Name (ARN) of the Role with an attached permissions policy to interact with the provided AWS services."
        },
        "destinationS3BucketName":{
          "shape":"DestinationS3BucketName",
          "documentation":"The name (friendly name, not ARN) of the destination S3 bucket."
        },
        "destinationS3Prefix":{
          "shape":"DestinationS3Prefix",
          "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."
        },
        "snsTopicArn":{
          "shape":"SnsTopicArn",
          "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."
        },
        "customerDefinedValues":{
          "shape":"CustomerDefinedValues",
          "documentation":"(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."
        }
      },
      "documentation":"Container for the parameters to the GenerateDataSet operation."
    },
    "GenerateDataSetResult":{
      "type":"structure",
      "members":{
        "dataSetRequestId":{
          "shape":"DataSetRequestId",
          "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."
        }
      },
      "documentation":"Container for the result of the GenerateDataSet operation."
    },
    "MarketplaceCommerceAnalyticsException":{
      "type":"structure",
      "members":{
        "message":{"shape":"ExceptionMessage"}
      },
      "documentation":"This exception is thrown when an internal service error occurs.",
      "exception":true,
      "fault":true
    },
    "OptionalKey":{
      "type":"string",
      "max":255,
      "min":1
    },
    "OptionalValue":{
      "type":"string",
      "max":255,
      "min":1
    },
    "RoleNameArn":{
      "type":"string",
      "min":1
    },
    "SnsTopicArn":{
      "type":"string",
      "min":1
    }
  },
  "documentation":"Provides AWS Marketplace business intelligence data on-demand."
}