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

Description

Lists the tags that are attached to the specified IAM virtual multi-factor authentication (MFA) device. 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 ListMFADeviceTags Source #

See: newListMFADeviceTags smart constructor.

Constructors

ListMFADeviceTags' 

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.

  • serialNumber :: Text

    The unique identifier for the IAM virtual MFA device whose tags you want to see. For virtual MFA devices, the serial number is the same as the ARN.

    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 ListMFADeviceTags Source # 
Instance details

Defined in Amazonka.IAM.ListMFADeviceTags

ToPath ListMFADeviceTags Source # 
Instance details

Defined in Amazonka.IAM.ListMFADeviceTags

ToQuery ListMFADeviceTags Source # 
Instance details

Defined in Amazonka.IAM.ListMFADeviceTags

AWSRequest ListMFADeviceTags Source # 
Instance details

Defined in Amazonka.IAM.ListMFADeviceTags

Associated Types

type AWSResponse ListMFADeviceTags #

Generic ListMFADeviceTags Source # 
Instance details

Defined in Amazonka.IAM.ListMFADeviceTags

Associated Types

type Rep ListMFADeviceTags :: Type -> Type #

Read ListMFADeviceTags Source # 
Instance details

Defined in Amazonka.IAM.ListMFADeviceTags

Show ListMFADeviceTags Source # 
Instance details

Defined in Amazonka.IAM.ListMFADeviceTags

NFData ListMFADeviceTags Source # 
Instance details

Defined in Amazonka.IAM.ListMFADeviceTags

Methods

rnf :: ListMFADeviceTags -> () #

Eq ListMFADeviceTags Source # 
Instance details

Defined in Amazonka.IAM.ListMFADeviceTags

Hashable ListMFADeviceTags Source # 
Instance details

Defined in Amazonka.IAM.ListMFADeviceTags

type AWSResponse ListMFADeviceTags Source # 
Instance details

Defined in Amazonka.IAM.ListMFADeviceTags

type Rep ListMFADeviceTags Source # 
Instance details

Defined in Amazonka.IAM.ListMFADeviceTags

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

newListMFADeviceTags Source #

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

ListMFADeviceTags, listMFADeviceTags_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:ListMFADeviceTags', listMFADeviceTags_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.

ListMFADeviceTags, listMFADeviceTags_serialNumber - The unique identifier for the IAM virtual MFA device whose tags you want to see. For virtual MFA devices, the serial number is the same as the ARN.

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

listMFADeviceTags_marker :: Lens' ListMFADeviceTags (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.

listMFADeviceTags_maxItems :: Lens' ListMFADeviceTags (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.

listMFADeviceTags_serialNumber :: Lens' ListMFADeviceTags Text Source #

The unique identifier for the IAM virtual MFA device whose tags you want to see. For virtual MFA devices, the serial number is the same as the ARN.

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 ListMFADeviceTagsResponse Source #

See: newListMFADeviceTagsResponse smart constructor.

Constructors

ListMFADeviceTagsResponse' 

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 virtual MFA device. 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 ListMFADeviceTagsResponse Source # 
Instance details

Defined in Amazonka.IAM.ListMFADeviceTags

Associated Types

type Rep ListMFADeviceTagsResponse :: Type -> Type #

Read ListMFADeviceTagsResponse Source # 
Instance details

Defined in Amazonka.IAM.ListMFADeviceTags

Show ListMFADeviceTagsResponse Source # 
Instance details

Defined in Amazonka.IAM.ListMFADeviceTags

NFData ListMFADeviceTagsResponse Source # 
Instance details

Defined in Amazonka.IAM.ListMFADeviceTags

Eq ListMFADeviceTagsResponse Source # 
Instance details

Defined in Amazonka.IAM.ListMFADeviceTags

type Rep ListMFADeviceTagsResponse Source # 
Instance details

Defined in Amazonka.IAM.ListMFADeviceTags

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

newListMFADeviceTagsResponse Source #

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

ListMFADeviceTagsResponse, listMFADeviceTagsResponse_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.

ListMFADeviceTags, listMFADeviceTagsResponse_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:ListMFADeviceTagsResponse', listMFADeviceTagsResponse_httpStatus - The response's http status code.

ListMFADeviceTagsResponse, listMFADeviceTagsResponse_tags - The list of tags that are currently attached to the virtual MFA device. 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

listMFADeviceTagsResponse_isTruncated :: Lens' ListMFADeviceTagsResponse (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.

listMFADeviceTagsResponse_marker :: Lens' ListMFADeviceTagsResponse (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.

listMFADeviceTagsResponse_tags :: Lens' ListMFADeviceTagsResponse [Tag] Source #

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