describe_db_subnet_groups¶
Operation¶
describe_db_subnet_groups
async
¶
describe_db_subnet_groups(request: DescribeDBSubnetGroupsInput | DescribeDBSubnetGroupsInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeDBSubnetGroupsOutput
describe_db_subnet_groups(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeDBSubnetGroupsInputDict]) -> DescribeDBSubnetGroupsOutput
Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.
For an overview of CIDR ranges, go to the Wikipedia Tutorial.
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 |
|---|---|
DescribeDBSubnetGroupsOutput
|
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¶
DescribeDBSubnetGroupsInput
dataclass
¶
Bases: _SerdeShape
Attributes¶
db_subnet_group_name
class-attribute
instance-attribute
¶
db_subnet_group_name: str | None = ...
The name of the DB subnet group to return details for.
filters
class-attribute
instance-attribute
¶
This parameter isn't currently supported.
marker
class-attribute
instance-attribute
¶
marker: str | None = ...
An optional pagination token provided by a previous
DescribeDBSubnetGroups 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 that you can retrieve the
remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
Dictionaries¶
DescribeDBSubnetGroupsInputDict
¶
Bases: TypedDict
Dictionary form of DescribeDBSubnetGroupsInput.
Attributes¶
db_subnet_group_name
instance-attribute
¶
db_subnet_group_name: str | None
The name of the DB subnet group to return details for.
filters
instance-attribute
¶
filters: Sequence[Filter | FilterDict] | None
This parameter isn't currently supported.
marker
instance-attribute
¶
marker: str | None
An optional pagination token provided by a previous
DescribeDBSubnetGroups 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 that you can retrieve the
remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
Output¶
DescribeDBSubnetGroupsOutput
dataclass
¶
Bases: _SerdeShape
Contains the result of a successful invocation of the
DescribeDBSubnetGroups action.
Attributes¶
db_subnet_groups
class-attribute
instance-attribute
¶
db_subnet_groups: list[DBSubnetGroup] | None = ...
A list of DBSubnetGroup instances.
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.