Amazonka.CloudHSMV2.ListTags

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.

Creating a Request

data ListTags

See: newListTags smart constructor.

Constructors

ListTags'

Fields

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

• nextToken :: Maybe Text

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

• resourceId :: Text

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

Instances

ToJSON ListTags

Defined in Amazonka.CloudHSMV2.ListTags

Methods

toJSON :: ListTags -> Value

toEncoding :: ListTags -> Encoding

toJSONList :: [ListTags] -> Value

toEncodingList :: [ListTags] -> Encoding

ToHeaders ListTags

Defined in Amazonka.CloudHSMV2.ListTags

Methods

toHeaders :: ListTags -> [Header]

ToPath ListTags

Defined in Amazonka.CloudHSMV2.ListTags

Methods

toPath :: ListTags -> ByteString

ToQuery ListTags

Defined in Amazonka.CloudHSMV2.ListTags

Methods

toQuery :: ListTags -> QueryString

AWSPager ListTags

Defined in Amazonka.CloudHSMV2.ListTags

Methods

page :: ListTags -> AWSResponse ListTags -> Maybe ListTags

AWSRequest ListTags

Defined in Amazonka.CloudHSMV2.ListTags

Associated Types

type AWSResponse ListTags

Methods

request :: (Service -> Service) -> ListTags -> Request ListTags

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListTags -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListTags)))

Generic ListTags

Defined in Amazonka.CloudHSMV2.ListTags

Associated Types

type Rep ListTags :: Type -> Type

Methods

from :: ListTags -> Rep ListTags x

to :: Rep ListTags x -> ListTags

Read ListTags

Defined in Amazonka.CloudHSMV2.ListTags

Methods

readsPrec :: Int -> ReadS ListTags

readList :: ReadS [ListTags]

readPrec :: ReadPrec ListTags

readListPrec :: ReadPrec [ListTags]

Show ListTags

Defined in Amazonka.CloudHSMV2.ListTags

Methods

showsPrec :: Int -> ListTags -> ShowS

show :: ListTags -> String

showList :: [ListTags] -> ShowS

NFData ListTags

Defined in Amazonka.CloudHSMV2.ListTags

Methods

rnf :: ListTags -> ()

Eq ListTags

Defined in Amazonka.CloudHSMV2.ListTags

Methods

(==) :: ListTags -> ListTags -> Bool

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

Hashable ListTags

Defined in Amazonka.CloudHSMV2.ListTags

Methods

hashWithSalt :: Int -> ListTags -> Int

hash :: ListTags -> Int

type AWSResponse ListTags

Defined in Amazonka.CloudHSMV2.ListTags

type AWSResponse ListTags = ListTagsResponse

type Rep ListTags

Defined in Amazonka.CloudHSMV2.ListTags

type Rep ListTags = D1 ('MetaData "ListTags" "Amazonka.CloudHSMV2.ListTags" "amazonka-cloudhsmv2-2.0-JPONnjzt63Q1wP3HCntyXZ" 'False) (C1 ('MetaCons "ListTags'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "resourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListTags

Arguments

:: Text

$sel:resourceId:ListTags'

-> ListTags

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

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

$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_maxResults :: Lens' ListTags (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.

listTags_nextToken :: Lens' ListTags (Maybe Text)

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

listTags_resourceId :: Lens' ListTags Text

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

Destructuring the Response

data ListTagsResponse

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

Generic ListTagsResponse

Defined in Amazonka.CloudHSMV2.ListTags

Associated Types

type Rep ListTagsResponse :: Type -> Type

Methods

from :: ListTagsResponse -> Rep ListTagsResponse x

to :: Rep ListTagsResponse x -> ListTagsResponse

Read ListTagsResponse

Defined in Amazonka.CloudHSMV2.ListTags

Methods

readsPrec :: Int -> ReadS ListTagsResponse

readList :: ReadS [ListTagsResponse]

readPrec :: ReadPrec ListTagsResponse

readListPrec :: ReadPrec [ListTagsResponse]

Show ListTagsResponse

Defined in Amazonka.CloudHSMV2.ListTags

Methods

showsPrec :: Int -> ListTagsResponse -> ShowS

show :: ListTagsResponse -> String

showList :: [ListTagsResponse] -> ShowS

NFData ListTagsResponse

Defined in Amazonka.CloudHSMV2.ListTags

Methods

rnf :: ListTagsResponse -> ()

Eq ListTagsResponse

Defined in Amazonka.CloudHSMV2.ListTags

Methods

(==) :: ListTagsResponse -> ListTagsResponse -> Bool

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

type Rep ListTagsResponse

Defined in Amazonka.CloudHSMV2.ListTags

type Rep ListTagsResponse = D1 ('MetaData "ListTagsResponse" "Amazonka.CloudHSMV2.ListTags" "amazonka-cloudhsmv2-2.0-JPONnjzt63Q1wP3HCntyXZ" '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

Arguments

:: Int

$sel:httpStatus:ListTagsResponse'

-> ListTagsResponse

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:

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.

ListTagsResponse, listTagsResponse_tagList - A list of tags.

Response Lenses

listTagsResponse_nextToken :: Lens' ListTagsResponse (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.

listTagsResponse_httpStatus :: Lens' ListTagsResponse Int

The response's http status code.

listTagsResponse_tagList :: Lens' ListTagsResponse [Tag]

A list of tags.