describe_serverless_v2_platform_versions¶
Operation¶
describe_serverless_v2_platform_versions
async
¶
describe_serverless_v2_platform_versions(request: DescribeServerlessV2PlatformVersionsInput | DescribeServerlessV2PlatformVersionsInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeServerlessV2PlatformVersionsOutput
describe_serverless_v2_platform_versions(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeServerlessV2PlatformVersionsInputDict]) -> DescribeServerlessV2PlatformVersionsOutput
Describes the properties of specific platform versions for Aurora Serverless v2.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
DescribeServerlessV2PlatformVersionsOutput
|
An instance of |
Input¶
Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.
Model¶
DescribeServerlessV2PlatformVersionsInput
dataclass
¶
Bases: _SerdeShape
Attributes¶
default_only
class-attribute
instance-attribute
¶
default_only: bool | 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.
engine
class-attribute
instance-attribute
¶
engine: str | None = ...
The database engine to return platform version details for.
Valid Values:
-
aurora-mysql -
aurora-postgresql
filters
class-attribute
instance-attribute
¶
This parameter isn't currently supported.
include_all
class-attribute
instance-attribute
¶
include_all: bool | None = ...
Specifies whether to also include platform versions which are no longer in use.
marker
class-attribute
instance-attribute
¶
marker: str | 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.
max_records
class-attribute
instance-attribute
¶
max_records: int | 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.
Dictionaries¶
DescribeServerlessV2PlatformVersionsInputDict
¶
Bases: TypedDict
Dictionary form of DescribeServerlessV2PlatformVersionsInput.
Attributes¶
default_only
instance-attribute
¶
default_only: bool | 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.
engine
instance-attribute
¶
engine: str | None
The database engine to return platform version details for.
Valid Values:
-
aurora-mysql -
aurora-postgresql
filters
instance-attribute
¶
filters: Sequence[Filter | FilterDict] | None
This parameter isn't currently supported.
include_all
instance-attribute
¶
include_all: bool | None
Specifies whether to also include platform versions which are no longer in use.
marker
instance-attribute
¶
marker: str | 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.
max_records
instance-attribute
¶
max_records: int | 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.
Output¶
DescribeServerlessV2PlatformVersionsOutput
dataclass
¶
Bases: _SerdeShape
Contains the result of a successful invocation of the
DescribeServerlessV2PlatformVersions action.
Attributes¶
marker
class-attribute
instance-attribute
¶
marker: str | 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.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.
serverless_v2_platform_versions
class-attribute
instance-attribute
¶
serverless_v2_platform_versions: list[ServerlessV2PlatformVersionInfo] | None = ...
A list of ServerlessV2PlatformVersionInfo elements.