| « PreviousNext » | |
  | Did this page help you? Yes | No | Tell us about it... |
CreateVirtualMFADevice
Description
Creates a new virtual MFA device for the AWS account. After creating the virtual MFA, use EnableMFADevice to attach the MFA device to an IAM user. For more information about creating and working with virtual MFA devices, go to Using a Virtual MFA Device in Using AWS Identity and Access Management.
For information about limits on the number of MFA devices you can create, see Limitations on Entities in Using AWS Identity and Access Management.
Important
The seed information contained in the QR code and the Base32 string should be treated like any other secret access information, such as your AWS access keys or your passwords. After you provision your virtual device, you should ensure that the information is destroyed following secure procedures.
Request Parameters
For information about the common parameters that all actions use, see Common Parameters.
- Path
The path for the virtual MFA device. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access Management.
This parameter is optional. If it is not included, it defaults to a slash (/).
Type: String
Length constraints: Minimum length of 1. Maximum length of 512.
Required: No
- VirtualMFADeviceName
The name of the virtual MFA device. Use with path to uniquely identify a virtual MFA device.
Type: String
Length constraints: Minimum length of 1.
Required: Yes
Response Elements
The following
element is
returned in a CreateVirtualMFADeviceResult structure.
- VirtualMFADevice
A newly created virtual MFA device.
Type: VirtualMFADevice
Errors
For information about the errors that are common to all actions, see Common Errors.
- EntityAlreadyExists
The request was rejected because it attempted to create a resource that already exists.
HTTP Status Code: 409
- LimitExceeded
The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.
HTTP Status Code: 409
Examples
Sample Request
https://iam.amazonaws.com/ ?Action=CreateVirtualMFADevice &VirtualMFADeviceName=ExampleName &Path=/ &Version=2010-05-08 &AUTHPARAMS
Sample Response
<CreateVirtualMFADeviceResponse>
<CreateVirtualMFADeviceResult>
<VirtualMFADevice>
<SerialNumber>arn:aws:iam::123456789012:mfa/ExampleName</SerialNumber>
<Base32StringSeed>2K5K5XTLA7GGE75TQLYEXAMPLEEXAMPLEEXAMPLECHDFW4KJYZ6
UFQ75LL7COCYKM</Base32StringSeed>
<QRCodePNG>89504E470D0A1A0AASDFAHSDFKJKLJFKALSDFJASDF</QRCodePNG> <!-- byte array of png file -->
</VirtualMFADevice>
</CreateVirtualMFADeviceResult>
<ResponseMetadata>
<RequestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</RequestId>
</ResponseMetadata>
</CreateVirtualMFADeviceResponse>
