describe_db_security_groups¶
Operation¶
async
¶
describe_db_security_groups(input: DescribeDBSecurityGroupsInput, plugins: list[Plugin] | None = None) -> DescribeDBSecurityGroupsOutput
Returns a list of DBSecurityGroup descriptions. If a
DBSecurityGroupName is specified, the list will contain only the
descriptions of the specified DB security group.
Note
EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring -- Here's How to Prepare, and Moving a DB instance not in a VPC into a VPC in the Amazon RDS User Guide.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
DescribeDBSecurityGroupsInput
|
An instance of |
required |
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 |
|---|---|
DescribeDBSecurityGroupsOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Attributes¶
class-attribute
instance-attribute
¶
db_security_group_name: str | None = ...
The name of the DB security group to return details for.
class-attribute
instance-attribute
¶
filters: list[Filter] | None = ...
This parameter isn't currently supported.
class-attribute
instance-attribute
¶
marker: str | None = ...
An optional pagination token provided by a previous
DescribeDBSecurityGroups request. If this parameter is specified, the
response includes only records beyond the marker, up to the value
specified by MaxRecords.
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.
Output¶
dataclass
¶
Bases: _SerdeShape
Contains the result of a successful invocation of the
DescribeDBSecurityGroups action.
Attributes¶
class-attribute
instance-attribute
¶
db_security_groups: list[DBSecurityGroup] | None = ...
A list of DBSecurityGroup instances.
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.
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.