SavingsPlans / Client / describe_savings_plans_offerings

describe_savings_plans_offerings#

SavingsPlans.Client.describe_savings_plans_offerings(**kwargs)#

Describes the offerings for the specified Savings Plans.

See also: AWS API Documentation

Request Syntax

response = client.describe_savings_plans_offerings(
    offeringIds=[
        'string',
    ],
    paymentOptions=[
        'All Upfront'|'Partial Upfront'|'No Upfront',
    ],
    productType='EC2'|'Fargate'|'Lambda'|'SageMaker',
    planTypes=[
        'Compute'|'EC2Instance'|'SageMaker',
    ],
    durations=[
        123,
    ],
    currencies=[
        'CNY'|'USD',
    ],
    descriptions=[
        'string',
    ],
    serviceCodes=[
        'string',
    ],
    usageTypes=[
        'string',
    ],
    operations=[
        'string',
    ],
    filters=[
        {
            'name': 'region'|'instanceFamily',
            'values': [
                'string',
            ]
        },
    ],
    nextToken='string',
    maxResults=123
)
Parameters:

  • offeringIds (list) –

    The IDs of the offerings.

    • (string) –

  • paymentOptions (list) –

    The payment options.

    • (string) –

  • productType (string) – The product type.

  • planTypes (list) –

    The plan types.

    • (string) –

  • durations (list) –

    The duration, in seconds.

    • (integer) –

  • currencies (list) –

    The currencies.

    • (string) –

  • descriptions (list) –

    The descriptions.

    • (string) –

  • serviceCodes (list) –

    The services.

    • (string) –

  • usageTypes (list) –

    The usage details of the line item in the billing report.

    • (string) –

  • operations (list) –

    The specific Amazon Web Services operation for the line item in the billing report.

    • (string) –

  • filters (list) –

    The filters.

    • (dict) –

      Information about a Savings Plan offering filter.

      • name (string) –

        The filter name.

      • values (list) –

        The filter values.

        • (string) –

  • nextToken (string) – The token for the next page of results.

  • maxResults (integer) – The maximum number of results to return with a single call. To retrieve additional results, make another call with the returned token value.

Return type:

dict

Returns:

Response Syntax

{
    'searchResults': [
        {
            'offeringId': 'string',
            'productTypes': [
                'EC2'|'Fargate'|'Lambda'|'SageMaker',
            ],
            'planType': 'Compute'|'EC2Instance'|'SageMaker',
            'description': 'string',
            'paymentOption': 'All Upfront'|'Partial Upfront'|'No Upfront',
            'durationSeconds': 123,
            'currency': 'CNY'|'USD',
            'serviceCode': 'string',
            'usageType': 'string',
            'operation': 'string',
            'properties': [
                {
                    'name': 'region'|'instanceFamily',
                    'value': 'string'
                },
            ]
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • searchResults (list) –

      Information about the Savings Plans offerings.

      • (dict) –

        Information about a Savings Plan offering.

        • offeringId (string) –

          The ID of the offering.

        • productTypes (list) –

          The product type.

          • (string) –

        • planType (string) –

          The plan type.

        • description (string) –

          The description.

        • paymentOption (string) –

          The payment option.

        • durationSeconds (integer) –

          The duration, in seconds.

        • currency (string) –

          The currency.

        • serviceCode (string) –

          The service.

        • usageType (string) –

          The usage details of the line item in the billing report.

        • operation (string) –

          The specific Amazon Web Services operation for the line item in the billing report.

        • properties (list) –

          The properties.

          • (dict) –

            Information about a Savings Plan offering property.

            • name (string) –

              The property name.

            • value (string) –

              The property value.

    • nextToken (string) –

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Exceptions