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

This operation returns paginated results.

Synopsis

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

Creating a Request

data DescribeClusters Source #

See: newDescribeClusters smart constructor.

Constructors

DescribeClusters'

Fields

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.
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.
showShardDetails :: Maybe Bool
An optional flag that can be included in the request to retrieve information about the individual shard(s).

Instances

Instances details

ToJSON DescribeClusters Source #
Instance details Defined in Amazonka.MemoryDb.DescribeClusters Methods toJSON :: DescribeClusters -> Value # toEncoding :: DescribeClusters -> Encoding # toJSONList :: [DescribeClusters] -> Value # toEncodingList :: [DescribeClusters] -> Encoding #
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 #
AWSPager DescribeClusters Source #
Instance details Defined in Amazonka.MemoryDb.DescribeClusters Methods page :: DescribeClusters -> AWSResponse DescribeClusters -> Maybe DescribeClusters #
AWSRequest DescribeClusters Source #
Instance details Defined in Amazonka.MemoryDb.DescribeClusters Associated Types type AWSResponse DescribeClusters # Methods request :: (Service -> Service) -> DescribeClusters -> Request DescribeClusters # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeClusters -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeClusters))) #
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 #
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 #
NFData DescribeClusters Source #
Instance details Defined in Amazonka.MemoryDb.DescribeClusters Methods rnf :: DescribeClusters -> () #
Eq DescribeClusters Source #
Instance details Defined in Amazonka.MemoryDb.DescribeClusters Methods (==) :: DescribeClusters -> DescribeClusters -> Bool # (/=) :: DescribeClusters -> DescribeClusters -> Bool #
Hashable DescribeClusters Source #
Instance details Defined in Amazonka.MemoryDb.DescribeClusters Methods hashWithSalt :: Int -> DescribeClusters -> Int # hash :: DescribeClusters -> Int #
type AWSResponse DescribeClusters Source #
Instance details Defined in Amazonka.MemoryDb.DescribeClusters type AWSResponse DescribeClusters = DescribeClustersResponse
type Rep DescribeClusters Source #
Instance details Defined in Amazonka.MemoryDb.DescribeClusters type Rep DescribeClusters = D1 ('MetaData "DescribeClusters" "Amazonka.MemoryDb.DescribeClusters" "amazonka-memorydb-2.0-7JvPQiLpSKi6naAXiKMLiu" 'False) (C1 ('MetaCons "DescribeClusters'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clusterName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "showShardDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))))

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:

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.

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

Request Lenses

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.

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_showShardDetails :: Lens' DescribeClusters (Maybe Bool) Source #

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

Destructuring the Response

data DescribeClustersResponse Source #

See: newDescribeClustersResponse smart constructor.

Constructors

DescribeClustersResponse'

Fields

clusters :: Maybe [Cluster]
A list of clusters
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.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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 #
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 #
NFData DescribeClustersResponse Source #
Instance details Defined in Amazonka.MemoryDb.DescribeClusters Methods rnf :: DescribeClustersResponse -> () #
Eq DescribeClustersResponse Source #
Instance details Defined in Amazonka.MemoryDb.DescribeClusters Methods (==) :: DescribeClustersResponse -> DescribeClustersResponse -> Bool # (/=) :: DescribeClustersResponse -> DescribeClustersResponse -> Bool #
type Rep DescribeClustersResponse Source #
Instance details Defined in Amazonka.MemoryDb.DescribeClusters type Rep DescribeClustersResponse = D1 ('MetaData "DescribeClustersResponse" "Amazonka.MemoryDb.DescribeClusters" "amazonka-memorydb-2.0-7JvPQiLpSKi6naAXiKMLiu" 'False) (C1 ('MetaCons "DescribeClustersResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "clusters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Cluster])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: 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:

DescribeClustersResponse, describeClustersResponse_clusters - A list of clusters

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:httpStatus:DescribeClustersResponse', describeClustersResponse_httpStatus - The response's http status code.

Response Lenses

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

A list of clusters

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_httpStatus :: Lens' DescribeClustersResponse Int Source #

The response's http status code.