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

This operation returns paginated results.

Creating a Request

data DescribeClusters

See: newDescribeClusters smart constructor.

Constructors

DescribeClusters'

Fields

• clusterNames :: Maybe [Text]

  The names of the DAX clusters being described.

• maxResults :: 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.

• nextToken :: 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.

Instances

ToJSON DescribeClusters

Defined in Amazonka.DAX.DescribeClusters

Methods

toJSON :: DescribeClusters -> Value

toEncoding :: DescribeClusters -> Encoding

toJSONList :: [DescribeClusters] -> Value

toEncodingList :: [DescribeClusters] -> Encoding

ToHeaders DescribeClusters

Defined in Amazonka.DAX.DescribeClusters

Methods

toHeaders :: DescribeClusters -> [Header]

ToPath DescribeClusters

Defined in Amazonka.DAX.DescribeClusters

Methods

toPath :: DescribeClusters -> ByteString

ToQuery DescribeClusters

Defined in Amazonka.DAX.DescribeClusters

Methods

toQuery :: DescribeClusters -> QueryString

AWSPager DescribeClusters

Defined in Amazonka.DAX.DescribeClusters

Methods

page :: DescribeClusters -> AWSResponse DescribeClusters -> Maybe DescribeClusters

AWSRequest DescribeClusters

Defined in Amazonka.DAX.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

Defined in Amazonka.DAX.DescribeClusters

Associated Types

type Rep DescribeClusters :: Type -> Type

Methods

from :: DescribeClusters -> Rep DescribeClusters x

to :: Rep DescribeClusters x -> DescribeClusters

Read DescribeClusters

Defined in Amazonka.DAX.DescribeClusters

Methods

readsPrec :: Int -> ReadS DescribeClusters

readList :: ReadS [DescribeClusters]

readPrec :: ReadPrec DescribeClusters

readListPrec :: ReadPrec [DescribeClusters]

Show DescribeClusters

Defined in Amazonka.DAX.DescribeClusters

Methods

showsPrec :: Int -> DescribeClusters -> ShowS

show :: DescribeClusters -> String

showList :: [DescribeClusters] -> ShowS

NFData DescribeClusters

Defined in Amazonka.DAX.DescribeClusters

Methods

rnf :: DescribeClusters -> ()

Eq DescribeClusters

Defined in Amazonka.DAX.DescribeClusters

Methods

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

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

Hashable DescribeClusters

Defined in Amazonka.DAX.DescribeClusters

Methods

hashWithSalt :: Int -> DescribeClusters -> Int

hash :: DescribeClusters -> Int

type AWSResponse DescribeClusters

Defined in Amazonka.DAX.DescribeClusters

type AWSResponse DescribeClusters = DescribeClustersResponse

type Rep DescribeClusters

Defined in Amazonka.DAX.DescribeClusters

type Rep DescribeClusters = D1 ('MetaData "DescribeClusters" "Amazonka.DAX.DescribeClusters" "amazonka-dynamodb-dax-2.0-FwsdPL1z9NS2dTys8oHQ2n" 'False) (C1 ('MetaCons "DescribeClusters'" 'PrefixI 'True) (S1 ('MetaSel ('Just "clusterNames") '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)))))

newDescribeClusters :: DescribeClusters

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:clusterNames:DescribeClusters', describeClusters_clusterNames - The names of the DAX clusters being described.

$sel:maxResults:DescribeClusters', describeClusters_maxResults - 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.

DescribeClusters, describeClusters_nextToken - 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.

Request Lenses

describeClusters_clusterNames :: Lens' DescribeClusters (Maybe [Text])

The names of the DAX clusters being described.

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

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

Destructuring the Response

data DescribeClustersResponse

See: newDescribeClustersResponse smart constructor.

Constructors

DescribeClustersResponse'

Fields

• clusters :: Maybe [Cluster]

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

• nextToken :: Maybe Text

  Provides an identifier to allow retrieval of paginated results.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeClustersResponse

Defined in Amazonka.DAX.DescribeClusters

Associated Types

type Rep DescribeClustersResponse :: Type -> Type

Methods

from :: DescribeClustersResponse -> Rep DescribeClustersResponse x

to :: Rep DescribeClustersResponse x -> DescribeClustersResponse

Read DescribeClustersResponse

Defined in Amazonka.DAX.DescribeClusters

Methods

readsPrec :: Int -> ReadS DescribeClustersResponse

readList :: ReadS [DescribeClustersResponse]

readPrec :: ReadPrec DescribeClustersResponse

readListPrec :: ReadPrec [DescribeClustersResponse]

Show DescribeClustersResponse

Defined in Amazonka.DAX.DescribeClusters

Methods

showsPrec :: Int -> DescribeClustersResponse -> ShowS

show :: DescribeClustersResponse -> String

showList :: [DescribeClustersResponse] -> ShowS

NFData DescribeClustersResponse

Defined in Amazonka.DAX.DescribeClusters

Methods

rnf :: DescribeClustersResponse -> ()

Eq DescribeClustersResponse

Defined in Amazonka.DAX.DescribeClusters

Methods

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

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

type Rep DescribeClustersResponse

Defined in Amazonka.DAX.DescribeClusters

type Rep DescribeClustersResponse = D1 ('MetaData "DescribeClustersResponse" "Amazonka.DAX.DescribeClusters" "amazonka-dynamodb-dax-2.0-FwsdPL1z9NS2dTys8oHQ2n" '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

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:clusters:DescribeClustersResponse', describeClustersResponse_clusters - The descriptions of your DAX clusters, in response to a DescribeClusters request.

DescribeClusters, describeClustersResponse_nextToken - Provides an identifier to allow retrieval of paginated results.

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

Response Lenses

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

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

describeClustersResponse_nextToken :: Lens' DescribeClustersResponse (Maybe Text)

Provides an identifier to allow retrieval of paginated results.

describeClustersResponse_httpStatus :: Lens' DescribeClustersResponse Int

The response's http status code.