DescribeReservedDBInstancesOfferings¶

class RDS.Paginator.DescribeReservedDBInstancesOfferings¶

paginator = client.get_paginator('describe_reserved_db_instances_offerings')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from RDS.Client.describe_reserved_db_instances_offerings().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ReservedDBInstancesOfferingId='string',
    DBInstanceClass='string',
    Duration='string',
    ProductDescription='string',
    OfferingType='string',
    MultiAZ=True|False,
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

ReservedDBInstancesOfferingId (string) --
The offering identifier filter value. Specify this parameter to show only the available offering that matches the specified reservation identifier.

Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
DBInstanceClass (string) -- The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.
Duration (string) --
Duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.

Valid Values: 1 | 3 | 31536000 | 94608000
ProductDescription (string) --
Product description filter value. Specify this parameter to show only the available offerings that contain the specified product description.

Note

The results show offerings that partially match the filter value.
OfferingType (string) --
The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.

Valid Values: "Partial Upfront" | "All Upfront" | "No Upfront"
MultiAZ (boolean) -- A value that indicates whether to show only those reservations that support Multi-AZ.
Filters (list) --
This parameter isn't currently supported.
- (dict) --
  A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
  
  Note
  
  Currently, wildcards are not supported in filters.
  
  The following actions can be filtered:
  - DescribeDBClusterBacktracks
  - DescribeDBClusterEndpoints
  - DescribeDBClusters
  - DescribeDBInstances
  - DescribePendingMaintenanceActions
  - Name (string) -- [REQUIRED]
    The name of the filter. Filter names are case-sensitive.
  - Values (list) -- [REQUIRED]
    One or more filter values. Filter values are case-sensitive.
    - (string) --
PaginationConfig (dict) --
A dictionary that provides parameters to control pagination.
- MaxItems (integer) --
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) --
  The size of each page.
- StartingToken (string) --
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'ReservedDBInstancesOfferings': [
        {
            'ReservedDBInstancesOfferingId': 'string',
            'DBInstanceClass': 'string',
            'Duration': 123,
            'FixedPrice': 123.0,
            'UsagePrice': 123.0,
            'CurrencyCode': 'string',
            'ProductDescription': 'string',
            'OfferingType': 'string',
            'MultiAZ': True|False,
            'RecurringCharges': [
                {
                    'RecurringChargeAmount': 123.0,
                    'RecurringChargeFrequency': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --

Contains the result of a successful invocation of the DescribeReservedDBInstancesOfferings action.
- ReservedDBInstancesOfferings (list) --
  
  A list of reserved DB instance offerings.
  - (dict) --
    
    This data type is used as a response element in the DescribeReservedDBInstancesOfferings action.
    - ReservedDBInstancesOfferingId (string) --
      
      The offering identifier.
    - DBInstanceClass (string) --
      
      The DB instance class for the reserved DB instance.
    - Duration (integer) --
      
      The duration of the offering in seconds.
    - FixedPrice (float) --
      
      The fixed price charged for this offering.
    - UsagePrice (float) --
      
      The hourly price charged for this offering.
    - CurrencyCode (string) --
      
      The currency code for the reserved DB instance offering.
    - ProductDescription (string) --
      
      The database engine used by the offering.
    - OfferingType (string) --
      
      The offering type.
    - MultiAZ (boolean) --
      
      Indicates if the offering applies to Multi-AZ deployments.
    - RecurringCharges (list) --
      
      The recurring price charged to run this reserved DB instance.
      - (dict) --
        
        This data type is used as a response element in the DescribeReservedDBInstances and DescribeReservedDBInstancesOfferings actions.
        
        RecurringChargeAmount (float) --
        
        The amount of the recurring charge.
        
        RecurringChargeFrequency (string) --
        
        The frequency of the recurring charge.
- NextToken (string) --
  
  A token to resume pagination.

Table Of Contents

DescribeReservedDBInstancesOfferings¶