Request Parameters Response Elements Errors See Also

DescribeServerlessV2PlatformVersions

Describes the properties of specific platform versions for Amazon DocumentDB Serverless v2.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

DefaultOnly

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

Type: Boolean

Required: No

Engine

The database engine to return platform version details for.

Type: String

Required: No

Filters.Filter.N

This parameter isn't currently supported.

Type: Array of Filter objects

Required: No

IncludeAll

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.

Type: Boolean

Required: No

Marker

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.

Type: String

Required: No

MaxRecords

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.

Type: Integer

Required: No

ServerlessV2PlatformVersion

A specific platform version to return details for.

Example: 3

Type: String

Required: No

Response Elements

The following elements are returned by the service.

Marker

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.

Type: String

ServerlessV2PlatformVersions.ServerlessV2PlatformVersionInfo.N

A list of ServerlessV2PlatformVersionInfo elements.

Type: Array of ServerlessV2PlatformVersionInfo objects

Errors

For information about the errors that are common to all actions, see Common Error Types.