Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.MemoryDb.DescribeClusters

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific cluster if a cluster name is supplied.

Synopsis

data DescribeClusters = DescribeClusters' {
- showShardDetails :: Maybe Bool
- nextToken :: Maybe Text
- clusterName :: Maybe Text
- maxResults :: Maybe Int
}
newDescribeClusters :: DescribeClusters
describeClusters_showShardDetails :: Lens' DescribeClusters (Maybe Bool)
describeClusters_nextToken :: Lens' DescribeClusters (Maybe Text)
describeClusters_clusterName :: Lens' DescribeClusters (Maybe Text)
describeClusters_maxResults :: Lens' DescribeClusters (Maybe Int)
data DescribeClustersResponse = DescribeClustersResponse' {
- nextToken :: Maybe Text
- clusters :: Maybe [Cluster]
- httpStatus :: Int
}
newDescribeClustersResponse :: Int -> DescribeClustersResponse
describeClustersResponse_nextToken :: Lens' DescribeClustersResponse (Maybe Text)
describeClustersResponse_clusters :: Lens' DescribeClustersResponse (Maybe [Cluster])
describeClustersResponse_httpStatus :: Lens' DescribeClustersResponse Int

Creating a Request

data DescribeClusters Source #

See: newDescribeClusters smart constructor.

Constructors

DescribeClusters'

Fields

showShardDetails :: Maybe Bool
An optional flag that can be included in the request to retrieve information about the individual shard(s).
nextToken :: Maybe Text
An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
clusterName :: Maybe Text
The name of the cluster
maxResults :: Maybe Int
The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

Instances

Instances details

Eq DescribeClusters Source #
Instance details Defined in Amazonka.MemoryDb.DescribeClusters Methods (==) :: DescribeClusters -> DescribeClusters -> Bool # (/=) :: DescribeClusters -> DescribeClusters -> Bool #
Read DescribeClusters Source #
Instance details Defined in Amazonka.MemoryDb.DescribeClusters Methods readsPrec :: Int -> ReadS DescribeClusters # readList :: ReadS [DescribeClusters] # readPrec :: ReadPrec DescribeClusters # readListPrec :: ReadPrec [DescribeClusters] #
Show DescribeClusters Source #
Instance details Defined in Amazonka.MemoryDb.DescribeClusters Methods showsPrec :: Int -> DescribeClusters -> ShowS # show :: DescribeClusters -> String # showList :: [DescribeClusters] -> ShowS #
Generic DescribeClusters Source #
Instance details Defined in Amazonka.MemoryDb.DescribeClusters Associated Types type Rep DescribeClusters :: Type -> Type # Methods from :: DescribeClusters -> Rep DescribeClusters x # to :: Rep DescribeClusters x -> DescribeClusters #
NFData DescribeClusters Source #
Instance details Defined in Amazonka.MemoryDb.DescribeClusters Methods rnf :: DescribeClusters -> () #
Hashable DescribeClusters Source #
Instance details Defined in Amazonka.MemoryDb.DescribeClusters Methods hashWithSalt :: Int -> DescribeClusters -> Int # hash :: DescribeClusters -> Int #
ToJSON DescribeClusters Source #
Instance details Defined in Amazonka.MemoryDb.DescribeClusters Methods toJSON :: DescribeClusters -> Value # toEncoding :: DescribeClusters -> Encoding # toJSONList :: [DescribeClusters] -> Value # toEncodingList :: [DescribeClusters] -> Encoding #
AWSRequest DescribeClusters Source #
Instance details Defined in Amazonka.MemoryDb.DescribeClusters Associated Types type AWSResponse DescribeClusters # Methods request :: DescribeClusters -> Request DescribeClusters # response :: MonadResource m => Logger -> Service -> Proxy DescribeClusters -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeClusters))) #
ToHeaders DescribeClusters Source #
Instance details Defined in Amazonka.MemoryDb.DescribeClusters Methods toHeaders :: DescribeClusters -> [Header] #
ToPath DescribeClusters Source #
Instance details Defined in Amazonka.MemoryDb.DescribeClusters Methods toPath :: DescribeClusters -> ByteString #
ToQuery DescribeClusters Source #
Instance details Defined in Amazonka.MemoryDb.DescribeClusters Methods toQuery :: DescribeClusters -> QueryString #
type Rep DescribeClusters Source #
Instance details Defined in Amazonka.MemoryDb.DescribeClusters type Rep DescribeClusters = D1 ('MetaData "DescribeClusters" "Amazonka.MemoryDb.DescribeClusters" "libZSservicesZSamazonka-memorydbZSamazonka-memorydb" 'False) (C1 ('MetaCons "DescribeClusters'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "showShardDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "clusterName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))))
type AWSResponse DescribeClusters Source #
Instance details Defined in Amazonka.MemoryDb.DescribeClusters type AWSResponse DescribeClusters = DescribeClustersResponse

newDescribeClusters :: DescribeClusters Source #

Create a value of DescribeClusters 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:showShardDetails:DescribeClusters', describeClusters_showShardDetails - An optional flag that can be included in the request to retrieve information about the individual shard(s).

$sel:nextToken:DescribeClusters', describeClusters_nextToken - An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

$sel:clusterName:DescribeClusters', describeClusters_clusterName - The name of the cluster

$sel:maxResults:DescribeClusters', describeClusters_maxResults - The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

Request Lenses

describeClusters_showShardDetails :: Lens' DescribeClusters (Maybe Bool) Source #

An optional flag that can be included in the request to retrieve information about the individual shard(s).

describeClusters_nextToken :: Lens' DescribeClusters (Maybe Text) Source #

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

describeClusters_clusterName :: Lens' DescribeClusters (Maybe Text) Source #

The name of the cluster

describeClusters_maxResults :: Lens' DescribeClusters (Maybe Int) Source #

The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

Destructuring the Response

data DescribeClustersResponse Source #

See: newDescribeClustersResponse smart constructor.

Constructors

DescribeClustersResponse'

Fields

nextToken :: Maybe Text
An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
clusters :: Maybe [Cluster]
A list of clusters
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq DescribeClustersResponse Source #
Instance details Defined in Amazonka.MemoryDb.DescribeClusters Methods (==) :: DescribeClustersResponse -> DescribeClustersResponse -> Bool # (/=) :: DescribeClustersResponse -> DescribeClustersResponse -> Bool #
Read DescribeClustersResponse Source #
Instance details Defined in Amazonka.MemoryDb.DescribeClusters Methods readsPrec :: Int -> ReadS DescribeClustersResponse # readList :: ReadS [DescribeClustersResponse] # readPrec :: ReadPrec DescribeClustersResponse # readListPrec :: ReadPrec [DescribeClustersResponse] #
Show DescribeClustersResponse Source #
Instance details Defined in Amazonka.MemoryDb.DescribeClusters Methods showsPrec :: Int -> DescribeClustersResponse -> ShowS # show :: DescribeClustersResponse -> String # showList :: [DescribeClustersResponse] -> ShowS #
Generic DescribeClustersResponse Source #
Instance details Defined in Amazonka.MemoryDb.DescribeClusters Associated Types type Rep DescribeClustersResponse :: Type -> Type # Methods from :: DescribeClustersResponse -> Rep DescribeClustersResponse x # to :: Rep DescribeClustersResponse x -> DescribeClustersResponse #
NFData DescribeClustersResponse Source #
Instance details Defined in Amazonka.MemoryDb.DescribeClusters Methods rnf :: DescribeClustersResponse -> () #
type Rep DescribeClustersResponse Source #
Instance details Defined in Amazonka.MemoryDb.DescribeClusters type Rep DescribeClustersResponse = D1 ('MetaData "DescribeClustersResponse" "Amazonka.MemoryDb.DescribeClusters" "libZSservicesZSamazonka-memorydbZSamazonka-memorydb" 'False) (C1 ('MetaCons "DescribeClustersResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "clusters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Cluster])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeClustersResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeClustersResponse'`
-> DescribeClustersResponse

Create a value of DescribeClustersResponse 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:nextToken:DescribeClusters', describeClustersResponse_nextToken - An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

$sel:clusters:DescribeClustersResponse', describeClustersResponse_clusters - A list of clusters

$sel:httpStatus:DescribeClustersResponse', describeClustersResponse_httpStatus - The response's http status code.

Response Lenses

describeClustersResponse_nextToken :: Lens' DescribeClustersResponse (Maybe Text) Source #

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

describeClustersResponse_clusters :: Lens' DescribeClustersResponse (Maybe [Cluster]) Source #

A list of clusters

describeClustersResponse_httpStatus :: Lens' DescribeClustersResponse Int Source #

The response's http status code.