Vapi · Schema

AnthropicBedrockCredential

AIVoiceAgentsRealtimeCPaaS

Properties

Name	Type	Description
provider	string
region	string	AWS region where Bedrock is configured.
authenticationPlan	object	Authentication method - either direct IAM credentials or cross-account role assumption.
id	string	This is the unique identifier for the credential.
orgId	string	This is the unique identifier for the org that this credential belongs to.
createdAt	string	This is the ISO 8601 date-time string of when the credential was created.
updatedAt	string	This is the ISO 8601 date-time string of when the assistant was last updated.
authenticationArtifact	object	Stores the external ID (generated or user-provided) for future AssumeRole calls.
authenticationSession	object	Cached authentication session from AssumeRole (temporary credentials). Managed by the system, auto-refreshed when expired.
name	string	This is the name of credential. This is just for your reference.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AnthropicBedrockCredential",
  "title": "AnthropicBedrockCredential",
  "type": "object",
  "properties": {
    "provider": {
      "type": "string",
      "enum": [
        "anthropic-bedrock"
      ]
    },
    "region": {
      "type": "string",
      "description": "AWS region where Bedrock is configured.",
      "enum": [
        "us-east-1",
        "us-west-2",
        "eu-west-1",
        "eu-west-3",
        "ap-northeast-1",
        "ap-southeast-2"
      ]
    },
    "authenticationPlan": {
      "description": "Authentication method - either direct IAM credentials or cross-account role assumption.",
      "oneOf": [
        {
          "$ref": "#/components/schemas/AWSIAMCredentialsAuthenticationPlan"
        },
        {
          "$ref": "#/components/schemas/AWSStsAuthenticationPlan"
        }
      ]
    },
    "id": {
      "type": "string",
      "description": "This is the unique identifier for the credential."
    },
    "orgId": {
      "type": "string",
      "description": "This is the unique identifier for the org that this credential belongs to."
    },
    "createdAt": {
      "format": "date-time",
      "type": "string",
      "description": "This is the ISO 8601 date-time string of when the credential was created."
    },
    "updatedAt": {
      "format": "date-time",
      "type": "string",
      "description": "This is the ISO 8601 date-time string of when the assistant was last updated."
    },
    "authenticationArtifact": {
      "description": "Stores the external ID (generated or user-provided) for future AssumeRole calls.",
      "allOf": [
        {
          "$ref": "#/components/schemas/AWSStsAuthenticationArtifact"
        }
      ]
    },
    "authenticationSession": {
      "description": "Cached authentication session from AssumeRole (temporary credentials).\nManaged by the system, auto-refreshed when expired.",
      "allOf": [
        {
          "$ref": "#/components/schemas/AWSStsAuthenticationSession"
        }
      ]
    },
    "name": {
      "type": "string",
      "description": "This is the name of credential. This is just for your reference.",
      "minLength": 1,
      "maxLength": 40
    }
  },
  "required": [
    "provider",
    "region",
    "authenticationPlan",
    "id",
    "orgId",
    "createdAt",
    "updatedAt"
  ]
}