Amazon Bedrock Bedrock Actiongroups API

openapi: 3.1.0
info:
  title: Amazon Bedrock Actiongroups API
  version: '2023-04-20'
  description: Generated from AWS's published Smithy model for Amazon Bedrock. 5 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.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /agents/{agentId}/agentversions/{agentVersion}/actiongroups/:
    put:
      operationId: CreateAgentActionGroup
      summary: Create Agent Action Group
      description: Creates an action group for an agent. An action group represents the actions that an agent can carry out
        for the customer by defining the APIs that an agent can call and the logic for calling them. To allow your agent to
        request the user for additional information when trying to complete a task, add an action group with the parentActionGroupSignature
        field set to AMAZON.UserInput. To allow your agent to generate, run, and troubleshoot code when trying to complete
        a task, add an action group with the parentActionGroupSignature field set to AMAZON.CodeInterpreter. You must leave
        the description, apiSchema, and actionGroupExecutor fields blank for this action group. During orchestration, if your
        agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete
        the API request, it will invoke this action group instead and return an Observation reprompting the user for more
        information.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateAgentActionGroupResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          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'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BedrockAgentValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAgentActionGroupRequest'
      tags:
      - Actiongroups
    post:
      operationId: ListAgentActionGroups
      summary: List Agent Action Groups
      description: Lists the action groups for an agent and information about each one.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListAgentActionGroupsResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '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/BedrockAgentValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListAgentActionGroupsRequest'
      tags:
      - Actiongroups
  /agents/{agentId}/agentversions/{agentVersion}/actiongroups/{actionGroupId}/:
    delete:
      operationId: DeleteAgentActionGroup
      summary: Delete Agent Action Group
      description: Deletes an action group in an agent.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteAgentActionGroupResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          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'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BedrockAgentValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteAgentActionGroupRequest'
      tags:
      - Actiongroups
    get:
      operationId: GetAgentActionGroup
      summary: Get Agent Action Group
      description: Gets information about an action group for an agent.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAgentActionGroupResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '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/BedrockAgentValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetAgentActionGroupRequest'
      tags:
      - Actiongroups
    put:
      operationId: UpdateAgentActionGroup
      summary: Update Agent Action Group
      description: Updates the configuration for an action group for an agent.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateAgentActionGroupResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          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'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BedrockAgentValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateAgentActionGroupRequest'
      tags:
      - Actiongroups
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:
    APISchema:
      type: object
      properties:
        s3:
          $ref: '#/components/schemas/S3Identifier'
        payload:
          type: string
          description: The JSON or YAML-formatted payload defining the OpenAPI schema for the action group. For more information,
            see Action group OpenAPI schemas.
      description: Exactly one member is set.
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
    ActionGroupExecutor:
      type: object
      properties:
        lambda:
          type: string
          description: The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried
            out upon invoking the action.
        customControl:
          type: string
          enum:
          - RETURN_CONTROL
          description: To return the action group invocation results directly in the InvokeAgent response, specify RETURN_CONTROL.
      description: Exactly one member is set.
    ActionGroupSummary:
      type: object
      properties:
        actionGroupId:
          type: string
          description: The unique identifier of the action group.
        actionGroupName:
          type: string
          description: The name of the action group.
        actionGroupState:
          type: string
          enum:
          - ENABLED
          - DISABLED
          description: Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent
            request.
        description:
          type: string
          description: The description of the action group.
        updatedAt:
          type: string
          format: date-time
          description: The time at which the action group was last updated.
      required:
      - actionGroupId
      - actionGroupName
      - actionGroupState
      - updatedAt
    AgentActionGroup:
      type: object
      properties:
        agentId:
          type: string
          description: The unique identifier of the agent to which the action group belongs.
        agentVersion:
          type: string
          description: The version of the agent to which the action group belongs.
        actionGroupId:
          type: string
          description: The unique identifier of the action group.
        actionGroupName:
          type: string
          description: The name of the action group.
        clientToken:
          type: string
          description: A unique, case-sensitive identifier to ensure that the API request completes no more than one time.
            If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For
            more information, see Ensuring idempotency.
        description:
          type: string
          description: The description of the action group.
        createdAt:
          type: string
          format: date-time
          description: The time at which the action group was created.
        updatedAt:
          type: string
          format: date-time
          description: The time at which the action group was last updated.
        parentActionSignature:
          type: string
          enum:
          - AMAZON.UserInput
          - AMAZON.CodeInterpreter
          - ANTHROPIC.Computer
          - ANTHROPIC.Bash
          - ANTHROPIC.TextEditor
          description: If this field is set as AMAZON.UserInput, the agent can request the user for additional information
            when trying to complete a task. The description, apiSchema, and actionGroupExecutor fields must be blank for this
            action group. During orchestration, if the agent determines that it needs to invoke an API in an action group,
            but doesn't have enough information to complete the API request, it will invoke this action group instead and
            return an Observation reprompting the user for more information.
        parentActionGroupSignatureParams:
          type: object
          additionalProperties:
            type: string
          description: The configuration settings for a computer use action. Computer use is a new Anthropic Claude model
            capability (in beta) available with Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only. For more information, see
            Configure an Amazon Bedrock Agent to complete tasks with computer use tools.
        actionGroupExecutor:
          $ref: '#/components/schemas/ActionGroupExecutor'
        apiSchema:
          $ref: '#/components/schemas/APISchema'
        functionSchema:
          $ref: '#/components/schemas/FunctionSchema'
        actionGroupState:
          type: string
          enum:
          - ENABLED
          - DISABLED
          description: Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent
            request.
      required:
      - agentId
      - agentVersion
      - actionGroupId
      - actionGroupName
      - createdAt
      - updatedAt
      - actionGroupState
    BedrockAgentValidationException:
      type: object
      properties:
        message:
          type: string
        fieldList:
          type: array
          items:
            $ref: '#/components/schemas/ValidationExceptionField'
          description: A list of objects containing fields that caused validation errors and their corresponding validation
            error messages.
    ConflictException:
      type: object
      properties:
        message:
          type: string
    CreateAgentActionGroupRequest:
      type: object
      properties:
        agentId:
          type: string
          description: The unique identifier of the agent for which to create the action group.
        agentVersion:
          type: string
          description: The version of the agent for which to create the action group.
        actionGroupName:
          type: string
          description: The name to give the action group.
        clientToken:
          type: string
          description: A unique, case-sensitive identifier to ensure that the API request completes no more than one time.
            If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For
            more information, see Ensuring idempotency.
        description:
          type: string
          description: A description of the action group.
        parentActionGroupSignature:
          type: string
          enum:
          - AMAZON.UserInput
          - AMAZON.CodeInterpreter
          - ANTHROPIC.Computer
          - ANTHROPIC.Bash
          - ANTHROPIC.TextEditor
          description: Specify a built-in or computer use action for this action group. If you specify a value, you must leave
            the description, apiSchema, and actionGroupExecutor fields empty for this action group. To allow your agent to
            request the user for additional information when trying to complete a task, set this field to AMAZON.UserInput.
            To allow your agent to generate, run, and troubleshoot code when trying to complete a task, set this field to
            AMAZON.CodeInterpreter. To allow your agent to use an Anthropic computer use tool, specify one of the following
            values. Computer use is a new Anthropic Claude mode
        parentActionGroupSignatureParams:
          type: object
          additionalProperties:
            type: string
          description: The configuration settings for a computer use action. Computer use is a new Anthropic Claude model
            capability (in beta) available with Anthropic Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only. For more information,
            see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.
        actionGroupExecutor:
          $ref: '#/components/schemas/ActionGroupExecutor'
        apiSchema:
          $ref: '#/components/schemas/APISchema'
        actionGroupState:
          type: string
          enum:
          - ENABLED
          - DISABLED
          description: Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent
            request.
        functionSchema:
          $ref: '#/components/schemas/FunctionSchema'
      required:
      - agentId
      - agentVersion
      - actionGroupName
    CreateAgentActionGroupResponse:
      type: object
      properties:
        agentActionGroup:
          $ref: '#/components/schemas/AgentActionGroup'
      required:
      - agentActionGroup
    DeleteAgentActionGroupRequest:
      type: object
      properties:
        agentId:
          type: string
          description: The unique identifier of the agent that the action group belongs to.
        agentVersion:
          type: string
          description: The version of the agent that the action group belongs to.
        actionGroupId:
          type: string
          description: The unique identifier of the action group to delete.
        skipResourceInUseCheck:
          type: boolean
          description: By default, this value is false and deletion is stopped if the resource is in use. If you set it to
            true, the resource will be deleted even if the resource is in use.
      required:
      - agentId
      - agentVersion
      - actionGroupId
    DeleteAgentActionGroupResponse:
      type: object
      properties: {}
    Function:
      type: object
      properties:
        name:
          type: string
          description: A name for the function.
        description:
          type: string
          description: A description of the function and its purpose.
        parameters:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/ParameterDetail'
          description: The parameters that the agent elicits from the user to fulfill the function.
        requireConfirmation:
          type: string
          enum:
          - ENABLED
          - DISABLED
          description: Contains information if user confirmation is required to invoke the function.
      required:
      - name
    FunctionSchema:
      type: object
      properties:
        functions:
          type: array
          items:
            $ref: '#/components/schemas/Function'
          description: A list of functions that each define an action in the action group.
      description: Exactly one member is set.
    GetAgentActionGroupRequest:
      type: object
      properties:
        agentId:
          type: string
          description: The unique identifier of the agent that the action group belongs to.
        agentVersion:
          type: string
          description: The version of the agent that the action group belongs to.
        actionGroupId:
          type: string
          description: The unique identifier of the action group for which to get information.
      required:
      - agentId
      - agentVersion
      - actionGroupId
    GetAgentActionGroupResponse:
      type: object
      properties:
        agentActionGroup:
          $ref: '#/components/schemas/AgentActionGroup'
      required:
      - agentActionGroup
    InternalServerException:
      type: object
      properties:
        message:
          type: string
    ListAgentActionGroupsRequest:
      type: object
      properties:
        agentId:
          type: string
          description: The unique identifier of the agent.
        agentVersion:
          type: string
          description: The version of the agent.
        maxResults:
          type: integer
          description: The maximum number of results to return in the response. If the total number of results is greater
            than this value, use the token returned in the response in the nextToken field when making another request to
            return the next batch of results.
        nextToken:
          type: string
          description: If the total number of results is greater than the maxResults value provided in the request, enter
            the token returned in the nextToken field in the response in this field to return the next batch of results.
      required:
      - agentId
      - agentVersion
    ListAgentActionGroupsResponse:
      type: object
      properties:
        actionGroupSummaries:
          type: array
          items:
            $ref: '#/components/schemas/ActionGroupSummary'
          description: A list of objects, each of which contains information about an action group.
        nextToken:
          type: string
          description: If the total number of results is greater than the maxResults value provided in the request, use this
            token when making another request in the nextToken field to return the next batch of results.
      required:
      - actionGroupSummaries
    ParameterDetail:
      type: object
      properties:
        description:
          type: string
          description: A description of the parameter. Helps the foundation model determine how to elicit the parameters from
            the user.
        type:
          type: string
          enum:
          - string
          - number
          - integer
          - boolean
          - array
          description: The data type of the parameter.
        required:
          type: boolean
          description: Whether the parameter is required for the agent to complete the function for action group invocation.
      required:
      - type
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
    S3Identifier:
      type: object
      properties:
        s3BucketName:
          type: string
          description: The name of the S3 bucket.
        s3ObjectKey:
          type: string
          description: The S3 object key for the S3 resource.
    ServiceQuotaExceededException:
      type: object
      properties:
        message:
          type: string
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
    UpdateAgentActionGroupRequest:
      type: object
      properties:
        agentId:
          type: string
          description: The unique identifier of the agent for which to update the action group.
        agentVersion:
          type: string
          description: The unique identifier of the agent version for which to update the action group.
        actionGroupId:
          type: string
          description: The unique identifier of the action group.
        actionGroupName:
          type: string
          description: Specifies a new name for the action group.
        description:
          type: string
          description: Specifies a new name for the action group.
        parentActionGroupSignature:
          type: string
          enum:
          - AMAZON.UserInput
          - AMAZON.CodeInterpreter
          - ANTHROPIC.Computer
          - ANTHROPIC.Bash
          - ANTHROPIC.TextEditor
          description: Update the built-in or computer use action for this action group. If you specify a value, you must
            leave the description, apiSchema, and actionGroupExecutor fields empty for this action group. To allow your agent
            to request the user for additional information when trying to complete a task, set this field to AMAZON.UserInput.
            To allow your agent to generate, run, and troubleshoot code when trying to complete a task, set this field to
            AMAZON.CodeInterpreter. To allow your agent to use an Anthropic computer use tool, specify one of the following
            values. Computer use is a new Anthropic Claude mod
        parentActionGroupSignatureParams:
          type: object
          additionalProperties:
            type: string
          description: The configuration settings for a computer use action. Computer use is a new Anthropic Claude model
            capability (in beta) available with Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only. For more information, see
            Configure an Amazon Bedrock Agent to complete tasks with computer use tools.
        actionGroupExecutor:
          $ref: '#/components/schemas/ActionGroupExecutor'
        actionGroupState:
          type: string
          enum:
          - ENABLED
          - DISABLED
          description: Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent
            request.
        apiSchema:
          $ref: '#/components/schemas/APISchema'
        functionSchema:
          $ref: '#/components/schemas/FunctionSchema'
      required:
      - agentId
      - agentVersion
      - actionGroupId
      - actionGroupName
    UpdateAgentActionGroupResponse:
      type: object
      properties:
        agentActionGroup:
          $ref: '#/components/schemas/AgentActionGroup'
      required:
      - agentActionGroup
    ValidationExceptionField:
      type: object
      properties:
        name:
          type: string
          description: The name of the field.
        message:
          type: string
          description: A message describing why this field failed validation.
      required:
      - name
      - message
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/bedrock-agent/service/2023-06-05/bedrock-agent-2023-06-05.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)