SavingsPlans / Client / describe_savings_plans_offering_rates

describe_savings_plans_offering_rates

SavingsPlans.Client.describe_savings_plans_offering_rates(**kwargs)

Describes the offering rates for the specified Savings Plans.

See also: AWS API Documentation

Request Syntax

response = client.describe_savings_plans_offering_rates(
    savingsPlanOfferingIds=[
        'string',
    ],
    savingsPlanPaymentOptions=[
        'All Upfront'|'Partial Upfront'|'No Upfront',
    ],
    savingsPlanTypes=[
        'Compute'|'EC2Instance'|'SageMaker',
    ],
    products=[
        'EC2'|'Fargate'|'Lambda'|'SageMaker',
    ],
    serviceCodes=[
        'AmazonEC2'|'AmazonECS'|'AmazonEKS'|'AWSLambda'|'AmazonSageMaker',
    ],
    usageTypes=[
        'string',
    ],
    operations=[
        'string',
    ],
    filters=[
        {
            'name': 'region'|'instanceFamily'|'instanceType'|'productDescription'|'tenancy'|'productId',
            'values': [
                'string',
            ]
        },
    ],
    nextToken='string',
    maxResults=123
)

Parameters:

• savingsPlanOfferingIds (list) –

  The IDs of the offerings.

  • (string) –

• savingsPlanPaymentOptions (list) –

  The payment options.

  • (string) –

• savingsPlanTypes (list) –

  The plan types.

  • (string) –

• products (list) –

  The Amazon Web Services products.

  • (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 rate 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': [
        {
            'savingsPlanOffering': {
                'offeringId': 'string',
                'paymentOption': 'All Upfront'|'Partial Upfront'|'No Upfront',
                'planType': 'Compute'|'EC2Instance'|'SageMaker',
                'durationSeconds': 123,
                'currency': 'CNY'|'USD',
                'planDescription': 'string'
            },
            'rate': 'string',
            'unit': 'Hrs'|'Lambda-GB-Second'|'Request',
            'productType': 'EC2'|'Fargate'|'Lambda'|'SageMaker',
            'serviceCode': 'AmazonEC2'|'AmazonECS'|'AmazonEKS'|'AWSLambda'|'AmazonSageMaker',
            'usageType': 'string',
            'operation': 'string',
            'properties': [
                {
                    'name': 'string',
                    'value': 'string'
                },
            ]
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) –

  • searchResults (list) –

    Information about the Savings Plans offering rates.

    • (dict) –

      Information about a Savings Plan offering rate.

      • savingsPlanOffering (dict) –

        The Savings Plan offering.

        • offeringId (string) –

          The ID of the offering.

        • paymentOption (string) –

          The payment option.

        • planType (string) –

          The plan type.

        • durationSeconds (integer) –

          The duration, in seconds.

        • currency (string) –

          The currency.

        • planDescription (string) –

          The description.

      • rate (string) –

        The Savings Plan rate.

      • unit (string) –

        The unit.

      • productType (string) –

        The product type.

      • 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 rate 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

• SavingsPlans.Client.exceptions.ValidationException

• SavingsPlans.Client.exceptions.InternalServerException