list_mfa_devices ( $opt )

Lists the MFA devices. If the request includes the user name, then this action lists all the MFA devices associated with the specified user name. If you do not specify a user name, IAM determines the user name implicitly based on the AWS Access Key ID signing the request.

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

Access

public

Parameters

Parameter

Type

Required

Description

$opt

array

Optional

An associative array of parameters that can have the following keys:

  • UserName - string - Optional - Name of the user whose MFA devices you want to list. [Constraints: The value must be between 1 and 128 characters, and must match the following regular expression pattern: [\w+=,.@-]*]
  • Marker - string - Optional - Use this only when paginating results, and only in a subsequent request after you’ve received a response where the results are truncated. Set it to the value of the Marker element in the response you just received. [Constraints: The value must be between 1 and 320 characters, and must match the following regular expression pattern: [\u0020-\u00FF]*]
  • MaxItems - integer - Optional - Use this only when paginating results to indicate the maximum number of MFA devices you want in the response. If there are additional MFA devices beyond the maximum you specify, the IsTruncated response element is true.
  • curlopts - array - Optional - A set of values to pass directly into curl_setopt(), where the key is a pre-defined CURLOPT_* constant.
  • returnCurlHandle - boolean - Optional - A private toggle specifying that the cURL handle be returned rather than actually completing the request. This toggle is useful for manually managed batch requests.

Returns

Type

Description

CFResponse

A CFResponse object containing a parsed HTTP response.

Examples

Lists multi-factor authentication devices for a user.

Learn more about multi-factor authentication at aws.amazon.com/mfa.

// Instantiate the class
$iam = new AmazonIAM();

$response = $iam->list_mfa_devices('johndoe2');

// Success?
var_dump($response->isOK());
Result:
bool(true)

Changelog

Version

Description

1.4.3

The ListMFADevices operation introduced backwards-incompatible changes in this update. These changes were accounted for in this version of the SDK.

Related Methods

Source

Method defined in services/iam.class.php | Toggle source view (6 lines) | View on GitHub

public function list_mfa_devices($opt = null)
{
    if (!$opt) $opt = array();
            
    return $this->authenticate('ListMFADevices', $opt);
}

Copyright © 2010–2013 Amazon Web Services, LLC


Feedback