Amazon Bedrock Bedrock Automated Reasoning Policies API

openapi: 3.2.0
info:
  title: Amazon Bedrock Automated Reasoning Policies 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.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Automated Reasoning Policies
paths:
  /automated-reasoning-policies:
    post:
      operationId: CreateAutomatedReasoningPolicy
      summary: Create Automated Reasoning Policy
      description: Creates an Automated Reasoning policy for Amazon Bedrock Guardrails. Automated Reasoning policies use mathematical techniques to detect hallucinations, suggest corrections, and highlight unstated assumptions in the responses of your GenAI application. To create a policy, you upload a source document that describes the rules that you're encoding. Automated Reasoning extracts important concepts from the source document that will become variables in the policy and infers policy rules.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateAutomatedReasoningPolicyResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '400':
          description: ConflictException; ServiceQuotaExceededException; TooManyTagsException; 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'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAutomatedReasoningPolicyRequest'
      tags:
      - Automated Reasoning Policies
    get:
      operationId: ListAutomatedReasoningPolicies
      summary: List Automated Reasoning Policies
      description: Lists all Automated Reasoning policies in your account, with optional filtering by policy ARN. This helps you manage and discover existing policies.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListAutomatedReasoningPoliciesResponse'
        '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/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListAutomatedReasoningPoliciesRequest'
      tags:
      - Automated Reasoning Policies
  /automated-reasoning-policies/{policyArn}:
    get:
      operationId: GetAutomatedReasoningPolicy
      summary: Get Automated Reasoning Policy
      description: Retrieves details about an Automated Reasoning policy or policy version. Returns information including the policy definition, metadata, and timestamps.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAutomatedReasoningPolicyResponse'
        '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/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetAutomatedReasoningPolicyRequest'
      tags:
      - Automated Reasoning Policies
    patch:
      operationId: UpdateAutomatedReasoningPolicy
      summary: Update Automated Reasoning Policy
      description: Updates an existing Automated Reasoning policy with new rules, variables, or configuration. This creates a new version of the policy while preserving the previous version.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateAutomatedReasoningPolicyResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '400':
          description: ConflictException; TooManyTagsException; 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'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateAutomatedReasoningPolicyRequest'
      tags:
      - Automated Reasoning Policies
    delete:
      operationId: DeleteAutomatedReasoningPolicy
      summary: Delete Automated Reasoning Policy
      description: Deletes an Automated Reasoning policy or policy version. This operation is idempotent. If you delete a policy more than once, each call succeeds. Deleting a policy removes it permanently and cannot be undone.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteAutomatedReasoningPolicyResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '400':
          description: ConflictException; ResourceInUseException; 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'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteAutomatedReasoningPolicyRequest'
      tags:
      - Automated Reasoning Policies
components:
  schemas:
    AutomatedReasoningPolicyDefinitionType:
      type: object
      properties:
        name:
          type: string
          description: The name of the custom type.
        description:
          type: string
          description: The description of what the custom type represents.
        values:
          type: array
          items:
            $ref: '#/components/schemas/AutomatedReasoningPolicyDefinitionTypeValue'
          description: The possible values for this enum-based type, each with its own description.
      required:
      - name
      - values
    Tag:
      type: object
      properties:
        key:
          type: string
          description: Key for the tag.
        value:
          type: string
          description: Value for the tag.
      required:
      - key
      - value
    AutomatedReasoningPolicyDefinitionTypeValue:
      type: object
      properties:
        value:
          type: string
          description: The actual value or identifier for this type value.
        description:
          type: string
          description: A human-readable description explaining what this type value represents and when it should be used.
      required:
      - value
    ListAutomatedReasoningPoliciesRequest:
      type: object
      properties:
        policyArn:
          type: string
          description: Optional filter to list only the policy versions with the specified Amazon Resource Name (ARN). If not provided, the DRAFT versions for all policies are listed.
        nextToken:
          type: string
          description: The pagination token from a previous request to retrieve the next page of results.
        maxResults:
          type: integer
          description: The maximum number of policies to return in a single call.
    GetAutomatedReasoningPolicyResponse:
      type: object
      properties:
        policyArn:
          type: string
          description: The Amazon Resource Name (ARN) of the policy.
        name:
          type: string
          description: The name of the policy.
        version:
          type: string
          description: The version of the policy.
        policyId:
          type: string
          description: The unique identifier of the policy.
        description:
          type: string
          description: The description of the policy.
        definitionHash:
          type: string
          description: The hash of the policy definition used as a concurrency token.
        kmsKeyArn:
          type: string
          description: The Amazon Resource Name (ARN) of the KMS key used to encrypt the automated reasoning policy and its associated artifacts. If a KMS key is not provided during the initial CreateAutomatedReasoningPolicyRequest, the kmsKeyArn won't be included in the GetAutomatedReasoningPolicyResponse.
        createdAt:
          type: string
          format: date-time
          description: The timestamp when the policy was created.
        updatedAt:
          type: string
          format: date-time
          description: The timestamp when the policy was last updated.
      required:
      - policyArn
      - name
      - version
      - policyId
      - definitionHash
      - updatedAt
    InternalServerException:
      type: object
      properties:
        message:
          type: string
    AutomatedReasoningPolicyDefinitionRule:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the rule within the policy.
        expression:
          type: string
          description: The formal logic expression of the rule.
        alternateExpression:
          type: string
          description: The human-readable form of the rule expression, often in natural language or simplified notation.
      required:
      - id
      - expression
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
    DeleteAutomatedReasoningPolicyRequest:
      type: object
      properties:
        policyArn:
          type: string
          description: The Amazon Resource Name (ARN) of the Automated Reasoning policy to delete.
        force:
          type: boolean
          description: Specifies whether to force delete the automated reasoning policy even if it has active resources. When false, Amazon Bedrock validates if all artifacts have been deleted (e.g. policy version, test case, test result) for a policy before deletion. When true, Amazon Bedrock will delete the policy and all its artifacts without validation. Default is false.
      required:
      - policyArn
    ConflictException:
      type: object
      properties:
        message:
          type: string
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
    ListAutomatedReasoningPoliciesResponse:
      type: object
      properties:
        automatedReasoningPolicySummaries:
          type: array
          items:
            $ref: '#/components/schemas/AutomatedReasoningPolicySummary'
          description: A list of Automated Reasoning policy summaries.
        nextToken:
          type: string
          description: The pagination token to use in a subsequent request to retrieve the next page of results.
      required:
      - automatedReasoningPolicySummaries
    ValidationException:
      type: object
      properties:
        message:
          type: string
    AutomatedReasoningPolicySummary:
      type: object
      properties:
        policyArn:
          type: string
          description: The Amazon Resource Name (ARN) of the policy.
        name:
          type: string
          description: The name of the policy.
        description:
          type: string
          description: The description of the policy.
        version:
          type: string
          description: The version of the policy.
        policyId:
          type: string
          description: The unique identifier of the policy.
        createdAt:
          type: string
          format: date-time
          description: The timestamp when the policy was created.
        updatedAt:
          type: string
          format: date-time
          description: The timestamp when the policy was last updated.
      required:
      - policyArn
      - name
      - version
      - policyId
      - createdAt
      - updatedAt
    GetAutomatedReasoningPolicyRequest:
      type: object
      properties:
        policyArn:
          type: string
          description: The Amazon Resource Name (ARN) of the Automated Reasoning policy to retrieve. Can be either the unversioned ARN for the draft policy or an ARN for a specific policy version.
      required:
      - policyArn
    CreateAutomatedReasoningPolicyRequest:
      type: object
      properties:
        name:
          type: string
          description: A unique name for the Automated Reasoning policy. The name must be between 1 and 63 characters and can contain letters, numbers, hyphens, and underscores.
        description:
          type: string
          description: A description of the Automated Reasoning policy. Use this to provide context about the policy's purpose and the types of validations it performs.
        clientRequestToken:
          type: string
          description: A unique, case-sensitive identifier to ensure that the operation completes no more than once. If this token matches a previous request, Amazon Bedrock ignores the request but doesn't return an error.
        policyDefinition:
          $ref: '#/components/schemas/AutomatedReasoningPolicyDefinition'
        kmsKeyId:
          type: string
          description: The identifier of the KMS key to use for encrypting the automated reasoning policy and its associated artifacts. If you don't specify a KMS key, Amazon Bedrock uses an KMS managed key for encryption. For enhanced security and control, you can specify a customer managed KMS key.
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: A list of tags to associate with the Automated Reasoning policy. Tags help you organize and manage your policies.
      required:
      - name
    DeleteAutomatedReasoningPolicyResponse:
      type: object
      properties: {}
    CreateAutomatedReasoningPolicyResponse:
      type: object
      properties:
        policyArn:
          type: string
          description: The Amazon Resource Name (ARN) of the Automated Reasoning policy that you created.
        version:
          type: string
          description: The version number of the newly created Automated Reasoning policy. The initial version is always DRAFT.
        name:
          type: string
          description: The name of the Automated Reasoning policy.
        description:
          type: string
          description: The description of the Automated Reasoning policy.
        definitionHash:
          type: string
          description: The hash of the policy definition. This is used as a concurrency token for creating policy versions that you can use in your application.
        createdAt:
          type: string
          format: date-time
          description: The timestamp when the policy was created.
        updatedAt:
          type: string
          format: date-time
          description: The timestamp when the policy was last updated.
      required:
      - policyArn
      - version
      - name
      - createdAt
      - updatedAt
    AutomatedReasoningPolicyDefinitionVariable:
      type: object
      properties:
        name:
          type: string
          description: The name of the variable. Use descriptive names that clearly indicate the concept being represented.
        type:
          type: string
          description: The data type of the variable. Valid types include bool, int, real, enum, and custom types that you can provide.
        description:
          type: string
          description: The description of the variable that explains what it represents and how users might refer to it. Clear and comprehensive descriptions are essential for accurate natural language translation.
      required:
      - name
      - type
      - description
    UpdateAutomatedReasoningPolicyRequest:
      type: object
      properties:
        policyArn:
          type: string
          description: The Amazon Resource Name (ARN) of the Automated Reasoning policy to update. This must be the ARN of a draft policy.
        policyDefinition:
          $ref: '#/components/schemas/AutomatedReasoningPolicyDefinition'
        name:
          type: string
          description: The updated name for the Automated Reasoning policy.
        description:
          type: string
          description: The updated description for the Automated Reasoning policy.
      required:
      - policyArn
      - policyDefinition
    AutomatedReasoningPolicyDefinition:
      type: object
      properties:
        version:
          type: string
          description: The version of the policy definition format.
        types:
          type: array
          items:
            $ref: '#/components/schemas/AutomatedReasoningPolicyDefinitionType'
          description: The custom user-defined vairable types used in the policy. Types are enum-based variable types that provide additional context beyond the predefined variable types.
        rules:
          type: array
          items:
            $ref: '#/components/schemas/AutomatedReasoningPolicyDefinitionRule'
          description: The formal logic rules extracted from the source document. Rules define the logical constraints that determine whether model responses are valid, invalid, or satisfiable.
        variables:
          type: array
          items:
            $ref: '#/components/schemas/AutomatedReasoningPolicyDefinitionVariable'
          description: The variables that represent concepts in the policy. Variables can have values assigned when translating natural language into formal logic. Their descriptions are crucial for accurate translation.
    UpdateAutomatedReasoningPolicyResponse:
      type: object
      properties:
        policyArn:
          type: string
          description: The Amazon Resource Name (ARN) of the updated policy.
        name:
          type: string
          description: The updated name of the policy.
        definitionHash:
          type: string
          description: The hash of the updated policy definition.
        updatedAt:
          type: string
          format: date-time
          description: The timestamp when the policy was last updated.
      required:
      - policyArn
      - name
      - definitionHash
      - updatedAt
  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/service/2023-04-20/bedrock-2023-04-20.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)