Amazon Bedrock Bedrock Async Invoke API

The Bedrock Async Invoke API from Amazon Bedrock — 2 operation(s) for bedrock async invoke.

Operations 3

GET /async-invoke/{invocationArn} Get Async Invoke #
GET /async-invoke List Async Invokes #
POST /async-invoke Start Async Invoke #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-bedrock:amazon-bedrock-async-invoke-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

amazon-bedrock-async-invoke-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Amazon Bedrock Async Invoke API
  version: '2023-04-20'
  description: Generated from AWS's published Smithy model for Amazon Bedrock. 3 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://bedrock-runtime.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Async Invoke
paths:
  /async-invoke/{invocationArn}:
    get:
      operationId: GetAsyncInvoke
      summary: Get Async Invoke
      description: Retrieve information about an asynchronous invocation.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAsyncInvokeResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetAsyncInvokeRequest'
      tags:
      - Async Invoke
  /async-invoke:
    get:
      operationId: ListAsyncInvokes
      summary: List Async Invokes
      description: Lists asynchronous invocations.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListAsyncInvokesResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListAsyncInvokesRequest'
      tags:
      - Async Invoke
    post:
      operationId: StartAsyncInvoke
      summary: Start Async Invoke
      description: Starts an asynchronous invocation. This operation requires permission for the bedrock:InvokeModel action. To deny all inference access to resources that you specify in the modelId field, you need to deny access to the bedrock:InvokeModel and bedrock:InvokeModelWithResponseStream actions. Doing this also denies access to the resource through the Converse API actions (Converse and ConverseStream). For more information see Deny access for inference on specific models.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StartAsyncInvokeResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '400':
          description: ConflictException; ServiceQuotaExceededException; ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '503':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StartAsyncInvokeRequest'
      tags:
      - Async Invoke
components:
  schemas:
    StartAsyncInvokeResponse:
      type: object
      properties:
        invocationArn:
          type: string
          description: The ARN of the invocation.
      required:
      - invocationArn
    AsyncInvokeOutputDataConfig:
      type: object
      properties:
        s3OutputDataConfig:
          $ref: '#/components/schemas/AsyncInvokeS3OutputDataConfig'
      description: Exactly one member is set.
    ValidationException:
      type: object
      properties:
        message:
          type: string
    ListAsyncInvokesResponse:
      type: object
      properties:
        nextToken:
          type: string
          description: Specify the pagination token from a previous request to retrieve the next page of results.
        asyncInvokeSummaries:
          type: array
          items:
            $ref: '#/components/schemas/AsyncInvokeSummary'
          description: A list of invocation summaries.
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
    GetAsyncInvokeRequest:
      type: object
      properties:
        invocationArn:
          type: string
          description: The invocation's ARN.
      required:
      - invocationArn
    AsyncInvokeSummary:
      type: object
      properties:
        invocationArn:
          type: string
          description: The invocation's ARN.
        modelArn:
          type: string
          description: The invoked model's ARN.
        clientRequestToken:
          type: string
          description: The invocation's idempotency token.
        status:
          type: string
          enum:
          - InProgress
          - Completed
          - Failed
          description: The invocation's status.
        failureMessage:
          type: string
          description: An error message.
        submitTime:
          type: string
          format: date-time
          description: When the invocation was submitted.
        lastModifiedTime:
          type: string
          format: date-time
          description: When the invocation was last modified.
        endTime:
          type: string
          format: date-time
          description: When the invocation ended.
        outputDataConfig:
          $ref: '#/components/schemas/AsyncInvokeOutputDataConfig'
      required:
      - invocationArn
      - modelArn
      - submitTime
      - outputDataConfig
    ConflictException:
      type: object
      properties:
        message:
          type: string
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
    InternalServerException:
      type: object
      properties:
        message:
          type: string
    BedrockRuntimeTag:
      type: object
      properties:
        key:
          type: string
          description: The tag's key.
        value:
          type: string
          description: The tag's value.
      required:
      - key
      - value
    StartAsyncInvokeRequest:
      type: object
      properties:
        clientRequestToken:
          type: string
          description: Specify idempotency token to ensure that requests are not duplicated.
        modelId:
          type: string
          description: The model to invoke.
        modelInput:
          type: object
          description: Input to send to the model.
        outputDataConfig:
          $ref: '#/components/schemas/AsyncInvokeOutputDataConfig'
        tags:
          type: array
          items:
            $ref: '#/components/schemas/BedrockRuntimeTag'
          description: Tags to apply to the invocation.
      required:
      - modelId
      - modelInput
      - outputDataConfig
    ListAsyncInvokesRequest:
      type: object
      properties:
        submitTimeAfter:
          type: string
          format: date-time
          description: Include invocations submitted after this time.
        submitTimeBefore:
          type: string
          format: date-time
          description: Include invocations submitted before this time.
        statusEquals:
          type: string
          enum:
          - InProgress
          - Completed
          - Failed
          description: Filter invocations by status.
        maxResults:
          type: integer
          description: The maximum number of invocations to return in one page of results.
        nextToken:
          type: string
          description: Specify the pagination token from a previous request to retrieve the next page of results.
        sortBy:
          type: string
          enum:
          - SubmissionTime
          description: How to sort the response.
        sortOrder:
          type: string
          enum:
          - Ascending
          - Descending
          description: The sorting order for the response.
    AsyncInvokeS3OutputDataConfig:
      type: object
      properties:
        s3Uri:
          type: string
          description: An object URI starting with s3://.
        kmsKeyId:
          type: string
          description: A KMS encryption key ID.
        bucketOwner:
          type: string
          description: If the bucket belongs to another AWS account, specify that account's ID.
      required:
      - s3Uri
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
    ServiceUnavailableException:
      type: object
      properties:
        message:
          type: string
    GetAsyncInvokeResponse:
      type: object
      properties:
        invocationArn:
          type: string
          description: The invocation's ARN.
        modelArn:
          type: string
          description: The invocation's model ARN.
        clientRequestToken:
          type: string
          description: The invocation's idempotency token.
        status:
          type: string
          enum:
          - InProgress
          - Completed
          - Failed
          description: The invocation's status.
        failureMessage:
          type: string
          description: An error message.
        submitTime:
          type: string
          format: date-time
          description: When the invocation request was submitted.
        lastModifiedTime:
          type: string
          format: date-time
          description: The invocation's last modified time.
        endTime:
          type: string
          format: date-time
          description: When the invocation ended.
        outputDataConfig:
          $ref: '#/components/schemas/AsyncInvokeOutputDataConfig'
      required:
      - invocationArn
      - modelArn
      - status
      - submitTime
      - outputDataConfig
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: bedrock
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/bedrock-runtime/service/2023-09-30/bedrock-runtime-2023-09-30.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)