Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Neptune.DescribeDBClusterParameterGroups

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName parameter is specified, the list will contain only the description of the specified DB cluster parameter group.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeDBClusterParameterGroups Source #

See: newDescribeDBClusterParameterGroups smart constructor.

Constructors

DescribeDBClusterParameterGroups'

Fields

filters :: Maybe [Filter]
This parameter is not currently supported.
marker :: Maybe Text
An optional pagination token provided by a previous DescribeDBClusterParameterGroups 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 the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
dbClusterParameterGroupName :: Maybe Text
The name of a specific DB cluster parameter group to return details for.
Constraints:
- If supplied, must match the name of an existing DBClusterParameterGroup.

Instances

Instances details

Eq DescribeDBClusterParameterGroups Source #
Instance details Defined in Amazonka.Neptune.DescribeDBClusterParameterGroups Methods (==) :: DescribeDBClusterParameterGroups -> DescribeDBClusterParameterGroups -> Bool # (/=) :: DescribeDBClusterParameterGroups -> DescribeDBClusterParameterGroups -> Bool #
Read DescribeDBClusterParameterGroups Source #
Instance details Defined in Amazonka.Neptune.DescribeDBClusterParameterGroups Methods readsPrec :: Int -> ReadS DescribeDBClusterParameterGroups # readList :: ReadS [DescribeDBClusterParameterGroups] # readPrec :: ReadPrec DescribeDBClusterParameterGroups # readListPrec :: ReadPrec [DescribeDBClusterParameterGroups] #
Show DescribeDBClusterParameterGroups Source #
Instance details Defined in Amazonka.Neptune.DescribeDBClusterParameterGroups Methods showsPrec :: Int -> DescribeDBClusterParameterGroups -> ShowS # show :: DescribeDBClusterParameterGroups -> String # showList :: [DescribeDBClusterParameterGroups] -> ShowS #
Generic DescribeDBClusterParameterGroups Source #
Instance details Defined in Amazonka.Neptune.DescribeDBClusterParameterGroups Associated Types type Rep DescribeDBClusterParameterGroups :: Type -> Type # Methods from :: DescribeDBClusterParameterGroups -> Rep DescribeDBClusterParameterGroups x # to :: Rep DescribeDBClusterParameterGroups x -> DescribeDBClusterParameterGroups #
NFData DescribeDBClusterParameterGroups Source #
Instance details Defined in Amazonka.Neptune.DescribeDBClusterParameterGroups Methods rnf :: DescribeDBClusterParameterGroups -> () #
Hashable DescribeDBClusterParameterGroups Source #
Instance details Defined in Amazonka.Neptune.DescribeDBClusterParameterGroups Methods hashWithSalt :: Int -> DescribeDBClusterParameterGroups -> Int # hash :: DescribeDBClusterParameterGroups -> Int #
AWSPager DescribeDBClusterParameterGroups Source #
Instance details Defined in Amazonka.Neptune.DescribeDBClusterParameterGroups Methods page :: DescribeDBClusterParameterGroups -> AWSResponse DescribeDBClusterParameterGroups -> Maybe DescribeDBClusterParameterGroups #
AWSRequest DescribeDBClusterParameterGroups Source #
Instance details Defined in Amazonka.Neptune.DescribeDBClusterParameterGroups Associated Types type AWSResponse DescribeDBClusterParameterGroups # Methods request :: DescribeDBClusterParameterGroups -> Request DescribeDBClusterParameterGroups # response :: MonadResource m => Logger -> Service -> Proxy DescribeDBClusterParameterGroups -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeDBClusterParameterGroups))) #
ToHeaders DescribeDBClusterParameterGroups Source #
Instance details Defined in Amazonka.Neptune.DescribeDBClusterParameterGroups Methods toHeaders :: DescribeDBClusterParameterGroups -> [Header] #
ToPath DescribeDBClusterParameterGroups Source #
Instance details Defined in Amazonka.Neptune.DescribeDBClusterParameterGroups Methods toPath :: DescribeDBClusterParameterGroups -> ByteString #
ToQuery DescribeDBClusterParameterGroups Source #
Instance details Defined in Amazonka.Neptune.DescribeDBClusterParameterGroups Methods toQuery :: DescribeDBClusterParameterGroups -> QueryString #
type Rep DescribeDBClusterParameterGroups Source #
Instance details Defined in Amazonka.Neptune.DescribeDBClusterParameterGroups type Rep DescribeDBClusterParameterGroups = D1 ('MetaData "DescribeDBClusterParameterGroups" "Amazonka.Neptune.DescribeDBClusterParameterGroups" "libZSservicesZSamazonka-neptuneZSamazonka-neptune" 'False) (C1 ('MetaCons "DescribeDBClusterParameterGroups'" 'PrefixI 'True) ((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)) :*: S1 ('MetaSel ('Just "dbClusterParameterGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))
type AWSResponse DescribeDBClusterParameterGroups Source #
Instance details Defined in Amazonka.Neptune.DescribeDBClusterParameterGroups type AWSResponse DescribeDBClusterParameterGroups = DescribeDBClusterParameterGroupsResponse

newDescribeDBClusterParameterGroups :: DescribeDBClusterParameterGroups Source #

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

$sel:filters:DescribeDBClusterParameterGroups', describeDBClusterParameterGroups_filters - This parameter is not currently supported.

$sel:marker:DescribeDBClusterParameterGroups', describeDBClusterParameterGroups_marker - An optional pagination token provided by a previous DescribeDBClusterParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

$sel:maxRecords:DescribeDBClusterParameterGroups', describeDBClusterParameterGroups_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 the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

$sel:dbClusterParameterGroupName:DescribeDBClusterParameterGroups', describeDBClusterParameterGroups_dbClusterParameterGroupName - The name of a specific DB cluster parameter group to return details for.

Constraints:

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

Request Lenses

describeDBClusterParameterGroups_filters :: Lens' DescribeDBClusterParameterGroups (Maybe [Filter]) Source #

This parameter is not currently supported.

describeDBClusterParameterGroups_marker :: Lens' DescribeDBClusterParameterGroups (Maybe Text) Source #

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

describeDBClusterParameterGroups_maxRecords :: Lens' DescribeDBClusterParameterGroups (Maybe Int) Source #

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 the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

describeDBClusterParameterGroups_dbClusterParameterGroupName :: Lens' DescribeDBClusterParameterGroups (Maybe Text) Source #

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

Constraints:

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

Destructuring the Response

data DescribeDBClusterParameterGroupsResponse Source #

See: newDescribeDBClusterParameterGroupsResponse smart constructor.

Constructors

DescribeDBClusterParameterGroupsResponse'

Fields

marker :: Maybe Text
An optional pagination token provided by a previous DescribeDBClusterParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
dbClusterParameterGroups :: Maybe [DBClusterParameterGroup]
A list of DB cluster parameter groups.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq DescribeDBClusterParameterGroupsResponse Source #
Instance details Defined in Amazonka.Neptune.DescribeDBClusterParameterGroups Methods (==) :: DescribeDBClusterParameterGroupsResponse -> DescribeDBClusterParameterGroupsResponse -> Bool # (/=) :: DescribeDBClusterParameterGroupsResponse -> DescribeDBClusterParameterGroupsResponse -> Bool #
Read DescribeDBClusterParameterGroupsResponse Source #
Instance details Defined in Amazonka.Neptune.DescribeDBClusterParameterGroups Methods readsPrec :: Int -> ReadS DescribeDBClusterParameterGroupsResponse # readList :: ReadS [DescribeDBClusterParameterGroupsResponse] # readPrec :: ReadPrec DescribeDBClusterParameterGroupsResponse # readListPrec :: ReadPrec [DescribeDBClusterParameterGroupsResponse] #
Show DescribeDBClusterParameterGroupsResponse Source #
Instance details Defined in Amazonka.Neptune.DescribeDBClusterParameterGroups Methods showsPrec :: Int -> DescribeDBClusterParameterGroupsResponse -> ShowS # show :: DescribeDBClusterParameterGroupsResponse -> String # showList :: [DescribeDBClusterParameterGroupsResponse] -> ShowS #
Generic DescribeDBClusterParameterGroupsResponse Source #
Instance details Defined in Amazonka.Neptune.DescribeDBClusterParameterGroups Associated Types type Rep DescribeDBClusterParameterGroupsResponse :: Type -> Type # Methods from :: DescribeDBClusterParameterGroupsResponse -> Rep DescribeDBClusterParameterGroupsResponse x # to :: Rep DescribeDBClusterParameterGroupsResponse x -> DescribeDBClusterParameterGroupsResponse #
NFData DescribeDBClusterParameterGroupsResponse Source #
Instance details Defined in Amazonka.Neptune.DescribeDBClusterParameterGroups Methods rnf :: DescribeDBClusterParameterGroupsResponse -> () #
type Rep DescribeDBClusterParameterGroupsResponse Source #
Instance details Defined in Amazonka.Neptune.DescribeDBClusterParameterGroups type Rep DescribeDBClusterParameterGroupsResponse = D1 ('MetaData "DescribeDBClusterParameterGroupsResponse" "Amazonka.Neptune.DescribeDBClusterParameterGroups" "libZSservicesZSamazonka-neptuneZSamazonka-neptune" 'False) (C1 ('MetaCons "DescribeDBClusterParameterGroupsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "dbClusterParameterGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DBClusterParameterGroup])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeDBClusterParameterGroupsResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeDBClusterParameterGroupsResponse'`
-> DescribeDBClusterParameterGroupsResponse

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

$sel:marker:DescribeDBClusterParameterGroups', describeDBClusterParameterGroupsResponse_marker - An optional pagination token provided by a previous DescribeDBClusterParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

$sel:dbClusterParameterGroups:DescribeDBClusterParameterGroupsResponse', describeDBClusterParameterGroupsResponse_dbClusterParameterGroups - A list of DB cluster parameter groups.

$sel:httpStatus:DescribeDBClusterParameterGroupsResponse', describeDBClusterParameterGroupsResponse_httpStatus - The response's http status code.

Response Lenses

describeDBClusterParameterGroupsResponse_marker :: Lens' DescribeDBClusterParameterGroupsResponse (Maybe Text) Source #

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

describeDBClusterParameterGroupsResponse_dbClusterParameterGroups :: Lens' DescribeDBClusterParameterGroupsResponse (Maybe [DBClusterParameterGroup]) Source #

A list of DB cluster parameter groups.

describeDBClusterParameterGroupsResponse_httpStatus :: Lens' DescribeDBClusterParameterGroupsResponse Int Source #

The response's http status code.