Amazonka.DocumentDB.DescribeGlobalClusters

Returns information about Amazon DocumentDB global clusters. This API supports pagination.

This action only applies to Amazon DocumentDB clusters.

This operation returns paginated results.

Creating a Request

data DescribeGlobalClusters

See: newDescribeGlobalClusters smart constructor.

Constructors

DescribeGlobalClusters'

Fields

• filters :: Maybe [Filter]

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

  Supported filters: db-cluster-id accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list will only include information about the clusters identified by these ARNs.

• globalClusterIdentifier :: Maybe Text

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

• marker :: Maybe Text

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

Instances

ToHeaders DescribeGlobalClusters

Defined in Amazonka.DocumentDB.DescribeGlobalClusters

Methods

toHeaders :: DescribeGlobalClusters -> [Header]

ToPath DescribeGlobalClusters

Defined in Amazonka.DocumentDB.DescribeGlobalClusters

Methods

toPath :: DescribeGlobalClusters -> ByteString

ToQuery DescribeGlobalClusters

Defined in Amazonka.DocumentDB.DescribeGlobalClusters

Methods

toQuery :: DescribeGlobalClusters -> QueryString

AWSPager DescribeGlobalClusters

Defined in Amazonka.DocumentDB.DescribeGlobalClusters

Methods

page :: DescribeGlobalClusters -> AWSResponse DescribeGlobalClusters -> Maybe DescribeGlobalClusters

AWSRequest DescribeGlobalClusters

Defined in Amazonka.DocumentDB.DescribeGlobalClusters

Associated Types

type AWSResponse DescribeGlobalClusters

Methods

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

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

Generic DescribeGlobalClusters

Defined in Amazonka.DocumentDB.DescribeGlobalClusters

Associated Types

type Rep DescribeGlobalClusters :: Type -> Type

Methods

from :: DescribeGlobalClusters -> Rep DescribeGlobalClusters x

to :: Rep DescribeGlobalClusters x -> DescribeGlobalClusters

Read DescribeGlobalClusters

Defined in Amazonka.DocumentDB.DescribeGlobalClusters

Methods

readsPrec :: Int -> ReadS DescribeGlobalClusters

readList :: ReadS [DescribeGlobalClusters]

readPrec :: ReadPrec DescribeGlobalClusters

readListPrec :: ReadPrec [DescribeGlobalClusters]

Show DescribeGlobalClusters

Defined in Amazonka.DocumentDB.DescribeGlobalClusters

Methods

showsPrec :: Int -> DescribeGlobalClusters -> ShowS

show :: DescribeGlobalClusters -> String

showList :: [DescribeGlobalClusters] -> ShowS

NFData DescribeGlobalClusters

Defined in Amazonka.DocumentDB.DescribeGlobalClusters

Methods

rnf :: DescribeGlobalClusters -> ()

Eq DescribeGlobalClusters

Defined in Amazonka.DocumentDB.DescribeGlobalClusters

Methods

(==) :: DescribeGlobalClusters -> DescribeGlobalClusters -> Bool

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

Hashable DescribeGlobalClusters

Defined in Amazonka.DocumentDB.DescribeGlobalClusters

Methods

hashWithSalt :: Int -> DescribeGlobalClusters -> Int

hash :: DescribeGlobalClusters -> Int

type AWSResponse DescribeGlobalClusters

Defined in Amazonka.DocumentDB.DescribeGlobalClusters

type AWSResponse DescribeGlobalClusters = DescribeGlobalClustersResponse

type Rep DescribeGlobalClusters

Defined in Amazonka.DocumentDB.DescribeGlobalClusters

type Rep DescribeGlobalClusters = D1 ('MetaData "DescribeGlobalClusters" "Amazonka.DocumentDB.DescribeGlobalClusters" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "DescribeGlobalClusters'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter])) :*: S1 ('MetaSel ('Just "globalClusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxRecords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))))

newDescribeGlobalClusters :: DescribeGlobalClusters

Create a value of DescribeGlobalClusters 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:DescribeGlobalClusters', describeGlobalClusters_filters - A filter that specifies one or more global DB clusters to describe.

Supported filters: db-cluster-id accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list will only include information about the clusters identified by these ARNs.

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

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

$sel:maxRecords:DescribeGlobalClusters', describeGlobalClusters_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.

Request Lenses

describeGlobalClusters_filters :: Lens' DescribeGlobalClusters (Maybe [Filter])

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

Supported filters: db-cluster-id accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list will only include information about the clusters identified by these ARNs.

describeGlobalClusters_globalClusterIdentifier :: Lens' DescribeGlobalClusters (Maybe Text)

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

describeGlobalClusters_marker :: Lens' DescribeGlobalClusters (Maybe Text)

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

describeGlobalClusters_maxRecords :: Lens' DescribeGlobalClusters (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.

Destructuring the Response

data DescribeGlobalClustersResponse

See: newDescribeGlobalClustersResponse smart constructor.

Constructors

DescribeGlobalClustersResponse'

Fields

• globalClusters :: Maybe [GlobalCluster]
• marker :: Maybe Text
• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeGlobalClustersResponse

Defined in Amazonka.DocumentDB.DescribeGlobalClusters

Associated Types

type Rep DescribeGlobalClustersResponse :: Type -> Type

Methods

from :: DescribeGlobalClustersResponse -> Rep DescribeGlobalClustersResponse x

to :: Rep DescribeGlobalClustersResponse x -> DescribeGlobalClustersResponse

Read DescribeGlobalClustersResponse

Defined in Amazonka.DocumentDB.DescribeGlobalClusters

Methods

readsPrec :: Int -> ReadS DescribeGlobalClustersResponse

readList :: ReadS [DescribeGlobalClustersResponse]

readPrec :: ReadPrec DescribeGlobalClustersResponse

readListPrec :: ReadPrec [DescribeGlobalClustersResponse]

Show DescribeGlobalClustersResponse

Defined in Amazonka.DocumentDB.DescribeGlobalClusters

Methods

showsPrec :: Int -> DescribeGlobalClustersResponse -> ShowS

show :: DescribeGlobalClustersResponse -> String

showList :: [DescribeGlobalClustersResponse] -> ShowS

NFData DescribeGlobalClustersResponse

Defined in Amazonka.DocumentDB.DescribeGlobalClusters

Methods

rnf :: DescribeGlobalClustersResponse -> ()

Eq DescribeGlobalClustersResponse

Defined in Amazonka.DocumentDB.DescribeGlobalClusters

Methods

(==) :: DescribeGlobalClustersResponse -> DescribeGlobalClustersResponse -> Bool

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

type Rep DescribeGlobalClustersResponse

Defined in Amazonka.DocumentDB.DescribeGlobalClusters

type Rep DescribeGlobalClustersResponse = D1 ('MetaData "DescribeGlobalClustersResponse" "Amazonka.DocumentDB.DescribeGlobalClusters" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "DescribeGlobalClustersResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "globalClusters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [GlobalCluster])) :*: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeGlobalClustersResponse

Arguments

:: Int

$sel:httpStatus:DescribeGlobalClustersResponse'

-> DescribeGlobalClustersResponse

Create a value of DescribeGlobalClustersResponse 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:globalClusters:DescribeGlobalClustersResponse', describeGlobalClustersResponse_globalClusters -

DescribeGlobalClusters, describeGlobalClustersResponse_marker -

$sel:httpStatus:DescribeGlobalClustersResponse', describeGlobalClustersResponse_httpStatus - The response's http status code.

Response Lenses

describeGlobalClustersResponse_globalClusters :: Lens' DescribeGlobalClustersResponse (Maybe [GlobalCluster])

describeGlobalClustersResponse_marker :: Lens' DescribeGlobalClustersResponse (Maybe Text)

describeGlobalClustersResponse_httpStatus :: Lens' DescribeGlobalClustersResponse Int

The response's http status code.