amazonka-iam-1.6.0: Amazon Identity and Access Management SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.IAM.ListMFADevices

Contents

Description

Lists the MFA devices for an IAM user. If the request includes a IAM user name, then this operation lists all the MFA devices associated with the specified user. If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request for this API.

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

This operation returns paginated results.

Synopsis

Creating a Request

listMFADevices :: ListMFADevices Source #

Creates a value of ListMFADevices with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • lmdUserName - The name of the user whose MFA devices you want to list. This parameter allows (per 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: _+=,.@-
  • lmdMarker - 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.
  • lmdMaxItems - (Optional) 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, it 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.

data ListMFADevices Source #

See: listMFADevices smart constructor.

Instances

Eq ListMFADevices Source # 
Data ListMFADevices Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListMFADevices -> c ListMFADevices #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListMFADevices #

toConstr :: ListMFADevices -> Constr #

dataTypeOf :: ListMFADevices -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ListMFADevices) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListMFADevices) #

gmapT :: (forall b. Data b => b -> b) -> ListMFADevices -> ListMFADevices #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListMFADevices -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListMFADevices -> r #

gmapQ :: (forall d. Data d => d -> u) -> ListMFADevices -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListMFADevices -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListMFADevices -> m ListMFADevices #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListMFADevices -> m ListMFADevices #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListMFADevices -> m ListMFADevices #

Read ListMFADevices Source # 
Show ListMFADevices Source # 
Generic ListMFADevices Source # 

Associated Types

type Rep ListMFADevices :: * -> * #

Hashable ListMFADevices Source # 
NFData ListMFADevices Source # 

Methods

rnf :: ListMFADevices -> () #

AWSPager ListMFADevices Source # 
AWSRequest ListMFADevices Source # 
ToHeaders ListMFADevices Source # 
ToPath ListMFADevices Source # 
ToQuery ListMFADevices Source # 
type Rep ListMFADevices Source # 
type Rep ListMFADevices = D1 * (MetaData "ListMFADevices" "Network.AWS.IAM.ListMFADevices" "amazonka-iam-1.6.0-CI3f7XZIc4eD0Ehb04tNY7" False) (C1 * (MetaCons "ListMFADevices'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_lmdUserName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_lmdMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_lmdMaxItems") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat))))))
type Rs ListMFADevices Source # 

Request Lenses

lmdUserName :: Lens' ListMFADevices (Maybe Text) Source #

The name of the user whose MFA devices you want to list. This parameter allows (per 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: _+=,.@-

lmdMarker :: Lens' ListMFADevices (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.

lmdMaxItems :: Lens' ListMFADevices (Maybe Natural) Source #

(Optional) 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, it 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

listMFADevicesResponse Source #

Creates a value of ListMFADevicesResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • lmdrsMarker - When IsTruncated is true , this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
  • lmdrsIsTruncated - 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 of your results.
  • lmdrsResponseStatus - -- | The response status code.
  • lmdrsMFADevices - A list of MFA devices.

data ListMFADevicesResponse Source #

Contains the response to a successful ListMFADevices request.

See: listMFADevicesResponse smart constructor.

Instances

Eq ListMFADevicesResponse Source # 
Data ListMFADevicesResponse Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListMFADevicesResponse -> c ListMFADevicesResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListMFADevicesResponse #

toConstr :: ListMFADevicesResponse -> Constr #

dataTypeOf :: ListMFADevicesResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ListMFADevicesResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListMFADevicesResponse) #

gmapT :: (forall b. Data b => b -> b) -> ListMFADevicesResponse -> ListMFADevicesResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListMFADevicesResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListMFADevicesResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> ListMFADevicesResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListMFADevicesResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListMFADevicesResponse -> m ListMFADevicesResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListMFADevicesResponse -> m ListMFADevicesResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListMFADevicesResponse -> m ListMFADevicesResponse #

Read ListMFADevicesResponse Source # 
Show ListMFADevicesResponse Source # 
Generic ListMFADevicesResponse Source # 
NFData ListMFADevicesResponse Source # 

Methods

rnf :: ListMFADevicesResponse -> () #

type Rep ListMFADevicesResponse Source # 
type Rep ListMFADevicesResponse = D1 * (MetaData "ListMFADevicesResponse" "Network.AWS.IAM.ListMFADevices" "amazonka-iam-1.6.0-CI3f7XZIc4eD0Ehb04tNY7" False) (C1 * (MetaCons "ListMFADevicesResponse'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_lmdrsMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_lmdrsIsTruncated") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_lmdrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)) (S1 * (MetaSel (Just Symbol "_lmdrsMFADevices") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * [MFADevice])))))

Response Lenses

lmdrsMarker :: Lens' ListMFADevicesResponse (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.

lmdrsIsTruncated :: Lens' ListMFADevicesResponse (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 of your results.