Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeGroup

Important

End of support notice: On March 31, 2027, AWS will end support for Amazon WorkMail. After March 31, 2027, you will no longer be able to access the WorkMail console or WorkMail resources. For more information, see Amazon WorkMail end of support.

Returns the data available for the group.

Request Syntax


{
   "GroupId": "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.

GroupId

The identifier for the group to be described.

The identifier can accept GroupId, Groupname, or email. The following identity formats are available:

Group ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234
Email address: group@domain.tld
Group name: group

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [a-zA-Z0-9._%+@-]+

Required: Yes

OrganizationId

The identifier for the organization under which the group exists.

Type: String

Length Constraints: Fixed length of 34.

Pattern: ^m-[0-9a-f]{32}$

Required: Yes

Response Syntax


{
   "DisabledDate": number,
   "Email": "string",
   "EnabledDate": number,
   "GroupId": "string",
   "HiddenFromGlobalAddressList": boolean,
   "Name": "string",
   "State": "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.

DisabledDate

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

Type: Timestamp

Email

The email of the described group.

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,}

EnabledDate

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

Type: Timestamp

GroupId

The identifier of the described group.

Type: String

Length Constraints: Minimum length of 12. Maximum length of 256.

HiddenFromGlobalAddressList

If the value is set to true, the group is hidden from the address book.

Type: Boolean

Name

The name of the described group.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [\u0020-\u00FF]+

State

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

Type: String

Valid Values: ENABLED | DISABLED | DELETED

Errors

For information about the errors that are common to all actions, see Common Error Types.

EntityNotFoundException

Important

The identifier supplied for the user, group, or resource does not exist in your organization.

HTTP Status Code: 400

InvalidParameterException

Important

One or more of the input parameters don't match the service's restrictions.

HTTP Status Code: 400

OrganizationNotFoundException

Important

An operation received a valid organization identifier that either doesn't belong or exist in the system.

HTTP Status Code: 400

OrganizationStateException

Important

The organization must have a valid state to perform certain operations on the organization or its members.

HTTP Status Code: 400