Amazon Bedrock Bedrock Executions API

The Bedrock Executions API from Amazon Bedrock — 3 operation(s) for bedrock executions.

GitHub OpenAPI

Operations 3

GET /flows/{flowIdentifier}/aliases/{flowAliasIdentifier}/executions/{executionIdentifier} Get Flow Execution #
GET /flows/{flowIdentifier}/executions List Flow Executions #
POST /flows/{flowIdentifier}/aliases/{flowAliasIdentifier}/executions Start Flow Execution #

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-executions-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-executions-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon Bedrock Executions 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-agent-runtime.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /flows/{flowIdentifier}/aliases/{flowAliasIdentifier}/executions/{executionIdentifier}:
    get:
      operationId: GetFlowExecution
      summary: Get Flow Execution
      description: Retrieves details about a specific flow execution, including its status, start and end times, and any errors
        that occurred during execution.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetFlowExecutionResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BedrockAgentRuntimeInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '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/GetFlowExecutionRequest'
      tags:
      - Executions
  /flows/{flowIdentifier}/executions:
    get:
      operationId: ListFlowExecutions
      summary: List Flow Executions
      description: Lists all executions of a flow. Results can be paginated and include summary information about each execution,
        such as status, start and end times, and the execution's Amazon Resource Name (ARN). Flow executions is in preview
        release for Amazon Bedrock and is subject to change.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListFlowExecutionsResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BedrockAgentRuntimeInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '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/ListFlowExecutionsRequest'
      tags:
      - Executions
  /flows/{flowIdentifier}/aliases/{flowAliasIdentifier}/executions:
    post:
      operationId: StartFlowExecution
      summary: Start Flow Execution
      description: Starts an execution of an Amazon Bedrock flow. Unlike flows that run until completion or time out after
        five minutes, flow executions let you run flows asynchronously for longer durations. Flow executions also yield control
        so that your application can perform other tasks. This operation returns an Amazon Resource Name (ARN) that you can
        use to track and manage your flow execution. Flow executions is in preview release for Amazon Bedrock and is subject
        to change.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StartFlowExecutionResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '502':
          description: BadGatewayException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadGatewayException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '424':
          description: DependencyFailedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DependencyFailedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BedrockAgentRuntimeInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '400':
          description: ServiceQuotaExceededException; ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StartFlowExecutionRequest'
      tags:
      - Executions
components:
  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
  schemas:
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
    BadGatewayException:
      type: object
      properties:
        message:
          type: string
        resourceName:
          type: string
          description: The name of the dependency that caused the issue, such as Amazon Bedrock, Lambda, or STS.
    BedrockAgentRuntimeInternalServerException:
      type: object
      properties:
        message:
          type: string
        reason:
          type: string
          description: The reason for the exception. If the reason is BEDROCK_MODEL_INVOCATION_SERVICE_UNAVAILABLE, the model
            invocation service is unavailable. Retry your request.
    BedrockAgentRuntimePerformanceConfiguration:
      type: object
      properties:
        latency:
          type: string
          enum:
          - standard
          - optimized
          description: To use a latency-optimized version of the model, set to optimized.
    ConflictException:
      type: object
      properties:
        message:
          type: string
    DependencyFailedException:
      type: object
      properties:
        message:
          type: string
        resourceName:
          type: string
          description: The name of the dependency that caused the issue, such as Amazon Bedrock, Lambda, or STS.
    FlowExecutionError:
      type: object
      properties:
        nodeName:
          type: string
          description: The name of the node in the flow where the error occurred (if applicable).
        error:
          type: string
          enum:
          - ExecutionTimedOut
          description: The error code for the type of error that occurred.
        message:
          type: string
          description: A descriptive message that provides details about the error.
    FlowExecutionSummary:
      type: object
      properties:
        executionArn:
          type: string
          description: The Amazon Resource Name (ARN) that uniquely identifies the flow execution.
        flowAliasIdentifier:
          type: string
          description: The unique identifier of the flow alias used for the execution.
        flowIdentifier:
          type: string
          description: The unique identifier of the flow.
        flowVersion:
          type: string
          description: The version of the flow used for the execution.
        status:
          type: string
          enum:
          - Running
          - Succeeded
          - Failed
          - TimedOut
          - Aborted
          description: The current status of the flow execution. Flow executions time out after 24 hours.
        createdAt:
          type: string
          format: date-time
          description: The timestamp when the flow execution was created.
        endedAt:
          type: string
          format: date-time
          description: The timestamp when the flow execution ended. This field is only populated when the execution has completed,
            failed, timed out, or been aborted.
      required:
      - executionArn
      - flowAliasIdentifier
      - flowIdentifier
      - flowVersion
      - status
      - createdAt
    FlowInput:
      type: object
      properties:
        nodeName:
          type: string
          description: The name of the flow input node that begins the prompt flow.
        nodeOutputName:
          type: string
          description: The name of the output from the flow input node that begins the prompt flow.
        content:
          $ref: '#/components/schemas/FlowInputContent'
        nodeInputName:
          type: string
          description: The name of the input from the flow input node.
      required:
      - nodeName
      - content
    FlowInputContent:
      type: object
      properties:
        document:
          type: object
          description: The input to send to the prompt flow input node.
      description: Exactly one member is set.
    GetFlowExecutionRequest:
      type: object
      properties:
        flowIdentifier:
          type: string
          description: The unique identifier of the flow.
        flowAliasIdentifier:
          type: string
          description: The unique identifier of the flow alias used for the execution.
        executionIdentifier:
          type: string
          description: The unique identifier of the flow execution to retrieve.
      required:
      - flowIdentifier
      - flowAliasIdentifier
      - executionIdentifier
    GetFlowExecutionResponse:
      type: object
      properties:
        executionArn:
          type: string
          description: The Amazon Resource Name (ARN) that uniquely identifies the flow execution.
        status:
          type: string
          enum:
          - Running
          - Succeeded
          - Failed
          - TimedOut
          - Aborted
          description: The current status of the flow execution. Flow executions time out after 24 hours.
        startedAt:
          type: string
          format: date-time
          description: The timestamp when the flow execution started.
        endedAt:
          type: string
          format: date-time
          description: The timestamp when the flow execution ended. This field is only populated when the execution has completed,
            failed, timed out, or been aborted.
        errors:
          type: array
          items:
            $ref: '#/components/schemas/FlowExecutionError'
          description: A list of errors that occurred during the flow execution. Each error includes an error code, message,
            and the node where the error occurred, if applicable.
        flowAliasIdentifier:
          type: string
          description: The unique identifier of the flow alias used for the execution.
        flowIdentifier:
          type: string
          description: The unique identifier of the flow.
        flowVersion:
          type: string
          description: The version of the flow used for the execution.
      required:
      - executionArn
      - status
      - startedAt
      - flowAliasIdentifier
      - flowIdentifier
      - flowVersion
    ListFlowExecutionsRequest:
      type: object
      properties:
        flowIdentifier:
          type: string
          description: The unique identifier of the flow to list executions for.
        flowAliasIdentifier:
          type: string
          description: The unique identifier of the flow alias to list executions for.
        maxResults:
          type: integer
          description: The maximum number of flow executions to return in a single response. If more executions exist than
            the specified maxResults value, a token is included in the response so that the remaining results can be retrieved.
        nextToken:
          type: string
          description: A token to retrieve the next set of results. This value is returned in the response if more results
            are available.
      required:
      - flowIdentifier
    ListFlowExecutionsResponse:
      type: object
      properties:
        flowExecutionSummaries:
          type: array
          items:
            $ref: '#/components/schemas/FlowExecutionSummary'
          description: A list of flow execution summaries. Each summary includes the execution ARN, flow identifier, flow
            alias identifier, flow version, status, and timestamps.
        nextToken:
          type: string
          description: A token to retrieve the next set of results. This value is returned if more results are available.
      required:
      - flowExecutionSummaries
    ModelPerformanceConfiguration:
      type: object
      properties:
        performanceConfig:
          $ref: '#/components/schemas/BedrockAgentRuntimePerformanceConfiguration'
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
    ServiceQuotaExceededException:
      type: object
      properties:
        message:
          type: string
    StartFlowExecutionRequest:
      type: object
      properties:
        flowIdentifier:
          type: string
          description: The unique identifier of the flow to execute.
        flowAliasIdentifier:
          type: string
          description: The unique identifier of the flow alias to use for the flow execution.
        flowExecutionName:
          type: string
          description: The unique name for the flow execution. If you don't provide one, a system-generated name is used.
        inputs:
          type: array
          items:
            $ref: '#/components/schemas/FlowInput'
          description: The input data required for the flow execution. This must match the input schema defined in the flow.
        modelPerformanceConfiguration:
          $ref: '#/components/schemas/ModelPerformanceConfiguration'
      required:
      - flowIdentifier
      - flowAliasIdentifier
      - inputs
    StartFlowExecutionResponse:
      type: object
      properties:
        executionArn:
          type: string
          description: The Amazon Resource Name (ARN) that uniquely identifies the flow execution.
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
    ValidationException:
      type: object
      properties:
        message:
          type: string
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/bedrock-agent-runtime/service/2023-07-26/bedrock-agent-runtime-2023-07-26.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)