Class CreateVirtualMFADeviceCommandProtected

Creates a new virtual MFA device for the Amazon Web Services 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, see Using a virtual MFA device in the IAM User Guide.

For information about the maximum number of MFA devices you can create, see IAM and STS quotas in the IAM User Guide.

The seed information contained in the QR code and the Base32 string should be treated like any other secret access information. In other words, protect the seed information as you would your Amazon Web Services access keys or your passwords. After you provision your virtual device, you should ensure that the information is destroyed following secure procedures.

Example

Use a bare-bones client and the command you need to make an API call.

import { IAMClient, CreateVirtualMFADeviceCommand } from "@aws-sdk/client-iam"; // ES Modules import
// const { IAMClient, CreateVirtualMFADeviceCommand } = require("@aws-sdk/client-iam"); // CommonJS import
const client = new IAMClient(config);
const input = { // CreateVirtualMFADeviceRequest
  Path: "STRING_VALUE",
  VirtualMFADeviceName: "STRING_VALUE", // required
  Tags: [ // tagListType
    { // Tag
      Key: "STRING_VALUE", // required
      Value: "STRING_VALUE", // required
    },
  ],
};
const command = new CreateVirtualMFADeviceCommand(input);
const response = await client.send(command);
// { // CreateVirtualMFADeviceResponse
//   VirtualMFADevice: { // VirtualMFADevice
//     SerialNumber: "STRING_VALUE", // required
//     Base32StringSeed: "BLOB_VALUE",
//     QRCodePNG: "BLOB_VALUE",
//     User: { // User
//       Path: "STRING_VALUE", // required
//       UserName: "STRING_VALUE", // required
//       UserId: "STRING_VALUE", // required
//       Arn: "STRING_VALUE", // required
//       CreateDate: new Date("TIMESTAMP"), // required
//       PasswordLastUsed: new Date("TIMESTAMP"),
//       PermissionsBoundary: { // AttachedPermissionsBoundary
//         PermissionsBoundaryType: "PermissionsBoundaryPolicy",
//         PermissionsBoundaryArn: "STRING_VALUE",
//       },
//       Tags: [ // tagListType
//         { // Tag
//           Key: "STRING_VALUE", // required
//           Value: "STRING_VALUE", // required
//         },
//       ],
//     },
//     EnableDate: new Date("TIMESTAMP"),
//     Tags: [
//       {
//         Key: "STRING_VALUE", // required
//         Value: "STRING_VALUE", // required
//       },
//     ],
//   },
// };

Param

CreateVirtualMFADeviceCommandInput

Returns

CreateVirtualMFADeviceCommandOutput

See

• CreateVirtualMFADeviceCommandInput for command's input shape.
• CreateVirtualMFADeviceCommandOutput for command's response shape.
• config for IAMClient's config shape.

Throws

ConcurrentModificationException (client fault)

The request was rejected because multiple requests to change this object were submitted simultaneously. Wait a few minutes and submit your request again.

Throws

EntityAlreadyExistsException (client fault)

The request was rejected because it attempted to create a resource that already exists.

Throws

InvalidInputException (client fault)

The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

Throws

LimitExceededException (client fault)

The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.

Throws

ServiceFailureException (server fault)

The request processing has failed because of an unknown error, exception or failure.

Throws

IAMServiceException

Base exception class for all service exceptions from IAM service.