DocDB / Paginator / DescribeOrderableDBInstanceOptions

DescribeOrderableDBInstanceOptions#

class DocDB.Paginator.DescribeOrderableDBInstanceOptions#
paginator = client.get_paginator('describe_orderable_db_instance_options')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from DocDB.Client.describe_orderable_db_instance_options().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Engine='string',
    EngineVersion='string',
    DBInstanceClass='string',
    LicenseModel='string',
    Vpc=True|False,
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • Engine (string) –

    [REQUIRED]

    The name of the engine to retrieve instance options for.

  • EngineVersion (string) – The engine version filter value. Specify this parameter to show only the available offerings that match the specified engine version.

  • DBInstanceClass (string) – The instance class filter value. Specify this parameter to show only the available offerings that match the specified instance class.

  • LicenseModel (string) – The license model filter value. Specify this parameter to show only the available offerings that match the specified license model.

  • Vpc (boolean) – The virtual private cloud (VPC) filter value. Specify this parameter to show only the available VPC or non-VPC offerings.

  • Filters (list) –

    This parameter is not currently supported.

    • (dict) –

      A named set of filter values, used to return a more specific list of results. You can use a filter to match a set of resources by specific criteria, such as IDs.

      Wildcards are not supported in filters.

      • 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

{
    'OrderableDBInstanceOptions': [
        {
            'Engine': 'string',
            'EngineVersion': 'string',
            'DBInstanceClass': 'string',
            'LicenseModel': 'string',
            'AvailabilityZones': [
                {
                    'Name': 'string'
                },
            ],
            'Vpc': True|False,
            'StorageType': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    Represents the output of DescribeOrderableDBInstanceOptions.

    • OrderableDBInstanceOptions (list) –

      The options that are available for a particular orderable instance.

      • (dict) –

        The options that are available for an instance.

        • Engine (string) –

          The engine type of an instance.

        • EngineVersion (string) –

          The engine version of an instance.

        • DBInstanceClass (string) –

          The instance class for an instance.

        • LicenseModel (string) –

          The license model for an instance.

        • AvailabilityZones (list) –

          A list of Availability Zones for an instance.

          • (dict) –

            Information about an Availability Zone.

            • Name (string) –

              The name of the Availability Zone.

        • Vpc (boolean) –

          Indicates whether an instance is in a virtual private cloud (VPC).

        • StorageType (string) –

          The storage type to associate with the DB cluster

    • NextToken (string) –

      A token to resume pagination.