libZSservicesZSamazonka-iamZSamazonka-iam
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.IAM.ListUserTags

Description

Lists the tags that are attached to the specified IAM user. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

This operation returns paginated results.

Synopsis

Creating a Request

data ListUserTags Source #

See: newListUserTags smart constructor.

Constructors

ListUserTags' 

Fields

  • marker :: Maybe Text

    Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

  • maxItems :: Maybe Natural

    Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

    If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

  • userName :: Text

    The name of the IAM user whose tags you want to see.

    This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

Instances

Instances details
Eq ListUserTags Source # 
Instance details

Defined in Amazonka.IAM.ListUserTags

Read ListUserTags Source # 
Instance details

Defined in Amazonka.IAM.ListUserTags

Show ListUserTags Source # 
Instance details

Defined in Amazonka.IAM.ListUserTags

Generic ListUserTags Source # 
Instance details

Defined in Amazonka.IAM.ListUserTags

Associated Types

type Rep ListUserTags :: Type -> Type #

NFData ListUserTags Source # 
Instance details

Defined in Amazonka.IAM.ListUserTags

Methods

rnf :: ListUserTags -> () #

Hashable ListUserTags Source # 
Instance details

Defined in Amazonka.IAM.ListUserTags

AWSPager ListUserTags Source # 
Instance details

Defined in Amazonka.IAM.ListUserTags

AWSRequest ListUserTags Source # 
Instance details

Defined in Amazonka.IAM.ListUserTags

Associated Types

type AWSResponse ListUserTags #

ToHeaders ListUserTags Source # 
Instance details

Defined in Amazonka.IAM.ListUserTags

ToPath ListUserTags Source # 
Instance details

Defined in Amazonka.IAM.ListUserTags

ToQuery ListUserTags Source # 
Instance details

Defined in Amazonka.IAM.ListUserTags

type Rep ListUserTags Source # 
Instance details

Defined in Amazonka.IAM.ListUserTags

type Rep ListUserTags = D1 ('MetaData "ListUserTags" "Amazonka.IAM.ListUserTags" "libZSservicesZSamazonka-iamZSamazonka-iam" 'False) (C1 ('MetaCons "ListUserTags'" 'PrefixI 'True) (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "maxItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "userName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse ListUserTags Source # 
Instance details

Defined in Amazonka.IAM.ListUserTags

newListUserTags Source #

Create a value of ListUserTags 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:marker:ListUserTags', listUserTags_marker - Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

$sel:maxItems:ListUserTags', listUserTags_maxItems - Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

$sel:userName:ListUserTags', listUserTags_userName - The name of the IAM user whose tags you want to see.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

Request Lenses

listUserTags_marker :: Lens' ListUserTags (Maybe Text) Source #

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

listUserTags_maxItems :: Lens' ListUserTags (Maybe Natural) Source #

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

listUserTags_userName :: Lens' ListUserTags Text Source #

The name of the IAM user whose tags you want to see.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

Destructuring the Response

data ListUserTagsResponse Source #

See: newListUserTagsResponse smart constructor.

Constructors

ListUserTagsResponse' 

Fields

  • marker :: Maybe Text

    When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

  • isTruncated :: Maybe Bool

    A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

  • httpStatus :: Int

    The response's http status code.

  • tags :: [Tag]

    The list of tags that are currently attached to the user. Each tag consists of a key name and an associated value. If no tags are attached to the specified resource, the response contains an empty list.

Instances

Instances details
Eq ListUserTagsResponse Source # 
Instance details

Defined in Amazonka.IAM.ListUserTags

Read ListUserTagsResponse Source # 
Instance details

Defined in Amazonka.IAM.ListUserTags

Show ListUserTagsResponse Source # 
Instance details

Defined in Amazonka.IAM.ListUserTags

Generic ListUserTagsResponse Source # 
Instance details

Defined in Amazonka.IAM.ListUserTags

Associated Types

type Rep ListUserTagsResponse :: Type -> Type #

NFData ListUserTagsResponse Source # 
Instance details

Defined in Amazonka.IAM.ListUserTags

Methods

rnf :: ListUserTagsResponse -> () #

type Rep ListUserTagsResponse Source # 
Instance details

Defined in Amazonka.IAM.ListUserTags

type Rep ListUserTagsResponse = D1 ('MetaData "ListUserTagsResponse" "Amazonka.IAM.ListUserTags" "libZSservicesZSamazonka-iamZSamazonka-iam" 'False) (C1 ('MetaCons "ListUserTagsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "isTruncated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Tag]))))

newListUserTagsResponse Source #

Create a value of ListUserTagsResponse 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:marker:ListUserTags', listUserTagsResponse_marker - When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

$sel:isTruncated:ListUserTagsResponse', listUserTagsResponse_isTruncated - A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

$sel:httpStatus:ListUserTagsResponse', listUserTagsResponse_httpStatus - The response's http status code.

$sel:tags:ListUserTagsResponse', listUserTagsResponse_tags - The list of tags that are currently attached to the user. Each tag consists of a key name and an associated value. If no tags are attached to the specified resource, the response contains an empty list.

Response Lenses

listUserTagsResponse_marker :: Lens' ListUserTagsResponse (Maybe Text) Source #

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

listUserTagsResponse_isTruncated :: Lens' ListUserTagsResponse (Maybe Bool) Source #

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

listUserTagsResponse_tags :: Lens' ListUserTagsResponse [Tag] Source #

The list of tags that are currently attached to the user. Each tag consists of a key name and an associated value. If no tags are attached to the specified resource, the response contains an empty list.