GetImpersonationRole
Gets the impersonation role details for the given WorkMail organization.
Request Syntax
{
"ImpersonationRoleId": "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.
- ImpersonationRoleId
-
The impersonation role ID to retrieve.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[a-zA-Z0-9_-]+Required: Yes
- OrganizationId
-
The WorkMail organization from which to retrieve the impersonation role.
Type: String
Length Constraints: Fixed length of 34.
Pattern:
^m-[0-9a-f]{32}$Required: Yes
Response Syntax
{
"DateCreated": number,
"DateModified": number,
"Description": "string",
"ImpersonationRoleId": "string",
"Name": "string",
"Rules": [
{
"Description": "string",
"Effect": "string",
"ImpersonationRuleId": "string",
"Name": "string",
"NotTargetUsers": [ "string" ],
"TargetUsers": [ "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.
- DateCreated
-
The date when the impersonation role was created.
Type: Timestamp
- DateModified
-
The date when the impersonation role was last modified.
Type: Timestamp
- Description
-
The impersonation role description.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[^\x00-\x09\x0B\x0C\x0E-\x1F\x7F\x3C\x3E\x5C]+ - ImpersonationRoleId
-
The impersonation role ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[a-zA-Z0-9_-]+ - Name
-
The impersonation role name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[^\x00-\x1F\x7F\x3C\x3E\x5C]+ - Rules
-
The list of rules for the given impersonation role.
Type: Array of ImpersonationRule objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
- Type
-
The impersonation role type.
Type: String
Valid Values:
FULL_ACCESS | READ_ONLY
Errors
For information about the errors that are common to all actions, see Common Errors.
- 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
- ResourceNotFoundException
-
The resource cannot be found.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
