Amazonka.RDS.DescribeDBSecurityGroups

Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified, the list will contain only the descriptions of the specified DB security group.

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.

This operation returns paginated results.

Creating a Request

data DescribeDBSecurityGroups

See: newDescribeDBSecurityGroups smart constructor.

Constructors

DescribeDBSecurityGroups'

Fields

• dbSecurityGroupName :: Maybe Text

  The name of the DB security group to return details for.

• filters :: Maybe [Filter]

  This parameter isn't currently supported.

• marker :: Maybe Text

  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.

• maxRecords :: Maybe Int

  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.

Instances

ToHeaders DescribeDBSecurityGroups

Defined in Amazonka.RDS.DescribeDBSecurityGroups

Methods

toHeaders :: DescribeDBSecurityGroups -> [Header]

ToPath DescribeDBSecurityGroups

Defined in Amazonka.RDS.DescribeDBSecurityGroups

Methods

toPath :: DescribeDBSecurityGroups -> ByteString

ToQuery DescribeDBSecurityGroups

Defined in Amazonka.RDS.DescribeDBSecurityGroups

Methods

toQuery :: DescribeDBSecurityGroups -> QueryString

AWSPager DescribeDBSecurityGroups

Defined in Amazonka.RDS.DescribeDBSecurityGroups

Methods

page :: DescribeDBSecurityGroups -> AWSResponse DescribeDBSecurityGroups -> Maybe DescribeDBSecurityGroups

AWSRequest DescribeDBSecurityGroups

Defined in Amazonka.RDS.DescribeDBSecurityGroups

Associated Types

type AWSResponse DescribeDBSecurityGroups

Methods

request :: (Service -> Service) -> DescribeDBSecurityGroups -> Request DescribeDBSecurityGroups

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeDBSecurityGroups -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeDBSecurityGroups)))

Generic DescribeDBSecurityGroups

Defined in Amazonka.RDS.DescribeDBSecurityGroups

Associated Types

type Rep DescribeDBSecurityGroups :: Type -> Type

Methods

from :: DescribeDBSecurityGroups -> Rep DescribeDBSecurityGroups x

to :: Rep DescribeDBSecurityGroups x -> DescribeDBSecurityGroups

Read DescribeDBSecurityGroups

Defined in Amazonka.RDS.DescribeDBSecurityGroups

Methods

readsPrec :: Int -> ReadS DescribeDBSecurityGroups

readList :: ReadS [DescribeDBSecurityGroups]

readPrec :: ReadPrec DescribeDBSecurityGroups

readListPrec :: ReadPrec [DescribeDBSecurityGroups]

Show DescribeDBSecurityGroups

Defined in Amazonka.RDS.DescribeDBSecurityGroups

Methods

showsPrec :: Int -> DescribeDBSecurityGroups -> ShowS

show :: DescribeDBSecurityGroups -> String

showList :: [DescribeDBSecurityGroups] -> ShowS

NFData DescribeDBSecurityGroups

Defined in Amazonka.RDS.DescribeDBSecurityGroups

Methods

rnf :: DescribeDBSecurityGroups -> ()

Eq DescribeDBSecurityGroups

Defined in Amazonka.RDS.DescribeDBSecurityGroups

Methods

(==) :: DescribeDBSecurityGroups -> DescribeDBSecurityGroups -> Bool

(/=) :: DescribeDBSecurityGroups -> DescribeDBSecurityGroups -> Bool

Hashable DescribeDBSecurityGroups

Defined in Amazonka.RDS.DescribeDBSecurityGroups

Methods

hashWithSalt :: Int -> DescribeDBSecurityGroups -> Int

hash :: DescribeDBSecurityGroups -> Int

type AWSResponse DescribeDBSecurityGroups

Defined in Amazonka.RDS.DescribeDBSecurityGroups

type AWSResponse DescribeDBSecurityGroups = DescribeDBSecurityGroupsResponse

type Rep DescribeDBSecurityGroups

Defined in Amazonka.RDS.DescribeDBSecurityGroups

type Rep DescribeDBSecurityGroups = D1 ('MetaData "DescribeDBSecurityGroups" "Amazonka.RDS.DescribeDBSecurityGroups" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "DescribeDBSecurityGroups'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dbSecurityGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter]))) :*: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxRecords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))))

newDescribeDBSecurityGroups :: DescribeDBSecurityGroups

Create a value of DescribeDBSecurityGroups with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeDBSecurityGroups, describeDBSecurityGroups_dbSecurityGroupName - The name of the DB security group to return details for.

$sel:filters:DescribeDBSecurityGroups', describeDBSecurityGroups_filters - This parameter isn't currently supported.

DescribeDBSecurityGroups, describeDBSecurityGroups_marker - 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.

$sel:maxRecords:DescribeDBSecurityGroups', describeDBSecurityGroups_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 that you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

Request Lenses

describeDBSecurityGroups_dbSecurityGroupName :: Lens' DescribeDBSecurityGroups (Maybe Text)

The name of the DB security group to return details for.

describeDBSecurityGroups_filters :: Lens' DescribeDBSecurityGroups (Maybe [Filter])

This parameter isn't currently supported.

describeDBSecurityGroups_marker :: Lens' DescribeDBSecurityGroups (Maybe Text)

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.

describeDBSecurityGroups_maxRecords :: Lens' DescribeDBSecurityGroups (Maybe Int)

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.

Destructuring the Response

data DescribeDBSecurityGroupsResponse

Contains the result of a successful invocation of the DescribeDBSecurityGroups action.

See: newDescribeDBSecurityGroupsResponse smart constructor.

Constructors

DescribeDBSecurityGroupsResponse'

Fields

• dbSecurityGroups :: Maybe [DBSecurityGroup]

  A list of DBSecurityGroup instances.

• marker :: Maybe Text

  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.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeDBSecurityGroupsResponse

Defined in Amazonka.RDS.DescribeDBSecurityGroups

Associated Types

type Rep DescribeDBSecurityGroupsResponse :: Type -> Type

Methods

from :: DescribeDBSecurityGroupsResponse -> Rep DescribeDBSecurityGroupsResponse x

to :: Rep DescribeDBSecurityGroupsResponse x -> DescribeDBSecurityGroupsResponse

Read DescribeDBSecurityGroupsResponse

Defined in Amazonka.RDS.DescribeDBSecurityGroups

Methods

readsPrec :: Int -> ReadS DescribeDBSecurityGroupsResponse

readList :: ReadS [DescribeDBSecurityGroupsResponse]

readPrec :: ReadPrec DescribeDBSecurityGroupsResponse

readListPrec :: ReadPrec [DescribeDBSecurityGroupsResponse]

Show DescribeDBSecurityGroupsResponse

Defined in Amazonka.RDS.DescribeDBSecurityGroups

Methods

showsPrec :: Int -> DescribeDBSecurityGroupsResponse -> ShowS

show :: DescribeDBSecurityGroupsResponse -> String

showList :: [DescribeDBSecurityGroupsResponse] -> ShowS

NFData DescribeDBSecurityGroupsResponse

Defined in Amazonka.RDS.DescribeDBSecurityGroups

Methods

rnf :: DescribeDBSecurityGroupsResponse -> ()

Eq DescribeDBSecurityGroupsResponse

Defined in Amazonka.RDS.DescribeDBSecurityGroups

Methods

(==) :: DescribeDBSecurityGroupsResponse -> DescribeDBSecurityGroupsResponse -> Bool

(/=) :: DescribeDBSecurityGroupsResponse -> DescribeDBSecurityGroupsResponse -> Bool

type Rep DescribeDBSecurityGroupsResponse

Defined in Amazonka.RDS.DescribeDBSecurityGroups

type Rep DescribeDBSecurityGroupsResponse = D1 ('MetaData "DescribeDBSecurityGroupsResponse" "Amazonka.RDS.DescribeDBSecurityGroups" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "DescribeDBSecurityGroupsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbSecurityGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DBSecurityGroup])) :*: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeDBSecurityGroupsResponse

Arguments

:: Int

$sel:httpStatus:DescribeDBSecurityGroupsResponse'

-> DescribeDBSecurityGroupsResponse

Create a value of DescribeDBSecurityGroupsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeDBSecurityGroupsResponse, describeDBSecurityGroupsResponse_dbSecurityGroups - A list of DBSecurityGroup instances.

DescribeDBSecurityGroups, describeDBSecurityGroupsResponse_marker - 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.

$sel:httpStatus:DescribeDBSecurityGroupsResponse', describeDBSecurityGroupsResponse_httpStatus - The response's http status code.

Response Lenses

describeDBSecurityGroupsResponse_dbSecurityGroups :: Lens' DescribeDBSecurityGroupsResponse (Maybe [DBSecurityGroup])

A list of DBSecurityGroup instances.

describeDBSecurityGroupsResponse_marker :: Lens' DescribeDBSecurityGroupsResponse (Maybe Text)

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.

describeDBSecurityGroupsResponse_httpStatus :: Lens' DescribeDBSecurityGroupsResponse Int

The response's http status code.