WorkMail / Client / describe_entity

describe_entity

WorkMail.Client.describe_entity(**kwargs)

Returns basic details about an entity in WorkMail.

See also: AWS API Documentation

Request Syntax

response = client.describe_entity(
    OrganizationId='string',
    Email='string'
)

Parameters:

• OrganizationId (string) –

  [REQUIRED]

  The identifier for the organization under which the entity exists.

• Email (string) –

  [REQUIRED]

  The email under which the entity exists.

Return type:

dict

Returns:

Response Syntax

{
    'EntityId': 'string',
    'Name': 'string',
    'Type': 'GROUP'|'USER'|'RESOURCE'
}

Response Structure

• (dict) –

  • EntityId (string) –

    The entity ID under which the entity exists.

  • Name (string) –

    Username, GroupName, or ResourceName based on entity type.

  • Type (string) –

    Entity type.

Exceptions

• WorkMail.Client.exceptions.EntityNotFoundException

• WorkMail.Client.exceptions.InvalidParameterException

• WorkMail.Client.exceptions.OrganizationNotFoundException

• WorkMail.Client.exceptions.OrganizationStateException