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

Description

Gets a list of tags for the specified AWS CloudHSM cluster.

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

This operation returns paginated results.

Synopsis

Creating a Request

data ListTags Source #

See: newListTags smart constructor.

Constructors

ListTags' 

Fields

  • nextToken :: Maybe Text

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

  • maxResults :: Maybe Natural

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

  • resourceId :: Text

    The cluster identifier (ID) for the cluster whose tags you are getting. To find the cluster ID, use DescribeClusters.

Instances

Instances details
Eq ListTags Source # 
Instance details

Defined in Amazonka.CloudHSMV2.ListTags

Read ListTags Source # 
Instance details

Defined in Amazonka.CloudHSMV2.ListTags

Show ListTags Source # 
Instance details

Defined in Amazonka.CloudHSMV2.ListTags

Generic ListTags Source # 
Instance details

Defined in Amazonka.CloudHSMV2.ListTags

Associated Types

type Rep ListTags :: Type -> Type #

Methods

from :: ListTags -> Rep ListTags x #

to :: Rep ListTags x -> ListTags #

NFData ListTags Source # 
Instance details

Defined in Amazonka.CloudHSMV2.ListTags

Methods

rnf :: ListTags -> () #

Hashable ListTags Source # 
Instance details

Defined in Amazonka.CloudHSMV2.ListTags

Methods

hashWithSalt :: Int -> ListTags -> Int #

hash :: ListTags -> Int #

ToJSON ListTags Source # 
Instance details

Defined in Amazonka.CloudHSMV2.ListTags

AWSPager ListTags Source # 
Instance details

Defined in Amazonka.CloudHSMV2.ListTags

AWSRequest ListTags Source # 
Instance details

Defined in Amazonka.CloudHSMV2.ListTags

Associated Types

type AWSResponse ListTags #

ToHeaders ListTags Source # 
Instance details

Defined in Amazonka.CloudHSMV2.ListTags

Methods

toHeaders :: ListTags -> [Header] #

ToPath ListTags Source # 
Instance details

Defined in Amazonka.CloudHSMV2.ListTags

ToQuery ListTags Source # 
Instance details

Defined in Amazonka.CloudHSMV2.ListTags

type Rep ListTags Source # 
Instance details

Defined in Amazonka.CloudHSMV2.ListTags

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

Defined in Amazonka.CloudHSMV2.ListTags

newListTags Source #

Create a value of ListTags 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:ListTags', listTags_nextToken - The NextToken value that you received in the previous response. Use this value to get more tags.

$sel:maxResults:ListTags', listTags_maxResults - The maximum number of tags to return in the response. When there are more tags than the number you specify, the response contains a NextToken value.

$sel:resourceId:ListTags', listTags_resourceId - The cluster identifier (ID) for the cluster whose tags you are getting. To find the cluster ID, use DescribeClusters.

Request Lenses

listTags_nextToken :: Lens' ListTags (Maybe Text) Source #

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

listTags_maxResults :: Lens' ListTags (Maybe Natural) Source #

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

listTags_resourceId :: Lens' ListTags Text Source #

The cluster identifier (ID) for the cluster whose tags you are getting. To find the cluster ID, use DescribeClusters.

Destructuring the Response

data ListTagsResponse Source #

See: newListTagsResponse smart constructor.

Constructors

ListTagsResponse' 

Fields

  • nextToken :: Maybe Text

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

  • httpStatus :: Int

    The response's http status code.

  • tagList :: [Tag]

    A list of tags.

Instances

Instances details
Eq ListTagsResponse Source # 
Instance details

Defined in Amazonka.CloudHSMV2.ListTags

Read ListTagsResponse Source # 
Instance details

Defined in Amazonka.CloudHSMV2.ListTags

Show ListTagsResponse Source # 
Instance details

Defined in Amazonka.CloudHSMV2.ListTags

Generic ListTagsResponse Source # 
Instance details

Defined in Amazonka.CloudHSMV2.ListTags

Associated Types

type Rep ListTagsResponse :: Type -> Type #

NFData ListTagsResponse Source # 
Instance details

Defined in Amazonka.CloudHSMV2.ListTags

Methods

rnf :: ListTagsResponse -> () #

type Rep ListTagsResponse Source # 
Instance details

Defined in Amazonka.CloudHSMV2.ListTags

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

newListTagsResponse Source #

Create a value of ListTagsResponse 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:ListTags', listTagsResponse_nextToken - An opaque string that indicates that the response contains only a subset of tags. Use this value in a subsequent ListTags request to get more tags.

$sel:httpStatus:ListTagsResponse', listTagsResponse_httpStatus - The response's http status code.

$sel:tagList:ListTagsResponse', listTagsResponse_tagList - A list of tags.

Response Lenses

listTagsResponse_nextToken :: Lens' ListTagsResponse (Maybe Text) Source #

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

listTagsResponse_httpStatus :: Lens' ListTagsResponse Int Source #

The response's http status code.