delete_virtual_mfa_device ¶

delete_virtual_mfa_device(
    serial_number: serialNumberType,
    *,
    config_overrides: Optional[IAMClientConfig] = None,
) -> None

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.

Parameters:

serial_number (serialNumberType) –

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: =,.@:/-

Raises:

ConcurrentModificationException –

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

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

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 –

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

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

The service returned an error code this client does not model.

Examples:

To remove a virtual MFA device The following delete-virtual-mfa-device command removes the specified MFA device from the current AWS account.

>>> client.delete_virtual_mfa_device(serial_number='arn:aws:iam::123456789012:mfa/ExampleName')

Source code in docs_src/capo_iam/_services/iam.py

def delete_virtual_mfa_device(
    self,
    serial_number: "capo_iam.types.serial_number_type.serialNumberType",
    *,
    config_overrides: Optional[IAMClientConfig] = None,
) -> None:
    """<p>Deletes a virtual MFA device.</p> <note> <p> You must deactivate a user's virtual MFA device before you can delete it. For information about deactivating MFA devices, see <a href="https://docs.aws.amazon.com/IAM/latest/APIReference/API_DeactivateMFADevice.html">DeactivateMFADevice</a>. </p> </note>

    Args:
        serial_number: <p>The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the same as the ARN.</p> <p>This parameter allows (through its <a href="http://wikipedia.org/wiki/regex">regex pattern</a>) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@:/-</p>

    Raises:
        capo_iam.errors.concurrent_modification_exception.ConcurrentModificationException: <p>The request was rejected because multiple requests to change this object were submitted simultaneously. Wait a few minutes and submit your request again.</p>
        capo_iam.errors.delete_conflict_exception.DeleteConflictException: <p>The request was rejected because it attempted to delete a resource that has attached subordinate entities. The error message describes these entities.</p>
        capo_iam.errors.limit_exceeded_exception.LimitExceededException: <p>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.</p>
        capo_iam.errors.no_such_entity_exception.NoSuchEntityException: <p>The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.</p>
        capo_iam.errors.service_failure_exception.ServiceFailureException: <p>The request processing has failed because of an unknown error, exception or failure.</p>
        capo_iam.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To remove a virtual MFA device
        The following delete-virtual-mfa-device command removes the specified MFA device from the current AWS account.

        >>> client.delete_virtual_mfa_device(serial_number='arn:aws:iam::123456789012:mfa/ExampleName')
    """

    def _handler(
        req: "OperationRequest[capo_iam.types.delete_virtual_mfa_device_request.DeleteVirtualMFADeviceRequest]",
    ) -> OperationResponse[None]:
        import capo_iam._operations.aws_identity_management_v20100508.delete_virtual_mfa_device

        output, http_response = (
            capo_iam._operations.aws_identity_management_v20100508.delete_virtual_mfa_device.delete_virtual_mfa_device(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteVirtualMFADevice")
    )
    input_: capo_iam.types.delete_virtual_mfa_device_request.DeleteVirtualMFADeviceRequest = {
        "serial_number": serial_number
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output