personal_access_tokens

Creates, updates, deletes, gets or lists a personal_access_tokens resource.

Overview

Name	personal_access_tokens
Type	Resource
Id	aws.workmail.personal_access_tokens

Fields

The following fields are returned by SELECT queries:

list_personal_access_tokens

Name	Datatype	Description
date_created	string (date-time)	The date when the Personal Access Token was created.
date_last_used	string (date-time)	The date when the Personal Access Token was last used.
expires_time	string (date-time)	The date when the Personal Access Token will expire.
name	string	The name of the Personal Access Token. (pattern: <code>[^\x00-\x1F\x7F\x3C\x3E\x5C]+</code>)
personal_access_token_id	string	The ID of the Personal Access Token. (pattern: <code>[a-zA-Z0-9_-]+</code>)
scopes	array	Lists all the Personal Access Token permissions for a mailbox.
user_id	string	The user ID of the WorkMail user associated with the Personal Access Token.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_personal_access_tokens	select	region		Returns a summary of your Personal Access Tokens.
delete_personal_access_token	delete	region		Deletes the Personal Access Token from the provided WorkMail Organization.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

list_personal_access_tokens

Returns a summary of your Personal Access Tokens.

SELECT
date_created,
date_last_used,
expires_time,
name,
personal_access_token_id,
scopes,
user_id
FROM aws.workmail.personal_access_tokens
WHERE region = '{{ region }}' -- required
;

DELETE examples

delete_personal_access_token

Deletes the Personal Access Token from the provided WorkMail Organization.

DELETE FROM aws.workmail.personal_access_tokens
WHERE region = '{{ region }}' --required
;