libZSservicesZSamazonka-neptuneZSamazonka-neptune
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Neptune.DescribeDBClusterParameterGroups

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

Read DescribeDBClusterParameterGroups Source # 
Instance details

Defined in Amazonka.Neptune.DescribeDBClusterParameterGroups

Show DescribeDBClusterParameterGroups Source # 
Instance details

Defined in Amazonka.Neptune.DescribeDBClusterParameterGroups

Generic DescribeDBClusterParameterGroups Source # 
Instance details

Defined in Amazonka.Neptune.DescribeDBClusterParameterGroups

Associated Types

type Rep DescribeDBClusterParameterGroups :: Type -> Type #

NFData DescribeDBClusterParameterGroups Source # 
Instance details

Defined in Amazonka.Neptune.DescribeDBClusterParameterGroups

Hashable DescribeDBClusterParameterGroups Source # 
Instance details

Defined in Amazonka.Neptune.DescribeDBClusterParameterGroups

AWSPager DescribeDBClusterParameterGroups Source # 
Instance details

Defined in Amazonka.Neptune.DescribeDBClusterParameterGroups

AWSRequest DescribeDBClusterParameterGroups Source # 
Instance details

Defined in Amazonka.Neptune.DescribeDBClusterParameterGroups

ToHeaders DescribeDBClusterParameterGroups Source # 
Instance details

Defined in Amazonka.Neptune.DescribeDBClusterParameterGroups

ToPath DescribeDBClusterParameterGroups Source # 
Instance details

Defined in Amazonka.Neptune.DescribeDBClusterParameterGroups

ToQuery DescribeDBClusterParameterGroups Source # 
Instance details

Defined in Amazonka.Neptune.DescribeDBClusterParameterGroups

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

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_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 #

Constructors

DescribeDBClusterParameterGroupsResponse' 

Fields

Instances

Instances details
Eq DescribeDBClusterParameterGroupsResponse Source # 
Instance details

Defined in Amazonka.Neptune.DescribeDBClusterParameterGroups

Read DescribeDBClusterParameterGroupsResponse Source # 
Instance details

Defined in Amazonka.Neptune.DescribeDBClusterParameterGroups

Show DescribeDBClusterParameterGroupsResponse Source # 
Instance details

Defined in Amazonka.Neptune.DescribeDBClusterParameterGroups

Generic DescribeDBClusterParameterGroupsResponse Source # 
Instance details

Defined in Amazonka.Neptune.DescribeDBClusterParameterGroups

NFData DescribeDBClusterParameterGroupsResponse Source # 
Instance details

Defined in Amazonka.Neptune.DescribeDBClusterParameterGroups

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 #

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.