DeleteVirtualMFADeviceCommand

Suggest an Edit

Deletes a virtual MFA device.

You must deactivate a user's virtual MFA device before you can delete it. For information about deactivating MFA devices, see DeactivateMFADevice.

Example Syntax

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

import { IAMClient, DeleteVirtualMFADeviceCommand } from "@aws-sdk/client-iam"; // ES Modules import
// const { IAMClient, DeleteVirtualMFADeviceCommand } = require("@aws-sdk/client-iam"); // CommonJS import
const client = new IAMClient(config);
const input = { // DeleteVirtualMFADeviceRequest
  SerialNumber: "STRING_VALUE", // required
};
const command = new DeleteVirtualMFADeviceCommand(input);
const response = await client.send(command);
// {};

Example Usage

 Loading code editorLoading code editor

DeleteVirtualMFADeviceCommand Input

See DeleteVirtualMFADeviceCommandInput for more details

Parameter
Type
Description
SerialNumber
Required
string | undefined

The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the same as the ARN.

This parameter allows (through 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: =,.:/-

DeleteVirtualMFADeviceCommand Output

See DeleteVirtualMFADeviceCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

Name
Fault
Details
ConcurrentModificationException
client

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

DeleteConflictException
client

The request was rejected because it attempted to delete a resource that has attached subordinate entities. The error message describes these entities.

LimitExceededException
client

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.

NoSuchEntityException
client

The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.

ServiceFailureException
server

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

IAMServiceException
Base exception class for all service exceptions from IAM service.