service-2.json

{
 "version":"2.0",
 "metadata":{
 "apiVersion":"2017-10-15",
 "endpointPrefix":"api.pricing",
 "jsonVersion":"1.1",
 "protocol":"json",
 "serviceAbbreviation":"AWS Pricing",
 "serviceFullName":"AWS Price List Service",
 "serviceId":"Pricing",
 "signatureVersion":"v4",
 "signingName":"pricing",
 "targetPrefix":"AWSPriceListService",
 "uid":"pricing-2017-10-15"
 },
 "operations":{
 "DescribeServices":{
 "name":"DescribeServices",
 "http":{
 "method":"POST",
 "requestUri":"/"
 },
 "input":{"shape":"DescribeServicesRequest"},
 "output":{"shape":"DescribeServicesResponse"},
 "errors":[
 {"shape":"InvalidParameterException"},
 {"shape":"InvalidNextTokenException"},
 {"shape":"NotFoundException"},
 {"shape":"InternalErrorException"},
 {"shape":"ThrottlingException"},
 {"shape":"ExpiredNextTokenException"}
 ],
 "documentation":"Returns the metadata for one service or a list of the metadata for all services. Use this without a service code to get the service codes for all services. Use it with a service code, such as <code>AmazonEC2</code>, to get information specific to that service, such as the attribute names available for that service. For example, some of the attribute names available for EC2 are <code>volumeType</code>, <code>maxIopsVolume</code>, <code>operation</code>, <code>locationType</code>, and <code>instanceCapacity10xlarge</code>."
 },
 "GetAttributeValues":{
 "name":"GetAttributeValues",
 "http":{
 "method":"POST",
 "requestUri":"/"
 },
 "input":{"shape":"GetAttributeValuesRequest"},
 "output":{"shape":"GetAttributeValuesResponse"},
 "errors":[
 {"shape":"InvalidParameterException"},
 {"shape":"InvalidNextTokenException"},
 {"shape":"NotFoundException"},
 {"shape":"InternalErrorException"},
 {"shape":"ThrottlingException"},
 {"shape":"ExpiredNextTokenException"}
 ],
 "documentation":"Returns a list of attribute values. Attributes are similar to the details in a Price List API offer file. For a list of available attributes, see <a href=\"https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/reading-an-offer.html#pps-defs\">Offer File Definitions</a> in the <a href=\"https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/billing-what-is.html\">Billing and Cost Management User Guide</a>."
 },
 "GetPriceListFileUrl":{
 "name":"GetPriceListFileUrl",
 "http":{
 "method":"POST",
 "requestUri":"/"
 },
 "input":{"shape":"GetPriceListFileUrlRequest"},
 "output":{"shape":"GetPriceListFileUrlResponse"},
 "errors":[
 {"shape":"InvalidParameterException"},
 {"shape":"NotFoundException"},
 {"shape":"AccessDeniedException"},
 {"shape":"InternalErrorException"},
 {"shape":"ThrottlingException"}
 ],
 "documentation":" This feature is in preview release and is subject to change. Your use of Amazon Web Services Price List API is subject to the Beta Service Participation terms of the <a href=\"https://aws.amazon.com/service-terms/\">Amazon Web Services Service Terms</a> (Section 1.10). This returns the URL that you can retrieve your Price List file from. This URL is based on the <code>PriceListArn</code> and <code>FileFormat</code> that you retrieve from the <a href=\"https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_pricing_ListPriceLists.html\">ListPriceLists</a> response. "
 },
 "GetProducts":{
 "name":"GetProducts",
 "http":{
 "method":"POST",
 "requestUri":"/"
 },
 "input":{"shape":"GetProductsRequest"},
 "output":{"shape":"GetProductsResponse"},
 "errors":[
 {"shape":"InvalidParameterException"},
 {"shape":"InvalidNextTokenException"},
 {"shape":"NotFoundException"},
 {"shape":"InternalErrorException"},
 {"shape":"ThrottlingException"},
 {"shape":"ExpiredNextTokenException"}
 ],
 "documentation":"Returns a list of all products that match the filter criteria."
 },
 "ListPriceLists":{
 "name":"ListPriceLists",
 "http":{
 "method":"POST",
 "requestUri":"/"
 },
 "input":{"shape":"ListPriceListsRequest"},
 "output":{"shape":"ListPriceListsResponse"},
 "errors":[
 {"shape":"InvalidParameterException"},
 {"shape":"InvalidNextTokenException"},
 {"shape":"NotFoundException"},
 {"shape":"AccessDeniedException"},
 {"shape":"InternalErrorException"},
 {"shape":"ThrottlingException"},
 {"shape":"ExpiredNextTokenException"}
 ],
 "documentation":" This feature is in preview release and is subject to change. Your use of Amazon Web Services Price List API is subject to the Beta Service Participation terms of the <a href=\"https://aws.amazon.com/service-terms/\">Amazon Web Services Service Terms</a> (Section 1.10). This returns a list of Price List references that the requester if authorized to view, given a <code>ServiceCode</code>, <code>CurrencyCode</code>, and an <code>EffectiveDate</code>. Use without a <code>RegionCode</code> filter to list Price List references from all available Amazon Web Services Regions. Use with a <code>RegionCode</code> filter to get the Price List reference that's specific to a specific Amazon Web Services Region. You can use the <code>PriceListArn</code> from the response to get your preferred Price List files through the <a href=\"https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_pricing_GetPriceListFileUrl.html\">GetPriceListFileUrl</a> API."
 }
 },
 "shapes":{
 "AccessDeniedException":{
 "type":"structure",
 "members":{
 "Message":{"shape":"errorMessage"}
 },
 "documentation":"General authentication failure. The request wasn't signed correctly.",
 "exception":true
 },
 "AttributeNameList":{
 "type":"list",
 "member":{"shape":"String"}
 },
 "AttributeValue":{
 "type":"structure",
 "members":{
 "Value":{
 "shape":"String",
 "documentation":"The specific value of an <code>attributeName</code>."
 }
 },
 "documentation":"The values of a given attribute, such as <code>Throughput Optimized HDD</code> or <code>Provisioned IOPS</code> for the <code>Amazon EC2</code> <code>volumeType</code> attribute."
 },
 "AttributeValueList":{
 "type":"list",
 "member":{"shape":"AttributeValue"}
 },
 "BoxedInteger":{
 "type":"integer",
 "box":true,
 "max":100,
 "min":1
 },
 "CurrencyCode":{
 "type":"string",
 "pattern":"[A-Z]{3}"
 },
 "DescribeServicesRequest":{
 "type":"structure",
 "members":{
 "ServiceCode":{
 "shape":"String",
 "documentation":"The code for the service whose information you want to retrieve, such as <code>AmazonEC2</code>. You can use the <code>ServiceCode</code> to filter the results in a <code>GetProducts</code> call. To retrieve a list of all services, leave this blank."
 },
 "FormatVersion":{
 "shape":"String",
 "documentation":"The format version that you want the response to be in. Valid values are: <code>aws_v1</code> "
 },
 "NextToken":{
 "shape":"String",
 "documentation":"The pagination token that indicates the next set of results that you want to retrieve."
 },
 "MaxResults":{
 "shape":"BoxedInteger",
 "documentation":"The maximum number of results that you want returned in the response."
 }
 }
 },
 "DescribeServicesResponse":{
 "type":"structure",
 "members":{
 "Services":{
 "shape":"ServiceList",
 "documentation":"The service metadata for the service or services in the response."
 },
 "FormatVersion":{
 "shape":"String",
 "documentation":"The format version of the response. For example, <code>aws_v1</code>."
 },
 "NextToken":{
 "shape":"String",
 "documentation":"The pagination token for the next set of retrievable results."
 }
 }
 },
 "EffectiveDate":{"type":"timestamp"},
 "ExpiredNextTokenException":{
 "type":"structure",
 "members":{
 "Message":{"shape":"errorMessage"}
 },
 "documentation":"The pagination token expired. Try again without a pagination token.",
 "exception":true
 },
 "FileFormat":{
 "type":"string",
 "max":255,
 "min":1
 },
 "FileFormats":{
 "type":"list",
 "member":{"shape":"FileFormat"}
 },
 "Filter":{
 "type":"structure",
 "required":[
 "Type",
 "Field",
 "Value"
 ],
 "members":{
 "Type":{
 "shape":"FilterType",
 "documentation":"The type of filter that you want to use. Valid values are: <code>TERM_MATCH</code>. <code>TERM_MATCH</code> returns only products that match both the given filter field and the given value."
 },
 "Field":{
 "shape":"String",
 "documentation":"The product metadata field that you want to filter on. You can filter by just the service code to see all products for a specific service, filter by just the attribute name to see a specific attribute for multiple services, or use both a service code and an attribute name to retrieve only products that match both fields. Valid values include: <code>ServiceCode</code>, and all attribute names For example, you can filter by the <code>AmazonEC2</code> service code and the <code>volumeType</code> attribute name to get the prices for only Amazon EC2 volumes."
 },
 "Value":{
 "shape":"String",
 "documentation":"The service code or attribute value that you want to filter by. If you're filtering by service code this is the actual service code, such as <code>AmazonEC2</code>. If you're filtering by attribute name, this is the attribute value that you want the returned products to match, such as a <code>Provisioned IOPS</code> volume."
 }
 },
 "documentation":"The constraints that you want all returned products to match."
 },
 "FilterType":{
 "type":"string",
 "enum":["TERM_MATCH"]
 },
 "Filters":{
 "type":"list",
 "member":{"shape":"Filter"}
 },
 "GetAttributeValuesRequest":{
 "type":"structure",
 "required":[
 "ServiceCode",
 "AttributeName"
 ],
 "members":{
 "ServiceCode":{
 "shape":"String",
 "documentation":"The service code for the service whose attributes you want to retrieve. For example, if you want the retrieve an EC2 attribute, use <code>AmazonEC2</code>."
 },
 "AttributeName":{
 "shape":"String",
 "documentation":"The name of the attribute that you want to retrieve the values for, such as <code>volumeType</code>."
 },
 "NextToken":{
 "shape":"String",
 "documentation":"The pagination token that indicates the next set of results that you want to retrieve."
 },
 "MaxResults":{
 "shape":"BoxedInteger",
 "documentation":"The maximum number of results to return in response."
 }
 }
 },
 "GetAttributeValuesResponse":{
 "type":"structure",
 "members":{
 "AttributeValues":{
 "shape":"AttributeValueList",
 "documentation":"The list of values for an attribute. For example, <code>Throughput Optimized HDD</code> and <code>Provisioned IOPS</code> are two available values for the <code>AmazonEC2</code> <code>volumeType</code>."
 },
 "NextToken":{
 "shape":"String",
 "documentation":"The pagination token that indicates the next set of results to retrieve."
 }
 }
 },
 "GetPriceListFileUrlRequest":{
 "type":"structure",
 "required":[
 "PriceListArn",
 "FileFormat"
 ],
 "members":{
 "PriceListArn":{
 "shape":"PriceListArn",
 "documentation":"The unique identifier that maps to where your Price List files are located. <code>PriceListArn</code> can be obtained from the <a href=\"https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_pricing_ListPriceLists.html\">ListPriceLists</a> response. "
 },
 "FileFormat":{
 "shape":"FileFormat",
 "documentation":"The format that you want to retrieve your Price List files in. The <code>FileFormat</code> can be obtained from the <a href=\"https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_pricing_ListPriceLists.html\">ListPriceLists</a> response. "
 }
 }
 },
 "GetPriceListFileUrlResponse":{
 "type":"structure",
 "members":{
 "Url":{
 "shape":"String",
 "documentation":"The URL to download your Price List file from. "
 }
 }
 },
 "GetProductsRequest":{
 "type":"structure",
 "required":["ServiceCode"],
 "members":{
 "ServiceCode":{
 "shape":"String",
 "documentation":"The code for the service whose products you want to retrieve. "
 },
 "Filters":{
 "shape":"Filters",
 "documentation":"The list of filters that limit the returned products. only products that match all filters are returned."
 },
 "FormatVersion":{
 "shape":"String",
 "documentation":"The format version that you want the response to be in. Valid values are: <code>aws_v1</code> "
 },
 "NextToken":{
 "shape":"String",
 "documentation":"The pagination token that indicates the next set of results that you want to retrieve."
 },
 "MaxResults":{
 "shape":"BoxedInteger",
 "documentation":"The maximum number of results to return in the response."
 }
 }
 },
 "GetProductsResponse":{
 "type":"structure",
 "members":{
 "FormatVersion":{
 "shape":"String",
 "documentation":"The format version of the response. For example, aws_v1."
 },
 "PriceList":{
 "shape":"PriceListJsonItems",
 "documentation":"The list of products that match your filters. The list contains both the product metadata and the price information."
 },
 "NextToken":{
 "shape":"String",
 "documentation":"The pagination token that indicates the next set of results to retrieve."
 }
 }
 },
 "InternalErrorException":{
 "type":"structure",
 "members":{
 "Message":{"shape":"errorMessage"}
 },
 "documentation":"An error on the server occurred during the processing of your request. Try again later.",
 "exception":true,
 "fault":true,
 "retryable":{"throttling":false}
 },
 "InvalidNextTokenException":{
 "type":"structure",
 "members":{
 "Message":{"shape":"errorMessage"}
 },
 "documentation":"The pagination token is invalid. Try again without a pagination token.",
 "exception":true
 },
 "InvalidParameterException":{
 "type":"structure",
 "members":{
 "Message":{"shape":"errorMessage"}
 },
 "documentation":"One or more parameters had an invalid value.",
 "exception":true
 },
 "ListPriceListsRequest":{
 "type":"structure",
 "required":[
 "ServiceCode",
 "EffectiveDate",
 "CurrencyCode"
 ],
 "members":{
 "ServiceCode":{
 "shape":"ServiceCode",
 "documentation":"The service code or the Savings Plan service code for the attributes that you want to retrieve. For example, to get the list of applicable Amazon EC2 price lists, use <code>AmazonEC2</code>. For a full list of service codes containing On-Demand and Reserved Instance (RI) pricing, use the <a href=\"https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_pricing_DescribeServices.html#awscostmanagement-pricing_DescribeServices-request-FormatVersion\">DescribeServices</a> API. To retrieve the Reserved Instance and Compute Savings Plan price lists, use <code>ComputeSavingsPlans</code>. To retrieve Machine Learning Savings Plans price lists, use <code>MachineLearningSavingsPlans</code>. "
 },
 "EffectiveDate":{
 "shape":"EffectiveDate",
 "documentation":"The date that the Price List file prices are effective from. "
 },
 "RegionCode":{
 "shape":"RegionCode",
 "documentation":"This is used to filter the Price List by Amazon Web Services Region. For example, to get the price list only for the <code>US East (N. Virginia)</code> Region, use <code>us-east-1</code>. If nothing is specified, you retrieve price lists for all applicable Regions. The available <code>RegionCode</code> list can be retrieved from <a href=\"https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_pricing_GetAttributeValues.html\">GetAttributeValues</a> API."
 },
 "CurrencyCode":{
 "shape":"CurrencyCode",
 "documentation":"The three alphabetical character ISO-4217 currency code that the Price List files are denominated in. "
 },
 "NextToken":{
 "shape":"String",
 "documentation":"The pagination token that indicates the next set of results that you want to retrieve. "
 },
 "MaxResults":{
 "shape":"MaxResults",
 "documentation":"The maximum number of results to return in the response. "
 }
 }
 },
 "ListPriceListsResponse":{
 "type":"structure",
 "members":{
 "PriceLists":{
 "shape":"PriceLists",
 "documentation":"The type of price list references that match your request. "
 },
 "NextToken":{
 "shape":"String",
 "documentation":"The pagination token that indicates the next set of results to retrieve. "
 }
 }
 },
 "MaxResults":{
 "type":"integer",
 "box":true,
 "max":100,
 "min":1
 },
 "NotFoundException":{
 "type":"structure",
 "members":{
 "Message":{"shape":"errorMessage"}
 },
 "documentation":"The requested resource can't be found.",
 "exception":true
 },
 "PriceList":{
 "type":"structure",
 "members":{
 "PriceListArn":{
 "shape":"PriceListArn",
 "documentation":"The unique identifier that maps to where your Price List files are located. <code>PriceListArn</code> can be obtained from the <a href=\"https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_pricing_ListPriceLists.html\"> <code>ListPriceList</code> </a> response. "
 },
 "RegionCode":{
 "shape":"RegionCode",
 "documentation":"This is used to filter the Price List by Amazon Web Services Region. For example, to get the price list only for the <code>US East (N. Virginia)</code> Region, use <code>us-east-1</code>. If nothing is specified, you retrieve price lists for all applicable Regions. The available <code>RegionCode</code> list can be retrieved from <a href=\"https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_pricing_GetAttributeValues.html\"> <code>GetAttributeValues</code> </a> API. "
 },
 "CurrencyCode":{
 "shape":"CurrencyCode",
 "documentation":"The three alphabetical character ISO-4217 currency code the Price List files are denominated in. "
 },
 "FileFormats":{
 "shape":"FileFormats",
 "documentation":"The format you want to retrieve your Price List files. The <code>FileFormat</code> can be obtained from the <a href=\"https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_pricing_ListPriceLists.html\"> <code>ListPriceList</code> </a> response. "
 }
 },
 "documentation":" This feature is in preview release and is subject to change. Your use of Amazon Web Services Price List API is subject to the Beta Service Participation terms of the <a href=\"https://aws.amazon.com/service-terms/\">Amazon Web Services Service Terms</a> (Section 1.10). This is the type of price list references that match your request. "
 },
 "PriceListArn":{
 "type":"string",
 "max":2048,
 "min":18,
 "pattern":"arn:[A-Za-z0-9][-.A-Za-z0-9]{0,62}:pricing:::price-list/[A-Za-z0-9+_/.-]{1,1023}"
 },
 "PriceListJsonItems":{
 "type":"list",
 "member":{
 "shape":"SynthesizedJsonPriceListJsonItem",
 "jsonvalue":true
 }
 },
 "PriceLists":{
 "type":"list",
 "member":{"shape":"PriceList"}
 },
 "RegionCode":{
 "type":"string",
 "max":255,
 "min":1
 },
 "Service":{
 "type":"structure",
 "required":["ServiceCode"],
 "members":{
 "ServiceCode":{
 "shape":"String",
 "documentation":"The code for the Amazon Web Services service."
 },
 "AttributeNames":{
 "shape":"AttributeNameList",
 "documentation":"The attributes that are available for this service."
 }
 },
 "documentation":"The metadata for a service, such as the service code and available attribute names."
 },
 "ServiceCode":{
 "type":"string",
 "max":32,
 "min":1
 },
 "ServiceList":{
 "type":"list",
 "member":{"shape":"Service"}
 },
 "String":{"type":"string"},
 "SynthesizedJsonPriceListJsonItem":{"type":"string"},
 "ThrottlingException":{
 "type":"structure",
 "members":{
 "Message":{"shape":"errorMessage"}
 },
 "documentation":"You've made too many requests exceeding service quotas. ",
 "exception":true,
 "retryable":{"throttling":true}
 },
 "errorMessage":{"type":"string"}
 },
 "documentation":"The Amazon Web Services Price List API is a centralized and convenient way to programmatically query Amazon Web Services for services, products, and pricing information. The Amazon Web Services Price List uses standardized product attributes such as <code>Location</code>, <code>Storage Class</code>, and <code>Operating System</code>, and provides prices at the SKU level. You can use the Amazon Web Services Price List to do the following: <ul> <li> Build cost control and scenario planning tools </li> <li> Reconcile billing data </li> <li> Forecast future spend for budgeting purposes </li> <li> Provide cost benefit analysis that compare your internal workloads with Amazon Web Services </li> </ul> Use <code>GetServices</code> without a service code to retrieve the service codes for all Amazon Web Services, then <code>GetServices</code> with a service code to retrieve the attribute names for that service. After you have the service code and attribute names, you can use <code>GetAttributeValues</code> to see what values are available for an attribute. With the service code and an attribute name and value, you can use <code>GetProducts</code> to find specific products that you're interested in, such as an <code>AmazonEC2</code> instance, with a <code>Provisioned IOPS</code> <code>volumeType</code>. For more information, see <a href=\"https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/price-changes.html\">Using the Amazon Web Services Price List API</a> in the Billing User Guide."
}

docroot: /var/www/469ed2f6-4d4b-4a8a-9f5e-ee4ef04d3bc8/public_html

curdir: /usr/lib/python3/dist-packages/botocore/data/pricing/2017-10-15

	.	4096
	..	4096
X	endpoint-rule-set-1.json	14910
X	examples-1.json	4263
X	paginators-1.json	820
X	service-2.json	24179
X	waiters-2.json	39