Network.AWS.DAX.DescribeClusters

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

If the cluster is in the CREATING state, only cluster level information will be displayed until all of the nodes are successfully provisioned.

If the cluster is in the DELETING state, only cluster level information will be displayed.

If nodes are currently being added to the DAX cluster, node endpoint information and creation time for the additional nodes will not be displayed until they are completely provisioned. When the DAX cluster state is available , the cluster is ready for use.

If nodes are currently being removed from the DAX cluster, no endpoint information for the removed nodes is displayed.

Creating a Request

describeClusters :: DescribeClusters

Creates a value of DescribeClusters with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dcClusterNames - The names of the DAX clusters being described.
• dcNextToken - An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults .
• dcMaxResults - The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved. The value for MaxResults must be between 20 and 100.

data DescribeClusters

See: describeClusters smart constructor.

Instances

Eq DescribeClusters

Methods

(==) :: DescribeClusters -> DescribeClusters -> Bool

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

Data DescribeClusters

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeClusters -> c DescribeClusters

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeClusters

toConstr :: DescribeClusters -> Constr

dataTypeOf :: DescribeClusters -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeClusters)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeClusters)

gmapT :: (forall b. Data b => b -> b) -> DescribeClusters -> DescribeClusters

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeClusters -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeClusters -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeClusters -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeClusters -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeClusters -> m DescribeClusters

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeClusters -> m DescribeClusters

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeClusters -> m DescribeClusters

Read DescribeClusters

Methods

readsPrec :: Int -> ReadS DescribeClusters

readList :: ReadS [DescribeClusters]

readPrec :: ReadPrec DescribeClusters

readListPrec :: ReadPrec [DescribeClusters]

Show DescribeClusters

Methods

showsPrec :: Int -> DescribeClusters -> ShowS

show :: DescribeClusters -> String

showList :: [DescribeClusters] -> ShowS

Generic DescribeClusters

Associated Types

type Rep DescribeClusters :: * -> *

Methods

from :: DescribeClusters -> Rep DescribeClusters x

to :: Rep DescribeClusters x -> DescribeClusters

Hashable DescribeClusters

Methods

hashWithSalt :: Int -> DescribeClusters -> Int

hash :: DescribeClusters -> Int

ToJSON DescribeClusters

Methods

toJSON :: DescribeClusters -> Value

toEncoding :: DescribeClusters -> Encoding

toJSONList :: [DescribeClusters] -> Value

toEncodingList :: [DescribeClusters] -> Encoding

NFData DescribeClusters

Methods

rnf :: DescribeClusters -> ()

AWSRequest DescribeClusters

Associated Types

type Rs DescribeClusters :: *

Methods

request :: DescribeClusters -> Request DescribeClusters

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * DescribeClusters -> ClientResponse -> m (Response DescribeClusters)

ToHeaders DescribeClusters

Methods

toHeaders :: DescribeClusters -> [Header]

ToPath DescribeClusters

Methods

toPath :: DescribeClusters -> ByteString

ToQuery DescribeClusters

Methods

toQuery :: DescribeClusters -> QueryString

type Rep DescribeClusters

type Rep DescribeClusters = D1 * (MetaData "DescribeClusters" "Network.AWS.DAX.DescribeClusters" "amazonka-dynamodb-dax-1.6.0-31oAZKJCCRq6sH266jsUP" False) (C1 * (MetaCons "DescribeClusters'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_dcClusterNames") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Text]))) ((:*:) * (S1 * (MetaSel (Just Symbol "_dcNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_dcMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int))))))

type Rs DescribeClusters

type Rs DescribeClusters = DescribeClustersResponse

Request Lenses

dcClusterNames :: Lens' DescribeClusters [Text]

The names of the DAX clusters being described.

dcNextToken :: Lens' DescribeClusters (Maybe Text)

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults .

dcMaxResults :: Lens' DescribeClusters (Maybe Int)

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

Destructuring the Response

describeClustersResponse

Arguments

:: Int

dcrsResponseStatus

-> DescribeClustersResponse

Creates a value of DescribeClustersResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dcrsNextToken - Provides an identifier to allow retrieval of paginated results.
• dcrsClusters - The descriptions of your DAX clusters, in response to a DescribeClusters request.
• dcrsResponseStatus - -- | The response status code.

data DescribeClustersResponse

See: describeClustersResponse smart constructor.

Instances

Eq DescribeClustersResponse

Methods

(==) :: DescribeClustersResponse -> DescribeClustersResponse -> Bool

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

Data DescribeClustersResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeClustersResponse -> c DescribeClustersResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeClustersResponse

toConstr :: DescribeClustersResponse -> Constr

dataTypeOf :: DescribeClustersResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeClustersResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeClustersResponse)

gmapT :: (forall b. Data b => b -> b) -> DescribeClustersResponse -> DescribeClustersResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeClustersResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeClustersResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeClustersResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeClustersResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeClustersResponse -> m DescribeClustersResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeClustersResponse -> m DescribeClustersResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeClustersResponse -> m DescribeClustersResponse

Read DescribeClustersResponse

Methods

readsPrec :: Int -> ReadS DescribeClustersResponse

readList :: ReadS [DescribeClustersResponse]

readPrec :: ReadPrec DescribeClustersResponse

readListPrec :: ReadPrec [DescribeClustersResponse]

Show DescribeClustersResponse

Methods

showsPrec :: Int -> DescribeClustersResponse -> ShowS

show :: DescribeClustersResponse -> String

showList :: [DescribeClustersResponse] -> ShowS

Generic DescribeClustersResponse

Associated Types

type Rep DescribeClustersResponse :: * -> *

Methods

from :: DescribeClustersResponse -> Rep DescribeClustersResponse x

to :: Rep DescribeClustersResponse x -> DescribeClustersResponse

NFData DescribeClustersResponse

Methods

rnf :: DescribeClustersResponse -> ()

type Rep DescribeClustersResponse

type Rep DescribeClustersResponse = D1 * (MetaData "DescribeClustersResponse" "Network.AWS.DAX.DescribeClusters" "amazonka-dynamodb-dax-1.6.0-31oAZKJCCRq6sH266jsUP" False) (C1 * (MetaCons "DescribeClustersResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_dcrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_dcrsClusters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Cluster]))) (S1 * (MetaSel (Just Symbol "_dcrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

dcrsNextToken :: Lens' DescribeClustersResponse (Maybe Text)

Provides an identifier to allow retrieval of paginated results.

dcrsClusters :: Lens' DescribeClustersResponse [Cluster]

The descriptions of your DAX clusters, in response to a DescribeClusters request.

dcrsResponseStatus :: Lens' DescribeClustersResponse Int

• - | The response status code.