DocDB / Client / describe_serverless_v2_platform_versions

describe_serverless_v2_platform_versions

DocDB.Client.describe_serverless_v2_platform_versions(**kwargs)

Describes the properties of specific platform versions for Amazon DocumentDB 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.

• Filters (list) –

  This parameter isn’t 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) – 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 that are no longer in use. If you don’t specify a value, the response includes only active platform versions.

• MaxRecords (integer) –

  The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

  Default: 100

  Constraints: Minimum 20, maximum 100.

• 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 operation.

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

      Contains details about a specific Amazon DocumentDB Serverless platform version, including its version number, status, engine, and supported features.

      • 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 Amazon DocumentDB Serverless v2 properties or limits that differ between platform versions. You can retrieve the platform version of an existing cluster and check whether it supports specific features before you use them.

        • MinCapacity (float) –

          The minimum number of Amazon DocumentDB capacity units (DCUs) for an instance in an Amazon DocumentDB Serverless cluster. You can specify DCU values in half-step increments, such as 8, 8.5, 9, and so on.

        • MaxCapacity (float) –

          The maximum number of Amazon DocumentDB capacity units (DCUs) for an instance in an Amazon DocumentDB Serverless cluster. You can specify DCU values in half-step increments, such as 32, 32.5, 33, and so on.

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

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