Network.AWS.CloudHSMv2.DescribeClusters

Gets information about AWS CloudHSM clusters.

This is a paginated operation, which means that each response might contain only a subset of all the clusters. When the response contains only a subset of clusters, it includes a NextToken value. Use this value in a subsequent DescribeClusters request to get more clusters. When you receive a response with no NextToken (or an empty or null value), that means there are no more clusters to get.

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:

• dcFilters - One or more filters to limit the items returned in the response. Use the clusterIds filter to return only the specified clusters. Specify clusters by their cluster identifier (ID). Use the vpcIds filter to return only the clusters in the specified virtual private clouds (VPCs). Specify VPCs by their VPC identifier (ID). Use the states filter to return only clusters that match the specified state.
• dcNextToken - The NextToken value that you received in the previous response. Use this value to get more clusters.
• dcMaxResults - The maximum number of clusters to return in the response. When there are more clusters than the number you specify, the response contains a NextToken value.

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 => Logger -> Service -> Proxy * DescribeClusters -> ClientResponse -> m (Response DescribeClusters)

ToQuery DescribeClusters

Methods

toQuery :: DescribeClusters -> QueryString

ToPath DescribeClusters

Methods

toPath :: DescribeClusters -> ByteString

ToHeaders DescribeClusters

Methods

toHeaders :: DescribeClusters -> [Header]

type Rep DescribeClusters

type Rep DescribeClusters = D1 (MetaData "DescribeClusters" "Network.AWS.CloudHSMv2.DescribeClusters" "amazonka-cloudhsmv2-1.5.0-9gkNObchpN7FWF7WWGRIob" False) (C1 (MetaCons "DescribeClusters'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_dcFilters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text [Text])))) ((:*:) (S1 (MetaSel (Just Symbol "_dcNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dcMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))))))

type Rs DescribeClusters

type Rs DescribeClusters = DescribeClustersResponse

Request Lenses

dcFilters :: Lens' DescribeClusters (HashMap Text [Text])

One or more filters to limit the items returned in the response. Use the clusterIds filter to return only the specified clusters. Specify clusters by their cluster identifier (ID). Use the vpcIds filter to return only the clusters in the specified virtual private clouds (VPCs). Specify VPCs by their VPC identifier (ID). Use the states filter to return only clusters that match the specified state.

dcNextToken :: Lens' DescribeClusters (Maybe Text)

The NextToken value that you received in the previous response. Use this value to get more clusters.

dcMaxResults :: Lens' DescribeClusters (Maybe Natural)

The maximum number of clusters to return in the response. When there are more clusters than the number you specify, the response contains a NextToken value.

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 - An opaque string that indicates that the response contains only a subset of clusters. Use this value in a subsequent DescribeClusters request to get more clusters.
• dcrsClusters - A list of clusters.
• 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.CloudHSMv2.DescribeClusters" "amazonka-cloudhsmv2-1.5.0-9gkNObchpN7FWF7WWGRIob" 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)

An opaque string that indicates that the response contains only a subset of clusters. Use this value in a subsequent DescribeClusters request to get more clusters.

dcrsClusters :: Lens' DescribeClustersResponse [Cluster]

A list of clusters.

dcrsResponseStatus :: Lens' DescribeClustersResponse Int

• - | The response status code.