SavingsPlans / Client / describe_savings_plan_rates

describe_savings_plan_rates#

SavingsPlans.Client.describe_savings_plan_rates(**kwargs)#

Describes the rates for the specified Savings Plan.

Request Syntax

response = client.describe_savings_plan_rates(
    savingsPlanId='string',
    filters=[
        {
            'name': 'region'|'instanceType'|'productDescription'|'tenancy'|'productType'|'serviceCode'|'usageType'|'operation',
            'values': [
                'string',
            ]
        },
    ],
    nextToken='string',
    maxResults=123
)

Parameters:

savingsPlanId (string) –
[REQUIRED]

The ID of the Savings Plan.
filters (list) –
The filters.
- (dict) –
  
  Information about a Savings Plan 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

{
    'savingsPlanId': 'string',
    'searchResults': [
        {
            'rate': 'string',
            'currency': 'CNY'|'USD',
            'unit': 'Hrs'|'Lambda-GB-Second'|'Request',
            'productType': 'EC2'|'Fargate'|'Lambda'|'SageMaker',
            'serviceCode': 'AmazonEC2'|'AmazonECS'|'AmazonEKS'|'AWSLambda'|'AmazonSageMaker',
            'usageType': 'string',
            'operation': 'string',
            'properties': [
                {
                    'name': 'region'|'instanceType'|'instanceFamily'|'productDescription'|'tenancy',
                    'value': 'string'
                },
            ]
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- savingsPlanId (string) –
  
  The ID of the Savings Plan.
- searchResults (list) –
  
  Information about the Savings Plan rates.
  - (dict) –
    
    Information about a Savings Plan rate.
    - rate (string) –
      
      The rate.
    - currency (string) –
      
      The currency.
    - 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 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.ResourceNotFoundException
SavingsPlans.Client.exceptions.ValidationException