RDS / Paginator / DescribeDBMajorEngineVersions

DescribeDBMajorEngineVersions

class RDS.Paginator.DescribeDBMajorEngineVersions

paginator = client.get_paginator('describe_db_major_engine_versions')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Engine='string',
    MajorEngineVersion='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• Engine (string) –

  The database engine to return major version details for.

  Valid Values:

  • aurora-mysql

  • aurora-postgresql

  • custom-sqlserver-ee

  • custom-sqlserver-se

  • custom-sqlserver-web

  • db2-ae

  • db2-se

  • mariadb

  • mysql

  • oracle-ee

  • oracle-ee-cdb

  • oracle-se2

  • oracle-se2-cdb

  • postgres

  • sqlserver-ee

  • sqlserver-se

  • sqlserver-ex

  • sqlserver-web

• MajorEngineVersion (string) –

  A specific database major engine version to return details for.

  Example: 8.4

• 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

{
    'DBMajorEngineVersions': [
        {
            'Engine': 'string',
            'MajorEngineVersion': 'string',
            'SupportedEngineLifecycles': [
                {
                    'LifecycleSupportName': 'open-source-rds-standard-support'|'open-source-rds-extended-support',
                    'LifecycleSupportStartDate': datetime(2015, 1, 1),
                    'LifecycleSupportEndDate': datetime(2015, 1, 1)
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • DBMajorEngineVersions (list) –

    A list of DBMajorEngineVersion elements.

    • (dict) –

      This data type is used as a response element in the operation DescribeDBMajorEngineVersions.

      • Engine (string) –

        The name of the database engine.

      • MajorEngineVersion (string) –

        The major version number of the database engine.

      • SupportedEngineLifecycles (list) –

        A list of the lifecycles supported by this engine for the DescribeDBMajorEngineVersions operation.

        • (dict) –

          This data type is used as a response element in the operation DescribeDBMajorEngineVersions.

          You can use the information that this data type returns to plan for upgrades.

          This data type only returns information for the open source engines Amazon RDS for MariaDB, Amazon RDS for MySQL, Amazon RDS for PostgreSQL, Aurora MySQL, and Aurora PostgreSQL.

          • LifecycleSupportName (string) –

            The type of lifecycle support that the engine version is in.

            This parameter returns the following values:

            • open-source-rds-standard-support - Indicates RDS standard support or Aurora standard support.

            • open-source-rds-extended-support - Indicates Amazon RDS Extended Support.

            For Amazon RDS for MySQL, Amazon RDS for PostgreSQL, Aurora MySQL, and Aurora PostgreSQL, this parameter returns both open-source-rds-standard-support and open-source-rds-extended-support.

            For Amazon RDS for MariaDB, this parameter only returns the value open-source-rds-standard-support.

            For information about Amazon RDS Extended Support, see Amazon RDS Extended Support with Amazon RDS in the Amazon RDS User Guide and Amazon RDS Extended Support with Amazon Aurora in the Amazon Aurora User Guide.

          • LifecycleSupportStartDate (datetime) –

            The start date for the type of support returned by LifecycleSupportName.

          • LifecycleSupportEndDate (datetime) –

            The end date for the type of support returned by LifecycleSupportName.

  • NextToken (string) –

    A token to resume pagination.