Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Neptune.DescribeGlobalClusters

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns information about Neptune global database clusters. This API supports pagination.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeGlobalClusters Source #

See: newDescribeGlobalClusters smart constructor.

Constructors

DescribeGlobalClusters'

Fields

globalClusterIdentifier :: Maybe Text
The user-supplied DB cluster identifier. If this parameter is specified, only information about the specified DB cluster is returned. This parameter is not case-sensitive.
Constraints: If supplied, must match an existing DB cluster identifier.
marker :: Maybe Text
(Optional) A pagination token returned by a previous call to DescribeGlobalClusters. If this parameter is specified, the response will only include records beyond the marker, up to the number 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 marker token is included in the response that you can use to retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.

Instances

Instances details

ToHeaders DescribeGlobalClusters Source #
Instance details Defined in Amazonka.Neptune.DescribeGlobalClusters Methods toHeaders :: DescribeGlobalClusters -> [Header] #
ToPath DescribeGlobalClusters Source #
Instance details Defined in Amazonka.Neptune.DescribeGlobalClusters Methods toPath :: DescribeGlobalClusters -> ByteString #
ToQuery DescribeGlobalClusters Source #
Instance details Defined in Amazonka.Neptune.DescribeGlobalClusters Methods toQuery :: DescribeGlobalClusters -> QueryString #
AWSPager DescribeGlobalClusters Source #
Instance details Defined in Amazonka.Neptune.DescribeGlobalClusters Methods page :: DescribeGlobalClusters -> AWSResponse DescribeGlobalClusters -> Maybe DescribeGlobalClusters #
AWSRequest DescribeGlobalClusters Source #
Instance details Defined in Amazonka.Neptune.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 Source #
Instance details Defined in Amazonka.Neptune.DescribeGlobalClusters Associated Types type Rep DescribeGlobalClusters :: Type -> Type # Methods from :: DescribeGlobalClusters -> Rep DescribeGlobalClusters x # to :: Rep DescribeGlobalClusters x -> DescribeGlobalClusters #
Read DescribeGlobalClusters Source #
Instance details Defined in Amazonka.Neptune.DescribeGlobalClusters Methods readsPrec :: Int -> ReadS DescribeGlobalClusters # readList :: ReadS [DescribeGlobalClusters] # readPrec :: ReadPrec DescribeGlobalClusters # readListPrec :: ReadPrec [DescribeGlobalClusters] #
Show DescribeGlobalClusters Source #
Instance details Defined in Amazonka.Neptune.DescribeGlobalClusters Methods showsPrec :: Int -> DescribeGlobalClusters -> ShowS # show :: DescribeGlobalClusters -> String # showList :: [DescribeGlobalClusters] -> ShowS #
NFData DescribeGlobalClusters Source #
Instance details Defined in Amazonka.Neptune.DescribeGlobalClusters Methods rnf :: DescribeGlobalClusters -> () #
Eq DescribeGlobalClusters Source #
Instance details Defined in Amazonka.Neptune.DescribeGlobalClusters Methods (==) :: DescribeGlobalClusters -> DescribeGlobalClusters -> Bool # (/=) :: DescribeGlobalClusters -> DescribeGlobalClusters -> Bool #
Hashable DescribeGlobalClusters Source #
Instance details Defined in Amazonka.Neptune.DescribeGlobalClusters Methods hashWithSalt :: Int -> DescribeGlobalClusters -> Int # hash :: DescribeGlobalClusters -> Int #
type AWSResponse DescribeGlobalClusters Source #
Instance details Defined in Amazonka.Neptune.DescribeGlobalClusters type AWSResponse DescribeGlobalClusters = DescribeGlobalClustersResponse
type Rep DescribeGlobalClusters Source #
Instance details Defined in Amazonka.Neptune.DescribeGlobalClusters type Rep DescribeGlobalClusters = D1 ('MetaData "DescribeGlobalClusters" "Amazonka.Neptune.DescribeGlobalClusters" "amazonka-neptune-2.0-2gYqDRsIJxo6L8BEj2Stvk" 'False) (C1 ('MetaCons "DescribeGlobalClusters'" 'PrefixI 'True) (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 Source #

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:

DescribeGlobalClusters, describeGlobalClusters_globalClusterIdentifier - The user-supplied DB cluster identifier. If this parameter is specified, only information about the specified DB cluster is returned. This parameter is not case-sensitive.

Constraints: If supplied, must match an existing DB cluster identifier.

DescribeGlobalClusters, describeGlobalClusters_marker - (Optional) A pagination token returned by a previous call to DescribeGlobalClusters. If this parameter is specified, the response will only include records beyond the marker, up to the number 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 marker token is included in the response that you can use to retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

Request Lenses

describeGlobalClusters_globalClusterIdentifier :: Lens' DescribeGlobalClusters (Maybe Text) Source #

The user-supplied DB cluster identifier. If this parameter is specified, only information about the specified DB cluster is returned. This parameter is not case-sensitive.

Constraints: If supplied, must match an existing DB cluster identifier.

describeGlobalClusters_marker :: Lens' DescribeGlobalClusters (Maybe Text) Source #

(Optional) A pagination token returned by a previous call to DescribeGlobalClusters. If this parameter is specified, the response will only include records beyond the marker, up to the number specified by MaxRecords.

describeGlobalClusters_maxRecords :: Lens' DescribeGlobalClusters (Maybe Int) Source #

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination marker token is included in the response that you can use to retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

Destructuring the Response

data DescribeGlobalClustersResponse Source #

See: newDescribeGlobalClustersResponse smart constructor.

Constructors

DescribeGlobalClustersResponse'
Fields globalClusters :: Maybe [GlobalCluster] The list of global clusters and instances returned by this request. marker :: Maybe Text A pagination token. If this parameter is returned in the response, more records are available, which can be retrieved by one or more additional calls to `DescribeGlobalClusters`. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DescribeGlobalClustersResponse Source #
Instance details Defined in Amazonka.Neptune.DescribeGlobalClusters Associated Types type Rep DescribeGlobalClustersResponse :: Type -> Type # Methods from :: DescribeGlobalClustersResponse -> Rep DescribeGlobalClustersResponse x # to :: Rep DescribeGlobalClustersResponse x -> DescribeGlobalClustersResponse #
Read DescribeGlobalClustersResponse Source #
Instance details Defined in Amazonka.Neptune.DescribeGlobalClusters Methods readsPrec :: Int -> ReadS DescribeGlobalClustersResponse # readList :: ReadS [DescribeGlobalClustersResponse] # readPrec :: ReadPrec DescribeGlobalClustersResponse # readListPrec :: ReadPrec [DescribeGlobalClustersResponse] #
Show DescribeGlobalClustersResponse Source #
Instance details Defined in Amazonka.Neptune.DescribeGlobalClusters Methods showsPrec :: Int -> DescribeGlobalClustersResponse -> ShowS # show :: DescribeGlobalClustersResponse -> String # showList :: [DescribeGlobalClustersResponse] -> ShowS #
NFData DescribeGlobalClustersResponse Source #
Instance details Defined in Amazonka.Neptune.DescribeGlobalClusters Methods rnf :: DescribeGlobalClustersResponse -> () #
Eq DescribeGlobalClustersResponse Source #
Instance details Defined in Amazonka.Neptune.DescribeGlobalClusters Methods (==) :: DescribeGlobalClustersResponse -> DescribeGlobalClustersResponse -> Bool # (/=) :: DescribeGlobalClustersResponse -> DescribeGlobalClustersResponse -> Bool #
type Rep DescribeGlobalClustersResponse Source #
Instance details Defined in Amazonka.Neptune.DescribeGlobalClusters type Rep DescribeGlobalClustersResponse = D1 ('MetaData "DescribeGlobalClustersResponse" "Amazonka.Neptune.DescribeGlobalClusters" "amazonka-neptune-2.0-2gYqDRsIJxo6L8BEj2Stvk" '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 Source #

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 - The list of global clusters and instances returned by this request.

DescribeGlobalClusters, describeGlobalClustersResponse_marker - A pagination token. If this parameter is returned in the response, more records are available, which can be retrieved by one or more additional calls to DescribeGlobalClusters.

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

Response Lenses

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

The list of global clusters and instances returned by this request.

describeGlobalClustersResponse_marker :: Lens' DescribeGlobalClustersResponse (Maybe Text) Source #

A pagination token. If this parameter is returned in the response, more records are available, which can be retrieved by one or more additional calls to DescribeGlobalClusters.

describeGlobalClustersResponse_httpStatus :: Lens' DescribeGlobalClustersResponse Int Source #

The response's http status code.