DeleteImpersonationRoleCommand

Suggest an Edit

Deletes an impersonation role for the given WorkMail organization.

Example Syntax

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

import { WorkMailClient, DeleteImpersonationRoleCommand } from "@aws-sdk/client-workmail"; // ES Modules import
// const { WorkMailClient, DeleteImpersonationRoleCommand } = require("@aws-sdk/client-workmail"); // CommonJS import
const client = new WorkMailClient(config);
const input = { // DeleteImpersonationRoleRequest
  OrganizationId: "STRING_VALUE", // required
  ImpersonationRoleId: "STRING_VALUE", // required
};
const command = new DeleteImpersonationRoleCommand(input);
const response = await client.send(command);
// {};

DeleteImpersonationRoleCommand Input

See DeleteImpersonationRoleCommandInput for more details

Parameter
Type
Description
ImpersonationRoleId
Required
string | undefined

The ID of the impersonation role to delete.

OrganizationId
Required
string | undefined

The WorkMail organization from which to delete the impersonation role.

DeleteImpersonationRoleCommand Output

See DeleteImpersonationRoleCommandOutput for details

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

Throws

Name
Fault
Details
InvalidParameterException
client

One or more of the input parameters don't match the service's restrictions.

OrganizationNotFoundException
client

An operation received a valid organization identifier that either doesn't belong or exist in the system.

OrganizationStateException
client

The organization must have a valid state to perform certain operations on the organization or its members.

WorkMailServiceException
Base exception class for all service exceptions from WorkMail service.