DocDB / Paginator / DescribeDBEngineVersions

DescribeDBEngineVersions#

class DocDB.Paginator.DescribeDBEngineVersions#
paginator = client.get_paginator('describe_db_engine_versions')
paginate(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Engine='string',
    EngineVersion='string',
    DBParameterGroupFamily='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    DefaultOnly=True|False,
    ListSupportedCharacterSets=True|False,
    ListSupportedTimezones=True|False,
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • Engine (string) – The database engine to return.

  • EngineVersion (string) –

    The database engine version to return.

    Example: 3.6.0

  • DBParameterGroupFamily (string) –

    The name of a specific parameter group family to return details for.

    Constraints:

    • If provided, must match an existing DBParameterGroupFamily.

  • 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) –

  • DefaultOnly (boolean) – Indicates that only the default version of the specified engine or engine and major version combination is returned.

  • ListSupportedCharacterSets (boolean) – If this parameter is specified and the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.

  • ListSupportedTimezones (boolean) – If this parameter is specified and the requested engine supports the TimeZone parameter for CreateDBInstance, the response includes a list of supported time zones for each engine version.

  • 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

{
    'DBEngineVersions': [
        {
            'Engine': 'string',
            'EngineVersion': 'string',
            'DBParameterGroupFamily': 'string',
            'DBEngineDescription': 'string',
            'DBEngineVersionDescription': 'string',
            'ValidUpgradeTarget': [
                {
                    'Engine': 'string',
                    'EngineVersion': 'string',
                    'Description': 'string',
                    'AutoUpgrade': True|False,
                    'IsMajorVersionUpgrade': True|False
                },
            ],
            'ExportableLogTypes': [
                'string',
            ],
            'SupportsLogExportsToCloudwatchLogs': True|False,
            'SupportedCACertificateIdentifiers': [
                'string',
            ],
            'SupportsCertificateRotationWithoutRestart': True|False
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    Represents the output of DescribeDBEngineVersions.

    • DBEngineVersions (list) –

      Detailed information about one or more engine versions.

      • (dict) –

        Detailed information about an engine version.

        • Engine (string) –

          The name of the database engine.

        • EngineVersion (string) –

          The version number of the database engine.

        • DBParameterGroupFamily (string) –

          The name of the parameter group family for the database engine.

        • DBEngineDescription (string) –

          The description of the database engine.

        • DBEngineVersionDescription (string) –

          The description of the database engine version.

        • ValidUpgradeTarget (list) –

          A list of engine versions that this database engine version can be upgraded to.

          • (dict) –

            The version of the database engine that an instance can be upgraded to.

            • Engine (string) –

              The name of the upgrade target database engine.

            • EngineVersion (string) –

              The version number of the upgrade target database engine.

            • Description (string) –

              The version of the database engine that an instance can be upgraded to.

            • AutoUpgrade (boolean) –

              A value that indicates whether the target version is applied to any source DB instances that have AutoMinorVersionUpgrade set to true.

            • IsMajorVersionUpgrade (boolean) –

              A value that indicates whether a database engine is upgraded to a major version.

        • ExportableLogTypes (list) –

          The types of logs that the database engine has available for export to Amazon CloudWatch Logs.

          • (string) –

        • SupportsLogExportsToCloudwatchLogs (boolean) –

          A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.

        • SupportedCACertificateIdentifiers (list) –

          A list of the supported CA certificate identifiers.

          For more information, see Updating Your Amazon DocumentDB TLS Certificates and Encrypting Data in Transit in the Amazon DocumentDB Developer Guide.

          • (string) –

        • SupportsCertificateRotationWithoutRestart (boolean) –

          Indicates whether the engine version supports rotating the server certificate without rebooting the DB instance.

    • NextToken (string) –

      A token to resume pagination.