price_lists
Creates, updates, deletes, gets or lists a price_lists resource.
Overview
| Name | price_lists |
| Type | Resource |
| Id | aws.pricing.price_lists |
Fields
The following fields are returned by SELECT queries:
- list_price_lists
| Name | Datatype | Description |
|---|---|---|
currency_code | string | The three alphabetical character ISO-4217 currency code the Price List files are denominated in. (pattern: <code>[A-Z]{3}</code>) |
file_formats | array | The format you want to retrieve your Price List files. The FileFormat can be obtained from the ListPriceList response. |
price_list_arn | string | The unique identifier that maps to where your Price List files are located. PriceListArn can be obtained from the ListPriceList response. (pattern: <code>arn:[A-Za-z0-9][-.A-Za-z0-9]{0,62}:pricing:::price-list/[A-Za-z0-9+_/.-]{1,1023}</code>) |
region_code | string | 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. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_price_lists | select | region | 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 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. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
region | string | AWS region (default: us-east-1) |
SELECT examples
- list_price_lists
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 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.
SELECT
currency_code,
file_formats,
price_list_arn,
region_code
FROM aws.pricing.price_lists
WHERE region = '{{ region }}' -- required
;