Skip to main content

resource_oauth2_tokens

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

Overview

Nameresource_oauth2_tokens
TypeResource
Idaws.bedrock_agentcore.resource_oauth2_tokens

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
access_tokenstringThe OAuth 2.0 access token to use.
authorization_urlstringThe URL to initiate the authorization process, provided when the access token requires user authorization.
session_statusstringStatus 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_uristringUnique 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:

NameAccessible byRequired ParamsOptional ParamsDescription
get_resource_oauth2_tokenselectregionReturns 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.

NameDatatypeDescription
regionstringAWS region (default: us-east-1)

SELECT examples

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
;