'2.0', 'service' => '

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 Location, Storage Class, and Operating System, and provides prices at the SKU level. You can use the Amazon Web Services Price List to do the following:

Build cost control and scenario planning tools
Reconcile billing data
Forecast future spend for budgeting purposes
Provide cost benefit analysis that compare your internal workloads with Amazon Web Services

Use GetServices without a service code to retrieve the service codes for all Amazon Web Services, then GetServices with a service code to retrieve the attribute names for that service. After you have the service code and attribute names, you can use GetAttributeValues to see what values are available for an attribute. With the service code and an attribute name and value, you can use GetProducts to find specific products that you\'re interested in, such as an AmazonEC2 instance, with a Provisioned IOPS volumeType.

You can use the following endpoints for the Amazon Web Services Price List API:

https://api.pricing.us-east-1.amazonaws.com
https://api.pricing.ap-south-1.amazonaws.com

', 'operations' => [ 'DescribeServices' => '

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 AmazonEC2, 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 volumeType, maxIopsVolume, operation, locationType, and instanceCapacity10xlarge.

', 'GetAttributeValues' => '

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 Offer File Definitions in the Billing and Cost Management User Guide.

', 'GetPriceListFileUrl' => '

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 Amazon Web Services Service Terms (Section 1.10).

This returns the URL that you can retrieve your Price List file from. This URL is based on the PriceListArn and FileFormat that you retrieve from the ListPriceLists response.

', 'GetProducts' => '

Returns a list of all products that match the filter criteria.

', 'ListPriceLists' => '

This returns a list of Price List references that the requester if authorized to view, given a ServiceCode, CurrencyCode, and an EffectiveDate. Use without a RegionCode filter to list Price List references from all available Amazon Web Services Regions. Use with a RegionCode filter to get the Price List reference that\'s specific to a specific Amazon Web Services Region. You can use the PriceListArn from the response to get your preferred Price List files through the GetPriceListFileUrl API.

', ], 'shapes' => [ 'AccessDeniedException' => [ 'base' => '

General authentication failure. The request wasn\'t signed correctly.

', 'refs' => [], ], 'AttributeNameList' => [ 'base' => NULL, 'refs' => [ 'Service$AttributeNames' => '

The attributes that are available for this service.

', ], ], 'AttributeValue' => [ 'base' => '

The values of a given attribute, such as Throughput Optimized HDD or Provisioned IOPS for the Amazon EC2 volumeType attribute.

', 'refs' => [ 'AttributeValueList$member' => NULL, ], ], 'AttributeValueList' => [ 'base' => NULL, 'refs' => [ 'GetAttributeValuesResponse$AttributeValues' => '

The list of values for an attribute. For example, Throughput Optimized HDD and Provisioned IOPS are two available values for the AmazonEC2 volumeType.

', ], ], 'BoxedInteger' => [ 'base' => NULL, 'refs' => [ 'DescribeServicesRequest$MaxResults' => '

The maximum number of results that you want returned in the response.

', 'GetAttributeValuesRequest$MaxResults' => '

The maximum number of results to return in response.

', 'GetProductsRequest$MaxResults' => '

The maximum number of results to return in the response.

', ], ], 'CurrencyCode' => [ 'base' => NULL, 'refs' => [ 'ListPriceListsRequest$CurrencyCode' => '

The three alphabetical character ISO-4217 currency code that the Price List files are denominated in.

', 'PriceList$CurrencyCode' => '

The three alphabetical character ISO-4217 currency code the Price List files are denominated in.

', ], ], 'DescribeServicesRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeServicesResponse' => [ 'base' => NULL, 'refs' => [], ], 'EffectiveDate' => [ 'base' => NULL, 'refs' => [ 'ListPriceListsRequest$EffectiveDate' => '

The date that the Price List file prices are effective from.

', ], ], 'ExpiredNextTokenException' => [ 'base' => '

The pagination token expired. Try again without a pagination token.

', 'refs' => [], ], 'FileFormat' => [ 'base' => NULL, 'refs' => [ 'FileFormats$member' => NULL, 'GetPriceListFileUrlRequest$FileFormat' => '

The format that you want to retrieve your Price List files in. The FileFormat can be obtained from the ListPriceLists response.

', ], ], 'FileFormats' => [ 'base' => NULL, 'refs' => [ 'PriceList$FileFormats' => '

The format you want to retrieve your Price List files. The FileFormat can be obtained from the ListPriceList response.

', ], ], 'Filter' => [ 'base' => '

The constraints that you want all returned products to match.

', 'refs' => [ 'Filters$member' => NULL, ], ], 'FilterType' => [ 'base' => NULL, 'refs' => [ 'Filter$Type' => '

The type of filter that you want to use.

Valid values are: TERM_MATCH. TERM_MATCH returns only products that match both the given filter field and the given value.

', ], ], 'Filters' => [ 'base' => NULL, 'refs' => [ 'GetProductsRequest$Filters' => '

The list of filters that limit the returned products. only products that match all filters are returned.

', ], ], 'GetAttributeValuesRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetAttributeValuesResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetPriceListFileUrlRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetPriceListFileUrlResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetProductsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetProductsResponse' => [ 'base' => NULL, 'refs' => [], ], 'InternalErrorException' => [ 'base' => '

An error on the server occurred during the processing of your request. Try again later.

', 'refs' => [], ], 'InvalidNextTokenException' => [ 'base' => '

The pagination token is invalid. Try again without a pagination token.

', 'refs' => [], ], 'InvalidParameterException' => [ 'base' => '

One or more parameters had an invalid value.

', 'refs' => [], ], 'ListPriceListsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListPriceListsResponse' => [ 'base' => NULL, 'refs' => [], ], 'MaxResults' => [ 'base' => NULL, 'refs' => [ 'ListPriceListsRequest$MaxResults' => '

The maximum number of results to return in the response.

', ], ], 'NotFoundException' => [ 'base' => '

The requested resource can\'t be found.

', 'refs' => [], ], 'PriceList' => [ 'base' => '

This is the type of price list references that match your request.

', 'refs' => [ 'PriceLists$member' => NULL, ], ], 'PriceListArn' => [ 'base' => NULL, 'refs' => [ 'GetPriceListFileUrlRequest$PriceListArn' => '

The unique identifier that maps to where your Price List files are located. PriceListArn can be obtained from the ListPriceLists response.

', 'PriceList$PriceListArn' => '

The unique identifier that maps to where your Price List files are located. PriceListArn can be obtained from the ListPriceList response.

', ], ], 'PriceListJsonItems' => [ 'base' => NULL, 'refs' => [ 'GetProductsResponse$PriceList' => '

The list of products that match your filters. The list contains both the product metadata and the price information.

', ], ], 'PriceLists' => [ 'base' => NULL, 'refs' => [ 'ListPriceListsResponse$PriceLists' => '

The type of price list references that match your request.

', ], ], 'RegionCode' => [ 'base' => NULL, 'refs' => [ 'ListPriceListsRequest$RegionCode' => '

This is used to filter the Price List by Amazon Web Services Region. For example, to get the price list only for the US East (N. Virginia) Region, use us-east-1. If nothing is specified, you retrieve price lists for all applicable Regions. The available RegionCode list can be retrieved from GetAttributeValues API.

', 'PriceList$RegionCode' => '

', ], ], 'Service' => [ 'base' => '

The metadata for a service, such as the service code and available attribute names.

', 'refs' => [ 'ServiceList$member' => NULL, ], ], 'ServiceCode' => [ 'base' => NULL, 'refs' => [ 'ListPriceListsRequest$ServiceCode' => '

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 AmazonEC2. For a full list of service codes containing On-Demand and Reserved Instance (RI) pricing, use the DescribeServices API.

To retrieve the Compute Savings Plan price lists, use ComputeSavingsPlans. To retrieve Machine Learning Savings Plans price lists, use MachineLearningSavingsPlans.

', ], ], 'ServiceList' => [ 'base' => NULL, 'refs' => [ 'DescribeServicesResponse$Services' => '

The service metadata for the service or services in the response.

', ], ], 'String' => [ 'base' => NULL, 'refs' => [ 'AttributeNameList$member' => NULL, 'AttributeValue$Value' => '

The specific value of an attributeName.

', 'DescribeServicesRequest$ServiceCode' => '

The code for the service whose information you want to retrieve, such as AmazonEC2. You can use the ServiceCode to filter the results in a GetProducts call. To retrieve a list of all services, leave this blank.

', 'DescribeServicesRequest$FormatVersion' => '

The format version that you want the response to be in.

Valid values are: aws_v1

', 'DescribeServicesRequest$NextToken' => '

The pagination token that indicates the next set of results that you want to retrieve.

', 'DescribeServicesResponse$FormatVersion' => '

The format version of the response. For example, aws_v1.

', 'DescribeServicesResponse$NextToken' => '

The pagination token for the next set of retrievable results.

', 'Filter$Field' => '

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: ServiceCode, and all attribute names

For example, you can filter by the AmazonEC2 service code and the volumeType attribute name to get the prices for only Amazon EC2 volumes.

', 'Filter$Value' => '

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 AmazonEC2. If you\'re filtering by attribute name, this is the attribute value that you want the returned products to match, such as a Provisioned IOPS volume.

', 'GetAttributeValuesRequest$ServiceCode' => '

The service code for the service whose attributes you want to retrieve. For example, if you want the retrieve an EC2 attribute, use AmazonEC2.

', 'GetAttributeValuesRequest$AttributeName' => '

The name of the attribute that you want to retrieve the values for, such as volumeType.

', 'GetAttributeValuesRequest$NextToken' => '

The pagination token that indicates the next set of results that you want to retrieve.

', 'GetAttributeValuesResponse$NextToken' => '

The pagination token that indicates the next set of results to retrieve.

', 'GetPriceListFileUrlResponse$Url' => '

The URL to download your Price List file from.

', 'GetProductsRequest$ServiceCode' => '

The code for the service whose products you want to retrieve.

', 'GetProductsRequest$FormatVersion' => '

The format version that you want the response to be in.

Valid values are: aws_v1

', 'GetProductsRequest$NextToken' => '

The pagination token that indicates the next set of results that you want to retrieve.

', 'GetProductsResponse$FormatVersion' => '

The format version of the response. For example, aws_v1.

', 'GetProductsResponse$NextToken' => '

The pagination token that indicates the next set of results to retrieve.

', 'ListPriceListsRequest$NextToken' => '

The pagination token that indicates the next set of results that you want to retrieve.

', 'ListPriceListsResponse$NextToken' => '

The pagination token that indicates the next set of results to retrieve.

', 'Service$ServiceCode' => '

The code for the Amazon Web Services service.

', ], ], 'SynthesizedJsonPriceListJsonItem' => [ 'base' => NULL, 'refs' => [ 'PriceListJsonItems$member' => NULL, ], ], 'errorMessage' => [ 'base' => NULL, 'refs' => [ 'AccessDeniedException$Message' => NULL, 'ExpiredNextTokenException$Message' => NULL, 'InternalErrorException$Message' => NULL, 'InvalidNextTokenException$Message' => NULL, 'InvalidParameterException$Message' => NULL, 'NotFoundException$Message' => NULL, ], ], ],];