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

Description

Lists the tags that are attached to the specified Security Assertion Markup Language (SAML) identity provider. The returned list of tags is sorted by tag key. For more information, see About SAML 2.0-based federation.

For more information about tagging, see Tagging IAM resources in the IAM User Guide.

Synopsis

Creating a Request

data ListSAMLProviderTags Source #

See: newListSAMLProviderTags smart constructor.

Constructors

ListSAMLProviderTags' 

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.

  • sAMLProviderArn :: Text

    The ARN of the Security Assertion Markup Language (SAML) identity provider 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
ToHeaders ListSAMLProviderTags Source # 
Instance details

Defined in Amazonka.IAM.ListSAMLProviderTags

ToPath ListSAMLProviderTags Source # 
Instance details

Defined in Amazonka.IAM.ListSAMLProviderTags

ToQuery ListSAMLProviderTags Source # 
Instance details

Defined in Amazonka.IAM.ListSAMLProviderTags

AWSRequest ListSAMLProviderTags Source # 
Instance details

Defined in Amazonka.IAM.ListSAMLProviderTags

Associated Types

type AWSResponse ListSAMLProviderTags #

Generic ListSAMLProviderTags Source # 
Instance details

Defined in Amazonka.IAM.ListSAMLProviderTags

Associated Types

type Rep ListSAMLProviderTags :: Type -> Type #

Read ListSAMLProviderTags Source # 
Instance details

Defined in Amazonka.IAM.ListSAMLProviderTags

Show ListSAMLProviderTags Source # 
Instance details

Defined in Amazonka.IAM.ListSAMLProviderTags

NFData ListSAMLProviderTags Source # 
Instance details

Defined in Amazonka.IAM.ListSAMLProviderTags

Methods

rnf :: ListSAMLProviderTags -> () #

Eq ListSAMLProviderTags Source # 
Instance details

Defined in Amazonka.IAM.ListSAMLProviderTags

Hashable ListSAMLProviderTags Source # 
Instance details

Defined in Amazonka.IAM.ListSAMLProviderTags

type AWSResponse ListSAMLProviderTags Source # 
Instance details

Defined in Amazonka.IAM.ListSAMLProviderTags

type Rep ListSAMLProviderTags Source # 
Instance details

Defined in Amazonka.IAM.ListSAMLProviderTags

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

newListSAMLProviderTags Source #

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

ListSAMLProviderTags, listSAMLProviderTags_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:ListSAMLProviderTags', listSAMLProviderTags_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:sAMLProviderArn:ListSAMLProviderTags', listSAMLProviderTags_sAMLProviderArn - The ARN of the Security Assertion Markup Language (SAML) identity provider 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

listSAMLProviderTags_marker :: Lens' ListSAMLProviderTags (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.

listSAMLProviderTags_maxItems :: Lens' ListSAMLProviderTags (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.

listSAMLProviderTags_sAMLProviderArn :: Lens' ListSAMLProviderTags Text Source #

The ARN of the Security Assertion Markup Language (SAML) identity provider 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 ListSAMLProviderTagsResponse Source #

See: newListSAMLProviderTagsResponse smart constructor.

Constructors

ListSAMLProviderTagsResponse' 

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 Security Assertion Markup Language (SAML) identity provider. 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 ListSAMLProviderTagsResponse Source # 
Instance details

Defined in Amazonka.IAM.ListSAMLProviderTags

Associated Types

type Rep ListSAMLProviderTagsResponse :: Type -> Type #

Read ListSAMLProviderTagsResponse Source # 
Instance details

Defined in Amazonka.IAM.ListSAMLProviderTags

Show ListSAMLProviderTagsResponse Source # 
Instance details

Defined in Amazonka.IAM.ListSAMLProviderTags

NFData ListSAMLProviderTagsResponse Source # 
Instance details

Defined in Amazonka.IAM.ListSAMLProviderTags

Eq ListSAMLProviderTagsResponse Source # 
Instance details

Defined in Amazonka.IAM.ListSAMLProviderTags

type Rep ListSAMLProviderTagsResponse Source # 
Instance details

Defined in Amazonka.IAM.ListSAMLProviderTags

type Rep ListSAMLProviderTagsResponse = D1 ('MetaData "ListSAMLProviderTagsResponse" "Amazonka.IAM.ListSAMLProviderTags" "amazonka-iam-2.0-5DxkArXx9sD3CCYYGFyGET" 'False) (C1 ('MetaCons "ListSAMLProviderTagsResponse'" '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]))))

newListSAMLProviderTagsResponse Source #

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

ListSAMLProviderTagsResponse, listSAMLProviderTagsResponse_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.

ListSAMLProviderTags, listSAMLProviderTagsResponse_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:ListSAMLProviderTagsResponse', listSAMLProviderTagsResponse_httpStatus - The response's http status code.

ListSAMLProviderTagsResponse, listSAMLProviderTagsResponse_tags - The list of tags that are currently attached to the Security Assertion Markup Language (SAML) identity provider. 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

listSAMLProviderTagsResponse_isTruncated :: Lens' ListSAMLProviderTagsResponse (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.

listSAMLProviderTagsResponse_marker :: Lens' ListSAMLProviderTagsResponse (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.

listSAMLProviderTagsResponse_tags :: Lens' ListSAMLProviderTagsResponse [Tag] Source #

The list of tags that are currently attached to the Security Assertion Markup Language (SAML) identity provider. 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.