GetPersonalAccessTokenMetadata
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.
Requests details of a specific Personal Access Token within the WorkMail organization.
Request Syntax
{
"OrganizationId": "string",
"PersonalAccessTokenId": "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.
- OrganizationId
-
The Organization ID.
Type: String
Length Constraints: Fixed length of 34.
Pattern:
^m-[0-9a-f]{32}$Required: Yes
- PersonalAccessTokenId
-
The Personal Access Token ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[a-zA-Z0-9_-]+Required: Yes
Response Syntax
{
"DateCreated": number,
"DateLastUsed": number,
"ExpiresTime": number,
"Name": "string",
"PersonalAccessTokenId": "string",
"Scopes": [ "string" ],
"UserId": "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 Personal Access Token ID was created.
Type: Timestamp
- DateLastUsed
-
The date when the Personal Access Token ID was last used.
Type: Timestamp
- ExpiresTime
-
The time when the Personal Access Token ID will expire.
Type: Timestamp
- Name
-
The Personal Access Token name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[^\x00-\x1F\x7F\x3C\x3E\x5C]+ - PersonalAccessTokenId
-
The Personal Access Token ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[a-zA-Z0-9_-]+ - Scopes
-
Lists all the Personal Access Token permissions for a mailbox.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[^\x00-\x1F\x7F\x3C\x3E\x5C]+ - UserId
-
The WorkMail User ID.
Type: String
Length Constraints: Minimum length of 12. Maximum length of 256.
Errors
For information about the errors that are common to all actions, see Common Error Types.
- InvalidParameterException
-
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.
One or more of the input parameters don't match the service's restrictions.
HTTP Status Code: 400
- OrganizationNotFoundException
-
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.
An operation received a valid organization identifier that either doesn't belong or exist in the system.
HTTP Status Code: 400
- OrganizationStateException
-
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.
The organization must have a valid state to perform certain operations on the organization or its members.
HTTP Status Code: 400
- ResourceNotFoundException
-
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.
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:
