From f68727d96fae13e666942e6c01d72eddc65f62f9 Mon Sep 17 00:00:00 2001
From: awstools Settings for a foundation model used to parse documents for a data source. Settings for a foundation model or inference profile used to parse documents for a data source. The model's ARN. The ARN of the foundation model or inference profile.
To use a model to parse PDF documents, set the parsing strategy to BEDROCK_FOUNDATION_MODEL
and
- * specify the model to use by ARN. You can also override the default parsing prompt with instructions for how
+ * specify the model or inference profile to use by ARN. You can also override the default parsing prompt with instructions for how
* to interpret images and tables in your documents. The following models are supported.
Contains details about the S3 object containing the OpenAPI schema for the action group. For more information, see Action group OpenAPI schemas.
" - } - }, - "payload": { - "target": "com.amazonaws.bedrockagent#Payload", - "traits": { - "smithy.api#documentation": "The JSON or YAML-formatted payload defining the OpenAPI schema for the action group. For more information, see Action group OpenAPI schemas.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains details about the OpenAPI schema for the action group. For more information, see Action group OpenAPI schemas. You can either include the schema directly in the payload
field or you can upload it to an S3 bucket and specify the S3 bucket location in the s3
field.
Contains details about the S3 object containing the OpenAPI schema for the action group. For more information, see Action group OpenAPI schemas.
" + } + }, + "payload": { + "target": "com.amazonaws.bedrockagent#Payload", + "traits": { + "smithy.api#documentation": "The JSON or YAML-formatted payload defining the OpenAPI schema for the action group. For more information, see Action group OpenAPI schemas.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about the OpenAPI schema for the action group. For more information, see Action group OpenAPI schemas. You can either include the schema directly in the payload
field or you can upload it to an S3 bucket and specify the S3 bucket location in the s3
field.
The request is denied because of missing access permissions.
", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.bedrockagent#ActionGroupExecutor": { + "type": "union", + "members": { + "lambda": { + "target": "com.amazonaws.bedrockagent#LambdaArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.
" + } + }, + "customControl": { + "target": "com.amazonaws.bedrockagent#CustomControlMethod", + "traits": { + "smithy.api#documentation": "To return the action group invocation results directly in the InvokeAgent
response, specify RETURN_CONTROL
.
Contains details about the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.
" + } + }, + "com.amazonaws.bedrockagent#ActionGroupResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrockagent#CreateAgentActionGroup" + }, + { + "target": "com.amazonaws.bedrockagent#DeleteAgentActionGroup" + }, + { + "target": "com.amazonaws.bedrockagent#GetAgentActionGroup" + }, + { + "target": "com.amazonaws.bedrockagent#ListAgentActionGroups" + }, + { + "target": "com.amazonaws.bedrockagent#UpdateAgentActionGroup" + } + ] + }, + "com.amazonaws.bedrockagent#ActionGroupSignature": { + "type": "enum", + "members": { + "AMAZON_USERINPUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AMAZON.UserInput" + } + }, + "AMAZON_CODEINTERPRETER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AMAZON.CodeInterpreter" + } + } + } + }, + "com.amazonaws.bedrockagent#ActionGroupState": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.bedrockagent#ActionGroupSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#ActionGroupSummary" + }, + "traits": { + "smithy.api#length": { + "max": 10 + } + } + }, + "com.amazonaws.bedrockagent#ActionGroupSummary": { + "type": "structure", + "members": { + "actionGroupId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the action group.
", + "smithy.api#required": {} + } + }, + "actionGroupName": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "The name of the action group.
", + "smithy.api#required": {} + } + }, + "actionGroupState": { + "target": "com.amazonaws.bedrockagent#ActionGroupState", + "traits": { + "smithy.api#documentation": "Specifies whether the action group is available for the agent to invoke or not when\n sending an InvokeAgent\n request.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "The description of the action group.
" + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the action group was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about an action group.
" + } + }, + "com.amazonaws.bedrockagent#Agent": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent.
", + "smithy.api#required": {} + } + }, + "agentName": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "The name of the agent.
", + "smithy.api#required": {} + } + }, + "agentArn": { + "target": "com.amazonaws.bedrockagent#AgentArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the agent.
", + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#DraftVersion", + "traits": { + "smithy.api#documentation": "The version of the agent.
", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagent#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
" + } + }, + "instruction": { + "target": "com.amazonaws.bedrockagent#Instruction", + "traits": { + "smithy.api#documentation": "Instructions that tell the agent what it should do and how it should interact with users.
" + } + }, + "agentStatus": { + "target": "com.amazonaws.bedrockagent#AgentStatus", + "traits": { + "smithy.api#documentation": "The status of the agent and whether it is ready for use. The following statuses are possible:
\nCREATING – The agent is being created.
\nPREPARING – The agent is being prepared.
\nPREPARED – The agent is prepared and ready to be invoked.
\nNOT_PREPARED – The agent has been created but not yet prepared.
\nFAILED – The agent API operation failed.
\nUPDATING – The agent is being updated.
\nDELETING – The agent is being deleted.
\nThe foundation model used for orchestration by the agent.
" + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "The description of the agent.
" + } + }, + "idleSessionTTLInSeconds": { + "target": "com.amazonaws.bedrockagent#SessionTTL", + "traits": { + "smithy.api#documentation": "The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.
\nA user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.
", + "smithy.api#required": {} + } + }, + "agentResourceRoleArn": { + "target": "com.amazonaws.bedrockagent#AgentRoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
", + "smithy.api#required": {} + } + }, + "customerEncryptionKeyArn": { + "target": "com.amazonaws.bedrockagent#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key that encrypts the agent.
" + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the agent was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the agent was last updated.
", + "smithy.api#required": {} + } + }, + "preparedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the agent was last prepared.
" + } + }, + "failureReasons": { + "target": "com.amazonaws.bedrockagent#FailureReasons", + "traits": { + "smithy.api#documentation": "Contains reasons that the agent-related API that you invoked failed.
" + } + }, + "recommendedActions": { + "target": "com.amazonaws.bedrockagent#RecommendedActions", + "traits": { + "smithy.api#documentation": "Contains recommended actions to take for the agent-related API that you invoked to succeed.
" + } + }, + "promptOverrideConfiguration": { + "target": "com.amazonaws.bedrockagent#PromptOverrideConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts.
" + } + }, + "guardrailConfiguration": { + "target": "com.amazonaws.bedrockagent#GuardrailConfiguration", + "traits": { + "smithy.api#documentation": "Details about the guardrail associated with the agent.
" + } + }, + "memoryConfiguration": { + "target": "com.amazonaws.bedrockagent#MemoryConfiguration", + "traits": { + "smithy.api#documentation": "Contains memory configuration for the agent.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about an agent.
" + } + }, + "com.amazonaws.bedrockagent#AgentActionGroup": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent to which the action group belongs.
", + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#Version", + "traits": { + "smithy.api#documentation": "The version of the agent to which the action group belongs.
", + "smithy.api#required": {} + } + }, + "actionGroupId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the action group.
", + "smithy.api#required": {} + } + }, + "actionGroupName": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "The name of the action group.
", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagent#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
" + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "The description of the action group.
" + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the action group was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the action group was last updated.
", + "smithy.api#required": {} + } + }, + "parentActionSignature": { + "target": "com.amazonaws.bedrockagent#ActionGroupSignature", + "traits": { + "smithy.api#documentation": "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.
" + } + }, + "actionGroupExecutor": { + "target": "com.amazonaws.bedrockagent#ActionGroupExecutor", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.
" + } + }, + "apiSchema": { + "target": "com.amazonaws.bedrockagent#APISchema", + "traits": { + "smithy.api#documentation": "Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas.
" + } + }, + "functionSchema": { + "target": "com.amazonaws.bedrockagent#FunctionSchema", + "traits": { + "smithy.api#documentation": "Defines functions that each define parameters that the agent needs to invoke from the user. Each function represents an action in an action group.
" + } + }, + "actionGroupState": { + "target": "com.amazonaws.bedrockagent#ActionGroupState", + "traits": { + "smithy.api#documentation": "Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about an action group.
" + } + }, + "com.amazonaws.bedrockagent#AgentAlias": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent.
", + "smithy.api#required": {} + } + }, + "agentAliasId": { + "target": "com.amazonaws.bedrockagent#AgentAliasId", + "traits": { + "smithy.api#documentation": "The unique identifier of the alias of the agent.
", + "smithy.api#required": {} + } + }, + "agentAliasName": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "The name of the alias of the agent.
", + "smithy.api#required": {} + } + }, + "agentAliasArn": { + "target": "com.amazonaws.bedrockagent#AgentAliasArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the alias of the agent.
", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagent#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
" + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "The description of the alias of the agent.
" + } + }, + "routingConfiguration": { + "target": "com.amazonaws.bedrockagent#AgentAliasRoutingConfiguration", + "traits": { + "smithy.api#documentation": "Contains details about the routing configuration of the alias.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the alias of the agent was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the alias was last updated.
", + "smithy.api#required": {} + } + }, + "agentAliasHistoryEvents": { + "target": "com.amazonaws.bedrockagent#AgentAliasHistoryEvents", + "traits": { + "smithy.api#documentation": "Contains details about the history of the alias.
" + } + }, + "agentAliasStatus": { + "target": "com.amazonaws.bedrockagent#AgentAliasStatus", + "traits": { + "smithy.api#documentation": "The status of the alias of the agent and whether it is ready for use. The following statuses are possible:
\nCREATING – The agent alias is being created.
\nPREPARED – The agent alias is finished being created or updated and is ready to be invoked.
\nFAILED – The agent alias API operation failed.
\nUPDATING – The agent alias is being updated.
\nDELETING – The agent alias is being deleted.
\nInformation on the failure of Provisioned Throughput assigned to an agent alias.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about an alias of an agent.
" + } + }, + "com.amazonaws.bedrockagent#AgentAliasArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent-alias/[0-9a-zA-Z]{10}/[0-9a-zA-Z]{10}$" + } + }, + "com.amazonaws.bedrockagent#AgentAliasHistoryEvent": { + "type": "structure", + "members": { + "routingConfiguration": { + "target": "com.amazonaws.bedrockagent#AgentAliasRoutingConfiguration", + "traits": { + "smithy.api#documentation": "Contains details about the version of the agent with which the alias is associated.
" + } + }, + "endDate": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The date that the alias stopped being associated to the version in the routingConfiguration
object
The date that the alias began being associated to the version in the routingConfiguration
object.
Contains details about the history of the alias.
" + } + }, + "com.amazonaws.bedrockagent#AgentAliasHistoryEvents": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#AgentAliasHistoryEvent" + }, + "traits": { + "smithy.api#length": { + "max": 10 + } + } + }, + "com.amazonaws.bedrockagent#AgentAliasId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 10, + "max": 10 + }, + "smithy.api#pattern": "^(\\bTSTALIASID\\b|[0-9a-zA-Z]+)$" + } + }, + "com.amazonaws.bedrockagent#AgentAliasRoutingConfiguration": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#AgentAliasRoutingConfigurationListItem" + }, + "traits": { + "smithy.api#length": { + "max": 1 + } + } + }, + "com.amazonaws.bedrockagent#AgentAliasRoutingConfigurationListItem": { + "type": "structure", + "members": { + "agentVersion": { + "target": "com.amazonaws.bedrockagent#Version", + "traits": { + "smithy.api#documentation": "The version of the agent with which the alias is associated.
" + } + }, + "provisionedThroughput": { + "target": "com.amazonaws.bedrockagent#ProvisionedModelIdentifier", + "traits": { + "smithy.api#documentation": "Information on the Provisioned Throughput assigned to an agent alias.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about the routing configuration of the alias.
" + } + }, + "com.amazonaws.bedrockagent#AgentAliasStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "PREPARED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PREPARED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + } + } + }, + "com.amazonaws.bedrockagent#AgentAliasSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#AgentAliasSummary" + }, + "traits": { + "smithy.api#length": { + "max": 10 + } + } + }, + "com.amazonaws.bedrockagent#AgentAliasSummary": { + "type": "structure", + "members": { + "agentAliasId": { + "target": "com.amazonaws.bedrockagent#AgentAliasId", + "traits": { + "smithy.api#documentation": "Contains details about
", + "smithy.api#required": {} + } + }, + "agentAliasName": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "The name of the alias.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "The description of the alias.
" + } + }, + "routingConfiguration": { + "target": "com.amazonaws.bedrockagent#AgentAliasRoutingConfiguration", + "traits": { + "smithy.api#documentation": "Contains details about the version of the agent with which the alias is associated.
" + } + }, + "agentAliasStatus": { + "target": "com.amazonaws.bedrockagent#AgentAliasStatus", + "traits": { + "smithy.api#documentation": "The status of the alias.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the alias of the agent was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the alias was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about an alias of an agent.
" + } + }, + "com.amazonaws.bedrockagent#AgentArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent/[0-9a-zA-Z]{10}$" + } + }, + "com.amazonaws.bedrockagent#AgentFlowNodeConfiguration": { + "type": "structure", + "members": { + "agentAliasArn": { + "target": "com.amazonaws.bedrockagent#AgentAliasArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the alias of the agent to invoke.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Defines an agent node in your flow. You specify the agent to invoke at this point in the flow. For more information, see Node types in Amazon Bedrock works in the Amazon Bedrock User Guide.
" + } + }, + "com.amazonaws.bedrockagent#AgentKnowledgeBase": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent with which the knowledge base is associated.
", + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#Version", + "traits": { + "smithy.api#documentation": "The version of the agent with which the knowledge base is associated.
", + "smithy.api#required": {} + } + }, + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the association between the agent and the knowledge base.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "The description of the association between the agent and the knowledge base.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the association between the agent and the knowledge base was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the association between the agent and the knowledge base was last updated.
", + "smithy.api#required": {} + } + }, + "knowledgeBaseState": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseState", + "traits": { + "smithy.api#documentation": "Specifies whether to use the knowledge base or not when sending an InvokeAgent request.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about a knowledge base that is associated with an agent.
" + } + }, + "com.amazonaws.bedrockagent#AgentKnowledgeBaseSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#AgentKnowledgeBaseSummary" + }, + "traits": { + "smithy.api#length": { + "max": 10 + } + } + }, + "com.amazonaws.bedrockagent#AgentKnowledgeBaseSummary": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base associated with an agent.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "The description of the knowledge base associated with an agent.
" + } + }, + "knowledgeBaseState": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseState", + "traits": { + "smithy.api#documentation": "Specifies whether the agent uses the knowledge base or not when sending an InvokeAgent request.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the knowledge base associated with an agent was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about a knowledge base associated with an agent.
" + } + }, + "com.amazonaws.bedrockagent#AgentResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrockagent#CreateAgent" + }, + { + "target": "com.amazonaws.bedrockagent#DeleteAgent" + }, + { + "target": "com.amazonaws.bedrockagent#GetAgent" + }, + { + "target": "com.amazonaws.bedrockagent#ListAgents" + }, + { + "target": "com.amazonaws.bedrockagent#PrepareAgent" + }, + { + "target": "com.amazonaws.bedrockagent#UpdateAgent" + } + ] + }, + "com.amazonaws.bedrockagent#AgentRoleArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+$" + } + }, + "com.amazonaws.bedrockagent#AgentStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "PREPARING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PREPARING" + } + }, + "PREPARED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PREPARED" + } + }, + "NOT_PREPARED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_PREPARED" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "VERSIONING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VERSIONING" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + } + } + }, + "com.amazonaws.bedrockagent#AgentSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#AgentSummary" + }, + "traits": { + "smithy.api#length": { + "max": 10 + } + } + }, + "com.amazonaws.bedrockagent#AgentSummary": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent.
", + "smithy.api#required": {} + } + }, + "agentName": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "The name of the agent.
", + "smithy.api#required": {} + } + }, + "agentStatus": { + "target": "com.amazonaws.bedrockagent#AgentStatus", + "traits": { + "smithy.api#documentation": "The status of the agent.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "The description of the agent.
" + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the agent was last updated.
", + "smithy.api#required": {} + } + }, + "latestAgentVersion": { + "target": "com.amazonaws.bedrockagent#Version", + "traits": { + "smithy.api#documentation": "The latest version of the agent.
" + } + }, + "guardrailConfiguration": { + "target": "com.amazonaws.bedrockagent#GuardrailConfiguration", + "traits": { + "smithy.api#documentation": "Details about the guardrail associated with the agent.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about an agent.
" + } + }, + "com.amazonaws.bedrockagent#AgentVersion": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent that the version belongs to.
", + "smithy.api#required": {} + } + }, + "agentName": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "The name of the agent that the version belongs to.
", + "smithy.api#required": {} + } + }, + "agentArn": { + "target": "com.amazonaws.bedrockagent#AgentArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the agent that the version belongs to.
", + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.bedrockagent#NumericalVersion", + "traits": { + "smithy.api#documentation": "The version number.
", + "smithy.api#required": {} + } + }, + "instruction": { + "target": "com.amazonaws.bedrockagent#Instruction", + "traits": { + "smithy.api#documentation": "The instructions provided to the agent.
" + } + }, + "agentStatus": { + "target": "com.amazonaws.bedrockagent#AgentStatus", + "traits": { + "smithy.api#documentation": "The status of the agent that the version belongs to.
", + "smithy.api#required": {} + } + }, + "foundationModel": { + "target": "com.amazonaws.bedrockagent#ModelIdentifier", + "traits": { + "smithy.api#documentation": "The foundation model that the version invokes.
" + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "The description of the version.
" + } + }, + "idleSessionTTLInSeconds": { + "target": "com.amazonaws.bedrockagent#SessionTTL", + "traits": { + "smithy.api#documentation": "The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.
\nA user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.
", + "smithy.api#required": {} + } + }, + "agentResourceRoleArn": { + "target": "com.amazonaws.bedrockagent#AgentRoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
", + "smithy.api#required": {} + } + }, + "customerEncryptionKeyArn": { + "target": "com.amazonaws.bedrockagent#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key that encrypts the agent.
" + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the version was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the version was last updated.
", + "smithy.api#required": {} + } + }, + "failureReasons": { + "target": "com.amazonaws.bedrockagent#FailureReasons", + "traits": { + "smithy.api#documentation": "A list of reasons that the API operation on the version failed.
" + } + }, + "recommendedActions": { + "target": "com.amazonaws.bedrockagent#RecommendedActions", + "traits": { + "smithy.api#documentation": "A list of recommended actions to take for the failed API operation on the version to succeed.
" + } + }, + "promptOverrideConfiguration": { + "target": "com.amazonaws.bedrockagent#PromptOverrideConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts.
" + } + }, + "guardrailConfiguration": { + "target": "com.amazonaws.bedrockagent#GuardrailConfiguration", + "traits": { + "smithy.api#documentation": "Details about the guardrail associated with the agent.
" + } + }, + "memoryConfiguration": { + "target": "com.amazonaws.bedrockagent#MemoryConfiguration", + "traits": { + "smithy.api#documentation": "\n Contains details of the memory configuration on the version of the agent. \n
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about a version of an agent.
" + } + }, + "com.amazonaws.bedrockagent#AgentVersionSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#AgentVersionSummary" + }, + "traits": { + "smithy.api#length": { + "max": 10 + } + } + }, + "com.amazonaws.bedrockagent#AgentVersionSummary": { + "type": "structure", + "members": { + "agentName": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "The name of the agent to which the version belongs.
", + "smithy.api#required": {} + } + }, + "agentStatus": { + "target": "com.amazonaws.bedrockagent#AgentStatus", + "traits": { + "smithy.api#documentation": "The status of the agent to which the version belongs.
", + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#Version", + "traits": { + "smithy.api#documentation": "The version of the agent.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the version was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the version was last updated.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "The description of the version of the agent.
" + } + }, + "guardrailConfiguration": { + "target": "com.amazonaws.bedrockagent#GuardrailConfiguration", + "traits": { + "smithy.api#documentation": "Details about the guardrail associated with the agent.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about a version of an agent.
" + } + }, + "com.amazonaws.bedrockagent#AliasResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrockagent#CreateAgentAlias" + }, + { + "target": "com.amazonaws.bedrockagent#DeleteAgentAlias" + }, + { + "target": "com.amazonaws.bedrockagent#GetAgentAlias" + }, + { + "target": "com.amazonaws.bedrockagent#ListAgentAliases" + }, + { + "target": "com.amazonaws.bedrockagent#UpdateAgentAlias" + } + ] + }, + "com.amazonaws.bedrockagent#AmazonBedrockAgentBuildTimeLambda": { + "type": "service", + "version": "2023-06-05", + "resources": [ + { + "target": "com.amazonaws.bedrockagent#ActionGroupResource" }, - "com.amazonaws.bedrockagent#AccessDeniedException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.bedrockagent#NonBlankString" - } - }, - "traits": { - "smithy.api#documentation": "The request is denied because of missing access permissions.
", - "smithy.api#error": "client", - "smithy.api#httpError": 403 - } + { + "target": "com.amazonaws.bedrockagent#AgentResource" }, - "com.amazonaws.bedrockagent#ActionGroupExecutor": { - "type": "union", - "members": { - "lambda": { - "target": "com.amazonaws.bedrockagent#LambdaArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.
" - } - }, - "customControl": { - "target": "com.amazonaws.bedrockagent#CustomControlMethod", - "traits": { - "smithy.api#documentation": "To return the action group invocation results directly in the InvokeAgent
response, specify RETURN_CONTROL
.
Contains details about the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.
" - } + { + "target": "com.amazonaws.bedrockagent#AliasResource" }, - "com.amazonaws.bedrockagent#ActionGroupResource": { - "type": "resource", - "operations": [ - { - "target": "com.amazonaws.bedrockagent#CreateAgentActionGroup" - }, - { - "target": "com.amazonaws.bedrockagent#DeleteAgentActionGroup" - }, - { - "target": "com.amazonaws.bedrockagent#GetAgentActionGroup" - }, - { - "target": "com.amazonaws.bedrockagent#ListAgentActionGroups" - }, - { - "target": "com.amazonaws.bedrockagent#UpdateAgentActionGroup" - } - ] - }, - "com.amazonaws.bedrockagent#ActionGroupSignature": { - "type": "enum", - "members": { - "AMAZON_USERINPUT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AMAZON.UserInput" - } - }, - "AMAZON_CODEINTERPRETER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AMAZON.CodeInterpreter" - } - } - } + { + "target": "com.amazonaws.bedrockagent#DataSourceResource" }, - "com.amazonaws.bedrockagent#ActionGroupState": { - "type": "enum", - "members": { - "ENABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENABLED" - } - }, - "DISABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISABLED" - } - } - } + { + "target": "com.amazonaws.bedrockagent#FlowResource" }, - "com.amazonaws.bedrockagent#ActionGroupSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagent#ActionGroupSummary" - }, - "traits": { - "smithy.api#length": { - "max": 10 - } - } + { + "target": "com.amazonaws.bedrockagent#IngestionJobResource" }, - "com.amazonaws.bedrockagent#ActionGroupSummary": { - "type": "structure", - "members": { - "actionGroupId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the action group.
", - "smithy.api#required": {} - } - }, - "actionGroupName": { - "target": "com.amazonaws.bedrockagent#Name", - "traits": { - "smithy.api#documentation": "The name of the action group.
", - "smithy.api#required": {} - } - }, - "actionGroupState": { - "target": "com.amazonaws.bedrockagent#ActionGroupState", - "traits": { - "smithy.api#documentation": "Specifies whether the action group is available for the agent to invoke or not when\n sending an InvokeAgent\n request.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#Description", - "traits": { - "smithy.api#documentation": "The description of the action group.
" - } - }, - "updatedAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the action group was last updated.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains details about an action group.
" - } + { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseResource" }, - "com.amazonaws.bedrockagent#Agent": { - "type": "structure", - "members": { - "agentId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the agent.
", - "smithy.api#required": {} - } - }, - "agentName": { - "target": "com.amazonaws.bedrockagent#Name", - "traits": { - "smithy.api#documentation": "The name of the agent.
", - "smithy.api#required": {} - } - }, - "agentArn": { - "target": "com.amazonaws.bedrockagent#AgentArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the agent.
", - "smithy.api#required": {} - } - }, - "agentVersion": { - "target": "com.amazonaws.bedrockagent#DraftVersion", - "traits": { - "smithy.api#documentation": "The version of the agent.
", - "smithy.api#required": {} - } - }, - "clientToken": { - "target": "com.amazonaws.bedrockagent#ClientToken", - "traits": { - "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
" - } - }, - "instruction": { - "target": "com.amazonaws.bedrockagent#Instruction", - "traits": { - "smithy.api#documentation": "Instructions that tell the agent what it should do and how it should interact with users.
" - } - }, - "agentStatus": { - "target": "com.amazonaws.bedrockagent#AgentStatus", - "traits": { - "smithy.api#documentation": "The status of the agent and whether it is ready for use. The following statuses are possible:
\nCREATING – The agent is being created.
\nPREPARING – The agent is being prepared.
\nPREPARED – The agent is prepared and ready to be invoked.
\nNOT_PREPARED – The agent has been created but not yet prepared.
\nFAILED – The agent API operation failed.
\nUPDATING – The agent is being updated.
\nDELETING – The agent is being deleted.
\nThe foundation model used for orchestration by the agent.
" - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#Description", - "traits": { - "smithy.api#documentation": "The description of the agent.
" - } - }, - "idleSessionTTLInSeconds": { - "target": "com.amazonaws.bedrockagent#SessionTTL", - "traits": { - "smithy.api#documentation": "The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.
\nA user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.
", - "smithy.api#required": {} - } - }, - "agentResourceRoleArn": { - "target": "com.amazonaws.bedrockagent#AgentRoleArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
", - "smithy.api#required": {} - } - }, - "customerEncryptionKeyArn": { - "target": "com.amazonaws.bedrockagent#KmsKeyArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key that encrypts the agent.
" - } - }, - "createdAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the agent was created.
", - "smithy.api#required": {} - } - }, - "updatedAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the agent was last updated.
", - "smithy.api#required": {} - } - }, - "preparedAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the agent was last prepared.
" - } - }, - "failureReasons": { - "target": "com.amazonaws.bedrockagent#FailureReasons", - "traits": { - "smithy.api#documentation": "Contains reasons that the agent-related API that you invoked failed.
" - } - }, - "recommendedActions": { - "target": "com.amazonaws.bedrockagent#RecommendedActions", - "traits": { - "smithy.api#documentation": "Contains recommended actions to take for the agent-related API that you invoked to succeed.
" - } - }, - "promptOverrideConfiguration": { - "target": "com.amazonaws.bedrockagent#PromptOverrideConfiguration", - "traits": { - "smithy.api#documentation": "Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts.
" - } - }, - "guardrailConfiguration": { - "target": "com.amazonaws.bedrockagent#GuardrailConfiguration", - "traits": { - "smithy.api#documentation": "Details about the guardrail associated with the agent.
" - } - }, - "memoryConfiguration": { - "target": "com.amazonaws.bedrockagent#MemoryConfiguration", - "traits": { - "smithy.api#documentation": "Contains memory configuration for the agent.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains details about an agent.
" - } + { + "target": "com.amazonaws.bedrockagent#PromptResource" }, - "com.amazonaws.bedrockagent#AgentActionGroup": { - "type": "structure", - "members": { - "agentId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the agent to which the action group belongs.
", - "smithy.api#required": {} - } - }, - "agentVersion": { - "target": "com.amazonaws.bedrockagent#Version", - "traits": { - "smithy.api#documentation": "The version of the agent to which the action group belongs.
", - "smithy.api#required": {} - } - }, - "actionGroupId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the action group.
", - "smithy.api#required": {} - } - }, - "actionGroupName": { - "target": "com.amazonaws.bedrockagent#Name", - "traits": { - "smithy.api#documentation": "The name of the action group.
", - "smithy.api#required": {} - } - }, - "clientToken": { - "target": "com.amazonaws.bedrockagent#ClientToken", - "traits": { - "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
" - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#Description", - "traits": { - "smithy.api#documentation": "The description of the action group.
" - } - }, - "createdAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the action group was created.
", - "smithy.api#required": {} - } - }, - "updatedAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the action group was last updated.
", - "smithy.api#required": {} - } - }, - "parentActionSignature": { - "target": "com.amazonaws.bedrockagent#ActionGroupSignature", - "traits": { - "smithy.api#documentation": "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.
" - } - }, - "actionGroupExecutor": { - "target": "com.amazonaws.bedrockagent#ActionGroupExecutor", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.
" - } - }, - "apiSchema": { - "target": "com.amazonaws.bedrockagent#APISchema", - "traits": { - "smithy.api#documentation": "Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas.
" - } - }, - "functionSchema": { - "target": "com.amazonaws.bedrockagent#FunctionSchema", - "traits": { - "smithy.api#documentation": "Defines functions that each define parameters that the agent needs to invoke from the user. Each function represents an action in an action group.
" - } - }, - "actionGroupState": { - "target": "com.amazonaws.bedrockagent#ActionGroupState", - "traits": { - "smithy.api#documentation": "Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains details about an action group.
" - } + { + "target": "com.amazonaws.bedrockagent#TaggingResource" }, - "com.amazonaws.bedrockagent#AgentAlias": { - "type": "structure", - "members": { - "agentId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the agent.
", - "smithy.api#required": {} - } - }, - "agentAliasId": { - "target": "com.amazonaws.bedrockagent#AgentAliasId", - "traits": { - "smithy.api#documentation": "The unique identifier of the alias of the agent.
", - "smithy.api#required": {} - } - }, - "agentAliasName": { - "target": "com.amazonaws.bedrockagent#Name", - "traits": { - "smithy.api#documentation": "The name of the alias of the agent.
", - "smithy.api#required": {} - } - }, - "agentAliasArn": { - "target": "com.amazonaws.bedrockagent#AgentAliasArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the alias of the agent.
", - "smithy.api#required": {} - } - }, - "clientToken": { - "target": "com.amazonaws.bedrockagent#ClientToken", - "traits": { - "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
" - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#Description", - "traits": { - "smithy.api#documentation": "The description of the alias of the agent.
" - } - }, - "routingConfiguration": { - "target": "com.amazonaws.bedrockagent#AgentAliasRoutingConfiguration", - "traits": { - "smithy.api#documentation": "Contains details about the routing configuration of the alias.
", - "smithy.api#required": {} - } - }, - "createdAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the alias of the agent was created.
", - "smithy.api#required": {} - } - }, - "updatedAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the alias was last updated.
", - "smithy.api#required": {} - } - }, - "agentAliasHistoryEvents": { - "target": "com.amazonaws.bedrockagent#AgentAliasHistoryEvents", - "traits": { - "smithy.api#documentation": "Contains details about the history of the alias.
" - } - }, - "agentAliasStatus": { - "target": "com.amazonaws.bedrockagent#AgentAliasStatus", - "traits": { - "smithy.api#documentation": "The status of the alias of the agent and whether it is ready for use. The following statuses are possible:
\nCREATING – The agent alias is being created.
\nPREPARED – The agent alias is finished being created or updated and is ready to be invoked.
\nFAILED – The agent alias API operation failed.
\nUPDATING – The agent alias is being updated.
\nDELETING – The agent alias is being deleted.
\nDescribes the API operations for creating and managing Amazon Bedrock agents.
", + "smithy.api#title": "Agents for Amazon Bedrock", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" }, - "failureReasons": { - "target": "com.amazonaws.bedrockagent#FailureReasons", - "traits": { - "smithy.api#documentation": "Information on the failure of Provisioned Throughput assigned to an agent alias.
" + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" } + ], + "type": "tree" } + ], + "type": "tree" }, - "traits": { - "smithy.api#documentation": "Contains details about an alias of an agent.
" - } - }, - "com.amazonaws.bedrockagent#AgentAliasArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 2048 - }, - "smithy.api#pattern": "^arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent-alias/[0-9a-zA-Z]{10}/[0-9a-zA-Z]{10}$" - } - }, - "com.amazonaws.bedrockagent#AgentAliasHistoryEvent": { - "type": "structure", - "members": { - "routingConfiguration": { - "target": "com.amazonaws.bedrockagent#AgentAliasRoutingConfiguration", - "traits": { - "smithy.api#documentation": "Contains details about the version of the agent with which the alias is associated.
" - } - }, - "endDate": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The date that the alias stopped being associated to the version in the routingConfiguration
object
The date that the alias began being associated to the version in the routingConfiguration
object.
Contains details about the history of the alias.
" - } - }, - "com.amazonaws.bedrockagent#AgentAliasHistoryEvents": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagent#AgentAliasHistoryEvent" - }, - "traits": { - "smithy.api#length": { - "max": 10 - } - } - }, - "com.amazonaws.bedrockagent#AgentAliasId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 10, - "max": 10 + ], + "type": "tree" }, - "smithy.api#pattern": "^(\\bTSTALIASID\\b|[0-9a-zA-Z]+)$" - } - }, - "com.amazonaws.bedrockagent#AgentAliasRoutingConfiguration": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagent#AgentAliasRoutingConfigurationListItem" - }, - "traits": { - "smithy.api#length": { - "max": 1 + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" } + ], + "type": "tree" } + ] }, - "com.amazonaws.bedrockagent#AgentAliasRoutingConfigurationListItem": { - "type": "structure", - "members": { - "agentVersion": { - "target": "com.amazonaws.bedrockagent#Version", - "traits": { - "smithy.api#documentation": "The version of the agent with which the alias is associated.
" - } - }, - "provisionedThroughput": { - "target": "com.amazonaws.bedrockagent#ProvisionedModelIdentifier", - "traits": { - "smithy.api#documentation": "Information on the Provisioned Throughput assigned to an agent alias.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains details about the routing configuration of the alias.
" - } - }, - "com.amazonaws.bedrockagent#AgentAliasStatus": { - "type": "enum", - "members": { - "CREATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATING" - } - }, - "PREPARED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PREPARED" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "UPDATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATING" - } - }, - "DELETING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETING" - } - } - } - }, - "com.amazonaws.bedrockagent#AgentAliasSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagent#AgentAliasSummary" - }, - "traits": { - "smithy.api#length": { - "max": 10 - } - } - }, - "com.amazonaws.bedrockagent#AgentAliasSummary": { - "type": "structure", - "members": { - "agentAliasId": { - "target": "com.amazonaws.bedrockagent#AgentAliasId", - "traits": { - "smithy.api#documentation": "Contains details about
", - "smithy.api#required": {} - } - }, - "agentAliasName": { - "target": "com.amazonaws.bedrockagent#Name", - "traits": { - "smithy.api#documentation": "The name of the alias.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#Description", - "traits": { - "smithy.api#documentation": "The description of the alias.
" - } - }, - "routingConfiguration": { - "target": "com.amazonaws.bedrockagent#AgentAliasRoutingConfiguration", - "traits": { - "smithy.api#documentation": "Contains details about the version of the agent with which the alias is associated.
" - } - }, - "agentAliasStatus": { - "target": "com.amazonaws.bedrockagent#AgentAliasStatus", - "traits": { - "smithy.api#documentation": "The status of the alias.
", - "smithy.api#required": {} - } - }, - "createdAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the alias of the agent was created.
", - "smithy.api#required": {} - } - }, - "updatedAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the alias was last updated.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains details about an alias of an agent.
" - } - }, - "com.amazonaws.bedrockagent#AgentArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 2048 - }, - "smithy.api#pattern": "^arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent/[0-9a-zA-Z]{10}$" - } - }, - "com.amazonaws.bedrockagent#AgentFlowNodeConfiguration": { - "type": "structure", - "members": { - "agentAliasArn": { - "target": "com.amazonaws.bedrockagent#AgentAliasArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the alias of the agent to invoke.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Defines an agent node in your flow. You specify the agent to invoke at this point in the flow. For more information, see Node types in Amazon Bedrock works in the Amazon Bedrock User Guide.
" - } - }, - "com.amazonaws.bedrockagent#AgentKnowledgeBase": { - "type": "structure", - "members": { - "agentId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the agent with which the knowledge base is associated.
", - "smithy.api#required": {} - } - }, - "agentVersion": { - "target": "com.amazonaws.bedrockagent#Version", - "traits": { - "smithy.api#documentation": "The version of the agent with which the knowledge base is associated.
", - "smithy.api#required": {} - } - }, - "knowledgeBaseId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the association between the agent and the knowledge base.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#Description", - "traits": { - "smithy.api#documentation": "The description of the association between the agent and the knowledge base.
", - "smithy.api#required": {} - } - }, - "createdAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the association between the agent and the knowledge base was created.
", - "smithy.api#required": {} - } - }, - "updatedAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the association between the agent and the knowledge base was last updated.
", - "smithy.api#required": {} - } - }, - "knowledgeBaseState": { - "target": "com.amazonaws.bedrockagent#KnowledgeBaseState", - "traits": { - "smithy.api#documentation": "Specifies whether to use the knowledge base or not when sending an InvokeAgent request.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains details about a knowledge base that is associated with an agent.
" - } - }, - "com.amazonaws.bedrockagent#AgentKnowledgeBaseSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagent#AgentKnowledgeBaseSummary" - }, - "traits": { - "smithy.api#length": { - "max": 10 - } - } - }, - "com.amazonaws.bedrockagent#AgentKnowledgeBaseSummary": { - "type": "structure", - "members": { - "knowledgeBaseId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the knowledge base associated with an agent.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#Description", - "traits": { - "smithy.api#documentation": "The description of the knowledge base associated with an agent.
" - } - }, - "knowledgeBaseState": { - "target": "com.amazonaws.bedrockagent#KnowledgeBaseState", - "traits": { - "smithy.api#documentation": "Specifies whether the agent uses the knowledge base or not when sending an InvokeAgent request.
", - "smithy.api#required": {} - } - }, - "updatedAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the knowledge base associated with an agent was last updated.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains details about a knowledge base associated with an agent.
" - } - }, - "com.amazonaws.bedrockagent#AgentResource": { - "type": "resource", - "operations": [ - { - "target": "com.amazonaws.bedrockagent#CreateAgent" - }, - { - "target": "com.amazonaws.bedrockagent#DeleteAgent" - }, - { - "target": "com.amazonaws.bedrockagent#GetAgent" - }, - { - "target": "com.amazonaws.bedrockagent#ListAgents" - }, - { - "target": "com.amazonaws.bedrockagent#PrepareAgent" - }, - { - "target": "com.amazonaws.bedrockagent#UpdateAgent" - } - ] - }, - "com.amazonaws.bedrockagent#AgentRoleArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 2048 - }, - "smithy.api#pattern": "^arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+$" - } - }, - "com.amazonaws.bedrockagent#AgentStatus": { - "type": "enum", - "members": { - "CREATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATING" - } - }, - "PREPARING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PREPARING" - } - }, - "PREPARED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PREPARED" - } - }, - "NOT_PREPARED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NOT_PREPARED" - } - }, - "DELETING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETING" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "VERSIONING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VERSIONING" - } - }, - "UPDATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATING" - } - } - } - }, - "com.amazonaws.bedrockagent#AgentSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagent#AgentSummary" - }, - "traits": { - "smithy.api#length": { - "max": 10 - } - } + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-agent.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.bedrockagent#AssociateAgentKnowledgeBase": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#AssociateAgentKnowledgeBaseRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#AssociateAgentKnowledgeBaseResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Associates a knowledge base with an agent. If a knowledge base is associated and its indexState
is set to Enabled
, the agent queries the knowledge base for information to augment its response to the user.
The unique identifier of the agent with which you want to associate the knowledge base.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#DraftVersion", + "traits": { + "smithy.api#documentation": "The version of the agent with which you want to associate the knowledge base.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base to associate with the agent.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "A description of what the agent should use the knowledge base for.
", + "smithy.api#required": {} + } + }, + "knowledgeBaseState": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseState", + "traits": { + "smithy.api#documentation": "Specifies whether to use the knowledge base or not when sending an InvokeAgent request.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#AssociateAgentKnowledgeBaseResponse": { + "type": "structure", + "members": { + "agentKnowledgeBase": { + "target": "com.amazonaws.bedrockagent#AgentKnowledgeBase", + "traits": { + "smithy.api#documentation": "Contains details about the knowledge base that has been associated with the agent.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#BasePromptTemplate": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100000 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#BedrockEmbeddingModelArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|([0-9]{12}:provisioned-model/[a-z0-9]{12})))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|(([0-9a-zA-Z][_-]?)+)$" + } + }, + "com.amazonaws.bedrockagent#BedrockEmbeddingModelConfiguration": { + "type": "structure", + "members": { + "dimensions": { + "target": "com.amazonaws.bedrockagent#Dimensions", + "traits": { + "smithy.api#documentation": "The dimensions details for the vector configuration used on the Bedrock embeddings model.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The vector configuration details for the Bedrock embeddings model.
" + } + }, + "com.amazonaws.bedrockagent#BedrockFoundationModelConfiguration": { + "type": "structure", + "members": { + "modelArn": { + "target": "com.amazonaws.bedrockagent#BedrockModelArn", + "traits": { + "smithy.api#documentation": "The ARN of the foundation model or inference profile.
", + "smithy.api#required": {} + } + }, + "parsingPrompt": { + "target": "com.amazonaws.bedrockagent#ParsingPrompt", + "traits": { + "smithy.api#documentation": "Instructions for interpreting the contents of a document.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Settings for a foundation model or inference profile used to parse documents for a data source.
" + } + }, + "com.amazonaws.bedrockagent#BedrockModelArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model/([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})|(arn:aws(|-us-gov|-cn|-iso|-iso-b):bedrock:(|[0-9a-z-]{1,20}):(|[0-9]{12}):inference-profile/[a-zA-Z0-9-:.]+)$" + } + }, + "com.amazonaws.bedrockagent#BucketOwnerAccountId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 12 + }, + "smithy.api#pattern": "^[0-9]{12}$" + } + }, + "com.amazonaws.bedrockagent#ChunkingConfiguration": { + "type": "structure", + "members": { + "chunkingStrategy": { + "target": "com.amazonaws.bedrockagent#ChunkingStrategy", + "traits": { + "smithy.api#documentation": "Knowledge base can split your source data into chunks. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. You have the following options for chunking your data. If you opt for NONE
, then you may want to pre-process your files by splitting them up such that each file corresponds to a chunk.
\n FIXED_SIZE
– Amazon Bedrock splits your source data into chunks of the approximate size that you set in the fixedSizeChunkingConfiguration
.
\n HIERARCHICAL
– Split documents into layers of chunks where the first layer contains large chunks, and the second layer contains smaller chunks derived from the first layer.
\n SEMANTIC
– Split documents into chunks based on groups of similar content derived with natural language processing.
\n NONE
– Amazon Bedrock treats each file as one chunk. If you choose this option, you may want to pre-process your documents by splitting them into separate files.
Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy
as NONE
, exclude this field.
Settings for hierarchical document chunking for a data source. Hierarchical chunking splits documents\n into layers of chunks where the first layer contains large chunks, and the second layer contains smaller\n chunks derived from the first layer.
" + } + }, + "semanticChunkingConfiguration": { + "target": "com.amazonaws.bedrockagent#SemanticChunkingConfiguration", + "traits": { + "smithy.api#documentation": "Settings for semantic document chunking for a data source. Semantic chunking splits\n a document into into smaller documents based on groups of similar content derived from the text\n with natural language processing.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.
" + } + }, + "com.amazonaws.bedrockagent#ChunkingStrategy": { + "type": "enum", + "members": { + "FIXED_SIZE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FIXED_SIZE" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + }, + "HIERARCHICAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HIERARCHICAL" + } + }, + "SEMANTIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SEMANTIC" + } + } + } + }, + "com.amazonaws.bedrockagent#ClientToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 33, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,256}$" + } + }, + "com.amazonaws.bedrockagent#CollectorFlowNodeConfiguration": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "Defines a collector node in your flow. This node takes an iteration of inputs and consolidates them into an array in the output. For more information, see Node types in Amazon Bedrock works in the Amazon Bedrock User Guide.
" + } + }, + "com.amazonaws.bedrockagent#ColumnName": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_\\-]+$" + } + }, + "com.amazonaws.bedrockagent#ConditionFlowNodeConfiguration": { + "type": "structure", + "members": { + "conditions": { + "target": "com.amazonaws.bedrockagent#FlowConditions", + "traits": { + "smithy.api#documentation": "An array of conditions. Each member contains the name of a condition and an expression that defines the condition.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Defines a condition node in your flow. You can specify conditions that determine which node comes next in the flow. For more information, see Node types in Amazon Bedrock works in the Amazon Bedrock User Guide.
" + } + }, + "com.amazonaws.bedrockagent#ConflictException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrockagent#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "There was a conflict performing an operation.
", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.bedrockagent#ConfluenceAuthType": { + "type": "enum", + "members": { + "BASIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BASIC" + } + }, + "OAUTH2_CLIENT_CREDENTIALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OAUTH2_CLIENT_CREDENTIALS" + } + } + } + }, + "com.amazonaws.bedrockagent#ConfluenceCrawlerConfiguration": { + "type": "structure", + "members": { + "filterConfiguration": { + "target": "com.amazonaws.bedrockagent#CrawlFilterConfiguration", + "traits": { + "smithy.api#documentation": "The configuration of filtering the Confluence content. For example, configuring \n regular expression patterns to include or exclude certain content.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration of the Confluence content. For example, configuring specific \n types of Confluence content.
" + } + }, + "com.amazonaws.bedrockagent#ConfluenceDataSourceConfiguration": { + "type": "structure", + "members": { + "sourceConfiguration": { + "target": "com.amazonaws.bedrockagent#ConfluenceSourceConfiguration", + "traits": { + "smithy.api#documentation": "The endpoint information to connect to your Confluence data source.
", + "smithy.api#required": {} + } + }, + "crawlerConfiguration": { + "target": "com.amazonaws.bedrockagent#ConfluenceCrawlerConfiguration", + "traits": { + "smithy.api#documentation": "The configuration of the Confluence content. For example, configuring \n specific types of Confluence content.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration information to connect to Confluence as your data source.
" + } + }, + "com.amazonaws.bedrockagent#ConfluenceHostType": { + "type": "enum", + "members": { + "SAAS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SAAS" + } + } + } + }, + "com.amazonaws.bedrockagent#ConfluenceSourceConfiguration": { + "type": "structure", + "members": { + "hostUrl": { + "target": "com.amazonaws.bedrockagent#HttpsUrl", + "traits": { + "smithy.api#documentation": "The Confluence host URL or instance URL.
", + "smithy.api#required": {} + } + }, + "hostType": { + "target": "com.amazonaws.bedrockagent#ConfluenceHostType", + "traits": { + "smithy.api#documentation": "The supported host type, whether online/cloud or server/on-premises.
", + "smithy.api#required": {} + } + }, + "authType": { + "target": "com.amazonaws.bedrockagent#ConfluenceAuthType", + "traits": { + "smithy.api#documentation": "The supported authentication type to authenticate and connect to your \n Confluence instance.
", + "smithy.api#required": {} + } + }, + "credentialsSecretArn": { + "target": "com.amazonaws.bedrockagent#SecretArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name of an Secrets Manager secret that \n stores your authentication credentials for your Confluence instance URL. \n For more information on the key-value pairs that must be included in \n your secret, depending on your authentication type, see \n Confluence connection configuration.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The endpoint information to connect to your Confluence data source.
" + } + }, + "com.amazonaws.bedrockagent#CrawlFilterConfiguration": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrockagent#CrawlFilterConfigurationType", + "traits": { + "smithy.api#documentation": "The type of filtering that you want to apply to certain objects or content of the \n data source. For example, the PATTERN
type is regular expression patterns \n you can apply to filter your content.
The configuration of filtering certain objects or content types of the data source.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration of filtering the data source content. For example, \n configuring regular expression patterns to include or exclude certain content.
" + } + }, + "com.amazonaws.bedrockagent#CrawlFilterConfigurationType": { + "type": "enum", + "members": { + "PATTERN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PATTERN" + } + } + } + }, + "com.amazonaws.bedrockagent#CreateAgent": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#CreateAgentRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#CreateAgentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an agent that orchestrates interactions between foundation models, data sources, software applications, user conversations, and APIs to carry out tasks to help customers.
\nSpecify the following fields for security purposes.
\n\n agentResourceRoleArn
– The Amazon Resource Name (ARN) of the role with permissions to invoke API operations on an agent.
(Optional) customerEncryptionKeyArn
– The Amazon Resource Name (ARN) of a KMS key to encrypt the creation of the agent.
(Optional) idleSessionTTLinSeconds
– Specify the number of seconds for which the agent should maintain session information. After this time expires, the subsequent InvokeAgent
request begins a new session.
To enable your agent to retain conversational context across multiple sessions, include a memoryConfiguration
object. \n For more information, see Configure memory.
To override the default prompt behavior for agent orchestration and to use advanced prompts, include a promptOverrideConfiguration
object. \n For more information, see Advanced prompts.
If your agent fails to be created, the response returns a list of failureReasons
alongside a list of recommendedActions
for you to troubleshoot.
The agent instructions will not be honored if your agent has only one knowledge base, uses default prompts, has no action group, and user input is disabled.
\nCreates 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.
\nTo allow your agent to request the user for additional information when trying to complete a task, \n 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, \n 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.
The unique identifier of the agent for which to create the action group.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#DraftVersion", + "traits": { + "smithy.api#documentation": "The version of the agent for which to create the action group.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "actionGroupName": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "The name to give the action group.
", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagent#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", + "smithy.api#idempotencyToken": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "A description of the action group.
" + } + }, + "parentActionGroupSignature": { + "target": "com.amazonaws.bedrockagent#ActionGroupSignature", + "traits": { + "smithy.api#documentation": "To allow your agent to request the user for additional information when trying to complete a task, set this field to AMAZON.UserInput
. You must leave the description
, apiSchema
, and actionGroupExecutor
fields blank for this action group.
To allow your agent to generate, run, and troubleshoot code when trying to complete a task, set this field 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.
" + } + }, + "actionGroupExecutor": { + "target": "com.amazonaws.bedrockagent#ActionGroupExecutor", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.
" + } + }, + "apiSchema": { + "target": "com.amazonaws.bedrockagent#APISchema", + "traits": { + "smithy.api#documentation": "Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas.
" + } + }, + "actionGroupState": { + "target": "com.amazonaws.bedrockagent#ActionGroupState", + "traits": { + "smithy.api#documentation": "Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
" + } + }, + "functionSchema": { + "target": "com.amazonaws.bedrockagent#FunctionSchema", + "traits": { + "smithy.api#documentation": "Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#CreateAgentActionGroupResponse": { + "type": "structure", + "members": { + "agentActionGroup": { + "target": "com.amazonaws.bedrockagent#AgentActionGroup", + "traits": { + "smithy.api#documentation": "Contains details about the action group that was created.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#CreateAgentAlias": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#CreateAgentAliasRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#CreateAgentAliasResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an alias of an agent that can be used to deploy the agent.
", + "smithy.api#http": { + "code": 202, + "method": "PUT", + "uri": "/agents/{agentId}/agentaliases/" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": ["console"] + } + }, + "com.amazonaws.bedrockagent#CreateAgentAliasRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentAliasName": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "The name of the alias.
", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagent#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", + "smithy.api#idempotencyToken": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "A description of the alias of the agent.
" + } + }, + "routingConfiguration": { + "target": "com.amazonaws.bedrockagent#AgentAliasRoutingConfiguration", + "traits": { + "smithy.api#documentation": "Contains details about the routing configuration of the alias.
" + } + }, + "tags": { + "target": "com.amazonaws.bedrockagent#TagsMap", + "traits": { + "smithy.api#documentation": "Any tags that you want to attach to the alias of the agent.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#CreateAgentAliasResponse": { + "type": "structure", + "members": { + "agentAlias": { + "target": "com.amazonaws.bedrockagent#AgentAlias", + "traits": { + "smithy.api#documentation": "Contains details about the alias that was created.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#CreateAgentRequest": { + "type": "structure", + "members": { + "agentName": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "A name for the agent that you create.
", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagent#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", + "smithy.api#idempotencyToken": {} + } + }, + "instruction": { + "target": "com.amazonaws.bedrockagent#Instruction", + "traits": { + "smithy.api#documentation": "Instructions that tell the agent what it should do and how it should interact with users.
" + } + }, + "foundationModel": { + "target": "com.amazonaws.bedrockagent#ModelIdentifier", + "traits": { + "smithy.api#documentation": "The foundation model to be used for orchestration by the agent you create.
" + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "A description of the agent.
" + } + }, + "idleSessionTTLInSeconds": { + "target": "com.amazonaws.bedrockagent#SessionTTL", + "traits": { + "smithy.api#documentation": "The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.
\nA user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.
" + } + }, + "agentResourceRoleArn": { + "target": "com.amazonaws.bedrockagent#AgentRoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
" + } + }, + "customerEncryptionKeyArn": { + "target": "com.amazonaws.bedrockagent#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.
" + } + }, + "tags": { + "target": "com.amazonaws.bedrockagent#TagsMap", + "traits": { + "smithy.api#documentation": "Any tags that you want to attach to the agent.
" + } + }, + "promptOverrideConfiguration": { + "target": "com.amazonaws.bedrockagent#PromptOverrideConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.
" + } + }, + "guardrailConfiguration": { + "target": "com.amazonaws.bedrockagent#GuardrailConfiguration", + "traits": { + "smithy.api#documentation": "The unique Guardrail configuration assigned to the agent when it is created.
" + } + }, + "memoryConfiguration": { + "target": "com.amazonaws.bedrockagent#MemoryConfiguration", + "traits": { + "smithy.api#documentation": "Contains the details of the memory configured for the agent.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#CreateAgentResponse": { + "type": "structure", + "members": { + "agent": { + "target": "com.amazonaws.bedrockagent#Agent", + "traits": { + "smithy.api#documentation": "Contains details about the agent created.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#CreateDataSource": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#CreateDataSourceRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#CreateDataSourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a data source connector for a knowledge base.
\nYou can't change the chunkingConfiguration
after you create the data source connector.
The unique identifier of the knowledge base to which to add the data source.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagent#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", + "smithy.api#idempotencyToken": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "The name of the data source.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "A description of the data source.
" + } + }, + "dataSourceConfiguration": { + "target": "com.amazonaws.bedrockagent#DataSourceConfiguration", + "traits": { + "smithy.api#documentation": "The connection configuration for the data source.
", + "smithy.api#required": {} + } + }, + "dataDeletionPolicy": { + "target": "com.amazonaws.bedrockagent#DataDeletionPolicy", + "traits": { + "smithy.api#documentation": "The data deletion policy for the data source.
\nYou can set the data deletion policy to:
\nDELETE: Deletes all data from your data source that’s converted \n into vector embeddings upon deletion of a knowledge base or data source resource. \n Note that the vector store itself is not deleted, \n only the data. This flag is ignored if an Amazon Web Services account is deleted.
\nRETAIN: Retains all data from your data source that’s converted \n into vector embeddings upon deletion of a knowledge base or data source resource. \n Note that the vector store itself is not deleted \n if you delete a knowledge base or data source resource.
\nContains details about the server-side encryption for the data source.
" + } + }, + "vectorIngestionConfiguration": { + "target": "com.amazonaws.bedrockagent#VectorIngestionConfiguration", + "traits": { + "smithy.api#documentation": "Contains details about how to ingest the documents in the data source.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#CreateDataSourceResponse": { + "type": "structure", + "members": { + "dataSource": { + "target": "com.amazonaws.bedrockagent#DataSource", + "traits": { + "smithy.api#documentation": "Contains details about the data source.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#CreateFlow": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#CreateFlowRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#CreateFlowResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a prompt flow that you can use to send an input through various steps to yield an output. Configure nodes, each of which corresponds to a step of the flow, and create connections between the nodes to create paths to different outputs. For more information, see How it works and Create a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/flows/" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": ["console"] + } + }, + "com.amazonaws.bedrockagent#CreateFlowAlias": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#CreateFlowAliasRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#CreateFlowAliasResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an alias of a flow for deployment. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/flows/{flowIdentifier}/aliases" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": ["console"] + } + }, + "com.amazonaws.bedrockagent#CreateFlowAliasRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "A name for the alias.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "A description for the alias.
" + } + }, + "routingConfiguration": { + "target": "com.amazonaws.bedrockagent#FlowAliasRoutingConfiguration", + "traits": { + "smithy.api#documentation": "Contains information about the version to which to map the alias.
", + "smithy.api#required": {} + } + }, + "flowIdentifier": { + "target": "com.amazonaws.bedrockagent#FlowIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow for which to create an alias.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagent#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", + "smithy.api#idempotencyToken": {} + } + }, + "tags": { + "target": "com.amazonaws.bedrockagent#TagsMap", + "traits": { + "aws.cloudformation#cfnMutability": "full", + "smithy.api#documentation": "Any tags that you want to attach to the alias of the flow. For more information, see Tagging resources in Amazon Bedrock.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#CreateFlowAliasResponse": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "The name of the alias.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "The description of the alias.
" + } + }, + "routingConfiguration": { + "target": "com.amazonaws.bedrockagent#FlowAliasRoutingConfiguration", + "traits": { + "smithy.api#documentation": "Contains information about the version that the alias is mapped to.
", + "smithy.api#required": {} + } + }, + "flowId": { + "target": "com.amazonaws.bedrockagent#FlowId", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow that the alias belongs to.
", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.bedrockagent#FlowAliasId", + "traits": { + "smithy.api#documentation": "The unique identifier of the alias.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.bedrockagent#FlowAliasArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the alias.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the alias was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the alias of the flow was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#CreateFlowRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#FlowName", + "traits": { + "smithy.api#documentation": "A name for the flow.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#FlowDescription", + "traits": { + "smithy.api#documentation": "A description for the flow.
" + } + }, + "executionRoleArn": { + "target": "com.amazonaws.bedrockagent#FlowExecutionRoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service role with permissions to create and manage a flow. For more information, see Create a service role for flows in Amazon Bedrock in the Amazon Bedrock User Guide.
", + "smithy.api#required": {} + } + }, + "customerEncryptionKeyArn": { + "target": "com.amazonaws.bedrockagent#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key to encrypt the flow.
" + } + }, + "definition": { + "target": "com.amazonaws.bedrockagent#FlowDefinition", + "traits": { + "smithy.api#documentation": "A definition of the nodes and connections between nodes in the flow.
" + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagent#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", + "smithy.api#idempotencyToken": {} + } + }, + "tags": { + "target": "com.amazonaws.bedrockagent#TagsMap", + "traits": { + "aws.cloudformation#cfnMutability": "full", + "smithy.api#documentation": "Any tags that you want to attach to the flow. For more information, see Tagging resources in Amazon Bedrock.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#CreateFlowResponse": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#FlowName", + "traits": { + "smithy.api#documentation": "The name of the flow.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#FlowDescription", + "traits": { + "smithy.api#documentation": "The description of the flow.
" + } + }, + "executionRoleArn": { + "target": "com.amazonaws.bedrockagent#FlowExecutionRoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service role with permissions to create a flow. For more information, see Create a service role for flows in Amazon Bedrock in the Amazon Bedrock User Guide.
", + "smithy.api#required": {} + } + }, + "customerEncryptionKeyArn": { + "target": "com.amazonaws.bedrockagent#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key that you encrypted the flow with.
" + } + }, + "id": { + "target": "com.amazonaws.bedrockagent#FlowId", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.bedrockagent#FlowArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the flow.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagent#FlowStatus", + "traits": { + "smithy.api#documentation": "The status of the flow. When you submit this request, the status will be NotPrepared
. If creation fails, the status becomes Failed
.
The time at which the flow was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the flow was last updated.
", + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.bedrockagent#DraftVersion", + "traits": { + "smithy.api#documentation": "The version of the flow. When you create a flow, the version created is the DRAFT
version.
A definition of the nodes and connections between nodes in the flow.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#CreateFlowVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#CreateFlowVersionRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#CreateFlowVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a version of the flow that you can deploy. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/flows/{flowIdentifier}/versions" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": ["console"] + } + }, + "com.amazonaws.bedrockagent#CreateFlowVersionRequest": { + "type": "structure", + "members": { + "flowIdentifier": { + "target": "com.amazonaws.bedrockagent#FlowIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow that you want to create a version of.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#FlowDescription", + "traits": { + "smithy.api#documentation": "A description of the version of the flow.
" + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagent#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#CreateFlowVersionResponse": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#FlowName", + "traits": { + "smithy.api#documentation": "The name of the version.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#FlowDescription", + "traits": { + "smithy.api#documentation": "The description of the version.
" + } + }, + "executionRoleArn": { + "target": "com.amazonaws.bedrockagent#FlowExecutionRoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service role with permissions to create a flow. For more information, see Create a service role for flows in Amazon Bedrock in the Amazon Bedrock User Guide.
", + "smithy.api#required": {} + } + }, + "customerEncryptionKeyArn": { + "target": "com.amazonaws.bedrockagent#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The KMS key that the flow is encrypted with.
" + } + }, + "id": { + "target": "com.amazonaws.bedrockagent#FlowId", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.bedrockagent#FlowArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the flow.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagent#FlowStatus", + "traits": { + "smithy.api#documentation": "The status of the flow.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the flow was created.
", + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.bedrockagent#NumericalVersion", + "traits": { + "smithy.api#documentation": "The version of the flow that was created. Versions are numbered incrementally, starting from 1.
", + "smithy.api#required": {} + } + }, + "definition": { + "target": "com.amazonaws.bedrockagent#FlowDefinition", + "traits": { + "smithy.api#documentation": "A definition of the nodes and connections in the flow.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#CreateKnowledgeBase": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#CreateKnowledgeBaseRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#CreateKnowledgeBaseResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a knowledge base that contains data sources from which information can be queried and used by LLMs. To create a knowledge base, you must first set up your data sources and configure a supported vector store. For more information, see Set up your data for ingestion.
\nIf you prefer to let Amazon Bedrock create and manage a vector store for you in Amazon OpenSearch Service, use the console. For more information, see Create a knowledge base.
\nProvide the name
and an optional description
.
Provide the Amazon Resource Name (ARN) with permissions to create a knowledge base in the roleArn
field.
Provide the embedding model to use in the embeddingModelArn
field in the knowledgeBaseConfiguration
object.
Provide the configuration for your vector store in the storageConfiguration
object.
For an Amazon OpenSearch Service database, use the opensearchServerlessConfiguration
object. For more information, see Create a vector store in Amazon OpenSearch Service.
For an Amazon Aurora database, use the RdsConfiguration
object. For more information, see Create a vector store in Amazon Aurora.
For a Pinecone database, use the pineconeConfiguration
object. For more information, see Create a vector store in Pinecone.
For a Redis Enterprise Cloud database, use the redisEnterpriseCloudConfiguration
object. For more information, see Create a vector store in Redis Enterprise Cloud.
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", + "smithy.api#idempotencyToken": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "A name for the knowledge base.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "A description of the knowledge base.
" + } + }, + "roleArn": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseRoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
", + "smithy.api#required": {} + } + }, + "knowledgeBaseConfiguration": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseConfiguration", + "traits": { + "smithy.api#documentation": "Contains details about the embeddings model used for the knowledge base.
", + "smithy.api#required": {} + } + }, + "storageConfiguration": { + "target": "com.amazonaws.bedrockagent#StorageConfiguration", + "traits": { + "smithy.api#documentation": "Contains details about the configuration of the vector database used for the knowledge base.
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.bedrockagent#TagsMap", + "traits": { + "smithy.api#documentation": "Specify the key-value pairs for the tags that you want to attach to your knowledge base in this object.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#CreateKnowledgeBaseResponse": { + "type": "structure", + "members": { + "knowledgeBase": { + "target": "com.amazonaws.bedrockagent#KnowledgeBase", + "traits": { + "smithy.api#documentation": "Contains details about the knowledge base.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#CreatePrompt": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#CreatePromptRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#CreatePromptResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a prompt in your prompt library that you can add to a flow. For more information, see Prompt management in Amazon Bedrock, Create a prompt using Prompt management and Prompt flows in Amazon Bedrock in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/prompts/" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": ["console"] + } + }, + "com.amazonaws.bedrockagent#CreatePromptRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#PromptName", + "traits": { + "smithy.api#documentation": "A name for the prompt.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#PromptDescription", + "traits": { + "smithy.api#documentation": "A description for the prompt.
" + } + }, + "customerEncryptionKeyArn": { + "target": "com.amazonaws.bedrockagent#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key to encrypt the prompt.
" + } + }, + "defaultVariant": { + "target": "com.amazonaws.bedrockagent#PromptVariantName", + "traits": { + "smithy.api#documentation": "The name of the default variant for the prompt. This value must match the name
field in the relevant PromptVariant object.
A list of objects, each containing details about a variant of the prompt.
" + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagent#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", + "smithy.api#idempotencyToken": {} + } + }, + "tags": { + "target": "com.amazonaws.bedrockagent#TagsMap", + "traits": { + "aws.cloudformation#cfnMutability": "full", + "smithy.api#documentation": "Any tags that you want to attach to the prompt. For more information, see Tagging resources in Amazon Bedrock.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#CreatePromptResponse": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#PromptName", + "traits": { + "smithy.api#documentation": "The name of the prompt.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#PromptDescription", + "traits": { + "smithy.api#documentation": "The description of the prompt.
" + } + }, + "customerEncryptionKeyArn": { + "target": "com.amazonaws.bedrockagent#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key that you encrypted the prompt with.
" + } + }, + "defaultVariant": { + "target": "com.amazonaws.bedrockagent#PromptVariantName", + "traits": { + "smithy.api#documentation": "The name of the default variant for your prompt.
" + } + }, + "variants": { + "target": "com.amazonaws.bedrockagent#PromptVariantList", + "traits": { + "smithy.api#documentation": "A list of objects, each containing details about a variant of the prompt.
" + } + }, + "id": { + "target": "com.amazonaws.bedrockagent#PromptId", + "traits": { + "smithy.api#documentation": "The unique identifier of the prompt.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.bedrockagent#PromptArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the prompt.
", + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.bedrockagent#Version", + "traits": { + "smithy.api#documentation": "The version of the prompt. When you create a prompt, the version created is the DRAFT
version.
The time at which the prompt was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the prompt was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#CreatePromptVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#CreatePromptVersionRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#CreatePromptVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a static snapshot of your prompt that can be deployed to production. For more information, see Deploy prompts using Prompt management by creating versions in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/prompts/{promptIdentifier}/versions" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": ["console"] + } + }, + "com.amazonaws.bedrockagent#CreatePromptVersionRequest": { + "type": "structure", + "members": { + "promptIdentifier": { + "target": "com.amazonaws.bedrockagent#PromptIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the prompt that you want to create a version of.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#PromptDescription", + "traits": { + "smithy.api#documentation": "A description for the version of the prompt.
" + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagent#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", + "smithy.api#idempotencyToken": {} + } + }, + "tags": { + "target": "com.amazonaws.bedrockagent#TagsMap", + "traits": { + "aws.cloudformation#cfnMutability": "full", + "smithy.api#documentation": "Any tags that you want to attach to the version of the prompt. For more information, see Tagging resources in Amazon Bedrock.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#CreatePromptVersionResponse": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#PromptName", + "traits": { + "smithy.api#documentation": "The name of the prompt.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#PromptDescription", + "traits": { + "smithy.api#documentation": "A description for the version.
" + } + }, + "customerEncryptionKeyArn": { + "target": "com.amazonaws.bedrockagent#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key to encrypt the version of the prompt.
" + } + }, + "defaultVariant": { + "target": "com.amazonaws.bedrockagent#PromptVariantName", + "traits": { + "smithy.api#documentation": "The name of the default variant for the prompt. This value must match the name
field in the relevant PromptVariant object.
A list of objects, each containing details about a variant of the prompt.
" + } + }, + "id": { + "target": "com.amazonaws.bedrockagent#PromptId", + "traits": { + "smithy.api#documentation": "The unique identifier of the prompt.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.bedrockagent#PromptArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the version of the prompt.
", + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.bedrockagent#Version", + "traits": { + "smithy.api#documentation": "The version of the prompt that was created. Versions are numbered incrementally, starting from 1.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the prompt was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the prompt was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#CreationMode": { + "type": "enum", + "members": { + "DEFAULT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEFAULT" + } + }, + "OVERRIDDEN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OVERRIDDEN" + } + } + } + }, + "com.amazonaws.bedrockagent#CustomControlMethod": { + "type": "enum", + "members": { + "RETURN_CONTROL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RETURN_CONTROL" + } + } + } + }, + "com.amazonaws.bedrockagent#CustomTransformationConfiguration": { + "type": "structure", + "members": { + "intermediateStorage": { + "target": "com.amazonaws.bedrockagent#IntermediateStorage", + "traits": { + "smithy.api#documentation": "An S3 bucket path for input and output objects.
", + "smithy.api#required": {} + } + }, + "transformations": { + "target": "com.amazonaws.bedrockagent#Transformations", + "traits": { + "smithy.api#documentation": "A Lambda function that processes documents.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Settings for customizing steps in the data source content ingestion pipeline.
\nYou can configure the data source to process documents with a Lambda function after\n they are parsed and converted into chunks. When you add a post-chunking transformation,\n the service stores chunked documents in an S3 bucket and invokes a Lambda function to process\n them.
\nTo process chunked documents with a Lambda function, define an S3 bucket path for input\n and output objects, and a transformation that specifies the Lambda function to invoke. You can\n use the Lambda function to customize how chunks are split, and the metadata for each chunk.\n
" + } + }, + "com.amazonaws.bedrockagent#DataDeletionPolicy": { + "type": "enum", + "members": { + "RETAIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RETAIN" + } + }, + "DELETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE" + } + } + } + }, + "com.amazonaws.bedrockagent#DataSource": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base to which the data source belongs.
", + "smithy.api#required": {} + } + }, + "dataSourceId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the data source.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "The name of the data source.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagent#DataSourceStatus", + "traits": { + "smithy.api#documentation": "The status of the data source. The following statuses are possible:
\nAvailable – The data source has been created and is ready for ingestion into the knowledge base.
\nDeleting – The data source is being deleted.
\nThe description of the data source.
" + } + }, + "dataSourceConfiguration": { + "target": "com.amazonaws.bedrockagent#DataSourceConfiguration", + "traits": { + "smithy.api#documentation": "The connection configuration for the data source.
", + "smithy.api#required": {} + } + }, + "serverSideEncryptionConfiguration": { + "target": "com.amazonaws.bedrockagent#ServerSideEncryptionConfiguration", + "traits": { + "smithy.api#documentation": "Contains details about the configuration of the server-side encryption.
" + } + }, + "vectorIngestionConfiguration": { + "target": "com.amazonaws.bedrockagent#VectorIngestionConfiguration", + "traits": { + "smithy.api#documentation": "Contains details about how to ingest the documents in the data source.
" + } + }, + "dataDeletionPolicy": { + "target": "com.amazonaws.bedrockagent#DataDeletionPolicy", + "traits": { + "smithy.api#documentation": "The data deletion policy for the data source.
" + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the data source was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the data source was last updated.
", + "smithy.api#required": {} + } + }, + "failureReasons": { + "target": "com.amazonaws.bedrockagent#FailureReasons", + "traits": { + "smithy.api#documentation": "The detailed reasons on the failure to delete a data source.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about a data source.
" + } + }, + "com.amazonaws.bedrockagent#DataSourceConfiguration": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrockagent#DataSourceType", + "traits": { + "smithy.api#documentation": "The type of data source.
", + "smithy.api#required": {} + } + }, + "s3Configuration": { + "target": "com.amazonaws.bedrockagent#S3DataSourceConfiguration", + "traits": { + "smithy.api#documentation": "The configuration information to connect to Amazon S3 as your data source.
" + } + }, + "webConfiguration": { + "target": "com.amazonaws.bedrockagent#WebDataSourceConfiguration", + "traits": { + "smithy.api#documentation": "The configuration of web URLs to crawl for your data source. \n You should be authorized to crawl the URLs.
\nCrawling web URLs as your data source is in preview release \n and is subject to change.
\nThe configuration information to connect to Confluence as your data source.
\nConfluence data source connector is in preview release and is subject to change.
\nThe configuration information to connect to Salesforce as your data source.
\nSalesforce data source connector is in preview release and is subject to change.
\nThe configuration information to connect to SharePoint as your data source.
\nSharePoint data source connector is in preview release and is subject to change.
\nThe connection configuration for the data source.
" + } + }, + "com.amazonaws.bedrockagent#DataSourceResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrockagent#CreateDataSource" + }, + { + "target": "com.amazonaws.bedrockagent#DeleteDataSource" + }, + { + "target": "com.amazonaws.bedrockagent#GetDataSource" + }, + { + "target": "com.amazonaws.bedrockagent#ListDataSources" + }, + { + "target": "com.amazonaws.bedrockagent#UpdateDataSource" + } + ] + }, + "com.amazonaws.bedrockagent#DataSourceStatus": { + "type": "enum", + "members": { + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "DELETE_UNSUCCESSFUL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_UNSUCCESSFUL" + } + } + } + }, + "com.amazonaws.bedrockagent#DataSourceSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#DataSourceSummary" + } + }, + "com.amazonaws.bedrockagent#DataSourceSummary": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base to which the data source belongs.
", + "smithy.api#required": {} + } + }, + "dataSourceId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the data source.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "The name of the data source.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagent#DataSourceStatus", + "traits": { + "smithy.api#documentation": "The status of the data source.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "The description of the data source.
" + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the data source was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about a data source.
" + } + }, + "com.amazonaws.bedrockagent#DataSourceType": { + "type": "enum", + "members": { + "S3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3" + } + }, + "WEB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WEB" + } + }, + "CONFLUENCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONFLUENCE" + } + }, + "SALESFORCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SALESFORCE" + } + }, + "SHAREPOINT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SHAREPOINT" + } + } + } + }, + "com.amazonaws.bedrockagent#DateTimestamp": { + "type": "timestamp", + "traits": { + "smithy.api#timestampFormat": "date-time" + } + }, + "com.amazonaws.bedrockagent#DeleteAgent": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#DeleteAgentRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#DeleteAgentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an agent.
", + "smithy.api#http": { + "code": 202, + "method": "DELETE", + "uri": "/agents/{agentId}/" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": ["console"] + } + }, + "com.amazonaws.bedrockagent#DeleteAgentActionGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#DeleteAgentActionGroupRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#DeleteAgentActionGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an action group in an agent.
", + "smithy.api#http": { + "code": 204, + "method": "DELETE", + "uri": "/agents/{agentId}/agentversions/{agentVersion}/actiongroups/{actionGroupId}/" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": ["console"] + } + }, + "com.amazonaws.bedrockagent#DeleteAgentActionGroupRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent that the action group belongs to.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#DraftVersion", + "traits": { + "smithy.api#documentation": "The version of the agent that the action group belongs to.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "actionGroupId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the action group to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "skipResourceInUseCheck": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "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.
Deletes an alias of an agent.
", + "smithy.api#http": { + "code": 202, + "method": "DELETE", + "uri": "/agents/{agentId}/agentaliases/{agentAliasId}/" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": ["console"] + } + }, + "com.amazonaws.bedrockagent#DeleteAgentAliasRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent that the alias belongs to.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentAliasId": { + "target": "com.amazonaws.bedrockagent#AgentAliasId", + "traits": { + "smithy.api#documentation": "The unique identifier of the alias to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#DeleteAgentAliasResponse": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent that the alias belongs to.
", + "smithy.api#required": {} + } + }, + "agentAliasId": { + "target": "com.amazonaws.bedrockagent#AgentAliasId", + "traits": { + "smithy.api#documentation": "The unique identifier of the alias that was deleted.
", + "smithy.api#required": {} + } + }, + "agentAliasStatus": { + "target": "com.amazonaws.bedrockagent#AgentAliasStatus", + "traits": { + "smithy.api#documentation": "The status of the alias.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#DeleteAgentRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "skipResourceInUseCheck": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "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.
The unique identifier of the agent that was deleted.
", + "smithy.api#required": {} + } + }, + "agentStatus": { + "target": "com.amazonaws.bedrockagent#AgentStatus", + "traits": { + "smithy.api#documentation": "The status of the agent.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#DeleteAgentVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#DeleteAgentVersionRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#DeleteAgentVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a version of an agent.
", + "smithy.api#http": { + "code": 202, + "method": "DELETE", + "uri": "/agents/{agentId}/agentversions/{agentVersion}/" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": ["console"] + } + }, + "com.amazonaws.bedrockagent#DeleteAgentVersionRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent that the version belongs to.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#NumericalVersion", + "traits": { + "smithy.api#documentation": "The version of the agent to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "skipResourceInUseCheck": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "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.
The unique identifier of the agent that the version belongs to.
", + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#NumericalVersion", + "traits": { + "smithy.api#documentation": "The version that was deleted.
", + "smithy.api#required": {} + } + }, + "agentStatus": { + "target": "com.amazonaws.bedrockagent#AgentStatus", + "traits": { + "smithy.api#documentation": "The status of the agent version.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#DeleteDataSource": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#DeleteDataSourceRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#DeleteDataSourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a data source from a knowledge base.
", + "smithy.api#http": { + "code": 202, + "method": "DELETE", + "uri": "/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": ["console"] + } + }, + "com.amazonaws.bedrockagent#DeleteDataSourceRequest": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base from which to delete the data source.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "dataSourceId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the data source to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#DeleteDataSourceResponse": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base to which the data source that was deleted belonged.
", + "smithy.api#required": {} + } + }, + "dataSourceId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the data source that was deleted.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagent#DataSourceStatus", + "traits": { + "smithy.api#documentation": "The status of the data source.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#DeleteFlow": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#DeleteFlowRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#DeleteFlowResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a flow.
", + "smithy.api#http": { + "code": 200, + "method": "DELETE", + "uri": "/flows/{flowIdentifier}/" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": ["console"] + } + }, + "com.amazonaws.bedrockagent#DeleteFlowAlias": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#DeleteFlowAliasRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#DeleteFlowAliasResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an alias of a flow.
", + "smithy.api#http": { + "code": 200, + "method": "DELETE", + "uri": "/flows/{flowIdentifier}/aliases/{aliasIdentifier}" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": ["console"] + } + }, + "com.amazonaws.bedrockagent#DeleteFlowAliasRequest": { + "type": "structure", + "members": { + "flowIdentifier": { + "target": "com.amazonaws.bedrockagent#FlowIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow that the alias belongs to.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "aliasIdentifier": { + "target": "com.amazonaws.bedrockagent#FlowAliasIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the alias to be deleted.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#DeleteFlowAliasResponse": { + "type": "structure", + "members": { + "flowId": { + "target": "com.amazonaws.bedrockagent#FlowId", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow that the alias belongs to.
", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.bedrockagent#FlowAliasId", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#DeleteFlowRequest": { + "type": "structure", + "members": { + "flowIdentifier": { + "target": "com.amazonaws.bedrockagent#FlowIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "skipResourceInUseCheck": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "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.
The unique identifier of the flow.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#DeleteFlowVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#DeleteFlowVersionRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#DeleteFlowVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a version of a flow.
", + "smithy.api#http": { + "code": 200, + "method": "DELETE", + "uri": "/flows/{flowIdentifier}/versions/{flowVersion}/" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": ["console"] + } + }, + "com.amazonaws.bedrockagent#DeleteFlowVersionRequest": { + "type": "structure", + "members": { + "flowIdentifier": { + "target": "com.amazonaws.bedrockagent#FlowIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow whose version that you want to delete
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "flowVersion": { + "target": "com.amazonaws.bedrockagent#NumericalVersion", + "traits": { + "smithy.api#documentation": "The version of the flow that you want to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "skipResourceInUseCheck": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "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.
The unique identifier of the flow.
", + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.bedrockagent#NumericalVersion", + "traits": { + "smithy.api#documentation": "The version of the flow being deleted.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#DeleteKnowledgeBase": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#DeleteKnowledgeBaseRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#DeleteKnowledgeBaseResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a knowledge base. Before deleting a knowledge base, you should disassociate the knowledge base from any agents that it is associated with by making a DisassociateAgentKnowledgeBase request.
", + "smithy.api#http": { + "code": 202, + "method": "DELETE", + "uri": "/knowledgebases/{knowledgeBaseId}" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": ["console"] + } + }, + "com.amazonaws.bedrockagent#DeleteKnowledgeBaseRequest": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#DeleteKnowledgeBaseResponse": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base that was deleted.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseStatus", + "traits": { + "smithy.api#documentation": "The status of the knowledge base and whether it has been successfully deleted.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#DeletePrompt": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#DeletePromptRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#DeletePromptResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a prompt or a version of it, depending on whether you include the promptVersion
field or not. For more information, see Delete prompts from the Prompt management tool and Delete a version of a prompt from the Prompt management tool in the Amazon Bedrock User Guide.
The unique identifier of the prompt.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "promptVersion": { + "target": "com.amazonaws.bedrockagent#NumericalVersion", + "traits": { + "smithy.api#documentation": "The version of the prompt to delete. To delete the prompt, omit this field.
", + "smithy.api#httpQuery": "promptVersion" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#DeletePromptResponse": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.bedrockagent#PromptId", + "traits": { + "smithy.api#documentation": "The unique identifier of the prompt that was deleted.
", + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.bedrockagent#NumericalVersion", + "traits": { + "smithy.api#documentation": "The version of the prompt that was deleted.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#Description": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.bedrockagent#Dimensions": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 4096 + } + } + }, + "com.amazonaws.bedrockagent#DisassociateAgentKnowledgeBase": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#DisassociateAgentKnowledgeBaseRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#DisassociateAgentKnowledgeBaseResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Disassociates a knowledge base from an agent.
", + "smithy.api#http": { + "code": 204, + "method": "DELETE", + "uri": "/agents/{agentId}/agentversions/{agentVersion}/knowledgebases/{knowledgeBaseId}/" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": ["console"] + } + }, + "com.amazonaws.bedrockagent#DisassociateAgentKnowledgeBaseRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent from which to disassociate the knowledge base.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#DraftVersion", + "traits": { + "smithy.api#documentation": "The version of the agent from which to disassociate the knowledge base.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base to disassociate.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#DisassociateAgentKnowledgeBaseResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#DraftVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 5, + "max": 5 + }, + "smithy.api#pattern": "^DRAFT$" + } + }, + "com.amazonaws.bedrockagent#EmbeddingModelConfiguration": { + "type": "structure", + "members": { + "bedrockEmbeddingModelConfiguration": { + "target": "com.amazonaws.bedrockagent#BedrockEmbeddingModelConfiguration", + "traits": { + "smithy.api#documentation": "The vector configuration details on the Bedrock embeddings model.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration details for the embeddings model.
" + } + }, + "com.amazonaws.bedrockagent#EnabledMemoryTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#MemoryType" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.bedrockagent#FailureReason": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + } + } + }, + "com.amazonaws.bedrockagent#FailureReasons": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#FailureReason" + }, + "traits": { + "smithy.api#length": { + "max": 2048 + } + } + }, + "com.amazonaws.bedrockagent#FieldName": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.bedrockagent#FilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#FilterPattern" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#FilterPattern": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#FilteredObjectType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#FixedSizeChunkingConfiguration": { + "type": "structure", + "members": { + "maxTokens": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The maximum number of tokens to include in a chunk.
", + "smithy.api#range": { + "min": 1 + }, + "smithy.api#required": {} + } + }, + "overlapPercentage": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The percentage of overlap between adjacent chunks of a data source.
", + "smithy.api#range": { + "min": 1, + "max": 99 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy
as NONE
, exclude this field.
The version that the alias maps to.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a version that the alias maps to.
" + } + }, + "com.amazonaws.bedrockagent#FlowAliasSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#FlowAliasSummary" + }, + "traits": { + "smithy.api#length": { + "max": 10 + } + } + }, + "com.amazonaws.bedrockagent#FlowAliasSummary": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "The name of the alias.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "A description of the alias.
" + } + }, + "routingConfiguration": { + "target": "com.amazonaws.bedrockagent#FlowAliasRoutingConfiguration", + "traits": { + "smithy.api#documentation": "A list of configurations about the versions that the alias maps to. Currently, you can only specify one.
", + "smithy.api#required": {} + } + }, + "flowId": { + "target": "com.amazonaws.bedrockagent#FlowId", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow.
", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.bedrockagent#FlowAliasId", + "traits": { + "smithy.api#documentation": "The unique identifier of the alias of the flow.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.bedrockagent#FlowAliasArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the alias.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the alias was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the alias was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about an alias of a flow.
\nThis data type is used in the following API operations:
\nA name for the condition that you can reference.
", + "smithy.api#required": {} + } + }, + "expression": { + "target": "com.amazonaws.bedrockagent#FlowConditionExpression", + "traits": { + "smithy.api#documentation": "Defines the condition. You must refer to at least one of the inputs in the condition. For more information, expand the Condition node section in Node types in prompt flows.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Defines a condition in the condition node.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#FlowConditionExpression": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#FlowConditionName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$" + } + }, + "com.amazonaws.bedrockagent#FlowConditionalConnectionConfiguration": { + "type": "structure", + "members": { + "condition": { + "target": "com.amazonaws.bedrockagent#FlowConditionName", + "traits": { + "smithy.api#documentation": "The condition that triggers this connection. For more information about how to write conditions, see the Condition node type in the Node types topic in the Amazon Bedrock User Guide.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration of a connection between a condition node and another node.
" + } + }, + "com.amazonaws.bedrockagent#FlowConditions": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#FlowCondition" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#FlowConnection": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrockagent#FlowConnectionType", + "traits": { + "smithy.api#documentation": "Whether the source node that the connection begins from is a condition node (Conditional
) or not (Data
).
A name for the connection that you can reference.
", + "smithy.api#required": {} + } + }, + "source": { + "target": "com.amazonaws.bedrockagent#FlowNodeName", + "traits": { + "smithy.api#documentation": "The node that the connection starts at.
", + "smithy.api#required": {} + } + }, + "target": { + "target": "com.amazonaws.bedrockagent#FlowNodeName", + "traits": { + "smithy.api#documentation": "The node that the connection ends at.
", + "smithy.api#required": {} + } + }, + "configuration": { + "target": "com.amazonaws.bedrockagent#FlowConnectionConfiguration", + "traits": { + "smithy.api#documentation": "The configuration of the connection.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a connection between two nodes in the flow.
" + } + }, + "com.amazonaws.bedrockagent#FlowConnectionConfiguration": { + "type": "union", + "members": { + "data": { + "target": "com.amazonaws.bedrockagent#FlowDataConnectionConfiguration", + "traits": { + "smithy.api#documentation": "The configuration of a connection originating from a node that isn't a Condition node.
" + } + }, + "conditional": { + "target": "com.amazonaws.bedrockagent#FlowConditionalConnectionConfiguration", + "traits": { + "smithy.api#documentation": "The configuration of a connection originating from a Condition node.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration of the connection.
" + } + }, + "com.amazonaws.bedrockagent#FlowConnectionName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){1,100}$" + } + }, + "com.amazonaws.bedrockagent#FlowConnectionType": { + "type": "enum", + "members": { + "DATA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Data" + } + }, + "CONDITIONAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Conditional" + } + } + } + }, + "com.amazonaws.bedrockagent#FlowConnections": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#FlowConnection" + }, + "traits": { + "smithy.api#length": { + "max": 20 + } + } + }, + "com.amazonaws.bedrockagent#FlowDataConnectionConfiguration": { + "type": "structure", + "members": { + "sourceOutput": { + "target": "com.amazonaws.bedrockagent#FlowNodeOutputName", + "traits": { + "smithy.api#documentation": "The name of the output in the source node that the connection begins from.
", + "smithy.api#required": {} + } + }, + "targetInput": { + "target": "com.amazonaws.bedrockagent#FlowNodeInputName", + "traits": { + "smithy.api#documentation": "The name of the input in the target node that the connection ends at.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration of a connection originating from a node that isn't a Condition node.
" + } + }, + "com.amazonaws.bedrockagent#FlowDefinition": { + "type": "structure", + "members": { + "nodes": { + "target": "com.amazonaws.bedrockagent#FlowNodes", + "traits": { + "smithy.api#documentation": "An array of node definitions in the flow.
" + } + }, + "connections": { + "target": "com.amazonaws.bedrockagent#FlowConnections", + "traits": { + "smithy.api#documentation": "An array of connection definitions in the flow.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The definition of the nodes and connections between nodes in the flow.
" + } + }, + "com.amazonaws.bedrockagent#FlowDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.bedrockagent#FlowExecutionRoleArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/(service-role/)?.+$" + } + }, + "com.amazonaws.bedrockagent#FlowId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[0-9a-zA-Z]{10}$" + } + }, + "com.amazonaws.bedrockagent#FlowIdentifier": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10})|([0-9a-zA-Z]{10})$" + } + }, + "com.amazonaws.bedrockagent#FlowName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^([0-9a-zA-Z][_-]?){1,100}$" + } + }, + "com.amazonaws.bedrockagent#FlowNode": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#FlowNodeName", + "traits": { + "smithy.api#documentation": "A name for the node.
", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.bedrockagent#FlowNodeType", + "traits": { + "smithy.api#documentation": "The type of node. This value must match the name of the key that you provide in the configuration you provide in the FlowNodeConfiguration
field.
Contains configurations for the node.
" + } + }, + "inputs": { + "target": "com.amazonaws.bedrockagent#FlowNodeInputs", + "traits": { + "smithy.api#documentation": "An array of objects, each of which contains information about an input into the node.
" + } + }, + "outputs": { + "target": "com.amazonaws.bedrockagent#FlowNodeOutputs", + "traits": { + "smithy.api#documentation": "A list of objects, each of which contains information about an output from the node.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations about a node in the flow.
" + } + }, + "com.amazonaws.bedrockagent#FlowNodeConfiguration": { + "type": "union", + "members": { + "input": { + "target": "com.amazonaws.bedrockagent#InputFlowNodeConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations for an input flow node in your flow. The first node in the flow. inputs
can't be specified for this node.
Contains configurations for an output flow node in your flow. The last node in the flow. outputs
can't be specified for this node.
Contains configurations for a knowledge base node in your flow. Queries a knowledge base and returns the retrieved results or generated response.
" + } + }, + "condition": { + "target": "com.amazonaws.bedrockagent#ConditionFlowNodeConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations for a Condition node in your flow. Defines conditions that lead to different branches of the flow.
" + } + }, + "lex": { + "target": "com.amazonaws.bedrockagent#LexFlowNodeConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations for a Lex node in your flow. Invokes an Amazon Lex bot to identify the intent of the input and return the intent as the output.
" + } + }, + "prompt": { + "target": "com.amazonaws.bedrockagent#PromptFlowNodeConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations for a prompt node in your flow. Runs a prompt and generates the model response as the output. You can use a prompt from Prompt management or you can configure one in this node.
" + } + }, + "lambdaFunction": { + "target": "com.amazonaws.bedrockagent#LambdaFunctionFlowNodeConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations for a Lambda function node in your flow. Invokes an Lambda function.
" + } + }, + "storage": { + "target": "com.amazonaws.bedrockagent#StorageFlowNodeConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations for a Storage node in your flow. Stores an input in an Amazon S3 location.
" + } + }, + "agent": { + "target": "com.amazonaws.bedrockagent#AgentFlowNodeConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations for an agent node in your flow. Invokes an alias of an agent and returns the response.
" + } + }, + "retrieval": { + "target": "com.amazonaws.bedrockagent#RetrievalFlowNodeConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations for a Retrieval node in your flow. Retrieves data from an Amazon S3 location and returns it as the output.
" + } + }, + "iterator": { + "target": "com.amazonaws.bedrockagent#IteratorFlowNodeConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations for an iterator node in your flow. Takes an input that is an array and iteratively sends each item of the array as an output to the following node. The size of the array is also returned in the output.
\nThe output flow node at the end of the flow iteration will return a response for each member of the array. To return only one response, you can include a collector node downstream from the iterator node.
" + } + }, + "collector": { + "target": "com.amazonaws.bedrockagent#CollectorFlowNodeConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations for a collector node in your flow. Collects an iteration of inputs and consolidates them into an array of outputs.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for a node in your flow. For more information, see Node types in Amazon Bedrock works in the Amazon Bedrock User Guide.
" + } + }, + "com.amazonaws.bedrockagent#FlowNodeIODataType": { + "type": "enum", + "members": { + "STRING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "String" + } + }, + "NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Number" + } + }, + "BOOLEAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Boolean" + } + }, + "OBJECT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Object" + } + }, + "ARRAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Array" + } + } + } + }, + "com.amazonaws.bedrockagent#FlowNodeInput": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#FlowNodeInputName", + "traits": { + "smithy.api#documentation": "A name for the input that you can reference.
", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.bedrockagent#FlowNodeIODataType", + "traits": { + "smithy.api#documentation": "The data type of the input. If the input doesn't match this type at runtime, a validation error will be thrown.
", + "smithy.api#required": {} + } + }, + "expression": { + "target": "com.amazonaws.bedrockagent#FlowNodeInputExpression", + "traits": { + "smithy.api#documentation": "An expression that formats the input for the node. For an explanation of how to create expressions, see Expressions in Prompt flows in Amazon Bedrock.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for an input to a node.
" + } + }, + "com.amazonaws.bedrockagent#FlowNodeInputExpression": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#FlowNodeInputName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$" + } + }, + "com.amazonaws.bedrockagent#FlowNodeInputs": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#FlowNodeInput" + }, + "traits": { + "smithy.api#length": { + "max": 5 + } + } + }, + "com.amazonaws.bedrockagent#FlowNodeName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$" + } + }, + "com.amazonaws.bedrockagent#FlowNodeOutput": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#FlowNodeOutputName", + "traits": { + "smithy.api#documentation": "A name for the output that you can reference.
", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.bedrockagent#FlowNodeIODataType", + "traits": { + "smithy.api#documentation": "The data type of the output. If the output doesn't match this type at runtime, a validation error will be thrown.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for an output from a node.
" + } + }, + "com.amazonaws.bedrockagent#FlowNodeOutputName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$" + } + }, + "com.amazonaws.bedrockagent#FlowNodeOutputs": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#FlowNodeOutput" + }, + "traits": { + "smithy.api#length": { + "max": 5 + } + } + }, + "com.amazonaws.bedrockagent#FlowNodeType": { + "type": "enum", + "members": { + "INPUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Input" + } + }, + "OUTPUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Output" + } + }, + "KNOWLEDGE_BASE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KnowledgeBase" + } + }, + "CONDITION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Condition" + } + }, + "LEX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Lex" + } + }, + "PROMPT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Prompt" + } + }, + "LAMBDA_FUNCTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LambdaFunction" + } + }, + "STORAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Storage" + } + }, + "AGENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Agent" + } + }, + "RETRIEVAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Retrieval" + } + }, + "ITERATOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Iterator" + } + }, + "COLLECTOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Collector" + } + } + } + }, + "com.amazonaws.bedrockagent#FlowNodes": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#FlowNode" + }, + "traits": { + "smithy.api#length": { + "max": 20 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#FlowResource": { + "type": "resource", + "identifiers": { + "flowIdentifier": { + "target": "com.amazonaws.bedrockagent#FlowIdentifier" + } + }, + "create": { + "target": "com.amazonaws.bedrockagent#CreateFlow" + }, + "read": { + "target": "com.amazonaws.bedrockagent#GetFlow" + }, + "update": { + "target": "com.amazonaws.bedrockagent#UpdateFlow" + }, + "delete": { + "target": "com.amazonaws.bedrockagent#DeleteFlow" + }, + "list": { + "target": "com.amazonaws.bedrockagent#ListFlows" + }, + "operations": [ + { + "target": "com.amazonaws.bedrockagent#PrepareFlow" + } + ], + "resources": [ + { + "target": "com.amazonaws.bedrockagent#FlowAliasResource" }, - "com.amazonaws.bedrockagent#AgentSummary": { - "type": "structure", - "members": { - "agentId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the agent.
", - "smithy.api#required": {} - } - }, - "agentName": { - "target": "com.amazonaws.bedrockagent#Name", - "traits": { - "smithy.api#documentation": "The name of the agent.
", - "smithy.api#required": {} - } - }, - "agentStatus": { - "target": "com.amazonaws.bedrockagent#AgentStatus", - "traits": { - "smithy.api#documentation": "The status of the agent.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#Description", - "traits": { - "smithy.api#documentation": "The description of the agent.
" - } - }, - "updatedAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the agent was last updated.
", - "smithy.api#required": {} - } - }, - "latestAgentVersion": { - "target": "com.amazonaws.bedrockagent#Version", - "traits": { - "smithy.api#documentation": "The latest version of the agent.
" - } - }, - "guardrailConfiguration": { - "target": "com.amazonaws.bedrockagent#GuardrailConfiguration", - "traits": { - "smithy.api#documentation": "Details about the guardrail associated with the agent.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains details about an agent.
" - } - }, - "com.amazonaws.bedrockagent#AgentVersion": { - "type": "structure", - "members": { - "agentId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the agent that the version belongs to.
", - "smithy.api#required": {} - } - }, - "agentName": { - "target": "com.amazonaws.bedrockagent#Name", - "traits": { - "smithy.api#documentation": "The name of the agent that the version belongs to.
", - "smithy.api#required": {} - } - }, - "agentArn": { - "target": "com.amazonaws.bedrockagent#AgentArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the agent that the version belongs to.
", - "smithy.api#required": {} - } - }, - "version": { - "target": "com.amazonaws.bedrockagent#NumericalVersion", - "traits": { - "smithy.api#documentation": "The version number.
", - "smithy.api#required": {} - } - }, - "instruction": { - "target": "com.amazonaws.bedrockagent#Instruction", - "traits": { - "smithy.api#documentation": "The instructions provided to the agent.
" - } - }, - "agentStatus": { - "target": "com.amazonaws.bedrockagent#AgentStatus", - "traits": { - "smithy.api#documentation": "The status of the agent that the version belongs to.
", - "smithy.api#required": {} - } - }, - "foundationModel": { - "target": "com.amazonaws.bedrockagent#ModelIdentifier", - "traits": { - "smithy.api#documentation": "The foundation model that the version invokes.
" - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#Description", - "traits": { - "smithy.api#documentation": "The description of the version.
" - } - }, - "idleSessionTTLInSeconds": { - "target": "com.amazonaws.bedrockagent#SessionTTL", - "traits": { - "smithy.api#documentation": "The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.
\nA user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.
", - "smithy.api#required": {} - } - }, - "agentResourceRoleArn": { - "target": "com.amazonaws.bedrockagent#AgentRoleArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
", - "smithy.api#required": {} - } - }, - "customerEncryptionKeyArn": { - "target": "com.amazonaws.bedrockagent#KmsKeyArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key that encrypts the agent.
" - } - }, - "createdAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the version was created.
", - "smithy.api#required": {} - } - }, - "updatedAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the version was last updated.
", - "smithy.api#required": {} - } - }, - "failureReasons": { - "target": "com.amazonaws.bedrockagent#FailureReasons", - "traits": { - "smithy.api#documentation": "A list of reasons that the API operation on the version failed.
" - } - }, - "recommendedActions": { - "target": "com.amazonaws.bedrockagent#RecommendedActions", - "traits": { - "smithy.api#documentation": "A list of recommended actions to take for the failed API operation on the version to succeed.
" - } - }, - "promptOverrideConfiguration": { - "target": "com.amazonaws.bedrockagent#PromptOverrideConfiguration", - "traits": { - "smithy.api#documentation": "Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts.
" - } - }, - "guardrailConfiguration": { - "target": "com.amazonaws.bedrockagent#GuardrailConfiguration", - "traits": { - "smithy.api#documentation": "Details about the guardrail associated with the agent.
" - } - }, - "memoryConfiguration": { - "target": "com.amazonaws.bedrockagent#MemoryConfiguration", - "traits": { - "smithy.api#documentation": "\n Contains details of the memory configuration on the version of the agent. \n
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains details about a version of an agent.
" - } - }, - "com.amazonaws.bedrockagent#AgentVersionSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagent#AgentVersionSummary" - }, - "traits": { - "smithy.api#length": { - "max": 10 - } - } - }, - "com.amazonaws.bedrockagent#AgentVersionSummary": { - "type": "structure", - "members": { - "agentName": { - "target": "com.amazonaws.bedrockagent#Name", - "traits": { - "smithy.api#documentation": "The name of the agent to which the version belongs.
", - "smithy.api#required": {} - } - }, - "agentStatus": { - "target": "com.amazonaws.bedrockagent#AgentStatus", - "traits": { - "smithy.api#documentation": "The status of the agent to which the version belongs.
", - "smithy.api#required": {} - } - }, - "agentVersion": { - "target": "com.amazonaws.bedrockagent#Version", - "traits": { - "smithy.api#documentation": "The version of the agent.
", - "smithy.api#required": {} - } - }, - "createdAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the version was created.
", - "smithy.api#required": {} - } - }, - "updatedAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the version was last updated.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#Description", - "traits": { - "smithy.api#documentation": "The description of the version of the agent.
" - } - }, - "guardrailConfiguration": { - "target": "com.amazonaws.bedrockagent#GuardrailConfiguration", - "traits": { - "smithy.api#documentation": "Details about the guardrail associated with the agent.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains details about a version of an agent.
" - } - }, - "com.amazonaws.bedrockagent#AliasResource": { - "type": "resource", - "operations": [ - { - "target": "com.amazonaws.bedrockagent#CreateAgentAlias" - }, - { - "target": "com.amazonaws.bedrockagent#DeleteAgentAlias" - }, - { - "target": "com.amazonaws.bedrockagent#GetAgentAlias" - }, - { - "target": "com.amazonaws.bedrockagent#ListAgentAliases" - }, - { - "target": "com.amazonaws.bedrockagent#UpdateAgentAlias" - } - ] - }, - "com.amazonaws.bedrockagent#AmazonBedrockAgentBuildTimeLambda": { - "type": "service", - "version": "2023-06-05", - "resources": [ - { - "target": "com.amazonaws.bedrockagent#ActionGroupResource" - }, - { - "target": "com.amazonaws.bedrockagent#AgentResource" - }, - { - "target": "com.amazonaws.bedrockagent#AliasResource" - }, - { - "target": "com.amazonaws.bedrockagent#DataSourceResource" - }, - { - "target": "com.amazonaws.bedrockagent#FlowResource" - }, - { - "target": "com.amazonaws.bedrockagent#IngestionJobResource" - }, - { - "target": "com.amazonaws.bedrockagent#KnowledgeBaseResource" - }, - { - "target": "com.amazonaws.bedrockagent#PromptResource" - }, - { - "target": "com.amazonaws.bedrockagent#TaggingResource" - }, - { - "target": "com.amazonaws.bedrockagent#VersionResource" - } - ], - "traits": { - "aws.api#service": { - "sdkId": "Bedrock Agent", - "arnNamespace": "bedrock", - "endpointPrefix": "bedrock-agent", - "cloudTrailEventSource": "bedrock.amazonaws.com" - }, - "aws.auth#sigv4": { - "name": "bedrock" - }, - "aws.protocols#restJson1": {}, - "smithy.api#cors": { - "additionalAllowedHeaders": [ - "*", - "content-type", - "x-amz-content-sha256", - "x-amz-user-agent", - "x-amzn-platform-id", - "x-amzn-trace-id" - ], - "additionalExposedHeaders": [ - "x-amzn-errortype", - "x-amzn-requestid", - "x-amzn-trace-id" - ], - "maxAge": 86400 - }, - "smithy.api#documentation": "Describes the API operations for creating and managing Amazon Bedrock agents.
", - "smithy.api#title": "Agents for Amazon Bedrock", - "smithy.rules#endpointRuleSet": { - "version": "1.0", - "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "String" - }, - "UseDualStack": { - "builtIn": "AWS::UseDualStack", - "required": true, - "default": false, - "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", - "type": "Boolean" - }, - "UseFIPS": { - "builtIn": "AWS::UseFIPS", - "required": true, - "default": false, - "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", - "type": "Boolean" - }, - "Endpoint": { - "builtIn": "SDK::Endpoint", - "required": false, - "documentation": "Override the endpoint used to send this request", - "type": "String" - } - }, - "rules": [ - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "rules": [ - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://bedrock-agent-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - }, - true - ] - } - ], - "rules": [ - { - "conditions": [], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://bedrock-agent-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://bedrock-agent.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://bedrock-agent.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ], - "type": "tree" - } - ] - }, - "smithy.rules#endpointTests": { - "testCases": [ - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://bedrock-agent-fips.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://bedrock-agent-fips.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://bedrock-agent.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://bedrock-agent.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://bedrock-agent-fips.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://bedrock-agent-fips.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://bedrock-agent.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://bedrock-agent.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://bedrock-agent-fips.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://bedrock-agent-fips.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://bedrock-agent.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://bedrock-agent.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://bedrock-agent-fips.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://bedrock-agent.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://bedrock-agent-fips.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://bedrock-agent.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with fips enabled and dualstack disabled", - "expect": { - "error": "Invalid Configuration: FIPS and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with fips disabled and dualstack enabled", - "expect": { - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "Missing region", - "expect": { - "error": "Invalid Configuration: Missing Region" - } - } - ], - "version": "1.0" - } - } - }, - "com.amazonaws.bedrockagent#AssociateAgentKnowledgeBase": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#AssociateAgentKnowledgeBaseRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#AssociateAgentKnowledgeBaseResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#ConflictException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Associates a knowledge base with an agent. If a knowledge base is associated and its indexState
is set to Enabled
, the agent queries the knowledge base for information to augment its response to the user.
The unique identifier of the agent with which you want to associate the knowledge base.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "agentVersion": { - "target": "com.amazonaws.bedrockagent#DraftVersion", - "traits": { - "smithy.api#documentation": "The version of the agent with which you want to associate the knowledge base.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "knowledgeBaseId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the knowledge base to associate with the agent.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#Description", - "traits": { - "smithy.api#documentation": "A description of what the agent should use the knowledge base for.
", - "smithy.api#required": {} - } - }, - "knowledgeBaseState": { - "target": "com.amazonaws.bedrockagent#KnowledgeBaseState", - "traits": { - "smithy.api#documentation": "Specifies whether to use the knowledge base or not when sending an InvokeAgent request.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#AssociateAgentKnowledgeBaseResponse": { - "type": "structure", - "members": { - "agentKnowledgeBase": { - "target": "com.amazonaws.bedrockagent#AgentKnowledgeBase", - "traits": { - "smithy.api#documentation": "Contains details about the knowledge base that has been associated with the agent.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#BasePromptTemplate": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100000 - }, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.bedrockagent#BedrockEmbeddingModelArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 2048 - }, - "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|([0-9]{12}:provisioned-model/[a-z0-9]{12})))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|(([0-9a-zA-Z][_-]?)+)$" - } - }, - "com.amazonaws.bedrockagent#BedrockEmbeddingModelConfiguration": { - "type": "structure", - "members": { - "dimensions": { - "target": "com.amazonaws.bedrockagent#Dimensions", - "traits": { - "smithy.api#documentation": "The dimensions details for the vector configuration used on the Bedrock embeddings model.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The vector configuration details for the Bedrock embeddings model.
" - } - }, - "com.amazonaws.bedrockagent#BedrockFoundationModelConfiguration": { - "type": "structure", - "members": { - "modelArn": { - "target": "com.amazonaws.bedrockagent#BedrockModelArn", - "traits": { - "smithy.api#documentation": "The model's ARN.
", - "smithy.api#required": {} - } - }, - "parsingPrompt": { - "target": "com.amazonaws.bedrockagent#ParsingPrompt", - "traits": { - "smithy.api#documentation": "Instructions for interpreting the contents of a document.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Settings for a foundation model used to parse documents for a data source.
" - } - }, - "com.amazonaws.bedrockagent#BedrockModelArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - }, - "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model/([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})$" - } - }, - "com.amazonaws.bedrockagent#BucketOwnerAccountId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 12, - "max": 12 - }, - "smithy.api#pattern": "^[0-9]{12}$" - } - }, - "com.amazonaws.bedrockagent#ChunkingConfiguration": { - "type": "structure", - "members": { - "chunkingStrategy": { - "target": "com.amazonaws.bedrockagent#ChunkingStrategy", - "traits": { - "smithy.api#documentation": "Knowledge base can split your source data into chunks. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. You have the following options for chunking your data. If you opt for NONE
, then you may want to pre-process your files by splitting them up such that each file corresponds to a chunk.
\n FIXED_SIZE
– Amazon Bedrock splits your source data into chunks of the approximate size that you set in the fixedSizeChunkingConfiguration
.
\n HIERARCHICAL
– Split documents into layers of chunks where the first layer contains large chunks, and the second layer contains smaller chunks derived from the first layer.
\n SEMANTIC
– Split documents into chunks based on groups of similar content derived with natural language processing.
\n NONE
– Amazon Bedrock treats each file as one chunk. If you choose this option, you may want to pre-process your documents by splitting them into separate files.
Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy
as NONE
, exclude this field.
Settings for hierarchical document chunking for a data source. Hierarchical chunking splits documents\n into layers of chunks where the first layer contains large chunks, and the second layer contains smaller\n chunks derived from the first layer.
" - } - }, - "semanticChunkingConfiguration": { - "target": "com.amazonaws.bedrockagent#SemanticChunkingConfiguration", - "traits": { - "smithy.api#documentation": "Settings for semantic document chunking for a data source. Semantic chunking splits\n a document into into smaller documents based on groups of similar content derived from the text\n with natural language processing.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.
" - } - }, - "com.amazonaws.bedrockagent#ChunkingStrategy": { - "type": "enum", - "members": { - "FIXED_SIZE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FIXED_SIZE" - } - }, - "NONE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NONE" - } - }, - "HIERARCHICAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HIERARCHICAL" - } - }, - "SEMANTIC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SEMANTIC" - } - } - } - }, - "com.amazonaws.bedrockagent#ClientToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 33, - "max": 256 - }, - "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,256}$" - } - }, - "com.amazonaws.bedrockagent#CollectorFlowNodeConfiguration": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "Defines a collector node in your flow. This node takes an iteration of inputs and consolidates them into an array in the output. For more information, see Node types in Amazon Bedrock works in the Amazon Bedrock User Guide.
" - } - }, - "com.amazonaws.bedrockagent#ColumnName": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 63 - }, - "smithy.api#pattern": "^[a-zA-Z0-9_\\-]+$" - } - }, - "com.amazonaws.bedrockagent#ConditionFlowNodeConfiguration": { - "type": "structure", - "members": { - "conditions": { - "target": "com.amazonaws.bedrockagent#FlowConditions", - "traits": { - "smithy.api#documentation": "An array of conditions. Each member contains the name of a condition and an expression that defines the condition.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Defines a condition node in your flow. You can specify conditions that determine which node comes next in the flow. For more information, see Node types in Amazon Bedrock works in the Amazon Bedrock User Guide.
" - } - }, - "com.amazonaws.bedrockagent#ConflictException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.bedrockagent#NonBlankString" - } - }, - "traits": { - "smithy.api#documentation": "There was a conflict performing an operation.
", - "smithy.api#error": "client", - "smithy.api#httpError": 409 - } - }, - "com.amazonaws.bedrockagent#ConfluenceAuthType": { - "type": "enum", - "members": { - "BASIC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BASIC" - } - }, - "OAUTH2_CLIENT_CREDENTIALS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OAUTH2_CLIENT_CREDENTIALS" - } - } - } - }, - "com.amazonaws.bedrockagent#ConfluenceCrawlerConfiguration": { - "type": "structure", - "members": { - "filterConfiguration": { - "target": "com.amazonaws.bedrockagent#CrawlFilterConfiguration", - "traits": { - "smithy.api#documentation": "The configuration of filtering the Confluence content. For example, configuring \n regular expression patterns to include or exclude certain content.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The configuration of the Confluence content. For example, configuring specific \n types of Confluence content.
" - } - }, - "com.amazonaws.bedrockagent#ConfluenceDataSourceConfiguration": { - "type": "structure", - "members": { - "sourceConfiguration": { - "target": "com.amazonaws.bedrockagent#ConfluenceSourceConfiguration", - "traits": { - "smithy.api#documentation": "The endpoint information to connect to your Confluence data source.
", - "smithy.api#required": {} - } - }, - "crawlerConfiguration": { - "target": "com.amazonaws.bedrockagent#ConfluenceCrawlerConfiguration", - "traits": { - "smithy.api#documentation": "The configuration of the Confluence content. For example, configuring \n specific types of Confluence content.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The configuration information to connect to Confluence as your data source.
" - } - }, - "com.amazonaws.bedrockagent#ConfluenceHostType": { - "type": "enum", - "members": { - "SAAS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SAAS" - } - } - } - }, - "com.amazonaws.bedrockagent#ConfluenceSourceConfiguration": { - "type": "structure", - "members": { - "hostUrl": { - "target": "com.amazonaws.bedrockagent#HttpsUrl", - "traits": { - "smithy.api#documentation": "The Confluence host URL or instance URL.
", - "smithy.api#required": {} - } - }, - "hostType": { - "target": "com.amazonaws.bedrockagent#ConfluenceHostType", - "traits": { - "smithy.api#documentation": "The supported host type, whether online/cloud or server/on-premises.
", - "smithy.api#required": {} - } - }, - "authType": { - "target": "com.amazonaws.bedrockagent#ConfluenceAuthType", - "traits": { - "smithy.api#documentation": "The supported authentication type to authenticate and connect to your \n Confluence instance.
", - "smithy.api#required": {} - } - }, - "credentialsSecretArn": { - "target": "com.amazonaws.bedrockagent#SecretArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name of an Secrets Manager secret that \n stores your authentication credentials for your Confluence instance URL. \n For more information on the key-value pairs that must be included in \n your secret, depending on your authentication type, see \n Confluence connection configuration.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "The endpoint information to connect to your Confluence data source.
" - } - }, - "com.amazonaws.bedrockagent#CrawlFilterConfiguration": { - "type": "structure", - "members": { - "type": { - "target": "com.amazonaws.bedrockagent#CrawlFilterConfigurationType", - "traits": { - "smithy.api#documentation": "The type of filtering that you want to apply to certain objects or content of the \n data source. For example, the PATTERN
type is regular expression patterns \n you can apply to filter your content.
The configuration of filtering certain objects or content types of the data source.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The configuration of filtering the data source content. For example, \n configuring regular expression patterns to include or exclude certain content.
" - } - }, - "com.amazonaws.bedrockagent#CrawlFilterConfigurationType": { - "type": "enum", - "members": { - "PATTERN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PATTERN" - } - } - } - }, - "com.amazonaws.bedrockagent#CreateAgent": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#CreateAgentRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#CreateAgentResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#ConflictException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Creates an agent that orchestrates interactions between foundation models, data sources, software applications, user conversations, and APIs to carry out tasks to help customers.
\nSpecify the following fields for security purposes.
\n\n agentResourceRoleArn
– The Amazon Resource Name (ARN) of the role with permissions to invoke API operations on an agent.
(Optional) customerEncryptionKeyArn
– The Amazon Resource Name (ARN) of a KMS key to encrypt the creation of the agent.
(Optional) idleSessionTTLinSeconds
– Specify the number of seconds for which the agent should maintain session information. After this time expires, the subsequent InvokeAgent
request begins a new session.
To enable your agent to retain conversational context across multiple sessions, include a memoryConfiguration
object. \n For more information, see Configure memory.
To override the default prompt behavior for agent orchestration and to use advanced prompts, include a promptOverrideConfiguration
object. \n For more information, see Advanced prompts.
If your agent fails to be created, the response returns a list of failureReasons
alongside a list of recommendedActions
for you to troubleshoot.
The agent instructions will not be honored if your agent has only one knowledge base, uses default prompts, has no action group, and user input is disabled.
\nCreates 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.
\nTo allow your agent to request the user for additional information when trying to complete a task, \n 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, \n 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.
The unique identifier of the agent for which to create the action group.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "agentVersion": { - "target": "com.amazonaws.bedrockagent#DraftVersion", - "traits": { - "smithy.api#documentation": "The version of the agent for which to create the action group.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "actionGroupName": { - "target": "com.amazonaws.bedrockagent#Name", - "traits": { - "smithy.api#documentation": "The name to give the action group.
", - "smithy.api#required": {} - } - }, - "clientToken": { - "target": "com.amazonaws.bedrockagent#ClientToken", - "traits": { - "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", - "smithy.api#idempotencyToken": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#Description", - "traits": { - "smithy.api#documentation": "A description of the action group.
" - } - }, - "parentActionGroupSignature": { - "target": "com.amazonaws.bedrockagent#ActionGroupSignature", - "traits": { - "smithy.api#documentation": "To allow your agent to request the user for additional information when trying to complete a task, set this field to AMAZON.UserInput
. You must leave the description
, apiSchema
, and actionGroupExecutor
fields blank for this action group.
To allow your agent to generate, run, and troubleshoot code when trying to complete a task, set this field 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.
" - } - }, - "actionGroupExecutor": { - "target": "com.amazonaws.bedrockagent#ActionGroupExecutor", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.
" - } - }, - "apiSchema": { - "target": "com.amazonaws.bedrockagent#APISchema", - "traits": { - "smithy.api#documentation": "Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas.
" - } - }, - "actionGroupState": { - "target": "com.amazonaws.bedrockagent#ActionGroupState", - "traits": { - "smithy.api#documentation": "Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
" - } - }, - "functionSchema": { - "target": "com.amazonaws.bedrockagent#FunctionSchema", - "traits": { - "smithy.api#documentation": "Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#CreateAgentActionGroupResponse": { - "type": "structure", - "members": { - "agentActionGroup": { - "target": "com.amazonaws.bedrockagent#AgentActionGroup", - "traits": { - "smithy.api#documentation": "Contains details about the action group that was created.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#CreateAgentAlias": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#CreateAgentAliasRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#CreateAgentAliasResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#ConflictException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Creates an alias of an agent that can be used to deploy the agent.
", - "smithy.api#http": { - "code": 202, - "method": "PUT", - "uri": "/agents/{agentId}/agentaliases/" - }, - "smithy.api#idempotent": {}, - "smithy.api#tags": [ - "console" - ] - } - }, - "com.amazonaws.bedrockagent#CreateAgentAliasRequest": { - "type": "structure", - "members": { - "agentId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the agent.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "agentAliasName": { - "target": "com.amazonaws.bedrockagent#Name", - "traits": { - "smithy.api#documentation": "The name of the alias.
", - "smithy.api#required": {} - } - }, - "clientToken": { - "target": "com.amazonaws.bedrockagent#ClientToken", - "traits": { - "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", - "smithy.api#idempotencyToken": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#Description", - "traits": { - "smithy.api#documentation": "A description of the alias of the agent.
" - } - }, - "routingConfiguration": { - "target": "com.amazonaws.bedrockagent#AgentAliasRoutingConfiguration", - "traits": { - "smithy.api#documentation": "Contains details about the routing configuration of the alias.
" - } - }, - "tags": { - "target": "com.amazonaws.bedrockagent#TagsMap", - "traits": { - "smithy.api#documentation": "Any tags that you want to attach to the alias of the agent.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#CreateAgentAliasResponse": { - "type": "structure", - "members": { - "agentAlias": { - "target": "com.amazonaws.bedrockagent#AgentAlias", - "traits": { - "smithy.api#documentation": "Contains details about the alias that was created.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#CreateAgentRequest": { - "type": "structure", - "members": { - "agentName": { - "target": "com.amazonaws.bedrockagent#Name", - "traits": { - "smithy.api#documentation": "A name for the agent that you create.
", - "smithy.api#required": {} - } - }, - "clientToken": { - "target": "com.amazonaws.bedrockagent#ClientToken", - "traits": { - "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", - "smithy.api#idempotencyToken": {} - } - }, - "instruction": { - "target": "com.amazonaws.bedrockagent#Instruction", - "traits": { - "smithy.api#documentation": "Instructions that tell the agent what it should do and how it should interact with users.
" - } - }, - "foundationModel": { - "target": "com.amazonaws.bedrockagent#ModelIdentifier", - "traits": { - "smithy.api#documentation": "The foundation model to be used for orchestration by the agent you create.
" - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#Description", - "traits": { - "smithy.api#documentation": "A description of the agent.
" - } - }, - "idleSessionTTLInSeconds": { - "target": "com.amazonaws.bedrockagent#SessionTTL", - "traits": { - "smithy.api#documentation": "The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.
\nA user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.
" - } - }, - "agentResourceRoleArn": { - "target": "com.amazonaws.bedrockagent#AgentRoleArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
" - } - }, - "customerEncryptionKeyArn": { - "target": "com.amazonaws.bedrockagent#KmsKeyArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.
" - } - }, - "tags": { - "target": "com.amazonaws.bedrockagent#TagsMap", - "traits": { - "smithy.api#documentation": "Any tags that you want to attach to the agent.
" - } - }, - "promptOverrideConfiguration": { - "target": "com.amazonaws.bedrockagent#PromptOverrideConfiguration", - "traits": { - "smithy.api#documentation": "Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.
" - } - }, - "guardrailConfiguration": { - "target": "com.amazonaws.bedrockagent#GuardrailConfiguration", - "traits": { - "smithy.api#documentation": "The unique Guardrail configuration assigned to the agent when it is created.
" - } - }, - "memoryConfiguration": { - "target": "com.amazonaws.bedrockagent#MemoryConfiguration", - "traits": { - "smithy.api#documentation": "Contains the details of the memory configured for the agent.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#CreateAgentResponse": { - "type": "structure", - "members": { - "agent": { - "target": "com.amazonaws.bedrockagent#Agent", - "traits": { - "smithy.api#documentation": "Contains details about the agent created.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#CreateDataSource": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#CreateDataSourceRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#CreateDataSourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#ConflictException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Creates a data source connector for a knowledge base.
\nYou can't change the chunkingConfiguration
after you create the data source connector.
The unique identifier of the knowledge base to which to add the data source.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "clientToken": { - "target": "com.amazonaws.bedrockagent#ClientToken", - "traits": { - "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", - "smithy.api#idempotencyToken": {} - } - }, - "name": { - "target": "com.amazonaws.bedrockagent#Name", - "traits": { - "smithy.api#documentation": "The name of the data source.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#Description", - "traits": { - "smithy.api#documentation": "A description of the data source.
" - } - }, - "dataSourceConfiguration": { - "target": "com.amazonaws.bedrockagent#DataSourceConfiguration", - "traits": { - "smithy.api#documentation": "The connection configuration for the data source.
", - "smithy.api#required": {} - } - }, - "dataDeletionPolicy": { - "target": "com.amazonaws.bedrockagent#DataDeletionPolicy", - "traits": { - "smithy.api#documentation": "The data deletion policy for the data source.
\nYou can set the data deletion policy to:
\nDELETE: Deletes all data from your data source that’s converted \n into vector embeddings upon deletion of a knowledge base or data source resource. \n Note that the vector store itself is not deleted, \n only the data. This flag is ignored if an Amazon Web Services account is deleted.
\nRETAIN: Retains all data from your data source that’s converted \n into vector embeddings upon deletion of a knowledge base or data source resource. \n Note that the vector store itself is not deleted \n if you delete a knowledge base or data source resource.
\nContains details about the server-side encryption for the data source.
" - } - }, - "vectorIngestionConfiguration": { - "target": "com.amazonaws.bedrockagent#VectorIngestionConfiguration", - "traits": { - "smithy.api#documentation": "Contains details about how to ingest the documents in the data source.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#CreateDataSourceResponse": { - "type": "structure", - "members": { - "dataSource": { - "target": "com.amazonaws.bedrockagent#DataSource", - "traits": { - "smithy.api#documentation": "Contains details about the data source.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#CreateFlow": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#CreateFlowRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#CreateFlowResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#ConflictException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Creates a prompt flow that you can use to send an input through various steps to yield an output. Configure nodes, each of which corresponds to a step of the flow, and create connections between the nodes to create paths to different outputs. For more information, see How it works and Create a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
", - "smithy.api#http": { - "code": 201, - "method": "POST", - "uri": "/flows/" - }, - "smithy.api#idempotent": {}, - "smithy.api#tags": [ - "console" - ] - } - }, - "com.amazonaws.bedrockagent#CreateFlowAlias": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#CreateFlowAliasRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#CreateFlowAliasResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#ConflictException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Creates an alias of a flow for deployment. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
", - "smithy.api#http": { - "code": 201, - "method": "POST", - "uri": "/flows/{flowIdentifier}/aliases" - }, - "smithy.api#idempotent": {}, - "smithy.api#tags": [ - "console" - ] - } - }, - "com.amazonaws.bedrockagent#CreateFlowAliasRequest": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.bedrockagent#Name", - "traits": { - "smithy.api#documentation": "A name for the alias.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#Description", - "traits": { - "smithy.api#documentation": "A description for the alias.
" - } - }, - "routingConfiguration": { - "target": "com.amazonaws.bedrockagent#FlowAliasRoutingConfiguration", - "traits": { - "smithy.api#documentation": "Contains information about the version to which to map the alias.
", - "smithy.api#required": {} - } - }, - "flowIdentifier": { - "target": "com.amazonaws.bedrockagent#FlowIdentifier", - "traits": { - "smithy.api#documentation": "The unique identifier of the flow for which to create an alias.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "clientToken": { - "target": "com.amazonaws.bedrockagent#ClientToken", - "traits": { - "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", - "smithy.api#idempotencyToken": {} - } - }, - "tags": { - "target": "com.amazonaws.bedrockagent#TagsMap", - "traits": { - "aws.cloudformation#cfnMutability": "full", - "smithy.api#documentation": "Any tags that you want to attach to the alias of the flow. For more information, see Tagging resources in Amazon Bedrock.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#CreateFlowAliasResponse": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.bedrockagent#Name", - "traits": { - "smithy.api#documentation": "The name of the alias.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#Description", - "traits": { - "smithy.api#documentation": "The description of the alias.
" - } - }, - "routingConfiguration": { - "target": "com.amazonaws.bedrockagent#FlowAliasRoutingConfiguration", - "traits": { - "smithy.api#documentation": "Contains information about the version that the alias is mapped to.
", - "smithy.api#required": {} - } - }, - "flowId": { - "target": "com.amazonaws.bedrockagent#FlowId", - "traits": { - "smithy.api#documentation": "The unique identifier of the flow that the alias belongs to.
", - "smithy.api#required": {} - } - }, - "id": { - "target": "com.amazonaws.bedrockagent#FlowAliasId", - "traits": { - "smithy.api#documentation": "The unique identifier of the alias.
", - "smithy.api#required": {} - } - }, - "arn": { - "target": "com.amazonaws.bedrockagent#FlowAliasArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the alias.
", - "smithy.api#required": {} - } - }, - "createdAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the alias was created.
", - "smithy.api#required": {} - } - }, - "updatedAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the alias of the flow was last updated.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#CreateFlowRequest": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.bedrockagent#FlowName", - "traits": { - "smithy.api#documentation": "A name for the flow.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#FlowDescription", - "traits": { - "smithy.api#documentation": "A description for the flow.
" - } - }, - "executionRoleArn": { - "target": "com.amazonaws.bedrockagent#FlowExecutionRoleArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service role with permissions to create and manage a flow. For more information, see Create a service role for flows in Amazon Bedrock in the Amazon Bedrock User Guide.
", - "smithy.api#required": {} - } - }, - "customerEncryptionKeyArn": { - "target": "com.amazonaws.bedrockagent#KmsKeyArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key to encrypt the flow.
" - } - }, - "definition": { - "target": "com.amazonaws.bedrockagent#FlowDefinition", - "traits": { - "smithy.api#documentation": "A definition of the nodes and connections between nodes in the flow.
" - } - }, - "clientToken": { - "target": "com.amazonaws.bedrockagent#ClientToken", - "traits": { - "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", - "smithy.api#idempotencyToken": {} - } - }, - "tags": { - "target": "com.amazonaws.bedrockagent#TagsMap", - "traits": { - "aws.cloudformation#cfnMutability": "full", - "smithy.api#documentation": "Any tags that you want to attach to the flow. For more information, see Tagging resources in Amazon Bedrock.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#CreateFlowResponse": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.bedrockagent#FlowName", - "traits": { - "smithy.api#documentation": "The name of the flow.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#FlowDescription", - "traits": { - "smithy.api#documentation": "The description of the flow.
" - } - }, - "executionRoleArn": { - "target": "com.amazonaws.bedrockagent#FlowExecutionRoleArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service role with permissions to create a flow. For more information, see Create a service role for flows in Amazon Bedrock in the Amazon Bedrock User Guide.
", - "smithy.api#required": {} - } - }, - "customerEncryptionKeyArn": { - "target": "com.amazonaws.bedrockagent#KmsKeyArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key that you encrypted the flow with.
" - } - }, - "id": { - "target": "com.amazonaws.bedrockagent#FlowId", - "traits": { - "smithy.api#documentation": "The unique identifier of the flow.
", - "smithy.api#required": {} - } - }, - "arn": { - "target": "com.amazonaws.bedrockagent#FlowArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the flow.
", - "smithy.api#required": {} - } - }, - "status": { - "target": "com.amazonaws.bedrockagent#FlowStatus", - "traits": { - "smithy.api#documentation": "The status of the flow. When you submit this request, the status will be NotPrepared
. If creation fails, the status becomes Failed
.
The time at which the flow was created.
", - "smithy.api#required": {} - } - }, - "updatedAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the flow was last updated.
", - "smithy.api#required": {} - } - }, - "version": { - "target": "com.amazonaws.bedrockagent#DraftVersion", - "traits": { - "smithy.api#documentation": "The version of the flow. When you create a flow, the version created is the DRAFT
version.
A definition of the nodes and connections between nodes in the flow.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#CreateFlowVersion": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#CreateFlowVersionRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#CreateFlowVersionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#ConflictException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Creates a version of the flow that you can deploy. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
", - "smithy.api#http": { - "code": 201, - "method": "POST", - "uri": "/flows/{flowIdentifier}/versions" - }, - "smithy.api#idempotent": {}, - "smithy.api#tags": [ - "console" - ] - } - }, - "com.amazonaws.bedrockagent#CreateFlowVersionRequest": { - "type": "structure", - "members": { - "flowIdentifier": { - "target": "com.amazonaws.bedrockagent#FlowIdentifier", - "traits": { - "smithy.api#documentation": "The unique identifier of the flow that you want to create a version of.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#FlowDescription", - "traits": { - "smithy.api#documentation": "A description of the version of the flow.
" - } - }, - "clientToken": { - "target": "com.amazonaws.bedrockagent#ClientToken", - "traits": { - "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#CreateFlowVersionResponse": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.bedrockagent#FlowName", - "traits": { - "smithy.api#documentation": "The name of the version.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#FlowDescription", - "traits": { - "smithy.api#documentation": "The description of the version.
" - } - }, - "executionRoleArn": { - "target": "com.amazonaws.bedrockagent#FlowExecutionRoleArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service role with permissions to create a flow. For more information, see Create a service role for flows in Amazon Bedrock in the Amazon Bedrock User Guide.
", - "smithy.api#required": {} - } - }, - "customerEncryptionKeyArn": { - "target": "com.amazonaws.bedrockagent#KmsKeyArn", - "traits": { - "smithy.api#documentation": "The KMS key that the flow is encrypted with.
" - } - }, - "id": { - "target": "com.amazonaws.bedrockagent#FlowId", - "traits": { - "smithy.api#documentation": "The unique identifier of the flow.
", - "smithy.api#required": {} - } - }, - "arn": { - "target": "com.amazonaws.bedrockagent#FlowArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the flow.
", - "smithy.api#required": {} - } - }, - "status": { - "target": "com.amazonaws.bedrockagent#FlowStatus", - "traits": { - "smithy.api#documentation": "The status of the flow.
", - "smithy.api#required": {} - } - }, - "createdAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the flow was created.
", - "smithy.api#required": {} - } - }, - "version": { - "target": "com.amazonaws.bedrockagent#NumericalVersion", - "traits": { - "smithy.api#documentation": "The version of the flow that was created. Versions are numbered incrementally, starting from 1.
", - "smithy.api#required": {} - } - }, - "definition": { - "target": "com.amazonaws.bedrockagent#FlowDefinition", - "traits": { - "smithy.api#documentation": "A definition of the nodes and connections in the flow.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#CreateKnowledgeBase": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#CreateKnowledgeBaseRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#CreateKnowledgeBaseResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#ConflictException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Creates a knowledge base that contains data sources from which information can be queried and used by LLMs. To create a knowledge base, you must first set up your data sources and configure a supported vector store. For more information, see Set up your data for ingestion.
\nIf you prefer to let Amazon Bedrock create and manage a vector store for you in Amazon OpenSearch Service, use the console. For more information, see Create a knowledge base.
\nProvide the name
and an optional description
.
Provide the Amazon Resource Name (ARN) with permissions to create a knowledge base in the roleArn
field.
Provide the embedding model to use in the embeddingModelArn
field in the knowledgeBaseConfiguration
object.
Provide the configuration for your vector store in the storageConfiguration
object.
For an Amazon OpenSearch Service database, use the opensearchServerlessConfiguration
object. For more information, see Create a vector store in Amazon OpenSearch Service.
For an Amazon Aurora database, use the RdsConfiguration
object. For more information, see Create a vector store in Amazon Aurora.
For a Pinecone database, use the pineconeConfiguration
object. For more information, see Create a vector store in Pinecone.
For a Redis Enterprise Cloud database, use the redisEnterpriseCloudConfiguration
object. For more information, see Create a vector store in Redis Enterprise Cloud.
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", - "smithy.api#idempotencyToken": {} - } - }, - "name": { - "target": "com.amazonaws.bedrockagent#Name", - "traits": { - "smithy.api#documentation": "A name for the knowledge base.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#Description", - "traits": { - "smithy.api#documentation": "A description of the knowledge base.
" - } - }, - "roleArn": { - "target": "com.amazonaws.bedrockagent#KnowledgeBaseRoleArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
", - "smithy.api#required": {} - } - }, - "knowledgeBaseConfiguration": { - "target": "com.amazonaws.bedrockagent#KnowledgeBaseConfiguration", - "traits": { - "smithy.api#documentation": "Contains details about the embeddings model used for the knowledge base.
", - "smithy.api#required": {} - } - }, - "storageConfiguration": { - "target": "com.amazonaws.bedrockagent#StorageConfiguration", - "traits": { - "smithy.api#documentation": "Contains details about the configuration of the vector database used for the knowledge base.
", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.bedrockagent#TagsMap", - "traits": { - "smithy.api#documentation": "Specify the key-value pairs for the tags that you want to attach to your knowledge base in this object.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#CreateKnowledgeBaseResponse": { - "type": "structure", - "members": { - "knowledgeBase": { - "target": "com.amazonaws.bedrockagent#KnowledgeBase", - "traits": { - "smithy.api#documentation": "Contains details about the knowledge base.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#CreatePrompt": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#CreatePromptRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#CreatePromptResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#ConflictException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Creates a prompt in your prompt library that you can add to a flow. For more information, see Prompt management in Amazon Bedrock, Create a prompt using Prompt management and Prompt flows in Amazon Bedrock in the Amazon Bedrock User Guide.
", - "smithy.api#http": { - "code": 201, - "method": "POST", - "uri": "/prompts/" - }, - "smithy.api#idempotent": {}, - "smithy.api#tags": [ - "console" - ] - } - }, - "com.amazonaws.bedrockagent#CreatePromptRequest": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.bedrockagent#PromptName", - "traits": { - "smithy.api#documentation": "A name for the prompt.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#PromptDescription", - "traits": { - "smithy.api#documentation": "A description for the prompt.
" - } - }, - "customerEncryptionKeyArn": { - "target": "com.amazonaws.bedrockagent#KmsKeyArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key to encrypt the prompt.
" - } - }, - "defaultVariant": { - "target": "com.amazonaws.bedrockagent#PromptVariantName", - "traits": { - "smithy.api#documentation": "The name of the default variant for the prompt. This value must match the name
field in the relevant PromptVariant object.
A list of objects, each containing details about a variant of the prompt.
" - } - }, - "clientToken": { - "target": "com.amazonaws.bedrockagent#ClientToken", - "traits": { - "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", - "smithy.api#idempotencyToken": {} - } - }, - "tags": { - "target": "com.amazonaws.bedrockagent#TagsMap", - "traits": { - "aws.cloudformation#cfnMutability": "full", - "smithy.api#documentation": "Any tags that you want to attach to the prompt. For more information, see Tagging resources in Amazon Bedrock.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#CreatePromptResponse": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.bedrockagent#PromptName", - "traits": { - "smithy.api#documentation": "The name of the prompt.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#PromptDescription", - "traits": { - "smithy.api#documentation": "The description of the prompt.
" - } - }, - "customerEncryptionKeyArn": { - "target": "com.amazonaws.bedrockagent#KmsKeyArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key that you encrypted the prompt with.
" - } - }, - "defaultVariant": { - "target": "com.amazonaws.bedrockagent#PromptVariantName", - "traits": { - "smithy.api#documentation": "The name of the default variant for your prompt.
" - } - }, - "variants": { - "target": "com.amazonaws.bedrockagent#PromptVariantList", - "traits": { - "smithy.api#documentation": "A list of objects, each containing details about a variant of the prompt.
" - } - }, - "id": { - "target": "com.amazonaws.bedrockagent#PromptId", - "traits": { - "smithy.api#documentation": "The unique identifier of the prompt.
", - "smithy.api#required": {} - } - }, - "arn": { - "target": "com.amazonaws.bedrockagent#PromptArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the prompt.
", - "smithy.api#required": {} - } - }, - "version": { - "target": "com.amazonaws.bedrockagent#Version", - "traits": { - "smithy.api#documentation": "The version of the prompt. When you create a prompt, the version created is the DRAFT
version.
The time at which the prompt was created.
", - "smithy.api#required": {} - } - }, - "updatedAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the prompt was last updated.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#CreatePromptVersion": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#CreatePromptVersionRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#CreatePromptVersionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#ConflictException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Creates a static snapshot of your prompt that can be deployed to production. For more information, see Deploy prompts using Prompt management by creating versions in the Amazon Bedrock User Guide.
", - "smithy.api#http": { - "code": 201, - "method": "POST", - "uri": "/prompts/{promptIdentifier}/versions" - }, - "smithy.api#idempotent": {}, - "smithy.api#tags": [ - "console" - ] - } - }, - "com.amazonaws.bedrockagent#CreatePromptVersionRequest": { - "type": "structure", - "members": { - "promptIdentifier": { - "target": "com.amazonaws.bedrockagent#PromptIdentifier", - "traits": { - "smithy.api#documentation": "The unique identifier of the prompt that you want to create a version of.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#PromptDescription", - "traits": { - "smithy.api#documentation": "A description for the version of the prompt.
" - } - }, - "clientToken": { - "target": "com.amazonaws.bedrockagent#ClientToken", - "traits": { - "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", - "smithy.api#idempotencyToken": {} - } - }, - "tags": { - "target": "com.amazonaws.bedrockagent#TagsMap", - "traits": { - "aws.cloudformation#cfnMutability": "full", - "smithy.api#documentation": "Any tags that you want to attach to the version of the prompt. For more information, see Tagging resources in Amazon Bedrock.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#CreatePromptVersionResponse": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.bedrockagent#PromptName", - "traits": { - "smithy.api#documentation": "The name of the prompt.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#PromptDescription", - "traits": { - "smithy.api#documentation": "A description for the version.
" - } - }, - "customerEncryptionKeyArn": { - "target": "com.amazonaws.bedrockagent#KmsKeyArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key to encrypt the version of the prompt.
" - } - }, - "defaultVariant": { - "target": "com.amazonaws.bedrockagent#PromptVariantName", - "traits": { - "smithy.api#documentation": "The name of the default variant for the prompt. This value must match the name
field in the relevant PromptVariant object.
A list of objects, each containing details about a variant of the prompt.
" - } - }, - "id": { - "target": "com.amazonaws.bedrockagent#PromptId", - "traits": { - "smithy.api#documentation": "The unique identifier of the prompt.
", - "smithy.api#required": {} - } - }, - "arn": { - "target": "com.amazonaws.bedrockagent#PromptArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the version of the prompt.
", - "smithy.api#required": {} - } - }, - "version": { - "target": "com.amazonaws.bedrockagent#Version", - "traits": { - "smithy.api#documentation": "The version of the prompt that was created. Versions are numbered incrementally, starting from 1.
", - "smithy.api#required": {} - } - }, - "createdAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the prompt was created.
", - "smithy.api#required": {} - } - }, - "updatedAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the prompt was last updated.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#CreationMode": { - "type": "enum", - "members": { - "DEFAULT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DEFAULT" - } - }, - "OVERRIDDEN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OVERRIDDEN" - } - } - } - }, - "com.amazonaws.bedrockagent#CustomControlMethod": { - "type": "enum", - "members": { - "RETURN_CONTROL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RETURN_CONTROL" - } - } - } - }, - "com.amazonaws.bedrockagent#CustomTransformationConfiguration": { - "type": "structure", - "members": { - "intermediateStorage": { - "target": "com.amazonaws.bedrockagent#IntermediateStorage", - "traits": { - "smithy.api#documentation": "An S3 bucket path for input and output objects.
", - "smithy.api#required": {} - } - }, - "transformations": { - "target": "com.amazonaws.bedrockagent#Transformations", - "traits": { - "smithy.api#documentation": "A Lambda function that processes documents.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Settings for customizing steps in the data source content ingestion pipeline.
\nYou can configure the data source to process documents with a Lambda function after\n they are parsed and converted into chunks. When you add a post-chunking transformation,\n the service stores chunked documents in an S3 bucket and invokes a Lambda function to process\n them.
\nTo process chunked documents with a Lambda function, define an S3 bucket path for input\n and output objects, and a transformation that specifies the Lambda function to invoke. You can\n use the Lambda function to customize how chunks are split, and the metadata for each chunk.\n
" - } - }, - "com.amazonaws.bedrockagent#DataDeletionPolicy": { - "type": "enum", - "members": { - "RETAIN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RETAIN" - } - }, - "DELETE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETE" - } - } - } - }, - "com.amazonaws.bedrockagent#DataSource": { - "type": "structure", - "members": { - "knowledgeBaseId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the knowledge base to which the data source belongs.
", - "smithy.api#required": {} - } - }, - "dataSourceId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the data source.
", - "smithy.api#required": {} - } - }, - "name": { - "target": "com.amazonaws.bedrockagent#Name", - "traits": { - "smithy.api#documentation": "The name of the data source.
", - "smithy.api#required": {} - } - }, - "status": { - "target": "com.amazonaws.bedrockagent#DataSourceStatus", - "traits": { - "smithy.api#documentation": "The status of the data source. The following statuses are possible:
\nAvailable – The data source has been created and is ready for ingestion into the knowledge base.
\nDeleting – The data source is being deleted.
\nThe description of the data source.
" - } - }, - "dataSourceConfiguration": { - "target": "com.amazonaws.bedrockagent#DataSourceConfiguration", - "traits": { - "smithy.api#documentation": "The connection configuration for the data source.
", - "smithy.api#required": {} - } - }, - "serverSideEncryptionConfiguration": { - "target": "com.amazonaws.bedrockagent#ServerSideEncryptionConfiguration", - "traits": { - "smithy.api#documentation": "Contains details about the configuration of the server-side encryption.
" - } - }, - "vectorIngestionConfiguration": { - "target": "com.amazonaws.bedrockagent#VectorIngestionConfiguration", - "traits": { - "smithy.api#documentation": "Contains details about how to ingest the documents in the data source.
" - } - }, - "dataDeletionPolicy": { - "target": "com.amazonaws.bedrockagent#DataDeletionPolicy", - "traits": { - "smithy.api#documentation": "The data deletion policy for the data source.
" - } - }, - "createdAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the data source was created.
", - "smithy.api#required": {} - } - }, - "updatedAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the data source was last updated.
", - "smithy.api#required": {} - } - }, - "failureReasons": { - "target": "com.amazonaws.bedrockagent#FailureReasons", - "traits": { - "smithy.api#documentation": "The detailed reasons on the failure to delete a data source.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains details about a data source.
" - } - }, - "com.amazonaws.bedrockagent#DataSourceConfiguration": { - "type": "structure", - "members": { - "type": { - "target": "com.amazonaws.bedrockagent#DataSourceType", - "traits": { - "smithy.api#documentation": "The type of data source.
", - "smithy.api#required": {} - } - }, - "s3Configuration": { - "target": "com.amazonaws.bedrockagent#S3DataSourceConfiguration", - "traits": { - "smithy.api#documentation": "The configuration information to connect to Amazon S3 as your data source.
" - } - }, - "webConfiguration": { - "target": "com.amazonaws.bedrockagent#WebDataSourceConfiguration", - "traits": { - "smithy.api#documentation": "The configuration of web URLs to crawl for your data source. \n You should be authorized to crawl the URLs.
\nCrawling web URLs as your data source is in preview release \n and is subject to change.
\nThe configuration information to connect to Confluence as your data source.
\nConfluence data source connector is in preview release and is subject to change.
\nThe configuration information to connect to Salesforce as your data source.
\nSalesforce data source connector is in preview release and is subject to change.
\nThe configuration information to connect to SharePoint as your data source.
\nSharePoint data source connector is in preview release and is subject to change.
\nThe connection configuration for the data source.
" - } - }, - "com.amazonaws.bedrockagent#DataSourceResource": { - "type": "resource", - "operations": [ - { - "target": "com.amazonaws.bedrockagent#CreateDataSource" - }, - { - "target": "com.amazonaws.bedrockagent#DeleteDataSource" - }, - { - "target": "com.amazonaws.bedrockagent#GetDataSource" - }, - { - "target": "com.amazonaws.bedrockagent#ListDataSources" - }, - { - "target": "com.amazonaws.bedrockagent#UpdateDataSource" - } - ] - }, - "com.amazonaws.bedrockagent#DataSourceStatus": { - "type": "enum", - "members": { - "AVAILABLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AVAILABLE" - } - }, - "DELETING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETING" - } - }, - "DELETE_UNSUCCESSFUL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETE_UNSUCCESSFUL" - } - } - } - }, - "com.amazonaws.bedrockagent#DataSourceSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagent#DataSourceSummary" - } - }, - "com.amazonaws.bedrockagent#DataSourceSummary": { - "type": "structure", - "members": { - "knowledgeBaseId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the knowledge base to which the data source belongs.
", - "smithy.api#required": {} - } - }, - "dataSourceId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the data source.
", - "smithy.api#required": {} - } - }, - "name": { - "target": "com.amazonaws.bedrockagent#Name", - "traits": { - "smithy.api#documentation": "The name of the data source.
", - "smithy.api#required": {} - } - }, - "status": { - "target": "com.amazonaws.bedrockagent#DataSourceStatus", - "traits": { - "smithy.api#documentation": "The status of the data source.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#Description", - "traits": { - "smithy.api#documentation": "The description of the data source.
" - } - }, - "updatedAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the data source was last updated.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains details about a data source.
" - } - }, - "com.amazonaws.bedrockagent#DataSourceType": { - "type": "enum", - "members": { - "S3": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "S3" - } - }, - "WEB": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WEB" - } - }, - "CONFLUENCE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONFLUENCE" - } - }, - "SALESFORCE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SALESFORCE" - } - }, - "SHAREPOINT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SHAREPOINT" - } - } - } - }, - "com.amazonaws.bedrockagent#DateTimestamp": { - "type": "timestamp", - "traits": { - "smithy.api#timestampFormat": "date-time" - } - }, - "com.amazonaws.bedrockagent#DeleteAgent": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#DeleteAgentRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#DeleteAgentResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#ConflictException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes an agent.
", - "smithy.api#http": { - "code": 202, - "method": "DELETE", - "uri": "/agents/{agentId}/" - }, - "smithy.api#idempotent": {}, - "smithy.api#tags": [ - "console" - ] - } - }, - "com.amazonaws.bedrockagent#DeleteAgentActionGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#DeleteAgentActionGroupRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#DeleteAgentActionGroupResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#ConflictException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes an action group in an agent.
", - "smithy.api#http": { - "code": 204, - "method": "DELETE", - "uri": "/agents/{agentId}/agentversions/{agentVersion}/actiongroups/{actionGroupId}/" - }, - "smithy.api#idempotent": {}, - "smithy.api#tags": [ - "console" - ] - } - }, - "com.amazonaws.bedrockagent#DeleteAgentActionGroupRequest": { - "type": "structure", - "members": { - "agentId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the agent that the action group belongs to.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "agentVersion": { - "target": "com.amazonaws.bedrockagent#DraftVersion", - "traits": { - "smithy.api#documentation": "The version of the agent that the action group belongs to.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "actionGroupId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the action group to delete.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "skipResourceInUseCheck": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "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.
Deletes an alias of an agent.
", - "smithy.api#http": { - "code": 202, - "method": "DELETE", - "uri": "/agents/{agentId}/agentaliases/{agentAliasId}/" - }, - "smithy.api#idempotent": {}, - "smithy.api#tags": [ - "console" - ] - } - }, - "com.amazonaws.bedrockagent#DeleteAgentAliasRequest": { - "type": "structure", - "members": { - "agentId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the agent that the alias belongs to.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "agentAliasId": { - "target": "com.amazonaws.bedrockagent#AgentAliasId", - "traits": { - "smithy.api#documentation": "The unique identifier of the alias to delete.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#DeleteAgentAliasResponse": { - "type": "structure", - "members": { - "agentId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the agent that the alias belongs to.
", - "smithy.api#required": {} - } - }, - "agentAliasId": { - "target": "com.amazonaws.bedrockagent#AgentAliasId", - "traits": { - "smithy.api#documentation": "The unique identifier of the alias that was deleted.
", - "smithy.api#required": {} - } - }, - "agentAliasStatus": { - "target": "com.amazonaws.bedrockagent#AgentAliasStatus", - "traits": { - "smithy.api#documentation": "The status of the alias.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#DeleteAgentRequest": { - "type": "structure", - "members": { - "agentId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the agent to delete.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "skipResourceInUseCheck": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "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.
The unique identifier of the agent that was deleted.
", - "smithy.api#required": {} - } - }, - "agentStatus": { - "target": "com.amazonaws.bedrockagent#AgentStatus", - "traits": { - "smithy.api#documentation": "The status of the agent.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#DeleteAgentVersion": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#DeleteAgentVersionRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#DeleteAgentVersionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#ConflictException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes a version of an agent.
", - "smithy.api#http": { - "code": 202, - "method": "DELETE", - "uri": "/agents/{agentId}/agentversions/{agentVersion}/" - }, - "smithy.api#idempotent": {}, - "smithy.api#tags": [ - "console" - ] - } - }, - "com.amazonaws.bedrockagent#DeleteAgentVersionRequest": { - "type": "structure", - "members": { - "agentId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the agent that the version belongs to.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "agentVersion": { - "target": "com.amazonaws.bedrockagent#NumericalVersion", - "traits": { - "smithy.api#documentation": "The version of the agent to delete.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "skipResourceInUseCheck": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "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.
The unique identifier of the agent that the version belongs to.
", - "smithy.api#required": {} - } - }, - "agentVersion": { - "target": "com.amazonaws.bedrockagent#NumericalVersion", - "traits": { - "smithy.api#documentation": "The version that was deleted.
", - "smithy.api#required": {} - } - }, - "agentStatus": { - "target": "com.amazonaws.bedrockagent#AgentStatus", - "traits": { - "smithy.api#documentation": "The status of the agent version.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#DeleteDataSource": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#DeleteDataSourceRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#DeleteDataSourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#ConflictException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes a data source from a knowledge base.
", - "smithy.api#http": { - "code": 202, - "method": "DELETE", - "uri": "/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}" - }, - "smithy.api#idempotent": {}, - "smithy.api#tags": [ - "console" - ] - } - }, - "com.amazonaws.bedrockagent#DeleteDataSourceRequest": { - "type": "structure", - "members": { - "knowledgeBaseId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the knowledge base from which to delete the data source.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "dataSourceId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the data source to delete.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#DeleteDataSourceResponse": { - "type": "structure", - "members": { - "knowledgeBaseId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the knowledge base to which the data source that was deleted belonged.
", - "smithy.api#required": {} - } - }, - "dataSourceId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the data source that was deleted.
", - "smithy.api#required": {} - } - }, - "status": { - "target": "com.amazonaws.bedrockagent#DataSourceStatus", - "traits": { - "smithy.api#documentation": "The status of the data source.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#DeleteFlow": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#DeleteFlowRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#DeleteFlowResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#ConflictException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes a flow.
", - "smithy.api#http": { - "code": 200, - "method": "DELETE", - "uri": "/flows/{flowIdentifier}/" - }, - "smithy.api#idempotent": {}, - "smithy.api#tags": [ - "console" - ] - } - }, - "com.amazonaws.bedrockagent#DeleteFlowAlias": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#DeleteFlowAliasRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#DeleteFlowAliasResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#ConflictException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes an alias of a flow.
", - "smithy.api#http": { - "code": 200, - "method": "DELETE", - "uri": "/flows/{flowIdentifier}/aliases/{aliasIdentifier}" - }, - "smithy.api#idempotent": {}, - "smithy.api#tags": [ - "console" - ] - } - }, - "com.amazonaws.bedrockagent#DeleteFlowAliasRequest": { - "type": "structure", - "members": { - "flowIdentifier": { - "target": "com.amazonaws.bedrockagent#FlowIdentifier", - "traits": { - "smithy.api#documentation": "The unique identifier of the flow that the alias belongs to.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "aliasIdentifier": { - "target": "com.amazonaws.bedrockagent#FlowAliasIdentifier", - "traits": { - "smithy.api#documentation": "The unique identifier of the alias to be deleted.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#DeleteFlowAliasResponse": { - "type": "structure", - "members": { - "flowId": { - "target": "com.amazonaws.bedrockagent#FlowId", - "traits": { - "smithy.api#documentation": "The unique identifier of the flow that the alias belongs to.
", - "smithy.api#required": {} - } - }, - "id": { - "target": "com.amazonaws.bedrockagent#FlowAliasId", - "traits": { - "smithy.api#documentation": "The unique identifier of the flow.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#DeleteFlowRequest": { - "type": "structure", - "members": { - "flowIdentifier": { - "target": "com.amazonaws.bedrockagent#FlowIdentifier", - "traits": { - "smithy.api#documentation": "The unique identifier of the flow.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "skipResourceInUseCheck": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "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.
The unique identifier of the flow.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#DeleteFlowVersion": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#DeleteFlowVersionRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#DeleteFlowVersionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#ConflictException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes a version of a flow.
", - "smithy.api#http": { - "code": 200, - "method": "DELETE", - "uri": "/flows/{flowIdentifier}/versions/{flowVersion}/" - }, - "smithy.api#idempotent": {}, - "smithy.api#tags": [ - "console" - ] - } - }, - "com.amazonaws.bedrockagent#DeleteFlowVersionRequest": { - "type": "structure", - "members": { - "flowIdentifier": { - "target": "com.amazonaws.bedrockagent#FlowIdentifier", - "traits": { - "smithy.api#documentation": "The unique identifier of the flow whose version that you want to delete
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "flowVersion": { - "target": "com.amazonaws.bedrockagent#NumericalVersion", - "traits": { - "smithy.api#documentation": "The version of the flow that you want to delete.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "skipResourceInUseCheck": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "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.
The unique identifier of the flow.
", - "smithy.api#required": {} - } - }, - "version": { - "target": "com.amazonaws.bedrockagent#NumericalVersion", - "traits": { - "smithy.api#documentation": "The version of the flow being deleted.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#DeleteKnowledgeBase": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#DeleteKnowledgeBaseRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#DeleteKnowledgeBaseResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#ConflictException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes a knowledge base. Before deleting a knowledge base, you should disassociate the knowledge base from any agents that it is associated with by making a DisassociateAgentKnowledgeBase request.
", - "smithy.api#http": { - "code": 202, - "method": "DELETE", - "uri": "/knowledgebases/{knowledgeBaseId}" - }, - "smithy.api#idempotent": {}, - "smithy.api#tags": [ - "console" - ] - } - }, - "com.amazonaws.bedrockagent#DeleteKnowledgeBaseRequest": { - "type": "structure", - "members": { - "knowledgeBaseId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the knowledge base to delete.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#DeleteKnowledgeBaseResponse": { - "type": "structure", - "members": { - "knowledgeBaseId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the knowledge base that was deleted.
", - "smithy.api#required": {} - } - }, - "status": { - "target": "com.amazonaws.bedrockagent#KnowledgeBaseStatus", - "traits": { - "smithy.api#documentation": "The status of the knowledge base and whether it has been successfully deleted.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#DeletePrompt": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#DeletePromptRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#DeletePromptResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#ConflictException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes a prompt or a version of it, depending on whether you include the promptVersion
field or not. For more information, see Delete prompts from the Prompt management tool and Delete a version of a prompt from the Prompt management tool in the Amazon Bedrock User Guide.
The unique identifier of the prompt.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "promptVersion": { - "target": "com.amazonaws.bedrockagent#NumericalVersion", - "traits": { - "smithy.api#documentation": "The version of the prompt to delete. To delete the prompt, omit this field.
", - "smithy.api#httpQuery": "promptVersion" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#DeletePromptResponse": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.bedrockagent#PromptId", - "traits": { - "smithy.api#documentation": "The unique identifier of the prompt that was deleted.
", - "smithy.api#required": {} - } - }, - "version": { - "target": "com.amazonaws.bedrockagent#NumericalVersion", - "traits": { - "smithy.api#documentation": "The version of the prompt that was deleted.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#Description": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 200 - } - } - }, - "com.amazonaws.bedrockagent#Dimensions": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0, - "max": 4096 - } - } - }, - "com.amazonaws.bedrockagent#DisassociateAgentKnowledgeBase": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#DisassociateAgentKnowledgeBaseRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#DisassociateAgentKnowledgeBaseResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#ConflictException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Disassociates a knowledge base from an agent.
", - "smithy.api#http": { - "code": 204, - "method": "DELETE", - "uri": "/agents/{agentId}/agentversions/{agentVersion}/knowledgebases/{knowledgeBaseId}/" - }, - "smithy.api#idempotent": {}, - "smithy.api#tags": [ - "console" - ] - } - }, - "com.amazonaws.bedrockagent#DisassociateAgentKnowledgeBaseRequest": { - "type": "structure", - "members": { - "agentId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the agent from which to disassociate the knowledge base.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "agentVersion": { - "target": "com.amazonaws.bedrockagent#DraftVersion", - "traits": { - "smithy.api#documentation": "The version of the agent from which to disassociate the knowledge base.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "knowledgeBaseId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the knowledge base to disassociate.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#DisassociateAgentKnowledgeBaseResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#DraftVersion": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 5, - "max": 5 - }, - "smithy.api#pattern": "^DRAFT$" - } - }, - "com.amazonaws.bedrockagent#EmbeddingModelConfiguration": { - "type": "structure", - "members": { - "bedrockEmbeddingModelConfiguration": { - "target": "com.amazonaws.bedrockagent#BedrockEmbeddingModelConfiguration", - "traits": { - "smithy.api#documentation": "The vector configuration details on the Bedrock embeddings model.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The configuration details for the embeddings model.
" - } - }, - "com.amazonaws.bedrockagent#EnabledMemoryTypes": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagent#MemoryType" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - } - } - }, - "com.amazonaws.bedrockagent#FailureReason": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 2048 - } - } - }, - "com.amazonaws.bedrockagent#FailureReasons": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagent#FailureReason" - }, - "traits": { - "smithy.api#length": { - "max": 2048 - } - } - }, - "com.amazonaws.bedrockagent#FieldName": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 2048 - }, - "smithy.api#pattern": "^.*$" - } - }, - "com.amazonaws.bedrockagent#FilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagent#FilterPattern" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 25 - }, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.bedrockagent#FilterPattern": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1000 - }, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.bedrockagent#FilteredObjectType": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - }, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.bedrockagent#FixedSizeChunkingConfiguration": { - "type": "structure", - "members": { - "maxTokens": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "The maximum number of tokens to include in a chunk.
", - "smithy.api#range": { - "min": 1 - }, - "smithy.api#required": {} - } - }, - "overlapPercentage": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "The percentage of overlap between adjacent chunks of a data source.
", - "smithy.api#range": { - "min": 1, - "max": 99 - }, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy
as NONE
, exclude this field.
The version that the alias maps to.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about a version that the alias maps to.
" - } - }, - "com.amazonaws.bedrockagent#FlowAliasSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagent#FlowAliasSummary" - }, - "traits": { - "smithy.api#length": { - "max": 10 - } - } - }, - "com.amazonaws.bedrockagent#FlowAliasSummary": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.bedrockagent#Name", - "traits": { - "smithy.api#documentation": "The name of the alias.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#Description", - "traits": { - "smithy.api#documentation": "A description of the alias.
" - } - }, - "routingConfiguration": { - "target": "com.amazonaws.bedrockagent#FlowAliasRoutingConfiguration", - "traits": { - "smithy.api#documentation": "A list of configurations about the versions that the alias maps to. Currently, you can only specify one.
", - "smithy.api#required": {} - } - }, - "flowId": { - "target": "com.amazonaws.bedrockagent#FlowId", - "traits": { - "smithy.api#documentation": "The unique identifier of the flow.
", - "smithy.api#required": {} - } - }, - "id": { - "target": "com.amazonaws.bedrockagent#FlowAliasId", - "traits": { - "smithy.api#documentation": "The unique identifier of the alias of the flow.
", - "smithy.api#required": {} - } - }, - "arn": { - "target": "com.amazonaws.bedrockagent#FlowAliasArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the alias.
", - "smithy.api#required": {} - } - }, - "createdAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the alias was created.
", - "smithy.api#required": {} - } - }, - "updatedAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the alias was last updated.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about an alias of a flow.
\nThis data type is used in the following API operations:
\nA name for the condition that you can reference.
", - "smithy.api#required": {} - } - }, - "expression": { - "target": "com.amazonaws.bedrockagent#FlowConditionExpression", - "traits": { - "smithy.api#documentation": "Defines the condition. You must refer to at least one of the inputs in the condition. For more information, expand the Condition node section in Node types in prompt flows.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Defines a condition in the condition node.
", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.bedrockagent#FlowConditionExpression": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.bedrockagent#FlowConditionName": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$" - } - }, - "com.amazonaws.bedrockagent#FlowConditionalConnectionConfiguration": { - "type": "structure", - "members": { - "condition": { - "target": "com.amazonaws.bedrockagent#FlowConditionName", - "traits": { - "smithy.api#documentation": "The condition that triggers this connection. For more information about how to write conditions, see the Condition node type in the Node types topic in the Amazon Bedrock User Guide.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "The configuration of a connection between a condition node and another node.
" - } - }, - "com.amazonaws.bedrockagent#FlowConditions": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagent#FlowCondition" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 5 - }, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.bedrockagent#FlowConnection": { - "type": "structure", - "members": { - "type": { - "target": "com.amazonaws.bedrockagent#FlowConnectionType", - "traits": { - "smithy.api#documentation": "Whether the source node that the connection begins from is a condition node (Conditional
) or not (Data
).
A name for the connection that you can reference.
", - "smithy.api#required": {} - } - }, - "source": { - "target": "com.amazonaws.bedrockagent#FlowNodeName", - "traits": { - "smithy.api#documentation": "The node that the connection starts at.
", - "smithy.api#required": {} - } - }, - "target": { - "target": "com.amazonaws.bedrockagent#FlowNodeName", - "traits": { - "smithy.api#documentation": "The node that the connection ends at.
", - "smithy.api#required": {} - } - }, - "configuration": { - "target": "com.amazonaws.bedrockagent#FlowConnectionConfiguration", - "traits": { - "smithy.api#documentation": "The configuration of the connection.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about a connection between two nodes in the flow.
" - } - }, - "com.amazonaws.bedrockagent#FlowConnectionConfiguration": { - "type": "union", - "members": { - "data": { - "target": "com.amazonaws.bedrockagent#FlowDataConnectionConfiguration", - "traits": { - "smithy.api#documentation": "The configuration of a connection originating from a node that isn't a Condition node.
" - } - }, - "conditional": { - "target": "com.amazonaws.bedrockagent#FlowConditionalConnectionConfiguration", - "traits": { - "smithy.api#documentation": "The configuration of a connection originating from a Condition node.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The configuration of the connection.
" - } - }, - "com.amazonaws.bedrockagent#FlowConnectionName": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){1,100}$" - } - }, - "com.amazonaws.bedrockagent#FlowConnectionType": { - "type": "enum", - "members": { - "DATA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Data" - } - }, - "CONDITIONAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Conditional" - } - } - } - }, - "com.amazonaws.bedrockagent#FlowConnections": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagent#FlowConnection" - }, - "traits": { - "smithy.api#length": { - "max": 20 - } - } - }, - "com.amazonaws.bedrockagent#FlowDataConnectionConfiguration": { - "type": "structure", - "members": { - "sourceOutput": { - "target": "com.amazonaws.bedrockagent#FlowNodeOutputName", - "traits": { - "smithy.api#documentation": "The name of the output in the source node that the connection begins from.
", - "smithy.api#required": {} - } - }, - "targetInput": { - "target": "com.amazonaws.bedrockagent#FlowNodeInputName", - "traits": { - "smithy.api#documentation": "The name of the input in the target node that the connection ends at.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "The configuration of a connection originating from a node that isn't a Condition node.
" - } - }, - "com.amazonaws.bedrockagent#FlowDefinition": { - "type": "structure", - "members": { - "nodes": { - "target": "com.amazonaws.bedrockagent#FlowNodes", - "traits": { - "smithy.api#documentation": "An array of node definitions in the flow.
" - } - }, - "connections": { - "target": "com.amazonaws.bedrockagent#FlowConnections", - "traits": { - "smithy.api#documentation": "An array of connection definitions in the flow.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The definition of the nodes and connections between nodes in the flow.
" - } - }, - "com.amazonaws.bedrockagent#FlowDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 200 - } - } - }, - "com.amazonaws.bedrockagent#FlowExecutionRoleArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 2048 - }, - "smithy.api#pattern": "^arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/(service-role/)?.+$" - } - }, - "com.amazonaws.bedrockagent#FlowId": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[0-9a-zA-Z]{10}$" - } - }, - "com.amazonaws.bedrockagent#FlowIdentifier": { - "type": "string", - "traits": { - "smithy.api#pattern": "^(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10})|([0-9a-zA-Z]{10})$" - } - }, - "com.amazonaws.bedrockagent#FlowName": { - "type": "string", - "traits": { - "smithy.api#pattern": "^([0-9a-zA-Z][_-]?){1,100}$" - } - }, - "com.amazonaws.bedrockagent#FlowNode": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.bedrockagent#FlowNodeName", - "traits": { - "smithy.api#documentation": "A name for the node.
", - "smithy.api#required": {} - } - }, - "type": { - "target": "com.amazonaws.bedrockagent#FlowNodeType", - "traits": { - "smithy.api#documentation": "The type of node. This value must match the name of the key that you provide in the configuration you provide in the FlowNodeConfiguration
field.
Contains configurations for the node.
" - } - }, - "inputs": { - "target": "com.amazonaws.bedrockagent#FlowNodeInputs", - "traits": { - "smithy.api#documentation": "An array of objects, each of which contains information about an input into the node.
" - } - }, - "outputs": { - "target": "com.amazonaws.bedrockagent#FlowNodeOutputs", - "traits": { - "smithy.api#documentation": "A list of objects, each of which contains information about an output from the node.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains configurations about a node in the flow.
" - } - }, - "com.amazonaws.bedrockagent#FlowNodeConfiguration": { - "type": "union", - "members": { - "input": { - "target": "com.amazonaws.bedrockagent#InputFlowNodeConfiguration", - "traits": { - "smithy.api#documentation": "Contains configurations for an input flow node in your flow. The first node in the flow. inputs
can't be specified for this node.
Contains configurations for an output flow node in your flow. The last node in the flow. outputs
can't be specified for this node.
Contains configurations for a knowledge base node in your flow. Queries a knowledge base and returns the retrieved results or generated response.
" - } - }, - "condition": { - "target": "com.amazonaws.bedrockagent#ConditionFlowNodeConfiguration", - "traits": { - "smithy.api#documentation": "Contains configurations for a Condition node in your flow. Defines conditions that lead to different branches of the flow.
" - } - }, - "lex": { - "target": "com.amazonaws.bedrockagent#LexFlowNodeConfiguration", - "traits": { - "smithy.api#documentation": "Contains configurations for a Lex node in your flow. Invokes an Amazon Lex bot to identify the intent of the input and return the intent as the output.
" - } - }, - "prompt": { - "target": "com.amazonaws.bedrockagent#PromptFlowNodeConfiguration", - "traits": { - "smithy.api#documentation": "Contains configurations for a prompt node in your flow. Runs a prompt and generates the model response as the output. You can use a prompt from Prompt management or you can configure one in this node.
" - } - }, - "lambdaFunction": { - "target": "com.amazonaws.bedrockagent#LambdaFunctionFlowNodeConfiguration", - "traits": { - "smithy.api#documentation": "Contains configurations for a Lambda function node in your flow. Invokes an Lambda function.
" - } - }, - "storage": { - "target": "com.amazonaws.bedrockagent#StorageFlowNodeConfiguration", - "traits": { - "smithy.api#documentation": "Contains configurations for a Storage node in your flow. Stores an input in an Amazon S3 location.
" - } - }, - "agent": { - "target": "com.amazonaws.bedrockagent#AgentFlowNodeConfiguration", - "traits": { - "smithy.api#documentation": "Contains configurations for an agent node in your flow. Invokes an alias of an agent and returns the response.
" - } - }, - "retrieval": { - "target": "com.amazonaws.bedrockagent#RetrievalFlowNodeConfiguration", - "traits": { - "smithy.api#documentation": "Contains configurations for a Retrieval node in your flow. Retrieves data from an Amazon S3 location and returns it as the output.
" - } - }, - "iterator": { - "target": "com.amazonaws.bedrockagent#IteratorFlowNodeConfiguration", - "traits": { - "smithy.api#documentation": "Contains configurations for an iterator node in your flow. Takes an input that is an array and iteratively sends each item of the array as an output to the following node. The size of the array is also returned in the output.
\nThe output flow node at the end of the flow iteration will return a response for each member of the array. To return only one response, you can include a collector node downstream from the iterator node.
" - } - }, - "collector": { - "target": "com.amazonaws.bedrockagent#CollectorFlowNodeConfiguration", - "traits": { - "smithy.api#documentation": "Contains configurations for a collector node in your flow. Collects an iteration of inputs and consolidates them into an array of outputs.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains configurations for a node in your flow. For more information, see Node types in Amazon Bedrock works in the Amazon Bedrock User Guide.
" - } - }, - "com.amazonaws.bedrockagent#FlowNodeIODataType": { - "type": "enum", - "members": { - "STRING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "String" - } - }, - "NUMBER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Number" - } - }, - "BOOLEAN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Boolean" - } - }, - "OBJECT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Object" - } - }, - "ARRAY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Array" - } - } - } - }, - "com.amazonaws.bedrockagent#FlowNodeInput": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.bedrockagent#FlowNodeInputName", - "traits": { - "smithy.api#documentation": "A name for the input that you can reference.
", - "smithy.api#required": {} - } - }, - "type": { - "target": "com.amazonaws.bedrockagent#FlowNodeIODataType", - "traits": { - "smithy.api#documentation": "The data type of the input. If the input doesn't match this type at runtime, a validation error will be thrown.
", - "smithy.api#required": {} - } - }, - "expression": { - "target": "com.amazonaws.bedrockagent#FlowNodeInputExpression", - "traits": { - "smithy.api#documentation": "An expression that formats the input for the node. For an explanation of how to create expressions, see Expressions in Prompt flows in Amazon Bedrock.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains configurations for an input to a node.
" - } - }, - "com.amazonaws.bedrockagent#FlowNodeInputExpression": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.bedrockagent#FlowNodeInputName": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$" - } - }, - "com.amazonaws.bedrockagent#FlowNodeInputs": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagent#FlowNodeInput" - }, - "traits": { - "smithy.api#length": { - "max": 5 - } - } - }, - "com.amazonaws.bedrockagent#FlowNodeName": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$" - } - }, - "com.amazonaws.bedrockagent#FlowNodeOutput": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.bedrockagent#FlowNodeOutputName", - "traits": { - "smithy.api#documentation": "A name for the output that you can reference.
", - "smithy.api#required": {} - } - }, - "type": { - "target": "com.amazonaws.bedrockagent#FlowNodeIODataType", - "traits": { - "smithy.api#documentation": "The data type of the output. If the output doesn't match this type at runtime, a validation error will be thrown.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains configurations for an output from a node.
" - } - }, - "com.amazonaws.bedrockagent#FlowNodeOutputName": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$" - } - }, - "com.amazonaws.bedrockagent#FlowNodeOutputs": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagent#FlowNodeOutput" - }, - "traits": { - "smithy.api#length": { - "max": 5 - } - } - }, - "com.amazonaws.bedrockagent#FlowNodeType": { - "type": "enum", - "members": { - "INPUT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Input" - } - }, - "OUTPUT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Output" - } - }, - "KNOWLEDGE_BASE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "KnowledgeBase" - } - }, - "CONDITION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Condition" - } - }, - "LEX": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Lex" - } - }, - "PROMPT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Prompt" - } - }, - "LAMBDA_FUNCTION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LambdaFunction" - } - }, - "STORAGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Storage" - } - }, - "AGENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Agent" - } - }, - "RETRIEVAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Retrieval" - } - }, - "ITERATOR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Iterator" - } - }, - "COLLECTOR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Collector" - } - } - } - }, - "com.amazonaws.bedrockagent#FlowNodes": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagent#FlowNode" - }, - "traits": { - "smithy.api#length": { - "max": 20 - }, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.bedrockagent#FlowResource": { - "type": "resource", - "identifiers": { - "flowIdentifier": { - "target": "com.amazonaws.bedrockagent#FlowIdentifier" - } - }, - "create": { - "target": "com.amazonaws.bedrockagent#CreateFlow" - }, - "read": { - "target": "com.amazonaws.bedrockagent#GetFlow" - }, - "update": { - "target": "com.amazonaws.bedrockagent#UpdateFlow" - }, - "delete": { - "target": "com.amazonaws.bedrockagent#DeleteFlow" - }, - "list": { - "target": "com.amazonaws.bedrockagent#ListFlows" - }, - "operations": [ - { - "target": "com.amazonaws.bedrockagent#PrepareFlow" - } - ], - "resources": [ - { - "target": "com.amazonaws.bedrockagent#FlowAliasResource" - }, - { - "target": "com.amazonaws.bedrockagent#FlowVersionResource" - } - ], - "traits": { - "aws.cloudformation#cfnResource": { - "name": "Flow" - } - } - }, - "com.amazonaws.bedrockagent#FlowStatus": { - "type": "enum", - "members": { - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Failed" - } - }, - "PREPARED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Prepared" - } - }, - "PREPARING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Preparing" - } - }, - "NOT_PREPARED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NotPrepared" - } - } - } - }, - "com.amazonaws.bedrockagent#FlowSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagent#FlowSummary" - }, - "traits": { - "smithy.api#length": { - "max": 10 - } - } - }, - "com.amazonaws.bedrockagent#FlowSummary": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.bedrockagent#FlowName", - "traits": { - "smithy.api#documentation": "The name of the flow.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#FlowDescription", - "traits": { - "smithy.api#documentation": "A description of the flow.
" - } - }, - "id": { - "target": "com.amazonaws.bedrockagent#FlowId", - "traits": { - "smithy.api#documentation": "The unique identifier of the flow.
", - "smithy.api#required": {} - } - }, - "arn": { - "target": "com.amazonaws.bedrockagent#FlowArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the flow.
", - "smithy.api#required": {} - } - }, - "status": { - "target": "com.amazonaws.bedrockagent#FlowStatus", - "traits": { - "smithy.api#documentation": "The status of the flow. The following statuses are possible:
\nNotPrepared – The flow has been created or updated, but hasn't been prepared. If you just created the flow, you can't test it. If you updated the flow, the DRAFT
version won't contain the latest changes for testing. Send a PrepareFlow request to package the latest changes into the DRAFT
version.
Preparing – The flow is being prepared so that the DRAFT
version contains the latest changes for testing.
Prepared – The flow is prepared and the DRAFT
version contains the latest changes for testing.
Failed – The last API operation that you invoked on the flow failed. Send a GetFlow request and check the error message in the validations
field.
The time at which the flow was created.
", - "smithy.api#required": {} - } - }, - "updatedAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the flow was last updated.
", - "smithy.api#required": {} - } - }, - "version": { - "target": "com.amazonaws.bedrockagent#DraftVersion", - "traits": { - "smithy.api#documentation": "The latest version of the flow.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains the definition of a flow.
" - } - }, - "com.amazonaws.bedrockagent#FlowValidation": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.bedrockagent#NonBlankString", - "traits": { - "smithy.api#documentation": "A message describing the validation error.
", - "smithy.api#required": {} - } - }, - "severity": { - "target": "com.amazonaws.bedrockagent#FlowValidationSeverity", - "traits": { - "smithy.api#documentation": "The severity of the issue described in the message.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about validation of the flow.
\nThis data type is used in the following API operations:
\n\n GetFlow response\n
\nThe unique identifier of the flow.
", - "smithy.api#required": {} - } - }, - "arn": { - "target": "com.amazonaws.bedrockagent#FlowArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the flow that the version belongs to.
", - "smithy.api#required": {} - } - }, - "status": { - "target": "com.amazonaws.bedrockagent#FlowStatus", - "traits": { - "smithy.api#documentation": "The status of the flow.
", - "smithy.api#required": {} - } - }, - "createdAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at the version was created.
", - "smithy.api#required": {} - } - }, - "version": { - "target": "com.amazonaws.bedrockagent#NumericalVersion", - "traits": { - "smithy.api#documentation": "The version of the flow.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about a version of a flow.
\nThis data type is used in the following API operations:
\nA name for the function.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#FunctionDescription", - "traits": { - "smithy.api#documentation": "A description of the function and its purpose.
" - } - }, - "parameters": { - "target": "com.amazonaws.bedrockagent#ParameterMap", - "traits": { - "smithy.api#documentation": "The parameters that the agent elicits from the user to fulfill the function.
" - } - }, - "requireConfirmation": { - "target": "com.amazonaws.bedrockagent#RequireConfirmation", - "traits": { - "smithy.api#documentation": "Contains information if user confirmation is required to invoke the function.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Defines parameters that the agent needs to invoke from the user to complete the function. Corresponds to an action in an action group.
\nThis data type is used in the following API operations:
\nA list of functions that each define an action in the action group.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Defines functions that each define parameters that the agent needs to invoke from the user. Each function represents an action in an action group.
\nThis data type is used in the following API operations:
\nGets information about an agent.
", - "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/agents/{agentId}/" - }, - "smithy.api#readonly": {}, - "smithy.api#tags": [ - "console" - ] - } - }, - "com.amazonaws.bedrockagent#GetAgentActionGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#GetAgentActionGroupRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#GetAgentActionGroupResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Gets information about an action group for an agent.
", - "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/agents/{agentId}/agentversions/{agentVersion}/actiongroups/{actionGroupId}/" - }, - "smithy.api#readonly": {}, - "smithy.api#tags": [ - "console" - ] - } - }, - "com.amazonaws.bedrockagent#GetAgentActionGroupRequest": { - "type": "structure", - "members": { - "agentId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the agent that the action group belongs to.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "agentVersion": { - "target": "com.amazonaws.bedrockagent#Version", - "traits": { - "smithy.api#documentation": "The version of the agent that the action group belongs to.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "actionGroupId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the action group for which to get information.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#GetAgentActionGroupResponse": { - "type": "structure", - "members": { - "agentActionGroup": { - "target": "com.amazonaws.bedrockagent#AgentActionGroup", - "traits": { - "smithy.api#documentation": "Contains details about the action group.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#GetAgentAlias": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#GetAgentAliasRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#GetAgentAliasResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Gets information about an alias of an agent.
", - "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/agents/{agentId}/agentaliases/{agentAliasId}/" - }, - "smithy.api#readonly": {}, - "smithy.api#tags": [ - "console" - ] - } - }, - "com.amazonaws.bedrockagent#GetAgentAliasRequest": { - "type": "structure", - "members": { - "agentId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the agent to which the alias to get information belongs.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "agentAliasId": { - "target": "com.amazonaws.bedrockagent#AgentAliasId", - "traits": { - "smithy.api#documentation": "The unique identifier of the alias for which to get information.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#GetAgentAliasResponse": { - "type": "structure", - "members": { - "agentAlias": { - "target": "com.amazonaws.bedrockagent#AgentAlias", - "traits": { - "smithy.api#documentation": "Contains information about the alias.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#GetAgentKnowledgeBase": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#GetAgentKnowledgeBaseRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#GetAgentKnowledgeBaseResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Gets information about a knowledge base associated with an agent.
", - "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/agents/{agentId}/agentversions/{agentVersion}/knowledgebases/{knowledgeBaseId}/" - }, - "smithy.api#readonly": {}, - "smithy.api#tags": [ - "console" - ] - } - }, - "com.amazonaws.bedrockagent#GetAgentKnowledgeBaseRequest": { - "type": "structure", - "members": { - "agentId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the agent with which the knowledge base is associated.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "agentVersion": { - "target": "com.amazonaws.bedrockagent#Version", - "traits": { - "smithy.api#documentation": "The version of the agent with which the knowledge base is associated.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "knowledgeBaseId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the knowledge base associated with the agent.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#GetAgentKnowledgeBaseResponse": { - "type": "structure", - "members": { - "agentKnowledgeBase": { - "target": "com.amazonaws.bedrockagent#AgentKnowledgeBase", - "traits": { - "smithy.api#documentation": "Contains details about a knowledge base attached to an agent.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#GetAgentRequest": { - "type": "structure", - "members": { - "agentId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the agent.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#GetAgentResponse": { - "type": "structure", - "members": { - "agent": { - "target": "com.amazonaws.bedrockagent#Agent", - "traits": { - "smithy.api#documentation": "Contains details about the agent.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#GetAgentVersion": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#GetAgentVersionRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#GetAgentVersionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Gets details about a version of an agent.
", - "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/agents/{agentId}/agentversions/{agentVersion}/" - }, - "smithy.api#readonly": {}, - "smithy.api#tags": [ - "console" - ] - } - }, - "com.amazonaws.bedrockagent#GetAgentVersionRequest": { - "type": "structure", - "members": { - "agentId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the agent.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "agentVersion": { - "target": "com.amazonaws.bedrockagent#NumericalVersion", - "traits": { - "smithy.api#documentation": "The version of the agent.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#GetAgentVersionResponse": { - "type": "structure", - "members": { - "agentVersion": { - "target": "com.amazonaws.bedrockagent#AgentVersion", - "traits": { - "smithy.api#documentation": "Contains details about the version of the agent.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#GetDataSource": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#GetDataSourceRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#GetDataSourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Gets information about a data source.
", - "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}" - }, - "smithy.api#readonly": {}, - "smithy.api#tags": [ - "console" - ] - } - }, - "com.amazonaws.bedrockagent#GetDataSourceRequest": { - "type": "structure", - "members": { - "knowledgeBaseId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the knowledge base that the data source was added to.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "dataSourceId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the data source.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#GetDataSourceResponse": { - "type": "structure", - "members": { - "dataSource": { - "target": "com.amazonaws.bedrockagent#DataSource", - "traits": { - "smithy.api#documentation": "Contains details about the data source.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#GetFlow": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#GetFlowRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#GetFlowResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Retrieves information about a flow. For more information, see Manage a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
", - "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/flows/{flowIdentifier}/" - }, - "smithy.api#readonly": {}, - "smithy.api#tags": [ - "console" - ] - } - }, - "com.amazonaws.bedrockagent#GetFlowAlias": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#GetFlowAliasRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#GetFlowAliasResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Retrieves information about a flow. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
", - "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/flows/{flowIdentifier}/aliases/{aliasIdentifier}" - }, - "smithy.api#readonly": {}, - "smithy.api#tags": [ - "console" - ] - } - }, - "com.amazonaws.bedrockagent#GetFlowAliasRequest": { - "type": "structure", - "members": { - "flowIdentifier": { - "target": "com.amazonaws.bedrockagent#FlowIdentifier", - "traits": { - "smithy.api#documentation": "The unique identifier of the flow that the alias belongs to.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "aliasIdentifier": { - "target": "com.amazonaws.bedrockagent#FlowAliasIdentifier", - "traits": { - "smithy.api#documentation": "The unique identifier of the alias for which to retrieve information.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#GetFlowAliasResponse": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.bedrockagent#Name", - "traits": { - "smithy.api#documentation": "The name of the alias.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#Description", - "traits": { - "smithy.api#documentation": "The description of the flow.
" - } - }, - "routingConfiguration": { - "target": "com.amazonaws.bedrockagent#FlowAliasRoutingConfiguration", - "traits": { - "smithy.api#documentation": "Contains information about the version that the alias is mapped to.
", - "smithy.api#required": {} - } - }, - "flowId": { - "target": "com.amazonaws.bedrockagent#FlowId", - "traits": { - "smithy.api#documentation": "The unique identifier of the flow that the alias belongs to.
", - "smithy.api#required": {} - } - }, - "id": { - "target": "com.amazonaws.bedrockagent#FlowAliasId", - "traits": { - "smithy.api#documentation": "The unique identifier of the alias of the flow.
", - "smithy.api#required": {} - } - }, - "arn": { - "target": "com.amazonaws.bedrockagent#FlowAliasArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the flow.
", - "smithy.api#required": {} - } - }, - "createdAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the flow was created.
", - "smithy.api#required": {} - } - }, - "updatedAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the alias was last updated.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#GetFlowRequest": { - "type": "structure", - "members": { - "flowIdentifier": { - "target": "com.amazonaws.bedrockagent#FlowIdentifier", - "traits": { - "smithy.api#documentation": "The unique identifier of the flow.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#GetFlowResponse": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.bedrockagent#FlowName", - "traits": { - "smithy.api#documentation": "The name of the flow.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#FlowDescription", - "traits": { - "smithy.api#documentation": "The description of the flow.
" - } - }, - "executionRoleArn": { - "target": "com.amazonaws.bedrockagent#FlowExecutionRoleArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service role with permissions to create a flow. For more information, see Create a service row for flows in the Amazon Bedrock User Guide.
", - "smithy.api#required": {} - } - }, - "customerEncryptionKeyArn": { - "target": "com.amazonaws.bedrockagent#KmsKeyArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key that the flow is encrypted with.
" - } - }, - "id": { - "target": "com.amazonaws.bedrockagent#FlowId", - "traits": { - "smithy.api#documentation": "The unique identifier of the flow.
", - "smithy.api#required": {} - } - }, - "arn": { - "target": "com.amazonaws.bedrockagent#FlowArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the flow.
", - "smithy.api#required": {} - } - }, - "status": { - "target": "com.amazonaws.bedrockagent#FlowStatus", - "traits": { - "smithy.api#documentation": "The status of the flow. The following statuses are possible:
\nNotPrepared – The flow has been created or updated, but hasn't been prepared. If you just created the flow, you can't test it. If you updated the flow, the DRAFT
version won't contain the latest changes for testing. Send a PrepareFlow request to package the latest changes into the DRAFT
version.
Preparing – The flow is being prepared so that the DRAFT
version contains the latest changes for testing.
Prepared – The flow is prepared and the DRAFT
version contains the latest changes for testing.
Failed – The last API operation that you invoked on the flow failed. Send a GetFlow request and check the error message in the validations
field.
The time at which the flow was created.
", - "smithy.api#required": {} - } - }, - "updatedAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the flow was last updated.
", - "smithy.api#required": {} - } - }, - "version": { - "target": "com.amazonaws.bedrockagent#DraftVersion", - "traits": { - "smithy.api#documentation": "The version of the flow for which information was retrieved.
", - "smithy.api#required": {} - } - }, - "definition": { - "target": "com.amazonaws.bedrockagent#FlowDefinition", - "traits": { - "smithy.api#documentation": "The definition of the nodes and connections between the nodes in the flow.
" - } - }, - "validations": { - "target": "com.amazonaws.bedrockagent#FlowValidations", - "traits": { - "smithy.api#documentation": "A list of validation error messages related to the last failed operation on the flow.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#GetFlowVersion": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#GetFlowVersionRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#GetFlowVersionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Retrieves information about a version of a flow. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
", - "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/flows/{flowIdentifier}/versions/{flowVersion}/" - }, - "smithy.api#readonly": {}, - "smithy.api#tags": [ - "console" - ] - } - }, - "com.amazonaws.bedrockagent#GetFlowVersionRequest": { - "type": "structure", - "members": { - "flowIdentifier": { - "target": "com.amazonaws.bedrockagent#FlowIdentifier", - "traits": { - "smithy.api#documentation": "The unique identifier of the flow for which to get information.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "flowVersion": { - "target": "com.amazonaws.bedrockagent#NumericalVersion", - "traits": { - "smithy.api#documentation": "The version of the flow for which to get information.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#GetFlowVersionResponse": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.bedrockagent#FlowName", - "traits": { - "smithy.api#documentation": "The name of the version.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#FlowDescription", - "traits": { - "smithy.api#documentation": "The description of the flow.
" - } - }, - "executionRoleArn": { - "target": "com.amazonaws.bedrockagent#FlowExecutionRoleArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service role with permissions to create a flow. For more information, see Create a service role for flows in Amazon Bedrock in the Amazon Bedrock User Guide.
", - "smithy.api#required": {} - } - }, - "customerEncryptionKeyArn": { - "target": "com.amazonaws.bedrockagent#KmsKeyArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key that the version of the flow is encrypted with.
" - } - }, - "id": { - "target": "com.amazonaws.bedrockagent#FlowId", - "traits": { - "smithy.api#documentation": "The unique identifier of the flow.
", - "smithy.api#required": {} - } - }, - "arn": { - "target": "com.amazonaws.bedrockagent#FlowArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the flow.
", - "smithy.api#required": {} - } - }, - "status": { - "target": "com.amazonaws.bedrockagent#FlowStatus", - "traits": { - "smithy.api#documentation": "The status of the flow.
", - "smithy.api#required": {} - } - }, - "createdAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the flow was created.
", - "smithy.api#required": {} - } - }, - "version": { - "target": "com.amazonaws.bedrockagent#NumericalVersion", - "traits": { - "smithy.api#documentation": "The version of the flow for which information was retrieved.
", - "smithy.api#required": {} - } - }, - "definition": { - "target": "com.amazonaws.bedrockagent#FlowDefinition", - "traits": { - "smithy.api#documentation": "The definition of the nodes and connections between nodes in the flow.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#GetIngestionJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#GetIngestionJobRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#GetIngestionJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Gets information about a ingestion job, in which a data source is added to a knowledge base.
", - "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}/ingestionjobs/{ingestionJobId}" - }, - "smithy.api#readonly": {}, - "smithy.api#tags": [ - "console" - ] - } - }, - "com.amazonaws.bedrockagent#GetIngestionJobRequest": { - "type": "structure", - "members": { - "knowledgeBaseId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the knowledge base for which the ingestion job applies.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "dataSourceId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the data source in the ingestion job.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ingestionJobId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the ingestion job.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#GetIngestionJobResponse": { - "type": "structure", - "members": { - "ingestionJob": { - "target": "com.amazonaws.bedrockagent#IngestionJob", - "traits": { - "smithy.api#documentation": "Contains details about the ingestion job.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#GetKnowledgeBase": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#GetKnowledgeBaseRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#GetKnowledgeBaseResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Gets information about a knoweldge base.
", - "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/knowledgebases/{knowledgeBaseId}" - }, - "smithy.api#readonly": {}, - "smithy.api#tags": [ - "console" - ] - } - }, - "com.amazonaws.bedrockagent#GetKnowledgeBaseRequest": { - "type": "structure", - "members": { - "knowledgeBaseId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the knowledge base for which to get information.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#GetKnowledgeBaseResponse": { - "type": "structure", - "members": { - "knowledgeBase": { - "target": "com.amazonaws.bedrockagent#KnowledgeBase", - "traits": { - "smithy.api#documentation": "Contains details about the knowledge base.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#GetPrompt": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#GetPromptRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#GetPromptResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Retrieves information about the working draft (DRAFT
version) of a prompt or a version of it, depending on whether you include the promptVersion
field or not. For more information, see View information about prompts using Prompt management and View information about a version of your prompt in the Amazon Bedrock User Guide.
The unique identifier of the prompt.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "promptVersion": { - "target": "com.amazonaws.bedrockagent#Version", - "traits": { - "smithy.api#documentation": "The version of the prompt about which you want to retrieve information. Omit this field to return information about the working draft of the prompt.
", - "smithy.api#httpQuery": "promptVersion" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#GetPromptResponse": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.bedrockagent#PromptName", - "traits": { - "smithy.api#documentation": "The name of the prompt.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#PromptDescription", - "traits": { - "smithy.api#documentation": "The descriptino of the prompt.
" - } - }, - "customerEncryptionKeyArn": { - "target": "com.amazonaws.bedrockagent#KmsKeyArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key that the prompt is encrypted with.
" - } - }, - "defaultVariant": { - "target": "com.amazonaws.bedrockagent#PromptVariantName", - "traits": { - "smithy.api#documentation": "The name of the default variant for the prompt. This value must match the name
field in the relevant PromptVariant object.
A list of objects, each containing details about a variant of the prompt.
" - } - }, - "id": { - "target": "com.amazonaws.bedrockagent#PromptId", - "traits": { - "smithy.api#documentation": "The unique identifier of the prompt.
", - "smithy.api#required": {} - } - }, - "arn": { - "target": "com.amazonaws.bedrockagent#PromptArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the prompt or the prompt version (if you specified a version in the request).
", - "smithy.api#required": {} - } - }, - "version": { - "target": "com.amazonaws.bedrockagent#Version", - "traits": { - "smithy.api#documentation": "The version of the prompt.
", - "smithy.api#required": {} - } - }, - "createdAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the prompt was created.
", - "smithy.api#required": {} - } - }, - "updatedAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the prompt was last updated.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#GuardrailConfiguration": { - "type": "structure", - "members": { - "guardrailIdentifier": { - "target": "com.amazonaws.bedrockagent#GuardrailIdentifier", - "traits": { - "smithy.api#documentation": "The unique identifier of the guardrail.
" - } - }, - "guardrailVersion": { - "target": "com.amazonaws.bedrockagent#GuardrailVersion", - "traits": { - "smithy.api#documentation": "The version of the guardrail.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Details about the guardrail associated with an agent.
" - } - }, - "com.amazonaws.bedrockagent#GuardrailIdentifier": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 2048 - }, - "smithy.api#pattern": "^(([a-z0-9]+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+))$" - } - }, - "com.amazonaws.bedrockagent#GuardrailVersion": { - "type": "string", - "traits": { - "smithy.api#pattern": "^(([0-9]{1,8})|(DRAFT))$" - } - }, - "com.amazonaws.bedrockagent#HierarchicalChunkingConfiguration": { - "type": "structure", - "members": { - "levelConfigurations": { - "target": "com.amazonaws.bedrockagent#HierarchicalChunkingLevelConfigurations", - "traits": { - "smithy.api#documentation": "Token settings for each layer.
", - "smithy.api#required": {} - } - }, - "overlapTokens": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "The number of tokens to repeat across chunks in the same layer.
", - "smithy.api#range": { - "min": 1 - }, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Settings for hierarchical document chunking for a data source. Hierarchical chunking splits documents\n into layers of chunks where the first layer contains large chunks, and the second layer contains smaller\n chunks derived from the first layer.
\nYou configure the number of tokens to overlap, or repeat across adjacent chunks. For example,\n if you set overlap tokens to 60, the last 60 tokens in the first chunk are also included at the beginning of\n the second chunk. For each layer, you must also configure the maximum number of tokens in a chunk.
" - } - }, - "com.amazonaws.bedrockagent#HierarchicalChunkingLevelConfiguration": { - "type": "structure", - "members": { - "maxTokens": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "The maximum number of tokens that a chunk can contain in this layer.
", - "smithy.api#range": { - "min": 1, - "max": 8192 - }, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Token settings for a layer in a hierarchical chunking configuration.
" - } - }, - "com.amazonaws.bedrockagent#HierarchicalChunkingLevelConfigurations": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagent#HierarchicalChunkingLevelConfiguration" - }, - "traits": { - "smithy.api#length": { - "min": 2, - "max": 2 - } - } - }, - "com.amazonaws.bedrockagent#HttpsUrl": { - "type": "string", - "traits": { - "smithy.api#pattern": "^https://[A-Za-z0-9][^\\s]*$" - } - }, - "com.amazonaws.bedrockagent#Id": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[0-9a-zA-Z]{10}$" - } - }, - "com.amazonaws.bedrockagent#InferenceConfiguration": { - "type": "structure", - "members": { - "temperature": { - "target": "com.amazonaws.bedrockagent#Temperature", - "traits": { - "smithy.api#documentation": "The likelihood of the model selecting higher-probability options while generating a response. A lower value makes the model more likely to choose higher-probability options, while a higher value makes the model more likely to choose lower-probability options.
" - } - }, - "topP": { - "target": "com.amazonaws.bedrockagent#TopP", - "traits": { - "smithy.api#documentation": "While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for Top P
determines the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set topP
to 80, the model only selects the next token from the top 80% of the probability distribution of next tokens.
While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for topK
is the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set topK
to 50, the model selects the next token from among the top 50 most likely choices.
The maximum number of tokens to allow in the generated response.
" - } - }, - "stopSequences": { - "target": "com.amazonaws.bedrockagent#StopSequences", - "traits": { - "smithy.api#documentation": "A list of stop sequences. A stop sequence is a sequence of characters that causes the model to stop generating the response.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the promptType
. For more information, see Inference parameters for foundation models.
The unique identifier of the knowledge base to which the data source is being added.
", - "smithy.api#required": {} - } - }, - "dataSourceId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the ingested data source.
", - "smithy.api#required": {} - } - }, - "ingestionJobId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the ingestion job.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#Description", - "traits": { - "smithy.api#documentation": "The description of the ingestion job.
" - } - }, - "status": { - "target": "com.amazonaws.bedrockagent#IngestionJobStatus", - "traits": { - "smithy.api#documentation": "The status of the ingestion job.
", - "smithy.api#required": {} - } - }, - "statistics": { - "target": "com.amazonaws.bedrockagent#IngestionJobStatistics", - "traits": { - "smithy.api#documentation": "Contains statistics about the ingestion job.
" - } - }, - "failureReasons": { - "target": "com.amazonaws.bedrockagent#FailureReasons", - "traits": { - "smithy.api#documentation": "A list of reasons that the ingestion job failed.
" - } - }, - "startedAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the ingestion job started.
", - "smithy.api#required": {} - } - }, - "updatedAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the ingestion job was last updated.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains details about an ingestion job, which converts a data source to embeddings for a vector store in knowledge base.
\nThis data type is used in the following API operations:
\nThe attribute by which to filter the results.
", - "smithy.api#required": {} - } - }, - "operator": { - "target": "com.amazonaws.bedrockagent#IngestionJobFilterOperator", - "traits": { - "smithy.api#documentation": "The operation to carry out between the attribute and the values.
", - "smithy.api#required": {} - } - }, - "values": { - "target": "com.amazonaws.bedrockagent#IngestionJobFilterValues", - "traits": { - "smithy.api#documentation": "A list of values for the attribute.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Defines a filter by which to filter the results.
" - } - }, - "com.amazonaws.bedrockagent#IngestionJobFilterAttribute": { - "type": "enum", - "members": { - "STATUS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STATUS" - } - } - } - }, - "com.amazonaws.bedrockagent#IngestionJobFilterOperator": { - "type": "enum", - "members": { - "EQ": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EQ" - } - } - } - }, - "com.amazonaws.bedrockagent#IngestionJobFilterValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - }, - "smithy.api#pattern": "^.*$" - } - }, - "com.amazonaws.bedrockagent#IngestionJobFilterValues": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagent#IngestionJobFilterValue" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 10 - } - } - }, - "com.amazonaws.bedrockagent#IngestionJobFilters": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagent#IngestionJobFilter" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - } - } - }, - "com.amazonaws.bedrockagent#IngestionJobResource": { - "type": "resource", - "operations": [ - { - "target": "com.amazonaws.bedrockagent#GetIngestionJob" - }, - { - "target": "com.amazonaws.bedrockagent#ListIngestionJobs" - }, - { - "target": "com.amazonaws.bedrockagent#StartIngestionJob" - } - ] - }, - "com.amazonaws.bedrockagent#IngestionJobSortBy": { - "type": "structure", - "members": { - "attribute": { - "target": "com.amazonaws.bedrockagent#IngestionJobSortByAttribute", - "traits": { - "smithy.api#documentation": "The attribute by which to sort the results.
", - "smithy.api#required": {} - } - }, - "order": { - "target": "com.amazonaws.bedrockagent#SortOrder", - "traits": { - "smithy.api#documentation": "The order by which to sort the results.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Parameters by which to sort the results.
" - } - }, - "com.amazonaws.bedrockagent#IngestionJobSortByAttribute": { - "type": "enum", - "members": { - "STATUS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STATUS" - } - }, - "STARTED_AT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STARTED_AT" - } - } - } - }, - "com.amazonaws.bedrockagent#IngestionJobStatistics": { - "type": "structure", - "members": { - "numberOfDocumentsScanned": { - "target": "smithy.api#PrimitiveLong", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The total number of source documents that were scanned. Includes new, updated, and unchanged documents.
" - } - }, - "numberOfMetadataDocumentsScanned": { - "target": "smithy.api#PrimitiveLong", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The total number of metadata files that were scanned. Includes new, updated, and unchanged files.
" - } - }, - "numberOfNewDocumentsIndexed": { - "target": "smithy.api#PrimitiveLong", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The number of new source documents in the data source that were successfully indexed.
" - } - }, - "numberOfModifiedDocumentsIndexed": { - "target": "smithy.api#PrimitiveLong", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The number of modified source documents in the data source that were successfully indexed.
" - } - }, - "numberOfMetadataDocumentsModified": { - "target": "smithy.api#PrimitiveLong", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The number of metadata files that were updated or deleted.
" - } - }, - "numberOfDocumentsDeleted": { - "target": "smithy.api#PrimitiveLong", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The number of source documents that was deleted.
" - } - }, - "numberOfDocumentsFailed": { - "target": "smithy.api#PrimitiveLong", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The number of source documents that failed to be ingested.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains the statistics for the ingestion job.
" - } - }, - "com.amazonaws.bedrockagent#IngestionJobStatus": { - "type": "enum", - "members": { - "STARTING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STARTING" - } - }, - "IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IN_PROGRESS" - } - }, - "COMPLETE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COMPLETE" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - } - } - }, - "com.amazonaws.bedrockagent#IngestionJobSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagent#IngestionJobSummary" - } - }, - "com.amazonaws.bedrockagent#IngestionJobSummary": { - "type": "structure", - "members": { - "knowledgeBaseId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the knowledge base to which the data source is added.
", - "smithy.api#required": {} - } - }, - "dataSourceId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the data source in the ingestion job.
", - "smithy.api#required": {} - } - }, - "ingestionJobId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the ingestion job.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#Description", - "traits": { - "smithy.api#documentation": "The description of the ingestion job.
" - } - }, - "status": { - "target": "com.amazonaws.bedrockagent#IngestionJobStatus", - "traits": { - "smithy.api#documentation": "The status of the ingestion job.
", - "smithy.api#required": {} - } - }, - "startedAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the ingestion job was started.
", - "smithy.api#required": {} - } - }, - "updatedAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the ingestion job was last updated.
", - "smithy.api#required": {} - } - }, - "statistics": { - "target": "com.amazonaws.bedrockagent#IngestionJobStatistics", - "traits": { - "smithy.api#documentation": "Contains statistics for the ingestion job.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains details about an ingestion job.
" - } - }, - "com.amazonaws.bedrockagent#InputFlowNodeConfiguration": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "Contains configurations for the input flow node for a flow. This node takes the input from flow invocation and passes it to the next node in the data type that you specify.
" - } - }, - "com.amazonaws.bedrockagent#Instruction": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 40, - "max": 4000 - }, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.bedrockagent#IntermediateStorage": { - "type": "structure", - "members": { - "s3Location": { - "target": "com.amazonaws.bedrockagent#S3Location", - "traits": { - "smithy.api#documentation": "An S3 bucket path.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A location for storing content from data sources temporarily as it is processed by\n custom components in the ingestion pipeline.
" - } - }, - "com.amazonaws.bedrockagent#InternalServerException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.bedrockagent#NonBlankString" - } - }, - "traits": { - "smithy.api#documentation": "An internal server error occurred. Retry your request.
", - "smithy.api#error": "server", - "smithy.api#httpError": 500 - } - }, - "com.amazonaws.bedrockagent#IteratorFlowNodeConfiguration": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "Contains configurations for an iterator node in a flow. Takes an input that is an array and iteratively sends each item of the array as an output to the following node. The size of the array is also returned in the output.
\nThe output flow node at the end of the flow iteration will return a response for each member of the array. To return only one response, you can include a collector node downstream from the iterator node.
" - } - }, - "com.amazonaws.bedrockagent#KmsKeyArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - }, - "smithy.api#pattern": "^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$" - } - }, - "com.amazonaws.bedrockagent#KnowledgeBase": { - "type": "structure", - "members": { - "knowledgeBaseId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the knowledge base.
", - "smithy.api#required": {} - } - }, - "name": { - "target": "com.amazonaws.bedrockagent#Name", - "traits": { - "smithy.api#documentation": "The name of the knowledge base.
", - "smithy.api#required": {} - } - }, - "knowledgeBaseArn": { - "target": "com.amazonaws.bedrockagent#KnowledgeBaseArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the knowledge base.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#Description", - "traits": { - "smithy.api#documentation": "The description of the knowledge base.
" - } - }, - "roleArn": { - "target": "com.amazonaws.bedrockagent#KnowledgeBaseRoleArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
", - "smithy.api#required": {} - } - }, - "knowledgeBaseConfiguration": { - "target": "com.amazonaws.bedrockagent#KnowledgeBaseConfiguration", - "traits": { - "smithy.api#documentation": "Contains details about the embeddings configuration of the knowledge base.
", - "smithy.api#required": {} - } - }, - "storageConfiguration": { - "target": "com.amazonaws.bedrockagent#StorageConfiguration", - "traits": { - "smithy.api#documentation": "Contains details about the storage configuration of the knowledge base.
", - "smithy.api#required": {} - } - }, - "status": { - "target": "com.amazonaws.bedrockagent#KnowledgeBaseStatus", - "traits": { - "smithy.api#documentation": "The status of the knowledge base. The following statuses are possible:
\nCREATING – The knowledge base is being created.
\nACTIVE – The knowledge base is ready to be queried.
\nDELETING – The knowledge base is being deleted.
\nUPDATING – The knowledge base is being updated.
\nFAILED – The knowledge base API operation failed.
\nThe time at which the knowledge base was created.
", - "smithy.api#required": {} - } - }, - "updatedAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the knowledge base was last updated.
", - "smithy.api#required": {} - } - }, - "failureReasons": { - "target": "com.amazonaws.bedrockagent#FailureReasons", - "traits": { - "smithy.api#documentation": "A list of reasons that the API operation on the knowledge base failed.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about a knowledge base.
" - } - }, - "com.amazonaws.bedrockagent#KnowledgeBaseArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 128 - }, - "smithy.api#pattern": "^arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:knowledge-base/[0-9a-zA-Z]+$" - } - }, - "com.amazonaws.bedrockagent#KnowledgeBaseConfiguration": { - "type": "structure", - "members": { - "type": { - "target": "com.amazonaws.bedrockagent#KnowledgeBaseType", - "traits": { - "smithy.api#documentation": "The type of data that the data source is converted into for the knowledge base.
", - "smithy.api#required": {} - } - }, - "vectorKnowledgeBaseConfiguration": { - "target": "com.amazonaws.bedrockagent#VectorKnowledgeBaseConfiguration", - "traits": { - "smithy.api#documentation": "Contains details about the embeddings model that'sused to convert the data source.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains details about the embeddings configuration of the knowledge base.
" - } - }, - "com.amazonaws.bedrockagent#KnowledgeBaseFlowNodeConfiguration": { - "type": "structure", - "members": { - "knowledgeBaseId": { - "target": "com.amazonaws.bedrockagent#KnowledgeBaseId", - "traits": { - "smithy.api#documentation": "The unique identifier of the knowledge base to query.
", - "smithy.api#required": {} - } - }, - "modelId": { - "target": "com.amazonaws.bedrockagent#ModelIdentifier", - "traits": { - "smithy.api#documentation": "The unique identifier of the model to use to generate a response from the query results. Omit this field if you want to return the retrieved results as an array.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains configurations for a knowledge base node in a flow. This node takes a query as the input and returns, as the output, the retrieved responses directly (as an array) or a response generated based on the retrieved responses. For more information, see Node types in Amazon Bedrock works in the Amazon Bedrock User Guide.
" - } - }, - "com.amazonaws.bedrockagent#KnowledgeBaseId": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 10 - }, - "smithy.api#pattern": "^[0-9a-zA-Z]+$" - } - }, - "com.amazonaws.bedrockagent#KnowledgeBaseResource": { - "type": "resource", - "operations": [ - { - "target": "com.amazonaws.bedrockagent#AssociateAgentKnowledgeBase" - }, - { - "target": "com.amazonaws.bedrockagent#CreateKnowledgeBase" - }, - { - "target": "com.amazonaws.bedrockagent#DeleteKnowledgeBase" - }, - { - "target": "com.amazonaws.bedrockagent#DisassociateAgentKnowledgeBase" - }, - { - "target": "com.amazonaws.bedrockagent#GetAgentKnowledgeBase" - }, - { - "target": "com.amazonaws.bedrockagent#GetKnowledgeBase" - }, - { - "target": "com.amazonaws.bedrockagent#ListAgentKnowledgeBases" - }, - { - "target": "com.amazonaws.bedrockagent#ListKnowledgeBases" - }, - { - "target": "com.amazonaws.bedrockagent#UpdateAgentKnowledgeBase" - }, - { - "target": "com.amazonaws.bedrockagent#UpdateKnowledgeBase" - } - ] - }, - "com.amazonaws.bedrockagent#KnowledgeBaseRoleArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 2048 - }, - "smithy.api#pattern": "^arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+$" - } - }, - "com.amazonaws.bedrockagent#KnowledgeBaseState": { - "type": "enum", - "members": { - "ENABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENABLED" - } - }, - "DISABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISABLED" - } - } - } - }, - "com.amazonaws.bedrockagent#KnowledgeBaseStatus": { - "type": "enum", - "members": { - "CREATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATING" - } - }, - "ACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACTIVE" - } - }, - "DELETING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETING" - } - }, - "UPDATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATING" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "DELETE_UNSUCCESSFUL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETE_UNSUCCESSFUL" - } - } - } - }, - "com.amazonaws.bedrockagent#KnowledgeBaseStorageType": { - "type": "enum", - "members": { - "OPENSEARCH_SERVERLESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OPENSEARCH_SERVERLESS" - } - }, - "PINECONE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PINECONE" - } - }, - "REDIS_ENTERPRISE_CLOUD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "REDIS_ENTERPRISE_CLOUD" - } - }, - "RDS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RDS" - } - }, - "MONGO_DB_ATLAS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MONGO_DB_ATLAS" - } - } - } - }, - "com.amazonaws.bedrockagent#KnowledgeBaseSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagent#KnowledgeBaseSummary" - } - }, - "com.amazonaws.bedrockagent#KnowledgeBaseSummary": { - "type": "structure", - "members": { - "knowledgeBaseId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the knowledge base.
", - "smithy.api#required": {} - } - }, - "name": { - "target": "com.amazonaws.bedrockagent#Name", - "traits": { - "smithy.api#documentation": "The name of the knowledge base.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#Description", - "traits": { - "smithy.api#documentation": "The description of the knowledge base.
" - } - }, - "status": { - "target": "com.amazonaws.bedrockagent#KnowledgeBaseStatus", - "traits": { - "smithy.api#documentation": "The status of the knowledge base.
", - "smithy.api#required": {} - } - }, - "updatedAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the knowledge base was last updated.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains details about a knowledge base.
" - } - }, - "com.amazonaws.bedrockagent#KnowledgeBaseType": { - "type": "enum", - "members": { - "VECTOR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VECTOR" - } - } - } - }, - "com.amazonaws.bedrockagent#LambdaArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 2048 - }, - "smithy.api#pattern": "^arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}(-gov)?-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9-_\\.]+(:(\\$LATEST|[a-zA-Z0-9-_]+))?$" - } - }, - "com.amazonaws.bedrockagent#LambdaFunctionFlowNodeConfiguration": { - "type": "structure", - "members": { - "lambdaArn": { - "target": "com.amazonaws.bedrockagent#LambdaArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Lambda function to invoke.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains configurations for a Lambda function node in the flow. You specify the Lambda function to invoke and the inputs into the function. The output is the response that is defined in the Lambda function. For more information, see Node types in Amazon Bedrock works in the Amazon Bedrock User Guide.
" - } - }, - "com.amazonaws.bedrockagent#LexBotAliasArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 78 - }, - "smithy.api#pattern": "^arn:aws(|-us-gov):lex:[a-z]{2}(-gov)?-[a-z]+-\\d{1}:\\d{12}:bot-alias/[0-9a-zA-Z]+/[0-9a-zA-Z]+$" - } - }, - "com.amazonaws.bedrockagent#LexBotLocaleId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.bedrockagent#LexFlowNodeConfiguration": { - "type": "structure", - "members": { - "botAliasArn": { - "target": "com.amazonaws.bedrockagent#LexBotAliasArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Lex bot alias to invoke.
", - "smithy.api#required": {} - } - }, - "localeId": { - "target": "com.amazonaws.bedrockagent#LexBotLocaleId", - "traits": { - "smithy.api#documentation": "The Region to invoke the Amazon Lex bot in.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains configurations for a Lex node in the flow. You specify a Amazon Lex bot to invoke. This node takes an utterance as the input and returns as the output the intent identified by the Amazon Lex bot. For more information, see Node types in Amazon Bedrock works in the Amazon Bedrock User Guide.
" - } - }, - "com.amazonaws.bedrockagent#ListAgentActionGroups": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#ListAgentActionGroupsRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#ListAgentActionGroupsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Lists the action groups for an agent and information about each one.
", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/agents/{agentId}/agentversions/{agentVersion}/actiongroups/" - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "actionGroupSummaries" - }, - "smithy.api#readonly": {}, - "smithy.api#tags": [ - "console" - ] - } - }, - "com.amazonaws.bedrockagent#ListAgentActionGroupsRequest": { - "type": "structure", - "members": { - "agentId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the agent.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "agentVersion": { - "target": "com.amazonaws.bedrockagent#Version", - "traits": { - "smithy.api#documentation": "The version of the agent.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "maxResults": { - "target": "com.amazonaws.bedrockagent#MaxResults", - "traits": { - "smithy.api#documentation": "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.
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.
A list of objects, each of which contains information about an action group.
", - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.bedrockagent#NextToken", - "traits": { - "smithy.api#documentation": "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.
Lists the aliases of an agent and information about each one.
", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/agents/{agentId}/agentaliases/" - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "agentAliasSummaries" - }, - "smithy.api#readonly": {}, - "smithy.api#tags": [ - "console" - ] - } - }, - "com.amazonaws.bedrockagent#ListAgentAliasesRequest": { - "type": "structure", - "members": { - "agentId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the agent.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "maxResults": { - "target": "com.amazonaws.bedrockagent#MaxResults", - "traits": { - "smithy.api#documentation": "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.
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.
A list of objects, each of which contains information about an alias of the agent.
", - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.bedrockagent#NextToken", - "traits": { - "smithy.api#documentation": "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.
Lists knowledge bases associated with an agent and information about each one.
", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/agents/{agentId}/agentversions/{agentVersion}/knowledgebases/" - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "agentKnowledgeBaseSummaries" - }, - "smithy.api#readonly": {}, - "smithy.api#tags": [ - "console" - ] - } - }, - "com.amazonaws.bedrockagent#ListAgentKnowledgeBasesRequest": { - "type": "structure", - "members": { - "agentId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the agent for which to return information about knowledge bases associated with it.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "agentVersion": { - "target": "com.amazonaws.bedrockagent#Version", - "traits": { - "smithy.api#documentation": "The version of the agent for which to return information about knowledge bases associated with it.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "maxResults": { - "target": "com.amazonaws.bedrockagent#MaxResults", - "traits": { - "smithy.api#documentation": "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.
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.
A list of objects, each of which contains information about a knowledge base associated with the agent.
", - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.bedrockagent#NextToken", - "traits": { - "smithy.api#documentation": "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.
Lists the versions of an agent and information about each version.
", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/agents/{agentId}/agentversions/" - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "agentVersionSummaries" - }, - "smithy.api#readonly": {}, - "smithy.api#tags": [ - "console" - ] - } - }, - "com.amazonaws.bedrockagent#ListAgentVersionsRequest": { - "type": "structure", - "members": { - "agentId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the agent.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "maxResults": { - "target": "com.amazonaws.bedrockagent#MaxResults", - "traits": { - "smithy.api#documentation": "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.
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.
A list of objects, each of which contains information about a version of the agent.
", - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.bedrockagent#NextToken", - "traits": { - "smithy.api#documentation": "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.
Lists the agents belonging to an account and information about each agent.
", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/agents/" - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "agentSummaries" - }, - "smithy.api#readonly": {}, - "smithy.api#tags": [ - "console" - ] - } - }, - "com.amazonaws.bedrockagent#ListAgentsRequest": { - "type": "structure", - "members": { - "maxResults": { - "target": "com.amazonaws.bedrockagent#MaxResults", - "traits": { - "smithy.api#documentation": "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.
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.
A list of objects, each of which contains information about an agent.
", - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.bedrockagent#NextToken", - "traits": { - "smithy.api#documentation": "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.
Lists the data sources in a knowledge base and information about each one.
", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/knowledgebases/{knowledgeBaseId}/datasources/" - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "dataSourceSummaries" - }, - "smithy.api#readonly": {}, - "smithy.api#tags": [ - "console" - ] - } - }, - "com.amazonaws.bedrockagent#ListDataSourcesRequest": { - "type": "structure", - "members": { - "knowledgeBaseId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the knowledge base for which to return a list of information.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "maxResults": { - "target": "com.amazonaws.bedrockagent#MaxResults", - "traits": { - "smithy.api#documentation": "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.
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.
A list of objects, each of which contains information about a data source.
", - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.bedrockagent#NextToken", - "traits": { - "smithy.api#documentation": "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.
Returns a list of aliases for a flow.
", - "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/flows/{flowIdentifier}/aliases" - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "flowAliasSummaries" - }, - "smithy.api#readonly": {}, - "smithy.api#tags": [ - "console" - ] - } - }, - "com.amazonaws.bedrockagent#ListFlowAliasesRequest": { - "type": "structure", - "members": { - "flowIdentifier": { - "target": "com.amazonaws.bedrockagent#FlowIdentifier", - "traits": { - "smithy.api#documentation": "The unique identifier of the flow for which aliases are being returned.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "maxResults": { - "target": "com.amazonaws.bedrockagent#MaxResults", - "traits": { - "smithy.api#documentation": "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.
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.
A list, each member of which contains information about an alias.
", - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.bedrockagent#NextToken", - "traits": { - "smithy.api#documentation": "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.
Returns a list of information about each flow. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
", - "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/flows/{flowIdentifier}/versions" - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "flowVersionSummaries" - }, - "smithy.api#readonly": {}, - "smithy.api#tags": [ - "console" - ] - } - }, - "com.amazonaws.bedrockagent#ListFlowVersionsRequest": { - "type": "structure", - "members": { - "flowIdentifier": { - "target": "com.amazonaws.bedrockagent#FlowIdentifier", - "traits": { - "smithy.api#documentation": "The unique identifier of the flow.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "maxResults": { - "target": "com.amazonaws.bedrockagent#MaxResults", - "traits": { - "smithy.api#documentation": "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.
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.
A list, each member of which contains information about a flow.
", - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.bedrockagent#NextToken", - "traits": { - "smithy.api#documentation": "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.
Returns a list of flows and information about each flow. For more information, see Manage a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
", - "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/flows/" - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "flowSummaries" - }, - "smithy.api#readonly": {}, - "smithy.api#tags": [ - "console" - ] - } - }, - "com.amazonaws.bedrockagent#ListFlowsRequest": { - "type": "structure", - "members": { - "maxResults": { - "target": "com.amazonaws.bedrockagent#MaxResults", - "traits": { - "smithy.api#documentation": "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.
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.
A list, each member of which contains information about a flow.
", - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.bedrockagent#NextToken", - "traits": { - "smithy.api#documentation": "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.
Lists the ingestion jobs for a data source and information about each of them.
", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}/ingestionjobs/" - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "ingestionJobSummaries" - }, - "smithy.api#readonly": {}, - "smithy.api#tags": [ - "console" - ] - } - }, - "com.amazonaws.bedrockagent#ListIngestionJobsRequest": { - "type": "structure", - "members": { - "knowledgeBaseId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the knowledge base for which to return ingestion jobs.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "dataSourceId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the data source for which to return ingestion jobs.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "filters": { - "target": "com.amazonaws.bedrockagent#IngestionJobFilters", - "traits": { - "smithy.api#documentation": "Contains a definition of a filter for which to filter the results.
" - } - }, - "sortBy": { - "target": "com.amazonaws.bedrockagent#IngestionJobSortBy", - "traits": { - "smithy.api#documentation": "Contains details about how to sort the results.
" - } - }, - "maxResults": { - "target": "com.amazonaws.bedrockagent#MaxResults", - "traits": { - "smithy.api#documentation": "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.
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.
A list of objects, each of which contains information about an ingestion job.
", - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.bedrockagent#NextToken", - "traits": { - "smithy.api#documentation": "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.
Lists the knowledge bases in an account and information about each of them.
", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/knowledgebases/" - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "knowledgeBaseSummaries" - }, - "smithy.api#readonly": {}, - "smithy.api#tags": [ - "console" - ] - } - }, - "com.amazonaws.bedrockagent#ListKnowledgeBasesRequest": { - "type": "structure", - "members": { - "maxResults": { - "target": "com.amazonaws.bedrockagent#MaxResults", - "traits": { - "smithy.api#documentation": "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.
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.
A list of objects, each of which contains information about a knowledge base.
", - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.bedrockagent#NextToken", - "traits": { - "smithy.api#documentation": "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.
Returns either information about the working draft (DRAFT
version) of each prompt in an account, or information about of all versions of a prompt, depending on whether you include the promptIdentifier
field or not. For more information, see View information about prompts using Prompt management in the Amazon Bedrock User Guide.
The unique identifier of the prompt for whose versions you want to return information. Omit this field to list information about all prompts in an account.
", - "smithy.api#httpQuery": "promptIdentifier" - } - }, - "maxResults": { - "target": "com.amazonaws.bedrockagent#MaxResults", - "traits": { - "smithy.api#documentation": "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.
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.
A list, each member of which contains information about a prompt using Prompt management.
", - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.bedrockagent#NextToken", - "traits": { - "smithy.api#documentation": "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.
List all the tags for the resource you specify.
", - "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/tags/{resourceArn}" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.bedrockagent#ListTagsForResourceRequest": { - "type": "structure", - "members": { - "resourceArn": { - "target": "com.amazonaws.bedrockagent#TaggableResourcesArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource for which to list tags.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#ListTagsForResourceResponse": { - "type": "structure", - "members": { - "tags": { - "target": "com.amazonaws.bedrockagent#TagsMap", - "traits": { - "smithy.api#documentation": "The key-value pairs for the tags associated with the resource.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#MaxResults": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 1000 - } - } - }, - "com.amazonaws.bedrockagent#MaximumLength": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0, - "max": 4096 - } - } - }, - "com.amazonaws.bedrockagent#MemoryConfiguration": { - "type": "structure", - "members": { - "enabledMemoryTypes": { - "target": "com.amazonaws.bedrockagent#EnabledMemoryTypes", - "traits": { - "smithy.api#documentation": "The type of memory that is stored.
", - "smithy.api#required": {} - } - }, - "storageDays": { - "target": "com.amazonaws.bedrockagent#StorageDays", - "traits": { - "smithy.api#default": 30, - "smithy.api#documentation": "The number of days the agent is configured to retain the conversational context.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Details of the memory configuration.
" - } - }, - "com.amazonaws.bedrockagent#MemoryType": { - "type": "enum", - "members": { - "SESSION_SUMMARY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SESSION_SUMMARY" - } - } - } - }, - "com.amazonaws.bedrockagent#Microsoft365TenantId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 36, - "max": 36 - }, - "smithy.api#pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" - } - }, - "com.amazonaws.bedrockagent#ModelIdentifier": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - }, - "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})))|(([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2}))|(([0-9a-zA-Z][_-]?)+)$" - } - }, - "com.amazonaws.bedrockagent#MongoDbAtlasCollectionName": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 63 - }, - "smithy.api#pattern": "^.*$" - } - }, - "com.amazonaws.bedrockagent#MongoDbAtlasConfiguration": { - "type": "structure", - "members": { - "endpoint": { - "target": "com.amazonaws.bedrockagent#MongoDbAtlasEndpoint", - "traits": { - "smithy.api#documentation": "The endpoint URL of your MongoDB Atlas cluster for your knowledge base.
", - "smithy.api#required": {} - } - }, - "databaseName": { - "target": "com.amazonaws.bedrockagent#MongoDbAtlasDatabaseName", - "traits": { - "smithy.api#documentation": "The database name in your MongoDB Atlas cluster for your knowledge base.
", - "smithy.api#required": {} - } - }, - "collectionName": { - "target": "com.amazonaws.bedrockagent#MongoDbAtlasCollectionName", - "traits": { - "smithy.api#documentation": "The collection name of the knowledge base in MongoDB Atlas.
", - "smithy.api#required": {} - } - }, - "vectorIndexName": { - "target": "com.amazonaws.bedrockagent#MongoDbAtlasIndexName", - "traits": { - "smithy.api#documentation": "The name of the MongoDB Atlas vector search index.
", - "smithy.api#required": {} - } - }, - "credentialsSecretArn": { - "target": "com.amazonaws.bedrockagent#SecretArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that contains user credentials for your MongoDB Atlas cluster.
", - "smithy.api#required": {} - } - }, - "fieldMapping": { - "target": "com.amazonaws.bedrockagent#MongoDbAtlasFieldMapping", - "traits": { - "smithy.api#documentation": "Contains the names of the fields to which to map information about the vector store.
", - "smithy.api#required": {} - } - }, - "endpointServiceName": { - "target": "com.amazonaws.bedrockagent#MongoDbAtlasEndpointServiceName", - "traits": { - "smithy.api#documentation": "The name of the VPC endpoint service in your account that is connected to your MongoDB Atlas cluster.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains details about the storage configuration of the knowledge base in MongoDB Atlas.
" - } - }, - "com.amazonaws.bedrockagent#MongoDbAtlasDatabaseName": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 63 - }, - "smithy.api#pattern": "^.*$" - } - }, - "com.amazonaws.bedrockagent#MongoDbAtlasEndpoint": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 2048 - }, - "smithy.api#pattern": "^.*$" - } - }, - "com.amazonaws.bedrockagent#MongoDbAtlasEndpointServiceName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^(?:arn:aws(?:-us-gov|-cn|-iso|-iso-[a-z])*:.+:.*:\\d+:.+/.+$|[a-zA-Z0-9*]+[a-zA-Z0-9._-]*)$" - } - }, - "com.amazonaws.bedrockagent#MongoDbAtlasFieldMapping": { - "type": "structure", - "members": { - "vectorField": { - "target": "com.amazonaws.bedrockagent#FieldName", - "traits": { - "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
", - "smithy.api#required": {} - } - }, - "textField": { - "target": "com.amazonaws.bedrockagent#FieldName", - "traits": { - "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
", - "smithy.api#required": {} - } - }, - "metadataField": { - "target": "com.amazonaws.bedrockagent#FieldName", - "traits": { - "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores metadata about the vector store.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains the names of the fields to which to map information about the vector store.
" - } - }, - "com.amazonaws.bedrockagent#MongoDbAtlasIndexName": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 2048 - }, - "smithy.api#pattern": "^.*$" - } - }, - "com.amazonaws.bedrockagent#Name": { - "type": "string", - "traits": { - "smithy.api#pattern": "^([0-9a-zA-Z][_-]?){1,100}$" - } - }, - "com.amazonaws.bedrockagent#NextToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - }, - "smithy.api#pattern": "^\\S*$" - } - }, - "com.amazonaws.bedrockagent#NonBlankString": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[\\s\\S]+$" - } - }, - "com.amazonaws.bedrockagent#NumericalVersion": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[0-9]{1,5}$" - } - }, - "com.amazonaws.bedrockagent#OpenSearchServerlessCollectionArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 2048 - }, - "smithy.api#pattern": "^arn:aws:aoss:[a-z]{2}(-gov)?-[a-z]+-\\d{1}:\\d{12}:collection/[a-z0-9-]{3,32}$" - } - }, - "com.amazonaws.bedrockagent#OpenSearchServerlessConfiguration": { - "type": "structure", - "members": { - "collectionArn": { - "target": "com.amazonaws.bedrockagent#OpenSearchServerlessCollectionArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the OpenSearch Service vector store.
", - "smithy.api#required": {} - } - }, - "vectorIndexName": { - "target": "com.amazonaws.bedrockagent#OpenSearchServerlessIndexName", - "traits": { - "smithy.api#documentation": "The name of the vector store.
", - "smithy.api#required": {} - } - }, - "fieldMapping": { - "target": "com.amazonaws.bedrockagent#OpenSearchServerlessFieldMapping", - "traits": { - "smithy.api#documentation": "Contains the names of the fields to which to map information about the vector store.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains details about the storage configuration of the knowledge base in Amazon OpenSearch Service. For more information, see Create a vector index in Amazon OpenSearch Service.
" - } - }, - "com.amazonaws.bedrockagent#OpenSearchServerlessFieldMapping": { - "type": "structure", - "members": { - "vectorField": { - "target": "com.amazonaws.bedrockagent#FieldName", - "traits": { - "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
", - "smithy.api#required": {} - } - }, - "textField": { - "target": "com.amazonaws.bedrockagent#FieldName", - "traits": { - "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
", - "smithy.api#required": {} - } - }, - "metadataField": { - "target": "com.amazonaws.bedrockagent#FieldName", - "traits": { - "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores metadata about the vector store.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains the names of the fields to which to map information about the vector store.
" - } - }, - "com.amazonaws.bedrockagent#OpenSearchServerlessIndexName": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 2048 - }, - "smithy.api#pattern": "^.*$" - } - }, - "com.amazonaws.bedrockagent#OutputFlowNodeConfiguration": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "Contains configurations for an output flow node in the flow. You specify the data type expected for the input into the node in the type
field and how to return the final output in the expression
field.
A description of the parameter. Helps the foundation model determine how to elicit the parameters from the user.
" - } - }, - "type": { - "target": "com.amazonaws.bedrockagent#Type", - "traits": { - "smithy.api#documentation": "The data type of the parameter.
", - "smithy.api#required": {} - } - }, - "required": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "Whether the parameter is required for the agent to complete the function for action group invocation.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains details about a parameter in a function for an action group.
\nThis data type is used in the following API operations:
\nThe parsing strategy for the data source.
", - "smithy.api#required": {} - } - }, - "bedrockFoundationModelConfiguration": { - "target": "com.amazonaws.bedrockagent#BedrockFoundationModelConfiguration", - "traits": { - "smithy.api#documentation": "Settings for a foundation model used to parse documents for a data source.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Settings for parsing document contents. By default, the service converts the contents of each\n document into text before splitting it into chunks. To improve processing of PDF files with tables and images,\n you can configure the data source to convert the pages of text into images and use a model to describe the\n contents of each page.
\nTo use a model to parse PDF documents, set the parsing strategy to BEDROCK_FOUNDATION_MODEL
and\n specify the model to use by ARN. You can also override the default parsing prompt with instructions for how\n to interpret images and tables in your documents. The following models are supported.
Anthropic Claude 3 Sonnet - anthropic.claude-3-sonnet-20240229-v1:0
\n
Anthropic Claude 3 Haiku - anthropic.claude-3-haiku-20240307-v1:0
\n
You can get the ARN of a model with the ListFoundationModels action. Standard model usage\n charges apply for the foundation model parsing strategy.
" - } - }, - "com.amazonaws.bedrockagent#ParsingPrompt": { - "type": "structure", - "members": { - "parsingPromptText": { - "target": "com.amazonaws.bedrockagent#ParsingPromptText", - "traits": { - "smithy.api#documentation": "Instructions for interpreting the contents of a document.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Instructions for interpreting the contents of a document.
" - } - }, - "com.amazonaws.bedrockagent#ParsingPromptText": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10000 - } - } - }, - "com.amazonaws.bedrockagent#ParsingStrategy": { - "type": "enum", - "members": { - "BEDROCK_FOUNDATION_MODEL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BEDROCK_FOUNDATION_MODEL" - } - } - } - }, - "com.amazonaws.bedrockagent#PatternObjectFilter": { - "type": "structure", - "members": { - "objectType": { - "target": "com.amazonaws.bedrockagent#FilteredObjectType", - "traits": { - "smithy.api#documentation": "The supported object type or content type of the data source.
", - "smithy.api#required": {} - } - }, - "inclusionFilters": { - "target": "com.amazonaws.bedrockagent#FilterList", - "traits": { - "smithy.api#documentation": "A list of one or more inclusion regular expression patterns to include certain \n object types that adhere to the pattern. If you specify an inclusion and exclusion \n filter/pattern and both match a document, the exclusion filter takes precedence \n and the document isn’t crawled.
" - } - }, - "exclusionFilters": { - "target": "com.amazonaws.bedrockagent#FilterList", - "traits": { - "smithy.api#documentation": "A list of one or more exclusion regular expression patterns to exclude certain \n object types that adhere to the pattern. If you specify an inclusion and exclusion \n filter/pattern and both match a document, the exclusion filter takes precedence \n and the document isn’t crawled.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The specific filters applied to your data source content. You can filter out or \n include certain content.
" - } - }, - "com.amazonaws.bedrockagent#PatternObjectFilterConfiguration": { - "type": "structure", - "members": { - "filters": { - "target": "com.amazonaws.bedrockagent#PatternObjectFilterList", - "traits": { - "smithy.api#documentation": "The configuration of specific filters applied to your data source content. You can \n filter out or include certain content.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "The configuration of filtering certain objects or content types of the data source.
" - } - }, - "com.amazonaws.bedrockagent#PatternObjectFilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagent#PatternObjectFilter" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 25 - }, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.bedrockagent#Payload": { - "type": "string", - "traits": { - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.bedrockagent#PineconeConfiguration": { - "type": "structure", - "members": { - "connectionString": { - "target": "com.amazonaws.bedrockagent#PineconeConnectionString", - "traits": { - "smithy.api#documentation": "The endpoint URL for your index management page.
", - "smithy.api#required": {} - } - }, - "credentialsSecretArn": { - "target": "com.amazonaws.bedrockagent#SecretArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Pinecone API key.
", - "smithy.api#required": {} - } - }, - "namespace": { - "target": "com.amazonaws.bedrockagent#PineconeNamespace", - "traits": { - "smithy.api#documentation": "The namespace to be used to write new data to your database.
" - } - }, - "fieldMapping": { - "target": "com.amazonaws.bedrockagent#PineconeFieldMapping", - "traits": { - "smithy.api#documentation": "Contains the names of the fields to which to map information about the vector store.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains details about the storage configuration of the knowledge base in Pinecone. For more information, see Create a vector index in Pinecone.
" - } - }, - "com.amazonaws.bedrockagent#PineconeConnectionString": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 2048 - }, - "smithy.api#pattern": "^.*$" - } - }, - "com.amazonaws.bedrockagent#PineconeFieldMapping": { - "type": "structure", - "members": { - "textField": { - "target": "com.amazonaws.bedrockagent#FieldName", - "traits": { - "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
", - "smithy.api#required": {} - } - }, - "metadataField": { - "target": "com.amazonaws.bedrockagent#FieldName", - "traits": { - "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores metadata about the vector store.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains the names of the fields to which to map information about the vector store.
" - } - }, - "com.amazonaws.bedrockagent#PineconeNamespace": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 2048 - }, - "smithy.api#pattern": "^.*$" - } - }, - "com.amazonaws.bedrockagent#PrepareAgent": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#PrepareAgentRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#PrepareAgentResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#ConflictException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Creates a DRAFT
version of the agent that can be used for internal testing.
The unique identifier of the agent for which to create a DRAFT
version.
The unique identifier of the agent for which the DRAFT
version was created.
The status of the DRAFT
version and whether it is ready for use.
The version of the agent.
", - "smithy.api#required": {} - } - }, - "preparedAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the DRAFT
version of the agent was last prepared.
Prepares the DRAFT
version of a flow so that it can be invoked. For more information, see Test a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
The unique identifier of the flow.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#PrepareFlowResponse": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.bedrockagent#FlowId", - "traits": { - "smithy.api#documentation": "The unique identifier of the flow.
", - "smithy.api#required": {} - } - }, - "status": { - "target": "com.amazonaws.bedrockagent#FlowStatus", - "traits": { - "smithy.api#documentation": "The status of the flow. When you submit this request, the status will be NotPrepared
. If preparation succeeds, the status becomes Prepared
. If it fails, the status becomes FAILED
.
The step in the agent sequence that this prompt configuration applies to.
" - } - }, - "promptCreationMode": { - "target": "com.amazonaws.bedrockagent#CreationMode", - "traits": { - "smithy.api#documentation": "Specifies whether to override the default prompt template for this promptType
. Set this value to OVERRIDDEN
to use the prompt that you provide in the basePromptTemplate
. If you leave it as DEFAULT
, the agent uses a default prompt template.
Specifies whether to allow the agent to carry out the step specified in the promptType
. If you set this value to DISABLED
, the agent skips that step. The default state for each promptType
is as follows.
\n PRE_PROCESSING
– ENABLED
\n
\n ORCHESTRATION
– ENABLED
\n
\n KNOWLEDGE_BASE_RESPONSE_GENERATION
– ENABLED
\n
\n POST_PROCESSING
– DISABLED
\n
Defines the prompt template with which to replace the default prompt template. You can use placeholder variables in the base prompt template to customize the prompt. For more information, see Prompt template placeholder variables. For more information, see Configure the prompt templates.
" - } - }, - "inferenceConfiguration": { - "target": "com.amazonaws.bedrockagent#InferenceConfiguration", - "traits": { - "smithy.api#documentation": "Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the promptType
. For more information, see Inference parameters for foundation models.
Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the promptType
. If you set the field as OVERRIDEN
, the overrideLambda
field in the PromptOverrideConfiguration must be specified with the ARN of a Lambda function.
Contains configurations to override a prompt template in one part of an agent sequence. For more information, see Advanced prompts.
" - } - }, - "com.amazonaws.bedrockagent#PromptConfigurations": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagent#PromptConfiguration" - }, - "traits": { - "smithy.api#length": { - "max": 10 - } - } - }, - "com.amazonaws.bedrockagent#PromptDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 200 - } - } - }, - "com.amazonaws.bedrockagent#PromptFlowNodeConfiguration": { - "type": "structure", - "members": { - "sourceConfiguration": { - "target": "com.amazonaws.bedrockagent#PromptFlowNodeSourceConfiguration", - "traits": { - "smithy.api#documentation": "Specifies whether the prompt is from Prompt management or defined inline.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains configurations for a prompt node in the flow. You can use a prompt from Prompt management or you can define one in this node. If the prompt contains variables, the inputs into this node will fill in the variables. The output from this node is the response generated by the model. For more information, see Node types in Amazon Bedrock works in the Amazon Bedrock User Guide.
" - } - }, - "com.amazonaws.bedrockagent#PromptFlowNodeInlineConfiguration": { - "type": "structure", - "members": { - "templateType": { - "target": "com.amazonaws.bedrockagent#PromptTemplateType", - "traits": { - "smithy.api#documentation": "The type of prompt template.
", - "smithy.api#required": {} - } - }, - "templateConfiguration": { - "target": "com.amazonaws.bedrockagent#PromptTemplateConfiguration", - "traits": { - "smithy.api#documentation": "Contains a prompt and variables in the prompt that can be replaced with values at runtime.
", - "smithy.api#required": {} - } - }, - "modelId": { - "target": "com.amazonaws.bedrockagent#PromptModelIdentifier", - "traits": { - "smithy.api#documentation": "The unique identifier of the model to run inference with.
", - "smithy.api#required": {} - } - }, - "inferenceConfiguration": { - "target": "com.amazonaws.bedrockagent#PromptInferenceConfiguration", - "traits": { - "smithy.api#documentation": "Contains inference configurations for the prompt.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains configurations for a prompt defined inline in the node.
" - } - }, - "com.amazonaws.bedrockagent#PromptFlowNodeResourceConfiguration": { - "type": "structure", - "members": { - "promptArn": { - "target": "com.amazonaws.bedrockagent#PromptArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the prompt from Prompt management.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains configurations for a prompt from Prompt management to use in a node.
" - } - }, - "com.amazonaws.bedrockagent#PromptFlowNodeSourceConfiguration": { - "type": "union", - "members": { - "resource": { - "target": "com.amazonaws.bedrockagent#PromptFlowNodeResourceConfiguration", - "traits": { - "smithy.api#documentation": "Contains configurations for a prompt from Prompt management.
" - } - }, - "inline": { - "target": "com.amazonaws.bedrockagent#PromptFlowNodeInlineConfiguration", - "traits": { - "smithy.api#documentation": "Contains configurations for a prompt that is defined inline
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains configurations for a prompt and whether it is from Prompt management or defined inline.
" - } - }, - "com.amazonaws.bedrockagent#PromptId": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[0-9a-zA-Z]{10}$" - } - }, - "com.amazonaws.bedrockagent#PromptIdentifier": { - "type": "string", - "traits": { - "smithy.api#pattern": "^([0-9a-zA-Z]{10})|(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:prompt/[0-9a-zA-Z]{10})(?::[0-9]{1,5})?$" - } - }, - "com.amazonaws.bedrockagent#PromptInferenceConfiguration": { - "type": "union", - "members": { - "text": { - "target": "com.amazonaws.bedrockagent#PromptModelInferenceConfiguration", - "traits": { - "smithy.api#documentation": "Contains inference configurations for a text prompt.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains inference configurations for the prompt.
" - } - }, - "com.amazonaws.bedrockagent#PromptInputVariable": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.bedrockagent#PromptInputVariableName", - "traits": { - "smithy.api#documentation": "The name of the variable.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about a variable in the prompt.
" - } - }, - "com.amazonaws.bedrockagent#PromptInputVariableName": { - "type": "string", - "traits": { - "smithy.api#pattern": "^([0-9a-zA-Z][_-]?){1,100}$" - } - }, - "com.amazonaws.bedrockagent#PromptInputVariablesList": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagent#PromptInputVariable" - }, - "traits": { - "smithy.api#length": { - "max": 5 - }, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.bedrockagent#PromptMetadataEntry": { - "type": "structure", - "members": { - "key": { - "target": "com.amazonaws.bedrockagent#PromptMetadataKey", - "traits": { - "smithy.api#documentation": "The key of a metadata tag for a prompt variant.
", - "smithy.api#required": {} - } - }, - "value": { - "target": "com.amazonaws.bedrockagent#PromptMetadataValue", - "traits": { - "smithy.api#documentation": "The value of a metadata tag for a prompt variant.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains a key-value pair that defines a metadata tag and value to attach to a prompt variant. For more information, see Create a prompt using Prompt management.
", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.bedrockagent#PromptMetadataKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.bedrockagent#PromptMetadataList": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagent#PromptMetadataEntry" - }, - "traits": { - "smithy.api#length": { - "max": 50 - }, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.bedrockagent#PromptMetadataValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - }, - "smithy.api#pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.bedrockagent#PromptModelIdentifier": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - }, - "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|([0-9]{12}:provisioned-model/[a-z0-9]{12})))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|(([0-9a-zA-Z][_-]?)+)$" - } - }, - "com.amazonaws.bedrockagent#PromptModelInferenceConfiguration": { - "type": "structure", - "members": { - "temperature": { - "target": "com.amazonaws.bedrockagent#Temperature", - "traits": { - "smithy.api#documentation": "Controls the randomness of the response. Choose a lower value for more predictable outputs and a higher value for more surprising outputs.
" - } - }, - "topP": { - "target": "com.amazonaws.bedrockagent#TopP", - "traits": { - "smithy.api#documentation": "The percentage of most-likely candidates that the model considers for the next token.
" - } - }, - "topK": { - "target": "com.amazonaws.bedrockagent#TopK", - "traits": { - "smithy.api#documentation": "The number of most-likely candidates that the model considers for the next token during generation.
" - } - }, - "maxTokens": { - "target": "com.amazonaws.bedrockagent#MaximumLength", - "traits": { - "smithy.api#documentation": "The maximum number of tokens to return in the response.
" - } - }, - "stopSequences": { - "target": "com.amazonaws.bedrockagent#StopSequences", - "traits": { - "smithy.api#documentation": "A list of strings that define sequences after which the model will stop generating.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains inference configurations related to model inference for a prompt. For more information, see Inference parameters.
" - } - }, - "com.amazonaws.bedrockagent#PromptName": { - "type": "string", - "traits": { - "smithy.api#pattern": "^([0-9a-zA-Z][_-]?){1,100}$" - } - }, - "com.amazonaws.bedrockagent#PromptOverrideConfiguration": { - "type": "structure", - "members": { - "promptConfigurations": { - "target": "com.amazonaws.bedrockagent#PromptConfigurations", - "traits": { - "smithy.api#documentation": "Contains configurations to override a prompt template in one part of an agent sequence. For more information, see Advanced prompts.
", - "smithy.api#required": {} - } - }, - "overrideLambda": { - "target": "com.amazonaws.bedrockagent#LambdaArn", - "traits": { - "smithy.api#documentation": "The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence. If you specify this field, at least one of the promptConfigurations
must contain a parserMode
value that is set to OVERRIDDEN
. For more information, see Parser Lambda function in Agents for Amazon Bedrock.
Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.
", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.bedrockagent#PromptResource": { - "type": "resource", - "identifiers": { - "promptIdentifier": { - "target": "com.amazonaws.bedrockagent#PromptIdentifier" - } - }, - "create": { - "target": "com.amazonaws.bedrockagent#CreatePrompt" - }, - "read": { - "target": "com.amazonaws.bedrockagent#GetPrompt" - }, - "update": { - "target": "com.amazonaws.bedrockagent#UpdatePrompt" - }, - "delete": { - "target": "com.amazonaws.bedrockagent#DeletePrompt" - }, - "list": { - "target": "com.amazonaws.bedrockagent#ListPrompts" - }, - "operations": [ - { - "target": "com.amazonaws.bedrockagent#CreatePromptVersion" - } - ], - "traits": { - "aws.cloudformation#cfnResource": { - "name": "Prompt" - } - } - }, - "com.amazonaws.bedrockagent#PromptState": { - "type": "enum", - "members": { - "ENABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENABLED" - } - }, - "DISABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISABLED" - } - } - } - }, - "com.amazonaws.bedrockagent#PromptSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagent#PromptSummary" - }, - "traits": { - "smithy.api#length": { - "max": 10 - } - } - }, - "com.amazonaws.bedrockagent#PromptSummary": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.bedrockagent#PromptName", - "traits": { - "smithy.api#documentation": "The name of the prompt.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#PromptDescription", - "traits": { - "smithy.api#documentation": "The description of the prompt.
" - } - }, - "id": { - "target": "com.amazonaws.bedrockagent#PromptId", - "traits": { - "smithy.api#documentation": "The unique identifier of the prompt.
", - "smithy.api#required": {} - } - }, - "arn": { - "target": "com.amazonaws.bedrockagent#PromptArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the prompt or the prompt version (if you specified a version in the request).
", - "smithy.api#required": {} - } - }, - "version": { - "target": "com.amazonaws.bedrockagent#Version", - "traits": { - "smithy.api#documentation": "The version of the prompt that this summary applies to.
", - "smithy.api#required": {} - } - }, - "createdAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the prompt was created.
", - "smithy.api#required": {} - } - }, - "updatedAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the prompt was last updated.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about a prompt in your Prompt management tool.
\nThis data type is used in the following API operations:
\n\n ListPrompts response\n
\nContains configurations for the text in a message for a prompt.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains the message for a prompt. For more information, see Prompt management in Amazon Bedrock.
" - } - }, - "com.amazonaws.bedrockagent#PromptTemplateType": { - "type": "enum", - "members": { - "TEXT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TEXT" - } - } - } - }, - "com.amazonaws.bedrockagent#PromptType": { - "type": "enum", - "members": { - "PRE_PROCESSING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PRE_PROCESSING" - } - }, - "ORCHESTRATION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ORCHESTRATION" - } - }, - "POST_PROCESSING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "POST_PROCESSING" - } - }, - "KNOWLEDGE_BASE_RESPONSE_GENERATION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "KNOWLEDGE_BASE_RESPONSE_GENERATION" - } - } - } - }, - "com.amazonaws.bedrockagent#PromptVariant": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.bedrockagent#PromptVariantName", - "traits": { - "smithy.api#documentation": "The name of the prompt variant.
", - "smithy.api#required": {} - } - }, - "templateType": { - "target": "com.amazonaws.bedrockagent#PromptTemplateType", - "traits": { - "smithy.api#documentation": "The type of prompt template to use.
", - "smithy.api#required": {} - } - }, - "templateConfiguration": { - "target": "com.amazonaws.bedrockagent#PromptTemplateConfiguration", - "traits": { - "smithy.api#documentation": "Contains configurations for the prompt template.
" - } - }, - "modelId": { - "target": "com.amazonaws.bedrockagent#PromptModelIdentifier", - "traits": { - "smithy.api#documentation": "The unique identifier of the model with which to run inference on the prompt.
" - } - }, - "inferenceConfiguration": { - "target": "com.amazonaws.bedrockagent#PromptInferenceConfiguration", - "traits": { - "smithy.api#documentation": "Contains inference configurations for the prompt variant.
" - } - }, - "metadata": { - "target": "com.amazonaws.bedrockagent#PromptMetadataList", - "traits": { - "smithy.api#documentation": "An array of objects, each containing a key-value pair that defines a metadata tag and value to attach to a prompt variant. For more information, see Create a prompt using Prompt management.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains details about a variant of the prompt.
", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.bedrockagent#PromptVariantList": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagent#PromptVariant" - }, - "traits": { - "smithy.api#length": { - "max": 3 - }, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.bedrockagent#PromptVariantName": { - "type": "string", - "traits": { - "smithy.api#pattern": "^([0-9a-zA-Z][_-]?){1,100}$" - } - }, - "com.amazonaws.bedrockagent#ProvisionedModelIdentifier": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - }, - "smithy.api#pattern": "^((([0-9a-zA-Z][_-]?){1,63})|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:provisioned-model/[a-z0-9]{12}))$" - } - }, - "com.amazonaws.bedrockagent#RdsArn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:aws(|-cn|-us-gov):rds:[a-zA-Z0-9-]*:[0-9]{12}:cluster:[a-zA-Z0-9-]{1,63}$" - } - }, - "com.amazonaws.bedrockagent#RdsConfiguration": { - "type": "structure", - "members": { - "resourceArn": { - "target": "com.amazonaws.bedrockagent#RdsArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the vector store.
", - "smithy.api#required": {} - } - }, - "credentialsSecretArn": { - "target": "com.amazonaws.bedrockagent#SecretArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Amazon RDS database.
", - "smithy.api#required": {} - } - }, - "databaseName": { - "target": "com.amazonaws.bedrockagent#RdsDatabaseName", - "traits": { - "smithy.api#documentation": "The name of your Amazon RDS database.
", - "smithy.api#required": {} - } - }, - "tableName": { - "target": "com.amazonaws.bedrockagent#RdsTableName", - "traits": { - "smithy.api#documentation": "The name of the table in the database.
", - "smithy.api#required": {} - } - }, - "fieldMapping": { - "target": "com.amazonaws.bedrockagent#RdsFieldMapping", - "traits": { - "smithy.api#documentation": "Contains the names of the fields to which to map information about the vector store.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS.
" - } - }, - "com.amazonaws.bedrockagent#RdsDatabaseName": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 63 - }, - "smithy.api#pattern": "^[a-zA-Z0-9_\\-]+$" - } - }, - "com.amazonaws.bedrockagent#RdsFieldMapping": { - "type": "structure", - "members": { - "primaryKeyField": { - "target": "com.amazonaws.bedrockagent#ColumnName", - "traits": { - "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores the ID for each entry.
", - "smithy.api#required": {} - } - }, - "vectorField": { - "target": "com.amazonaws.bedrockagent#ColumnName", - "traits": { - "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
", - "smithy.api#required": {} - } - }, - "textField": { - "target": "com.amazonaws.bedrockagent#ColumnName", - "traits": { - "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
", - "smithy.api#required": {} - } - }, - "metadataField": { - "target": "com.amazonaws.bedrockagent#ColumnName", - "traits": { - "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores metadata about the vector store.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains the names of the fields to which to map information about the vector store.
" - } - }, - "com.amazonaws.bedrockagent#RdsTableName": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 63 - }, - "smithy.api#pattern": "^[a-zA-Z0-9_\\.\\-]+$" - } - }, - "com.amazonaws.bedrockagent#RecommendedAction": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 2048 - } - } - }, - "com.amazonaws.bedrockagent#RecommendedActions": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagent#RecommendedAction" - }, - "traits": { - "smithy.api#length": { - "max": 2048 - } - } - }, - "com.amazonaws.bedrockagent#RedisEnterpriseCloudConfiguration": { - "type": "structure", - "members": { - "endpoint": { - "target": "com.amazonaws.bedrockagent#RedisEnterpriseCloudEndpoint", - "traits": { - "smithy.api#documentation": "The endpoint URL of the Redis Enterprise Cloud database.
", - "smithy.api#required": {} - } - }, - "vectorIndexName": { - "target": "com.amazonaws.bedrockagent#RedisEnterpriseCloudIndexName", - "traits": { - "smithy.api#documentation": "The name of the vector index.
", - "smithy.api#required": {} - } - }, - "credentialsSecretArn": { - "target": "com.amazonaws.bedrockagent#SecretArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Redis Enterprise Cloud database.
", - "smithy.api#required": {} - } - }, - "fieldMapping": { - "target": "com.amazonaws.bedrockagent#RedisEnterpriseCloudFieldMapping", - "traits": { - "smithy.api#documentation": "Contains the names of the fields to which to map information about the vector store.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains details about the storage configuration of the knowledge base in Redis Enterprise Cloud. For more information, see Create a vector index in Redis Enterprise Cloud.
" - } - }, - "com.amazonaws.bedrockagent#RedisEnterpriseCloudEndpoint": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 2048 - }, - "smithy.api#pattern": "^.*$" - } - }, - "com.amazonaws.bedrockagent#RedisEnterpriseCloudFieldMapping": { - "type": "structure", - "members": { - "vectorField": { - "target": "com.amazonaws.bedrockagent#FieldName", - "traits": { - "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
", - "smithy.api#required": {} - } - }, - "textField": { - "target": "com.amazonaws.bedrockagent#FieldName", - "traits": { - "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
", - "smithy.api#required": {} - } - }, - "metadataField": { - "target": "com.amazonaws.bedrockagent#FieldName", - "traits": { - "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores metadata about the vector store.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains the names of the fields to which to map information about the vector store.
" - } - }, - "com.amazonaws.bedrockagent#RedisEnterpriseCloudIndexName": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 2048 - }, - "smithy.api#pattern": "^.*$" - } - }, - "com.amazonaws.bedrockagent#RequireConfirmation": { - "type": "enum", - "members": { - "ENABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENABLED" - } - }, - "DISABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISABLED" - } - } - }, - "traits": { - "smithy.api#documentation": "ENUM to check if action requires user confirmation" - } - }, - "com.amazonaws.bedrockagent#ResourceNotFoundException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.bedrockagent#NonBlankString" - } - }, - "traits": { - "smithy.api#documentation": "The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.bedrockagent#RetrievalFlowNodeConfiguration": { - "type": "structure", - "members": { - "serviceConfiguration": { - "target": "com.amazonaws.bedrockagent#RetrievalFlowNodeServiceConfiguration", - "traits": { - "smithy.api#documentation": "Contains configurations for the service to use for retrieving data to return as the output from the node.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains configurations for a Retrieval node in a flow. This node retrieves data from the Amazon S3 location that you specify and returns it as the output.
" - } - }, - "com.amazonaws.bedrockagent#RetrievalFlowNodeS3Configuration": { - "type": "structure", - "members": { - "bucketName": { - "target": "com.amazonaws.bedrockagent#S3BucketName", - "traits": { - "smithy.api#documentation": "The name of the Amazon S3 bucket from which to retrieve data.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains configurations for the Amazon S3 location from which to retrieve data to return as the output from the node.
" - } - }, - "com.amazonaws.bedrockagent#RetrievalFlowNodeServiceConfiguration": { - "type": "union", - "members": { - "s3": { - "target": "com.amazonaws.bedrockagent#RetrievalFlowNodeS3Configuration", - "traits": { - "smithy.api#documentation": "Contains configurations for the Amazon S3 location from which to retrieve data to return as the output from the node.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains configurations for the service to use for retrieving data to return as the output from the node.
" - } - }, - "com.amazonaws.bedrockagent#S3BucketArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - }, - "smithy.api#pattern": "^arn:aws(|-cn|-us-gov):s3:::[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$" - } - }, - "com.amazonaws.bedrockagent#S3BucketName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 3, - "max": 63 - }, - "smithy.api#pattern": "^[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$" - } - }, - "com.amazonaws.bedrockagent#S3BucketUri": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - }, - "smithy.api#pattern": "^s3://.{1,128}$" - } - }, - "com.amazonaws.bedrockagent#S3DataSourceConfiguration": { - "type": "structure", - "members": { - "bucketArn": { - "target": "com.amazonaws.bedrockagent#S3BucketArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the S3 bucket that contains your data.
", - "smithy.api#required": {} - } - }, - "inclusionPrefixes": { - "target": "com.amazonaws.bedrockagent#S3Prefixes", - "traits": { - "smithy.api#documentation": "A list of S3 prefixes to include certain files or content. For more information, \n see Organizing objects using prefixes.
" - } - }, - "bucketOwnerAccountId": { - "target": "com.amazonaws.bedrockagent#BucketOwnerAccountId", - "traits": { - "smithy.api#documentation": "The account ID for the owner of the S3 bucket.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The configuration information to connect to Amazon S3 as your data source.
" - } - }, - "com.amazonaws.bedrockagent#S3Identifier": { - "type": "structure", - "members": { - "s3BucketName": { - "target": "com.amazonaws.bedrockagent#S3BucketName", - "traits": { - "smithy.api#documentation": "The name of the S3 bucket.
" - } - }, - "s3ObjectKey": { - "target": "com.amazonaws.bedrockagent#S3ObjectKey", - "traits": { - "smithy.api#documentation": "The S3 object key for the S3 resource.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The identifier information for an Amazon S3 bucket.
" - } - }, - "com.amazonaws.bedrockagent#S3Location": { - "type": "structure", - "members": { - "uri": { - "target": "com.amazonaws.bedrockagent#S3BucketUri", - "traits": { - "smithy.api#documentation": "The location's URI. For example, s3://my-bucket/chunk-processor/
.
An Amazon S3 location.
" - } - }, - "com.amazonaws.bedrockagent#S3ObjectKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - }, - "smithy.api#pattern": "^[\\.\\-\\!\\*\\_\\'\\(\\)a-zA-Z0-9][\\.\\-\\!\\*\\_\\'\\(\\)\\/a-zA-Z0-9]*$" - } - }, - "com.amazonaws.bedrockagent#S3Prefix": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 300 - }, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.bedrockagent#S3Prefixes": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagent#S3Prefix" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - } - } - }, - "com.amazonaws.bedrockagent#SalesforceAuthType": { - "type": "enum", - "members": { - "OAUTH2_CLIENT_CREDENTIALS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OAUTH2_CLIENT_CREDENTIALS" - } - } - } - }, - "com.amazonaws.bedrockagent#SalesforceCrawlerConfiguration": { - "type": "structure", - "members": { - "filterConfiguration": { - "target": "com.amazonaws.bedrockagent#CrawlFilterConfiguration", - "traits": { - "smithy.api#documentation": "The configuration of filtering the Salesforce content. For example, \n configuring regular expression patterns to include or exclude certain \n content.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The configuration of the Salesforce content. For example, configuring \n specific types of Salesforce content.
" - } - }, - "com.amazonaws.bedrockagent#SalesforceDataSourceConfiguration": { - "type": "structure", - "members": { - "sourceConfiguration": { - "target": "com.amazonaws.bedrockagent#SalesforceSourceConfiguration", - "traits": { - "smithy.api#documentation": "The endpoint information to connect to your Salesforce data source.
", - "smithy.api#required": {} - } - }, - "crawlerConfiguration": { - "target": "com.amazonaws.bedrockagent#SalesforceCrawlerConfiguration", - "traits": { - "smithy.api#documentation": "The configuration of the Salesforce content. For example, configuring \n specific types of Salesforce content.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The configuration information to connect to Salesforce as your data source.
" - } - }, - "com.amazonaws.bedrockagent#SalesforceSourceConfiguration": { - "type": "structure", - "members": { - "hostUrl": { - "target": "com.amazonaws.bedrockagent#HttpsUrl", - "traits": { - "smithy.api#documentation": "The Salesforce host URL or instance URL.
", - "smithy.api#required": {} - } - }, - "authType": { - "target": "com.amazonaws.bedrockagent#SalesforceAuthType", - "traits": { - "smithy.api#documentation": "The supported authentication type to authenticate and connect to your \n Salesforce instance.
", - "smithy.api#required": {} - } - }, - "credentialsSecretArn": { - "target": "com.amazonaws.bedrockagent#SecretArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name of an Secrets Manager secret that \n stores your authentication credentials for your Salesforce instance URL. \n For more information on the key-value pairs that must be included in \n your secret, depending on your authentication type, see \n Salesforce connection configuration.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "The endpoint information to connect to your Salesforce data source.
" - } - }, - "com.amazonaws.bedrockagent#SecretArn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9!/_+=.@-]{1,512}$" - } - }, - "com.amazonaws.bedrockagent#SeedUrl": { - "type": "structure", - "members": { - "url": { - "target": "com.amazonaws.bedrockagent#Url", - "traits": { - "smithy.api#documentation": "A seed or starting point URL.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The seed or starting point URL. \n You should be authorized to crawl the URL.
" - } - }, - "com.amazonaws.bedrockagent#SeedUrls": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagent#SeedUrl" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.bedrockagent#SemanticChunkingConfiguration": { - "type": "structure", - "members": { - "maxTokens": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "The maximum number of tokens that a chunk can contain.
", - "smithy.api#range": { - "min": 1 - }, - "smithy.api#required": {} - } - }, - "bufferSize": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "The buffer size.
", - "smithy.api#range": { - "min": 0, - "max": 1 - }, - "smithy.api#required": {} - } - }, - "breakpointPercentileThreshold": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "The dissimilarity threshold for splitting chunks.
", - "smithy.api#range": { - "min": 50, - "max": 99 - }, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Settings for semantic document chunking for a data source. Semantic chunking splits\n a document into into smaller documents based on groups of similar content derived from the text\n with natural language processing.
\nWith semantic chunking, each sentence is compared to the next to determine how similar they are.\n You specify a threshold in the form of a percentile, where adjacent sentences that are less similar than\n that percentage of sentence pairs are divided into separate chunks. For example, if you set the threshold to \n 90, then the 10 percent of sentence pairs that are least similar are split. So if you have 101 sentences,\n 100 sentence pairs are compared, and the 10 with the least similarity are split, creating 11 chunks. These\n chunks are further split if they exceed the max token size.
\nYou must also specify a buffer size, which determines whether sentences are compared in isolation, or\n within a moving context window that includes the previous and following sentence. For example, if you set\n the buffer size to 1
, the embedding for sentence 10 is derived from sentences 9, 10, and 11\n combined.
The Amazon Resource Name (ARN) of the KMS key used to encrypt the resource.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains the configuration for server-side encryption.
" - } - }, - "com.amazonaws.bedrockagent#ServiceQuotaExceededException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.bedrockagent#NonBlankString" - } - }, - "traits": { - "smithy.api#documentation": "The number of requests exceeds the service quota. Resubmit your request later.
", - "smithy.api#error": "client", - "smithy.api#httpError": 402 - } - }, - "com.amazonaws.bedrockagent#SessionTTL": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 60, - "max": 3600 - } - } - }, - "com.amazonaws.bedrockagent#SharePointAuthType": { - "type": "enum", - "members": { - "OAUTH2_CLIENT_CREDENTIALS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OAUTH2_CLIENT_CREDENTIALS" - } - } - } - }, - "com.amazonaws.bedrockagent#SharePointCrawlerConfiguration": { - "type": "structure", - "members": { - "filterConfiguration": { - "target": "com.amazonaws.bedrockagent#CrawlFilterConfiguration", - "traits": { - "smithy.api#documentation": "The configuration of filtering the SharePoint content. For example, \n configuring regular expression patterns to include or exclude certain content.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The configuration of the SharePoint content. For example, configuring \n specific types of SharePoint content.
" - } - }, - "com.amazonaws.bedrockagent#SharePointDataSourceConfiguration": { - "type": "structure", - "members": { - "sourceConfiguration": { - "target": "com.amazonaws.bedrockagent#SharePointSourceConfiguration", - "traits": { - "smithy.api#documentation": "The endpoint information to connect to your SharePoint data source.
", - "smithy.api#required": {} - } - }, - "crawlerConfiguration": { - "target": "com.amazonaws.bedrockagent#SharePointCrawlerConfiguration", - "traits": { - "smithy.api#documentation": "The configuration of the SharePoint content. For example, configuring \n specific types of SharePoint content.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The configuration information to connect to SharePoint as your data source.
" - } - }, - "com.amazonaws.bedrockagent#SharePointDomain": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.bedrockagent#SharePointHostType": { - "type": "enum", - "members": { - "ONLINE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ONLINE" - } - } - } - }, - "com.amazonaws.bedrockagent#SharePointSiteUrls": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagent#HttpsUrl" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.bedrockagent#SharePointSourceConfiguration": { - "type": "structure", - "members": { - "tenantId": { - "target": "com.amazonaws.bedrockagent#Microsoft365TenantId", - "traits": { - "smithy.api#documentation": "The identifier of your Microsoft 365 tenant.
" - } - }, - "domain": { - "target": "com.amazonaws.bedrockagent#SharePointDomain", - "traits": { - "smithy.api#documentation": "The domain of your SharePoint instance or site URL/URLs.
", - "smithy.api#required": {} - } - }, - "siteUrls": { - "target": "com.amazonaws.bedrockagent#SharePointSiteUrls", - "traits": { - "smithy.api#documentation": "A list of one or more SharePoint site URLs.
", - "smithy.api#required": {} - } - }, - "hostType": { - "target": "com.amazonaws.bedrockagent#SharePointHostType", - "traits": { - "smithy.api#documentation": "The supported host type, whether online/cloud or server/on-premises.
", - "smithy.api#required": {} - } - }, - "authType": { - "target": "com.amazonaws.bedrockagent#SharePointAuthType", - "traits": { - "smithy.api#documentation": "The supported authentication type to authenticate and connect \n to your SharePoint site/sites.
", - "smithy.api#required": {} - } - }, - "credentialsSecretArn": { - "target": "com.amazonaws.bedrockagent#SecretArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name of an Secrets Manager secret that \n stores your authentication credentials for your SharePoint site/sites. \n For more information on the key-value pairs that must be included in \n your secret, depending on your authentication type, see \n SharePoint connection configuration.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "The endpoint information to connect to your SharePoint data source.
" - } - }, - "com.amazonaws.bedrockagent#SortOrder": { - "type": "enum", - "members": { - "ASCENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ASCENDING" - } - }, - "DESCENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DESCENDING" - } - } - } - }, - "com.amazonaws.bedrockagent#StartIngestionJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#StartIngestionJobRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#StartIngestionJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#ConflictException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Begins an ingestion job, in which a data source is added to a knowledge base.
", - "smithy.api#http": { - "code": 202, - "method": "PUT", - "uri": "/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}/ingestionjobs/" - }, - "smithy.api#idempotent": {}, - "smithy.api#tags": [ - "console" - ] - } - }, - "com.amazonaws.bedrockagent#StartIngestionJobRequest": { - "type": "structure", - "members": { - "knowledgeBaseId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the knowledge base to which to add the data source.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "dataSourceId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the data source to ingest.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "clientToken": { - "target": "com.amazonaws.bedrockagent#ClientToken", - "traits": { - "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", - "smithy.api#idempotencyToken": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#Description", - "traits": { - "smithy.api#documentation": "A description of the ingestion job.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#StartIngestionJobResponse": { - "type": "structure", - "members": { - "ingestionJob": { - "target": "com.amazonaws.bedrockagent#IngestionJob", - "traits": { - "smithy.api#documentation": "An object containing information about the ingestion job.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#StepType": { - "type": "enum", - "members": { - "POST_CHUNKING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "POST_CHUNKING" - } - } - } - }, - "com.amazonaws.bedrockagent#StopSequences": { - "type": "list", - "member": { - "target": "smithy.api#String" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 4 - } - } - }, - "com.amazonaws.bedrockagent#StorageConfiguration": { - "type": "structure", - "members": { - "type": { - "target": "com.amazonaws.bedrockagent#KnowledgeBaseStorageType", - "traits": { - "smithy.api#documentation": "The vector store service in which the knowledge base is stored.
", - "smithy.api#required": {} - } - }, - "opensearchServerlessConfiguration": { - "target": "com.amazonaws.bedrockagent#OpenSearchServerlessConfiguration", - "traits": { - "smithy.api#documentation": "Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.
" - } - }, - "pineconeConfiguration": { - "target": "com.amazonaws.bedrockagent#PineconeConfiguration", - "traits": { - "smithy.api#documentation": "Contains the storage configuration of the knowledge base in Pinecone.
" - } - }, - "redisEnterpriseCloudConfiguration": { - "target": "com.amazonaws.bedrockagent#RedisEnterpriseCloudConfiguration", - "traits": { - "smithy.api#documentation": "Contains the storage configuration of the knowledge base in Redis Enterprise Cloud.
" - } - }, - "rdsConfiguration": { - "target": "com.amazonaws.bedrockagent#RdsConfiguration", - "traits": { - "smithy.api#documentation": "Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS.
" - } - }, - "mongoDbAtlasConfiguration": { - "target": "com.amazonaws.bedrockagent#MongoDbAtlasConfiguration", - "traits": { - "smithy.api#documentation": "Contains the storage configuration of the knowledge base in MongoDB Atlas.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains the storage configuration of the knowledge base.
" - } - }, - "com.amazonaws.bedrockagent#StorageDays": { - "type": "integer", - "traits": { - "smithy.api#default": 30, - "smithy.api#range": { - "min": 0, - "max": 30 - } - } - }, - "com.amazonaws.bedrockagent#StorageFlowNodeConfiguration": { - "type": "structure", - "members": { - "serviceConfiguration": { - "target": "com.amazonaws.bedrockagent#StorageFlowNodeServiceConfiguration", - "traits": { - "smithy.api#documentation": "Contains configurations for the service to use for storing the input into the node.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains configurations for a Storage node in a flow. This node stores the input in an Amazon S3 location that you specify.
" - } - }, - "com.amazonaws.bedrockagent#StorageFlowNodeS3Configuration": { - "type": "structure", - "members": { - "bucketName": { - "target": "com.amazonaws.bedrockagent#S3BucketName", - "traits": { - "smithy.api#documentation": "The name of the Amazon S3 bucket in which to store the input into the node.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains configurations for the Amazon S3 location in which to store the input into the node.
" - } - }, - "com.amazonaws.bedrockagent#StorageFlowNodeServiceConfiguration": { - "type": "union", - "members": { - "s3": { - "target": "com.amazonaws.bedrockagent#StorageFlowNodeS3Configuration", - "traits": { - "smithy.api#documentation": "Contains configurations for the Amazon S3 location in which to store the input into the node.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains configurations for the service to use for storing the input into the node.
" - } - }, - "com.amazonaws.bedrockagent#TagKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$" - } - }, - "com.amazonaws.bedrockagent#TagKeyList": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagent#TagKey" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 200 - } - } - }, - "com.amazonaws.bedrockagent#TagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#TagResourceRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#TagResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Associate tags with a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.
", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/tags/{resourceArn}" - } - } - }, - "com.amazonaws.bedrockagent#TagResourceRequest": { - "type": "structure", - "members": { - "resourceArn": { - "target": "com.amazonaws.bedrockagent#TaggableResourcesArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource to tag.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.bedrockagent#TagsMap", - "traits": { - "smithy.api#documentation": "An object containing key-value pairs that define the tags to attach to the resource.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#TagResourceResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#TagValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$" - } - }, - "com.amazonaws.bedrockagent#TaggableResourcesArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 1011 - }, - "smithy.api#pattern": "(^arn:aws:bedrock:[a-zA-Z0-9-]+:/d{12}:(agent|agent-alias|knowledge-base|flow|prompt)/[A-Z0-9]{10}(?:/[A-Z0-9]{10})?$|^arn:aws:bedrock:[a-zA-Z0-9-]+:/d{12}:flow/([A-Z0-9]{10})/alias/([A-Z0-9]{10})$|^arn:aws:bedrock:[a-zA-Z0-9-]+:/d{12}:prompt/([A-Z0-9]{10})?(?::/d+)?$)" - } - }, - "com.amazonaws.bedrockagent#TaggingResource": { - "type": "resource", - "operations": [ - { - "target": "com.amazonaws.bedrockagent#ListTagsForResource" - }, - { - "target": "com.amazonaws.bedrockagent#TagResource" - }, - { - "target": "com.amazonaws.bedrockagent#UntagResource" - } - ] - }, - "com.amazonaws.bedrockagent#TagsMap": { - "type": "map", - "key": { - "target": "com.amazonaws.bedrockagent#TagKey" - }, - "value": { - "target": "com.amazonaws.bedrockagent#TagValue" - } - }, - "com.amazonaws.bedrockagent#Temperature": { - "type": "float", - "traits": { - "smithy.api#range": { - "min": 0, - "max": 1 - } - } - }, - "com.amazonaws.bedrockagent#TextPrompt": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 200000 - }, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.bedrockagent#TextPromptTemplateConfiguration": { - "type": "structure", - "members": { - "text": { - "target": "com.amazonaws.bedrockagent#TextPrompt", - "traits": { - "smithy.api#documentation": "The message for the prompt.
", - "smithy.api#required": {} - } - }, - "inputVariables": { - "target": "com.amazonaws.bedrockagent#PromptInputVariablesList", - "traits": { - "smithy.api#documentation": "An array of the variables in the prompt template.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains configurations for a text prompt template. To include a variable, enclose a word in double curly braces as in {{variable}}
.
The number of requests exceeds the limit. Resubmit your request later.
", - "smithy.api#error": "client", - "smithy.api#httpError": 429 - } - }, - "com.amazonaws.bedrockagent#TopK": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0, - "max": 500 - } - } - }, - "com.amazonaws.bedrockagent#TopP": { - "type": "float", - "traits": { - "smithy.api#range": { - "min": 0, - "max": 1 - } - } - }, - "com.amazonaws.bedrockagent#Transformation": { - "type": "structure", - "members": { - "transformationFunction": { - "target": "com.amazonaws.bedrockagent#TransformationFunction", - "traits": { - "smithy.api#documentation": "A Lambda function that processes documents.
", - "smithy.api#required": {} - } - }, - "stepToApply": { - "target": "com.amazonaws.bedrockagent#StepType", - "traits": { - "smithy.api#documentation": "When the service applies the transformation.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A custom processing step for documents moving through a data source ingestion pipeline. To\n process documents after they have been converted into chunks, set the step to apply to\n POST_CHUNKING
.
The Lambda function.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A Lambda function that processes documents.
" - } - }, - "com.amazonaws.bedrockagent#TransformationLambdaConfiguration": { - "type": "structure", - "members": { - "lambdaArn": { - "target": "com.amazonaws.bedrockagent#LambdaArn", - "traits": { - "smithy.api#documentation": "The function's ARN identifier.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A Lambda function that processes documents.
" - } - }, - "com.amazonaws.bedrockagent#Transformations": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagent#Transformation" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - } - } - }, - "com.amazonaws.bedrockagent#Type": { - "type": "enum", - "members": { - "STRING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "string" - } - }, - "NUMBER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "number" - } - }, - "INTEGER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "integer" - } - }, - "BOOLEAN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "boolean" - } - }, - "ARRAY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "array" - } - } - } - }, - "com.amazonaws.bedrockagent#UntagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#UntagResourceRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#UntagResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Remove tags from a resource.
", - "smithy.api#http": { - "code": 200, - "method": "DELETE", - "uri": "/tags/{resourceArn}" - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.bedrockagent#UntagResourceRequest": { - "type": "structure", - "members": { - "resourceArn": { - "target": "com.amazonaws.bedrockagent#TaggableResourcesArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource from which to remove tags.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "tagKeys": { - "target": "com.amazonaws.bedrockagent#TagKeyList", - "traits": { - "smithy.api#documentation": "A list of keys of the tags to remove from the resource.
", - "smithy.api#httpQuery": "tagKeys", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#UntagResourceResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#UpdateAgent": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#UpdateAgentRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#UpdateAgentResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#ConflictException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Updates the configuration of an agent.
", - "smithy.api#http": { - "code": 202, - "method": "PUT", - "uri": "/agents/{agentId}/" - }, - "smithy.api#idempotent": {}, - "smithy.api#tags": [ - "console" - ] - } - }, - "com.amazonaws.bedrockagent#UpdateAgentActionGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#UpdateAgentActionGroupRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#UpdateAgentActionGroupResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#ConflictException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Updates the configuration for an action group for an agent.
", - "smithy.api#http": { - "code": 200, - "method": "PUT", - "uri": "/agents/{agentId}/agentversions/{agentVersion}/actiongroups/{actionGroupId}/" - }, - "smithy.api#idempotent": {}, - "smithy.api#tags": [ - "console" - ] - } - }, - "com.amazonaws.bedrockagent#UpdateAgentActionGroupRequest": { - "type": "structure", - "members": { - "agentId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the agent for which to update the action group.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "agentVersion": { - "target": "com.amazonaws.bedrockagent#DraftVersion", - "traits": { - "smithy.api#documentation": "The unique identifier of the agent version for which to update the action group.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "actionGroupId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the action group.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "actionGroupName": { - "target": "com.amazonaws.bedrockagent#Name", - "traits": { - "smithy.api#documentation": "Specifies a new name for the action group.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#Description", - "traits": { - "smithy.api#documentation": "Specifies a new name for the action group.
" - } - }, - "parentActionGroupSignature": { - "target": "com.amazonaws.bedrockagent#ActionGroupSignature", - "traits": { - "smithy.api#documentation": "To allow your agent to request the user for additional information when trying to complete a task, set this field to AMAZON.UserInput
. 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.
" - } - }, - "actionGroupExecutor": { - "target": "com.amazonaws.bedrockagent#ActionGroupExecutor", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.
" - } - }, - "actionGroupState": { - "target": "com.amazonaws.bedrockagent#ActionGroupState", - "traits": { - "smithy.api#documentation": "Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
" - } - }, - "apiSchema": { - "target": "com.amazonaws.bedrockagent#APISchema", - "traits": { - "smithy.api#documentation": "Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas.
" - } - }, - "functionSchema": { - "target": "com.amazonaws.bedrockagent#FunctionSchema", - "traits": { - "smithy.api#documentation": "Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#UpdateAgentActionGroupResponse": { - "type": "structure", - "members": { - "agentActionGroup": { - "target": "com.amazonaws.bedrockagent#AgentActionGroup", - "traits": { - "smithy.api#documentation": "Contains details about the action group that was updated.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#UpdateAgentAlias": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#UpdateAgentAliasRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#UpdateAgentAliasResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#ConflictException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Updates configurations for an alias of an agent.
", - "smithy.api#http": { - "code": 202, - "method": "PUT", - "uri": "/agents/{agentId}/agentaliases/{agentAliasId}/" - }, - "smithy.api#idempotent": {}, - "smithy.api#tags": [ - "console" - ] - } - }, - "com.amazonaws.bedrockagent#UpdateAgentAliasRequest": { - "type": "structure", - "members": { - "agentId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the agent.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "agentAliasId": { - "target": "com.amazonaws.bedrockagent#AgentAliasId", - "traits": { - "smithy.api#documentation": "The unique identifier of the alias.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "agentAliasName": { - "target": "com.amazonaws.bedrockagent#Name", - "traits": { - "smithy.api#documentation": "Specifies a new name for the alias.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#Description", - "traits": { - "smithy.api#documentation": "Specifies a new description for the alias.
" - } - }, - "routingConfiguration": { - "target": "com.amazonaws.bedrockagent#AgentAliasRoutingConfiguration", - "traits": { - "smithy.api#documentation": "Contains details about the routing configuration of the alias.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#UpdateAgentAliasResponse": { - "type": "structure", - "members": { - "agentAlias": { - "target": "com.amazonaws.bedrockagent#AgentAlias", - "traits": { - "smithy.api#documentation": "Contains details about the alias that was updated.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#UpdateAgentKnowledgeBase": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#UpdateAgentKnowledgeBaseRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#UpdateAgentKnowledgeBaseResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#ConflictException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Updates the configuration for a knowledge base that has been associated with an agent.
", - "smithy.api#http": { - "code": 200, - "method": "PUT", - "uri": "/agents/{agentId}/agentversions/{agentVersion}/knowledgebases/{knowledgeBaseId}/" - }, - "smithy.api#idempotent": {}, - "smithy.api#tags": [ - "console" - ] - } - }, - "com.amazonaws.bedrockagent#UpdateAgentKnowledgeBaseRequest": { - "type": "structure", - "members": { - "agentId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the agent associated with the knowledge base that you want to update.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "agentVersion": { - "target": "com.amazonaws.bedrockagent#DraftVersion", - "traits": { - "smithy.api#documentation": "The version of the agent associated with the knowledge base that you want to update.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "knowledgeBaseId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the knowledge base that has been associated with an agent.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#Description", - "traits": { - "smithy.api#documentation": "Specifies a new description for the knowledge base associated with an agent.
" - } - }, - "knowledgeBaseState": { - "target": "com.amazonaws.bedrockagent#KnowledgeBaseState", - "traits": { - "smithy.api#documentation": "Specifies whether the agent uses the knowledge base or not when sending an InvokeAgent request.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#UpdateAgentKnowledgeBaseResponse": { - "type": "structure", - "members": { - "agentKnowledgeBase": { - "target": "com.amazonaws.bedrockagent#AgentKnowledgeBase", - "traits": { - "smithy.api#documentation": "Contains details about the knowledge base that has been associated with an agent.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#UpdateAgentRequest": { - "type": "structure", - "members": { - "agentId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the agent.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "agentName": { - "target": "com.amazonaws.bedrockagent#Name", - "traits": { - "smithy.api#documentation": "Specifies a new name for the agent.
", - "smithy.api#required": {} - } - }, - "instruction": { - "target": "com.amazonaws.bedrockagent#Instruction", - "traits": { - "smithy.api#documentation": "Specifies new instructions that tell the agent what it should do and how it should interact with users.
" - } - }, - "foundationModel": { - "target": "com.amazonaws.bedrockagent#ModelIdentifier", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Specifies a new foundation model to be used for orchestration by the agent.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#Description", - "traits": { - "smithy.api#documentation": "Specifies a new description of the agent.
" - } - }, - "idleSessionTTLInSeconds": { - "target": "com.amazonaws.bedrockagent#SessionTTL", - "traits": { - "smithy.api#documentation": "The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.
\nA user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.
" - } - }, - "agentResourceRoleArn": { - "target": "com.amazonaws.bedrockagent#AgentRoleArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
", - "smithy.api#required": {} - } - }, - "customerEncryptionKeyArn": { - "target": "com.amazonaws.bedrockagent#KmsKeyArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.
" - } - }, - "promptOverrideConfiguration": { - "target": "com.amazonaws.bedrockagent#PromptOverrideConfiguration", - "traits": { - "smithy.api#documentation": "Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.
" - } - }, - "guardrailConfiguration": { - "target": "com.amazonaws.bedrockagent#GuardrailConfiguration", - "traits": { - "smithy.api#documentation": "The unique Guardrail configuration assigned to the agent when it is updated.
" - } - }, - "memoryConfiguration": { - "target": "com.amazonaws.bedrockagent#MemoryConfiguration", - "traits": { - "smithy.api#documentation": "Specifies the new memory configuration for the agent.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#UpdateAgentResponse": { - "type": "structure", - "members": { - "agent": { - "target": "com.amazonaws.bedrockagent#Agent", - "traits": { - "smithy.api#documentation": "Contains details about the agent that was updated.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#UpdateDataSource": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#UpdateDataSourceRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#UpdateDataSourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#ConflictException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Updates the configurations for a data source connector.
\nYou can't change the chunkingConfiguration
after you create the data source connector. Specify the existing chunkingConfiguration
.
The unique identifier of the knowledge base for the data source.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "dataSourceId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the data source.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "name": { - "target": "com.amazonaws.bedrockagent#Name", - "traits": { - "smithy.api#documentation": "Specifies a new name for the data source.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#Description", - "traits": { - "smithy.api#documentation": "Specifies a new description for the data source.
" - } - }, - "dataSourceConfiguration": { - "target": "com.amazonaws.bedrockagent#DataSourceConfiguration", - "traits": { - "smithy.api#documentation": "The connection configuration for the data source that you want to update.
", - "smithy.api#required": {} - } - }, - "dataDeletionPolicy": { - "target": "com.amazonaws.bedrockagent#DataDeletionPolicy", - "traits": { - "smithy.api#documentation": "The data deletion policy for the data source that you want to update.
" - } - }, - "serverSideEncryptionConfiguration": { - "target": "com.amazonaws.bedrockagent#ServerSideEncryptionConfiguration", - "traits": { - "smithy.api#documentation": "Contains details about server-side encryption of the data source.
" - } - }, - "vectorIngestionConfiguration": { - "target": "com.amazonaws.bedrockagent#VectorIngestionConfiguration", - "traits": { - "smithy.api#documentation": "Contains details about how to ingest the documents in the data source.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#UpdateDataSourceResponse": { - "type": "structure", - "members": { - "dataSource": { - "target": "com.amazonaws.bedrockagent#DataSource", - "traits": { - "smithy.api#documentation": "Contains details about the data source.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#UpdateFlow": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#UpdateFlowRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#UpdateFlowResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#ConflictException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Modifies a flow. Include both fields that you want to keep and fields that you want to change. For more information, see How it works and Create a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
", - "smithy.api#http": { - "code": 200, - "method": "PUT", - "uri": "/flows/{flowIdentifier}/" - }, - "smithy.api#idempotent": {}, - "smithy.api#tags": [ - "console" - ] - } - }, - "com.amazonaws.bedrockagent#UpdateFlowAlias": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#UpdateFlowAliasRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#UpdateFlowAliasResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#ConflictException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Modifies the alias of a flow. Include both fields that you want to keep and ones that you want to change. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
", - "smithy.api#http": { - "code": 200, - "method": "PUT", - "uri": "/flows/{flowIdentifier}/aliases/{aliasIdentifier}" - }, - "smithy.api#idempotent": {}, - "smithy.api#tags": [ - "console" - ] - } - }, - "com.amazonaws.bedrockagent#UpdateFlowAliasRequest": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.bedrockagent#Name", - "traits": { - "smithy.api#documentation": "The name of the alias.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#Description", - "traits": { - "smithy.api#documentation": "A description for the alias.
" - } - }, - "routingConfiguration": { - "target": "com.amazonaws.bedrockagent#FlowAliasRoutingConfiguration", - "traits": { - "smithy.api#documentation": "Contains information about the version to which to map the alias.
", - "smithy.api#required": {} - } - }, - "flowIdentifier": { - "target": "com.amazonaws.bedrockagent#FlowIdentifier", - "traits": { - "smithy.api#documentation": "The unique identifier of the flow.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "aliasIdentifier": { - "target": "com.amazonaws.bedrockagent#FlowAliasIdentifier", - "traits": { - "smithy.api#documentation": "The unique identifier of the alias.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#UpdateFlowAliasResponse": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.bedrockagent#Name", - "traits": { - "smithy.api#documentation": "The name of the alias.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#Description", - "traits": { - "smithy.api#documentation": "The description of the flow.
" - } - }, - "routingConfiguration": { - "target": "com.amazonaws.bedrockagent#FlowAliasRoutingConfiguration", - "traits": { - "smithy.api#documentation": "Contains information about the version that the alias is mapped to.
", - "smithy.api#required": {} - } - }, - "flowId": { - "target": "com.amazonaws.bedrockagent#FlowId", - "traits": { - "smithy.api#documentation": "The unique identifier of the flow.
", - "smithy.api#required": {} - } - }, - "id": { - "target": "com.amazonaws.bedrockagent#FlowAliasId", - "traits": { - "smithy.api#documentation": "The unique identifier of the alias.
", - "smithy.api#required": {} - } - }, - "arn": { - "target": "com.amazonaws.bedrockagent#FlowAliasArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the flow.
", - "smithy.api#required": {} - } - }, - "createdAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the flow was created.
", - "smithy.api#required": {} - } - }, - "updatedAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the alias was last updated.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#UpdateFlowRequest": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.bedrockagent#FlowName", - "traits": { - "smithy.api#documentation": "A name for the flow.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#FlowDescription", - "traits": { - "smithy.api#documentation": "A description for the flow.
" - } - }, - "executionRoleArn": { - "target": "com.amazonaws.bedrockagent#FlowExecutionRoleArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service role with permissions to create and manage a flow. For more information, see Create a service role for flows in Amazon Bedrock in the Amazon Bedrock User Guide.
", - "smithy.api#required": {} - } - }, - "customerEncryptionKeyArn": { - "target": "com.amazonaws.bedrockagent#KmsKeyArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key to encrypt the flow.
" - } - }, - "definition": { - "target": "com.amazonaws.bedrockagent#FlowDefinition", - "traits": { - "smithy.api#documentation": "A definition of the nodes and the connections between the nodes in the flow.
" - } - }, - "flowIdentifier": { - "target": "com.amazonaws.bedrockagent#FlowIdentifier", - "traits": { - "smithy.api#documentation": "The unique identifier of the flow.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#UpdateFlowResponse": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.bedrockagent#FlowName", - "traits": { - "smithy.api#documentation": "The name of the flow.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#FlowDescription", - "traits": { - "smithy.api#documentation": "The description of the flow.
" - } - }, - "executionRoleArn": { - "target": "com.amazonaws.bedrockagent#FlowExecutionRoleArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service role with permissions to create a flow. For more information, see Create a service role for flows in Amazon Bedrock in the Amazon Bedrock User Guide.
", - "smithy.api#required": {} - } - }, - "customerEncryptionKeyArn": { - "target": "com.amazonaws.bedrockagent#KmsKeyArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key that the flow was encrypted with.
" - } - }, - "id": { - "target": "com.amazonaws.bedrockagent#FlowId", - "traits": { - "smithy.api#documentation": "The unique identifier of the flow.
", - "smithy.api#required": {} - } - }, - "arn": { - "target": "com.amazonaws.bedrockagent#FlowArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the flow.
", - "smithy.api#required": {} - } - }, - "status": { - "target": "com.amazonaws.bedrockagent#FlowStatus", - "traits": { - "smithy.api#documentation": "The status of the flow. When you submit this request, the status will be NotPrepared
. If updating fails, the status becomes Failed
.
The time at which the flow was created.
", - "smithy.api#required": {} - } - }, - "updatedAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the flow was last updated.
", - "smithy.api#required": {} - } - }, - "version": { - "target": "com.amazonaws.bedrockagent#DraftVersion", - "traits": { - "smithy.api#documentation": "The version of the flow. When you update a flow, the version updated is the DRAFT
version.
A definition of the nodes and the connections between nodes in the flow.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#UpdateKnowledgeBase": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#UpdateKnowledgeBaseRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#UpdateKnowledgeBaseResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#ConflictException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Updates the configuration of a knowledge base with the fields that you specify. Because all fields will be overwritten, you must include the same values for fields that you want to keep the same.
\nYou can change the following fields:
\n\n name
\n
\n description
\n
\n roleArn
\n
You can't change the knowledgeBaseConfiguration
or storageConfiguration
fields, so you must specify the same configurations as when you created the knowledge base. You can send a GetKnowledgeBase request and copy the same configurations.
The unique identifier of the knowledge base to update.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "name": { - "target": "com.amazonaws.bedrockagent#Name", - "traits": { - "smithy.api#documentation": "Specifies a new name for the knowledge base.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#Description", - "traits": { - "smithy.api#documentation": "Specifies a new description for the knowledge base.
" - } - }, - "roleArn": { - "target": "com.amazonaws.bedrockagent#KnowledgeBaseRoleArn", - "traits": { - "smithy.api#documentation": "Specifies a different Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
", - "smithy.api#required": {} - } - }, - "knowledgeBaseConfiguration": { - "target": "com.amazonaws.bedrockagent#KnowledgeBaseConfiguration", - "traits": { - "smithy.api#documentation": "Specifies the configuration for the embeddings model used for the knowledge base. You must use the same configuration as when the knowledge base was created.
", - "smithy.api#required": {} - } - }, - "storageConfiguration": { - "target": "com.amazonaws.bedrockagent#StorageConfiguration", - "traits": { - "smithy.api#documentation": "Specifies the configuration for the vector store used for the knowledge base. You must use the same configuration as when the knowledge base was created.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#UpdateKnowledgeBaseResponse": { - "type": "structure", - "members": { - "knowledgeBase": { - "target": "com.amazonaws.bedrockagent#KnowledgeBase", - "traits": { - "smithy.api#documentation": "Contains details about the knowledge base.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#UpdatePrompt": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#UpdatePromptRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#UpdatePromptResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#ConflictException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Modifies a prompt in your prompt library. Include both fields that you want to keep and fields that you want to replace. For more information, see Prompt management in Amazon Bedrock and Edit prompts in your prompt library in the Amazon Bedrock User Guide.
", - "smithy.api#http": { - "code": 200, - "method": "PUT", - "uri": "/prompts/{promptIdentifier}/" - }, - "smithy.api#idempotent": {}, - "smithy.api#tags": [ - "console" - ] - } - }, - "com.amazonaws.bedrockagent#UpdatePromptRequest": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.bedrockagent#PromptName", - "traits": { - "smithy.api#documentation": "A name for the prompt.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#PromptDescription", - "traits": { - "smithy.api#documentation": "A description for the prompt.
" - } - }, - "customerEncryptionKeyArn": { - "target": "com.amazonaws.bedrockagent#KmsKeyArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key to encrypt the prompt.
" - } - }, - "defaultVariant": { - "target": "com.amazonaws.bedrockagent#PromptVariantName", - "traits": { - "smithy.api#documentation": "The name of the default variant for the prompt. This value must match the name
field in the relevant PromptVariant object.
A list of objects, each containing details about a variant of the prompt.
" - } - }, - "promptIdentifier": { - "target": "com.amazonaws.bedrockagent#PromptIdentifier", - "traits": { - "smithy.api#documentation": "The unique identifier of the prompt.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#UpdatePromptResponse": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.bedrockagent#PromptName", - "traits": { - "smithy.api#documentation": "The name of the prompt.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrockagent#PromptDescription", - "traits": { - "smithy.api#documentation": "The description of the prompt.
" - } - }, - "customerEncryptionKeyArn": { - "target": "com.amazonaws.bedrockagent#KmsKeyArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key to encrypt the prompt.
" - } - }, - "defaultVariant": { - "target": "com.amazonaws.bedrockagent#PromptVariantName", - "traits": { - "smithy.api#documentation": "The name of the default variant for the prompt. This value must match the name
field in the relevant PromptVariant object.
A list of objects, each containing details about a variant of the prompt.
" - } - }, - "id": { - "target": "com.amazonaws.bedrockagent#PromptId", - "traits": { - "smithy.api#documentation": "The unique identifier of the prompt.
", - "smithy.api#required": {} - } - }, - "arn": { - "target": "com.amazonaws.bedrockagent#PromptArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the prompt.
", - "smithy.api#required": {} - } - }, - "version": { - "target": "com.amazonaws.bedrockagent#Version", - "traits": { - "smithy.api#documentation": "The version of the prompt. When you update a prompt, the version updated is the DRAFT
version.
The time at which the prompt was created.
", - "smithy.api#required": {} - } - }, - "updatedAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", - "traits": { - "smithy.api#documentation": "The time at which the prompt was last updated.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#Url": { - "type": "string", - "traits": { - "smithy.api#pattern": "^https?://[A-Za-z0-9][^\\s]*$" - } - }, - "com.amazonaws.bedrockagent#UrlConfiguration": { - "type": "structure", - "members": { - "seedUrls": { - "target": "com.amazonaws.bedrockagent#SeedUrls", - "traits": { - "smithy.api#documentation": "One or more seed or starting point URLs.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The configuration of web URLs that you want to crawl. \n You should be authorized to crawl the URLs.
" - } - }, - "com.amazonaws.bedrockagent#ValidationException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.bedrockagent#NonBlankString" - }, - "fieldList": { - "target": "com.amazonaws.bedrockagent#ValidationExceptionFieldList", - "traits": { - "smithy.api#documentation": "A list of objects containing fields that caused validation errors and their corresponding validation error messages.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Input validation failed. Check your request parameters and retry the request.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.bedrockagent#ValidationExceptionField": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.bedrockagent#NonBlankString", - "traits": { - "smithy.api#documentation": "The name of the field.
", - "smithy.api#required": {} - } - }, - "message": { - "target": "com.amazonaws.bedrockagent#NonBlankString", - "traits": { - "smithy.api#documentation": "A message describing why this field failed validation.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Stores information about a field passed inside a request that resulted in an validation error.
" - } - }, - "com.amazonaws.bedrockagent#ValidationExceptionFieldList": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagent#ValidationExceptionField" - } - }, - "com.amazonaws.bedrockagent#VectorIngestionConfiguration": { - "type": "structure", - "members": { - "chunkingConfiguration": { - "target": "com.amazonaws.bedrockagent#ChunkingConfiguration", - "traits": { - "smithy.api#documentation": "Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.
" - } - }, - "customTransformationConfiguration": { - "target": "com.amazonaws.bedrockagent#CustomTransformationConfiguration", - "traits": { - "smithy.api#documentation": "A custom document transformer for parsed data source documents.
" - } - }, - "parsingConfiguration": { - "target": "com.amazonaws.bedrockagent#ParsingConfiguration", - "traits": { - "smithy.api#documentation": "A custom parser for data source documents.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains details about how to ingest the documents in a data source.
" - } - }, - "com.amazonaws.bedrockagent#VectorKnowledgeBaseConfiguration": { - "type": "structure", - "members": { - "embeddingModelArn": { - "target": "com.amazonaws.bedrockagent#BedrockEmbeddingModelArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model used to create vector embeddings for the knowledge base.
", - "smithy.api#required": {} - } - }, - "embeddingModelConfiguration": { - "target": "com.amazonaws.bedrockagent#EmbeddingModelConfiguration", - "traits": { - "smithy.api#documentation": "The embeddings model configuration details for the vector model used in Knowledge Base.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains details about the model used to create vector embeddings for the knowledge base.
" - } - }, - "com.amazonaws.bedrockagent#Version": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 5 - }, - "smithy.api#pattern": "^(DRAFT|[0-9]{0,4}[1-9][0-9]{0,4})$" - } - }, - "com.amazonaws.bedrockagent#VersionResource": { - "type": "resource", - "operations": [ - { - "target": "com.amazonaws.bedrockagent#DeleteAgentVersion" - }, - { - "target": "com.amazonaws.bedrockagent#GetAgentVersion" - }, - { - "target": "com.amazonaws.bedrockagent#ListAgentVersions" - } - ] - }, - "com.amazonaws.bedrockagent#WebCrawlerConfiguration": { - "type": "structure", - "members": { - "crawlerLimits": { - "target": "com.amazonaws.bedrockagent#WebCrawlerLimits", - "traits": { - "smithy.api#documentation": "The configuration of crawl limits for the web URLs.
" - } - }, - "inclusionFilters": { - "target": "com.amazonaws.bedrockagent#FilterList", - "traits": { - "smithy.api#documentation": "A list of one or more inclusion regular expression patterns to include \n certain URLs. If you specify an inclusion and exclusion filter/pattern \n and both match a URL, the exclusion filter takes precedence and the web \n content of the URL isn’t crawled.
" - } - }, - "exclusionFilters": { - "target": "com.amazonaws.bedrockagent#FilterList", - "traits": { - "smithy.api#documentation": "A list of one or more exclusion regular expression patterns to exclude \n certain URLs. If you specify an inclusion and exclusion filter/pattern \n and both match a URL, the exclusion filter takes precedence and the web \n content of the URL isn’t crawled.
" - } - }, - "scope": { - "target": "com.amazonaws.bedrockagent#WebScopeType", - "traits": { - "smithy.api#documentation": "The scope of what is crawled for your URLs.
\nYou can choose to crawl only web pages that belong to the same host or primary \n domain. For example, only web pages that contain the seed URL \n \"https://docs.aws.amazon.com/bedrock/latest/userguide/\" and no other domains. \n You can choose to include sub domains in addition to the host or primary domain. \n For example, web pages that contain \"aws.amazon.com\" can also include sub domain \n \"docs.aws.amazon.com\".
" - } - } - }, - "traits": { - "smithy.api#documentation": "The configuration of web URLs that you want to crawl. \n You should be authorized to crawl the URLs.
" - } - }, - "com.amazonaws.bedrockagent#WebCrawlerLimits": { - "type": "structure", - "members": { - "rateLimit": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "The max rate at which pages are crawled, up to 300 per minute per host.
", - "smithy.api#range": { - "min": 1, - "max": 300 - } - } - } - }, - "traits": { - "smithy.api#documentation": "The rate limits for the URLs that you want to crawl. \n You should be authorized to crawl the URLs.
" - } - }, - "com.amazonaws.bedrockagent#WebDataSourceConfiguration": { - "type": "structure", - "members": { - "sourceConfiguration": { - "target": "com.amazonaws.bedrockagent#WebSourceConfiguration", - "traits": { - "smithy.api#documentation": "The source configuration details for the web data source.
", - "smithy.api#required": {} - } - }, - "crawlerConfiguration": { - "target": "com.amazonaws.bedrockagent#WebCrawlerConfiguration", - "traits": { - "smithy.api#documentation": "The Web Crawler configuration details for the web data source.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The configuration details for the web data source.
" - } - }, - "com.amazonaws.bedrockagent#WebScopeType": { - "type": "enum", - "members": { - "HOST_ONLY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HOST_ONLY" - } - }, - "SUBDOMAINS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUBDOMAINS" - } - } - } - }, - "com.amazonaws.bedrockagent#WebSourceConfiguration": { - "type": "structure", - "members": { - "urlConfiguration": { - "target": "com.amazonaws.bedrockagent#UrlConfiguration", - "traits": { - "smithy.api#documentation": "The configuration of the URL/URLs.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "The configuration of the URL/URLs for the web content that you want \n to crawl. You should be authorized to crawl the URLs.
" - } + { + "target": "com.amazonaws.bedrockagent#FlowVersionResource" + } + ], + "traits": { + "aws.cloudformation#cfnResource": { + "name": "Flow" + } + } + }, + "com.amazonaws.bedrockagent#FlowStatus": { + "type": "enum", + "members": { + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "PREPARED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Prepared" + } + }, + "PREPARING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Preparing" + } + }, + "NOT_PREPARED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NotPrepared" + } + } + } + }, + "com.amazonaws.bedrockagent#FlowSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#FlowSummary" + }, + "traits": { + "smithy.api#length": { + "max": 10 + } + } + }, + "com.amazonaws.bedrockagent#FlowSummary": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#FlowName", + "traits": { + "smithy.api#documentation": "The name of the flow.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#FlowDescription", + "traits": { + "smithy.api#documentation": "A description of the flow.
" + } + }, + "id": { + "target": "com.amazonaws.bedrockagent#FlowId", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.bedrockagent#FlowArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the flow.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagent#FlowStatus", + "traits": { + "smithy.api#documentation": "The status of the flow. The following statuses are possible:
\nNotPrepared – The flow has been created or updated, but hasn't been prepared. If you just created the flow, you can't test it. If you updated the flow, the DRAFT
version won't contain the latest changes for testing. Send a PrepareFlow request to package the latest changes into the DRAFT
version.
Preparing – The flow is being prepared so that the DRAFT
version contains the latest changes for testing.
Prepared – The flow is prepared and the DRAFT
version contains the latest changes for testing.
Failed – The last API operation that you invoked on the flow failed. Send a GetFlow request and check the error message in the validations
field.
The time at which the flow was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the flow was last updated.
", + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.bedrockagent#DraftVersion", + "traits": { + "smithy.api#documentation": "The latest version of the flow.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the definition of a flow.
" + } + }, + "com.amazonaws.bedrockagent#FlowValidation": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrockagent#NonBlankString", + "traits": { + "smithy.api#documentation": "A message describing the validation error.
", + "smithy.api#required": {} + } + }, + "severity": { + "target": "com.amazonaws.bedrockagent#FlowValidationSeverity", + "traits": { + "smithy.api#documentation": "The severity of the issue described in the message.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about validation of the flow.
\nThis data type is used in the following API operations:
\n\n GetFlow response\n
\nThe unique identifier of the flow.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.bedrockagent#FlowArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the flow that the version belongs to.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagent#FlowStatus", + "traits": { + "smithy.api#documentation": "The status of the flow.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at the version was created.
", + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.bedrockagent#NumericalVersion", + "traits": { + "smithy.api#documentation": "The version of the flow.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a version of a flow.
\nThis data type is used in the following API operations:
\nA name for the function.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#FunctionDescription", + "traits": { + "smithy.api#documentation": "A description of the function and its purpose.
" + } + }, + "parameters": { + "target": "com.amazonaws.bedrockagent#ParameterMap", + "traits": { + "smithy.api#documentation": "The parameters that the agent elicits from the user to fulfill the function.
" + } + }, + "requireConfirmation": { + "target": "com.amazonaws.bedrockagent#RequireConfirmation", + "traits": { + "smithy.api#documentation": "Contains information if user confirmation is required to invoke the function.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Defines parameters that the agent needs to invoke from the user to complete the function. Corresponds to an action in an action group.
\nThis data type is used in the following API operations:
\nA list of functions that each define an action in the action group.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Defines functions that each define parameters that the agent needs to invoke from the user. Each function represents an action in an action group.
\nThis data type is used in the following API operations:
\nGets information about an agent.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/agents/{agentId}/" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": ["console"] + } + }, + "com.amazonaws.bedrockagent#GetAgentActionGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#GetAgentActionGroupRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#GetAgentActionGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets information about an action group for an agent.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/agents/{agentId}/agentversions/{agentVersion}/actiongroups/{actionGroupId}/" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": ["console"] + } + }, + "com.amazonaws.bedrockagent#GetAgentActionGroupRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent that the action group belongs to.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#Version", + "traits": { + "smithy.api#documentation": "The version of the agent that the action group belongs to.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "actionGroupId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the action group for which to get information.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#GetAgentActionGroupResponse": { + "type": "structure", + "members": { + "agentActionGroup": { + "target": "com.amazonaws.bedrockagent#AgentActionGroup", + "traits": { + "smithy.api#documentation": "Contains details about the action group.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#GetAgentAlias": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#GetAgentAliasRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#GetAgentAliasResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets information about an alias of an agent.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/agents/{agentId}/agentaliases/{agentAliasId}/" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": ["console"] + } + }, + "com.amazonaws.bedrockagent#GetAgentAliasRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent to which the alias to get information belongs.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentAliasId": { + "target": "com.amazonaws.bedrockagent#AgentAliasId", + "traits": { + "smithy.api#documentation": "The unique identifier of the alias for which to get information.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#GetAgentAliasResponse": { + "type": "structure", + "members": { + "agentAlias": { + "target": "com.amazonaws.bedrockagent#AgentAlias", + "traits": { + "smithy.api#documentation": "Contains information about the alias.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#GetAgentKnowledgeBase": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#GetAgentKnowledgeBaseRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#GetAgentKnowledgeBaseResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets information about a knowledge base associated with an agent.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/agents/{agentId}/agentversions/{agentVersion}/knowledgebases/{knowledgeBaseId}/" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": ["console"] + } + }, + "com.amazonaws.bedrockagent#GetAgentKnowledgeBaseRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent with which the knowledge base is associated.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#Version", + "traits": { + "smithy.api#documentation": "The version of the agent with which the knowledge base is associated.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base associated with the agent.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#GetAgentKnowledgeBaseResponse": { + "type": "structure", + "members": { + "agentKnowledgeBase": { + "target": "com.amazonaws.bedrockagent#AgentKnowledgeBase", + "traits": { + "smithy.api#documentation": "Contains details about a knowledge base attached to an agent.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#GetAgentRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#GetAgentResponse": { + "type": "structure", + "members": { + "agent": { + "target": "com.amazonaws.bedrockagent#Agent", + "traits": { + "smithy.api#documentation": "Contains details about the agent.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#GetAgentVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#GetAgentVersionRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#GetAgentVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets details about a version of an agent.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/agents/{agentId}/agentversions/{agentVersion}/" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": ["console"] + } + }, + "com.amazonaws.bedrockagent#GetAgentVersionRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#NumericalVersion", + "traits": { + "smithy.api#documentation": "The version of the agent.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#GetAgentVersionResponse": { + "type": "structure", + "members": { + "agentVersion": { + "target": "com.amazonaws.bedrockagent#AgentVersion", + "traits": { + "smithy.api#documentation": "Contains details about the version of the agent.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#GetDataSource": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#GetDataSourceRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#GetDataSourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets information about a data source.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": ["console"] + } + }, + "com.amazonaws.bedrockagent#GetDataSourceRequest": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base that the data source was added to.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "dataSourceId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the data source.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#GetDataSourceResponse": { + "type": "structure", + "members": { + "dataSource": { + "target": "com.amazonaws.bedrockagent#DataSource", + "traits": { + "smithy.api#documentation": "Contains details about the data source.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#GetFlow": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#GetFlowRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#GetFlowResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves information about a flow. For more information, see Manage a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/flows/{flowIdentifier}/" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": ["console"] + } + }, + "com.amazonaws.bedrockagent#GetFlowAlias": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#GetFlowAliasRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#GetFlowAliasResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves information about a flow. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/flows/{flowIdentifier}/aliases/{aliasIdentifier}" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": ["console"] + } + }, + "com.amazonaws.bedrockagent#GetFlowAliasRequest": { + "type": "structure", + "members": { + "flowIdentifier": { + "target": "com.amazonaws.bedrockagent#FlowIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow that the alias belongs to.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "aliasIdentifier": { + "target": "com.amazonaws.bedrockagent#FlowAliasIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the alias for which to retrieve information.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#GetFlowAliasResponse": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "The name of the alias.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "The description of the flow.
" + } + }, + "routingConfiguration": { + "target": "com.amazonaws.bedrockagent#FlowAliasRoutingConfiguration", + "traits": { + "smithy.api#documentation": "Contains information about the version that the alias is mapped to.
", + "smithy.api#required": {} + } + }, + "flowId": { + "target": "com.amazonaws.bedrockagent#FlowId", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow that the alias belongs to.
", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.bedrockagent#FlowAliasId", + "traits": { + "smithy.api#documentation": "The unique identifier of the alias of the flow.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.bedrockagent#FlowAliasArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the flow.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the flow was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the alias was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#GetFlowRequest": { + "type": "structure", + "members": { + "flowIdentifier": { + "target": "com.amazonaws.bedrockagent#FlowIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#GetFlowResponse": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#FlowName", + "traits": { + "smithy.api#documentation": "The name of the flow.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#FlowDescription", + "traits": { + "smithy.api#documentation": "The description of the flow.
" + } + }, + "executionRoleArn": { + "target": "com.amazonaws.bedrockagent#FlowExecutionRoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service role with permissions to create a flow. For more information, see Create a service row for flows in the Amazon Bedrock User Guide.
", + "smithy.api#required": {} + } + }, + "customerEncryptionKeyArn": { + "target": "com.amazonaws.bedrockagent#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key that the flow is encrypted with.
" + } + }, + "id": { + "target": "com.amazonaws.bedrockagent#FlowId", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.bedrockagent#FlowArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the flow.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagent#FlowStatus", + "traits": { + "smithy.api#documentation": "The status of the flow. The following statuses are possible:
\nNotPrepared – The flow has been created or updated, but hasn't been prepared. If you just created the flow, you can't test it. If you updated the flow, the DRAFT
version won't contain the latest changes for testing. Send a PrepareFlow request to package the latest changes into the DRAFT
version.
Preparing – The flow is being prepared so that the DRAFT
version contains the latest changes for testing.
Prepared – The flow is prepared and the DRAFT
version contains the latest changes for testing.
Failed – The last API operation that you invoked on the flow failed. Send a GetFlow request and check the error message in the validations
field.
The time at which the flow was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the flow was last updated.
", + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.bedrockagent#DraftVersion", + "traits": { + "smithy.api#documentation": "The version of the flow for which information was retrieved.
", + "smithy.api#required": {} + } + }, + "definition": { + "target": "com.amazonaws.bedrockagent#FlowDefinition", + "traits": { + "smithy.api#documentation": "The definition of the nodes and connections between the nodes in the flow.
" + } + }, + "validations": { + "target": "com.amazonaws.bedrockagent#FlowValidations", + "traits": { + "smithy.api#documentation": "A list of validation error messages related to the last failed operation on the flow.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#GetFlowVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#GetFlowVersionRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#GetFlowVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves information about a version of a flow. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/flows/{flowIdentifier}/versions/{flowVersion}/" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": ["console"] + } + }, + "com.amazonaws.bedrockagent#GetFlowVersionRequest": { + "type": "structure", + "members": { + "flowIdentifier": { + "target": "com.amazonaws.bedrockagent#FlowIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow for which to get information.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "flowVersion": { + "target": "com.amazonaws.bedrockagent#NumericalVersion", + "traits": { + "smithy.api#documentation": "The version of the flow for which to get information.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#GetFlowVersionResponse": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#FlowName", + "traits": { + "smithy.api#documentation": "The name of the version.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#FlowDescription", + "traits": { + "smithy.api#documentation": "The description of the flow.
" + } + }, + "executionRoleArn": { + "target": "com.amazonaws.bedrockagent#FlowExecutionRoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service role with permissions to create a flow. For more information, see Create a service role for flows in Amazon Bedrock in the Amazon Bedrock User Guide.
", + "smithy.api#required": {} + } + }, + "customerEncryptionKeyArn": { + "target": "com.amazonaws.bedrockagent#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key that the version of the flow is encrypted with.
" + } + }, + "id": { + "target": "com.amazonaws.bedrockagent#FlowId", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.bedrockagent#FlowArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the flow.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagent#FlowStatus", + "traits": { + "smithy.api#documentation": "The status of the flow.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the flow was created.
", + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.bedrockagent#NumericalVersion", + "traits": { + "smithy.api#documentation": "The version of the flow for which information was retrieved.
", + "smithy.api#required": {} + } + }, + "definition": { + "target": "com.amazonaws.bedrockagent#FlowDefinition", + "traits": { + "smithy.api#documentation": "The definition of the nodes and connections between nodes in the flow.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#GetIngestionJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#GetIngestionJobRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#GetIngestionJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets information about a ingestion job, in which a data source is added to a knowledge base.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}/ingestionjobs/{ingestionJobId}" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": ["console"] + } + }, + "com.amazonaws.bedrockagent#GetIngestionJobRequest": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base for which the ingestion job applies.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "dataSourceId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the data source in the ingestion job.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ingestionJobId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the ingestion job.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#GetIngestionJobResponse": { + "type": "structure", + "members": { + "ingestionJob": { + "target": "com.amazonaws.bedrockagent#IngestionJob", + "traits": { + "smithy.api#documentation": "Contains details about the ingestion job.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#GetKnowledgeBase": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#GetKnowledgeBaseRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#GetKnowledgeBaseResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets information about a knoweldge base.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/knowledgebases/{knowledgeBaseId}" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": ["console"] + } + }, + "com.amazonaws.bedrockagent#GetKnowledgeBaseRequest": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base for which to get information.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#GetKnowledgeBaseResponse": { + "type": "structure", + "members": { + "knowledgeBase": { + "target": "com.amazonaws.bedrockagent#KnowledgeBase", + "traits": { + "smithy.api#documentation": "Contains details about the knowledge base.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#GetPrompt": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#GetPromptRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#GetPromptResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves information about the working draft (DRAFT
version) of a prompt or a version of it, depending on whether you include the promptVersion
field or not. For more information, see View information about prompts using Prompt management and View information about a version of your prompt in the Amazon Bedrock User Guide.
The unique identifier of the prompt.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "promptVersion": { + "target": "com.amazonaws.bedrockagent#Version", + "traits": { + "smithy.api#documentation": "The version of the prompt about which you want to retrieve information. Omit this field to return information about the working draft of the prompt.
", + "smithy.api#httpQuery": "promptVersion" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#GetPromptResponse": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#PromptName", + "traits": { + "smithy.api#documentation": "The name of the prompt.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#PromptDescription", + "traits": { + "smithy.api#documentation": "The descriptino of the prompt.
" + } + }, + "customerEncryptionKeyArn": { + "target": "com.amazonaws.bedrockagent#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key that the prompt is encrypted with.
" + } + }, + "defaultVariant": { + "target": "com.amazonaws.bedrockagent#PromptVariantName", + "traits": { + "smithy.api#documentation": "The name of the default variant for the prompt. This value must match the name
field in the relevant PromptVariant object.
A list of objects, each containing details about a variant of the prompt.
" + } + }, + "id": { + "target": "com.amazonaws.bedrockagent#PromptId", + "traits": { + "smithy.api#documentation": "The unique identifier of the prompt.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.bedrockagent#PromptArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the prompt or the prompt version (if you specified a version in the request).
", + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.bedrockagent#Version", + "traits": { + "smithy.api#documentation": "The version of the prompt.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the prompt was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the prompt was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#GuardrailConfiguration": { + "type": "structure", + "members": { + "guardrailIdentifier": { + "target": "com.amazonaws.bedrockagent#GuardrailIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the guardrail.
" + } + }, + "guardrailVersion": { + "target": "com.amazonaws.bedrockagent#GuardrailVersion", + "traits": { + "smithy.api#documentation": "The version of the guardrail.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details about the guardrail associated with an agent.
" + } + }, + "com.amazonaws.bedrockagent#GuardrailIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^(([a-z0-9]+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+))$" + } + }, + "com.amazonaws.bedrockagent#GuardrailVersion": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(([0-9]{1,8})|(DRAFT))$" + } + }, + "com.amazonaws.bedrockagent#HierarchicalChunkingConfiguration": { + "type": "structure", + "members": { + "levelConfigurations": { + "target": "com.amazonaws.bedrockagent#HierarchicalChunkingLevelConfigurations", + "traits": { + "smithy.api#documentation": "Token settings for each layer.
", + "smithy.api#required": {} + } + }, + "overlapTokens": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The number of tokens to repeat across chunks in the same layer.
", + "smithy.api#range": { + "min": 1 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Settings for hierarchical document chunking for a data source. Hierarchical chunking splits documents\n into layers of chunks where the first layer contains large chunks, and the second layer contains smaller\n chunks derived from the first layer.
\nYou configure the number of tokens to overlap, or repeat across adjacent chunks. For example,\n if you set overlap tokens to 60, the last 60 tokens in the first chunk are also included at the beginning of\n the second chunk. For each layer, you must also configure the maximum number of tokens in a chunk.
" + } + }, + "com.amazonaws.bedrockagent#HierarchicalChunkingLevelConfiguration": { + "type": "structure", + "members": { + "maxTokens": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The maximum number of tokens that a chunk can contain in this layer.
", + "smithy.api#range": { + "min": 1, + "max": 8192 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Token settings for a layer in a hierarchical chunking configuration.
" + } + }, + "com.amazonaws.bedrockagent#HierarchicalChunkingLevelConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#HierarchicalChunkingLevelConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 2, + "max": 2 + } + } + }, + "com.amazonaws.bedrockagent#HttpsUrl": { + "type": "string", + "traits": { + "smithy.api#pattern": "^https://[A-Za-z0-9][^\\s]*$" + } + }, + "com.amazonaws.bedrockagent#Id": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[0-9a-zA-Z]{10}$" + } + }, + "com.amazonaws.bedrockagent#InferenceConfiguration": { + "type": "structure", + "members": { + "temperature": { + "target": "com.amazonaws.bedrockagent#Temperature", + "traits": { + "smithy.api#documentation": "The likelihood of the model selecting higher-probability options while generating a response. A lower value makes the model more likely to choose higher-probability options, while a higher value makes the model more likely to choose lower-probability options.
" + } + }, + "topP": { + "target": "com.amazonaws.bedrockagent#TopP", + "traits": { + "smithy.api#documentation": "While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for Top P
determines the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set topP
to 80, the model only selects the next token from the top 80% of the probability distribution of next tokens.
While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for topK
is the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set topK
to 50, the model selects the next token from among the top 50 most likely choices.
The maximum number of tokens to allow in the generated response.
" + } + }, + "stopSequences": { + "target": "com.amazonaws.bedrockagent#StopSequences", + "traits": { + "smithy.api#documentation": "A list of stop sequences. A stop sequence is a sequence of characters that causes the model to stop generating the response.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the promptType
. For more information, see Inference parameters for foundation models.
The unique identifier of the knowledge base to which the data source is being added.
", + "smithy.api#required": {} + } + }, + "dataSourceId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the ingested data source.
", + "smithy.api#required": {} + } + }, + "ingestionJobId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the ingestion job.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "The description of the ingestion job.
" + } + }, + "status": { + "target": "com.amazonaws.bedrockagent#IngestionJobStatus", + "traits": { + "smithy.api#documentation": "The status of the ingestion job.
", + "smithy.api#required": {} + } + }, + "statistics": { + "target": "com.amazonaws.bedrockagent#IngestionJobStatistics", + "traits": { + "smithy.api#documentation": "Contains statistics about the ingestion job.
" + } + }, + "failureReasons": { + "target": "com.amazonaws.bedrockagent#FailureReasons", + "traits": { + "smithy.api#documentation": "A list of reasons that the ingestion job failed.
" + } + }, + "startedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the ingestion job started.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the ingestion job was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about an ingestion job, which converts a data source to embeddings for a vector store in knowledge base.
\nThis data type is used in the following API operations:
\nThe attribute by which to filter the results.
", + "smithy.api#required": {} + } + }, + "operator": { + "target": "com.amazonaws.bedrockagent#IngestionJobFilterOperator", + "traits": { + "smithy.api#documentation": "The operation to carry out between the attribute and the values.
", + "smithy.api#required": {} + } + }, + "values": { + "target": "com.amazonaws.bedrockagent#IngestionJobFilterValues", + "traits": { + "smithy.api#documentation": "A list of values for the attribute.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Defines a filter by which to filter the results.
" + } + }, + "com.amazonaws.bedrockagent#IngestionJobFilterAttribute": { + "type": "enum", + "members": { + "STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STATUS" + } + } + } + }, + "com.amazonaws.bedrockagent#IngestionJobFilterOperator": { + "type": "enum", + "members": { + "EQ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EQ" + } + } + } + }, + "com.amazonaws.bedrockagent#IngestionJobFilterValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.bedrockagent#IngestionJobFilterValues": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#IngestionJobFilterValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.bedrockagent#IngestionJobFilters": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#IngestionJobFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.bedrockagent#IngestionJobResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrockagent#GetIngestionJob" + }, + { + "target": "com.amazonaws.bedrockagent#ListIngestionJobs" + }, + { + "target": "com.amazonaws.bedrockagent#StartIngestionJob" + } + ] + }, + "com.amazonaws.bedrockagent#IngestionJobSortBy": { + "type": "structure", + "members": { + "attribute": { + "target": "com.amazonaws.bedrockagent#IngestionJobSortByAttribute", + "traits": { + "smithy.api#documentation": "The attribute by which to sort the results.
", + "smithy.api#required": {} + } + }, + "order": { + "target": "com.amazonaws.bedrockagent#SortOrder", + "traits": { + "smithy.api#documentation": "The order by which to sort the results.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Parameters by which to sort the results.
" + } + }, + "com.amazonaws.bedrockagent#IngestionJobSortByAttribute": { + "type": "enum", + "members": { + "STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STATUS" + } + }, + "STARTED_AT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STARTED_AT" + } + } + } + }, + "com.amazonaws.bedrockagent#IngestionJobStatistics": { + "type": "structure", + "members": { + "numberOfDocumentsScanned": { + "target": "smithy.api#PrimitiveLong", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The total number of source documents that were scanned. Includes new, updated, and unchanged documents.
" + } + }, + "numberOfMetadataDocumentsScanned": { + "target": "smithy.api#PrimitiveLong", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The total number of metadata files that were scanned. Includes new, updated, and unchanged files.
" + } + }, + "numberOfNewDocumentsIndexed": { + "target": "smithy.api#PrimitiveLong", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The number of new source documents in the data source that were successfully indexed.
" + } + }, + "numberOfModifiedDocumentsIndexed": { + "target": "smithy.api#PrimitiveLong", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The number of modified source documents in the data source that were successfully indexed.
" + } + }, + "numberOfMetadataDocumentsModified": { + "target": "smithy.api#PrimitiveLong", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The number of metadata files that were updated or deleted.
" + } + }, + "numberOfDocumentsDeleted": { + "target": "smithy.api#PrimitiveLong", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The number of source documents that was deleted.
" + } + }, + "numberOfDocumentsFailed": { + "target": "smithy.api#PrimitiveLong", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The number of source documents that failed to be ingested.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the statistics for the ingestion job.
" + } + }, + "com.amazonaws.bedrockagent#IngestionJobStatus": { + "type": "enum", + "members": { + "STARTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STARTING" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETE" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.bedrockagent#IngestionJobSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#IngestionJobSummary" + } + }, + "com.amazonaws.bedrockagent#IngestionJobSummary": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base to which the data source is added.
", + "smithy.api#required": {} + } + }, + "dataSourceId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the data source in the ingestion job.
", + "smithy.api#required": {} + } + }, + "ingestionJobId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the ingestion job.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "The description of the ingestion job.
" + } + }, + "status": { + "target": "com.amazonaws.bedrockagent#IngestionJobStatus", + "traits": { + "smithy.api#documentation": "The status of the ingestion job.
", + "smithy.api#required": {} + } + }, + "startedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the ingestion job was started.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the ingestion job was last updated.
", + "smithy.api#required": {} + } + }, + "statistics": { + "target": "com.amazonaws.bedrockagent#IngestionJobStatistics", + "traits": { + "smithy.api#documentation": "Contains statistics for the ingestion job.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about an ingestion job.
" + } + }, + "com.amazonaws.bedrockagent#InputFlowNodeConfiguration": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "Contains configurations for the input flow node for a flow. This node takes the input from flow invocation and passes it to the next node in the data type that you specify.
" + } + }, + "com.amazonaws.bedrockagent#Instruction": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 40, + "max": 4000 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#IntermediateStorage": { + "type": "structure", + "members": { + "s3Location": { + "target": "com.amazonaws.bedrockagent#S3Location", + "traits": { + "smithy.api#documentation": "An S3 bucket path.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A location for storing content from data sources temporarily as it is processed by\n custom components in the ingestion pipeline.
" + } + }, + "com.amazonaws.bedrockagent#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrockagent#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "An internal server error occurred. Retry your request.
", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.bedrockagent#IteratorFlowNodeConfiguration": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "Contains configurations for an iterator node in a flow. Takes an input that is an array and iteratively sends each item of the array as an output to the following node. The size of the array is also returned in the output.
\nThe output flow node at the end of the flow iteration will return a response for each member of the array. To return only one response, you can include a collector node downstream from the iterator node.
" + } + }, + "com.amazonaws.bedrockagent#KmsKeyArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$" + } + }, + "com.amazonaws.bedrockagent#KnowledgeBase": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "The name of the knowledge base.
", + "smithy.api#required": {} + } + }, + "knowledgeBaseArn": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the knowledge base.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "The description of the knowledge base.
" + } + }, + "roleArn": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseRoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
", + "smithy.api#required": {} + } + }, + "knowledgeBaseConfiguration": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseConfiguration", + "traits": { + "smithy.api#documentation": "Contains details about the embeddings configuration of the knowledge base.
", + "smithy.api#required": {} + } + }, + "storageConfiguration": { + "target": "com.amazonaws.bedrockagent#StorageConfiguration", + "traits": { + "smithy.api#documentation": "Contains details about the storage configuration of the knowledge base.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseStatus", + "traits": { + "smithy.api#documentation": "The status of the knowledge base. The following statuses are possible:
\nCREATING – The knowledge base is being created.
\nACTIVE – The knowledge base is ready to be queried.
\nDELETING – The knowledge base is being deleted.
\nUPDATING – The knowledge base is being updated.
\nFAILED – The knowledge base API operation failed.
\nThe time at which the knowledge base was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the knowledge base was last updated.
", + "smithy.api#required": {} + } + }, + "failureReasons": { + "target": "com.amazonaws.bedrockagent#FailureReasons", + "traits": { + "smithy.api#documentation": "A list of reasons that the API operation on the knowledge base failed.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a knowledge base.
" + } + }, + "com.amazonaws.bedrockagent#KnowledgeBaseArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 128 + }, + "smithy.api#pattern": "^arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:knowledge-base/[0-9a-zA-Z]+$" + } + }, + "com.amazonaws.bedrockagent#KnowledgeBaseConfiguration": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseType", + "traits": { + "smithy.api#documentation": "The type of data that the data source is converted into for the knowledge base.
", + "smithy.api#required": {} + } + }, + "vectorKnowledgeBaseConfiguration": { + "target": "com.amazonaws.bedrockagent#VectorKnowledgeBaseConfiguration", + "traits": { + "smithy.api#documentation": "Contains details about the embeddings model that'sused to convert the data source.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about the embeddings configuration of the knowledge base.
" + } + }, + "com.amazonaws.bedrockagent#KnowledgeBaseFlowNodeConfiguration": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseId", + "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base to query.
", + "smithy.api#required": {} + } + }, + "modelId": { + "target": "com.amazonaws.bedrockagent#ModelIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the model to use to generate a response from the query results. Omit this field if you want to return the retrieved results as an array.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for a knowledge base node in a flow. This node takes a query as the input and returns, as the output, the retrieved responses directly (as an array) or a response generated based on the retrieved responses. For more information, see Node types in Amazon Bedrock works in the Amazon Bedrock User Guide.
" + } + }, + "com.amazonaws.bedrockagent#KnowledgeBaseId": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 10 + }, + "smithy.api#pattern": "^[0-9a-zA-Z]+$" + } + }, + "com.amazonaws.bedrockagent#KnowledgeBaseResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrockagent#AssociateAgentKnowledgeBase" + }, + { + "target": "com.amazonaws.bedrockagent#CreateKnowledgeBase" + }, + { + "target": "com.amazonaws.bedrockagent#DeleteKnowledgeBase" + }, + { + "target": "com.amazonaws.bedrockagent#DisassociateAgentKnowledgeBase" + }, + { + "target": "com.amazonaws.bedrockagent#GetAgentKnowledgeBase" + }, + { + "target": "com.amazonaws.bedrockagent#GetKnowledgeBase" + }, + { + "target": "com.amazonaws.bedrockagent#ListAgentKnowledgeBases" + }, + { + "target": "com.amazonaws.bedrockagent#ListKnowledgeBases" + }, + { + "target": "com.amazonaws.bedrockagent#UpdateAgentKnowledgeBase" + }, + { + "target": "com.amazonaws.bedrockagent#UpdateKnowledgeBase" + } + ] + }, + "com.amazonaws.bedrockagent#KnowledgeBaseRoleArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+$" + } + }, + "com.amazonaws.bedrockagent#KnowledgeBaseState": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.bedrockagent#KnowledgeBaseStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "DELETE_UNSUCCESSFUL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_UNSUCCESSFUL" + } + } + } + }, + "com.amazonaws.bedrockagent#KnowledgeBaseStorageType": { + "type": "enum", + "members": { + "OPENSEARCH_SERVERLESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OPENSEARCH_SERVERLESS" + } + }, + "PINECONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PINECONE" + } + }, + "REDIS_ENTERPRISE_CLOUD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REDIS_ENTERPRISE_CLOUD" + } + }, + "RDS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RDS" + } + }, + "MONGO_DB_ATLAS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MONGO_DB_ATLAS" + } + } + } + }, + "com.amazonaws.bedrockagent#KnowledgeBaseSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseSummary" + } + }, + "com.amazonaws.bedrockagent#KnowledgeBaseSummary": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "The name of the knowledge base.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "The description of the knowledge base.
" + } + }, + "status": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseStatus", + "traits": { + "smithy.api#documentation": "The status of the knowledge base.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the knowledge base was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about a knowledge base.
" + } + }, + "com.amazonaws.bedrockagent#KnowledgeBaseType": { + "type": "enum", + "members": { + "VECTOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VECTOR" + } + } + } + }, + "com.amazonaws.bedrockagent#LambdaArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}(-gov)?-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9-_\\.]+(:(\\$LATEST|[a-zA-Z0-9-_]+))?$" + } + }, + "com.amazonaws.bedrockagent#LambdaFunctionFlowNodeConfiguration": { + "type": "structure", + "members": { + "lambdaArn": { + "target": "com.amazonaws.bedrockagent#LambdaArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Lambda function to invoke.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for a Lambda function node in the flow. You specify the Lambda function to invoke and the inputs into the function. The output is the response that is defined in the Lambda function. For more information, see Node types in Amazon Bedrock works in the Amazon Bedrock User Guide.
" + } + }, + "com.amazonaws.bedrockagent#LexBotAliasArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 78 + }, + "smithy.api#pattern": "^arn:aws(|-us-gov):lex:[a-z]{2}(-gov)?-[a-z]+-\\d{1}:\\d{12}:bot-alias/[0-9a-zA-Z]+/[0-9a-zA-Z]+$" + } + }, + "com.amazonaws.bedrockagent#LexBotLocaleId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.bedrockagent#LexFlowNodeConfiguration": { + "type": "structure", + "members": { + "botAliasArn": { + "target": "com.amazonaws.bedrockagent#LexBotAliasArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Lex bot alias to invoke.
", + "smithy.api#required": {} + } + }, + "localeId": { + "target": "com.amazonaws.bedrockagent#LexBotLocaleId", + "traits": { + "smithy.api#documentation": "The Region to invoke the Amazon Lex bot in.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for a Lex node in the flow. You specify a Amazon Lex bot to invoke. This node takes an utterance as the input and returns as the output the intent identified by the Amazon Lex bot. For more information, see Node types in Amazon Bedrock works in the Amazon Bedrock User Guide.
" + } + }, + "com.amazonaws.bedrockagent#ListAgentActionGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#ListAgentActionGroupsRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#ListAgentActionGroupsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the action groups for an agent and information about each one.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/agents/{agentId}/agentversions/{agentVersion}/actiongroups/" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "actionGroupSummaries" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": ["console"] + } + }, + "com.amazonaws.bedrockagent#ListAgentActionGroupsRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#Version", + "traits": { + "smithy.api#documentation": "The version of the agent.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.bedrockagent#MaxResults", + "traits": { + "smithy.api#documentation": "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.
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.
A list of objects, each of which contains information about an action group.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagent#NextToken", + "traits": { + "smithy.api#documentation": "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.
Lists the aliases of an agent and information about each one.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/agents/{agentId}/agentaliases/" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "agentAliasSummaries" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": ["console"] + } + }, + "com.amazonaws.bedrockagent#ListAgentAliasesRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.bedrockagent#MaxResults", + "traits": { + "smithy.api#documentation": "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.
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.
A list of objects, each of which contains information about an alias of the agent.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagent#NextToken", + "traits": { + "smithy.api#documentation": "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.
Lists knowledge bases associated with an agent and information about each one.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/agents/{agentId}/agentversions/{agentVersion}/knowledgebases/" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "agentKnowledgeBaseSummaries" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": ["console"] + } + }, + "com.amazonaws.bedrockagent#ListAgentKnowledgeBasesRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent for which to return information about knowledge bases associated with it.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#Version", + "traits": { + "smithy.api#documentation": "The version of the agent for which to return information about knowledge bases associated with it.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.bedrockagent#MaxResults", + "traits": { + "smithy.api#documentation": "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.
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.
A list of objects, each of which contains information about a knowledge base associated with the agent.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagent#NextToken", + "traits": { + "smithy.api#documentation": "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.
Lists the versions of an agent and information about each version.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/agents/{agentId}/agentversions/" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "agentVersionSummaries" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": ["console"] + } + }, + "com.amazonaws.bedrockagent#ListAgentVersionsRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.bedrockagent#MaxResults", + "traits": { + "smithy.api#documentation": "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.
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.
A list of objects, each of which contains information about a version of the agent.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagent#NextToken", + "traits": { + "smithy.api#documentation": "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.
Lists the agents belonging to an account and information about each agent.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/agents/" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "agentSummaries" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": ["console"] + } + }, + "com.amazonaws.bedrockagent#ListAgentsRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "com.amazonaws.bedrockagent#MaxResults", + "traits": { + "smithy.api#documentation": "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.
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.
A list of objects, each of which contains information about an agent.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagent#NextToken", + "traits": { + "smithy.api#documentation": "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.
Lists the data sources in a knowledge base and information about each one.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/knowledgebases/{knowledgeBaseId}/datasources/" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "dataSourceSummaries" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": ["console"] + } + }, + "com.amazonaws.bedrockagent#ListDataSourcesRequest": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base for which to return a list of information.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.bedrockagent#MaxResults", + "traits": { + "smithy.api#documentation": "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.
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.
A list of objects, each of which contains information about a data source.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagent#NextToken", + "traits": { + "smithy.api#documentation": "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.
Returns a list of aliases for a flow.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/flows/{flowIdentifier}/aliases" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "flowAliasSummaries" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": ["console"] + } + }, + "com.amazonaws.bedrockagent#ListFlowAliasesRequest": { + "type": "structure", + "members": { + "flowIdentifier": { + "target": "com.amazonaws.bedrockagent#FlowIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow for which aliases are being returned.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.bedrockagent#MaxResults", + "traits": { + "smithy.api#documentation": "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.
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.
A list, each member of which contains information about an alias.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagent#NextToken", + "traits": { + "smithy.api#documentation": "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.
Returns a list of information about each flow. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/flows/{flowIdentifier}/versions" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "flowVersionSummaries" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": ["console"] + } + }, + "com.amazonaws.bedrockagent#ListFlowVersionsRequest": { + "type": "structure", + "members": { + "flowIdentifier": { + "target": "com.amazonaws.bedrockagent#FlowIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.bedrockagent#MaxResults", + "traits": { + "smithy.api#documentation": "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.
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.
A list, each member of which contains information about a flow.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagent#NextToken", + "traits": { + "smithy.api#documentation": "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.
Returns a list of flows and information about each flow. For more information, see Manage a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/flows/" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "flowSummaries" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": ["console"] + } + }, + "com.amazonaws.bedrockagent#ListFlowsRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "com.amazonaws.bedrockagent#MaxResults", + "traits": { + "smithy.api#documentation": "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.
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.
A list, each member of which contains information about a flow.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagent#NextToken", + "traits": { + "smithy.api#documentation": "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.
Lists the ingestion jobs for a data source and information about each of them.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}/ingestionjobs/" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "ingestionJobSummaries" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": ["console"] + } + }, + "com.amazonaws.bedrockagent#ListIngestionJobsRequest": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base for which to return ingestion jobs.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "dataSourceId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the data source for which to return ingestion jobs.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "filters": { + "target": "com.amazonaws.bedrockagent#IngestionJobFilters", + "traits": { + "smithy.api#documentation": "Contains a definition of a filter for which to filter the results.
" + } + }, + "sortBy": { + "target": "com.amazonaws.bedrockagent#IngestionJobSortBy", + "traits": { + "smithy.api#documentation": "Contains details about how to sort the results.
" + } + }, + "maxResults": { + "target": "com.amazonaws.bedrockagent#MaxResults", + "traits": { + "smithy.api#documentation": "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.
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.
A list of objects, each of which contains information about an ingestion job.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagent#NextToken", + "traits": { + "smithy.api#documentation": "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.
Lists the knowledge bases in an account and information about each of them.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/knowledgebases/" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "knowledgeBaseSummaries" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": ["console"] + } + }, + "com.amazonaws.bedrockagent#ListKnowledgeBasesRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "com.amazonaws.bedrockagent#MaxResults", + "traits": { + "smithy.api#documentation": "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.
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.
A list of objects, each of which contains information about a knowledge base.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagent#NextToken", + "traits": { + "smithy.api#documentation": "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.
Returns either information about the working draft (DRAFT
version) of each prompt in an account, or information about of all versions of a prompt, depending on whether you include the promptIdentifier
field or not. For more information, see View information about prompts using Prompt management in the Amazon Bedrock User Guide.
The unique identifier of the prompt for whose versions you want to return information. Omit this field to list information about all prompts in an account.
", + "smithy.api#httpQuery": "promptIdentifier" + } + }, + "maxResults": { + "target": "com.amazonaws.bedrockagent#MaxResults", + "traits": { + "smithy.api#documentation": "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.
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.
A list, each member of which contains information about a prompt using Prompt management.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagent#NextToken", + "traits": { + "smithy.api#documentation": "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.
List all the tags for the resource you specify.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/tags/{resourceArn}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagent#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.bedrockagent#TaggableResourcesArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource for which to list tags.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.bedrockagent#TagsMap", + "traits": { + "smithy.api#documentation": "The key-value pairs for the tags associated with the resource.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.bedrockagent#MaximumLength": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 4096 + } + } + }, + "com.amazonaws.bedrockagent#MemoryConfiguration": { + "type": "structure", + "members": { + "enabledMemoryTypes": { + "target": "com.amazonaws.bedrockagent#EnabledMemoryTypes", + "traits": { + "smithy.api#documentation": "The type of memory that is stored.
", + "smithy.api#required": {} + } + }, + "storageDays": { + "target": "com.amazonaws.bedrockagent#StorageDays", + "traits": { + "smithy.api#default": 30, + "smithy.api#documentation": "The number of days the agent is configured to retain the conversational context.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details of the memory configuration.
" + } + }, + "com.amazonaws.bedrockagent#MemoryType": { + "type": "enum", + "members": { + "SESSION_SUMMARY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SESSION_SUMMARY" + } + } + } + }, + "com.amazonaws.bedrockagent#Microsoft365TenantId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 36, + "max": 36 + }, + "smithy.api#pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" + } + }, + "com.amazonaws.bedrockagent#ModelIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})))|(([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2}))|(([0-9a-zA-Z][_-]?)+)$" + } + }, + "com.amazonaws.bedrockagent#MongoDbAtlasCollectionName": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 63 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.bedrockagent#MongoDbAtlasConfiguration": { + "type": "structure", + "members": { + "endpoint": { + "target": "com.amazonaws.bedrockagent#MongoDbAtlasEndpoint", + "traits": { + "smithy.api#documentation": "The endpoint URL of your MongoDB Atlas cluster for your knowledge base.
", + "smithy.api#required": {} + } + }, + "databaseName": { + "target": "com.amazonaws.bedrockagent#MongoDbAtlasDatabaseName", + "traits": { + "smithy.api#documentation": "The database name in your MongoDB Atlas cluster for your knowledge base.
", + "smithy.api#required": {} + } + }, + "collectionName": { + "target": "com.amazonaws.bedrockagent#MongoDbAtlasCollectionName", + "traits": { + "smithy.api#documentation": "The collection name of the knowledge base in MongoDB Atlas.
", + "smithy.api#required": {} + } + }, + "vectorIndexName": { + "target": "com.amazonaws.bedrockagent#MongoDbAtlasIndexName", + "traits": { + "smithy.api#documentation": "The name of the MongoDB Atlas vector search index.
", + "smithy.api#required": {} + } + }, + "credentialsSecretArn": { + "target": "com.amazonaws.bedrockagent#SecretArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that contains user credentials for your MongoDB Atlas cluster.
", + "smithy.api#required": {} + } + }, + "fieldMapping": { + "target": "com.amazonaws.bedrockagent#MongoDbAtlasFieldMapping", + "traits": { + "smithy.api#documentation": "Contains the names of the fields to which to map information about the vector store.
", + "smithy.api#required": {} + } + }, + "endpointServiceName": { + "target": "com.amazonaws.bedrockagent#MongoDbAtlasEndpointServiceName", + "traits": { + "smithy.api#documentation": "The name of the VPC endpoint service in your account that is connected to your MongoDB Atlas cluster.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about the storage configuration of the knowledge base in MongoDB Atlas.
" + } + }, + "com.amazonaws.bedrockagent#MongoDbAtlasDatabaseName": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 63 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.bedrockagent#MongoDbAtlasEndpoint": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.bedrockagent#MongoDbAtlasEndpointServiceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^(?:arn:aws(?:-us-gov|-cn|-iso|-iso-[a-z])*:.+:.*:\\d+:.+/.+$|[a-zA-Z0-9*]+[a-zA-Z0-9._-]*)$" + } + }, + "com.amazonaws.bedrockagent#MongoDbAtlasFieldMapping": { + "type": "structure", + "members": { + "vectorField": { + "target": "com.amazonaws.bedrockagent#FieldName", + "traits": { + "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
", + "smithy.api#required": {} + } + }, + "textField": { + "target": "com.amazonaws.bedrockagent#FieldName", + "traits": { + "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
", + "smithy.api#required": {} + } + }, + "metadataField": { + "target": "com.amazonaws.bedrockagent#FieldName", + "traits": { + "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores metadata about the vector store.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the names of the fields to which to map information about the vector store.
" + } + }, + "com.amazonaws.bedrockagent#MongoDbAtlasIndexName": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.bedrockagent#Name": { + "type": "string", + "traits": { + "smithy.api#pattern": "^([0-9a-zA-Z][_-]?){1,100}$" + } + }, + "com.amazonaws.bedrockagent#NextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^\\S*$" + } + }, + "com.amazonaws.bedrockagent#NonBlankString": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[\\s\\S]+$" + } + }, + "com.amazonaws.bedrockagent#NumericalVersion": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[0-9]{1,5}$" + } + }, + "com.amazonaws.bedrockagent#OpenSearchServerlessCollectionArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws:aoss:[a-z]{2}(-gov)?-[a-z]+-\\d{1}:\\d{12}:collection/[a-z0-9-]{3,32}$" + } + }, + "com.amazonaws.bedrockagent#OpenSearchServerlessConfiguration": { + "type": "structure", + "members": { + "collectionArn": { + "target": "com.amazonaws.bedrockagent#OpenSearchServerlessCollectionArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the OpenSearch Service vector store.
", + "smithy.api#required": {} + } + }, + "vectorIndexName": { + "target": "com.amazonaws.bedrockagent#OpenSearchServerlessIndexName", + "traits": { + "smithy.api#documentation": "The name of the vector store.
", + "smithy.api#required": {} + } + }, + "fieldMapping": { + "target": "com.amazonaws.bedrockagent#OpenSearchServerlessFieldMapping", + "traits": { + "smithy.api#documentation": "Contains the names of the fields to which to map information about the vector store.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about the storage configuration of the knowledge base in Amazon OpenSearch Service. For more information, see Create a vector index in Amazon OpenSearch Service.
" + } + }, + "com.amazonaws.bedrockagent#OpenSearchServerlessFieldMapping": { + "type": "structure", + "members": { + "vectorField": { + "target": "com.amazonaws.bedrockagent#FieldName", + "traits": { + "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
", + "smithy.api#required": {} + } + }, + "textField": { + "target": "com.amazonaws.bedrockagent#FieldName", + "traits": { + "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
", + "smithy.api#required": {} + } + }, + "metadataField": { + "target": "com.amazonaws.bedrockagent#FieldName", + "traits": { + "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores metadata about the vector store.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the names of the fields to which to map information about the vector store.
" + } + }, + "com.amazonaws.bedrockagent#OpenSearchServerlessIndexName": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.bedrockagent#OutputFlowNodeConfiguration": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "Contains configurations for an output flow node in the flow. You specify the data type expected for the input into the node in the type
field and how to return the final output in the expression
field.
A description of the parameter. Helps the foundation model determine how to elicit the parameters from the user.
" + } + }, + "type": { + "target": "com.amazonaws.bedrockagent#Type", + "traits": { + "smithy.api#documentation": "The data type of the parameter.
", + "smithy.api#required": {} + } + }, + "required": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Whether the parameter is required for the agent to complete the function for action group invocation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about a parameter in a function for an action group.
\nThis data type is used in the following API operations:
\nThe parsing strategy for the data source.
", + "smithy.api#required": {} + } + }, + "bedrockFoundationModelConfiguration": { + "target": "com.amazonaws.bedrockagent#BedrockFoundationModelConfiguration", + "traits": { + "smithy.api#documentation": "Settings for a foundation model used to parse documents for a data source.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Settings for parsing document contents. By default, the service converts the contents of each\n document into text before splitting it into chunks. To improve processing of PDF files with tables and images,\n you can configure the data source to convert the pages of text into images and use a model to describe the\n contents of each page.
\nTo use a model to parse PDF documents, set the parsing strategy to BEDROCK_FOUNDATION_MODEL
and\n specify the model or inference profile to use by ARN. You can also override the default parsing prompt with instructions for how\n to interpret images and tables in your documents. The following models are supported.
Anthropic Claude 3 Sonnet - anthropic.claude-3-sonnet-20240229-v1:0
\n
Anthropic Claude 3 Haiku - anthropic.claude-3-haiku-20240307-v1:0
\n
You can get the ARN of a model with the ListFoundationModels action. Standard model usage\n charges apply for the foundation model parsing strategy.
" + } + }, + "com.amazonaws.bedrockagent#ParsingPrompt": { + "type": "structure", + "members": { + "parsingPromptText": { + "target": "com.amazonaws.bedrockagent#ParsingPromptText", + "traits": { + "smithy.api#documentation": "Instructions for interpreting the contents of a document.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Instructions for interpreting the contents of a document.
" + } + }, + "com.amazonaws.bedrockagent#ParsingPromptText": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10000 + } + } + }, + "com.amazonaws.bedrockagent#ParsingStrategy": { + "type": "enum", + "members": { + "BEDROCK_FOUNDATION_MODEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BEDROCK_FOUNDATION_MODEL" + } + } + } + }, + "com.amazonaws.bedrockagent#PatternObjectFilter": { + "type": "structure", + "members": { + "objectType": { + "target": "com.amazonaws.bedrockagent#FilteredObjectType", + "traits": { + "smithy.api#documentation": "The supported object type or content type of the data source.
", + "smithy.api#required": {} + } + }, + "inclusionFilters": { + "target": "com.amazonaws.bedrockagent#FilterList", + "traits": { + "smithy.api#documentation": "A list of one or more inclusion regular expression patterns to include certain \n object types that adhere to the pattern. If you specify an inclusion and exclusion \n filter/pattern and both match a document, the exclusion filter takes precedence \n and the document isn’t crawled.
" + } + }, + "exclusionFilters": { + "target": "com.amazonaws.bedrockagent#FilterList", + "traits": { + "smithy.api#documentation": "A list of one or more exclusion regular expression patterns to exclude certain \n object types that adhere to the pattern. If you specify an inclusion and exclusion \n filter/pattern and both match a document, the exclusion filter takes precedence \n and the document isn’t crawled.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The specific filters applied to your data source content. You can filter out or \n include certain content.
" + } + }, + "com.amazonaws.bedrockagent#PatternObjectFilterConfiguration": { + "type": "structure", + "members": { + "filters": { + "target": "com.amazonaws.bedrockagent#PatternObjectFilterList", + "traits": { + "smithy.api#documentation": "The configuration of specific filters applied to your data source content. You can \n filter out or include certain content.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration of filtering certain objects or content types of the data source.
" + } + }, + "com.amazonaws.bedrockagent#PatternObjectFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#PatternObjectFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#Payload": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#PineconeConfiguration": { + "type": "structure", + "members": { + "connectionString": { + "target": "com.amazonaws.bedrockagent#PineconeConnectionString", + "traits": { + "smithy.api#documentation": "The endpoint URL for your index management page.
", + "smithy.api#required": {} + } + }, + "credentialsSecretArn": { + "target": "com.amazonaws.bedrockagent#SecretArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Pinecone API key.
", + "smithy.api#required": {} + } + }, + "namespace": { + "target": "com.amazonaws.bedrockagent#PineconeNamespace", + "traits": { + "smithy.api#documentation": "The namespace to be used to write new data to your database.
" + } + }, + "fieldMapping": { + "target": "com.amazonaws.bedrockagent#PineconeFieldMapping", + "traits": { + "smithy.api#documentation": "Contains the names of the fields to which to map information about the vector store.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about the storage configuration of the knowledge base in Pinecone. For more information, see Create a vector index in Pinecone.
" + } + }, + "com.amazonaws.bedrockagent#PineconeConnectionString": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.bedrockagent#PineconeFieldMapping": { + "type": "structure", + "members": { + "textField": { + "target": "com.amazonaws.bedrockagent#FieldName", + "traits": { + "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
", + "smithy.api#required": {} + } + }, + "metadataField": { + "target": "com.amazonaws.bedrockagent#FieldName", + "traits": { + "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores metadata about the vector store.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the names of the fields to which to map information about the vector store.
" + } + }, + "com.amazonaws.bedrockagent#PineconeNamespace": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.bedrockagent#PrepareAgent": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#PrepareAgentRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#PrepareAgentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a DRAFT
version of the agent that can be used for internal testing.
The unique identifier of the agent for which to create a DRAFT
version.
The unique identifier of the agent for which the DRAFT
version was created.
The status of the DRAFT
version and whether it is ready for use.
The version of the agent.
", + "smithy.api#required": {} + } + }, + "preparedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the DRAFT
version of the agent was last prepared.
Prepares the DRAFT
version of a flow so that it can be invoked. For more information, see Test a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
The unique identifier of the flow.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#PrepareFlowResponse": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.bedrockagent#FlowId", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagent#FlowStatus", + "traits": { + "smithy.api#documentation": "The status of the flow. When you submit this request, the status will be NotPrepared
. If preparation succeeds, the status becomes Prepared
. If it fails, the status becomes FAILED
.
The step in the agent sequence that this prompt configuration applies to.
" + } + }, + "promptCreationMode": { + "target": "com.amazonaws.bedrockagent#CreationMode", + "traits": { + "smithy.api#documentation": "Specifies whether to override the default prompt template for this promptType
. Set this value to OVERRIDDEN
to use the prompt that you provide in the basePromptTemplate
. If you leave it as DEFAULT
, the agent uses a default prompt template.
Specifies whether to allow the agent to carry out the step specified in the promptType
. If you set this value to DISABLED
, the agent skips that step. The default state for each promptType
is as follows.
\n PRE_PROCESSING
– ENABLED
\n
\n ORCHESTRATION
– ENABLED
\n
\n KNOWLEDGE_BASE_RESPONSE_GENERATION
– ENABLED
\n
\n POST_PROCESSING
– DISABLED
\n
Defines the prompt template with which to replace the default prompt template. You can use placeholder variables in the base prompt template to customize the prompt. For more information, see Prompt template placeholder variables. For more information, see Configure the prompt templates.
" + } + }, + "inferenceConfiguration": { + "target": "com.amazonaws.bedrockagent#InferenceConfiguration", + "traits": { + "smithy.api#documentation": "Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the promptType
. For more information, see Inference parameters for foundation models.
Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the promptType
. If you set the field as OVERRIDEN
, the overrideLambda
field in the PromptOverrideConfiguration must be specified with the ARN of a Lambda function.
Contains configurations to override a prompt template in one part of an agent sequence. For more information, see Advanced prompts.
" + } + }, + "com.amazonaws.bedrockagent#PromptConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#PromptConfiguration" + }, + "traits": { + "smithy.api#length": { + "max": 10 + } + } + }, + "com.amazonaws.bedrockagent#PromptDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.bedrockagent#PromptFlowNodeConfiguration": { + "type": "structure", + "members": { + "sourceConfiguration": { + "target": "com.amazonaws.bedrockagent#PromptFlowNodeSourceConfiguration", + "traits": { + "smithy.api#documentation": "Specifies whether the prompt is from Prompt management or defined inline.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for a prompt node in the flow. You can use a prompt from Prompt management or you can define one in this node. If the prompt contains variables, the inputs into this node will fill in the variables. The output from this node is the response generated by the model. For more information, see Node types in Amazon Bedrock works in the Amazon Bedrock User Guide.
" + } + }, + "com.amazonaws.bedrockagent#PromptFlowNodeInlineConfiguration": { + "type": "structure", + "members": { + "templateType": { + "target": "com.amazonaws.bedrockagent#PromptTemplateType", + "traits": { + "smithy.api#documentation": "The type of prompt template.
", + "smithy.api#required": {} + } + }, + "templateConfiguration": { + "target": "com.amazonaws.bedrockagent#PromptTemplateConfiguration", + "traits": { + "smithy.api#documentation": "Contains a prompt and variables in the prompt that can be replaced with values at runtime.
", + "smithy.api#required": {} + } + }, + "modelId": { + "target": "com.amazonaws.bedrockagent#PromptModelIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the model to run inference with.
", + "smithy.api#required": {} + } + }, + "inferenceConfiguration": { + "target": "com.amazonaws.bedrockagent#PromptInferenceConfiguration", + "traits": { + "smithy.api#documentation": "Contains inference configurations for the prompt.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for a prompt defined inline in the node.
" + } + }, + "com.amazonaws.bedrockagent#PromptFlowNodeResourceConfiguration": { + "type": "structure", + "members": { + "promptArn": { + "target": "com.amazonaws.bedrockagent#PromptArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the prompt from Prompt management.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for a prompt from Prompt management to use in a node.
" + } + }, + "com.amazonaws.bedrockagent#PromptFlowNodeSourceConfiguration": { + "type": "union", + "members": { + "resource": { + "target": "com.amazonaws.bedrockagent#PromptFlowNodeResourceConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations for a prompt from Prompt management.
" + } + }, + "inline": { + "target": "com.amazonaws.bedrockagent#PromptFlowNodeInlineConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations for a prompt that is defined inline
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for a prompt and whether it is from Prompt management or defined inline.
" + } + }, + "com.amazonaws.bedrockagent#PromptId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[0-9a-zA-Z]{10}$" + } + }, + "com.amazonaws.bedrockagent#PromptIdentifier": { + "type": "string", + "traits": { + "smithy.api#pattern": "^([0-9a-zA-Z]{10})|(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:prompt/[0-9a-zA-Z]{10})(?::[0-9]{1,5})?$" + } + }, + "com.amazonaws.bedrockagent#PromptInferenceConfiguration": { + "type": "union", + "members": { + "text": { + "target": "com.amazonaws.bedrockagent#PromptModelInferenceConfiguration", + "traits": { + "smithy.api#documentation": "Contains inference configurations for a text prompt.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains inference configurations for the prompt.
" + } + }, + "com.amazonaws.bedrockagent#PromptInputVariable": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#PromptInputVariableName", + "traits": { + "smithy.api#documentation": "The name of the variable.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a variable in the prompt.
" + } + }, + "com.amazonaws.bedrockagent#PromptInputVariableName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^([0-9a-zA-Z][_-]?){1,100}$" + } + }, + "com.amazonaws.bedrockagent#PromptInputVariablesList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#PromptInputVariable" + }, + "traits": { + "smithy.api#length": { + "max": 5 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#PromptMetadataEntry": { + "type": "structure", + "members": { + "key": { + "target": "com.amazonaws.bedrockagent#PromptMetadataKey", + "traits": { + "smithy.api#documentation": "The key of a metadata tag for a prompt variant.
", + "smithy.api#required": {} + } + }, + "value": { + "target": "com.amazonaws.bedrockagent#PromptMetadataValue", + "traits": { + "smithy.api#documentation": "The value of a metadata tag for a prompt variant.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains a key-value pair that defines a metadata tag and value to attach to a prompt variant. For more information, see Create a prompt using Prompt management.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#PromptMetadataKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#PromptMetadataList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#PromptMetadataEntry" + }, + "traits": { + "smithy.api#length": { + "max": 50 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#PromptMetadataValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#PromptModelIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|([0-9]{12}:provisioned-model/[a-z0-9]{12})))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|(([0-9a-zA-Z][_-]?)+)$" + } + }, + "com.amazonaws.bedrockagent#PromptModelInferenceConfiguration": { + "type": "structure", + "members": { + "temperature": { + "target": "com.amazonaws.bedrockagent#Temperature", + "traits": { + "smithy.api#documentation": "Controls the randomness of the response. Choose a lower value for more predictable outputs and a higher value for more surprising outputs.
" + } + }, + "topP": { + "target": "com.amazonaws.bedrockagent#TopP", + "traits": { + "smithy.api#documentation": "The percentage of most-likely candidates that the model considers for the next token.
" + } + }, + "topK": { + "target": "com.amazonaws.bedrockagent#TopK", + "traits": { + "smithy.api#documentation": "The number of most-likely candidates that the model considers for the next token during generation.
" + } + }, + "maxTokens": { + "target": "com.amazonaws.bedrockagent#MaximumLength", + "traits": { + "smithy.api#documentation": "The maximum number of tokens to return in the response.
" + } + }, + "stopSequences": { + "target": "com.amazonaws.bedrockagent#StopSequences", + "traits": { + "smithy.api#documentation": "A list of strings that define sequences after which the model will stop generating.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains inference configurations related to model inference for a prompt. For more information, see Inference parameters.
" + } + }, + "com.amazonaws.bedrockagent#PromptName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^([0-9a-zA-Z][_-]?){1,100}$" + } + }, + "com.amazonaws.bedrockagent#PromptOverrideConfiguration": { + "type": "structure", + "members": { + "promptConfigurations": { + "target": "com.amazonaws.bedrockagent#PromptConfigurations", + "traits": { + "smithy.api#documentation": "Contains configurations to override a prompt template in one part of an agent sequence. For more information, see Advanced prompts.
", + "smithy.api#required": {} + } + }, + "overrideLambda": { + "target": "com.amazonaws.bedrockagent#LambdaArn", + "traits": { + "smithy.api#documentation": "The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence. If you specify this field, at least one of the promptConfigurations
must contain a parserMode
value that is set to OVERRIDDEN
. For more information, see Parser Lambda function in Agents for Amazon Bedrock.
Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#PromptResource": { + "type": "resource", + "identifiers": { + "promptIdentifier": { + "target": "com.amazonaws.bedrockagent#PromptIdentifier" + } + }, + "create": { + "target": "com.amazonaws.bedrockagent#CreatePrompt" + }, + "read": { + "target": "com.amazonaws.bedrockagent#GetPrompt" + }, + "update": { + "target": "com.amazonaws.bedrockagent#UpdatePrompt" + }, + "delete": { + "target": "com.amazonaws.bedrockagent#DeletePrompt" + }, + "list": { + "target": "com.amazonaws.bedrockagent#ListPrompts" + }, + "operations": [ + { + "target": "com.amazonaws.bedrockagent#CreatePromptVersion" + } + ], + "traits": { + "aws.cloudformation#cfnResource": { + "name": "Prompt" + } + } + }, + "com.amazonaws.bedrockagent#PromptState": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.bedrockagent#PromptSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#PromptSummary" + }, + "traits": { + "smithy.api#length": { + "max": 10 + } + } + }, + "com.amazonaws.bedrockagent#PromptSummary": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#PromptName", + "traits": { + "smithy.api#documentation": "The name of the prompt.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#PromptDescription", + "traits": { + "smithy.api#documentation": "The description of the prompt.
" + } + }, + "id": { + "target": "com.amazonaws.bedrockagent#PromptId", + "traits": { + "smithy.api#documentation": "The unique identifier of the prompt.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.bedrockagent#PromptArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the prompt or the prompt version (if you specified a version in the request).
", + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.bedrockagent#Version", + "traits": { + "smithy.api#documentation": "The version of the prompt that this summary applies to.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the prompt was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the prompt was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a prompt in your Prompt management tool.
\nThis data type is used in the following API operations:
\n\n ListPrompts response\n
\nContains configurations for the text in a message for a prompt.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the message for a prompt. For more information, see Prompt management in Amazon Bedrock.
" + } + }, + "com.amazonaws.bedrockagent#PromptTemplateType": { + "type": "enum", + "members": { + "TEXT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TEXT" + } + } + } + }, + "com.amazonaws.bedrockagent#PromptType": { + "type": "enum", + "members": { + "PRE_PROCESSING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRE_PROCESSING" + } + }, + "ORCHESTRATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ORCHESTRATION" + } + }, + "POST_PROCESSING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POST_PROCESSING" + } + }, + "KNOWLEDGE_BASE_RESPONSE_GENERATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KNOWLEDGE_BASE_RESPONSE_GENERATION" + } + } + } + }, + "com.amazonaws.bedrockagent#PromptVariant": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#PromptVariantName", + "traits": { + "smithy.api#documentation": "The name of the prompt variant.
", + "smithy.api#required": {} + } + }, + "templateType": { + "target": "com.amazonaws.bedrockagent#PromptTemplateType", + "traits": { + "smithy.api#documentation": "The type of prompt template to use.
", + "smithy.api#required": {} + } + }, + "templateConfiguration": { + "target": "com.amazonaws.bedrockagent#PromptTemplateConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations for the prompt template.
" + } + }, + "modelId": { + "target": "com.amazonaws.bedrockagent#PromptModelIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the model with which to run inference on the prompt.
" + } + }, + "inferenceConfiguration": { + "target": "com.amazonaws.bedrockagent#PromptInferenceConfiguration", + "traits": { + "smithy.api#documentation": "Contains inference configurations for the prompt variant.
" + } + }, + "metadata": { + "target": "com.amazonaws.bedrockagent#PromptMetadataList", + "traits": { + "smithy.api#documentation": "An array of objects, each containing a key-value pair that defines a metadata tag and value to attach to a prompt variant. For more information, see Create a prompt using Prompt management.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about a variant of the prompt.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#PromptVariantList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#PromptVariant" + }, + "traits": { + "smithy.api#length": { + "max": 3 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#PromptVariantName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^([0-9a-zA-Z][_-]?){1,100}$" + } + }, + "com.amazonaws.bedrockagent#ProvisionedModelIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^((([0-9a-zA-Z][_-]?){1,63})|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:provisioned-model/[a-z0-9]{12}))$" + } + }, + "com.amazonaws.bedrockagent#RdsArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws(|-cn|-us-gov):rds:[a-zA-Z0-9-]*:[0-9]{12}:cluster:[a-zA-Z0-9-]{1,63}$" + } + }, + "com.amazonaws.bedrockagent#RdsConfiguration": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.bedrockagent#RdsArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the vector store.
", + "smithy.api#required": {} + } + }, + "credentialsSecretArn": { + "target": "com.amazonaws.bedrockagent#SecretArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Amazon RDS database.
", + "smithy.api#required": {} + } + }, + "databaseName": { + "target": "com.amazonaws.bedrockagent#RdsDatabaseName", + "traits": { + "smithy.api#documentation": "The name of your Amazon RDS database.
", + "smithy.api#required": {} + } + }, + "tableName": { + "target": "com.amazonaws.bedrockagent#RdsTableName", + "traits": { + "smithy.api#documentation": "The name of the table in the database.
", + "smithy.api#required": {} + } + }, + "fieldMapping": { + "target": "com.amazonaws.bedrockagent#RdsFieldMapping", + "traits": { + "smithy.api#documentation": "Contains the names of the fields to which to map information about the vector store.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS.
" + } + }, + "com.amazonaws.bedrockagent#RdsDatabaseName": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_\\-]+$" + } + }, + "com.amazonaws.bedrockagent#RdsFieldMapping": { + "type": "structure", + "members": { + "primaryKeyField": { + "target": "com.amazonaws.bedrockagent#ColumnName", + "traits": { + "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores the ID for each entry.
", + "smithy.api#required": {} + } + }, + "vectorField": { + "target": "com.amazonaws.bedrockagent#ColumnName", + "traits": { + "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
", + "smithy.api#required": {} + } + }, + "textField": { + "target": "com.amazonaws.bedrockagent#ColumnName", + "traits": { + "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
", + "smithy.api#required": {} + } + }, + "metadataField": { + "target": "com.amazonaws.bedrockagent#ColumnName", + "traits": { + "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores metadata about the vector store.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the names of the fields to which to map information about the vector store.
" + } + }, + "com.amazonaws.bedrockagent#RdsTableName": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_\\.\\-]+$" + } + }, + "com.amazonaws.bedrockagent#RecommendedAction": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + } + } + }, + "com.amazonaws.bedrockagent#RecommendedActions": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#RecommendedAction" + }, + "traits": { + "smithy.api#length": { + "max": 2048 + } + } + }, + "com.amazonaws.bedrockagent#RedisEnterpriseCloudConfiguration": { + "type": "structure", + "members": { + "endpoint": { + "target": "com.amazonaws.bedrockagent#RedisEnterpriseCloudEndpoint", + "traits": { + "smithy.api#documentation": "The endpoint URL of the Redis Enterprise Cloud database.
", + "smithy.api#required": {} + } + }, + "vectorIndexName": { + "target": "com.amazonaws.bedrockagent#RedisEnterpriseCloudIndexName", + "traits": { + "smithy.api#documentation": "The name of the vector index.
", + "smithy.api#required": {} + } + }, + "credentialsSecretArn": { + "target": "com.amazonaws.bedrockagent#SecretArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Redis Enterprise Cloud database.
", + "smithy.api#required": {} + } + }, + "fieldMapping": { + "target": "com.amazonaws.bedrockagent#RedisEnterpriseCloudFieldMapping", + "traits": { + "smithy.api#documentation": "Contains the names of the fields to which to map information about the vector store.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about the storage configuration of the knowledge base in Redis Enterprise Cloud. For more information, see Create a vector index in Redis Enterprise Cloud.
" + } + }, + "com.amazonaws.bedrockagent#RedisEnterpriseCloudEndpoint": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.bedrockagent#RedisEnterpriseCloudFieldMapping": { + "type": "structure", + "members": { + "vectorField": { + "target": "com.amazonaws.bedrockagent#FieldName", + "traits": { + "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
", + "smithy.api#required": {} + } + }, + "textField": { + "target": "com.amazonaws.bedrockagent#FieldName", + "traits": { + "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
", + "smithy.api#required": {} + } + }, + "metadataField": { + "target": "com.amazonaws.bedrockagent#FieldName", + "traits": { + "smithy.api#documentation": "The name of the field in which Amazon Bedrock stores metadata about the vector store.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the names of the fields to which to map information about the vector store.
" + } + }, + "com.amazonaws.bedrockagent#RedisEnterpriseCloudIndexName": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.bedrockagent#RequireConfirmation": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + }, + "traits": { + "smithy.api#documentation": "ENUM to check if action requires user confirmation" + } + }, + "com.amazonaws.bedrockagent#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrockagent#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.bedrockagent#RetrievalFlowNodeConfiguration": { + "type": "structure", + "members": { + "serviceConfiguration": { + "target": "com.amazonaws.bedrockagent#RetrievalFlowNodeServiceConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations for the service to use for retrieving data to return as the output from the node.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for a Retrieval node in a flow. This node retrieves data from the Amazon S3 location that you specify and returns it as the output.
" + } + }, + "com.amazonaws.bedrockagent#RetrievalFlowNodeS3Configuration": { + "type": "structure", + "members": { + "bucketName": { + "target": "com.amazonaws.bedrockagent#S3BucketName", + "traits": { + "smithy.api#documentation": "The name of the Amazon S3 bucket from which to retrieve data.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for the Amazon S3 location from which to retrieve data to return as the output from the node.
" + } + }, + "com.amazonaws.bedrockagent#RetrievalFlowNodeServiceConfiguration": { + "type": "union", + "members": { + "s3": { + "target": "com.amazonaws.bedrockagent#RetrievalFlowNodeS3Configuration", + "traits": { + "smithy.api#documentation": "Contains configurations for the Amazon S3 location from which to retrieve data to return as the output from the node.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for the service to use for retrieving data to return as the output from the node.
" + } + }, + "com.amazonaws.bedrockagent#S3BucketArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(|-cn|-us-gov):s3:::[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$" + } + }, + "com.amazonaws.bedrockagent#S3BucketName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 63 + }, + "smithy.api#pattern": "^[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$" + } + }, + "com.amazonaws.bedrockagent#S3BucketUri": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^s3://.{1,128}$" + } + }, + "com.amazonaws.bedrockagent#S3DataSourceConfiguration": { + "type": "structure", + "members": { + "bucketArn": { + "target": "com.amazonaws.bedrockagent#S3BucketArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the S3 bucket that contains your data.
", + "smithy.api#required": {} + } + }, + "inclusionPrefixes": { + "target": "com.amazonaws.bedrockagent#S3Prefixes", + "traits": { + "smithy.api#documentation": "A list of S3 prefixes to include certain files or content. For more information, \n see Organizing objects using prefixes.
" + } + }, + "bucketOwnerAccountId": { + "target": "com.amazonaws.bedrockagent#BucketOwnerAccountId", + "traits": { + "smithy.api#documentation": "The account ID for the owner of the S3 bucket.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration information to connect to Amazon S3 as your data source.
" + } + }, + "com.amazonaws.bedrockagent#S3Identifier": { + "type": "structure", + "members": { + "s3BucketName": { + "target": "com.amazonaws.bedrockagent#S3BucketName", + "traits": { + "smithy.api#documentation": "The name of the S3 bucket.
" + } + }, + "s3ObjectKey": { + "target": "com.amazonaws.bedrockagent#S3ObjectKey", + "traits": { + "smithy.api#documentation": "The S3 object key for the S3 resource.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The identifier information for an Amazon S3 bucket.
" + } + }, + "com.amazonaws.bedrockagent#S3Location": { + "type": "structure", + "members": { + "uri": { + "target": "com.amazonaws.bedrockagent#S3BucketUri", + "traits": { + "smithy.api#documentation": "The location's URI. For example, s3://my-bucket/chunk-processor/
.
An Amazon S3 location.
" + } + }, + "com.amazonaws.bedrockagent#S3ObjectKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^[\\.\\-\\!\\*\\_\\'\\(\\)a-zA-Z0-9][\\.\\-\\!\\*\\_\\'\\(\\)\\/a-zA-Z0-9]*$" + } + }, + "com.amazonaws.bedrockagent#S3Prefix": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 300 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#S3Prefixes": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#S3Prefix" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.bedrockagent#SalesforceAuthType": { + "type": "enum", + "members": { + "OAUTH2_CLIENT_CREDENTIALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OAUTH2_CLIENT_CREDENTIALS" + } + } + } + }, + "com.amazonaws.bedrockagent#SalesforceCrawlerConfiguration": { + "type": "structure", + "members": { + "filterConfiguration": { + "target": "com.amazonaws.bedrockagent#CrawlFilterConfiguration", + "traits": { + "smithy.api#documentation": "The configuration of filtering the Salesforce content. For example, \n configuring regular expression patterns to include or exclude certain \n content.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration of the Salesforce content. For example, configuring \n specific types of Salesforce content.
" + } + }, + "com.amazonaws.bedrockagent#SalesforceDataSourceConfiguration": { + "type": "structure", + "members": { + "sourceConfiguration": { + "target": "com.amazonaws.bedrockagent#SalesforceSourceConfiguration", + "traits": { + "smithy.api#documentation": "The endpoint information to connect to your Salesforce data source.
", + "smithy.api#required": {} + } + }, + "crawlerConfiguration": { + "target": "com.amazonaws.bedrockagent#SalesforceCrawlerConfiguration", + "traits": { + "smithy.api#documentation": "The configuration of the Salesforce content. For example, configuring \n specific types of Salesforce content.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration information to connect to Salesforce as your data source.
" + } + }, + "com.amazonaws.bedrockagent#SalesforceSourceConfiguration": { + "type": "structure", + "members": { + "hostUrl": { + "target": "com.amazonaws.bedrockagent#HttpsUrl", + "traits": { + "smithy.api#documentation": "The Salesforce host URL or instance URL.
", + "smithy.api#required": {} + } + }, + "authType": { + "target": "com.amazonaws.bedrockagent#SalesforceAuthType", + "traits": { + "smithy.api#documentation": "The supported authentication type to authenticate and connect to your \n Salesforce instance.
", + "smithy.api#required": {} + } + }, + "credentialsSecretArn": { + "target": "com.amazonaws.bedrockagent#SecretArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name of an Secrets Manager secret that \n stores your authentication credentials for your Salesforce instance URL. \n For more information on the key-value pairs that must be included in \n your secret, depending on your authentication type, see \n Salesforce connection configuration.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The endpoint information to connect to your Salesforce data source.
" + } + }, + "com.amazonaws.bedrockagent#SecretArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9!/_+=.@-]{1,512}$" + } + }, + "com.amazonaws.bedrockagent#SeedUrl": { + "type": "structure", + "members": { + "url": { + "target": "com.amazonaws.bedrockagent#Url", + "traits": { + "smithy.api#documentation": "A seed or starting point URL.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The seed or starting point URL. \n You should be authorized to crawl the URL.
" + } + }, + "com.amazonaws.bedrockagent#SeedUrls": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#SeedUrl" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.bedrockagent#SemanticChunkingConfiguration": { + "type": "structure", + "members": { + "maxTokens": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The maximum number of tokens that a chunk can contain.
", + "smithy.api#range": { + "min": 1 + }, + "smithy.api#required": {} + } + }, + "bufferSize": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The buffer size.
", + "smithy.api#range": { + "min": 0, + "max": 1 + }, + "smithy.api#required": {} + } + }, + "breakpointPercentileThreshold": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The dissimilarity threshold for splitting chunks.
", + "smithy.api#range": { + "min": 50, + "max": 99 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Settings for semantic document chunking for a data source. Semantic chunking splits\n a document into into smaller documents based on groups of similar content derived from the text\n with natural language processing.
\nWith semantic chunking, each sentence is compared to the next to determine how similar they are.\n You specify a threshold in the form of a percentile, where adjacent sentences that are less similar than\n that percentage of sentence pairs are divided into separate chunks. For example, if you set the threshold to \n 90, then the 10 percent of sentence pairs that are least similar are split. So if you have 101 sentences,\n 100 sentence pairs are compared, and the 10 with the least similarity are split, creating 11 chunks. These\n chunks are further split if they exceed the max token size.
\nYou must also specify a buffer size, which determines whether sentences are compared in isolation, or\n within a moving context window that includes the previous and following sentence. For example, if you set\n the buffer size to 1
, the embedding for sentence 10 is derived from sentences 9, 10, and 11\n combined.
The Amazon Resource Name (ARN) of the KMS key used to encrypt the resource.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the configuration for server-side encryption.
" + } + }, + "com.amazonaws.bedrockagent#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrockagent#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "The number of requests exceeds the service quota. Resubmit your request later.
", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.bedrockagent#SessionTTL": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 60, + "max": 3600 + } + } + }, + "com.amazonaws.bedrockagent#SharePointAuthType": { + "type": "enum", + "members": { + "OAUTH2_CLIENT_CREDENTIALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OAUTH2_CLIENT_CREDENTIALS" + } + } + } + }, + "com.amazonaws.bedrockagent#SharePointCrawlerConfiguration": { + "type": "structure", + "members": { + "filterConfiguration": { + "target": "com.amazonaws.bedrockagent#CrawlFilterConfiguration", + "traits": { + "smithy.api#documentation": "The configuration of filtering the SharePoint content. For example, \n configuring regular expression patterns to include or exclude certain content.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration of the SharePoint content. For example, configuring \n specific types of SharePoint content.
" + } + }, + "com.amazonaws.bedrockagent#SharePointDataSourceConfiguration": { + "type": "structure", + "members": { + "sourceConfiguration": { + "target": "com.amazonaws.bedrockagent#SharePointSourceConfiguration", + "traits": { + "smithy.api#documentation": "The endpoint information to connect to your SharePoint data source.
", + "smithy.api#required": {} + } + }, + "crawlerConfiguration": { + "target": "com.amazonaws.bedrockagent#SharePointCrawlerConfiguration", + "traits": { + "smithy.api#documentation": "The configuration of the SharePoint content. For example, configuring \n specific types of SharePoint content.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration information to connect to SharePoint as your data source.
" + } + }, + "com.amazonaws.bedrockagent#SharePointDomain": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.bedrockagent#SharePointHostType": { + "type": "enum", + "members": { + "ONLINE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ONLINE" + } + } + } + }, + "com.amazonaws.bedrockagent#SharePointSiteUrls": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#HttpsUrl" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.bedrockagent#SharePointSourceConfiguration": { + "type": "structure", + "members": { + "tenantId": { + "target": "com.amazonaws.bedrockagent#Microsoft365TenantId", + "traits": { + "smithy.api#documentation": "The identifier of your Microsoft 365 tenant.
" + } + }, + "domain": { + "target": "com.amazonaws.bedrockagent#SharePointDomain", + "traits": { + "smithy.api#documentation": "The domain of your SharePoint instance or site URL/URLs.
", + "smithy.api#required": {} + } + }, + "siteUrls": { + "target": "com.amazonaws.bedrockagent#SharePointSiteUrls", + "traits": { + "smithy.api#documentation": "A list of one or more SharePoint site URLs.
", + "smithy.api#required": {} + } + }, + "hostType": { + "target": "com.amazonaws.bedrockagent#SharePointHostType", + "traits": { + "smithy.api#documentation": "The supported host type, whether online/cloud or server/on-premises.
", + "smithy.api#required": {} + } + }, + "authType": { + "target": "com.amazonaws.bedrockagent#SharePointAuthType", + "traits": { + "smithy.api#documentation": "The supported authentication type to authenticate and connect \n to your SharePoint site/sites.
", + "smithy.api#required": {} + } + }, + "credentialsSecretArn": { + "target": "com.amazonaws.bedrockagent#SecretArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name of an Secrets Manager secret that \n stores your authentication credentials for your SharePoint site/sites. \n For more information on the key-value pairs that must be included in \n your secret, depending on your authentication type, see \n SharePoint connection configuration.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The endpoint information to connect to your SharePoint data source.
" + } + }, + "com.amazonaws.bedrockagent#SortOrder": { + "type": "enum", + "members": { + "ASCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASCENDING" + } + }, + "DESCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DESCENDING" + } + } + } + }, + "com.amazonaws.bedrockagent#StartIngestionJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#StartIngestionJobRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#StartIngestionJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Begins an ingestion job, in which a data source is added to a knowledge base.
", + "smithy.api#http": { + "code": 202, + "method": "PUT", + "uri": "/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}/ingestionjobs/" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": ["console"] + } + }, + "com.amazonaws.bedrockagent#StartIngestionJobRequest": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base to which to add the data source.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "dataSourceId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the data source to ingest.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagent#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", + "smithy.api#idempotencyToken": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "A description of the ingestion job.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#StartIngestionJobResponse": { + "type": "structure", + "members": { + "ingestionJob": { + "target": "com.amazonaws.bedrockagent#IngestionJob", + "traits": { + "smithy.api#documentation": "An object containing information about the ingestion job.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#StepType": { + "type": "enum", + "members": { + "POST_CHUNKING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POST_CHUNKING" + } + } + } + }, + "com.amazonaws.bedrockagent#StopSequences": { + "type": "list", + "member": { + "target": "smithy.api#String" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 4 + } + } + }, + "com.amazonaws.bedrockagent#StorageConfiguration": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseStorageType", + "traits": { + "smithy.api#documentation": "The vector store service in which the knowledge base is stored.
", + "smithy.api#required": {} + } + }, + "opensearchServerlessConfiguration": { + "target": "com.amazonaws.bedrockagent#OpenSearchServerlessConfiguration", + "traits": { + "smithy.api#documentation": "Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.
" + } + }, + "pineconeConfiguration": { + "target": "com.amazonaws.bedrockagent#PineconeConfiguration", + "traits": { + "smithy.api#documentation": "Contains the storage configuration of the knowledge base in Pinecone.
" + } + }, + "redisEnterpriseCloudConfiguration": { + "target": "com.amazonaws.bedrockagent#RedisEnterpriseCloudConfiguration", + "traits": { + "smithy.api#documentation": "Contains the storage configuration of the knowledge base in Redis Enterprise Cloud.
" + } + }, + "rdsConfiguration": { + "target": "com.amazonaws.bedrockagent#RdsConfiguration", + "traits": { + "smithy.api#documentation": "Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS.
" + } + }, + "mongoDbAtlasConfiguration": { + "target": "com.amazonaws.bedrockagent#MongoDbAtlasConfiguration", + "traits": { + "smithy.api#documentation": "Contains the storage configuration of the knowledge base in MongoDB Atlas.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the storage configuration of the knowledge base.
" + } + }, + "com.amazonaws.bedrockagent#StorageDays": { + "type": "integer", + "traits": { + "smithy.api#default": 30, + "smithy.api#range": { + "min": 0, + "max": 30 + } + } + }, + "com.amazonaws.bedrockagent#StorageFlowNodeConfiguration": { + "type": "structure", + "members": { + "serviceConfiguration": { + "target": "com.amazonaws.bedrockagent#StorageFlowNodeServiceConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations for the service to use for storing the input into the node.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for a Storage node in a flow. This node stores the input in an Amazon S3 location that you specify.
" + } + }, + "com.amazonaws.bedrockagent#StorageFlowNodeS3Configuration": { + "type": "structure", + "members": { + "bucketName": { + "target": "com.amazonaws.bedrockagent#S3BucketName", + "traits": { + "smithy.api#documentation": "The name of the Amazon S3 bucket in which to store the input into the node.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for the Amazon S3 location in which to store the input into the node.
" + } + }, + "com.amazonaws.bedrockagent#StorageFlowNodeServiceConfiguration": { + "type": "union", + "members": { + "s3": { + "target": "com.amazonaws.bedrockagent#StorageFlowNodeS3Configuration", + "traits": { + "smithy.api#documentation": "Contains configurations for the Amazon S3 location in which to store the input into the node.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for the service to use for storing the input into the node.
" + } + }, + "com.amazonaws.bedrockagent#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$" + } + }, + "com.amazonaws.bedrockagent#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.bedrockagent#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Associate tags with a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/tags/{resourceArn}" + } + } + }, + "com.amazonaws.bedrockagent#TagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.bedrockagent#TaggableResourcesArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource to tag.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.bedrockagent#TagsMap", + "traits": { + "smithy.api#documentation": "An object containing key-value pairs that define the tags to attach to the resource.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#TagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$" + } + }, + "com.amazonaws.bedrockagent#TaggableResourcesArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 1011 + }, + "smithy.api#pattern": "(^arn:aws:bedrock:[a-zA-Z0-9-]+:/d{12}:(agent|agent-alias|knowledge-base|flow|prompt)/[A-Z0-9]{10}(?:/[A-Z0-9]{10})?$|^arn:aws:bedrock:[a-zA-Z0-9-]+:/d{12}:flow/([A-Z0-9]{10})/alias/([A-Z0-9]{10})$|^arn:aws:bedrock:[a-zA-Z0-9-]+:/d{12}:prompt/([A-Z0-9]{10})?(?::/d+)?$)" + } + }, + "com.amazonaws.bedrockagent#TaggingResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrockagent#ListTagsForResource" + }, + { + "target": "com.amazonaws.bedrockagent#TagResource" + }, + { + "target": "com.amazonaws.bedrockagent#UntagResource" + } + ] + }, + "com.amazonaws.bedrockagent#TagsMap": { + "type": "map", + "key": { + "target": "com.amazonaws.bedrockagent#TagKey" + }, + "value": { + "target": "com.amazonaws.bedrockagent#TagValue" + } + }, + "com.amazonaws.bedrockagent#Temperature": { + "type": "float", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.bedrockagent#TextPrompt": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200000 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#TextPromptTemplateConfiguration": { + "type": "structure", + "members": { + "text": { + "target": "com.amazonaws.bedrockagent#TextPrompt", + "traits": { + "smithy.api#documentation": "The message for the prompt.
", + "smithy.api#required": {} + } + }, + "inputVariables": { + "target": "com.amazonaws.bedrockagent#PromptInputVariablesList", + "traits": { + "smithy.api#documentation": "An array of the variables in the prompt template.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configurations for a text prompt template. To include a variable, enclose a word in double curly braces as in {{variable}}
.
The number of requests exceeds the limit. Resubmit your request later.
", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.bedrockagent#TopK": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 500 + } + } + }, + "com.amazonaws.bedrockagent#TopP": { + "type": "float", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.bedrockagent#Transformation": { + "type": "structure", + "members": { + "transformationFunction": { + "target": "com.amazonaws.bedrockagent#TransformationFunction", + "traits": { + "smithy.api#documentation": "A Lambda function that processes documents.
", + "smithy.api#required": {} + } + }, + "stepToApply": { + "target": "com.amazonaws.bedrockagent#StepType", + "traits": { + "smithy.api#documentation": "When the service applies the transformation.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A custom processing step for documents moving through a data source ingestion pipeline. To\n process documents after they have been converted into chunks, set the step to apply to\n POST_CHUNKING
.
The Lambda function.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A Lambda function that processes documents.
" + } + }, + "com.amazonaws.bedrockagent#TransformationLambdaConfiguration": { + "type": "structure", + "members": { + "lambdaArn": { + "target": "com.amazonaws.bedrockagent#LambdaArn", + "traits": { + "smithy.api#documentation": "The function's ARN identifier.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A Lambda function that processes documents.
" + } + }, + "com.amazonaws.bedrockagent#Transformations": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#Transformation" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.bedrockagent#Type": { + "type": "enum", + "members": { + "STRING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "string" + } + }, + "NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "number" + } + }, + "INTEGER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "integer" + } + }, + "BOOLEAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "boolean" + } + }, + "ARRAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "array" + } + } + } + }, + "com.amazonaws.bedrockagent#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Remove tags from a resource.
", + "smithy.api#http": { + "code": 200, + "method": "DELETE", + "uri": "/tags/{resourceArn}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagent#UntagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.bedrockagent#TaggableResourcesArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource from which to remove tags.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tagKeys": { + "target": "com.amazonaws.bedrockagent#TagKeyList", + "traits": { + "smithy.api#documentation": "A list of keys of the tags to remove from the resource.
", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#UntagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#UpdateAgent": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#UpdateAgentRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#UpdateAgentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the configuration of an agent.
", + "smithy.api#http": { + "code": 202, + "method": "PUT", + "uri": "/agents/{agentId}/" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": ["console"] + } + }, + "com.amazonaws.bedrockagent#UpdateAgentActionGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#UpdateAgentActionGroupRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#UpdateAgentActionGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the configuration for an action group for an agent.
", + "smithy.api#http": { + "code": 200, + "method": "PUT", + "uri": "/agents/{agentId}/agentversions/{agentVersion}/actiongroups/{actionGroupId}/" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": ["console"] + } + }, + "com.amazonaws.bedrockagent#UpdateAgentActionGroupRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent for which to update the action group.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#DraftVersion", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent version for which to update the action group.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "actionGroupId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the action group.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "actionGroupName": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "Specifies a new name for the action group.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "Specifies a new name for the action group.
" + } + }, + "parentActionGroupSignature": { + "target": "com.amazonaws.bedrockagent#ActionGroupSignature", + "traits": { + "smithy.api#documentation": "To allow your agent to request the user for additional information when trying to complete a task, set this field to AMAZON.UserInput
. 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.
" + } + }, + "actionGroupExecutor": { + "target": "com.amazonaws.bedrockagent#ActionGroupExecutor", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.
" + } + }, + "actionGroupState": { + "target": "com.amazonaws.bedrockagent#ActionGroupState", + "traits": { + "smithy.api#documentation": "Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
" + } + }, + "apiSchema": { + "target": "com.amazonaws.bedrockagent#APISchema", + "traits": { + "smithy.api#documentation": "Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas.
" + } + }, + "functionSchema": { + "target": "com.amazonaws.bedrockagent#FunctionSchema", + "traits": { + "smithy.api#documentation": "Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#UpdateAgentActionGroupResponse": { + "type": "structure", + "members": { + "agentActionGroup": { + "target": "com.amazonaws.bedrockagent#AgentActionGroup", + "traits": { + "smithy.api#documentation": "Contains details about the action group that was updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#UpdateAgentAlias": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#UpdateAgentAliasRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#UpdateAgentAliasResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates configurations for an alias of an agent.
", + "smithy.api#http": { + "code": 202, + "method": "PUT", + "uri": "/agents/{agentId}/agentaliases/{agentAliasId}/" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": ["console"] + } + }, + "com.amazonaws.bedrockagent#UpdateAgentAliasRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentAliasId": { + "target": "com.amazonaws.bedrockagent#AgentAliasId", + "traits": { + "smithy.api#documentation": "The unique identifier of the alias.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentAliasName": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "Specifies a new name for the alias.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "Specifies a new description for the alias.
" + } + }, + "routingConfiguration": { + "target": "com.amazonaws.bedrockagent#AgentAliasRoutingConfiguration", + "traits": { + "smithy.api#documentation": "Contains details about the routing configuration of the alias.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#UpdateAgentAliasResponse": { + "type": "structure", + "members": { + "agentAlias": { + "target": "com.amazonaws.bedrockagent#AgentAlias", + "traits": { + "smithy.api#documentation": "Contains details about the alias that was updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#UpdateAgentKnowledgeBase": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#UpdateAgentKnowledgeBaseRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#UpdateAgentKnowledgeBaseResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the configuration for a knowledge base that has been associated with an agent.
", + "smithy.api#http": { + "code": 200, + "method": "PUT", + "uri": "/agents/{agentId}/agentversions/{agentVersion}/knowledgebases/{knowledgeBaseId}/" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": ["console"] + } + }, + "com.amazonaws.bedrockagent#UpdateAgentKnowledgeBaseRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent associated with the knowledge base that you want to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#DraftVersion", + "traits": { + "smithy.api#documentation": "The version of the agent associated with the knowledge base that you want to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base that has been associated with an agent.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "Specifies a new description for the knowledge base associated with an agent.
" + } + }, + "knowledgeBaseState": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseState", + "traits": { + "smithy.api#documentation": "Specifies whether the agent uses the knowledge base or not when sending an InvokeAgent request.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#UpdateAgentKnowledgeBaseResponse": { + "type": "structure", + "members": { + "agentKnowledgeBase": { + "target": "com.amazonaws.bedrockagent#AgentKnowledgeBase", + "traits": { + "smithy.api#documentation": "Contains details about the knowledge base that has been associated with an agent.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#UpdateAgentRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentName": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "Specifies a new name for the agent.
", + "smithy.api#required": {} + } + }, + "instruction": { + "target": "com.amazonaws.bedrockagent#Instruction", + "traits": { + "smithy.api#documentation": "Specifies new instructions that tell the agent what it should do and how it should interact with users.
" + } + }, + "foundationModel": { + "target": "com.amazonaws.bedrockagent#ModelIdentifier", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Specifies a new foundation model to be used for orchestration by the agent.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "Specifies a new description of the agent.
" + } + }, + "idleSessionTTLInSeconds": { + "target": "com.amazonaws.bedrockagent#SessionTTL", + "traits": { + "smithy.api#documentation": "The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.
\nA user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.
" + } + }, + "agentResourceRoleArn": { + "target": "com.amazonaws.bedrockagent#AgentRoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
", + "smithy.api#required": {} + } + }, + "customerEncryptionKeyArn": { + "target": "com.amazonaws.bedrockagent#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.
" + } + }, + "promptOverrideConfiguration": { + "target": "com.amazonaws.bedrockagent#PromptOverrideConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.
" + } + }, + "guardrailConfiguration": { + "target": "com.amazonaws.bedrockagent#GuardrailConfiguration", + "traits": { + "smithy.api#documentation": "The unique Guardrail configuration assigned to the agent when it is updated.
" + } + }, + "memoryConfiguration": { + "target": "com.amazonaws.bedrockagent#MemoryConfiguration", + "traits": { + "smithy.api#documentation": "Specifies the new memory configuration for the agent.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#UpdateAgentResponse": { + "type": "structure", + "members": { + "agent": { + "target": "com.amazonaws.bedrockagent#Agent", + "traits": { + "smithy.api#documentation": "Contains details about the agent that was updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#UpdateDataSource": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#UpdateDataSourceRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#UpdateDataSourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the configurations for a data source connector.
\nYou can't change the chunkingConfiguration
after you create the data source connector. Specify the existing chunkingConfiguration
.
The unique identifier of the knowledge base for the data source.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "dataSourceId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the data source.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "Specifies a new name for the data source.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "Specifies a new description for the data source.
" + } + }, + "dataSourceConfiguration": { + "target": "com.amazonaws.bedrockagent#DataSourceConfiguration", + "traits": { + "smithy.api#documentation": "The connection configuration for the data source that you want to update.
", + "smithy.api#required": {} + } + }, + "dataDeletionPolicy": { + "target": "com.amazonaws.bedrockagent#DataDeletionPolicy", + "traits": { + "smithy.api#documentation": "The data deletion policy for the data source that you want to update.
" + } + }, + "serverSideEncryptionConfiguration": { + "target": "com.amazonaws.bedrockagent#ServerSideEncryptionConfiguration", + "traits": { + "smithy.api#documentation": "Contains details about server-side encryption of the data source.
" + } + }, + "vectorIngestionConfiguration": { + "target": "com.amazonaws.bedrockagent#VectorIngestionConfiguration", + "traits": { + "smithy.api#documentation": "Contains details about how to ingest the documents in the data source.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#UpdateDataSourceResponse": { + "type": "structure", + "members": { + "dataSource": { + "target": "com.amazonaws.bedrockagent#DataSource", + "traits": { + "smithy.api#documentation": "Contains details about the data source.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#UpdateFlow": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#UpdateFlowRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#UpdateFlowResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Modifies a flow. Include both fields that you want to keep and fields that you want to change. For more information, see How it works and Create a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 200, + "method": "PUT", + "uri": "/flows/{flowIdentifier}/" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": ["console"] + } + }, + "com.amazonaws.bedrockagent#UpdateFlowAlias": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#UpdateFlowAliasRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#UpdateFlowAliasResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Modifies the alias of a flow. Include both fields that you want to keep and ones that you want to change. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 200, + "method": "PUT", + "uri": "/flows/{flowIdentifier}/aliases/{aliasIdentifier}" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": ["console"] + } + }, + "com.amazonaws.bedrockagent#UpdateFlowAliasRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "The name of the alias.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "A description for the alias.
" + } + }, + "routingConfiguration": { + "target": "com.amazonaws.bedrockagent#FlowAliasRoutingConfiguration", + "traits": { + "smithy.api#documentation": "Contains information about the version to which to map the alias.
", + "smithy.api#required": {} + } + }, + "flowIdentifier": { + "target": "com.amazonaws.bedrockagent#FlowIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "aliasIdentifier": { + "target": "com.amazonaws.bedrockagent#FlowAliasIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the alias.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#UpdateFlowAliasResponse": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "The name of the alias.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "The description of the flow.
" + } + }, + "routingConfiguration": { + "target": "com.amazonaws.bedrockagent#FlowAliasRoutingConfiguration", + "traits": { + "smithy.api#documentation": "Contains information about the version that the alias is mapped to.
", + "smithy.api#required": {} + } + }, + "flowId": { + "target": "com.amazonaws.bedrockagent#FlowId", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow.
", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.bedrockagent#FlowAliasId", + "traits": { + "smithy.api#documentation": "The unique identifier of the alias.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.bedrockagent#FlowAliasArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the flow.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the flow was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the alias was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#UpdateFlowRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#FlowName", + "traits": { + "smithy.api#documentation": "A name for the flow.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#FlowDescription", + "traits": { + "smithy.api#documentation": "A description for the flow.
" + } + }, + "executionRoleArn": { + "target": "com.amazonaws.bedrockagent#FlowExecutionRoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service role with permissions to create and manage a flow. For more information, see Create a service role for flows in Amazon Bedrock in the Amazon Bedrock User Guide.
", + "smithy.api#required": {} + } + }, + "customerEncryptionKeyArn": { + "target": "com.amazonaws.bedrockagent#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key to encrypt the flow.
" + } + }, + "definition": { + "target": "com.amazonaws.bedrockagent#FlowDefinition", + "traits": { + "smithy.api#documentation": "A definition of the nodes and the connections between the nodes in the flow.
" + } + }, + "flowIdentifier": { + "target": "com.amazonaws.bedrockagent#FlowIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#UpdateFlowResponse": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#FlowName", + "traits": { + "smithy.api#documentation": "The name of the flow.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#FlowDescription", + "traits": { + "smithy.api#documentation": "The description of the flow.
" + } + }, + "executionRoleArn": { + "target": "com.amazonaws.bedrockagent#FlowExecutionRoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service role with permissions to create a flow. For more information, see Create a service role for flows in Amazon Bedrock in the Amazon Bedrock User Guide.
", + "smithy.api#required": {} + } + }, + "customerEncryptionKeyArn": { + "target": "com.amazonaws.bedrockagent#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key that the flow was encrypted with.
" + } + }, + "id": { + "target": "com.amazonaws.bedrockagent#FlowId", + "traits": { + "smithy.api#documentation": "The unique identifier of the flow.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.bedrockagent#FlowArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the flow.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagent#FlowStatus", + "traits": { + "smithy.api#documentation": "The status of the flow. When you submit this request, the status will be NotPrepared
. If updating fails, the status becomes Failed
.
The time at which the flow was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the flow was last updated.
", + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.bedrockagent#DraftVersion", + "traits": { + "smithy.api#documentation": "The version of the flow. When you update a flow, the version updated is the DRAFT
version.
A definition of the nodes and the connections between nodes in the flow.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#UpdateKnowledgeBase": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#UpdateKnowledgeBaseRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#UpdateKnowledgeBaseResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the configuration of a knowledge base with the fields that you specify. Because all fields will be overwritten, you must include the same values for fields that you want to keep the same.
\nYou can change the following fields:
\n\n name
\n
\n description
\n
\n roleArn
\n
You can't change the knowledgeBaseConfiguration
or storageConfiguration
fields, so you must specify the same configurations as when you created the knowledge base. You can send a GetKnowledgeBase request and copy the same configurations.
The unique identifier of the knowledge base to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "Specifies a new name for the knowledge base.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "Specifies a new description for the knowledge base.
" + } + }, + "roleArn": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseRoleArn", + "traits": { + "smithy.api#documentation": "Specifies a different Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
", + "smithy.api#required": {} + } + }, + "knowledgeBaseConfiguration": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseConfiguration", + "traits": { + "smithy.api#documentation": "Specifies the configuration for the embeddings model used for the knowledge base. You must use the same configuration as when the knowledge base was created.
", + "smithy.api#required": {} + } + }, + "storageConfiguration": { + "target": "com.amazonaws.bedrockagent#StorageConfiguration", + "traits": { + "smithy.api#documentation": "Specifies the configuration for the vector store used for the knowledge base. You must use the same configuration as when the knowledge base was created.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#UpdateKnowledgeBaseResponse": { + "type": "structure", + "members": { + "knowledgeBase": { + "target": "com.amazonaws.bedrockagent#KnowledgeBase", + "traits": { + "smithy.api#documentation": "Contains details about the knowledge base.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#UpdatePrompt": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#UpdatePromptRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#UpdatePromptResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Modifies a prompt in your prompt library. Include both fields that you want to keep and fields that you want to replace. For more information, see Prompt management in Amazon Bedrock and Edit prompts in your prompt library in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 200, + "method": "PUT", + "uri": "/prompts/{promptIdentifier}/" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": ["console"] + } + }, + "com.amazonaws.bedrockagent#UpdatePromptRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#PromptName", + "traits": { + "smithy.api#documentation": "A name for the prompt.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#PromptDescription", + "traits": { + "smithy.api#documentation": "A description for the prompt.
" + } + }, + "customerEncryptionKeyArn": { + "target": "com.amazonaws.bedrockagent#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key to encrypt the prompt.
" + } + }, + "defaultVariant": { + "target": "com.amazonaws.bedrockagent#PromptVariantName", + "traits": { + "smithy.api#documentation": "The name of the default variant for the prompt. This value must match the name
field in the relevant PromptVariant object.
A list of objects, each containing details about a variant of the prompt.
" + } + }, + "promptIdentifier": { + "target": "com.amazonaws.bedrockagent#PromptIdentifier", + "traits": { + "smithy.api#documentation": "The unique identifier of the prompt.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#UpdatePromptResponse": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#PromptName", + "traits": { + "smithy.api#documentation": "The name of the prompt.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockagent#PromptDescription", + "traits": { + "smithy.api#documentation": "The description of the prompt.
" + } + }, + "customerEncryptionKeyArn": { + "target": "com.amazonaws.bedrockagent#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key to encrypt the prompt.
" + } + }, + "defaultVariant": { + "target": "com.amazonaws.bedrockagent#PromptVariantName", + "traits": { + "smithy.api#documentation": "The name of the default variant for the prompt. This value must match the name
field in the relevant PromptVariant object.
A list of objects, each containing details about a variant of the prompt.
" + } + }, + "id": { + "target": "com.amazonaws.bedrockagent#PromptId", + "traits": { + "smithy.api#documentation": "The unique identifier of the prompt.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.bedrockagent#PromptArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the prompt.
", + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.bedrockagent#Version", + "traits": { + "smithy.api#documentation": "The version of the prompt. When you update a prompt, the version updated is the DRAFT
version.
The time at which the prompt was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time at which the prompt was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#Url": { + "type": "string", + "traits": { + "smithy.api#pattern": "^https?://[A-Za-z0-9][^\\s]*$" + } + }, + "com.amazonaws.bedrockagent#UrlConfiguration": { + "type": "structure", + "members": { + "seedUrls": { + "target": "com.amazonaws.bedrockagent#SeedUrls", + "traits": { + "smithy.api#documentation": "One or more seed or starting point URLs.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration of web URLs that you want to crawl. \n You should be authorized to crawl the URLs.
" + } + }, + "com.amazonaws.bedrockagent#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrockagent#NonBlankString" + }, + "fieldList": { + "target": "com.amazonaws.bedrockagent#ValidationExceptionFieldList", + "traits": { + "smithy.api#documentation": "A list of objects containing fields that caused validation errors and their corresponding validation error messages.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Input validation failed. Check your request parameters and retry the request.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.bedrockagent#ValidationExceptionField": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#NonBlankString", + "traits": { + "smithy.api#documentation": "The name of the field.
", + "smithy.api#required": {} + } + }, + "message": { + "target": "com.amazonaws.bedrockagent#NonBlankString", + "traits": { + "smithy.api#documentation": "A message describing why this field failed validation.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Stores information about a field passed inside a request that resulted in an validation error.
" + } + }, + "com.amazonaws.bedrockagent#ValidationExceptionFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#ValidationExceptionField" + } + }, + "com.amazonaws.bedrockagent#VectorIngestionConfiguration": { + "type": "structure", + "members": { + "chunkingConfiguration": { + "target": "com.amazonaws.bedrockagent#ChunkingConfiguration", + "traits": { + "smithy.api#documentation": "Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.
" + } + }, + "customTransformationConfiguration": { + "target": "com.amazonaws.bedrockagent#CustomTransformationConfiguration", + "traits": { + "smithy.api#documentation": "A custom document transformer for parsed data source documents.
" + } + }, + "parsingConfiguration": { + "target": "com.amazonaws.bedrockagent#ParsingConfiguration", + "traits": { + "smithy.api#documentation": "A custom parser for data source documents.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about how to ingest the documents in a data source.
" + } + }, + "com.amazonaws.bedrockagent#VectorKnowledgeBaseConfiguration": { + "type": "structure", + "members": { + "embeddingModelArn": { + "target": "com.amazonaws.bedrockagent#BedrockEmbeddingModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model used to create vector embeddings for the knowledge base.
", + "smithy.api#required": {} + } + }, + "embeddingModelConfiguration": { + "target": "com.amazonaws.bedrockagent#EmbeddingModelConfiguration", + "traits": { + "smithy.api#documentation": "The embeddings model configuration details for the vector model used in Knowledge Base.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about the model used to create vector embeddings for the knowledge base.
" + } + }, + "com.amazonaws.bedrockagent#Version": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + }, + "smithy.api#pattern": "^(DRAFT|[0-9]{0,4}[1-9][0-9]{0,4})$" + } + }, + "com.amazonaws.bedrockagent#VersionResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrockagent#DeleteAgentVersion" + }, + { + "target": "com.amazonaws.bedrockagent#GetAgentVersion" + }, + { + "target": "com.amazonaws.bedrockagent#ListAgentVersions" + } + ] + }, + "com.amazonaws.bedrockagent#WebCrawlerConfiguration": { + "type": "structure", + "members": { + "crawlerLimits": { + "target": "com.amazonaws.bedrockagent#WebCrawlerLimits", + "traits": { + "smithy.api#documentation": "The configuration of crawl limits for the web URLs.
" + } + }, + "inclusionFilters": { + "target": "com.amazonaws.bedrockagent#FilterList", + "traits": { + "smithy.api#documentation": "A list of one or more inclusion regular expression patterns to include \n certain URLs. If you specify an inclusion and exclusion filter/pattern \n and both match a URL, the exclusion filter takes precedence and the web \n content of the URL isn’t crawled.
" + } + }, + "exclusionFilters": { + "target": "com.amazonaws.bedrockagent#FilterList", + "traits": { + "smithy.api#documentation": "A list of one or more exclusion regular expression patterns to exclude \n certain URLs. If you specify an inclusion and exclusion filter/pattern \n and both match a URL, the exclusion filter takes precedence and the web \n content of the URL isn’t crawled.
" + } + }, + "scope": { + "target": "com.amazonaws.bedrockagent#WebScopeType", + "traits": { + "smithy.api#documentation": "The scope of what is crawled for your URLs.
\nYou can choose to crawl only web pages that belong to the same host or primary \n domain. For example, only web pages that contain the seed URL \n \"https://docs.aws.amazon.com/bedrock/latest/userguide/\" and no other domains. \n You can choose to include sub domains in addition to the host or primary domain. \n For example, web pages that contain \"aws.amazon.com\" can also include sub domain \n \"docs.aws.amazon.com\".
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration of web URLs that you want to crawl. \n You should be authorized to crawl the URLs.
" + } + }, + "com.amazonaws.bedrockagent#WebCrawlerLimits": { + "type": "structure", + "members": { + "rateLimit": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The max rate at which pages are crawled, up to 300 per minute per host.
", + "smithy.api#range": { + "min": 1, + "max": 300 + } + } + } + }, + "traits": { + "smithy.api#documentation": "The rate limits for the URLs that you want to crawl. \n You should be authorized to crawl the URLs.
" + } + }, + "com.amazonaws.bedrockagent#WebDataSourceConfiguration": { + "type": "structure", + "members": { + "sourceConfiguration": { + "target": "com.amazonaws.bedrockagent#WebSourceConfiguration", + "traits": { + "smithy.api#documentation": "The source configuration details for the web data source.
", + "smithy.api#required": {} + } + }, + "crawlerConfiguration": { + "target": "com.amazonaws.bedrockagent#WebCrawlerConfiguration", + "traits": { + "smithy.api#documentation": "The Web Crawler configuration details for the web data source.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration details for the web data source.
" + } + }, + "com.amazonaws.bedrockagent#WebScopeType": { + "type": "enum", + "members": { + "HOST_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HOST_ONLY" + } + }, + "SUBDOMAINS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUBDOMAINS" + } + } + } + }, + "com.amazonaws.bedrockagent#WebSourceConfiguration": { + "type": "structure", + "members": { + "urlConfiguration": { + "target": "com.amazonaws.bedrockagent#UrlConfiguration", + "traits": { + "smithy.api#documentation": "The configuration of the URL/URLs.
", + "smithy.api#required": {} + } } + }, + "traits": { + "smithy.api#documentation": "The configuration of the URL/URLs for the web content that you want \n to crawl. You should be authorized to crawl the URLs.
" + } } -} \ No newline at end of file + } +}