Amazonka.Neptune.DescribeDBClusterParameterGroups

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.

Creating a Request

data DescribeDBClusterParameterGroups

See: newDescribeDBClusterParameterGroups smart constructor.

Constructors

DescribeDBClusterParameterGroups'

Fields

• 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.
• 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.

Instances

ToHeaders DescribeDBClusterParameterGroups

Defined in Amazonka.Neptune.DescribeDBClusterParameterGroups

Methods

toHeaders :: DescribeDBClusterParameterGroups -> [Header]

ToPath DescribeDBClusterParameterGroups

Defined in Amazonka.Neptune.DescribeDBClusterParameterGroups

Methods

toPath :: DescribeDBClusterParameterGroups -> ByteString

ToQuery DescribeDBClusterParameterGroups

Defined in Amazonka.Neptune.DescribeDBClusterParameterGroups

Methods

toQuery :: DescribeDBClusterParameterGroups -> QueryString

AWSPager DescribeDBClusterParameterGroups

Defined in Amazonka.Neptune.DescribeDBClusterParameterGroups

Methods

page :: DescribeDBClusterParameterGroups -> AWSResponse DescribeDBClusterParameterGroups -> Maybe DescribeDBClusterParameterGroups

AWSRequest DescribeDBClusterParameterGroups

Defined in Amazonka.Neptune.DescribeDBClusterParameterGroups

Associated Types

type AWSResponse DescribeDBClusterParameterGroups

Methods

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

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

Generic DescribeDBClusterParameterGroups

Defined in Amazonka.Neptune.DescribeDBClusterParameterGroups

Associated Types

type Rep DescribeDBClusterParameterGroups :: Type -> Type

Methods

from :: DescribeDBClusterParameterGroups -> Rep DescribeDBClusterParameterGroups x

to :: Rep DescribeDBClusterParameterGroups x -> DescribeDBClusterParameterGroups

Read DescribeDBClusterParameterGroups

Defined in Amazonka.Neptune.DescribeDBClusterParameterGroups

Methods

readsPrec :: Int -> ReadS DescribeDBClusterParameterGroups

readList :: ReadS [DescribeDBClusterParameterGroups]

readPrec :: ReadPrec DescribeDBClusterParameterGroups

readListPrec :: ReadPrec [DescribeDBClusterParameterGroups]

Show DescribeDBClusterParameterGroups

Defined in Amazonka.Neptune.DescribeDBClusterParameterGroups

Methods

showsPrec :: Int -> DescribeDBClusterParameterGroups -> ShowS

show :: DescribeDBClusterParameterGroups -> String

showList :: [DescribeDBClusterParameterGroups] -> ShowS

NFData DescribeDBClusterParameterGroups

Defined in Amazonka.Neptune.DescribeDBClusterParameterGroups

Methods

rnf :: DescribeDBClusterParameterGroups -> ()

Eq DescribeDBClusterParameterGroups

Defined in Amazonka.Neptune.DescribeDBClusterParameterGroups

Methods

(==) :: DescribeDBClusterParameterGroups -> DescribeDBClusterParameterGroups -> Bool

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

Hashable DescribeDBClusterParameterGroups

Defined in Amazonka.Neptune.DescribeDBClusterParameterGroups

Methods

hashWithSalt :: Int -> DescribeDBClusterParameterGroups -> Int

hash :: DescribeDBClusterParameterGroups -> Int

type AWSResponse DescribeDBClusterParameterGroups

Defined in Amazonka.Neptune.DescribeDBClusterParameterGroups

type AWSResponse DescribeDBClusterParameterGroups = DescribeDBClusterParameterGroupsResponse

type Rep DescribeDBClusterParameterGroups

Defined in Amazonka.Neptune.DescribeDBClusterParameterGroups

type Rep DescribeDBClusterParameterGroups = D1 ('MetaData "DescribeDBClusterParameterGroups" "Amazonka.Neptune.DescribeDBClusterParameterGroups" "amazonka-neptune-2.0-2gYqDRsIJxo6L8BEj2Stvk" 'False) (C1 ('MetaCons "DescribeDBClusterParameterGroups'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dbClusterParameterGroupName") '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)))))

newDescribeDBClusterParameterGroups :: DescribeDBClusterParameterGroups

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:

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.

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

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.

Request Lenses

describeDBClusterParameterGroups_dbClusterParameterGroupName :: Lens' DescribeDBClusterParameterGroups (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.

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

This parameter is not currently supported.

describeDBClusterParameterGroups_marker :: Lens' DescribeDBClusterParameterGroups (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.

describeDBClusterParameterGroups_maxRecords :: Lens' DescribeDBClusterParameterGroups (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.

Destructuring the Response

data DescribeDBClusterParameterGroupsResponse

See: newDescribeDBClusterParameterGroupsResponse smart constructor.

Constructors

DescribeDBClusterParameterGroupsResponse'

Fields

• dbClusterParameterGroups :: Maybe [DBClusterParameterGroup]

  A list of DB cluster parameter groups.

• 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.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeDBClusterParameterGroupsResponse

Defined in Amazonka.Neptune.DescribeDBClusterParameterGroups

Associated Types

type Rep DescribeDBClusterParameterGroupsResponse :: Type -> Type

Methods

from :: DescribeDBClusterParameterGroupsResponse -> Rep DescribeDBClusterParameterGroupsResponse x

to :: Rep DescribeDBClusterParameterGroupsResponse x -> DescribeDBClusterParameterGroupsResponse

Read DescribeDBClusterParameterGroupsResponse

Defined in Amazonka.Neptune.DescribeDBClusterParameterGroups

Methods

readsPrec :: Int -> ReadS DescribeDBClusterParameterGroupsResponse

readList :: ReadS [DescribeDBClusterParameterGroupsResponse]

readPrec :: ReadPrec DescribeDBClusterParameterGroupsResponse

readListPrec :: ReadPrec [DescribeDBClusterParameterGroupsResponse]

Show DescribeDBClusterParameterGroupsResponse

Defined in Amazonka.Neptune.DescribeDBClusterParameterGroups

Methods

showsPrec :: Int -> DescribeDBClusterParameterGroupsResponse -> ShowS

show :: DescribeDBClusterParameterGroupsResponse -> String

showList :: [DescribeDBClusterParameterGroupsResponse] -> ShowS

NFData DescribeDBClusterParameterGroupsResponse

Defined in Amazonka.Neptune.DescribeDBClusterParameterGroups

Methods

rnf :: DescribeDBClusterParameterGroupsResponse -> ()

Eq DescribeDBClusterParameterGroupsResponse

Defined in Amazonka.Neptune.DescribeDBClusterParameterGroups

Methods

(==) :: DescribeDBClusterParameterGroupsResponse -> DescribeDBClusterParameterGroupsResponse -> Bool

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

type Rep DescribeDBClusterParameterGroupsResponse

Defined in Amazonka.Neptune.DescribeDBClusterParameterGroups

type Rep DescribeDBClusterParameterGroupsResponse = D1 ('MetaData "DescribeDBClusterParameterGroupsResponse" "Amazonka.Neptune.DescribeDBClusterParameterGroups" "amazonka-neptune-2.0-2gYqDRsIJxo6L8BEj2Stvk" 'False) (C1 ('MetaCons "DescribeDBClusterParameterGroupsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbClusterParameterGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DBClusterParameterGroup])) :*: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeDBClusterParameterGroupsResponse

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:dbClusterParameterGroups:DescribeDBClusterParameterGroupsResponse', describeDBClusterParameterGroupsResponse_dbClusterParameterGroups - A list of DB cluster parameter groups.

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:httpStatus:DescribeDBClusterParameterGroupsResponse', describeDBClusterParameterGroupsResponse_httpStatus - The response's http status code.

Response Lenses

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

A list of DB cluster parameter groups.

describeDBClusterParameterGroupsResponse_marker :: Lens' DescribeDBClusterParameterGroupsResponse (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.

describeDBClusterParameterGroupsResponse_httpStatus :: Lens' DescribeDBClusterParameterGroupsResponse Int

The response's http status code.