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

Description

Returns information about provisioned DB clusters, and supports pagination.

This operation can also return information for Amazon RDS clusters and Amazon DocDB clusters.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeDBClusters Source #

See: newDescribeDBClusters smart constructor.

Constructors

DescribeDBClusters' 

Fields

  • dbClusterIdentifier :: Maybe Text

    The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive.

    Constraints:

    • If supplied, must match an existing DBClusterIdentifier.
  • filters :: Maybe [Filter]

    A filter that specifies one or more DB clusters to describe.

    Supported filters:

    • db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB clusters identified by these ARNs.
    • engine - Accepts an engine name (such as neptune), and restricts the results list to DB clusters created by that engine.

    For example, to invoke this API from the Amazon CLI and filter so that only Neptune DB clusters are returned, you could use the following command:

  • marker :: Maybe Text

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

Instances details
Eq DescribeDBClusters Source # 
Instance details

Defined in Amazonka.Neptune.DescribeDBClusters

Read DescribeDBClusters Source # 
Instance details

Defined in Amazonka.Neptune.DescribeDBClusters

Show DescribeDBClusters Source # 
Instance details

Defined in Amazonka.Neptune.DescribeDBClusters

Generic DescribeDBClusters Source # 
Instance details

Defined in Amazonka.Neptune.DescribeDBClusters

Associated Types

type Rep DescribeDBClusters :: Type -> Type #

NFData DescribeDBClusters Source # 
Instance details

Defined in Amazonka.Neptune.DescribeDBClusters

Methods

rnf :: DescribeDBClusters -> () #

Hashable DescribeDBClusters Source # 
Instance details

Defined in Amazonka.Neptune.DescribeDBClusters

AWSPager DescribeDBClusters Source # 
Instance details

Defined in Amazonka.Neptune.DescribeDBClusters

AWSRequest DescribeDBClusters Source # 
Instance details

Defined in Amazonka.Neptune.DescribeDBClusters

Associated Types

type AWSResponse DescribeDBClusters #

ToHeaders DescribeDBClusters Source # 
Instance details

Defined in Amazonka.Neptune.DescribeDBClusters

ToPath DescribeDBClusters Source # 
Instance details

Defined in Amazonka.Neptune.DescribeDBClusters

ToQuery DescribeDBClusters Source # 
Instance details

Defined in Amazonka.Neptune.DescribeDBClusters

type Rep DescribeDBClusters Source # 
Instance details

Defined in Amazonka.Neptune.DescribeDBClusters

type Rep DescribeDBClusters = D1 ('MetaData "DescribeDBClusters" "Amazonka.Neptune.DescribeDBClusters" "libZSservicesZSamazonka-neptuneZSamazonka-neptune" 'False) (C1 ('MetaCons "DescribeDBClusters'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dbClusterIdentifier") '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)))))
type AWSResponse DescribeDBClusters Source # 
Instance details

Defined in Amazonka.Neptune.DescribeDBClusters

newDescribeDBClusters :: DescribeDBClusters Source #

Create a value of DescribeDBClusters 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:dbClusterIdentifier:DescribeDBClusters', describeDBClusters_dbClusterIdentifier - The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive.

Constraints:

  • If supplied, must match an existing DBClusterIdentifier.

$sel:filters:DescribeDBClusters', describeDBClusters_filters - A filter that specifies one or more DB clusters to describe.

Supported filters:

  • db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB clusters identified by these ARNs.
  • engine - Accepts an engine name (such as neptune), and restricts the results list to DB clusters created by that engine.

For example, to invoke this API from the Amazon CLI and filter so that only Neptune DB clusters are returned, you could use the following command:

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

$sel:maxRecords:DescribeDBClusters', describeDBClusters_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

describeDBClusters_dbClusterIdentifier :: Lens' DescribeDBClusters (Maybe Text) Source #

The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive.

Constraints:

  • If supplied, must match an existing DBClusterIdentifier.

describeDBClusters_filters :: Lens' DescribeDBClusters (Maybe [Filter]) Source #

A filter that specifies one or more DB clusters to describe.

Supported filters:

  • db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB clusters identified by these ARNs.
  • engine - Accepts an engine name (such as neptune), and restricts the results list to DB clusters created by that engine.

For example, to invoke this API from the Amazon CLI and filter so that only Neptune DB clusters are returned, you could use the following command:

describeDBClusters_marker :: Lens' DescribeDBClusters (Maybe Text) Source #

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

describeDBClusters_maxRecords :: Lens' DescribeDBClusters (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.

Destructuring the Response

data DescribeDBClustersResponse Source #

See: newDescribeDBClustersResponse smart constructor.

Constructors

DescribeDBClustersResponse' 

Fields

Instances

Instances details
Eq DescribeDBClustersResponse Source # 
Instance details

Defined in Amazonka.Neptune.DescribeDBClusters

Read DescribeDBClustersResponse Source # 
Instance details

Defined in Amazonka.Neptune.DescribeDBClusters

Show DescribeDBClustersResponse Source # 
Instance details

Defined in Amazonka.Neptune.DescribeDBClusters

Generic DescribeDBClustersResponse Source # 
Instance details

Defined in Amazonka.Neptune.DescribeDBClusters

Associated Types

type Rep DescribeDBClustersResponse :: Type -> Type #

NFData DescribeDBClustersResponse Source # 
Instance details

Defined in Amazonka.Neptune.DescribeDBClusters

type Rep DescribeDBClustersResponse Source # 
Instance details

Defined in Amazonka.Neptune.DescribeDBClusters

type Rep DescribeDBClustersResponse = D1 ('MetaData "DescribeDBClustersResponse" "Amazonka.Neptune.DescribeDBClusters" "libZSservicesZSamazonka-neptuneZSamazonka-neptune" 'False) (C1 ('MetaCons "DescribeDBClustersResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbClusters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DBCluster])) :*: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeDBClustersResponse Source #

Create a value of DescribeDBClustersResponse 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:dbClusters:DescribeDBClustersResponse', describeDBClustersResponse_dbClusters - Contains a list of DB clusters for the user.

$sel:marker:DescribeDBClusters', describeDBClustersResponse_marker - A pagination token that can be used in a subsequent DescribeDBClusters request.

$sel:httpStatus:DescribeDBClustersResponse', describeDBClustersResponse_httpStatus - The response's http status code.

Response Lenses

describeDBClustersResponse_marker :: Lens' DescribeDBClustersResponse (Maybe Text) Source #

A pagination token that can be used in a subsequent DescribeDBClusters request.