Skip to content

DescribeDBShardGroupsMessage

Source code in docs_src/capo_rds/types/describe_db_shard_groups_message.py 
16
17
18
19
20
21
22
23
24
25
26
class DescribeDBShardGroupsMessage(TypedDict, closed=True):
    db_shard_group_identifier: NotRequired[
        "capo_rds.types.db_shard_group_identifier.DBShardGroupIdentifier"
    ]
    """<p>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.</p> <p>Constraints:</p> <ul> <li> <p>If supplied, must match an existing DB shard group identifier.</p> </li> </ul>"""
    filters: NotRequired["capo_rds.types.filter_list.FilterList"]
    """<p>A filter that specifies one or more DB shard groups to describe.</p>"""
    marker: NotRequired["capo_rds.types.string.String"]
    """<p>An optional pagination token provided by a previous <code>DescribeDBShardGroups</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>"""
    max_records: NotRequired["capo_rds.types.max_records.MaxRecords"]
    """<p>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so you can retrieve the remaining results.</p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100</p>"""

db_shard_group_identifier instance-attribute 

db_shard_group_identifier: NotRequired[DBShardGroupIdentifier]

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: NotRequired[FilterList]

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

marker instance-attribute 

marker: NotRequired[String]

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: NotRequired[MaxRecords]

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