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

Description

Lists the virtual MFA devices defined in the Amazon Web Services account by assignment status. If you do not specify an assignment status, the operation returns a list of all virtual MFA devices. Assignment status can be Assigned, Unassigned, or Any.

IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view tag information for a virtual MFA device, see ListMFADeviceTags.

You can paginate the results using the MaxItems and Marker parameters.

This operation returns paginated results.

Synopsis

Creating a Request

data ListVirtualMFADevices Source #

See: newListVirtualMFADevices smart constructor.

Constructors

ListVirtualMFADevices' 

Fields

  • assignmentStatus :: Maybe AssignmentStatusType

    The status (Unassigned or Assigned) of the devices to list. If you do not specify an AssignmentStatus, the operation defaults to Any, which lists both assigned and unassigned virtual MFA devices.,

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

Instances

Instances details
ToHeaders ListVirtualMFADevices Source # 
Instance details

Defined in Amazonka.IAM.ListVirtualMFADevices

ToPath ListVirtualMFADevices Source # 
Instance details

Defined in Amazonka.IAM.ListVirtualMFADevices

ToQuery ListVirtualMFADevices Source # 
Instance details

Defined in Amazonka.IAM.ListVirtualMFADevices

AWSPager ListVirtualMFADevices Source # 
Instance details

Defined in Amazonka.IAM.ListVirtualMFADevices

AWSRequest ListVirtualMFADevices Source # 
Instance details

Defined in Amazonka.IAM.ListVirtualMFADevices

Associated Types

type AWSResponse ListVirtualMFADevices #

Generic ListVirtualMFADevices Source # 
Instance details

Defined in Amazonka.IAM.ListVirtualMFADevices

Associated Types

type Rep ListVirtualMFADevices :: Type -> Type #

Read ListVirtualMFADevices Source # 
Instance details

Defined in Amazonka.IAM.ListVirtualMFADevices

Show ListVirtualMFADevices Source # 
Instance details

Defined in Amazonka.IAM.ListVirtualMFADevices

NFData ListVirtualMFADevices Source # 
Instance details

Defined in Amazonka.IAM.ListVirtualMFADevices

Methods

rnf :: ListVirtualMFADevices -> () #

Eq ListVirtualMFADevices Source # 
Instance details

Defined in Amazonka.IAM.ListVirtualMFADevices

Hashable ListVirtualMFADevices Source # 
Instance details

Defined in Amazonka.IAM.ListVirtualMFADevices

type AWSResponse ListVirtualMFADevices Source # 
Instance details

Defined in Amazonka.IAM.ListVirtualMFADevices

type Rep ListVirtualMFADevices Source # 
Instance details

Defined in Amazonka.IAM.ListVirtualMFADevices

type Rep ListVirtualMFADevices = D1 ('MetaData "ListVirtualMFADevices" "Amazonka.IAM.ListVirtualMFADevices" "amazonka-iam-2.0-5DxkArXx9sD3CCYYGFyGET" 'False) (C1 ('MetaCons "ListVirtualMFADevices'" 'PrefixI 'True) (S1 ('MetaSel ('Just "assignmentStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AssignmentStatusType)) :*: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))

newListVirtualMFADevices :: ListVirtualMFADevices Source #

Create a value of ListVirtualMFADevices 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:assignmentStatus:ListVirtualMFADevices', listVirtualMFADevices_assignmentStatus - The status (Unassigned or Assigned) of the devices to list. If you do not specify an AssignmentStatus, the operation defaults to Any, which lists both assigned and unassigned virtual MFA devices.,

ListVirtualMFADevices, listVirtualMFADevices_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:ListVirtualMFADevices', listVirtualMFADevices_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.

Request Lenses

listVirtualMFADevices_assignmentStatus :: Lens' ListVirtualMFADevices (Maybe AssignmentStatusType) Source #

The status (Unassigned or Assigned) of the devices to list. If you do not specify an AssignmentStatus, the operation defaults to Any, which lists both assigned and unassigned virtual MFA devices.,

listVirtualMFADevices_marker :: Lens' ListVirtualMFADevices (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.

listVirtualMFADevices_maxItems :: Lens' ListVirtualMFADevices (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.

Destructuring the Response

data ListVirtualMFADevicesResponse Source #

Contains the response to a successful ListVirtualMFADevices request.

See: newListVirtualMFADevicesResponse smart constructor.

Constructors

ListVirtualMFADevicesResponse' 

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.

  • virtualMFADevices :: [VirtualMFADevice]

    The list of virtual MFA devices in the current account that match the AssignmentStatus value that was passed in the request.

Instances

Instances details
Generic ListVirtualMFADevicesResponse Source # 
Instance details

Defined in Amazonka.IAM.ListVirtualMFADevices

Associated Types

type Rep ListVirtualMFADevicesResponse :: Type -> Type #

Show ListVirtualMFADevicesResponse Source # 
Instance details

Defined in Amazonka.IAM.ListVirtualMFADevices

NFData ListVirtualMFADevicesResponse Source # 
Instance details

Defined in Amazonka.IAM.ListVirtualMFADevices

Eq ListVirtualMFADevicesResponse Source # 
Instance details

Defined in Amazonka.IAM.ListVirtualMFADevices

type Rep ListVirtualMFADevicesResponse Source # 
Instance details

Defined in Amazonka.IAM.ListVirtualMFADevices

type Rep ListVirtualMFADevicesResponse = D1 ('MetaData "ListVirtualMFADevicesResponse" "Amazonka.IAM.ListVirtualMFADevices" "amazonka-iam-2.0-5DxkArXx9sD3CCYYGFyGET" 'False) (C1 ('MetaCons "ListVirtualMFADevicesResponse'" '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 "virtualMFADevices") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [VirtualMFADevice]))))

newListVirtualMFADevicesResponse Source #

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

ListVirtualMFADevicesResponse, listVirtualMFADevicesResponse_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.

ListVirtualMFADevices, listVirtualMFADevicesResponse_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:ListVirtualMFADevicesResponse', listVirtualMFADevicesResponse_httpStatus - The response's http status code.

$sel:virtualMFADevices:ListVirtualMFADevicesResponse', listVirtualMFADevicesResponse_virtualMFADevices - The list of virtual MFA devices in the current account that match the AssignmentStatus value that was passed in the request.

Response Lenses

listVirtualMFADevicesResponse_isTruncated :: Lens' ListVirtualMFADevicesResponse (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.

listVirtualMFADevicesResponse_marker :: Lens' ListVirtualMFADevicesResponse (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.

listVirtualMFADevicesResponse_virtualMFADevices :: Lens' ListVirtualMFADevicesResponse [VirtualMFADevice] Source #

The list of virtual MFA devices in the current account that match the AssignmentStatus value that was passed in the request.