GetAsyncInvoke
Retrieve information about an asynchronous invocation.
Request Syntax
GET /async-invoke/invocationArn HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- invocationArn
-
The invocation's ARN.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:async-invoke/[a-z0-9]{12}$Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"clientRequestToken": "string",
"endTime": "string",
"failureMessage": "string",
"invocationArn": "string",
"lastModifiedTime": "string",
"modelArn": "string",
"outputDataConfig": { ... },
"status": "string",
"submitTime": "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.
- clientRequestToken
-
The invocation's idempotency token.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
^[!-~]*$ - endTime
-
When the invocation ended.
Type: Timestamp
- failureMessage
-
An error message.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
- invocationArn
-
The invocation's ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:async-invoke/[a-z0-9]{12}$ - lastModifiedTime
-
The invocation's last modified time.
Type: Timestamp
- modelArn
-
The invocation's model ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
^arn:[a-z0-9\-]+:bedrock:[a-z0-9\-]*:[0-9]*:(provisioned-model|foundation-model)/.+$ - outputDataConfig
-
Output data settings.
Type: AsyncInvokeOutputDataConfig object
Note: This object is a Union. Only one member of this object can be specified or returned.
- status
-
The invocation's status.
Type: String
Valid Values:
InProgress | Completed | Failed - submitTime
-
When the invocation request was submitted.
Type: Timestamp
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
The request is denied because you do not have sufficient permissions to perform the requested action. For troubleshooting this error, see AccessDeniedException in the Amazon Bedrock User Guide
HTTP Status Code: 403
- InternalServerException
-
An internal server error occurred. For troubleshooting this error, see InternalFailure in the Amazon Bedrock User Guide
HTTP Status Code: 500
- ThrottlingException
-
Your request was denied due to exceeding the account quotas for Amazon Bedrock. For troubleshooting this error, see ThrottlingException in the Amazon Bedrock User Guide
HTTP Status Code: 429
- ValidationException
-
The input fails to satisfy the constraints specified by Amazon Bedrock. For troubleshooting this error, see ValidationError in the Amazon Bedrock User Guide
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
