:doc:`SavingsPlans <../../savingsplans>` / Client / describe_savings_plans_offerings

********************************
describe_savings_plans_offerings
********************************



.. py:method:: SavingsPlans.Client.describe_savings_plans_offerings(**kwargs)

  

  Describes the offerings for the specified Savings Plans.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/savingsplans-2019-06-28/DescribeSavingsPlansOfferings>`_  


  **Request Syntax**
  ::

    response = client.describe_savings_plans_offerings(
        offeringIds=[
            'string',
        ],
        paymentOptions=[
            'All Upfront'|'Partial Upfront'|'No Upfront',
        ],
        productType='EC2'|'Fargate'|'Lambda'|'SageMaker'|'RDS'|'DSQL'|'DynamoDB'|'ElastiCache'|'DocDB'|'Neptune'|'Timestream'|'Keyspaces'|'DMS',
        planTypes=[
            'Compute'|'EC2Instance'|'SageMaker'|'Database',
        ],
        durations=[
            123,
        ],
        currencies=[
            'CNY'|'USD'|'EUR',
        ],
        descriptions=[
            'string',
        ],
        serviceCodes=[
            'string',
        ],
        usageTypes=[
            'string',
        ],
        operations=[
            'string',
        ],
        filters=[
            {
                'name': 'region'|'instanceFamily',
                'values': [
                    'string',
                ]
            },
        ],
        nextToken='string',
        maxResults=123
    )
    
  :type offeringIds: list
  :param offeringIds: 

    The IDs of the offerings.

    

  
    - *(string) --* 

    

  :type paymentOptions: list
  :param paymentOptions: 

    The payment options.

    

  
    - *(string) --* 

    

  :type productType: string
  :param productType: 

    The product type.

    

  
  :type planTypes: list
  :param planTypes: 

    The plan types.

    

  
    - *(string) --* 

    

  :type durations: list
  :param durations: 

    The duration, in seconds.

    

  
    - *(integer) --* 

    

  :type currencies: list
  :param currencies: 

    The currencies.

    

  
    - *(string) --* 

    

  :type descriptions: list
  :param descriptions: 

    The descriptions.

    

  
    - *(string) --* 

    

  :type serviceCodes: list
  :param serviceCodes: 

    The services.

    

  
    - *(string) --* 

    

  :type usageTypes: list
  :param usageTypes: 

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

    

  
    - *(string) --* 

    

  :type operations: list
  :param operations: 

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

    

  
    - *(string) --* 

    

  :type filters: list
  :param filters: 

    The filters.

    

  
    - *(dict) --* 

      Information about a Savings Plan offering filter.

      

    
      - **name** *(string) --* 

        The filter name.

        

      
      - **values** *(list) --* 

        The filter values.

        

      
        - *(string) --* 

        
    
    

  :type nextToken: string
  :param nextToken: 

    The token for the next page of results.

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of results to return with a single call. To retrieve additional results, make another call with the returned token value.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'searchResults': [
              {
                  'offeringId': 'string',
                  'productTypes': [
                      'EC2'|'Fargate'|'Lambda'|'SageMaker'|'RDS'|'DSQL'|'DynamoDB'|'ElastiCache'|'DocDB'|'Neptune'|'Timestream'|'Keyspaces'|'DMS',
                  ],
                  'planType': 'Compute'|'EC2Instance'|'SageMaker'|'Database',
                  'description': 'string',
                  'paymentOption': 'All Upfront'|'Partial Upfront'|'No Upfront',
                  'durationSeconds': 123,
                  'currency': 'CNY'|'USD'|'EUR',
                  '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**
  
  *   :py:class:`SavingsPlans.Client.exceptions.ValidationException`

  
  *   :py:class:`SavingsPlans.Client.exceptions.InternalServerException`

  