v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1480317256.9 KB

Returns the data available for the group.

post/#X-Amz-Target=WorkMailService.DescribeGroup

Headers

X-Amz-Target'WorkMailService.DescribeGroup' required

Request body

OrganizationIdstring required

The identifier for the organization under which the group exists.

GroupIdstring required

The identifier for the group to be described.

Response

Success

GroupIdstring

The identifier of the described group.

Namestring

The name of the described group.

Emailstring

The email of the described group.

State'ENABLED' | 'DISABLED' | 'DELETED'

The state of the user: enabled (registered to WorkMail) or disabled (deregistered or never registered to WorkMail).

EnabledDatestring date-time

The date and time when a user was registered to WorkMail, in UNIX epoch time format.

DisabledDatestring date-time

The date and time when a user was deregistered from WorkMail, in UNIX epoch time format.