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

Description

Lists the tags that are attached to the specified IAM customer managed policy. 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 ListPolicyTags Source #

See: newListPolicyTags smart constructor.

Constructors

ListPolicyTags' 

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.

  • policyArn :: Text

    The ARN of the IAM customer managed policy 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 ListPolicyTags Source # 
Instance details

Defined in Amazonka.IAM.ListPolicyTags

Read ListPolicyTags Source # 
Instance details

Defined in Amazonka.IAM.ListPolicyTags

Show ListPolicyTags Source # 
Instance details

Defined in Amazonka.IAM.ListPolicyTags

Generic ListPolicyTags Source # 
Instance details

Defined in Amazonka.IAM.ListPolicyTags

Associated Types

type Rep ListPolicyTags :: Type -> Type #

NFData ListPolicyTags Source # 
Instance details

Defined in Amazonka.IAM.ListPolicyTags

Methods

rnf :: ListPolicyTags -> () #

Hashable ListPolicyTags Source # 
Instance details

Defined in Amazonka.IAM.ListPolicyTags

AWSRequest ListPolicyTags Source # 
Instance details

Defined in Amazonka.IAM.ListPolicyTags

Associated Types

type AWSResponse ListPolicyTags #

ToHeaders ListPolicyTags Source # 
Instance details

Defined in Amazonka.IAM.ListPolicyTags

ToPath ListPolicyTags Source # 
Instance details

Defined in Amazonka.IAM.ListPolicyTags

ToQuery ListPolicyTags Source # 
Instance details

Defined in Amazonka.IAM.ListPolicyTags

type Rep ListPolicyTags Source # 
Instance details

Defined in Amazonka.IAM.ListPolicyTags

type Rep ListPolicyTags = D1 ('MetaData "ListPolicyTags" "Amazonka.IAM.ListPolicyTags" "libZSservicesZSamazonka-iamZSamazonka-iam" 'False) (C1 ('MetaCons "ListPolicyTags'" '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 "policyArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse ListPolicyTags Source # 
Instance details

Defined in Amazonka.IAM.ListPolicyTags

newListPolicyTags Source #

Create a value of ListPolicyTags 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:ListPolicyTags', listPolicyTags_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:ListPolicyTags', listPolicyTags_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:policyArn:ListPolicyTags', listPolicyTags_policyArn - The ARN of the IAM customer managed policy 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

listPolicyTags_marker :: Lens' ListPolicyTags (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.

listPolicyTags_maxItems :: Lens' ListPolicyTags (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.

listPolicyTags_policyArn :: Lens' ListPolicyTags Text Source #

The ARN of the IAM customer managed policy 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 ListPolicyTagsResponse Source #

See: newListPolicyTagsResponse smart constructor.

Constructors

ListPolicyTagsResponse' 

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 IAM customer managed policy. 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 ListPolicyTagsResponse Source # 
Instance details

Defined in Amazonka.IAM.ListPolicyTags

Read ListPolicyTagsResponse Source # 
Instance details

Defined in Amazonka.IAM.ListPolicyTags

Show ListPolicyTagsResponse Source # 
Instance details

Defined in Amazonka.IAM.ListPolicyTags

Generic ListPolicyTagsResponse Source # 
Instance details

Defined in Amazonka.IAM.ListPolicyTags

Associated Types

type Rep ListPolicyTagsResponse :: Type -> Type #

NFData ListPolicyTagsResponse Source # 
Instance details

Defined in Amazonka.IAM.ListPolicyTags

Methods

rnf :: ListPolicyTagsResponse -> () #

type Rep ListPolicyTagsResponse Source # 
Instance details

Defined in Amazonka.IAM.ListPolicyTags

type Rep ListPolicyTagsResponse = D1 ('MetaData "ListPolicyTagsResponse" "Amazonka.IAM.ListPolicyTags" "libZSservicesZSamazonka-iamZSamazonka-iam" 'False) (C1 ('MetaCons "ListPolicyTagsResponse'" '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]))))

newListPolicyTagsResponse Source #

Create a value of ListPolicyTagsResponse 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:ListPolicyTags', listPolicyTagsResponse_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:ListPolicyTagsResponse', listPolicyTagsResponse_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:ListPolicyTagsResponse', listPolicyTagsResponse_httpStatus - The response's http status code.

$sel:tags:ListPolicyTagsResponse', listPolicyTagsResponse_tags - The list of tags that are currently attached to the IAM customer managed policy. 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

listPolicyTagsResponse_marker :: Lens' ListPolicyTagsResponse (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.

listPolicyTagsResponse_isTruncated :: Lens' ListPolicyTagsResponse (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.

listPolicyTagsResponse_tags :: Lens' ListPolicyTagsResponse [Tag] Source #

The list of tags that are currently attached to the IAM customer managed policy. 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.