AssumeImpersonationRoleCommand

Suggest an Edit

Assumes an impersonation role for the given WorkMail organization. This method returns an authentication token you can use to make impersonated calls.

Example Syntax

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

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

AssumeImpersonationRoleCommand Input

See AssumeImpersonationRoleCommandInput for more details

Parameter
Type
Description
ImpersonationRoleId
Required
string | undefined

The impersonation role ID to assume.

OrganizationId
Required
string | undefined

The WorkMail organization under which the impersonation role will be assumed.

AssumeImpersonationRoleCommand Output

See AssumeImpersonationRoleCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
ExpiresIn
number | undefined

The authentication token's validity, in seconds.

Token
string | undefined

The authentication token for the impersonation role.

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.

ResourceNotFoundException
client

The resource cannot be found.

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