| 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.CloudHSMV2.DescribeClusters
Description
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.
This operation returns paginated results.
Synopsis
- data DescribeClusters = DescribeClusters' {}
- newDescribeClusters :: DescribeClusters
- describeClusters_filters :: Lens' DescribeClusters (Maybe (HashMap Text [Text]))
- describeClusters_maxResults :: Lens' DescribeClusters (Maybe Natural)
- describeClusters_nextToken :: Lens' DescribeClusters (Maybe Text)
- data DescribeClustersResponse = DescribeClustersResponse' {}
- 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
| |
Instances
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:filters:DescribeClusters', describeClusters_filters - 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.
$sel:maxResults:DescribeClusters', describeClusters_maxResults - 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.
DescribeClusters, describeClusters_nextToken - The NextToken value that you received in the previous response. Use
this value to get more clusters.
Request Lenses
describeClusters_filters :: Lens' DescribeClusters (Maybe (HashMap Text [Text])) Source #
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.
describeClusters_maxResults :: Lens' DescribeClusters (Maybe Natural) Source #
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.
describeClusters_nextToken :: Lens' DescribeClusters (Maybe Text) Source #
The NextToken value that you received in the previous response. Use
this value to get more clusters.
Destructuring the Response
data DescribeClustersResponse Source #
See: newDescribeClustersResponse smart constructor.
Constructors
| DescribeClustersResponse' | |
Instances
newDescribeClustersResponse Source #
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 - A list of clusters.
DescribeClusters, describeClustersResponse_nextToken - 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.
$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 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.
describeClustersResponse_httpStatus :: Lens' DescribeClustersResponse Int Source #
The response's http status code.