DescribeEntity
Returns basic details about an entity in WorkMail.
Request Syntax
{
"Email": "string",
"OrganizationId": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
-
The email under which the entity exists.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 254.
Pattern:
[a-zA-Z0-9._%+-]{1,64}@[a-zA-Z0-9.-]+\.[a-zA-Z-]{2,}Required: Yes
- OrganizationId
-
The identifier for the organization under which the entity exists.
Type: String
Length Constraints: Fixed length of 34.
Pattern:
^m-[0-9a-f]{32}$Required: Yes
Response Syntax
{
"EntityId": "string",
"Name": "string",
"Type": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- EntityId
-
The entity ID under which the entity exists.
Type: String
Length Constraints: Minimum length of 12. Maximum length of 256.
- Name
-
Username, GroupName, or ResourceName based on entity type.
Type: String
Length Constraints: Maximum length of 256.
- Type
-
Entity type.
Type: String
Valid Values:
GROUP | USER | RESOURCE
Errors
For information about the errors that are common to all actions, see Common Errors.
- EntityNotFoundException
-
The identifier supplied for the user, group, or resource does not exist in your organization.
HTTP Status Code: 400
- InvalidParameterException
-
One or more of the input parameters don't match the service's restrictions.
HTTP Status Code: 400
- OrganizationNotFoundException
-
An operation received a valid organization identifier that either doesn't belong or exist in the system.
HTTP Status Code: 400
- OrganizationStateException
-
The organization must have a valid state to perform certain operations on the organization or its members.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
