AWS Price List Service

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.

See also: AWS API Documentation

Request Syntax

client.list_price_lists(
    ServiceCode='string',
    EffectiveDate=datetime(2015, 1, 1),
    RegionCode='string',
    CurrencyCode='string',
    NextToken='string',
    MaxResults=123
)

type ServiceCode

string

param ServiceCode

[REQUIRED]

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 .

type EffectiveDate

datetime

param EffectiveDate

[REQUIRED]

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

type RegionCode

string

param 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.

type CurrencyCode

string

param CurrencyCode

[REQUIRED]

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

type NextToken

string

param NextToken

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

type MaxResults

integer

param MaxResults

The maximum number of results to return in the response.

rtype

dict

returns

Response Syntax

{
    'PriceLists': [
        {
            'PriceListArn': 'string',
            'RegionCode': 'string',
            'CurrencyCode': 'string',
            'FileFormats': [
                'string',
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • PriceLists (list) --

    The type of price list references that match your request.

    • (dict) --

      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 is the type of price list references that match your request.

      • PriceListArn (string) --

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

      • RegionCode (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.

      • CurrencyCode (string) --

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

      • FileFormats (list) --

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

        • (string) --

  • NextToken (string) --

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

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.

See also: AWS API Documentation

Request Syntax

client.get_price_list_file_url(
    PriceListArn='string',
    FileFormat='string'
)

type PriceListArn

string

param PriceListArn

[REQUIRED]

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

type FileFormat

string

param FileFormat

[REQUIRED]

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

rtype

dict

returns

Response Syntax

{
    'Url': 'string'
}

Response Structure

• (dict) --

  • Url (string) --

    The URL to download your Price List file from.