async_invokes

Creates, updates, deletes, gets or lists an async_invokes resource.

Overview

Name	async_invokes
Type	Resource
Id	aws.bedrock_runtime.async_invokes

Fields

The following fields are returned by SELECT queries:

get_async_invoke

Name	Datatype	Description
client_request_token	string	The invocation's idempotency token. (pattern: <code>[!-~]*</code>)
end_time	string (date-time)	When the invocation ended.
failure_message	string	An error message.
invocation_arn	string	The invocation's ARN. (pattern: <code>arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:async-invoke/[a-z0-9]{12}</code>)
last_modified_time	string (date-time)	The invocation's last modified time.
model_arn	string	The invocation's model ARN. (pattern: <code>arn:[a-z0-9-]+:bedrock:[a-z0-9-]:[0-9]:(provisioned-model|foundation-model)/.+</code>)
output_data_config	object	Output data settings.
status	string	The invocation's status. (InProgress, Completed, Failed)
submit_time	string (date-time)	When the invocation request was submitted.

list_async_invokes

Name	Datatype	Description
client_request_token	string	The invocation's idempotency token. (pattern: <code>[!-~]*</code>)
end_time	string (date-time)	When the invocation ended.
failure_message	string	An error message.
invocation_arn	string	The invocation's ARN. (pattern: <code>arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:async-invoke/[a-z0-9]{12}</code>)
last_modified_time	string (date-time)	When the invocation was last modified.
model_arn	string	The invoked model's ARN. (pattern: <code>arn:[a-z0-9-]+:bedrock:[a-z0-9-]:[0-9]:(provisioned-model|foundation-model)/.+</code>)
output_data_config	object	The invocation's output data settings.
status	string	The invocation's status. (InProgress, Completed, Failed)
submit_time	string (date-time)	When the invocation was submitted.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_async_invoke	select	invocation_arn, region		Retrieve information about an asynchronous invocation.
list_async_invokes	select	region	submitTimeAfter, submitTimeBefore, statusEquals, maxResults, nextToken, sortBy, sortOrder	Lists asynchronous invocations.

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
invocation_arn	string	The invocation's ARN.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of invocations to return in one page of results.
nextToken	string	Specify the pagination token from a previous request to retrieve the next page of results.
sortBy	string	How to sort the response.
sortOrder	string	The sorting order for the response.
statusEquals	string	Filter invocations by status.
submitTimeAfter	string (date-time)	Include invocations submitted after this time.
submitTimeBefore	string (date-time)	Include invocations submitted before this time.

SELECT examples

get_async_invoke

Retrieve information about an asynchronous invocation.

SELECT
client_request_token,
end_time,
failure_message,
invocation_arn,
last_modified_time,
model_arn,
output_data_config,
status,
submit_time
FROM aws.bedrock_runtime.async_invokes
WHERE invocation_arn = '{{ invocation_arn }}' -- required
AND region = '{{ region }}' -- required
;

list_async_invokes

Lists asynchronous invocations.

SELECT
client_request_token,
end_time,
failure_message,
invocation_arn,
last_modified_time,
model_arn,
output_data_config,
status,
submit_time
FROM aws.bedrock_runtime.async_invokes
WHERE region = '{{ region }}' -- required
AND submitTimeAfter = '{{ submitTimeAfter }}'
AND submitTimeBefore = '{{ submitTimeBefore }}'
AND statusEquals = '{{ statusEquals }}'
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
AND sortBy = '{{ sortBy }}'
AND sortOrder = '{{ sortOrder }}'
;