v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1480317256.9 KB

Returns the data available for the resource.

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

Headers

X-Amz-Target'WorkMailService.DescribeResource' required

Request body

OrganizationIdstring required

The identifier associated with the organization for which the resource is described.

ResourceIdstring required

The identifier of the resource to be described.

Response

Success

ResourceIdstring

The identifier of the described resource.

Emailstring

The email of the described resource.

Namestring

The name of the described resource.

Type'ROOM' | 'EQUIPMENT'

The type of the described resource.

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

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

EnabledDatestring date-time

The date and time when a resource was enabled for WorkMail, in UNIX epoch time format.

DisabledDatestring date-time

The date and time when a resource was disabled from WorkMail, in UNIX epoch time format.