Skip to content

RDS  >  Operations  >  describe_db_shard_groups

describe_db_shard_groups

Operation

describe_db_shard_groups async

describe_db_shard_groups(request: DescribeDBShardGroupsInput | DescribeDBShardGroupsInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeDBShardGroupsOutput
describe_db_shard_groups(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeDBShardGroupsInputDict]) -> DescribeDBShardGroupsOutput

Describes existing Aurora Limitless Database DB shard groups.

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
DescribeDBShardGroupsOutput

An instance of DescribeDBShardGroupsOutput.

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

DescribeDBShardGroupsInput dataclass

Bases: _SerdeShape

Dataclass for DescribeDBShardGroupsInput structure.

Attributes
db_shard_group_identifier class-attribute instance-attribute
db_shard_group_identifier: str | None = ...

The user-supplied DB shard group identifier. If this parameter is specified, information for only the specific DB shard group is returned. This parameter isn't case-sensitive.

Constraints:

  • If supplied, must match an existing DB shard group identifier.
filters class-attribute instance-attribute
filters: list[Filter] | None = ...

A filter that specifies one or more DB shard groups to describe.

marker class-attribute instance-attribute
marker: str | None = ...

An optional pagination token provided by a previous DescribeDBShardGroups 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 records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100

Dictionaries

DescribeDBShardGroupsInputDict

Bases: TypedDict

Dictionary form of DescribeDBShardGroupsInput.

Attributes
db_shard_group_identifier instance-attribute
db_shard_group_identifier: str | None

The user-supplied DB shard group identifier. If this parameter is specified, information for only the specific DB shard group is returned. This parameter isn't case-sensitive.

Constraints:

  • If supplied, must match an existing DB shard group identifier.
filters instance-attribute
filters: Sequence[Filter | FilterDict] | None

A filter that specifies one or more DB shard groups to describe.

marker instance-attribute
marker: str | None

An optional pagination token provided by a previous DescribeDBShardGroups 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 records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100

Output

DescribeDBShardGroupsOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeDBShardGroupsOutput structure.

Attributes

db_shard_groups class-attribute instance-attribute
db_shard_groups: list[DBShardGroup] | None = ...

Contains a list of DB shard groups for the user.

marker class-attribute instance-attribute
marker: str | None = ...

A pagination token that can be used in a later DescribeDBClusters request.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

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.