RDS / Client / describe_serverless_v2_platform_versions

describe_serverless_v2_platform_versions

RDS.Client.describe_serverless_v2_platform_versions(**kwargs)

Describes the properties of specific platform versions for Aurora Serverless v2.

See also: AWS API Documentation

Request Syntax

response = client.describe_serverless_v2_platform_versions(
    ServerlessV2PlatformVersion='string',
    Engine='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    DefaultOnly=True|False,
    IncludeAll=True|False,
    MaxRecords=123,
    Marker='string'
)

Parameters:

• ServerlessV2PlatformVersion (string) –

  A specific platform version to return details for.

  Example: 3

• Engine (string) –

  The database engine to return platform version details for.

  Valid Values:

  • aurora-mysql

  • aurora-postgresql

• 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

    • DescribeDBRecommendations

    • DescribeDBShardGroups

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

• DefaultOnly (boolean) – Specifies whether to return only the default platform versions for each engine. The default platform version is the version used for new DB clusters.

• IncludeAll (boolean) – Specifies whether to also include platform versions which are no longer in use.

• MaxRecords (integer) –

  The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so you can retrieve the remaining results.

  Default: 20

  Constraints: Minimum 1, maximum 200.

• Marker (string) – An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Return type:

dict

Returns:

Response Syntax

{
    'Marker': 'string',
    'ServerlessV2PlatformVersions': [
        {
            'ServerlessV2PlatformVersion': 'string',
            'ServerlessV2PlatformVersionDescription': 'string',
            'Engine': 'string',
            'ServerlessV2FeaturesSupport': {
                'MinCapacity': 123.0,
                'MaxCapacity': 123.0
            },
            'Status': 'string',
            'IsDefault': True|False
        },
    ]
}

Response Structure

• (dict) –

  Contains the result of a successful invocation of the DescribeServerlessV2PlatformVersions action.

  • Marker (string) –

    An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

  • ServerlessV2PlatformVersions (list) –

    A list of ServerlessV2PlatformVersionInfo elements.

    • (dict) –

      This data type is used as a response element in the action DescribeServerlessV2PlatformVersions.

      • ServerlessV2PlatformVersion (string) –

        The version number of the serverless platform.

      • ServerlessV2PlatformVersionDescription (string) –

        The description of the serverless platform.

      • Engine (string) –

        The name of the database engine.

      • ServerlessV2FeaturesSupport (dict) –

        Specifies any Aurora Serverless v2 properties or limits that differ between Aurora Serverless v2 platform versions. You can retrieve the platform version of an existing DB cluster and check whether that version supports certain Aurora Serverless v2 features before you attempt to use those features.

        • MinCapacity (float) –

          If the minimum capacity is 0 ACUs, the engine version or platform version supports the automatic pause/resume feature of Aurora Serverless v2.

        • MaxCapacity (float) –

          Specifies the upper Aurora Serverless v2 capacity limit for a particular engine version or platform version. Depending on the engine version, the maximum capacity for an Aurora Serverless v2 cluster might be 256 or 128.

      • Status (string) –

        The status of the serverless platform. Valid statuses are the following:

        • enabled - The platform version is in use.

        • disabled - The platform version is not in use.

      • IsDefault (boolean) –

        Indicates whether this platform version is the default version for the engine. The default platform version is the version used for new DB clusters.