Amazonka.RDS.DescribeDBParameterGroups

Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the description of the specified DB parameter group.

This operation returns paginated results.

Creating a Request

data DescribeDBParameterGroups

See: newDescribeDBParameterGroups smart constructor.

Constructors

DescribeDBParameterGroups'

Fields

• dbParameterGroupName :: Maybe Text

  The name of a specific DB parameter group to return details for.

  Constraints:

  • If supplied, must match the name of an existing DBClusterParameterGroup.
• filters :: Maybe [Filter]

  This parameter isn't currently supported.

• marker :: Maybe Text

  An optional pagination token provided by a previous DescribeDBParameterGroups 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 DescribeDBParameterGroups

Defined in Amazonka.RDS.DescribeDBParameterGroups

Methods

toHeaders :: DescribeDBParameterGroups -> [Header]

ToPath DescribeDBParameterGroups

Defined in Amazonka.RDS.DescribeDBParameterGroups

Methods

toPath :: DescribeDBParameterGroups -> ByteString

ToQuery DescribeDBParameterGroups

Defined in Amazonka.RDS.DescribeDBParameterGroups

Methods

toQuery :: DescribeDBParameterGroups -> QueryString

AWSPager DescribeDBParameterGroups

Defined in Amazonka.RDS.DescribeDBParameterGroups

Methods

page :: DescribeDBParameterGroups -> AWSResponse DescribeDBParameterGroups -> Maybe DescribeDBParameterGroups

AWSRequest DescribeDBParameterGroups

Defined in Amazonka.RDS.DescribeDBParameterGroups

Associated Types

type AWSResponse DescribeDBParameterGroups

Methods

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

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

Generic DescribeDBParameterGroups

Defined in Amazonka.RDS.DescribeDBParameterGroups

Associated Types

type Rep DescribeDBParameterGroups :: Type -> Type

Methods

from :: DescribeDBParameterGroups -> Rep DescribeDBParameterGroups x

to :: Rep DescribeDBParameterGroups x -> DescribeDBParameterGroups

Read DescribeDBParameterGroups

Defined in Amazonka.RDS.DescribeDBParameterGroups

Methods

readsPrec :: Int -> ReadS DescribeDBParameterGroups

readList :: ReadS [DescribeDBParameterGroups]

readPrec :: ReadPrec DescribeDBParameterGroups

readListPrec :: ReadPrec [DescribeDBParameterGroups]

Show DescribeDBParameterGroups

Defined in Amazonka.RDS.DescribeDBParameterGroups

Methods

showsPrec :: Int -> DescribeDBParameterGroups -> ShowS

show :: DescribeDBParameterGroups -> String

showList :: [DescribeDBParameterGroups] -> ShowS

NFData DescribeDBParameterGroups

Defined in Amazonka.RDS.DescribeDBParameterGroups

Methods

rnf :: DescribeDBParameterGroups -> ()

Eq DescribeDBParameterGroups

Defined in Amazonka.RDS.DescribeDBParameterGroups

Methods

(==) :: DescribeDBParameterGroups -> DescribeDBParameterGroups -> Bool

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

Hashable DescribeDBParameterGroups

Defined in Amazonka.RDS.DescribeDBParameterGroups

Methods

hashWithSalt :: Int -> DescribeDBParameterGroups -> Int

hash :: DescribeDBParameterGroups -> Int

type AWSResponse DescribeDBParameterGroups

Defined in Amazonka.RDS.DescribeDBParameterGroups

type AWSResponse DescribeDBParameterGroups = DescribeDBParameterGroupsResponse

type Rep DescribeDBParameterGroups

Defined in Amazonka.RDS.DescribeDBParameterGroups

type Rep DescribeDBParameterGroups = D1 ('MetaData "DescribeDBParameterGroups" "Amazonka.RDS.DescribeDBParameterGroups" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "DescribeDBParameterGroups'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dbParameterGroupName") '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)))))

newDescribeDBParameterGroups :: DescribeDBParameterGroups

Create a value of DescribeDBParameterGroups 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:

DescribeDBParameterGroups, describeDBParameterGroups_dbParameterGroupName - The name of a specific DB parameter group to return details for.

Constraints:

• If supplied, must match the name of an existing DBClusterParameterGroup.

$sel:filters:DescribeDBParameterGroups', describeDBParameterGroups_filters - This parameter isn't currently supported.

DescribeDBParameterGroups, describeDBParameterGroups_marker - An optional pagination token provided by a previous DescribeDBParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

$sel:maxRecords:DescribeDBParameterGroups', describeDBParameterGroups_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

describeDBParameterGroups_dbParameterGroupName :: Lens' DescribeDBParameterGroups (Maybe Text)

The name of a specific DB parameter group to return details for.

Constraints:

• If supplied, must match the name of an existing DBClusterParameterGroup.

describeDBParameterGroups_filters :: Lens' DescribeDBParameterGroups (Maybe [Filter])

This parameter isn't currently supported.

describeDBParameterGroups_marker :: Lens' DescribeDBParameterGroups (Maybe Text)

An optional pagination token provided by a previous DescribeDBParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeDBParameterGroups_maxRecords :: Lens' DescribeDBParameterGroups (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 DescribeDBParameterGroupsResponse

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

See: newDescribeDBParameterGroupsResponse smart constructor.

Constructors

DescribeDBParameterGroupsResponse'

Fields

• dbParameterGroups :: Maybe [DBParameterGroup]

  A list of DBParameterGroup 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 DescribeDBParameterGroupsResponse

Defined in Amazonka.RDS.DescribeDBParameterGroups

Associated Types

type Rep DescribeDBParameterGroupsResponse :: Type -> Type

Methods

from :: DescribeDBParameterGroupsResponse -> Rep DescribeDBParameterGroupsResponse x

to :: Rep DescribeDBParameterGroupsResponse x -> DescribeDBParameterGroupsResponse

Read DescribeDBParameterGroupsResponse

Defined in Amazonka.RDS.DescribeDBParameterGroups

Methods

readsPrec :: Int -> ReadS DescribeDBParameterGroupsResponse

readList :: ReadS [DescribeDBParameterGroupsResponse]

readPrec :: ReadPrec DescribeDBParameterGroupsResponse

readListPrec :: ReadPrec [DescribeDBParameterGroupsResponse]

Show DescribeDBParameterGroupsResponse

Defined in Amazonka.RDS.DescribeDBParameterGroups

Methods

showsPrec :: Int -> DescribeDBParameterGroupsResponse -> ShowS

show :: DescribeDBParameterGroupsResponse -> String

showList :: [DescribeDBParameterGroupsResponse] -> ShowS

NFData DescribeDBParameterGroupsResponse

Defined in Amazonka.RDS.DescribeDBParameterGroups

Methods

rnf :: DescribeDBParameterGroupsResponse -> ()

Eq DescribeDBParameterGroupsResponse

Defined in Amazonka.RDS.DescribeDBParameterGroups

Methods

(==) :: DescribeDBParameterGroupsResponse -> DescribeDBParameterGroupsResponse -> Bool

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

type Rep DescribeDBParameterGroupsResponse

Defined in Amazonka.RDS.DescribeDBParameterGroups

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

newDescribeDBParameterGroupsResponse

Arguments

:: Int

$sel:httpStatus:DescribeDBParameterGroupsResponse'

-> DescribeDBParameterGroupsResponse

Create a value of DescribeDBParameterGroupsResponse 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:

DescribeDBParameterGroupsResponse, describeDBParameterGroupsResponse_dbParameterGroups - A list of DBParameterGroup instances.

DescribeDBParameterGroups, describeDBParameterGroupsResponse_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:DescribeDBParameterGroupsResponse', describeDBParameterGroupsResponse_httpStatus - The response's http status code.

Response Lenses

describeDBParameterGroupsResponse_dbParameterGroups :: Lens' DescribeDBParameterGroupsResponse (Maybe [DBParameterGroup])

A list of DBParameterGroup instances.

describeDBParameterGroupsResponse_marker :: Lens' DescribeDBParameterGroupsResponse (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.

describeDBParameterGroupsResponse_httpStatus :: Lens' DescribeDBParameterGroupsResponse Int

The response's http status code.