libZSservicesZSamazonka-cloudhsmv2ZSamazonka-cloudhsmv2
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

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

Creating a Request

data DescribeClusters Source #

See: newDescribeClusters smart constructor.

Constructors

DescribeClusters' 

Fields

  • filters :: Maybe (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.

  • nextToken :: Maybe Text

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

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

Instances

Instances details
Eq DescribeClusters Source # 
Instance details

Defined in Amazonka.CloudHSMV2.DescribeClusters

Read DescribeClusters Source # 
Instance details

Defined in Amazonka.CloudHSMV2.DescribeClusters

Show DescribeClusters Source # 
Instance details

Defined in Amazonka.CloudHSMV2.DescribeClusters

Generic DescribeClusters Source # 
Instance details

Defined in Amazonka.CloudHSMV2.DescribeClusters

Associated Types

type Rep DescribeClusters :: Type -> Type #

NFData DescribeClusters Source # 
Instance details

Defined in Amazonka.CloudHSMV2.DescribeClusters

Methods

rnf :: DescribeClusters -> () #

Hashable DescribeClusters Source # 
Instance details

Defined in Amazonka.CloudHSMV2.DescribeClusters

ToJSON DescribeClusters Source # 
Instance details

Defined in Amazonka.CloudHSMV2.DescribeClusters

AWSPager DescribeClusters Source # 
Instance details

Defined in Amazonka.CloudHSMV2.DescribeClusters

AWSRequest DescribeClusters Source # 
Instance details

Defined in Amazonka.CloudHSMV2.DescribeClusters

Associated Types

type AWSResponse DescribeClusters #

ToHeaders DescribeClusters Source # 
Instance details

Defined in Amazonka.CloudHSMV2.DescribeClusters

ToPath DescribeClusters Source # 
Instance details

Defined in Amazonka.CloudHSMV2.DescribeClusters

ToQuery DescribeClusters Source # 
Instance details

Defined in Amazonka.CloudHSMV2.DescribeClusters

type Rep DescribeClusters Source # 
Instance details

Defined in Amazonka.CloudHSMV2.DescribeClusters

type Rep DescribeClusters = D1 ('MetaData "DescribeClusters" "Amazonka.CloudHSMV2.DescribeClusters" "libZSservicesZSamazonka-cloudhsmv2ZSamazonka-cloudhsmv2" 'False) (C1 ('MetaCons "DescribeClusters'" 'PrefixI 'True) (S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text [Text]))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))
type AWSResponse DescribeClusters Source # 
Instance details

Defined in Amazonka.CloudHSMV2.DescribeClusters

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:nextToken:DescribeClusters', describeClusters_nextToken - The NextToken value that you received in the previous response. Use this value to get more clusters.

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

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

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

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.

Destructuring the Response

data DescribeClustersResponse Source #

See: newDescribeClustersResponse smart constructor.

Constructors

DescribeClustersResponse' 

Fields

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

  • clusters :: Maybe [Cluster]

    A list of clusters.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq DescribeClustersResponse Source # 
Instance details

Defined in Amazonka.CloudHSMV2.DescribeClusters

Read DescribeClustersResponse Source # 
Instance details

Defined in Amazonka.CloudHSMV2.DescribeClusters

Show DescribeClustersResponse Source # 
Instance details

Defined in Amazonka.CloudHSMV2.DescribeClusters

Generic DescribeClustersResponse Source # 
Instance details

Defined in Amazonka.CloudHSMV2.DescribeClusters

Associated Types

type Rep DescribeClustersResponse :: Type -> Type #

NFData DescribeClustersResponse Source # 
Instance details

Defined in Amazonka.CloudHSMV2.DescribeClusters

type Rep DescribeClustersResponse Source # 
Instance details

Defined in Amazonka.CloudHSMV2.DescribeClusters

type Rep DescribeClustersResponse = D1 ('MetaData "DescribeClustersResponse" "Amazonka.CloudHSMV2.DescribeClusters" "libZSservicesZSamazonka-cloudhsmv2ZSamazonka-cloudhsmv2" 'False) (C1 ('MetaCons "DescribeClustersResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "clusters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Cluster])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

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:nextToken: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:clusters:DescribeClustersResponse', describeClustersResponse_clusters - A list of clusters.

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

Response Lenses

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.