resource_oauth2_tokens
Creates, updates, deletes, gets or lists a resource_oauth2_tokens resource.
Overview
| Name | resource_oauth2_tokens |
| Type | Resource |
| Id | aws.bedrock_agentcore.resource_oauth2_tokens |
Fields
The following fields are returned by SELECT queries:
- get_resource_oauth2_token
| Name | Datatype | Description |
|---|---|---|
access_token | string | The OAuth 2.0 access token to use. |
authorization_url | string | The URL to initiate the authorization process, provided when the access token requires user authorization. |
session_status | string | Status indicating whether the user's authorization session is in progress or has failed. This helps determine the next steps in the OAuth2 authentication flow. (IN_PROGRESS, FAILED) |
session_uri | string | Unique identifier for the user's authorization session for retrieving OAuth2 tokens. This matches the sessionId from the request and can be used to track the session state. (pattern: <code>urn:ietf:params:oauth:request_uri:[a-zA-Z0-9-._~]+</code>) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_resource_oauth2_token | select | region | Returns the OAuth 2.0 token of the provided resource. |
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
- get_resource_oauth2_token
Returns the OAuth 2.0 token of the provided resource.
SELECT
access_token,
authorization_url,
session_status,
session_uri
FROM aws.bedrock_agentcore.resource_oauth2_tokens
WHERE region = '{{ region }}' -- required
;