amazonka-iam-2.0: Amazon Identity and Access Management SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.IAM.ListRoleTags

Description

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

Synopsis

Creating a Request

data ListRoleTags Source #

See: newListRoleTags smart constructor.

Constructors

ListRoleTags' 

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.

  • roleName :: Text

    The name of the IAM role for which you want to see the list of tags.

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

Instances

Instances details
ToHeaders ListRoleTags Source # 
Instance details

Defined in Amazonka.IAM.ListRoleTags

ToPath ListRoleTags Source # 
Instance details

Defined in Amazonka.IAM.ListRoleTags

ToQuery ListRoleTags Source # 
Instance details

Defined in Amazonka.IAM.ListRoleTags

AWSRequest ListRoleTags Source # 
Instance details

Defined in Amazonka.IAM.ListRoleTags

Associated Types

type AWSResponse ListRoleTags #

Generic ListRoleTags Source # 
Instance details

Defined in Amazonka.IAM.ListRoleTags

Associated Types

type Rep ListRoleTags :: Type -> Type #

Read ListRoleTags Source # 
Instance details

Defined in Amazonka.IAM.ListRoleTags

Show ListRoleTags Source # 
Instance details

Defined in Amazonka.IAM.ListRoleTags

NFData ListRoleTags Source # 
Instance details

Defined in Amazonka.IAM.ListRoleTags

Methods

rnf :: ListRoleTags -> () #

Eq ListRoleTags Source # 
Instance details

Defined in Amazonka.IAM.ListRoleTags

Hashable ListRoleTags Source # 
Instance details

Defined in Amazonka.IAM.ListRoleTags

type AWSResponse ListRoleTags Source # 
Instance details

Defined in Amazonka.IAM.ListRoleTags

type Rep ListRoleTags Source # 
Instance details

Defined in Amazonka.IAM.ListRoleTags

type Rep ListRoleTags = D1 ('MetaData "ListRoleTags" "Amazonka.IAM.ListRoleTags" "amazonka-iam-2.0-5DxkArXx9sD3CCYYGFyGET" 'False) (C1 ('MetaCons "ListRoleTags'" '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 "roleName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListRoleTags Source #

Create a value of ListRoleTags 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:

ListRoleTags, listRoleTags_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:ListRoleTags', listRoleTags_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.

ListRoleTags, listRoleTags_roleName - The name of the IAM role for which you want to see the list of tags.

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

Request Lenses

listRoleTags_marker :: Lens' ListRoleTags (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.

listRoleTags_maxItems :: Lens' ListRoleTags (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.

listRoleTags_roleName :: Lens' ListRoleTags Text Source #

The name of the IAM role for which you want to see the list of tags.

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

Destructuring the Response

data ListRoleTagsResponse Source #

See: newListRoleTagsResponse smart constructor.

Constructors

ListRoleTagsResponse' 

Fields

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

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

  • httpStatus :: Int

    The response's http status code.

  • tags :: [Tag]

    The list of tags that are currently attached to the role. 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
Generic ListRoleTagsResponse Source # 
Instance details

Defined in Amazonka.IAM.ListRoleTags

Associated Types

type Rep ListRoleTagsResponse :: Type -> Type #

Read ListRoleTagsResponse Source # 
Instance details

Defined in Amazonka.IAM.ListRoleTags

Show ListRoleTagsResponse Source # 
Instance details

Defined in Amazonka.IAM.ListRoleTags

NFData ListRoleTagsResponse Source # 
Instance details

Defined in Amazonka.IAM.ListRoleTags

Methods

rnf :: ListRoleTagsResponse -> () #

Eq ListRoleTagsResponse Source # 
Instance details

Defined in Amazonka.IAM.ListRoleTags

type Rep ListRoleTagsResponse Source # 
Instance details

Defined in Amazonka.IAM.ListRoleTags

type Rep ListRoleTagsResponse = D1 ('MetaData "ListRoleTagsResponse" "Amazonka.IAM.ListRoleTags" "amazonka-iam-2.0-5DxkArXx9sD3CCYYGFyGET" 'False) (C1 ('MetaCons "ListRoleTagsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "isTruncated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Tag]))))

newListRoleTagsResponse Source #

Create a value of ListRoleTagsResponse 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:

ListRoleTagsResponse, listRoleTagsResponse_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.

ListRoleTags, listRoleTagsResponse_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:httpStatus:ListRoleTagsResponse', listRoleTagsResponse_httpStatus - The response's http status code.

ListRoleTagsResponse, listRoleTagsResponse_tags - The list of tags that are currently attached to the role. 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

listRoleTagsResponse_isTruncated :: Lens' ListRoleTagsResponse (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.

listRoleTagsResponse_marker :: Lens' ListRoleTagsResponse (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.

listRoleTagsResponse_tags :: Lens' ListRoleTagsResponse [Tag] Source #

The list of tags that are currently attached to the role. 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.