Skip to content

describe_serverless_v2_platform_versions

describe_serverless_v2_platform_versions(
    *,
    config_overrides: Optional[RDSClientConfig] = None,
    serverless_v2_platform_version: Optional[String] = None,
    engine: Optional[String] = None,
    filters: Optional[FilterList] = None,
    default_only: Optional[BooleanOptional] = None,
    include_all: Optional[BooleanOptional] = None,
    max_records: Optional[IntegerOptional] = None,
    marker: Optional[String] = None,
) -> ServerlessV2PlatformVersionsMessage

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

Parameters:

  • serverless_v2_platform_version (Optional[String], default: None ) –

    A specific platform version to return details for.

    Example: 3

  • engine (Optional[String], default: None ) –

    The database engine to return platform version details for.

    Valid Values:

    • aurora-mysql

    • aurora-postgresql

  • filters (Optional[FilterList], default: None ) –

    This parameter isn't currently supported.

  • default_only (Optional[BooleanOptional], default: None ) –

    Specifies whether to return only the default platform versions for each engine. The default platform version is the version used for new DB clusters.

  • include_all (Optional[BooleanOptional], default: None ) –

    Specifies whether to also include platform versions which are no longer in use.

  • max_records (Optional[IntegerOptional], default: None ) –

    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 (Optional[String], default: None ) –

    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.

Raises:

Examples:

To describe the serverless platform versions for the Aurora MySQL DB engine The following example displays details about each of the serverless platform versions for the specified DB engine.

>>> client.describe_serverless_v2_platform_versions(engine='aurora-mysql')
Source code in docs_src/capo_rds/_services/rds.py
def describe_serverless_v2_platform_versions(
    self,
    *,
    config_overrides: Optional[RDSClientConfig] = None,
    serverless_v2_platform_version: Optional["capo_rds.types.string.String"] = None,
    engine: Optional["capo_rds.types.string.String"] = None,
    filters: Optional["capo_rds.types.filter_list.FilterList"] = None,
    default_only: Optional[
        "capo_rds.types.boolean_optional.BooleanOptional"
    ] = None,
    include_all: Optional["capo_rds.types.boolean_optional.BooleanOptional"] = None,
    max_records: Optional["capo_rds.types.integer_optional.IntegerOptional"] = None,
    marker: Optional["capo_rds.types.string.String"] = None,
) -> "capo_rds.types.serverless_v2_platform_versions_message.ServerlessV2PlatformVersionsMessage":
    """<p>Describes the properties of specific platform versions for Aurora Serverless v2.</p>

    Args:
        serverless_v2_platform_version: <p>A specific platform version to return details for.</p> <p>Example: <code>3</code> </p>
        engine: <p>The database engine to return platform version details for.</p> <p>Valid Values:</p> <ul> <li> <p> <code>aurora-mysql</code> </p> </li> <li> <p> <code>aurora-postgresql</code> </p> </li> </ul>
        filters: <p>This parameter isn't currently supported.</p>
        default_only: <p>Specifies whether to return only the default platform versions for each engine. The default platform version is the version used for new DB clusters.</p>
        include_all: <p>Specifies whether to also include platform versions which are no longer in use.</p>
        max_records: <p>The maximum number of records to include in the response. If more than the <code>MaxRecords</code> value is available, a pagination token called a marker is included in the response so you can retrieve the remaining results.</p> <p>Default: 20</p> <p>Constraints: Minimum 1, maximum 200.</p>
        marker: <p>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 <code>MaxRecords</code>.</p>

    Raises:
        capo_rds.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To describe the serverless platform versions for the Aurora MySQL DB engine
        The following example displays details about each of the serverless platform versions for the specified DB engine.

        >>> client.describe_serverless_v2_platform_versions(engine='aurora-mysql')
    """

    def _handler(
        req: "OperationRequest[capo_rds.types.describe_serverless_v2_platform_versions_message.DescribeServerlessV2PlatformVersionsMessage]",
    ) -> OperationResponse[
        "capo_rds.types.serverless_v2_platform_versions_message.ServerlessV2PlatformVersionsMessage"
    ]:
        import capo_rds._operations.amazon_rd_sv19.describe_serverless_v2_platform_versions

        output, http_response = (
            capo_rds._operations.amazon_rd_sv19.describe_serverless_v2_platform_versions.describe_serverless_v2_platform_versions(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeServerlessV2PlatformVersions")
    )
    input_: capo_rds.types.describe_serverless_v2_platform_versions_message.DescribeServerlessV2PlatformVersionsMessage = {}
    if serverless_v2_platform_version is not None:
        input_["serverless_v2_platform_version"] = serverless_v2_platform_version
    if engine is not None:
        input_["engine"] = engine
    if filters is not None:
        input_["filters"] = filters
    if default_only is not None:
        input_["default_only"] = default_only
    if include_all is not None:
        input_["include_all"] = include_all
    if max_records is not None:
        input_["max_records"] = max_records
    if marker is not None:
        input_["marker"] = marker

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output