From 52a10ac239cc1aab2d070fbb004f6445ca0ddcc0 Mon Sep 17 00:00:00 2001 From: AWS SDK for Go v2 automation user Date: Wed, 10 Jul 2024 18:41:17 +0000 Subject: [PATCH] Update API model --- codegen/sdk-codegen/aws-models/batch.json | 54 +- .../aws-models/bedrock-agent-runtime.json | 1395 +- .../sdk-codegen/aws-models/bedrock-agent.json | 11090 ++++++++++++---- .../aws-models/bedrock-runtime.json | 485 +- codegen/sdk-codegen/aws-models/bedrock.json | 171 +- codegen/sdk-codegen/aws-models/ec2.json | 65 +- codegen/sdk-codegen/aws-models/glue.json | 163 +- .../sdk-codegen/aws-models/groundstation.json | 2 +- .../license-manager-linux-subscriptions.json | 771 +- .../sdk-codegen/aws-models/mediaconnect.json | 41 + 10 files changed, 11194 insertions(+), 3043 deletions(-) diff --git a/codegen/sdk-codegen/aws-models/batch.json b/codegen/sdk-codegen/aws-models/batch.json index 2e47a6a4466..d8b89bb51d9 100644 --- a/codegen/sdk-codegen/aws-models/batch.json +++ b/codegen/sdk-codegen/aws-models/batch.json @@ -4024,6 +4024,12 @@ "smithy.api#documentation": "

The details for the init containers.

" } }, + "eksClusterArn": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon EKS cluster.

" + } + }, "podName": { "target": "com.amazonaws.batch#String", "traits": { @@ -6499,6 +6505,12 @@ "traits": { "smithy.api#documentation": "

An object that contains the instance types that you want to replace for the existing\n resources of a job.

" } + }, + "eksPropertiesOverride": { + "target": "com.amazonaws.batch#EksPropertiesOverride", + "traits": { + "smithy.api#documentation": "

An object that contains the properties that you want to replace for the existing Amazon EKS resources of a job.

" + } } }, "traits": { @@ -6545,6 +6557,12 @@ "traits": { "smithy.api#documentation": "

This is an object that represents the properties of the node range for a multi-node parallel\n job.

" } + }, + "eksProperties": { + "target": "com.amazonaws.batch#EksProperties", + "traits": { + "smithy.api#documentation": "

This is an object that represents the properties of the node range for a multi-node parallel job.

" + } } }, "traits": { @@ -6629,14 +6647,16 @@ "smithy.api#documentation": "

Registers an Batch job definition.

", "smithy.api#examples": [ { - "title": "To register a job definition", - "documentation": "This example registers a job definition for a simple container job.", + "title": "RegisterJobDefinition with tags", + "documentation": "This demonstrates calling the RegisterJobDefinition action, including tags.", "input": { + "jobDefinitionName": "sleep30", + "type": "container", "containerProperties": { "image": "busybox", "command": [ "sleep", - "10" + "30" ], "resourceRequirements": [ { @@ -6649,26 +6669,26 @@ } ] }, - "type": "container", - "jobDefinitionName": "sleep10" + "tags": { + "Department": "Engineering", + "User": "JaneDoe" + } }, "output": { - "jobDefinitionName": "sleep10", - "jobDefinitionArn": "arn:aws:batch:us-east-1:012345678910:job-definition/sleep10:1", + "jobDefinitionName": "sleep30", + "jobDefinitionArn": "arn:aws:batch:us-east-1:012345678910:job-definition/sleep30:1", "revision": 1 } }, { - "title": "RegisterJobDefinition with tags", - "documentation": "This demonstrates calling the RegisterJobDefinition action, including tags.", + "title": "To register a job definition", + "documentation": "This example registers a job definition for a simple container job.", "input": { - "jobDefinitionName": "sleep30", - "type": "container", "containerProperties": { "image": "busybox", "command": [ "sleep", - "30" + "10" ], "resourceRequirements": [ { @@ -6681,14 +6701,12 @@ } ] }, - "tags": { - "Department": "Engineering", - "User": "JaneDoe" - } + "type": "container", + "jobDefinitionName": "sleep10" }, "output": { - "jobDefinitionName": "sleep30", - "jobDefinitionArn": "arn:aws:batch:us-east-1:012345678910:job-definition/sleep30:1", + "jobDefinitionName": "sleep10", + "jobDefinitionArn": "arn:aws:batch:us-east-1:012345678910:job-definition/sleep10:1", "revision": 1 } } diff --git a/codegen/sdk-codegen/aws-models/bedrock-agent-runtime.json b/codegen/sdk-codegen/aws-models/bedrock-agent-runtime.json index f6881f207b9..24ceb9b0788 100644 --- a/codegen/sdk-codegen/aws-models/bedrock-agent-runtime.json +++ b/codegen/sdk-codegen/aws-models/bedrock-agent-runtime.json @@ -52,6 +52,18 @@ "traits": { "smithy.api#documentation": "

The function in the action group to call.

" } + }, + "executionType": { + "target": "com.amazonaws.bedrockagentruntime#ExecutionType", + "traits": { + "smithy.api#documentation": "

How fulfillment of the action is handled. For more information, see Handling fulfillment of the action.

" + } + }, + "invocationId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The unique identifier of the invocation. Only returned if the executionType is RETURN_CONTROL.

" + } } }, "traits": { @@ -137,9 +149,15 @@ "type": "service", "version": "2023-07-26", "resources": [ + { + "target": "com.amazonaws.bedrockagentruntime#FlowResource" + }, { "target": "com.amazonaws.bedrockagentruntime#InferenceResource" }, + { + "target": "com.amazonaws.bedrockagentruntime#MemoryResource" + }, { "target": "com.amazonaws.bedrockagentruntime#RetrieveAndGenerateResource" }, @@ -1053,6 +1071,28 @@ "smithy.api#documentation": "

This property contains the document to chat with, along with its attributes.

" } }, + "com.amazonaws.bedrockagentruntime#ByteContentFile": { + "type": "structure", + "members": { + "mediaType": { + "target": "com.amazonaws.bedrockagentruntime#MimeType", + "traits": { + "smithy.api#documentation": "

The MIME type of data contained in the file used for chat.

", + "smithy.api#required": {} + } + }, + "data": { + "target": "com.amazonaws.bedrockagentruntime#ByteContentBlob", + "traits": { + "smithy.api#documentation": "

The byte value of the file to attach, encoded as Base-64 string. The maximum size of all files that is attached is 10MB. You can attach a maximum of 5 files.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The property contains the file to chat with, along with its attributes.

" + } + }, "com.amazonaws.bedrockagentruntime#Citation": { "type": "structure", "members": { @@ -1079,6 +1119,58 @@ "target": "com.amazonaws.bedrockagentruntime#Citation" } }, + "com.amazonaws.bedrockagentruntime#CodeInterpreterInvocationInput": { + "type": "structure", + "members": { + "code": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The code for the code interpreter to use.

" + } + }, + "files": { + "target": "com.amazonaws.bedrockagentruntime#Files", + "traits": { + "smithy.api#documentation": "

Files that are uploaded for code interpreter to use.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about the code interpreter being invoked.

" + } + }, + "com.amazonaws.bedrockagentruntime#CodeInterpreterInvocationOutput": { + "type": "structure", + "members": { + "executionOutput": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

Contains the successful output returned from code execution

" + } + }, + "executionError": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

Contains the error returned from code execution.

" + } + }, + "files": { + "target": "com.amazonaws.bedrockagentruntime#Files", + "traits": { + "smithy.api#documentation": "

Contains output files, if generated by code execution.

" + } + }, + "executionTimeout": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates if the execution of the code timed out.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the JSON-formatted string returned by the API invoked by the code interpreter.

" + } + }, "com.amazonaws.bedrockagentruntime#ConflictException": { "type": "structure", "members": { @@ -1138,6 +1230,98 @@ } } }, + "com.amazonaws.bedrockagentruntime#DateTimestamp": { + "type": "timestamp", + "traits": { + "smithy.api#documentation": "Time Stamp.", + "smithy.api#timestampFormat": "date-time" + } + }, + "com.amazonaws.bedrockagentruntime#DeleteAgentMemory": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentruntime#DeleteAgentMemoryRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentruntime#DeleteAgentMemoryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#BadGatewayException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#DependencyFailedException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes memory from the specified memory identifier.

", + "smithy.api#http": { + "code": 202, + "method": "DELETE", + "uri": "/agents/{agentId}/agentAliases/{agentAliasId}/memories" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockagentruntime#DeleteAgentMemoryRequest": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagentruntime#AgentId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the agent to which the alias belongs.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentAliasId": { + "target": "com.amazonaws.bedrockagentruntime#AgentAliasId", + "traits": { + "smithy.api#documentation": "

The unique identifier of an alias of an agent.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "memoryId": { + "target": "com.amazonaws.bedrockagentruntime#MemoryId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the memory.

", + "smithy.api#httpQuery": "memoryId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentruntime#DeleteAgentMemoryResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.bedrockagentruntime#DependencyFailedException": { "type": "structure", "members": { @@ -1157,6 +1341,23 @@ "smithy.api#httpError": 424 } }, + "com.amazonaws.bedrockagentruntime#ExecutionType": { + "type": "enum", + "members": { + "LAMBDA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LAMBDA" + } + }, + "RETURN_CONTROL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RETURN_CONTROL" + } + } + } + }, "com.amazonaws.bedrockagentruntime#ExternalSource": { "type": "structure", "members": { @@ -1300,6 +1501,96 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.bedrockagentruntime#FileBody": { + "type": "blob", + "traits": { + "smithy.api#length": { + "max": 1000000 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#FilePart": { + "type": "structure", + "members": { + "files": { + "target": "com.amazonaws.bedrockagentruntime#OutputFiles", + "traits": { + "smithy.api#documentation": "

Files containing intermediate response for the user.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains intermediate response for code interpreter if any files have been generated.

" + } + }, + "com.amazonaws.bedrockagentruntime#FileSource": { + "type": "structure", + "members": { + "sourceType": { + "target": "com.amazonaws.bedrockagentruntime#FileSourceType", + "traits": { + "smithy.api#documentation": "

The source type of the files to attach.

", + "smithy.api#required": {} + } + }, + "s3Location": { + "target": "com.amazonaws.bedrockagentruntime#S3ObjectFile", + "traits": { + "smithy.api#documentation": "

The s3 location of the files to attach.

" + } + }, + "byteContent": { + "target": "com.amazonaws.bedrockagentruntime#ByteContentFile", + "traits": { + "smithy.api#documentation": "

The data and the text of the attached files.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The source file of the content contained in the wrapper object.

" + } + }, + "com.amazonaws.bedrockagentruntime#FileSourceType": { + "type": "enum", + "members": { + "S3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3" + } + }, + "BYTE_CONTENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BYTE_CONTENT" + } + } + } + }, + "com.amazonaws.bedrockagentruntime#FileUseCase": { + "type": "enum", + "members": { + "CODE_INTERPRETER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CODE_INTERPRETER" + } + }, + "CHAT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CHAT" + } + } + } + }, + "com.amazonaws.bedrockagentruntime#Files": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, "com.amazonaws.bedrockagentruntime#FilterAttribute": { "type": "structure", "members": { @@ -1354,46 +1645,274 @@ "smithy.api#sensitive": {} } }, - "com.amazonaws.bedrockagentruntime#Function": { + "com.amazonaws.bedrockagentruntime#FlowAliasIdentifier": { "type": "string", "traits": { - "smithy.api#sensitive": {} + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10}/alias/[0-9a-zA-Z]{10})|(\\bTSTALIASID\\b|[0-9a-zA-Z]+)$" } }, - "com.amazonaws.bedrockagentruntime#FunctionInvocationInput": { + "com.amazonaws.bedrockagentruntime#FlowCompletionEvent": { "type": "structure", "members": { - "actionGroup": { - "target": "smithy.api#String", + "completionReason": { + "target": "com.amazonaws.bedrockagentruntime#FlowCompletionReason", "traits": { - "smithy.api#documentation": "

The action group that the function belongs to.

", + "smithy.api#documentation": "

The reason that the flow completed.

", "smithy.api#required": {} } - }, - "parameters": { - "target": "com.amazonaws.bedrockagentruntime#FunctionParameters", - "traits": { - "smithy.api#documentation": "

A list of parameters of the function.

" - } - }, - "function": { - "target": "smithy.api#String", + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about why a flow completed.

\n

This data type is used in the following API operations:

\n ", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#FlowCompletionReason": { + "type": "enum", + "members": { + "SUCCESS": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The name of the function.

" + "smithy.api#enumValue": "SUCCESS" } } - }, + } + }, + "com.amazonaws.bedrockagentruntime#FlowIdentifier": { + "type": "string", "traits": { - "smithy.api#documentation": "

Contains information about the function that the agent predicts should be called.

\n

This data type is used in the following API operations:

\n " + "smithy.api#length": { + "max": 2048 + }, + "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.bedrockagentruntime#FunctionParameter": { + "com.amazonaws.bedrockagentruntime#FlowInput": { "type": "structure", "members": { - "name": { - "target": "smithy.api#String", + "nodeName": { + "target": "com.amazonaws.bedrockagentruntime#NodeName", "traits": { - "smithy.api#documentation": "

The name of the parameter.

" + "smithy.api#documentation": "

A name for the input of the flow input node.

", + "smithy.api#required": {} + } + }, + "nodeOutputName": { + "target": "com.amazonaws.bedrockagentruntime#NodeOutputName", + "traits": { + "smithy.api#documentation": "

A name for the output of the flow input node.

", + "smithy.api#required": {} + } + }, + "content": { + "target": "com.amazonaws.bedrockagentruntime#FlowInputContent", + "traits": { + "smithy.api#documentation": "

Contains information about an input into the flow.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about an input into the flow and what to do with it.

\n

This data type is used in the following API operations:

\n " + } + }, + "com.amazonaws.bedrockagentruntime#FlowInputContent": { + "type": "union", + "members": { + "document": { + "target": "smithy.api#Document", + "traits": { + "smithy.api#documentation": "

The input for the flow input node.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about an input into the flow.

\n

This data type is used in the following API operations:

\n ", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#FlowInputs": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#FlowInput" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.bedrockagentruntime#FlowOutputContent": { + "type": "union", + "members": { + "document": { + "target": "smithy.api#Document", + "traits": { + "smithy.api#documentation": "

A name for the output of the flow.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about the output node.

\n

This data type is used in the following API operations:

\n " + } + }, + "com.amazonaws.bedrockagentruntime#FlowOutputEvent": { + "type": "structure", + "members": { + "nodeName": { + "target": "com.amazonaws.bedrockagentruntime#NodeName", + "traits": { + "smithy.api#documentation": "

The name of the node to which input was provided.

", + "smithy.api#required": {} + } + }, + "nodeType": { + "target": "com.amazonaws.bedrockagentruntime#NodeType", + "traits": { + "smithy.api#documentation": "

The type of node to which input was provided.

", + "smithy.api#required": {} + } + }, + "content": { + "target": "com.amazonaws.bedrockagentruntime#FlowOutputContent", + "traits": { + "smithy.api#documentation": "

The output of the node.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about an output from flow invoction.

\n

This data type is used in the following API operations:

\n ", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#FlowResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrockagentruntime#InvokeFlow" + } + ] + }, + "com.amazonaws.bedrockagentruntime#FlowResponseStream": { + "type": "union", + "members": { + "flowOutputEvent": { + "target": "com.amazonaws.bedrockagentruntime#FlowOutputEvent", + "traits": { + "smithy.api#documentation": "

Contains information about an output from flow invocation.

" + } + }, + "flowCompletionEvent": { + "target": "com.amazonaws.bedrockagentruntime#FlowCompletionEvent", + "traits": { + "smithy.api#documentation": "

Contains information about why the flow completed.

" + } + }, + "internalServerException": { + "target": "com.amazonaws.bedrockagentruntime#InternalServerException", + "traits": { + "smithy.api#documentation": "

An internal server error occurred. Retry your request.

" + } + }, + "validationException": { + "target": "com.amazonaws.bedrockagentruntime#ValidationException", + "traits": { + "smithy.api#documentation": "

Input validation failed. Check your request parameters and retry the request.

" + } + }, + "resourceNotFoundException": { + "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException", + "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.

" + } + }, + "serviceQuotaExceededException": { + "target": "com.amazonaws.bedrockagentruntime#ServiceQuotaExceededException", + "traits": { + "smithy.api#documentation": "

The number of requests exceeds the service quota. Resubmit your request later.

" + } + }, + "throttlingException": { + "target": "com.amazonaws.bedrockagentruntime#ThrottlingException", + "traits": { + "smithy.api#documentation": "

The number of requests exceeds the limit. Resubmit your request later.

" + } + }, + "accessDeniedException": { + "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException", + "traits": { + "smithy.api#documentation": "

The request is denied because of missing access permissions. Check your permissions and retry your request.

" + } + }, + "conflictException": { + "target": "com.amazonaws.bedrockagentruntime#ConflictException", + "traits": { + "smithy.api#documentation": "

There was a conflict performing an operation. Resolve the conflict and retry your request.

" + } + }, + "dependencyFailedException": { + "target": "com.amazonaws.bedrockagentruntime#DependencyFailedException", + "traits": { + "smithy.api#documentation": "

There was an issue with a dependency. Check the resource configurations and retry the request.

" + } + }, + "badGatewayException": { + "target": "com.amazonaws.bedrockagentruntime#BadGatewayException", + "traits": { + "smithy.api#documentation": "

There was an issue with a dependency due to a server issue. Retry your request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The output of the flow.

\n

This data type is used in the following API operations:

\n ", + "smithy.api#streaming": {} + } + }, + "com.amazonaws.bedrockagentruntime#Function": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#FunctionInvocationInput": { + "type": "structure", + "members": { + "actionGroup": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The action group that the function belongs to.

", + "smithy.api#required": {} + } + }, + "parameters": { + "target": "com.amazonaws.bedrockagentruntime#FunctionParameters", + "traits": { + "smithy.api#documentation": "

A list of parameters of the function.

" + } + }, + "function": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the function.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about the function that the agent predicts should be called.

\n

This data type is used in the following API operations:

\n " + } + }, + "com.amazonaws.bedrockagentruntime#FunctionParameter": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the parameter.

" } }, "type": { @@ -1484,18 +2003,145 @@ "inferenceConfig": { "target": "com.amazonaws.bedrockagentruntime#InferenceConfig", "traits": { - "smithy.api#documentation": "

Configuration settings for inference when using RetrieveAndGenerate to generate responses while using a knowledge base as a source.

" + "smithy.api#documentation": "

Configuration settings for inference when using RetrieveAndGenerate to generate responses while using a knowledge base as a source.

" + } + }, + "additionalModelRequestFields": { + "target": "com.amazonaws.bedrockagentruntime#AdditionalModelRequestFields", + "traits": { + "smithy.api#documentation": "

Additional model parameters and corresponding values not included in the textInferenceConfig structure for a knowledge base. This allows users to provide custom model parameters specific to the language model being used.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains configurations for response generation based on the knowledge base query results.

\n

This data type is used in the following API operations:

\n " + } + }, + "com.amazonaws.bedrockagentruntime#GetAgentMemory": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentruntime#GetAgentMemoryRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentruntime#GetAgentMemoryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#BadGatewayException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#DependencyFailedException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the sessions stored in the memory of the agent.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/agents/{agentId}/agentAliases/{agentAliasId}/memories" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxItems", + "items": "memoryContents" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentruntime#GetAgentMemoryRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.bedrockagentruntime#NextToken", + "traits": { + "smithy.api#documentation": "

If the total number of results is greater than the maxItems value provided in the request, enter the token returned \n in the nextToken field in the response in this field to return the next batch of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxItems": { + "target": "com.amazonaws.bedrockagentruntime#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return in the response. If the total number of results is greater \n than this value, use the token returned in the response in the nextToken field when making another \n request to return the next batch of results.

", + "smithy.api#httpQuery": "maxItems" + } + }, + "agentId": { + "target": "com.amazonaws.bedrockagentruntime#AgentId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the agent to which the alias belongs.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "agentAliasId": { + "target": "com.amazonaws.bedrockagentruntime#AgentAliasId", + "traits": { + "smithy.api#documentation": "

The unique identifier of an alias of an agent.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "memoryType": { + "target": "com.amazonaws.bedrockagentruntime#MemoryType", + "traits": { + "smithy.api#documentation": "

The type of memory.

", + "smithy.api#httpQuery": "memoryType", + "smithy.api#required": {} + } + }, + "memoryId": { + "target": "com.amazonaws.bedrockagentruntime#MemoryId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the memory.

", + "smithy.api#httpQuery": "memoryId", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentruntime#GetAgentMemoryResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.bedrockagentruntime#NextToken", + "traits": { + "smithy.api#documentation": "

If the total number of results is greater than the maxItems value provided in the request, use this token \n when making another request in the nextToken field to return the next batch of results.

" } }, - "additionalModelRequestFields": { - "target": "com.amazonaws.bedrockagentruntime#AdditionalModelRequestFields", + "memoryContents": { + "target": "com.amazonaws.bedrockagentruntime#Memories", "traits": { - "smithy.api#documentation": "

Additional model parameters and corresponding values not included in the textInferenceConfig structure for a knowledge base. This allows users to provide custom model parameters specific to the language model being used.

" + "smithy.api#documentation": "

Contains details of the sessions stored in the memory

" } } }, "traits": { - "smithy.api#documentation": "

Contains configurations for response generation based on the knowledge base query results.

\n

This data type is used in the following API operations:

\n " + "smithy.api#output": {} } }, "com.amazonaws.bedrockagentruntime#GuadrailAction": { @@ -2326,6 +2972,41 @@ } ] }, + "com.amazonaws.bedrockagentruntime#InputFile": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the source file.

", + "smithy.api#required": {} + } + }, + "source": { + "target": "com.amazonaws.bedrockagentruntime#FileSource", + "traits": { + "smithy.api#documentation": "

Specifies where the files are located.

", + "smithy.api#required": {} + } + }, + "useCase": { + "target": "com.amazonaws.bedrockagentruntime#FileUseCase", + "traits": { + "smithy.api#documentation": "

Specifies how the source files will be used by the code interpreter.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains details of the source files.

" + } + }, + "com.amazonaws.bedrockagentruntime#InputFiles": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#InputFile" + } + }, "com.amazonaws.bedrockagentruntime#InputText": { "type": "string", "traits": { @@ -2374,6 +3055,12 @@ "traits": { "smithy.api#documentation": "

Contains details about the knowledge base to look up and the query to be made.

" } + }, + "codeInterpreterInvocationInput": { + "target": "com.amazonaws.bedrockagentruntime#CodeInterpreterInvocationInput", + "traits": { + "smithy.api#documentation": "

Contains information about the code interpreter to be invoked.

" + } } }, "traits": { @@ -2453,6 +3140,12 @@ "traits": { "smithy.api#enumValue": "FINISH" } + }, + "ACTION_GROUP_CODE_INTERPRETER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTION_GROUP_CODE_INTERPRETER" + } } } }, @@ -2494,7 +3187,7 @@ } ], "traits": { - "smithy.api#documentation": "\n

The CLI doesn't support InvokeAgent.

\n \n

Sends a prompt for the agent to process and respond to. Note the following fields for the request:

\n \n

The response is returned in the bytes field of the chunk object.

\n ", + "smithy.api#documentation": "\n

The CLI doesn't support streaming operations in Amazon Bedrock, including InvokeAgent.

\n \n

Sends a prompt for the agent to process and respond to. Note the following fields for the request:

\n \n

The response is returned in the bytes field of the chunk object.

\n ", "smithy.api#http": { "code": 200, "method": "POST", @@ -2552,6 +3245,12 @@ "traits": { "smithy.api#documentation": "

The prompt text to send the agent.

\n \n

If you include returnControlInvocationResults in the sessionState field, the inputText field will be ignored.

\n " } + }, + "memoryId": { + "target": "com.amazonaws.bedrockagentruntime#MemoryId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the agent memory.

" + } } }, "traits": { @@ -2584,6 +3283,106 @@ "smithy.api#httpHeader": "x-amz-bedrock-agent-session-id", "smithy.api#required": {} } + }, + "memoryId": { + "target": "com.amazonaws.bedrockagentruntime#MemoryId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the agent memory.

", + "smithy.api#httpHeader": "x-amz-bedrock-agent-memory-id" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentruntime#InvokeFlow": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentruntime#InvokeFlowRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentruntime#InvokeFlowResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#BadGatewayException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#DependencyFailedException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Invokes an alias of a flow to run the inputs that you specify and return the output of each node as a stream. If there's an error, the error is returned. For more information, see Test a flow in Amazon Bedrock in the Amazon Bedrock User Guide.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/flows/{flowIdentifier}/aliases/{flowAliasIdentifier}" + } + } + }, + "com.amazonaws.bedrockagentruntime#InvokeFlowRequest": { + "type": "structure", + "members": { + "flowIdentifier": { + "target": "com.amazonaws.bedrockagentruntime#FlowIdentifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the flow.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "flowAliasIdentifier": { + "target": "com.amazonaws.bedrockagentruntime#FlowAliasIdentifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the flow alias.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "inputs": { + "target": "com.amazonaws.bedrockagentruntime#FlowInputs", + "traits": { + "smithy.api#documentation": "

A list of objects, each containing information about an input into the flow.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentruntime#InvokeFlowResponse": { + "type": "structure", + "members": { + "responseStream": { + "target": "com.amazonaws.bedrockagentruntime#FlowResponseStream", + "traits": { + "smithy.api#documentation": "

The output of the flow, returned as a stream. If there's an error, the error is returned.

", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } } }, "traits": { @@ -2600,6 +3399,39 @@ "smithy.api#pattern": "^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$" } }, + "com.amazonaws.bedrockagentruntime#KnowledgeBaseConfiguration": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseId", + "traits": { + "smithy.api#documentation": "

The unique identifier for a knowledge base attached to the agent.

", + "smithy.api#required": {} + } + }, + "retrievalConfiguration": { + "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseRetrievalConfiguration", + "traits": { + "smithy.api#documentation": "

The configurations to apply to the knowledge base during query. For more information, see Query configurations.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Configurations to apply to a knowledge base attached to the agent during query. For more information, see Knowledge base retrieval configurations.

" + } + }, + "com.amazonaws.bedrockagentruntime#KnowledgeBaseConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, "com.amazonaws.bedrockagentruntime#KnowledgeBaseId": { "type": "string", "traits": { @@ -2680,7 +3512,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains configurations for the knowledge base query and retrieval process. For more information, see Query configurations.

\n

This data type is used in the following API operations:

\n " + "smithy.api#documentation": "

Contains configurations for knowledge base query. For more information, see Query configurations.

\n

This data type is used in the following API operations:

\n " } }, "com.amazonaws.bedrockagentruntime#KnowledgeBaseRetrievalResult": { @@ -2745,70 +3577,176 @@ "retrievalConfiguration": { "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseRetrievalConfiguration", "traits": { - "smithy.api#documentation": "

Contains configurations for how to retrieve and return the knowledge base query.

" + "smithy.api#documentation": "

Contains configurations for how to retrieve and return the knowledge base query.

" + } + }, + "generationConfiguration": { + "target": "com.amazonaws.bedrockagentruntime#GenerationConfiguration", + "traits": { + "smithy.api#documentation": "

Contains configurations for response generation based on the knowledge base query results.

" + } + }, + "orchestrationConfiguration": { + "target": "com.amazonaws.bedrockagentruntime#OrchestrationConfiguration", + "traits": { + "smithy.api#documentation": "

Settings for how the model processes the prompt prior to retrieval and generation.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains details about the resource being queried.

\n

This data type is used in the following API operations:

\n " + } + }, + "com.amazonaws.bedrockagentruntime#KnowledgeBaseVectorSearchConfiguration": { + "type": "structure", + "members": { + "numberOfResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": 5, + "smithy.api#documentation": "

The number of source chunks to retrieve.

", + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "overrideSearchType": { + "target": "com.amazonaws.bedrockagentruntime#SearchType", + "traits": { + "smithy.api#documentation": "

By default, Amazon Bedrock decides a search strategy for you. If you're using an Amazon OpenSearch Serverless vector store that contains a filterable text field, you can specify whether to query the knowledge base with a HYBRID search using both vector embeddings and raw text, or SEMANTIC search using only vector embeddings. For other vector store configurations, only SEMANTIC search is available. For more information, see Test a knowledge base.

" + } + }, + "filter": { + "target": "com.amazonaws.bedrockagentruntime#RetrievalFilter", + "traits": { + "smithy.api#documentation": "

Specifies the filters to use on the metadata in the knowledge base data sources before returning results. For more information, see Query configurations.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configurations for how to perform the search query and return results. For more information, see Query configurations.

\n

This data type is used in the following API operations:

\n " + } + }, + "com.amazonaws.bedrockagentruntime#LambdaArn": { + "type": "string" + }, + "com.amazonaws.bedrockagentruntime#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#documentation": "Max Results.", + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.bedrockagentruntime#MaxTokens": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 65536 + } + } + }, + "com.amazonaws.bedrockagentruntime#MaximumLength": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 4096 + } + } + }, + "com.amazonaws.bedrockagentruntime#Memories": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#Memory" + } + }, + "com.amazonaws.bedrockagentruntime#Memory": { + "type": "union", + "members": { + "sessionSummary": { + "target": "com.amazonaws.bedrockagentruntime#MemorySessionSummary", + "traits": { + "smithy.api#documentation": "

Contains summary of a session.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains sessions summaries.

" + } + }, + "com.amazonaws.bedrockagentruntime#MemoryId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 100 + }, + "smithy.api#pattern": "^[0-9a-zA-Z._:-]+$" + } + }, + "com.amazonaws.bedrockagentruntime#MemoryResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrockagentruntime#DeleteAgentMemory" + }, + { + "target": "com.amazonaws.bedrockagentruntime#GetAgentMemory" + } + ] + }, + "com.amazonaws.bedrockagentruntime#MemorySessionSummary": { + "type": "structure", + "members": { + "memoryId": { + "target": "com.amazonaws.bedrockagentruntime#MemoryId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the memory where the session summary is stored.

" } }, - "generationConfiguration": { - "target": "com.amazonaws.bedrockagentruntime#GenerationConfiguration", + "sessionId": { + "target": "com.amazonaws.bedrockagentruntime#SessionId", "traits": { - "smithy.api#documentation": "

Contains configurations for response generation based on the knowwledge base query results.

" + "smithy.api#documentation": "

The identifier for this session.

" } - } - }, - "traits": { - "smithy.api#documentation": "

Contains details about the resource being queried.

\n

This data type is used in the following API operations:

\n " - } - }, - "com.amazonaws.bedrockagentruntime#KnowledgeBaseVectorSearchConfiguration": { - "type": "structure", - "members": { - "numberOfResults": { - "target": "smithy.api#Integer", + }, + "sessionStartTime": { + "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", "traits": { - "smithy.api#addedDefault": {}, - "smithy.api#default": 5, - "smithy.api#documentation": "

The number of source chunks to retrieve.

", - "smithy.api#range": { - "min": 1, - "max": 100 - } + "smithy.api#documentation": "

The start time for this session.

" } }, - "overrideSearchType": { - "target": "com.amazonaws.bedrockagentruntime#SearchType", + "sessionExpiryTime": { + "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", "traits": { - "smithy.api#documentation": "

By default, Amazon Bedrock decides a search strategy for you. If you're using an Amazon OpenSearch Serverless vector store that contains a filterable text field, you can specify whether to query the knowledge base with a HYBRID search using both vector embeddings and raw text, or SEMANTIC search using only vector embeddings. For other vector store configurations, only SEMANTIC search is available. For more information, see Test a knowledge base.

" + "smithy.api#documentation": "

The time when the memory duration for the session is set to end.

" } }, - "filter": { - "target": "com.amazonaws.bedrockagentruntime#RetrievalFilter", + "summaryText": { + "target": "com.amazonaws.bedrockagentruntime#SummaryText", "traits": { - "smithy.api#documentation": "

Specifies the filters to use on the metadata in the knowledge base data sources before returning results. For more information, see Query configurations.

" + "smithy.api#documentation": "

The summarized text for this session.

" } } }, "traits": { - "smithy.api#documentation": "

Configurations for how to perform the search query and return results. For more information, see Query configurations.

\n

This data type is used in the following API operations:

\n " - } - }, - "com.amazonaws.bedrockagentruntime#LambdaArn": { - "type": "string" - }, - "com.amazonaws.bedrockagentruntime#MaxTokens": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0, - "max": 65536 - } + "smithy.api#documentation": "

Contains details of a session summary.

" } }, - "com.amazonaws.bedrockagentruntime#MaximumLength": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0, - "max": 4096 + "com.amazonaws.bedrockagentruntime#MemoryType": { + "type": "enum", + "members": { + "SESSION_SUMMARY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SESSION_SUMMARY" + } } } }, @@ -2876,6 +3814,65 @@ "smithy.api#pattern": "^\\S*$" } }, + "com.amazonaws.bedrockagentruntime#NodeName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){0,99}$" + } + }, + "com.amazonaws.bedrockagentruntime#NodeOutputName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){0,99}$" + } + }, + "com.amazonaws.bedrockagentruntime#NodeType": { + "type": "enum", + "members": { + "FLOW_INPUT_NODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FlowInputNode" + } + }, + "FLOW_OUTPUT_NODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FlowOutputNode" + } + }, + "LAMBDA_FUNCTION_NODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LambdaFunctionNode" + } + }, + "KNOWLEDGE_BASE_NODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KnowledgeBaseNode" + } + }, + "PROMPT_NODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PromptNode" + } + }, + "CONDITION_NODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ConditionNode" + } + }, + "LEX_NODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LexNode" + } + } + } + }, "com.amazonaws.bedrockagentruntime#NonBlankString": { "type": "string", "traits": { @@ -2920,6 +3917,12 @@ "traits": { "smithy.api#documentation": "

Contains details about the response to reprompt the input.

" } + }, + "codeInterpreterInvocationOutput": { + "target": "com.amazonaws.bedrockagentruntime#CodeInterpreterInvocationOutput", + "traits": { + "smithy.api#documentation": "

Contains the JSON-formatted string returned by the API invoked by the code interpreter.

" + } } }, "traits": { @@ -2927,6 +3930,21 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.bedrockagentruntime#OrchestrationConfiguration": { + "type": "structure", + "members": { + "queryTransformationConfiguration": { + "target": "com.amazonaws.bedrockagentruntime#QueryTransformationConfiguration", + "traits": { + "smithy.api#documentation": "

To split up the prompt and retrieve multiple sources, set the transformation type to\n QUERY_DECOMPOSITION.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Settings for how the model processes the prompt prior to retrieval and generation.

" + } + }, "com.amazonaws.bedrockagentruntime#OrchestrationTrace": { "type": "union", "members": { @@ -2960,6 +3978,45 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.bedrockagentruntime#OutputFile": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the file containing response from code interpreter.

" + } + }, + "type": { + "target": "com.amazonaws.bedrockagentruntime#MimeType", + "traits": { + "smithy.api#documentation": "

The type of file that contains response from the code interpreter.

" + } + }, + "bytes": { + "target": "com.amazonaws.bedrockagentruntime#FileBody", + "traits": { + "smithy.api#documentation": "

The byte count of files that contains response from code interpreter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains details of the response from code interpreter.

", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#OutputFiles": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#OutputFile" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, "com.amazonaws.bedrockagentruntime#OutputString": { "type": "string", "traits": { @@ -3226,6 +4283,32 @@ "smithy.api#documentation": "

Contains the parameters in the request body.

" } }, + "com.amazonaws.bedrockagentruntime#QueryTransformationConfiguration": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrockagentruntime#QueryTransformationType", + "traits": { + "smithy.api#documentation": "

The type of transformation to apply to the prompt.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

To split up the prompt and retrieve multiple sources, set the transformation type to\n QUERY_DECOMPOSITION.

" + } + }, + "com.amazonaws.bedrockagentruntime#QueryTransformationType": { + "type": "enum", + "members": { + "QUERY_DECOMPOSITION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUERY_DECOMPOSITION" + } + } + } + }, "com.amazonaws.bedrockagentruntime#RAGStopSequences": { "type": "list", "member": { @@ -3419,6 +4502,12 @@ "traits": { "smithy.api#documentation": "

There was an issue with a dependency due to a server issue. Retry your request.

" } + }, + "files": { + "target": "com.amazonaws.bedrockagentruntime#FilePart", + "traits": { + "smithy.api#documentation": "

Contains intermediate response for code interpreter if any files have been generated.

" + } } }, "traits": { @@ -3525,6 +4614,20 @@ } } }, + "com.amazonaws.bedrockagentruntime#RetrievalResultConfluenceLocation": { + "type": "structure", + "members": { + "url": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Confluence host URL for the data source location.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The Confluence data source location.

" + } + }, "com.amazonaws.bedrockagentruntime#RetrievalResultContent": { "type": "structure", "members": { @@ -3547,19 +4650,43 @@ "type": { "target": "com.amazonaws.bedrockagentruntime#RetrievalResultLocationType", "traits": { - "smithy.api#documentation": "

The type of the location of the data source.

", + "smithy.api#documentation": "

The type of data source location.

", "smithy.api#required": {} } }, "s3Location": { "target": "com.amazonaws.bedrockagentruntime#RetrievalResultS3Location", "traits": { - "smithy.api#documentation": "

Contains the S3 location of the data source.

" + "smithy.api#documentation": "

The S3 data source location.

" + } + }, + "webLocation": { + "target": "com.amazonaws.bedrockagentruntime#RetrievalResultWebLocation", + "traits": { + "smithy.api#documentation": "

The web URL/URLs data source location.

" + } + }, + "confluenceLocation": { + "target": "com.amazonaws.bedrockagentruntime#RetrievalResultConfluenceLocation", + "traits": { + "smithy.api#documentation": "

The Confluence data source location.

" + } + }, + "salesforceLocation": { + "target": "com.amazonaws.bedrockagentruntime#RetrievalResultSalesforceLocation", + "traits": { + "smithy.api#documentation": "

The Salesforce data source location.

" + } + }, + "sharePointLocation": { + "target": "com.amazonaws.bedrockagentruntime#RetrievalResultSharePointLocation", + "traits": { + "smithy.api#documentation": "

The SharePoint data source location.

" } } }, "traits": { - "smithy.api#documentation": "

Contains information about the location of the data source.

\n

This data type is used in the following API operations:

\n ", + "smithy.api#documentation": "

Contains information about the data source location.

\n

This data type is used in the following API operations:

\n ", "smithy.api#sensitive": {} } }, @@ -3571,6 +4698,30 @@ "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" + } } } }, @@ -3607,12 +4758,54 @@ "uri": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The S3 URI of the data source.

" + "smithy.api#documentation": "

The S3 URI for the data source location.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The S3 data source location.

\n

This data type is used in the following API operations:

\n " + } + }, + "com.amazonaws.bedrockagentruntime#RetrievalResultSalesforceLocation": { + "type": "structure", + "members": { + "url": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Salesforce host URL for the data source location.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The Salesforce data source location.

" + } + }, + "com.amazonaws.bedrockagentruntime#RetrievalResultSharePointLocation": { + "type": "structure", + "members": { + "url": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The SharePoint site URL for the data source location.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The SharePoint data source location.

" + } + }, + "com.amazonaws.bedrockagentruntime#RetrievalResultWebLocation": { + "type": "structure", + "members": { + "url": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The web URL/URLs for the data source location.

" } } }, "traits": { - "smithy.api#documentation": "

Contains the S3 location of the data source.

\n

This data type is used in the following API operations:

\n " + "smithy.api#documentation": "

The web URL/URLs data source location.

" } }, "com.amazonaws.bedrockagentruntime#Retrieve": { @@ -3781,7 +4974,7 @@ "sessionId": { "target": "com.amazonaws.bedrockagentruntime#SessionId", "traits": { - "smithy.api#documentation": "

The unique identifier of the session. Reuse the same value to continue the same session with the knowledge base.

" + "smithy.api#documentation": "

The unique identifier of the session. When you first make a RetrieveAndGenerate request, Amazon Bedrock automatically generates this value. You must reuse this value for all subsequent requests in the same conversational session. This value allows Amazon Bedrock to maintain context and knowledge from previous interactions. You can't explicitly set the sessionId yourself.

" } }, "input": { @@ -3822,7 +5015,7 @@ "sessionId": { "target": "com.amazonaws.bedrockagentruntime#SessionId", "traits": { - "smithy.api#documentation": "

The unique identifier of the session. Reuse the same value to continue the same session with the knowledge base.

", + "smithy.api#documentation": "

The unique identifier of the session. When you first make a RetrieveAndGenerate request, Amazon Bedrock automatically generates this value. You must reuse this value for all subsequent requests in the same conversational session. This value allows Amazon Bedrock to maintain context and knowledge from previous interactions. You can't explicitly set the sessionId yourself.

", "smithy.api#required": {} } }, @@ -4026,6 +5219,21 @@ "smithy.api#documentation": "

The unique wrapper object of the document from the S3 location.

" } }, + "com.amazonaws.bedrockagentruntime#S3ObjectFile": { + "type": "structure", + "members": { + "uri": { + "target": "com.amazonaws.bedrockagentruntime#S3Uri", + "traits": { + "smithy.api#documentation": "

The uri of the s3 object.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains details of the s3 object where the source file is located.

" + } + }, "com.amazonaws.bedrockagentruntime#S3Uri": { "type": "string", "traits": { @@ -4111,6 +5319,18 @@ "traits": { "smithy.api#documentation": "

The identifier of the invocation of an action. This value must match the invocationId returned in the InvokeAgent response for the action whose results are provided in the returnControlInvocationResults field. For more information, see Return control to the agent developer and Control session context.

" } + }, + "files": { + "target": "com.amazonaws.bedrockagentruntime#InputFiles", + "traits": { + "smithy.api#documentation": "

Contains information about the files used by code interpreter.

" + } + }, + "knowledgeBaseConfigurations": { + "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseConfigurations", + "traits": { + "smithy.api#documentation": "

An array of configurations, each of which applies to a knowledge base attached to the agent.

" + } } }, "traits": { @@ -4181,6 +5401,15 @@ } } }, + "com.amazonaws.bedrockagentruntime#SummaryText": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 25000000 + } + } + }, "com.amazonaws.bedrockagentruntime#Temperature": { "type": "float", "traits": { diff --git a/codegen/sdk-codegen/aws-models/bedrock-agent.json b/codegen/sdk-codegen/aws-models/bedrock-agent.json index 9d4cbfb72ab..5a40050c6b5 100644 --- a/codegen/sdk-codegen/aws-models/bedrock-agent.json +++ b/codegen/sdk-codegen/aws-models/bedrock-agent.json @@ -82,6 +82,12 @@ "traits": { "smithy.api#enumValue": "AMAZON.UserInput" } + }, + "AMAZON_CODEINTERPRETER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AMAZON.CodeInterpreter" + } } } }, @@ -278,7 +284,13 @@ "guardrailConfiguration": { "target": "com.amazonaws.bedrockagent#GuardrailConfiguration", "traits": { - "smithy.api#documentation": "

The guardrails configuration assigned to the agent.

" + "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.

" } } }, @@ -664,6 +676,21 @@ "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": { @@ -909,7 +936,7 @@ "guardrailConfiguration": { "target": "com.amazonaws.bedrockagent#GuardrailConfiguration", "traits": { - "smithy.api#documentation": "

The details of the guardrails configuration in the agent summary.

" + "smithy.api#documentation": "

Details about the guardrail associated with the agent.

" } } }, @@ -1028,7 +1055,13 @@ "guardrailConfiguration": { "target": "com.amazonaws.bedrockagent#GuardrailConfiguration", "traits": { - "smithy.api#documentation": "

The guardrails configuration assigned to the agent version.

" + "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

" } } }, @@ -1094,7 +1127,7 @@ "guardrailConfiguration": { "target": "com.amazonaws.bedrockagent#GuardrailConfiguration", "traits": { - "smithy.api#documentation": "

The details of the guardrails configuration in the agent version summary.

" + "smithy.api#documentation": "

Details about the guardrail associated with the agent.

" } } }, @@ -1138,12 +1171,18 @@ { "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" }, @@ -1955,7 +1994,8 @@ "smithy.api#length": { "min": 1, "max": 100000 - } + }, + "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagent#BedrockEmbeddingModelArn": { @@ -1982,6 +2022,37 @@ "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": { @@ -1998,7 +2069,7 @@ "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 ", + "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 ", "smithy.api#required": {} } }, @@ -2007,6 +2078,18 @@ "traits": { "smithy.api#documentation": "

Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy as NONE, exclude this field.

" } + }, + "hierarchicalChunkingConfiguration": { + "target": "com.amazonaws.bedrockagent#HierarchicalChunkingConfiguration", + "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.

" + } + }, + "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": { @@ -2027,6 +2110,18 @@ "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" + } } } }, @@ -2037,7 +2132,14 @@ "min": 33, "max": 256 }, - "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$" + "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": { @@ -2049,6 +2151,21 @@ "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": { @@ -2062,6 +2179,137 @@ "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 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 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.

", + "smithy.api#required": {} + } + }, + "patternObjectFilter": { + "target": "com.amazonaws.bedrockagent#PatternObjectFilterConfiguration", + "traits": { + "smithy.api#documentation": "

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": { @@ -2091,7 +2339,7 @@ } ], "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.

\n ", + "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.

\n ", "smithy.api#http": { "code": 202, "method": "PUT", @@ -2135,7 +2383,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an action group for an agent. An action group represents the actions that an agent can carry out for the customer by defining the APIs that an agent can call and the logic for calling them.

\n

To allow your agent to request the user for additional information when trying to complete a task, add an action group with the parentActionGroupSignature field set to AMAZON.UserInput. 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.

", + "smithy.api#documentation": "

Creates an action group for an agent. An action group represents the actions that an agent can carry out for the customer by defining the APIs that an agent can call and the logic for calling them.

\n

To 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.

\n

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.

\n

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.

", "smithy.api#http": { "code": 200, "method": "PUT", @@ -2189,7 +2437,7 @@ "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.

\n

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.

" + "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.

\n

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.

\n

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": { @@ -2413,6 +2661,12 @@ "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": { @@ -2466,7 +2720,7 @@ } ], "traits": { - "smithy.api#documentation": "

Sets up a data source to be added to a knowledge base.

\n \n

You can't change the chunkingConfiguration after you create the data source.

\n ", + "smithy.api#documentation": "

Creates a data source connector for a knowledge base.

\n \n

You can't change the chunkingConfiguration after you create the data source connector.

\n ", "smithy.api#http": { "code": 200, "method": "PUT", @@ -2512,14 +2766,14 @@ "dataSourceConfiguration": { "target": "com.amazonaws.bedrockagent#DataSourceConfiguration", "traits": { - "smithy.api#documentation": "

Contains metadata about where the data source is stored.

", + "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 assigned to the data source.

" + "smithy.api#documentation": "

The data deletion policy for the data source.

\n

You can set the data deletion policy to:

\n " } }, "serverSideEncryptionConfiguration": { @@ -2554,13 +2808,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.bedrockagent#CreateKnowledgeBase": { + "com.amazonaws.bedrockagent#CreateFlow": { "type": "operation", "input": { - "target": "com.amazonaws.bedrockagent#CreateKnowledgeBaseRequest" + "target": "com.amazonaws.bedrockagent#CreateFlowRequest" }, "output": { - "target": "com.amazonaws.bedrockagent#CreateKnowledgeBaseResponse" + "target": "com.amazonaws.bedrockagent#CreateFlowResponse" }, "errors": [ { @@ -2583,11 +2837,11 @@ } ], "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.

\n \n

If 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.

\n \n ", + "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": 202, - "method": "PUT", - "uri": "/knowledgebases/" + "code": 201, + "method": "POST", + "uri": "/flows/" }, "smithy.api#idempotent": {}, "smithy.api#tags": [ @@ -2595,54 +2849,93 @@ ] } }, - "com.amazonaws.bedrockagent#CreateKnowledgeBaseRequest": { + "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": { - "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": "

A name for the knowledge base.

", + "smithy.api#documentation": "

A name for the alias.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.bedrockagent#Description", "traits": { - "smithy.api#documentation": "

A description of the knowledge base.

" + "smithy.api#documentation": "

A description for the alias.

" } }, - "roleArn": { - "target": "com.amazonaws.bedrockagent#KnowledgeBaseRoleArn", + "routingConfiguration": { + "target": "com.amazonaws.bedrockagent#FlowAliasRoutingConfiguration", "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#documentation": "

Contains information about the version to which to map the alias.

", "smithy.api#required": {} } }, - "knowledgeBaseConfiguration": { - "target": "com.amazonaws.bedrockagent#KnowledgeBaseConfiguration", + "flowIdentifier": { + "target": "com.amazonaws.bedrockagent#FlowIdentifier", "traits": { - "smithy.api#documentation": "

Contains details about the embeddings model used for the knowledge base.

", + "smithy.api#documentation": "

The unique identifier of the flow for which to create an alias.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "storageConfiguration": { - "target": "com.amazonaws.bedrockagent#StorageConfiguration", + "clientToken": { + "target": "com.amazonaws.bedrockagent#ClientToken", "traits": { - "smithy.api#documentation": "

Contains details about the configuration of the vector database used for the knowledge base.

", - "smithy.api#required": {} + "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": { - "smithy.api#documentation": "

Specify the key-value pairs for the tags that you want to attach to your knowledge base in this object.

" + "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.

" } } }, @@ -2650,296 +2943,212 @@ "smithy.api#input": {} } }, - "com.amazonaws.bedrockagent#CreateKnowledgeBaseResponse": { + "com.amazonaws.bedrockagent#CreateFlowAliasResponse": { "type": "structure", "members": { - "knowledgeBase": { - "target": "com.amazonaws.bedrockagent#KnowledgeBase", + "name": { + "target": "com.amazonaws.bedrockagent#Name", "traits": { - "smithy.api#documentation": "

Contains details about the knowledge base.

", + "smithy.api#documentation": "

The name of the alias.

", "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#DataDeletionPolicy": { - "type": "enum", - "members": { - "RETAIN": { - "target": "smithy.api#Unit", + "description": { + "target": "com.amazonaws.bedrockagent#Description", "traits": { - "smithy.api#enumValue": "RETAIN" + "smithy.api#documentation": "

The description of the alias.

" } }, - "DELETE": { - "target": "smithy.api#Unit", + "routingConfiguration": { + "target": "com.amazonaws.bedrockagent#FlowAliasRoutingConfiguration", "traits": { - "smithy.api#enumValue": "DELETE" + "smithy.api#documentation": "

Contains information about the version that the alias is mapped to.

", + "smithy.api#required": {} } - } - } - }, - "com.amazonaws.bedrockagent#DataSource": { - "type": "structure", - "members": { - "knowledgeBaseId": { - "target": "com.amazonaws.bedrockagent#Id", + }, + "flowId": { + "target": "com.amazonaws.bedrockagent#FlowId", "traits": { - "smithy.api#documentation": "

The unique identifier of the knowledge base to which the data source belongs.

", + "smithy.api#documentation": "

The unique identifier of the flow that the alias belongs to.

", "smithy.api#required": {} } }, - "dataSourceId": { - "target": "com.amazonaws.bedrockagent#Id", + "id": { + "target": "com.amazonaws.bedrockagent#FlowAliasId", "traits": { - "smithy.api#documentation": "

The unique identifier of the data source.

", + "smithy.api#documentation": "

The unique identifier of the alias.

", "smithy.api#required": {} } }, - "name": { - "target": "com.amazonaws.bedrockagent#Name", + "arn": { + "target": "com.amazonaws.bedrockagent#FlowAliasArn", "traits": { - "smithy.api#documentation": "

The name of the data source.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the alias.

", "smithy.api#required": {} } }, - "status": { - "target": "com.amazonaws.bedrockagent#DataSourceStatus", + "createdAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", "traits": { - "smithy.api#documentation": "

The status of the data source. The following statuses are possible:

\n ", + "smithy.api#documentation": "

The time at which the alias was created.

", "smithy.api#required": {} } }, - "description": { - "target": "com.amazonaws.bedrockagent#Description", + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", "traits": { - "smithy.api#documentation": "

The description of the data source.

" + "smithy.api#documentation": "

The time at which the alias of the flow was last updated.

", + "smithy.api#required": {} } - }, - "dataSourceConfiguration": { - "target": "com.amazonaws.bedrockagent#DataSourceConfiguration", + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#CreateFlowRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#FlowName", "traits": { - "smithy.api#documentation": "

Contains details about how the data source is stored.

", + "smithy.api#documentation": "

A name for the flow.

", "smithy.api#required": {} } }, - "serverSideEncryptionConfiguration": { - "target": "com.amazonaws.bedrockagent#ServerSideEncryptionConfiguration", + "description": { + "target": "com.amazonaws.bedrockagent#FlowDescription", "traits": { - "smithy.api#documentation": "

Contains details about the configuration of the server-side encryption.

" + "smithy.api#documentation": "

A description for the flow.

" } }, - "vectorIngestionConfiguration": { - "target": "com.amazonaws.bedrockagent#VectorIngestionConfiguration", + "executionRoleArn": { + "target": "com.amazonaws.bedrockagent#FlowExecutionRoleArn", "traits": { - "smithy.api#documentation": "

Contains details about how to ingest the documents in the data source.

" + "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": {} } }, - "dataDeletionPolicy": { - "target": "com.amazonaws.bedrockagent#DataDeletionPolicy", + "customerEncryptionKeyArn": { + "target": "com.amazonaws.bedrockagent#KmsKeyArn", "traits": { - "smithy.api#documentation": "

The data deletion policy for a data source.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the KMS key to encrypt the flow.

" } }, - "createdAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", + "definition": { + "target": "com.amazonaws.bedrockagent#FlowDefinition", "traits": { - "smithy.api#documentation": "

The time at which the data source was created.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A definition of the nodes and connections between nodes in the flow.

" } }, - "updatedAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", + "clientToken": { + "target": "com.amazonaws.bedrockagent#ClientToken", "traits": { - "smithy.api#documentation": "

The time at which the data source was last updated.

", - "smithy.api#required": {} + "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": {} } }, - "failureReasons": { - "target": "com.amazonaws.bedrockagent#FailureReasons", + "tags": { + "target": "com.amazonaws.bedrockagent#TagsMap", "traits": { - "smithy.api#documentation": "

The detailed reasons on the failure to delete a data source.

" + "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#documentation": "

Contains details about a data source.

" + "smithy.api#input": {} } }, - "com.amazonaws.bedrockagent#DataSourceConfiguration": { + "com.amazonaws.bedrockagent#CreateFlowResponse": { "type": "structure", "members": { - "type": { - "target": "com.amazonaws.bedrockagent#DataSourceType", + "name": { + "target": "com.amazonaws.bedrockagent#FlowName", "traits": { - "smithy.api#documentation": "

The type of storage for the data source.

", + "smithy.api#documentation": "

The name of the flow.

", "smithy.api#required": {} } }, - "s3Configuration": { - "target": "com.amazonaws.bedrockagent#S3DataSourceConfiguration", + "description": { + "target": "com.amazonaws.bedrockagent#FlowDescription", "traits": { - "smithy.api#documentation": "

Contains details about the configuration of the S3 object containing the data source.

" + "smithy.api#documentation": "

The description of the flow.

" } - } - }, - "traits": { - "smithy.api#documentation": "

Contains details about how a data source is stored.

" - } - }, - "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", + "executionRoleArn": { + "target": "com.amazonaws.bedrockagent#FlowExecutionRoleArn", "traits": { - "smithy.api#enumValue": "AVAILABLE" + "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": {} } }, - "DELETING": { - "target": "smithy.api#Unit", + "customerEncryptionKeyArn": { + "target": "com.amazonaws.bedrockagent#KmsKeyArn", "traits": { - "smithy.api#enumValue": "DELETING" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the KMS key that you encrypted the flow with.

" } }, - "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", + "id": { + "target": "com.amazonaws.bedrockagent#FlowId", "traits": { - "smithy.api#documentation": "

The unique identifier of the knowledge base to which the data source belongs.

", + "smithy.api#documentation": "

The unique identifier of the flow.

", "smithy.api#required": {} } }, - "dataSourceId": { - "target": "com.amazonaws.bedrockagent#Id", + "arn": { + "target": "com.amazonaws.bedrockagent#FlowArn", "traits": { - "smithy.api#documentation": "

The unique identifier of the data source.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the flow.

", "smithy.api#required": {} } }, - "name": { - "target": "com.amazonaws.bedrockagent#Name", + "status": { + "target": "com.amazonaws.bedrockagent#FlowStatus", "traits": { - "smithy.api#documentation": "

The name of the data source.

", + "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.

", "smithy.api#required": {} } }, - "status": { - "target": "com.amazonaws.bedrockagent#DataSourceStatus", + "createdAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", "traits": { - "smithy.api#documentation": "

The status of the data source.

", + "smithy.api#documentation": "

The time at which the flow was created.

", "smithy.api#required": {} } }, - "description": { - "target": "com.amazonaws.bedrockagent#Description", + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", "traits": { - "smithy.api#documentation": "

The description of the data source.

" + "smithy.api#documentation": "

The time at which the flow was last updated.

", + "smithy.api#required": {} } }, - "updatedAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", + "version": { + "target": "com.amazonaws.bedrockagent#DraftVersion", "traits": { - "smithy.api#documentation": "

The time at which the data source was last updated.

", + "smithy.api#documentation": "

The version of the flow. When you create a flow, the version created is the DRAFT version.

", "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", + }, + "definition": { + "target": "com.amazonaws.bedrockagent#FlowDefinition", "traits": { - "smithy.api#enumValue": "S3" + "smithy.api#documentation": "

A definition of the nodes and connections between nodes in the flow.

" } } - } - }, - "com.amazonaws.bedrockagent#DateTimestamp": { - "type": "timestamp", + }, "traits": { - "smithy.api#timestampFormat": "date-time" + "smithy.api#output": {} } }, - "com.amazonaws.bedrockagent#DeleteAgent": { + "com.amazonaws.bedrockagent#CreateFlowVersion": { "type": "operation", "input": { - "target": "com.amazonaws.bedrockagent#DeleteAgentRequest" + "target": "com.amazonaws.bedrockagent#CreateFlowVersionRequest" }, "output": { - "target": "com.amazonaws.bedrockagent#DeleteAgentResponse" + "target": "com.amazonaws.bedrockagent#CreateFlowVersionResponse" }, "errors": [ { @@ -2954,6 +3163,9 @@ { "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, { "target": "com.amazonaws.bedrockagent#ThrottlingException" }, @@ -2962,11 +3174,11 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes an agent.

", + "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": 202, - "method": "DELETE", - "uri": "/agents/{agentId}/" + "code": 201, + "method": "POST", + "uri": "/flows/{flowIdentifier}/versions" }, "smithy.api#idempotent": {}, "smithy.api#tags": [ @@ -2974,111 +3186,130 @@ ] } }, - "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" + "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": {} + } }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" + "description": { + "target": "com.amazonaws.bedrockagent#FlowDescription", + "traits": { + "smithy.api#documentation": "

A description of the version of the flow.

" + } }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" + "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#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" - ] + "smithy.api#input": {} } }, - "com.amazonaws.bedrockagent#DeleteAgentActionGroupRequest": { + "com.amazonaws.bedrockagent#CreateFlowVersionResponse": { "type": "structure", "members": { - "agentId": { - "target": "com.amazonaws.bedrockagent#Id", + "name": { + "target": "com.amazonaws.bedrockagent#FlowName", "traits": { - "smithy.api#documentation": "

The unique identifier of the agent that the action group belongs to.

", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

The name of the flow version.

", "smithy.api#required": {} } }, - "agentVersion": { - "target": "com.amazonaws.bedrockagent#DraftVersion", + "description": { + "target": "com.amazonaws.bedrockagent#FlowDescription", "traits": { - "smithy.api#documentation": "

The version of the agent that the action group belongs to.

", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

The description of the flow 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": {} } }, - "actionGroupId": { - "target": "com.amazonaws.bedrockagent#Id", + "customerEncryptionKeyArn": { + "target": "com.amazonaws.bedrockagent#KmsKeyArn", "traits": { - "smithy.api#documentation": "

The unique identifier of the action group to delete.

", - "smithy.api#httpLabel": {}, + "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": {} } }, - "skipResourceInUseCheck": { - "target": "smithy.api#Boolean", + "arn": { + "target": "com.amazonaws.bedrockagent#FlowArn", "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.

", - "smithy.api#httpQuery": "skipResourceInUseCheck" + "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#input": {} - } - }, - "com.amazonaws.bedrockagent#DeleteAgentActionGroupResponse": { - "type": "structure", - "members": {}, "traits": { "smithy.api#output": {} } }, - "com.amazonaws.bedrockagent#DeleteAgentAlias": { + "com.amazonaws.bedrockagent#CreateKnowledgeBase": { "type": "operation", "input": { - "target": "com.amazonaws.bedrockagent#DeleteAgentAliasRequest" + "target": "com.amazonaws.bedrockagent#CreateKnowledgeBaseRequest" }, "output": { - "target": "com.amazonaws.bedrockagent#DeleteAgentAliasResponse" + "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#ResourceNotFoundException" + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" }, { "target": "com.amazonaws.bedrockagent#ThrottlingException" @@ -3088,11 +3319,11 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes an alias of an agent.

", + "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.

\n \n

If 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.

\n \n ", "smithy.api#http": { "code": 202, - "method": "DELETE", - "uri": "/agents/{agentId}/agentaliases/{agentAliasId}/" + "method": "PUT", + "uri": "/knowledgebases/" }, "smithy.api#idempotent": {}, "smithy.api#tags": [ @@ -3100,76 +3331,54 @@ ] } }, - "com.amazonaws.bedrockagent#DeleteAgentAliasRequest": { + "com.amazonaws.bedrockagent#CreateKnowledgeBaseRequest": { "type": "structure", "members": { - "agentId": { - "target": "com.amazonaws.bedrockagent#Id", + "clientToken": { + "target": "com.amazonaws.bedrockagent#ClientToken", "traits": { - "smithy.api#documentation": "

The unique identifier of the agent that the alias belongs to.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "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": {} } }, - "agentAliasId": { - "target": "com.amazonaws.bedrockagent#AgentAliasId", + "name": { + "target": "com.amazonaws.bedrockagent#Name", "traits": { - "smithy.api#documentation": "

The unique identifier of the alias to delete.

", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

A name for the knowledge base.

", "smithy.api#required": {} } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#DeleteAgentAliasResponse": { - "type": "structure", - "members": { - "agentId": { - "target": "com.amazonaws.bedrockagent#Id", + }, + "description": { + "target": "com.amazonaws.bedrockagent#Description", "traits": { - "smithy.api#documentation": "

The unique identifier of the agent that the alias belongs to.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A description of the knowledge base.

" } }, - "agentAliasId": { - "target": "com.amazonaws.bedrockagent#AgentAliasId", + "roleArn": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseRoleArn", "traits": { - "smithy.api#documentation": "

The unique identifier of the alias that was deleted.

", + "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": {} } }, - "agentAliasStatus": { - "target": "com.amazonaws.bedrockagent#AgentAliasStatus", + "knowledgeBaseConfiguration": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseConfiguration", "traits": { - "smithy.api#documentation": "

The status of the alias.

", + "smithy.api#documentation": "

Contains details about the embeddings model used for the knowledge base.

", "smithy.api#required": {} } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#DeleteAgentRequest": { - "type": "structure", - "members": { - "agentId": { - "target": "com.amazonaws.bedrockagent#Id", + }, + "storageConfiguration": { + "target": "com.amazonaws.bedrockagent#StorageConfiguration", "traits": { - "smithy.api#documentation": "

The unique identifier of the agent to delete.

", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

Contains details about the configuration of the vector database used for the knowledge base.

", "smithy.api#required": {} } }, - "skipResourceInUseCheck": { - "target": "smithy.api#Boolean", + "tags": { + "target": "com.amazonaws.bedrockagent#TagsMap", "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.

", - "smithy.api#httpQuery": "skipResourceInUseCheck" + "smithy.api#documentation": "

Specify the key-value pairs for the tags that you want to attach to your knowledge base in this object.

" } } }, @@ -3177,20 +3386,13 @@ "smithy.api#input": {} } }, - "com.amazonaws.bedrockagent#DeleteAgentResponse": { + "com.amazonaws.bedrockagent#CreateKnowledgeBaseResponse": { "type": "structure", "members": { - "agentId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "

The unique identifier of the agent that was deleted.

", - "smithy.api#required": {} - } - }, - "agentStatus": { - "target": "com.amazonaws.bedrockagent#AgentStatus", + "knowledgeBase": { + "target": "com.amazonaws.bedrockagent#KnowledgeBase", "traits": { - "smithy.api#documentation": "

The status of the agent.

", + "smithy.api#documentation": "

Contains details about the knowledge base.

", "smithy.api#required": {} } } @@ -3199,13 +3401,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.bedrockagent#DeleteAgentVersion": { + "com.amazonaws.bedrockagent#CreatePrompt": { "type": "operation", "input": { - "target": "com.amazonaws.bedrockagent#DeleteAgentVersionRequest" + "target": "com.amazonaws.bedrockagent#CreatePromptRequest" }, "output": { - "target": "com.amazonaws.bedrockagent#DeleteAgentVersionResponse" + "target": "com.amazonaws.bedrockagent#CreatePromptResponse" }, "errors": [ { @@ -3218,7 +3420,7 @@ "target": "com.amazonaws.bedrockagent#InternalServerException" }, { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" }, { "target": "com.amazonaws.bedrockagent#ThrottlingException" @@ -3228,11 +3430,11 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a version of an agent.

", + "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": 202, - "method": "DELETE", - "uri": "/agents/{agentId}/agentversions/{agentVersion}/" + "code": 201, + "method": "POST", + "uri": "/prompts/" }, "smithy.api#idempotent": {}, "smithy.api#tags": [ @@ -3240,31 +3442,52 @@ ] } }, - "com.amazonaws.bedrockagent#DeleteAgentVersionRequest": { + "com.amazonaws.bedrockagent#CreatePromptRequest": { "type": "structure", "members": { - "agentId": { - "target": "com.amazonaws.bedrockagent#Id", + "name": { + "target": "com.amazonaws.bedrockagent#PromptName", "traits": { - "smithy.api#documentation": "

The unique identifier of the agent that the version belongs to.

", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

A name for the prompt.

", "smithy.api#required": {} } }, - "agentVersion": { - "target": "com.amazonaws.bedrockagent#NumericalVersion", + "description": { + "target": "com.amazonaws.bedrockagent#PromptDescription", "traits": { - "smithy.api#documentation": "

The version of the agent to delete.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

A description for the prompt.

" } }, - "skipResourceInUseCheck": { - "target": "smithy.api#Boolean", + "customerEncryptionKeyArn": { + "target": "com.amazonaws.bedrockagent#KmsKeyArn", "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.

", - "smithy.api#httpQuery": "skipResourceInUseCheck" + "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.

" + } + }, + "variants": { + "target": "com.amazonaws.bedrockagent#PromptVariantList", + "traits": { + "smithy.api#documentation": "

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.

" } } }, @@ -3272,121 +3495,72 @@ "smithy.api#input": {} } }, - "com.amazonaws.bedrockagent#DeleteAgentVersionResponse": { + "com.amazonaws.bedrockagent#CreatePromptResponse": { "type": "structure", "members": { - "agentId": { - "target": "com.amazonaws.bedrockagent#Id", + "name": { + "target": "com.amazonaws.bedrockagent#PromptName", "traits": { - "smithy.api#documentation": "

The unique identifier of the agent that the version belongs to.

", + "smithy.api#documentation": "

The name of the prompt.

", "smithy.api#required": {} } }, - "agentVersion": { - "target": "com.amazonaws.bedrockagent#NumericalVersion", + "description": { + "target": "com.amazonaws.bedrockagent#PromptDescription", "traits": { - "smithy.api#documentation": "

The version that was deleted.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The description of the prompt.

" } }, - "agentStatus": { - "target": "com.amazonaws.bedrockagent#AgentStatus", + "customerEncryptionKeyArn": { + "target": "com.amazonaws.bedrockagent#KmsKeyArn", "traits": { - "smithy.api#documentation": "

The status of the agent version.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the KMS key that you encrypted the prompt with.

" } - } - }, - "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" + "defaultVariant": { + "target": "com.amazonaws.bedrockagent#PromptVariantName", + "traits": { + "smithy.api#documentation": "

The name of the default variant for your prompt.

" + } }, - { - "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}" + "variants": { + "target": "com.amazonaws.bedrockagent#PromptVariantList", + "traits": { + "smithy.api#documentation": "

A list of objects, each containing details about a variant of the prompt.

" + } }, - "smithy.api#idempotent": {}, - "smithy.api#tags": [ - "console" - ] - } - }, - "com.amazonaws.bedrockagent#DeleteDataSourceRequest": { - "type": "structure", - "members": { - "knowledgeBaseId": { - "target": "com.amazonaws.bedrockagent#Id", + "id": { + "target": "com.amazonaws.bedrockagent#PromptId", "traits": { - "smithy.api#documentation": "

The unique identifier of the knowledge base from which to delete the data source.

", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

The unique identifier of the prompt.

", "smithy.api#required": {} } }, - "dataSourceId": { - "target": "com.amazonaws.bedrockagent#Id", + "arn": { + "target": "com.amazonaws.bedrockagent#PromptArn", "traits": { - "smithy.api#documentation": "

The unique identifier of the data source to delete.

", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the prompt.

", "smithy.api#required": {} } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#DeleteDataSourceResponse": { - "type": "structure", - "members": { - "knowledgeBaseId": { - "target": "com.amazonaws.bedrockagent#Id", + }, + "version": { + "target": "com.amazonaws.bedrockagent#Version", "traits": { - "smithy.api#documentation": "

The unique identifier of the knowledge base to which the data source that was deleted belonged.

", + "smithy.api#documentation": "

The version of the prompt. When you create a prompt, the version created is the DRAFT version.

", "smithy.api#required": {} } }, - "dataSourceId": { - "target": "com.amazonaws.bedrockagent#Id", + "createdAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", "traits": { - "smithy.api#documentation": "

The unique identifier of the data source that was deleted.

", + "smithy.api#documentation": "

The time at which the prompt was created.

", "smithy.api#required": {} } }, - "status": { - "target": "com.amazonaws.bedrockagent#DataSourceStatus", + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", "traits": { - "smithy.api#documentation": "

The status of the data source.

", + "smithy.api#documentation": "

The time at which the prompt was last updated.

", "smithy.api#required": {} } } @@ -3395,13 +3569,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.bedrockagent#DeleteKnowledgeBase": { + "com.amazonaws.bedrockagent#CreatePromptVersion": { "type": "operation", "input": { - "target": "com.amazonaws.bedrockagent#DeleteKnowledgeBaseRequest" + "target": "com.amazonaws.bedrockagent#CreatePromptVersionRequest" }, "output": { - "target": "com.amazonaws.bedrockagent#DeleteKnowledgeBaseResponse" + "target": "com.amazonaws.bedrockagent#CreatePromptVersionResponse" }, "errors": [ { @@ -3416,6 +3590,9 @@ { "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, { "target": "com.amazonaws.bedrockagent#ThrottlingException" }, @@ -3424,11 +3601,11 @@ } ], "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#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": 202, - "method": "DELETE", - "uri": "/knowledgebases/{knowledgeBaseId}" + "code": 201, + "method": "POST", + "uri": "/prompts/{promptIdentifier}/versions" }, "smithy.api#idempotent": {}, "smithy.api#tags": [ @@ -3436,414 +3613,469 @@ ] } }, - "com.amazonaws.bedrockagent#DeleteKnowledgeBaseRequest": { + "com.amazonaws.bedrockagent#CreatePromptVersionRequest": { "type": "structure", "members": { - "knowledgeBaseId": { - "target": "com.amazonaws.bedrockagent#Id", + "promptIdentifier": { + "target": "com.amazonaws.bedrockagent#PromptIdentifier", "traits": { - "smithy.api#documentation": "

The unique identifier of the knowledge base to delete.

", + "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#DeleteKnowledgeBaseResponse": { + "com.amazonaws.bedrockagent#CreatePromptVersionResponse": { "type": "structure", "members": { - "knowledgeBaseId": { - "target": "com.amazonaws.bedrockagent#Id", + "name": { + "target": "com.amazonaws.bedrockagent#PromptName", "traits": { - "smithy.api#documentation": "

The unique identifier of the knowledge base that was deleted.

", + "smithy.api#documentation": "

The name of the prompt version.

", "smithy.api#required": {} } }, - "status": { - "target": "com.amazonaws.bedrockagent#KnowledgeBaseStatus", + "description": { + "target": "com.amazonaws.bedrockagent#PromptDescription", "traits": { - "smithy.api#documentation": "

The status of the knowledge base and whether it has been successfully deleted.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A description for the prompt version.

" } - } - }, - "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" + "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.

" + } }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" + "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.

" + } }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + "variants": { + "target": "com.amazonaws.bedrockagent#PromptVariantList", + "traits": { + "smithy.api#documentation": "

A list of objects, each containing details about a variant of the prompt.

" + } }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" + "id": { + "target": "com.amazonaws.bedrockagent#PromptId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the prompt.

", + "smithy.api#required": {} + } }, - { - "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}/" + "arn": { + "target": "com.amazonaws.bedrockagent#PromptArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the version of the prompt.

", + "smithy.api#required": {} + } }, - "smithy.api#idempotent": {}, - "smithy.api#tags": [ - "console" - ] - } - }, - "com.amazonaws.bedrockagent#DisassociateAgentKnowledgeBaseRequest": { - "type": "structure", - "members": { - "agentId": { - "target": "com.amazonaws.bedrockagent#Id", + "version": { + "target": "com.amazonaws.bedrockagent#Version", "traits": { - "smithy.api#documentation": "

The unique identifier of the agent from which to disassociate the knowledge base.

", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

The version of the prompt that was created. Versions are numbered incrementally, starting from 1.

", "smithy.api#required": {} } }, - "agentVersion": { - "target": "com.amazonaws.bedrockagent#DraftVersion", + "createdAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", "traits": { - "smithy.api#documentation": "

The version of the agent from which to disassociate the knowledge base.

", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

The time at which the prompt was created.

", "smithy.api#required": {} } }, - "knowledgeBaseId": { - "target": "com.amazonaws.bedrockagent#Id", + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", "traits": { - "smithy.api#documentation": "

The unique identifier of the knowledge base to disassociate.

", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

The time at which the prompt was last updated.

", "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 + "com.amazonaws.bedrockagent#CreationMode": { + "type": "enum", + "members": { + "DEFAULT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEFAULT" + } }, - "smithy.api#pattern": "^DRAFT$" + "OVERRIDDEN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OVERRIDDEN" + } + } } }, - "com.amazonaws.bedrockagent#EmbeddingModelConfiguration": { - "type": "structure", + "com.amazonaws.bedrockagent#CustomControlMethod": { + "type": "enum", "members": { - "bedrockEmbeddingModelConfiguration": { - "target": "com.amazonaws.bedrockagent#BedrockEmbeddingModelConfiguration", + "RETURN_CONTROL": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The vector configuration details on the Bedrock embeddings model.

" + "smithy.api#enumValue": "RETURN_CONTROL" } } - }, - "traits": { - "smithy.api#documentation": "

The configuration details for the embeddings model.

" } }, - "com.amazonaws.bedrockagent#FailureReason": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 2048 + "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": {} + } } - } - }, - "com.amazonaws.bedrockagent#FailureReasons": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagent#FailureReason" }, "traits": { - "smithy.api#length": { - "max": 2048 - } + "smithy.api#documentation": "

Settings for customizing steps in the data source content ingestion pipeline.

\n

You 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.

\n

To 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#FieldName": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 2048 + "com.amazonaws.bedrockagent#DataDeletionPolicy": { + "type": "enum", + "members": { + "RETAIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RETAIN" + } }, - "smithy.api#pattern": "^.*$" + "DELETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE" + } + } } }, - "com.amazonaws.bedrockagent#FixedSizeChunkingConfiguration": { + "com.amazonaws.bedrockagent#DataSource": { "type": "structure", "members": { - "maxTokens": { - "target": "smithy.api#Integer", + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", "traits": { - "smithy.api#documentation": "

The maximum number of tokens to include in a chunk.

", - "smithy.api#range": { - "min": 1 - }, + "smithy.api#documentation": "

The unique identifier of the knowledge base to which the data source belongs.

", "smithy.api#required": {} } }, - "overlapPercentage": { - "target": "smithy.api#Integer", + "dataSourceId": { + "target": "com.amazonaws.bedrockagent#Id", "traits": { - "smithy.api#documentation": "

The percentage of overlap between adjacent chunks of a data source.

", - "smithy.api#range": { - "min": 1, - "max": 99 - }, + "smithy.api#documentation": "

The unique identifier of the data source.

", "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.

" - } - }, - "com.amazonaws.bedrockagent#Function": { - "type": "structure", - "members": { + }, "name": { "target": "com.amazonaws.bedrockagent#Name", "traits": { - "smithy.api#documentation": "

A name for the function.

", + "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:

\n ", "smithy.api#required": {} } }, "description": { - "target": "com.amazonaws.bedrockagent#FunctionDescription", + "target": "com.amazonaws.bedrockagent#Description", "traits": { - "smithy.api#documentation": "

A description of the function and its purpose.

" + "smithy.api#documentation": "

The description of the data source.

" } }, - "parameters": { - "target": "com.amazonaws.bedrockagent#ParameterMap", + "dataSourceConfiguration": { + "target": "com.amazonaws.bedrockagent#DataSourceConfiguration", "traits": { - "smithy.api#documentation": "

The parameters that the agent elicits from the user to fulfill the function.

" + "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": "

Defines parameters that the agent needs to invoke from the user to complete the function. Corresponds to an action in an action group.

\n

This data type is used in the following API operations:

\n " - } - }, - "com.amazonaws.bedrockagent#FunctionDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1200 - } + "smithy.api#documentation": "

Contains details about a data source.

" } }, - "com.amazonaws.bedrockagent#FunctionSchema": { - "type": "union", + "com.amazonaws.bedrockagent#DataSourceConfiguration": { + "type": "structure", "members": { - "functions": { - "target": "com.amazonaws.bedrockagent#Functions", + "type": { + "target": "com.amazonaws.bedrockagent#DataSourceType", "traits": { - "smithy.api#documentation": "

A list of functions that each define an action in the action group.

" + "smithy.api#documentation": "

The type of data source.

", + "smithy.api#required": {} } - } - }, - "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.

\n

This data type is used in the following API operations:

\n " - } - }, - "com.amazonaws.bedrockagent#Functions": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagent#Function" - } - }, - "com.amazonaws.bedrockagent#GetAgent": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#GetAgentRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#GetAgentResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" + "s3Configuration": { + "target": "com.amazonaws.bedrockagent#S3DataSourceConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration information to connect to Amazon S3 as your data source.

" + } }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + "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.

\n \n

Crawling web URLs as your data source is in preview release \n and is subject to change.

\n " + } }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" + "confluenceConfiguration": { + "target": "com.amazonaws.bedrockagent#ConfluenceDataSourceConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration information to connect to Confluence as your data source.

\n \n

Confluence data source connector is in preview release and is subject to change.

\n " + } }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" + "salesforceConfiguration": { + "target": "com.amazonaws.bedrockagent#SalesforceDataSourceConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration information to connect to Salesforce as your data source.

\n \n

Salesforce data source connector is in preview release and is subject to change.

\n " + } + }, + "sharePointConfiguration": { + "target": "com.amazonaws.bedrockagent#SharePointDataSourceConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration information to connect to SharePoint as your data source.

\n \n

SharePoint data source connector is in preview release and is subject to change.

\n " + } } - ], + }, "traits": { - "smithy.api#documentation": "

Gets information about an agent.

", - "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/agents/{agentId}/" - }, - "smithy.api#readonly": {}, - "smithy.api#tags": [ - "console" - ] + "smithy.api#documentation": "

The connection configuration for the data source.

" } }, - "com.amazonaws.bedrockagent#GetAgentActionGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#GetAgentActionGroupRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#GetAgentActionGroupResponse" - }, - "errors": [ + "com.amazonaws.bedrockagent#DataSourceResource": { + "type": "resource", + "operations": [ { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" + "target": "com.amazonaws.bedrockagent#CreateDataSource" }, { - "target": "com.amazonaws.bedrockagent#InternalServerException" + "target": "com.amazonaws.bedrockagent#DeleteDataSource" }, { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + "target": "com.amazonaws.bedrockagent#GetDataSource" }, { - "target": "com.amazonaws.bedrockagent#ThrottlingException" + "target": "com.amazonaws.bedrockagent#ListDataSources" }, { - "target": "com.amazonaws.bedrockagent#ValidationException" + "target": "com.amazonaws.bedrockagent#UpdateDataSource" } - ], - "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", + "com.amazonaws.bedrockagent#DataSourceStatus": { + "type": "enum", "members": { - "agentId": { - "target": "com.amazonaws.bedrockagent#Id", + "AVAILABLE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The unique identifier of the agent that the action group belongs to.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#enumValue": "AVAILABLE" } }, - "agentVersion": { - "target": "com.amazonaws.bedrockagent#Version", + "DELETING": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The version of the agent that the action group belongs to.

", - "smithy.api#httpLabel": {}, + "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": {} } }, - "actionGroupId": { + "dataSourceId": { "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#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#input": {} + "smithy.api#documentation": "

Contains details about a data source.

" } }, - "com.amazonaws.bedrockagent#GetAgentActionGroupResponse": { - "type": "structure", + "com.amazonaws.bedrockagent#DataSourceType": { + "type": "enum", "members": { - "agentActionGroup": { - "target": "com.amazonaws.bedrockagent#AgentActionGroup", + "S3": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

Contains details about the action group.

", - "smithy.api#required": {} + "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#output": {} + "smithy.api#timestampFormat": "date-time" } }, - "com.amazonaws.bedrockagent#GetAgentAlias": { + "com.amazonaws.bedrockagent#DeleteAgent": { "type": "operation", "input": { - "target": "com.amazonaws.bedrockagent#GetAgentAliasRequest" + "target": "com.amazonaws.bedrockagent#DeleteAgentRequest" }, "output": { - "target": "com.amazonaws.bedrockagent#GetAgentAliasResponse" + "target": "com.amazonaws.bedrockagent#DeleteAgentResponse" }, "errors": [ { "target": "com.amazonaws.bedrockagent#AccessDeniedException" }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, { "target": "com.amazonaws.bedrockagent#InternalServerException" }, @@ -3858,69 +4090,33 @@ } ], "traits": { - "smithy.api#documentation": "

Gets information about an alias of an agent.

", + "smithy.api#documentation": "

Deletes an agent.

", "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/agents/{agentId}/agentaliases/{agentAliasId}/" + "code": 202, + "method": "DELETE", + "uri": "/agents/{agentId}/" }, - "smithy.api#readonly": {}, + "smithy.api#idempotent": {}, "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": { + "com.amazonaws.bedrockagent#DeleteAgentActionGroup": { "type": "operation", "input": { - "target": "com.amazonaws.bedrockagent#GetAgentKnowledgeBaseRequest" + "target": "com.amazonaws.bedrockagent#DeleteAgentActionGroupRequest" }, "output": { - "target": "com.amazonaws.bedrockagent#GetAgentKnowledgeBaseResponse" + "target": "com.amazonaws.bedrockagent#DeleteAgentActionGroupResponse" }, "errors": [ { "target": "com.amazonaws.bedrockagent#AccessDeniedException" }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, { "target": "com.amazonaws.bedrockagent#InternalServerException" }, @@ -3935,74 +4131,51 @@ } ], "traits": { - "smithy.api#documentation": "

Gets information about a knowledge base associated with an agent.

", + "smithy.api#documentation": "

Deletes an action group in an agent.

", "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/agents/{agentId}/agentversions/{agentVersion}/knowledgebases/{knowledgeBaseId}/" + "code": 204, + "method": "DELETE", + "uri": "/agents/{agentId}/agentversions/{agentVersion}/actiongroups/{actionGroupId}/" }, - "smithy.api#readonly": {}, + "smithy.api#idempotent": {}, "smithy.api#tags": [ "console" ] } }, - "com.amazonaws.bedrockagent#GetAgentKnowledgeBaseRequest": { + "com.amazonaws.bedrockagent#DeleteAgentActionGroupRequest": { "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#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", + "target": "com.amazonaws.bedrockagent#DraftVersion", "traits": { - "smithy.api#documentation": "

The version of the agent with which the knowledge base is associated.

", + "smithy.api#documentation": "

The version of the agent that the action group belongs to.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "knowledgeBaseId": { + "actionGroupId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { - "smithy.api#documentation": "

The unique identifier of the knowledge base associated with the agent.

", + "smithy.api#documentation": "

The unique identifier of the action group to delete.

", "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", + }, + "skipResourceInUseCheck": { + "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

The unique identifier of the agent.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "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.

", + "smithy.api#httpQuery": "skipResourceInUseCheck" } } }, @@ -4010,28 +4183,20 @@ "smithy.api#input": {} } }, - "com.amazonaws.bedrockagent#GetAgentResponse": { + "com.amazonaws.bedrockagent#DeleteAgentActionGroupResponse": { "type": "structure", - "members": { - "agent": { - "target": "com.amazonaws.bedrockagent#Agent", - "traits": { - "smithy.api#documentation": "

Contains details about the agent.

", - "smithy.api#required": {} - } - } - }, + "members": {}, "traits": { "smithy.api#output": {} } }, - "com.amazonaws.bedrockagent#GetAgentVersion": { + "com.amazonaws.bedrockagent#DeleteAgentAlias": { "type": "operation", "input": { - "target": "com.amazonaws.bedrockagent#GetAgentVersionRequest" + "target": "com.amazonaws.bedrockagent#DeleteAgentAliasRequest" }, "output": { - "target": "com.amazonaws.bedrockagent#GetAgentVersionResponse" + "target": "com.amazonaws.bedrockagent#DeleteAgentAliasResponse" }, "errors": [ { @@ -4051,33 +4216,33 @@ } ], "traits": { - "smithy.api#documentation": "

Gets details about a version of an agent.

", + "smithy.api#documentation": "

Deletes an alias of an agent.

", "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/agents/{agentId}/agentversions/{agentVersion}/" + "code": 202, + "method": "DELETE", + "uri": "/agents/{agentId}/agentaliases/{agentAliasId}/" }, - "smithy.api#readonly": {}, + "smithy.api#idempotent": {}, "smithy.api#tags": [ "console" ] } }, - "com.amazonaws.bedrockagent#GetAgentVersionRequest": { + "com.amazonaws.bedrockagent#DeleteAgentAliasRequest": { "type": "structure", "members": { "agentId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { - "smithy.api#documentation": "

The unique identifier of the agent.

", + "smithy.api#documentation": "

The unique identifier of the agent that the alias belongs to.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "agentVersion": { - "target": "com.amazonaws.bedrockagent#NumericalVersion", + "agentAliasId": { + "target": "com.amazonaws.bedrockagent#AgentAliasId", "traits": { - "smithy.api#documentation": "

The version of the agent.

", + "smithy.api#documentation": "

The unique identifier of the alias to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4087,13 +4252,27 @@ "smithy.api#input": {} } }, - "com.amazonaws.bedrockagent#GetAgentVersionResponse": { + "com.amazonaws.bedrockagent#DeleteAgentAliasResponse": { "type": "structure", "members": { - "agentVersion": { - "target": "com.amazonaws.bedrockagent#AgentVersion", + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", "traits": { - "smithy.api#documentation": "

Contains details about the version of the agent.

", + "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": {} } } @@ -4102,18 +4281,67 @@ "smithy.api#output": {} } }, - "com.amazonaws.bedrockagent#GetDataSource": { + "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.

", + "smithy.api#httpQuery": "skipResourceInUseCheck" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#DeleteAgentResponse": { + "type": "structure", + "members": { + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "

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#GetDataSourceRequest" + "target": "com.amazonaws.bedrockagent#DeleteAgentVersionRequest" }, "output": { - "target": "com.amazonaws.bedrockagent#GetDataSourceResponse" + "target": "com.amazonaws.bedrockagent#DeleteAgentVersionResponse" }, "errors": [ { "target": "com.amazonaws.bedrockagent#AccessDeniedException" }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, { "target": "com.amazonaws.bedrockagent#InternalServerException" }, @@ -4128,49 +4356,71 @@ } ], "traits": { - "smithy.api#documentation": "

Gets information about a data source.

", + "smithy.api#documentation": "

Deletes a version of an agent.

", "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}" + "code": 202, + "method": "DELETE", + "uri": "/agents/{agentId}/agentversions/{agentVersion}/" }, - "smithy.api#readonly": {}, + "smithy.api#idempotent": {}, "smithy.api#tags": [ "console" ] } }, - "com.amazonaws.bedrockagent#GetDataSourceRequest": { + "com.amazonaws.bedrockagent#DeleteAgentVersionRequest": { "type": "structure", "members": { - "knowledgeBaseId": { + "agentId": { "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#documentation": "

The unique identifier of the agent that the version belongs to.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "dataSourceId": { - "target": "com.amazonaws.bedrockagent#Id", + "agentVersion": { + "target": "com.amazonaws.bedrockagent#NumericalVersion", "traits": { - "smithy.api#documentation": "

The unique identifier of the data source.

", + "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.

", + "smithy.api#httpQuery": "skipResourceInUseCheck" + } } }, "traits": { "smithy.api#input": {} } }, - "com.amazonaws.bedrockagent#GetDataSourceResponse": { + "com.amazonaws.bedrockagent#DeleteAgentVersionResponse": { "type": "structure", "members": { - "dataSource": { - "target": "com.amazonaws.bedrockagent#DataSource", + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", "traits": { - "smithy.api#documentation": "

Contains details about the data source.

", + "smithy.api#documentation": "

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": {} } } @@ -4179,18 +4429,21 @@ "smithy.api#output": {} } }, - "com.amazonaws.bedrockagent#GetIngestionJob": { + "com.amazonaws.bedrockagent#DeleteDataSource": { "type": "operation", "input": { - "target": "com.amazonaws.bedrockagent#GetIngestionJobRequest" + "target": "com.amazonaws.bedrockagent#DeleteDataSourceRequest" }, "output": { - "target": "com.amazonaws.bedrockagent#GetIngestionJobResponse" + "target": "com.amazonaws.bedrockagent#DeleteDataSourceResponse" }, "errors": [ { "target": "com.amazonaws.bedrockagent#AccessDeniedException" }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, { "target": "com.amazonaws.bedrockagent#InternalServerException" }, @@ -4205,25 +4458,25 @@ } ], "traits": { - "smithy.api#documentation": "

Gets information about a ingestion job, in which a data source is added to a knowledge base.

", + "smithy.api#documentation": "

Deletes a data source from a knowledge base.

", "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}/ingestionjobs/{ingestionJobId}" + "code": 202, + "method": "DELETE", + "uri": "/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}" }, - "smithy.api#readonly": {}, + "smithy.api#idempotent": {}, "smithy.api#tags": [ "console" ] } }, - "com.amazonaws.bedrockagent#GetIngestionJobRequest": { + "com.amazonaws.bedrockagent#DeleteDataSourceRequest": { "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#documentation": "

The unique identifier of the knowledge base from which to delete the data source.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4231,15 +4484,7 @@ "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#documentation": "

The unique identifier of the data source to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4249,13 +4494,27 @@ "smithy.api#input": {} } }, - "com.amazonaws.bedrockagent#GetIngestionJobResponse": { + "com.amazonaws.bedrockagent#DeleteDataSourceResponse": { "type": "structure", "members": { - "ingestionJob": { - "target": "com.amazonaws.bedrockagent#IngestionJob", + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", "traits": { - "smithy.api#documentation": "

Contains details about the ingestion job.

", + "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": {} } } @@ -4264,18 +4523,21 @@ "smithy.api#output": {} } }, - "com.amazonaws.bedrockagent#GetKnowledgeBase": { + "com.amazonaws.bedrockagent#DeleteFlow": { "type": "operation", "input": { - "target": "com.amazonaws.bedrockagent#GetKnowledgeBaseRequest" + "target": "com.amazonaws.bedrockagent#DeleteFlowRequest" }, "output": { - "target": "com.amazonaws.bedrockagent#GetKnowledgeBaseResponse" + "target": "com.amazonaws.bedrockagent#DeleteFlowResponse" }, "errors": [ { "target": "com.amazonaws.bedrockagent#AccessDeniedException" }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, { "target": "com.amazonaws.bedrockagent#InternalServerException" }, @@ -4290,25 +4552,74 @@ } ], "traits": { - "smithy.api#documentation": "

Gets information about a knoweldge base.

", + "smithy.api#documentation": "

Deletes a flow.

", "smithy.api#http": { "code": 200, - "method": "GET", - "uri": "/knowledgebases/{knowledgeBaseId}" + "method": "DELETE", + "uri": "/flows/{flowIdentifier}/" }, - "smithy.api#readonly": {}, + "smithy.api#idempotent": {}, "smithy.api#tags": [ "console" ] } }, - "com.amazonaws.bedrockagent#GetKnowledgeBaseRequest": { + "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": { - "knowledgeBaseId": { - "target": "com.amazonaws.bedrockagent#Id", + "flowIdentifier": { + "target": "com.amazonaws.bedrockagent#FlowIdentifier", "traits": { - "smithy.api#documentation": "

The unique identifier of the knowledge base for which to get information.

", + "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": {} } @@ -4318,13 +4629,20 @@ "smithy.api#input": {} } }, - "com.amazonaws.bedrockagent#GetKnowledgeBaseResponse": { + "com.amazonaws.bedrockagent#DeleteFlowAliasResponse": { "type": "structure", "members": { - "knowledgeBase": { - "target": "com.amazonaws.bedrockagent#KnowledgeBase", + "flowId": { + "target": "com.amazonaws.bedrockagent#FlowId", "traits": { - "smithy.api#documentation": "

Contains details about the knowledge base.

", + "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": {} } } @@ -4333,1008 +4651,5497 @@ "smithy.api#output": {} } }, - "com.amazonaws.bedrockagent#GuardrailConfiguration": { + "com.amazonaws.bedrockagent#DeleteFlowRequest": { "type": "structure", "members": { - "guardrailIdentifier": { - "target": "com.amazonaws.bedrockagent#GuardrailIdentifier", + "flowIdentifier": { + "target": "com.amazonaws.bedrockagent#FlowIdentifier", "traits": { - "smithy.api#documentation": "

The guardrails identifier assigned to the guardrails configuration.

" + "smithy.api#documentation": "

The unique identifier of the flow.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "guardrailVersion": { - "target": "com.amazonaws.bedrockagent#GuardrailVersion", + "skipResourceInUseCheck": { + "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

The guardrails version assigned to the guardrails configuration.

" + "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.

", + "smithy.api#httpQuery": "skipResourceInUseCheck" } } }, "traits": { - "smithy.api#documentation": "

The details of the guardrails configuration.

" - } - }, - "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]+))$" + "smithy.api#input": {} } }, - "com.amazonaws.bedrockagent#GuardrailVersion": { - "type": "string", + "com.amazonaws.bedrockagent#DeleteFlowResponse": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.bedrockagent#FlowId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the flow.

", + "smithy.api#required": {} + } + } + }, "traits": { - "smithy.api#pattern": "^(([0-9]{1,8})|(DRAFT))$" + "smithy.api#output": {} } }, - "com.amazonaws.bedrockagent#Id": { - "type": "string", + "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#pattern": "^[0-9a-zA-Z]{10}$" + "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#InferenceConfiguration": { + "com.amazonaws.bedrockagent#DeleteFlowVersionRequest": { "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.

" - } - }, - "topK": { - "target": "com.amazonaws.bedrockagent#TopK", + "flowIdentifier": { + "target": "com.amazonaws.bedrockagent#FlowIdentifier", "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 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.

" + "smithy.api#documentation": "

The unique identifier of the flow whose version that you want to delete

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "maximumLength": { - "target": "com.amazonaws.bedrockagent#MaximumLength", + "flowVersion": { + "target": "com.amazonaws.bedrockagent#NumericalVersion", "traits": { - "smithy.api#documentation": "

The maximum number of tokens to allow in the generated response.

" + "smithy.api#documentation": "

The version of the flow that you want to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "stopSequences": { - "target": "com.amazonaws.bedrockagent#StopSequences", + "skipResourceInUseCheck": { + "target": "smithy.api#Boolean", "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.

" + "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.

", + "smithy.api#httpQuery": "skipResourceInUseCheck" } } }, "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.

" + "smithy.api#input": {} } }, - "com.amazonaws.bedrockagent#IngestionJob": { + "com.amazonaws.bedrockagent#DeleteFlowVersionResponse": { "type": "structure", "members": { - "knowledgeBaseId": { + "id": { "target": "com.amazonaws.bedrockagent#Id", "traits": { - "smithy.api#documentation": "

The unique identifier of the knowledge base to which the data source is being added.

", + "smithy.api#documentation": "

The unique identifier of the flow.

", "smithy.api#required": {} } }, - "dataSourceId": { - "target": "com.amazonaws.bedrockagent#Id", + "version": { + "target": "com.amazonaws.bedrockagent#NumericalVersion", "traits": { - "smithy.api#documentation": "

The unique identifier of the ingested data source.

", + "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" }, - "ingestionJobId": { + { + "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 ingestion job.

", + "smithy.api#documentation": "

The unique identifier of the knowledge base to delete.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "description": { - "target": "com.amazonaws.bedrockagent#Description", + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#DeleteKnowledgeBaseResponse": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", "traits": { - "smithy.api#documentation": "

The description of the ingestion job.

" + "smithy.api#documentation": "

The unique identifier of the knowledge base that was deleted.

", + "smithy.api#required": {} } }, "status": { - "target": "com.amazonaws.bedrockagent#IngestionJobStatus", + "target": "com.amazonaws.bedrockagent#KnowledgeBaseStatus", "traits": { - "smithy.api#documentation": "

The status of the ingestion job.

", + "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" }, - "statistics": { - "target": "com.amazonaws.bedrockagent#IngestionJobStatistics", - "traits": { - "smithy.api#documentation": "

Contains statistics about the ingestion job.

" - } + { + "target": "com.amazonaws.bedrockagent#ConflictException" }, - "failureReasons": { - "target": "com.amazonaws.bedrockagent#FailureReasons", - "traits": { - "smithy.api#documentation": "

A list of reasons that the ingestion job failed.

" - } + { + "target": "com.amazonaws.bedrockagent#InternalServerException" }, - "startedAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a prompt or a prompt version from the Prompt management tool. 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.

", + "smithy.api#http": { + "code": 200, + "method": "DELETE", + "uri": "/prompts/{promptIdentifier}/" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#DeletePromptRequest": { + "type": "structure", + "members": { + "promptIdentifier": { + "target": "com.amazonaws.bedrockagent#PromptIdentifier", "traits": { - "smithy.api#documentation": "

The time at which the ingestion job started.

", + "smithy.api#documentation": "

The unique identifier of the prompt.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "updatedAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", + "promptVersion": { + "target": "com.amazonaws.bedrockagent#NumericalVersion", "traits": { - "smithy.api#documentation": "

The time at which the ingestion job was last updated.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The version of the prompt to delete.

", + "smithy.api#httpQuery": "promptVersion" } } }, "traits": { - "smithy.api#documentation": "

Contains details about an ingestion job, which converts a data source to embeddings for a vector store in knowledge base.

\n

This data type is used in the following API operations:

\n " + "smithy.api#input": {} } }, - "com.amazonaws.bedrockagent#IngestionJobFilter": { + "com.amazonaws.bedrockagent#DeletePromptResponse": { "type": "structure", "members": { - "attribute": { - "target": "com.amazonaws.bedrockagent#IngestionJobFilterAttribute", + "id": { + "target": "com.amazonaws.bedrockagent#PromptId", "traits": { - "smithy.api#documentation": "

The attribute by which to filter the results.

", + "smithy.api#documentation": "

The unique identifier of the prompt that was deleted.

", "smithy.api#required": {} } }, - "operator": { - "target": "com.amazonaws.bedrockagent#IngestionJobFilterOperator", + "version": { + "target": "com.amazonaws.bedrockagent#NumericalVersion", "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": {} + "smithy.api#documentation": "

The version of the prompt that was deleted.

" } } }, "traits": { - "smithy.api#documentation": "

Defines a filter by which to filter the results.

" + "smithy.api#output": {} } }, - "com.amazonaws.bedrockagent#IngestionJobFilterAttribute": { - "type": "enum", + "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": { - "STATUS": { - "target": "smithy.api#Unit", + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", "traits": { - "smithy.api#enumValue": "STATUS" + "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#IngestionJobFilterOperator": { - "type": "enum", + "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": { - "EQ": { - "target": "smithy.api#Unit", + "bedrockEmbeddingModelConfiguration": { + "target": "com.amazonaws.bedrockagent#BedrockEmbeddingModelConfiguration", "traits": { - "smithy.api#enumValue": "EQ" + "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#IngestionJobFilterValue": { + "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": { - "min": 0, - "max": 100 - }, - "smithy.api#pattern": "^.*$" + "max": 2048 + } } }, - "com.amazonaws.bedrockagent#IngestionJobFilterValues": { + "com.amazonaws.bedrockagent#FailureReasons": { "type": "list", "member": { - "target": "com.amazonaws.bedrockagent#IngestionJobFilterValue" + "target": "com.amazonaws.bedrockagent#FailureReason" }, "traits": { "smithy.api#length": { - "min": 0, - "max": 10 + "max": 2048 } } }, - "com.amazonaws.bedrockagent#IngestionJobFilters": { + "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#IngestionJobFilter" + "target": "com.amazonaws.bedrockagent#FilterPattern" }, "traits": { "smithy.api#length": { "min": 1, - "max": 1 - } + "max": 25 + }, + "smithy.api#sensitive": {} } }, - "com.amazonaws.bedrockagent#IngestionJobResource": { - "type": "resource", - "operations": [ - { - "target": "com.amazonaws.bedrockagent#GetIngestionJob" + "com.amazonaws.bedrockagent#FilterPattern": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 }, - { - "target": "com.amazonaws.bedrockagent#ListIngestionJobs" + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#FilteredObjectType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 }, - { - "target": "com.amazonaws.bedrockagent#StartIngestionJob" - } - ] + "smithy.api#sensitive": {} + } }, - "com.amazonaws.bedrockagent#IngestionJobSortBy": { + "com.amazonaws.bedrockagent#FixedSizeChunkingConfiguration": { "type": "structure", "members": { - "attribute": { - "target": "com.amazonaws.bedrockagent#IngestionJobSortByAttribute", + "maxTokens": { + "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The attribute by which to sort the results.

", + "smithy.api#documentation": "

The maximum number of tokens to include in a chunk.

", + "smithy.api#range": { + "min": 1 + }, "smithy.api#required": {} } }, - "order": { - "target": "com.amazonaws.bedrockagent#SortOrder", + "overlapPercentage": { + "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The order by which to sort the results.

", + "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": "

Parameters by which to sort the results.

" + "smithy.api#documentation": "

Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy as NONE, exclude this field.

" } }, - "com.amazonaws.bedrockagent#IngestionJobSortByAttribute": { - "type": "enum", - "members": { - "STATUS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STATUS" - } + "com.amazonaws.bedrockagent#FlowAliasArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10}/alias/(TSTALIASID|[0-9a-zA-Z]{10})$" + } + }, + "com.amazonaws.bedrockagent#FlowAliasId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(TSTALIASID|[0-9a-zA-Z]{10})$" + } + }, + "com.amazonaws.bedrockagent#FlowAliasIdentifier": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10}/alias/[0-9a-zA-Z]{10})|(TSTALIASID|[0-9a-zA-Z]{10})$" + } + }, + "com.amazonaws.bedrockagent#FlowAliasResource": { + "type": "resource", + "identifiers": { + "flowIdentifier": { + "target": "com.amazonaws.bedrockagent#FlowIdentifier" }, - "STARTED_AT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STARTED_AT" - } + "aliasIdentifier": { + "target": "com.amazonaws.bedrockagent#FlowAliasIdentifier" + } + }, + "create": { + "target": "com.amazonaws.bedrockagent#CreateFlowAlias" + }, + "read": { + "target": "com.amazonaws.bedrockagent#GetFlowAlias" + }, + "update": { + "target": "com.amazonaws.bedrockagent#UpdateFlowAlias" + }, + "delete": { + "target": "com.amazonaws.bedrockagent#DeleteFlowAlias" + }, + "list": { + "target": "com.amazonaws.bedrockagent#ListFlowAliases" + }, + "traits": { + "aws.api#arn": { + "template": "flow/{flowIdentifier}/alias/{aliasIdentifier}" + }, + "aws.cloudformation#cfnResource": { + "name": "FlowAlias" } } }, - "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.

" - } - } + "com.amazonaws.bedrockagent#FlowAliasRoutingConfiguration": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#FlowAliasRoutingConfigurationListItem" }, "traits": { - "smithy.api#documentation": "

Contains the statistics for the ingestion job.

" + "smithy.api#length": { + "min": 1, + "max": 1 + } } }, - "com.amazonaws.bedrockagent#IngestionJobStatus": { - "type": "enum", + "com.amazonaws.bedrockagent#FlowAliasRoutingConfigurationListItem": { + "type": "structure", "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", + "flowVersion": { + "target": "com.amazonaws.bedrockagent#Version", "traits": { - "smithy.api#enumValue": "FAILED" + "smithy.api#documentation": "

The version that the alias maps to.

" } } + }, + "traits": { + "smithy.api#documentation": "

Contains information about a version that the alias maps to.

" } }, - "com.amazonaws.bedrockagent#IngestionJobSummaries": { + "com.amazonaws.bedrockagent#FlowAliasSummaries": { "type": "list", "member": { - "target": "com.amazonaws.bedrockagent#IngestionJobSummary" + "target": "com.amazonaws.bedrockagent#FlowAliasSummary" + }, + "traits": { + "smithy.api#length": { + "max": 10 + } } }, - "com.amazonaws.bedrockagent#IngestionJobSummary": { + "com.amazonaws.bedrockagent#FlowAliasSummary": { "type": "structure", "members": { - "knowledgeBaseId": { - "target": "com.amazonaws.bedrockagent#Id", + "name": { + "target": "com.amazonaws.bedrockagent#Name", "traits": { - "smithy.api#documentation": "

The unique identifier of the knowledge base to which the data source is added.

", + "smithy.api#documentation": "

The name of the alias.

", "smithy.api#required": {} } }, - "dataSourceId": { - "target": "com.amazonaws.bedrockagent#Id", + "description": { + "target": "com.amazonaws.bedrockagent#Description", "traits": { - "smithy.api#documentation": "

The unique identifier of the data source in the ingestion job.

", + "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": {} } }, - "ingestionJobId": { - "target": "com.amazonaws.bedrockagent#Id", + "flowId": { + "target": "com.amazonaws.bedrockagent#FlowId", "traits": { - "smithy.api#documentation": "

The unique identifier of the ingestion job.

", + "smithy.api#documentation": "

The unique identifier of the flow.

", "smithy.api#required": {} } }, - "description": { - "target": "com.amazonaws.bedrockagent#Description", + "id": { + "target": "com.amazonaws.bedrockagent#FlowAliasId", "traits": { - "smithy.api#documentation": "

The description of the ingestion job.

" + "smithy.api#documentation": "

The unique identifier of the alias of the flow.

", + "smithy.api#required": {} } }, - "status": { - "target": "com.amazonaws.bedrockagent#IngestionJobStatus", + "arn": { + "target": "com.amazonaws.bedrockagent#FlowAliasArn", "traits": { - "smithy.api#documentation": "

The status of the ingestion job.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the flow alias.

", "smithy.api#required": {} } }, - "startedAt": { + "createdAt": { "target": "com.amazonaws.bedrockagent#DateTimestamp", "traits": { - "smithy.api#documentation": "

The time at which the ingestion job was started.

", + "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 ingestion job was last updated.

", + "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.

\n

This data type is used in the following API operations:

\n " + } + }, + "com.amazonaws.bedrockagent#FlowArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10}$" + } + }, + "com.amazonaws.bedrockagent#FlowCondition": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#FlowConditionName", + "traits": { + "smithy.api#documentation": "

A name for the condition that you can reference.

", "smithy.api#required": {} } }, - "statistics": { - "target": "com.amazonaws.bedrockagent#IngestionJobStatistics", + "expression": { + "target": "com.amazonaws.bedrockagent#FlowConditionExpression", "traits": { - "smithy.api#documentation": "

Contains statistics for the ingestion job.

" + "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": "

Contains details about an ingestion job.

" + "smithy.api#documentation": "

Defines a condition in the condition node.

", + "smithy.api#sensitive": {} } }, - "com.amazonaws.bedrockagent#Instruction": { + "com.amazonaws.bedrockagent#FlowConditionExpression": { "type": "string", "traits": { "smithy.api#length": { - "min": 40, - "max": 4000 + "min": 1, + "max": 64 }, "smithy.api#sensitive": {} } }, - "com.amazonaws.bedrockagent#InternalServerException": { + "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": { - "message": { - "target": "com.amazonaws.bedrockagent#NonBlankString" + "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": "

An internal server error occurred. Retry your request.

", - "smithy.api#error": "server", - "smithy.api#httpError": 500 + "smithy.api#documentation": "

The configuration of a connection between a condition node and another node.

" } }, - "com.amazonaws.bedrockagent#KmsKeyArn": { - "type": "string", + "com.amazonaws.bedrockagent#FlowConditions": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#FlowCondition" + }, "traits": { "smithy.api#length": { "min": 1, - "max": 2048 + "max": 5 }, - "smithy.api#pattern": "^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$" + "smithy.api#sensitive": {} } }, - "com.amazonaws.bedrockagent#KnowledgeBase": { + "com.amazonaws.bedrockagent#FlowConnection": { "type": "structure", "members": { - "knowledgeBaseId": { - "target": "com.amazonaws.bedrockagent#Id", + "type": { + "target": "com.amazonaws.bedrockagent#FlowConnectionType", "traits": { - "smithy.api#documentation": "

The unique identifier of the knowledge base.

", + "smithy.api#documentation": "

Whether the source node that the connection begins from is a condition node (Conditional) or not (Data).

", "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", + "target": "com.amazonaws.bedrockagent#FlowConnectionName", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the knowledge base.

", + "smithy.api#documentation": "

A name for the connection that you can reference.

", "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", + "source": { + "target": "com.amazonaws.bedrockagent#FlowNodeName", "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#documentation": "

The node that the connection starts at.

", "smithy.api#required": {} } }, - "knowledgeBaseConfiguration": { - "target": "com.amazonaws.bedrockagent#KnowledgeBaseConfiguration", + "target": { + "target": "com.amazonaws.bedrockagent#FlowNodeName", "traits": { - "smithy.api#documentation": "

Contains details about the embeddings configuration of the knowledge base.

", + "smithy.api#documentation": "

The node that the connection ends at.

", "smithy.api#required": {} } }, - "storageConfiguration": { - "target": "com.amazonaws.bedrockagent#StorageConfiguration", + "configuration": { + "target": "com.amazonaws.bedrockagent#FlowConnectionConfiguration", "traits": { - "smithy.api#documentation": "

Contains details about the storage configuration of the knowledge base.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The configuration of the connection.

" } - }, - "status": { - "target": "com.amazonaws.bedrockagent#KnowledgeBaseStatus", + } + }, + "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 status of the knowledge base. The following statuses are possible:

\n ", - "smithy.api#required": {} + "smithy.api#documentation": "

The configuration of a connection originating from a node that isn't a Condition node.

" } }, - "createdAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", + "conditional": { + "target": "com.amazonaws.bedrockagent#FlowConditionalConnectionConfiguration", "traits": { - "smithy.api#documentation": "

The time at which the knowledge base was created.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The configuration of a connection originating from a Condition node.

" } - }, - "updatedAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", + } + }, + "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#documentation": "

The time at which the knowledge base was last updated.

", - "smithy.api#required": {} + "smithy.api#enumValue": "Data" } }, - "failureReasons": { - "target": "com.amazonaws.bedrockagent#FailureReasons", + "CONDITIONAL": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

A list of reasons that the API operation on the knowledge base failed.

" + "smithy.api#enumValue": "Conditional" } } - }, - "traits": { - "smithy.api#documentation": "

Contains information about a knowledge base.

" } }, - "com.amazonaws.bedrockagent#KnowledgeBaseArn": { - "type": "string", + "com.amazonaws.bedrockagent#FlowConnections": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#FlowConnection" + }, "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]+$" + "max": 20 + } } }, - "com.amazonaws.bedrockagent#KnowledgeBaseConfiguration": { + "com.amazonaws.bedrockagent#FlowDataConnectionConfiguration": { "type": "structure", "members": { - "type": { - "target": "com.amazonaws.bedrockagent#KnowledgeBaseType", + "sourceOutput": { + "target": "com.amazonaws.bedrockagent#FlowNodeOutputName", "traits": { - "smithy.api#documentation": "

The type of data that the data source is converted into for the knowledge base.

", + "smithy.api#documentation": "

The name of the output in the source node that the connection begins from.

", "smithy.api#required": {} } }, - "vectorKnowledgeBaseConfiguration": { - "target": "com.amazonaws.bedrockagent#VectorKnowledgeBaseConfiguration", + "targetInput": { + "target": "com.amazonaws.bedrockagent#FlowNodeInputName", "traits": { - "smithy.api#documentation": "

Contains details about the embeddings model that'sused to convert the data source.

" + "smithy.api#documentation": "

The name of the input in the target node that the connection ends at.

", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Contains details about the embeddings configuration of the knowledge base.

" + "smithy.api#documentation": "

The configuration of a connection originating from a node that isn't a Condition node.

" } }, - "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" + "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.

" + } }, - { - "target": "com.amazonaws.bedrockagent#UpdateKnowledgeBase" + "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#KnowledgeBaseRoleArn": { + "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/.+$" + "smithy.api#pattern": "^arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/(service-role/)?.+$" } }, - "com.amazonaws.bedrockagent#KnowledgeBaseState": { - "type": "enum", + "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": { - "ENABLED": { - "target": "smithy.api#Unit", + "name": { + "target": "com.amazonaws.bedrockagent#FlowNodeName", "traits": { - "smithy.api#enumValue": "ENABLED" + "smithy.api#documentation": "

A name for the node.

", + "smithy.api#required": {} } }, - "DISABLED": { - "target": "smithy.api#Unit", + "type": { + "target": "com.amazonaws.bedrockagent#FlowNodeType", "traits": { - "smithy.api#enumValue": "DISABLED" + "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.

", + "smithy.api#required": {} + } + }, + "configuration": { + "target": "com.amazonaws.bedrockagent#FlowNodeConfiguration", + "traits": { + "smithy.api#documentation": "

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#KnowledgeBaseStatus": { - "type": "enum", + "com.amazonaws.bedrockagent#FlowNodeConfiguration": { + "type": "union", "members": { - "CREATING": { - "target": "smithy.api#Unit", + "input": { + "target": "com.amazonaws.bedrockagent#InputFlowNodeConfiguration", "traits": { - "smithy.api#enumValue": "CREATING" + "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.

" } }, - "ACTIVE": { - "target": "smithy.api#Unit", + "output": { + "target": "com.amazonaws.bedrockagent#OutputFlowNodeConfiguration", "traits": { - "smithy.api#enumValue": "ACTIVE" + "smithy.api#documentation": "

Contains configurations for an output flow node in your flow. The last node in the flow. outputs can't be specified for this node.

" } }, - "DELETING": { - "target": "smithy.api#Unit", + "knowledgeBase": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseFlowNodeConfiguration", "traits": { - "smithy.api#enumValue": "DELETING" + "smithy.api#documentation": "

Contains configurations for a knowledge base node in your flow. Queries a knowledge base and returns the retrieved results or generated response.

" } }, - "UPDATING": { - "target": "smithy.api#Unit", + "condition": { + "target": "com.amazonaws.bedrockagent#ConditionFlowNodeConfiguration", "traits": { - "smithy.api#enumValue": "UPDATING" + "smithy.api#documentation": "

Contains configurations for a Condition node in your flow. Defines conditions that lead to different branches of the flow.

" } }, - "FAILED": { - "target": "smithy.api#Unit", + "lex": { + "target": "com.amazonaws.bedrockagent#LexFlowNodeConfiguration", "traits": { - "smithy.api#enumValue": "FAILED" + "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.

" } }, - "DELETE_UNSUCCESSFUL": { - "target": "smithy.api#Unit", + "prompt": { + "target": "com.amazonaws.bedrockagent#PromptFlowNodeConfiguration", "traits": { - "smithy.api#enumValue": "DELETE_UNSUCCESSFUL" + "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.

\n

The 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#KnowledgeBaseStorageType": { + "com.amazonaws.bedrockagent#FlowNodeIODataType": { "type": "enum", "members": { - "OPENSEARCH_SERVERLESS": { + "STRING": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "OPENSEARCH_SERVERLESS" + "smithy.api#enumValue": "String" } }, - "PINECONE": { + "NUMBER": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "PINECONE" + "smithy.api#enumValue": "Number" } }, - "REDIS_ENTERPRISE_CLOUD": { + "BOOLEAN": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "REDIS_ENTERPRISE_CLOUD" + "smithy.api#enumValue": "Boolean" } }, - "RDS": { + "OBJECT": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "RDS" + "smithy.api#enumValue": "Object" } }, - "MONGO_DB_ATLAS": { + "ARRAY": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "MONGO_DB_ATLAS" + "smithy.api#enumValue": "Array" } } } }, - "com.amazonaws.bedrockagent#KnowledgeBaseSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagent#KnowledgeBaseSummary" - } - }, - "com.amazonaws.bedrockagent#KnowledgeBaseSummary": { + "com.amazonaws.bedrockagent#FlowNodeInput": { "type": "structure", "members": { - "knowledgeBaseId": { - "target": "com.amazonaws.bedrockagent#Id", + "name": { + "target": "com.amazonaws.bedrockagent#FlowNodeInputName", "traits": { - "smithy.api#documentation": "

The unique identifier of the knowledge base.

", + "smithy.api#documentation": "

A name for the input that you can reference.

", "smithy.api#required": {} } }, - "name": { - "target": "com.amazonaws.bedrockagent#Name", + "type": { + "target": "com.amazonaws.bedrockagent#FlowNodeIODataType", "traits": { - "smithy.api#documentation": "

The name of the knowledge base.

", + "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": {} } }, - "description": { - "target": "com.amazonaws.bedrockagent#Description", + "expression": { + "target": "com.amazonaws.bedrockagent#FlowNodeInputExpression", "traits": { - "smithy.api#documentation": "

The description of the knowledge base.

" + "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 }, - "status": { - "target": "com.amazonaws.bedrockagent#KnowledgeBaseStatus", + "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": "

The status of the knowledge base.

", + "smithy.api#documentation": "

A name for the output that you can reference.

", "smithy.api#required": {} } }, - "updatedAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", + "type": { + "target": "com.amazonaws.bedrockagent#FlowNodeIODataType", "traits": { - "smithy.api#documentation": "

The time at which the knowledge base was last updated.

", + "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 details about a knowledge base.

" + "smithy.api#documentation": "

Contains configurations for an output from a node.

" } }, - "com.amazonaws.bedrockagent#KnowledgeBaseType": { - "type": "enum", - "members": { - "VECTOR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VECTOR" - } - } + "com.amazonaws.bedrockagent#FlowNodeOutputName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$" } }, - "com.amazonaws.bedrockagent#LambdaArn": { - "type": "string", + "com.amazonaws.bedrockagent#FlowNodeOutputs": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#FlowNodeOutput" + }, "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-_]+))?$" + "max": 5 + } } }, - "com.amazonaws.bedrockagent#ListAgentActionGroups": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#ListAgentActionGroupsRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#ListAgentActionGroupsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" + "com.amazonaws.bedrockagent#FlowNodeType": { + "type": "enum", + "members": { + "INPUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Input" + } }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" + "OUTPUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Output" + } }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + "KNOWLEDGE_BASE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KnowledgeBase" + } }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" + "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:

\n ", + "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 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.

\n

This data type is used in the following API operations:

\n " + } + }, + "com.amazonaws.bedrockagent#FlowValidationSeverity": { + "type": "enum", + "members": { + "WARNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Warning" + } + }, + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Error" + } + } + } + }, + "com.amazonaws.bedrockagent#FlowValidations": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#FlowValidation" + }, + "traits": { + "smithy.api#length": { + "max": 100 + } + } + }, + "com.amazonaws.bedrockagent#FlowVersionResource": { + "type": "resource", + "identifiers": { + "flowIdentifier": { + "target": "com.amazonaws.bedrockagent#FlowIdentifier" + }, + "flowVersion": { + "target": "com.amazonaws.bedrockagent#NumericalVersion" + } + }, + "create": { + "target": "com.amazonaws.bedrockagent#CreateFlowVersion" + }, + "read": { + "target": "com.amazonaws.bedrockagent#GetFlowVersion" + }, + "delete": { + "target": "com.amazonaws.bedrockagent#DeleteFlowVersion" + }, + "list": { + "target": "com.amazonaws.bedrockagent#ListFlowVersions" + }, + "traits": { + "aws.cloudformation#cfnResource": { + "name": "FlowVersion" + } + } + }, + "com.amazonaws.bedrockagent#FlowVersionSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#FlowVersionSummary" + }, + "traits": { + "smithy.api#length": { + "max": 10 + } + } + }, + "com.amazonaws.bedrockagent#FlowVersionSummary": { + "type": "structure", + "members": { + "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 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 flow 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 the flow version.

\n

This data type is used in the following API operations:

\n " + } + }, + "com.amazonaws.bedrockagent#Function": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagent#Name", + "traits": { + "smithy.api#documentation": "

A 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.

" + } + } + }, + "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.

\n

This data type is used in the following API operations:

\n " + } + }, + "com.amazonaws.bedrockagent#FunctionDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1200 + } + } + }, + "com.amazonaws.bedrockagent#FunctionSchema": { + "type": "union", + "members": { + "functions": { + "target": "com.amazonaws.bedrockagent#Functions", + "traits": { + "smithy.api#documentation": "

A 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.

\n

This data type is used in the following API operations:

\n " + } + }, + "com.amazonaws.bedrockagent#Functions": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#Function" + } + }, + "com.amazonaws.bedrockagent#GetAgent": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#GetAgentRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#GetAgentResponse" + }, + "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 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 flow 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 flow 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:

\n ", + "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 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 flow 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 a prompt or a version of it. 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.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/prompts/{promptIdentifier}/" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#GetPromptRequest": { + "type": "structure", + "members": { + "promptIdentifier": { + "target": "com.amazonaws.bedrockagent#PromptIdentifier", + "traits": { + "smithy.api#documentation": "

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.

", + "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.

" + } + }, + "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.

", + "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.

\n

You 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.

" + } + }, + "topK": { + "target": "com.amazonaws.bedrockagent#TopK", + "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 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.

" + } + }, + "maximumLength": { + "target": "com.amazonaws.bedrockagent#MaximumLength", + "traits": { + "smithy.api#documentation": "

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.

" + } + }, + "com.amazonaws.bedrockagent#IngestionJob": { + "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 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.

\n

This data type is used in the following API operations:

\n " + } + }, + "com.amazonaws.bedrockagent#IngestionJobFilter": { + "type": "structure", + "members": { + "attribute": { + "target": "com.amazonaws.bedrockagent#IngestionJobFilterAttribute", + "traits": { + "smithy.api#documentation": "

The 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.

\n

The 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:

\n ", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "

The 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.

" + } + }, + "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, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#ListAgentActionGroupsResponse": { + "type": "structure", + "members": { + "actionGroupSummaries": { + "target": "com.amazonaws.bedrockagent#ActionGroupSummaries", + "traits": { + "smithy.api#documentation": "

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.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#ListAgentAliases": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#ListAgentAliasesRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#ListAgentAliasesResponse" + }, + "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 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.

" + } + }, + "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, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#ListAgentAliasesResponse": { + "type": "structure", + "members": { + "agentAliasSummaries": { + "target": "com.amazonaws.bedrockagent#AgentAliasSummaries", + "traits": { + "smithy.api#documentation": "

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.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#ListAgentKnowledgeBases": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#ListAgentKnowledgeBasesRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#ListAgentKnowledgeBasesResponse" + }, + "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 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.

" + } + }, + "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, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#ListAgentKnowledgeBasesResponse": { + "type": "structure", + "members": { + "agentKnowledgeBaseSummaries": { + "target": "com.amazonaws.bedrockagent#AgentKnowledgeBaseSummaries", + "traits": { + "smithy.api#documentation": "

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.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#ListAgentVersions": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#ListAgentVersionsRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#ListAgentVersionsResponse" + }, + "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 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.

" + } + }, + "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, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#ListAgentVersionsResponse": { + "type": "structure", + "members": { + "agentVersionSummaries": { + "target": "com.amazonaws.bedrockagent#AgentVersionSummaries", + "traits": { + "smithy.api#documentation": "

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.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#ListAgents": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#ListAgentsRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#ListAgentsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

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.

" + } + }, + "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, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#ListAgentsResponse": { + "type": "structure", + "members": { + "agentSummaries": { + "target": "com.amazonaws.bedrockagent#AgentSummaries", + "traits": { + "smithy.api#documentation": "

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.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#ListDataSources": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#ListDataSourcesRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#ListDataSourcesResponse" + }, + "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 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.

" + } + }, + "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, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#ListDataSourcesResponse": { + "type": "structure", + "members": { + "dataSourceSummaries": { + "target": "com.amazonaws.bedrockagent#DataSourceSummaries", + "traits": { + "smithy.api#documentation": "

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.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#ListFlowAliases": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#ListFlowAliasesRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#ListFlowAliasesResponse" + }, + "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": "

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.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "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, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#ListFlowAliasesResponse": { + "type": "structure", + "members": { + "flowAliasSummaries": { + "target": "com.amazonaws.bedrockagent#FlowAliasSummaries", + "traits": { + "smithy.api#documentation": "

A list, each member of which contains information about a flow 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.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#ListFlowVersions": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#ListFlowVersionsRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#ListFlowVersionsResponse" + }, + "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": "

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.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "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, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#ListFlowVersionsResponse": { + "type": "structure", + "members": { + "flowVersionSummaries": { + "target": "com.amazonaws.bedrockagent#FlowVersionSummaries", + "traits": { + "smithy.api#documentation": "

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.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#ListFlows": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#ListFlowsRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#ListFlowsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

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.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "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, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#ListFlowsResponse": { + "type": "structure", + "members": { + "flowSummaries": { + "target": "com.amazonaws.bedrockagent#FlowSummaries", + "traits": { + "smithy.api#documentation": "

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.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#ListIngestionJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#ListIngestionJobsRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#ListIngestionJobsResponse" + }, + "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 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.

" + } + }, + "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, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#ListIngestionJobsResponse": { + "type": "structure", + "members": { + "ingestionJobSummaries": { + "target": "com.amazonaws.bedrockagent#IngestionJobSummaries", + "traits": { + "smithy.api#documentation": "

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.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#ListKnowledgeBases": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#ListKnowledgeBasesRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#ListKnowledgeBasesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

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.

" + } + }, + "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, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#ListKnowledgeBasesResponse": { + "type": "structure", + "members": { + "knowledgeBaseSummaries": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseSummaries", + "traits": { + "smithy.api#documentation": "

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.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#ListPrompts": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#ListPromptsRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#ListPromptsResponse" + }, + "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": "

Returns a list of prompts from the Prompt management tool and information about each prompt. For more information, see View information about prompts using Prompt management in the Amazon Bedrock User Guide.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/prompts/" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "promptSummaries" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#ListPromptsRequest": { + "type": "structure", + "members": { + "promptIdentifier": { + "target": "com.amazonaws.bedrockagent#PromptIdentifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the prompt.

", + "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.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "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, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#ListPromptsResponse": { + "type": "structure", + "members": { + "promptSummaries": { + "target": "com.amazonaws.bedrockagent#PromptSummaries", + "traits": { + "smithy.api#documentation": "

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.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagent#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#ListTagsForResourceResponse" + }, + "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": "

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.

" + } + }, + "com.amazonaws.bedrockagent#ParameterDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 500 + } + } + }, + "com.amazonaws.bedrockagent#ParameterDetail": { + "type": "structure", + "members": { + "description": { + "target": "com.amazonaws.bedrockagent#ParameterDescription", + "traits": { + "smithy.api#documentation": "

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.

\n

This data type is used in the following API operations:

\n " + } + }, + "com.amazonaws.bedrockagent#ParameterMap": { + "type": "map", + "key": { + "target": "com.amazonaws.bedrockagent#Name" + }, + "value": { + "target": "com.amazonaws.bedrockagent#ParameterDetail" + } + }, + "com.amazonaws.bedrockagent#ParsingConfiguration": { + "type": "structure", + "members": { + "parsingStrategy": { + "target": "com.amazonaws.bedrockagent#ParsingStrategy", + "traits": { + "smithy.api#documentation": "

The parsing strategy for the data source.

", + "smithy.api#required": {} + } }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" + "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": "

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" - ] + "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.

\n

To 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.

\n \n

You can get the ARN of a model with the action. Standard model usage\n charges apply for the foundation model parsing strategy.

" } }, - "com.amazonaws.bedrockagent#ListAgentActionGroupsRequest": { + "com.amazonaws.bedrockagent#ParsingPrompt": { "type": "structure", "members": { - "agentId": { - "target": "com.amazonaws.bedrockagent#Id", + "parsingPromptText": { + "target": "com.amazonaws.bedrockagent#ParsingPromptText", "traits": { - "smithy.api#documentation": "

The unique identifier of the agent.

", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

Instructions for interpreting the contents of a document.

", "smithy.api#required": {} } - }, - "agentVersion": { - "target": "com.amazonaws.bedrockagent#Version", + } + }, + "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#documentation": "

The version of the agent.

", - "smithy.api#httpLabel": {}, + "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": {} } }, - "maxResults": { - "target": "com.amazonaws.bedrockagent#MaxResults", + "inclusionFilters": { + "target": "com.amazonaws.bedrockagent#FilterList", "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.

" + "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.

" } }, - "nextToken": { - "target": "com.amazonaws.bedrockagent#NextToken", + "exclusionFilters": { + "target": "com.amazonaws.bedrockagent#FilterList", "traits": { - "smithy.api#documentation": "

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.

" + "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#input": {} + "smithy.api#documentation": "

The specific filters applied to your data source content. You can filter out or \n include certain content.

" } }, - "com.amazonaws.bedrockagent#ListAgentActionGroupsResponse": { + "com.amazonaws.bedrockagent#PatternObjectFilterConfiguration": { "type": "structure", "members": { - "actionGroupSummaries": { - "target": "com.amazonaws.bedrockagent#ActionGroupSummaries", + "filters": { + "target": "com.amazonaws.bedrockagent#PatternObjectFilterList", "traits": { - "smithy.api#documentation": "

A list of objects, each of which contains information about an action group.

", + "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": {} } - }, - "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.

" - } } }, "traits": { - "smithy.api#output": {} + "smithy.api#documentation": "

The configuration of filtering certain objects or content types of the data source.

" } }, - "com.amazonaws.bedrockagent#ListAgentAliases": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#ListAgentAliasesRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#ListAgentAliasesResponse" + "com.amazonaws.bedrockagent#PatternObjectFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#PatternObjectFilter" }, - "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 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#length": { + "min": 1, + "max": 25 }, - "smithy.api#readonly": {}, - "smithy.api#tags": [ - "console" - ] + "smithy.api#sensitive": {} } }, - "com.amazonaws.bedrockagent#ListAgentAliasesRequest": { + "com.amazonaws.bedrockagent#Payload": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#PineconeConfiguration": { "type": "structure", "members": { - "agentId": { - "target": "com.amazonaws.bedrockagent#Id", + "connectionString": { + "target": "com.amazonaws.bedrockagent#PineconeConnectionString", "traits": { - "smithy.api#documentation": "

The unique identifier of the agent.

", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

The endpoint URL for your index management page.

", "smithy.api#required": {} } }, - "maxResults": { - "target": "com.amazonaws.bedrockagent#MaxResults", + "credentialsSecretArn": { + "target": "com.amazonaws.bedrockagent#SecretArn", "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.

" + "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": {} } }, - "nextToken": { - "target": "com.amazonaws.bedrockagent#NextToken", + "namespace": { + "target": "com.amazonaws.bedrockagent#PineconeNamespace", "traits": { - "smithy.api#documentation": "

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.

" + "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#input": {} + "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#ListAgentAliasesResponse": { + "com.amazonaws.bedrockagent#PineconeConnectionString": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.bedrockagent#PineconeFieldMapping": { "type": "structure", "members": { - "agentAliasSummaries": { - "target": "com.amazonaws.bedrockagent#AgentAliasSummaries", + "textField": { + "target": "com.amazonaws.bedrockagent#FieldName", "traits": { - "smithy.api#documentation": "

A list of objects, each of which contains information about an alias of the agent.

", + "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": {} } }, - "nextToken": { - "target": "com.amazonaws.bedrockagent#NextToken", + "metadataField": { + "target": "com.amazonaws.bedrockagent#FieldName", "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.

" + "smithy.api#documentation": "

The name of the field in which Amazon Bedrock stores metadata about the vector store.

", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#output": {} + "smithy.api#documentation": "

Contains the names of the fields to which to map information about the vector store.

" } }, - "com.amazonaws.bedrockagent#ListAgentKnowledgeBases": { + "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#ListAgentKnowledgeBasesRequest" + "target": "com.amazonaws.bedrockagent#PrepareAgentRequest" }, "output": { - "target": "com.amazonaws.bedrockagent#ListAgentKnowledgeBasesResponse" + "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" }, @@ -5343,74 +10150,62 @@ } ], "traits": { - "smithy.api#documentation": "

Lists knowledge bases associated with an agent and information about each one.

", + "smithy.api#documentation": "

Creates a DRAFT version of the agent that can be used for internal testing.

", "smithy.api#http": { - "code": 200, + "code": 202, "method": "POST", - "uri": "/agents/{agentId}/agentversions/{agentVersion}/knowledgebases/" - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "agentKnowledgeBaseSummaries" + "uri": "/agents/{agentId}/" }, - "smithy.api#readonly": {}, "smithy.api#tags": [ "console" ] } }, - "com.amazonaws.bedrockagent#ListAgentKnowledgeBasesRequest": { + "com.amazonaws.bedrockagent#PrepareAgentRequest": { "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#documentation": "

The unique identifier of the agent for which to create a DRAFT version.

", "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.

" - } - }, - "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, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

" - } } }, "traits": { "smithy.api#input": {} } }, - "com.amazonaws.bedrockagent#ListAgentKnowledgeBasesResponse": { + "com.amazonaws.bedrockagent#PrepareAgentResponse": { "type": "structure", "members": { - "agentKnowledgeBaseSummaries": { - "target": "com.amazonaws.bedrockagent#AgentKnowledgeBaseSummaries", + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "

The unique identifier of the agent for which the DRAFT version was created.

", + "smithy.api#required": {} + } + }, + "agentStatus": { + "target": "com.amazonaws.bedrockagent#AgentStatus", + "traits": { + "smithy.api#documentation": "

The status of the DRAFT version and whether it is ready for use.

", + "smithy.api#required": {} + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagent#Version", "traits": { - "smithy.api#documentation": "

A list of objects, each of which contains information about a knowledge base associated with the agent.

", + "smithy.api#documentation": "

The version of the agent.

", "smithy.api#required": {} } }, - "nextToken": { - "target": "com.amazonaws.bedrockagent#NextToken", + "preparedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", "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.

" + "smithy.api#documentation": "

The time at which the DRAFT version of the agent was last prepared.

", + "smithy.api#required": {} } } }, @@ -5418,24 +10213,30 @@ "smithy.api#output": {} } }, - "com.amazonaws.bedrockagent#ListAgentVersions": { + "com.amazonaws.bedrockagent#PrepareFlow": { "type": "operation", "input": { - "target": "com.amazonaws.bedrockagent#ListAgentVersionsRequest" + "target": "com.amazonaws.bedrockagent#PrepareFlowRequest" }, "output": { - "target": "com.amazonaws.bedrockagent#ListAgentVersionsResponse" + "target": "com.amazonaws.bedrockagent#PrepareFlowResponse" }, "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" }, @@ -5444,66 +10245,48 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the versions of an agent and information about each version.

", + "smithy.api#documentation": "

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.

", "smithy.api#http": { - "code": 200, + "code": 202, "method": "POST", - "uri": "/agents/{agentId}/agentversions/" - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "agentVersionSummaries" + "uri": "/flows/{flowIdentifier}/" }, - "smithy.api#readonly": {}, "smithy.api#tags": [ "console" ] } }, - "com.amazonaws.bedrockagent#ListAgentVersionsRequest": { + "com.amazonaws.bedrockagent#PrepareFlowRequest": { "type": "structure", "members": { - "agentId": { - "target": "com.amazonaws.bedrockagent#Id", + "flowIdentifier": { + "target": "com.amazonaws.bedrockagent#FlowIdentifier", "traits": { - "smithy.api#documentation": "

The unique identifier of the agent.

", + "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.

" - } - }, - "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, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

" - } } }, "traits": { "smithy.api#input": {} } }, - "com.amazonaws.bedrockagent#ListAgentVersionsResponse": { + "com.amazonaws.bedrockagent#PrepareFlowResponse": { "type": "structure", "members": { - "agentVersionSummaries": { - "target": "com.amazonaws.bedrockagent#AgentVersionSummaries", + "id": { + "target": "com.amazonaws.bedrockagent#FlowId", "traits": { - "smithy.api#documentation": "

A list of objects, each of which contains information about a version of the agent.

", + "smithy.api#documentation": "

The unique identifier of the flow.

", "smithy.api#required": {} } }, - "nextToken": { - "target": "com.amazonaws.bedrockagent#NextToken", + "status": { + "target": "com.amazonaws.bedrockagent#FlowStatus", "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.

" + "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.

", + "smithy.api#required": {} } } }, @@ -5511,581 +10294,619 @@ "smithy.api#output": {} } }, - "com.amazonaws.bedrockagent#ListAgents": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#ListAgentsRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#ListAgentsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" + "com.amazonaws.bedrockagent#PromptArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:prompt/[0-9a-zA-Z]{10}(?::[0-9]{1,5})?)$" + } + }, + "com.amazonaws.bedrockagent#PromptConfiguration": { + "type": "structure", + "members": { + "promptType": { + "target": "com.amazonaws.bedrockagent#PromptType", + "traits": { + "smithy.api#documentation": "

The step in the agent sequence that this prompt configuration applies to.

" + } }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" + "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.

" + } }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" + "promptState": { + "target": "com.amazonaws.bedrockagent#PromptState", + "traits": { + "smithy.api#documentation": "

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 " + } }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists the agents belonging to an account and information about each agent.

", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/agents/" + "basePromptTemplate": { + "target": "com.amazonaws.bedrockagent#BasePromptTemplate", + "traits": { + "smithy.api#documentation": "

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.

" + } }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "agentSummaries" + "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.

" + } }, - "smithy.api#readonly": {}, - "smithy.api#tags": [ - "console" - ] + "parserMode": { + "target": "com.amazonaws.bedrockagent#CreationMode", + "traits": { + "smithy.api#documentation": "

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.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains configurations to override a prompt template in one part of an agent sequence. For more information, see Advanced prompts.

" } }, - "com.amazonaws.bedrockagent#ListAgentsRequest": { + "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": { - "maxResults": { - "target": "com.amazonaws.bedrockagent#MaxResults", + "sourceConfiguration": { + "target": "com.amazonaws.bedrockagent#PromptFlowNodeSourceConfiguration", "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.

" + "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": {} } }, - "nextToken": { - "target": "com.amazonaws.bedrockagent#NextToken", + "templateConfiguration": { + "target": "com.amazonaws.bedrockagent#PromptTemplateConfiguration", "traits": { - "smithy.api#documentation": "

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.

" + "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#input": {} + "smithy.api#documentation": "

Contains configurations for a prompt defined inline in the node.

" } }, - "com.amazonaws.bedrockagent#ListAgentsResponse": { + "com.amazonaws.bedrockagent#PromptFlowNodeResourceConfiguration": { "type": "structure", "members": { - "agentSummaries": { - "target": "com.amazonaws.bedrockagent#AgentSummaries", + "promptArn": { + "target": "com.amazonaws.bedrockagent#PromptArn", "traits": { - "smithy.api#documentation": "

A list of objects, each of which contains information about an agent.

", + "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.

" + } }, - "nextToken": { - "target": "com.amazonaws.bedrockagent#NextToken", + "inline": { + "target": "com.amazonaws.bedrockagent#PromptFlowNodeInlineConfiguration", "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.

" + "smithy.api#documentation": "

Contains configurations for a prompt that is defined inline

" } } }, "traits": { - "smithy.api#output": {} + "smithy.api#documentation": "

Contains configurations for a prompt and whether it is from Prompt management or defined inline.

" } }, - "com.amazonaws.bedrockagent#ListDataSources": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#ListDataSourcesRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#ListDataSourcesResponse" + "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.

" + } + } }, - "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": "

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": "

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#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#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "dataSourceSummaries" + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#PromptModelIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 }, - "smithy.api#readonly": {}, - "smithy.api#tags": [ - "console" - ] + "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#ListDataSourcesRequest": { + "com.amazonaws.bedrockagent#PromptModelInferenceConfiguration": { "type": "structure", "members": { - "knowledgeBaseId": { - "target": "com.amazonaws.bedrockagent#Id", + "temperature": { + "target": "com.amazonaws.bedrockagent#Temperature", "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": {} + "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.

" } }, - "maxResults": { - "target": "com.amazonaws.bedrockagent#MaxResults", + "topP": { + "target": "com.amazonaws.bedrockagent#TopP", "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.

" + "smithy.api#documentation": "

The percentage of most-likely candidates that the model considers for the next token.

" } }, - "nextToken": { - "target": "com.amazonaws.bedrockagent#NextToken", + "topK": { + "target": "com.amazonaws.bedrockagent#TopK", "traits": { - "smithy.api#documentation": "

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.

" + "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#input": {} + "smithy.api#documentation": "

Contains inference configurations related to model inference for a prompt. For more information, see Inference parameters.

" } }, - "com.amazonaws.bedrockagent#ListDataSourcesResponse": { + "com.amazonaws.bedrockagent#PromptName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^([0-9a-zA-Z][_-]?){1,100}$" + } + }, + "com.amazonaws.bedrockagent#PromptOverrideConfiguration": { "type": "structure", "members": { - "dataSourceSummaries": { - "target": "com.amazonaws.bedrockagent#DataSourceSummaries", + "promptConfigurations": { + "target": "com.amazonaws.bedrockagent#PromptConfigurations", "traits": { - "smithy.api#documentation": "

A list of objects, each of which contains information about a data source.

", + "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": {} } }, - "nextToken": { - "target": "com.amazonaws.bedrockagent#NextToken", + "overrideLambda": { + "target": "com.amazonaws.bedrockagent#LambdaArn", "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.

" + "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.

" } } }, "traits": { - "smithy.api#output": {} + "smithy.api#documentation": "

Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.

", + "smithy.api#sensitive": {} } }, - "com.amazonaws.bedrockagent#ListIngestionJobs": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#ListIngestionJobsRequest" + "com.amazonaws.bedrockagent#PromptResource": { + "type": "resource", + "identifiers": { + "promptIdentifier": { + "target": "com.amazonaws.bedrockagent#PromptIdentifier" + } }, - "output": { - "target": "com.amazonaws.bedrockagent#ListIngestionJobsResponse" + "create": { + "target": "com.amazonaws.bedrockagent#CreatePrompt" }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, + "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#ValidationException" + "target": "com.amazonaws.bedrockagent#CreatePromptVersion" } ], "traits": { - "smithy.api#documentation": "

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" + "aws.cloudformation#cfnResource": { + "name": "Prompt" + } + } + }, + "com.amazonaws.bedrockagent#PromptState": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } }, - "smithy.api#readonly": {}, - "smithy.api#tags": [ - "console" - ] + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } } }, - "com.amazonaws.bedrockagent#ListIngestionJobsRequest": { + "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": { - "knowledgeBaseId": { - "target": "com.amazonaws.bedrockagent#Id", + "name": { + "target": "com.amazonaws.bedrockagent#PromptName", "traits": { - "smithy.api#documentation": "

The unique identifier of the knowledge base for which to return ingestion jobs.

", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

The name of the prompt.

", "smithy.api#required": {} } }, - "dataSourceId": { - "target": "com.amazonaws.bedrockagent#Id", + "description": { + "target": "com.amazonaws.bedrockagent#PromptDescription", "traits": { - "smithy.api#documentation": "

The unique identifier of the data source for which to return ingestion jobs.

", - "smithy.api#httpLabel": {}, + "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": {} } }, - "filters": { - "target": "com.amazonaws.bedrockagent#IngestionJobFilters", + "arn": { + "target": "com.amazonaws.bedrockagent#PromptArn", "traits": { - "smithy.api#documentation": "

Contains a definition of a filter for which to filter the results.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the prompt.

", + "smithy.api#required": {} } }, - "sortBy": { - "target": "com.amazonaws.bedrockagent#IngestionJobSortBy", + "version": { + "target": "com.amazonaws.bedrockagent#Version", "traits": { - "smithy.api#documentation": "

Contains details about how to sort the results.

" + "smithy.api#documentation": "

The version of the prompt that this summary applies to.

", + "smithy.api#required": {} } }, - "maxResults": { - "target": "com.amazonaws.bedrockagent#MaxResults", + "createdAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", "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.

" + "smithy.api#documentation": "

The time at which the prompt was created.

", + "smithy.api#required": {} } }, - "nextToken": { - "target": "com.amazonaws.bedrockagent#NextToken", + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", "traits": { - "smithy.api#documentation": "

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.

" + "smithy.api#documentation": "

The time at which the prompt was last updated.

", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#input": {} + "smithy.api#documentation": "

Contains information about a prompt in your Prompt management tool.

\n

This data type is used in the following API operations:

\n " } }, - "com.amazonaws.bedrockagent#ListIngestionJobsResponse": { - "type": "structure", + "com.amazonaws.bedrockagent#PromptTemplateConfiguration": { + "type": "union", "members": { - "ingestionJobSummaries": { - "target": "com.amazonaws.bedrockagent#IngestionJobSummaries", - "traits": { - "smithy.api#documentation": "

A list of objects, each of which contains information about an ingestion job.

", - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.bedrockagent#NextToken", + "text": { + "target": "com.amazonaws.bedrockagent#TextPromptTemplateConfiguration", "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.

" + "smithy.api#documentation": "

Contains configurations for the text in a message for a prompt.

" } } }, "traits": { - "smithy.api#output": {} + "smithy.api#documentation": "

Contains the message for a prompt. For more information, see Prompt management in Amazon Bedrock.

" } }, - "com.amazonaws.bedrockagent#ListKnowledgeBases": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#ListKnowledgeBasesRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#ListKnowledgeBasesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrockagent#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrockagent#InternalServerException" - }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" + "com.amazonaws.bedrockagent#PromptTemplateType": { + "type": "enum", + "members": { + "TEXT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TEXT" + } } - ], - "traits": { - "smithy.api#documentation": "

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", + "com.amazonaws.bedrockagent#PromptType": { + "type": "enum", "members": { - "maxResults": { - "target": "com.amazonaws.bedrockagent#MaxResults", + "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#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.

" + "smithy.api#enumValue": "POST_PROCESSING" } }, - "nextToken": { - "target": "com.amazonaws.bedrockagent#NextToken", + "KNOWLEDGE_BASE_RESPONSE_GENERATION": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

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.

" + "smithy.api#enumValue": "KNOWLEDGE_BASE_RESPONSE_GENERATION" } } - }, - "traits": { - "smithy.api#input": {} } }, - "com.amazonaws.bedrockagent#ListKnowledgeBasesResponse": { + "com.amazonaws.bedrockagent#PromptVariant": { "type": "structure", "members": { - "knowledgeBaseSummaries": { - "target": "com.amazonaws.bedrockagent#KnowledgeBaseSummaries", + "name": { + "target": "com.amazonaws.bedrockagent#PromptVariantName", "traits": { - "smithy.api#documentation": "

A list of objects, each of which contains information about a knowledge base.

", + "smithy.api#documentation": "

The name of the prompt variant.

", "smithy.api#required": {} } }, - "nextToken": { - "target": "com.amazonaws.bedrockagent#NextToken", + "templateType": { + "target": "com.amazonaws.bedrockagent#PromptTemplateType", "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.

" + "smithy.api#documentation": "

The type of prompt template to use.

", + "smithy.api#required": {} } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrockagent#ListTagsForResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrockagent#ListTagsForResourceRequest" - }, - "output": { - "target": "com.amazonaws.bedrockagent#ListTagsForResourceResponse" - }, - "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": "

List all the tags for the resource you specify.

", - "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/tags/{resourceArn}" + "templateConfiguration": { + "target": "com.amazonaws.bedrockagent#PromptTemplateConfiguration", + "traits": { + "smithy.api#documentation": "

Contains configurations for the prompt template.

" + } }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.bedrockagent#ListTagsForResourceRequest": { - "type": "structure", - "members": { - "resourceArn": { - "target": "com.amazonaws.bedrockagent#TaggableResourcesArn", + "modelId": { + "target": "com.amazonaws.bedrockagent#PromptModelIdentifier", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource for which to list tags.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

The unique identifier of the model with which to run inference on the prompt.

" } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#ListTagsForResourceResponse": { - "type": "structure", - "members": { - "tags": { - "target": "com.amazonaws.bedrockagent#TagsMap", + }, + "inferenceConfiguration": { + "target": "com.amazonaws.bedrockagent#PromptInferenceConfiguration", "traits": { - "smithy.api#documentation": "

The key-value pairs for the tags associated with the resource.

" + "smithy.api#documentation": "

Contains inference configurations for the prompt variant.

" } } }, "traits": { - "smithy.api#output": {} + "smithy.api#documentation": "

Contains details about a variant of the prompt.

", + "smithy.api#sensitive": {} } }, - "com.amazonaws.bedrockagent#MaxResults": { - "type": "integer", + "com.amazonaws.bedrockagent#PromptVariantList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#PromptVariant" + }, "traits": { - "smithy.api#range": { - "min": 1, - "max": 1000 - } + "smithy.api#length": { + "max": 3 + }, + "smithy.api#sensitive": {} } }, - "com.amazonaws.bedrockagent#MaximumLength": { - "type": "integer", + "com.amazonaws.bedrockagent#PromptVariantName": { + "type": "string", "traits": { - "smithy.api#range": { - "min": 0, - "max": 4096 - } + "smithy.api#pattern": "^([0-9a-zA-Z][_-]?){1,100}$" } }, - "com.amazonaws.bedrockagent#ModelIdentifier": { + "com.amazonaws.bedrockagent#ProvisionedModelIdentifier": { "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][_-]?)+)$" + "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#MongoDbAtlasCollectionName": { + "com.amazonaws.bedrockagent#RdsArn": { "type": "string", "traits": { - "smithy.api#length": { - "max": 63 - }, - "smithy.api#pattern": "^.*$" + "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#MongoDbAtlasConfiguration": { + "com.amazonaws.bedrockagent#RdsConfiguration": { "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", + "resourceArn": { + "target": "com.amazonaws.bedrockagent#RdsArn", "traits": { - "smithy.api#documentation": "

The database name in your MongoDB Atlas cluster for your knowledge base.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the vector store.

", "smithy.api#required": {} } }, - "collectionName": { - "target": "com.amazonaws.bedrockagent#MongoDbAtlasCollectionName", + "credentialsSecretArn": { + "target": "com.amazonaws.bedrockagent#SecretArn", "traits": { - "smithy.api#documentation": "

The collection name of the knowledge base in MongoDB Atlas.

", + "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": {} } }, - "vectorIndexName": { - "target": "com.amazonaws.bedrockagent#MongoDbAtlasIndexName", + "databaseName": { + "target": "com.amazonaws.bedrockagent#RdsDatabaseName", "traits": { - "smithy.api#documentation": "

The name of the MongoDB Atlas vector search index.

", + "smithy.api#documentation": "

The name of your Amazon RDS database.

", "smithy.api#required": {} } }, - "credentialsSecretArn": { - "target": "com.amazonaws.bedrockagent#SecretArn", + "tableName": { + "target": "com.amazonaws.bedrockagent#RdsTableName", "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#documentation": "

The name of the table in the database.

", "smithy.api#required": {} } }, "fieldMapping": { - "target": "com.amazonaws.bedrockagent#MongoDbAtlasFieldMapping", + "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": {} } - }, - "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.

" + "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#MongoDbAtlasDatabaseName": { + "com.amazonaws.bedrockagent#RdsDatabaseName": { "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._-]*)$" + "smithy.api#pattern": "^[a-zA-Z0-9_\\-]+$" } }, - "com.amazonaws.bedrockagent#MongoDbAtlasFieldMapping": { + "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#FieldName", + "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#FieldName", + "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#FieldName", + "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": {} @@ -6096,71 +10917,60 @@ "smithy.api#documentation": "

Contains the names of the fields to which to map information about the vector store.

" } }, - "com.amazonaws.bedrockagent#MongoDbAtlasIndexName": { + "com.amazonaws.bedrockagent#RdsTableName": { "type": "string", "traits": { "smithy.api#length": { - "max": 2048 + "max": 63 }, - "smithy.api#pattern": "^.*$" - } - }, - "com.amazonaws.bedrockagent#Name": { - "type": "string", - "traits": { - "smithy.api#pattern": "^([0-9a-zA-Z][_-]?){1,100}$" + "smithy.api#pattern": "^[a-zA-Z0-9_\\.\\-]+$" } }, - "com.amazonaws.bedrockagent#NextToken": { + "com.amazonaws.bedrockagent#RecommendedAction": { "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", + "com.amazonaws.bedrockagent#RecommendedActions": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#RecommendedAction" + }, "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": { + "com.amazonaws.bedrockagent#RedisEnterpriseCloudConfiguration": { "type": "structure", "members": { - "collectionArn": { - "target": "com.amazonaws.bedrockagent#OpenSearchServerlessCollectionArn", + "endpoint": { + "target": "com.amazonaws.bedrockagent#RedisEnterpriseCloudEndpoint", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the OpenSearch Service vector store.

", + "smithy.api#documentation": "

The endpoint URL of the Redis Enterprise Cloud database.

", "smithy.api#required": {} } }, "vectorIndexName": { - "target": "com.amazonaws.bedrockagent#OpenSearchServerlessIndexName", + "target": "com.amazonaws.bedrockagent#RedisEnterpriseCloudIndexName", "traits": { - "smithy.api#documentation": "

The name of the vector store.

", + "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#OpenSearchServerlessFieldMapping", + "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": {} @@ -6168,10 +10978,19 @@ } }, "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.

" + "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#OpenSearchServerlessFieldMapping": { + "com.amazonaws.bedrockagent#RedisEnterpriseCloudEndpoint": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.bedrockagent#RedisEnterpriseCloudFieldMapping": { "type": "structure", "members": { "vectorField": { @@ -6200,7 +11019,7 @@ "smithy.api#documentation": "

Contains the names of the fields to which to map information about the vector store.

" } }, - "com.amazonaws.bedrockagent#OpenSearchServerlessIndexName": { + "com.amazonaws.bedrockagent#RedisEnterpriseCloudIndexName": { "type": "string", "traits": { "smithy.api#length": { @@ -6209,697 +11028,906 @@ "smithy.api#pattern": "^.*$" } }, - "com.amazonaws.bedrockagent#ParameterDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 500 + "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#ParameterDetail": { + "com.amazonaws.bedrockagent#RetrievalFlowNodeConfiguration": { "type": "structure", "members": { - "description": { - "target": "com.amazonaws.bedrockagent#ParameterDescription", + "serviceConfiguration": { + "target": "com.amazonaws.bedrockagent#RetrievalFlowNodeServiceConfiguration", "traits": { - "smithy.api#documentation": "

A description of the parameter. Helps the foundation model determine how to elicit the parameters from the user.

" + "smithy.api#documentation": "

Contains configurations for the service to use for retrieving data to return as the output from the node.

", + "smithy.api#required": {} } - }, - "type": { - "target": "com.amazonaws.bedrockagent#Type", + } + }, + "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 data type of the parameter.

", + "smithy.api#documentation": "

The name of the Amazon S3 bucket from which to retrieve data.

", "smithy.api#required": {} } - }, - "required": { - "target": "smithy.api#Boolean", + } + }, + "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": "

Whether the parameter is required for the agent to complete the function for action group invocation.

" + "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 details about a parameter in a function for an action group.

\n

This data type is used in the following API operations:

\n " + "smithy.api#documentation": "

Contains configurations for the service to use for retrieving data to return as the output from the node.

" } }, - "com.amazonaws.bedrockagent#ParameterMap": { - "type": "map", - "key": { - "target": "com.amazonaws.bedrockagent#Name" - }, - "value": { - "target": "com.amazonaws.bedrockagent#ParameterDetail" + "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#Payload": { + "com.amazonaws.bedrockagent#S3BucketName": { "type": "string", "traits": { - "smithy.api#sensitive": {} + "smithy.api#length": { + "min": 3, + "max": 63 + }, + "smithy.api#pattern": "^[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$" } }, - "com.amazonaws.bedrockagent#PineconeConfiguration": { + "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": { - "connectionString": { - "target": "com.amazonaws.bedrockagent#PineconeConnectionString", + "bucketArn": { + "target": "com.amazonaws.bedrockagent#S3BucketArn", "traits": { - "smithy.api#documentation": "

The endpoint URL for your index management page.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the S3 bucket that contains your data.

", "smithy.api#required": {} } }, - "credentialsSecretArn": { - "target": "com.amazonaws.bedrockagent#SecretArn", + "inclusionPrefixes": { + "target": "com.amazonaws.bedrockagent#S3Prefixes", "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": {} + "smithy.api#documentation": "

A list of S3 prefixes to include certain files or content. For more information, \n see Organizing objects using prefixes.

" } }, - "namespace": { - "target": "com.amazonaws.bedrockagent#PineconeNamespace", + "bucketOwnerAccountId": { + "target": "com.amazonaws.bedrockagent#BucketOwnerAccountId", "traits": { - "smithy.api#documentation": "

The namespace to be used to write new data to your database.

" + "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.

" } }, - "fieldMapping": { - "target": "com.amazonaws.bedrockagent#PineconeFieldMapping", + "s3ObjectKey": { + "target": "com.amazonaws.bedrockagent#S3ObjectKey", "traits": { - "smithy.api#documentation": "

Contains the names of the fields to which to map information about the vector store.

", + "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/.

", "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.

" + "smithy.api#documentation": "

An Amazon S3 location.

" } }, - "com.amazonaws.bedrockagent#PineconeConnectionString": { + "com.amazonaws.bedrockagent#S3ObjectKey": { "type": "string", "traits": { "smithy.api#length": { - "max": 2048 + "min": 1, + "max": 1024 }, - "smithy.api#pattern": "^.*$" + "smithy.api#pattern": "^[\\.\\-\\!\\*\\_\\'\\(\\)a-zA-Z0-9][\\.\\-\\!\\*\\_\\'\\(\\)\\/a-zA-Z0-9]*$" } }, - "com.amazonaws.bedrockagent#PineconeFieldMapping": { - "type": "structure", + "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": { - "textField": { - "target": "com.amazonaws.bedrockagent#FieldName", + "OAUTH2_CLIENT_CREDENTIALS": { + "target": "smithy.api#Unit", "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": {} + "smithy.api#enumValue": "OAUTH2_CLIENT_CREDENTIALS" } - }, - "metadataField": { - "target": "com.amazonaws.bedrockagent#FieldName", + } + } + }, + "com.amazonaws.bedrockagent#SalesforceCrawlerConfiguration": { + "type": "structure", + "members": { + "filterConfiguration": { + "target": "com.amazonaws.bedrockagent#CrawlFilterConfiguration", "traits": { - "smithy.api#documentation": "

The name of the field in which Amazon Bedrock stores metadata about the vector store.

", - "smithy.api#required": {} + "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": "

Contains the names of the fields to which to map information about the vector store.

" + "smithy.api#documentation": "

The configuration of the Salesforce content. For example, configuring \n specific types of Salesforce content.

" } }, - "com.amazonaws.bedrockagent#PineconeNamespace": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 2048 + "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": {} + } }, - "smithy.api#pattern": "^.*$" + "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#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" + "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": {} + } }, - { - "target": "com.amazonaws.bedrockagent#ThrottlingException" + "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": {} + } }, - { - "target": "com.amazonaws.bedrockagent#ValidationException" + "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 Salesforce connection configuration.

", + "smithy.api#required": {} + } } - ], - "traits": { - "smithy.api#documentation": "

Creates a DRAFT version of the agent that can be used for internal testing.

", - "smithy.api#http": { - "code": 202, - "method": "POST", - "uri": "/agents/{agentId}/" - }, - "smithy.api#tags": [ - "console" - ] + }, + "traits": { + "smithy.api#documentation": "

The endpoint information to connect to your Salesforce data source.

" } }, - "com.amazonaws.bedrockagent#PrepareAgentRequest": { + "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": { - "agentId": { - "target": "com.amazonaws.bedrockagent#Id", + "url": { + "target": "com.amazonaws.bedrockagent#Url", "traits": { - "smithy.api#documentation": "

The unique identifier of the agent for which to create a DRAFT version.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

A seed or starting point URL.

" } } }, "traits": { - "smithy.api#input": {} + "smithy.api#documentation": "

The seed or starting point URL. \n You should be authorized to crawl the URL.

" } }, - "com.amazonaws.bedrockagent#PrepareAgentResponse": { + "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": { - "agentId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "

The unique identifier of the agent for which the DRAFT version was created.

", - "smithy.api#required": {} - } - }, - "agentStatus": { - "target": "com.amazonaws.bedrockagent#AgentStatus", + "maxTokens": { + "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The status of the DRAFT version and whether it is ready for use.

", + "smithy.api#documentation": "

The maximum number of tokens that a chunk can contain.

", + "smithy.api#range": { + "min": 1 + }, "smithy.api#required": {} } }, - "agentVersion": { - "target": "com.amazonaws.bedrockagent#Version", + "bufferSize": { + "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The version of the agent.

", + "smithy.api#documentation": "

The buffer size.

", + "smithy.api#range": { + "min": 0, + "max": 1 + }, "smithy.api#required": {} } }, - "preparedAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp", + "breakpointPercentileThreshold": { + "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The time at which the DRAFT version of the agent was last prepared.

", + "smithy.api#documentation": "

The dissimilarity threshold for splitting chunks.

", + "smithy.api#range": { + "min": 50, + "max": 99 + }, "smithy.api#required": {} } } }, "traits": { - "smithy.api#output": {} + "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.

\n

With 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.

\n

You 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.

" } }, - "com.amazonaws.bedrockagent#PromptConfiguration": { + "com.amazonaws.bedrockagent#ServerSideEncryptionConfiguration": { "type": "structure", "members": { - "promptType": { - "target": "com.amazonaws.bedrockagent#PromptType", - "traits": { - "smithy.api#documentation": "

The step in the agent sequence that this prompt configuration applies to.

" - } - }, - "promptCreationMode": { - "target": "com.amazonaws.bedrockagent#CreationMode", + "kmsKeyArn": { + "target": "com.amazonaws.bedrockagent#KmsKeyArn", "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.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the KMS key used to encrypt the resource.

" } - }, - "promptState": { - "target": "com.amazonaws.bedrockagent#PromptState", + } + }, + "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#documentation": "

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 " + "smithy.api#enumValue": "OAUTH2_CLIENT_CREDENTIALS" } - }, - "basePromptTemplate": { - "target": "com.amazonaws.bedrockagent#BasePromptTemplate", + } + } + }, + "com.amazonaws.bedrockagent#SharePointCrawlerConfiguration": { + "type": "structure", + "members": { + "filterConfiguration": { + "target": "com.amazonaws.bedrockagent#CrawlFilterConfiguration", "traits": { - "smithy.api#documentation": "

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.

" + "smithy.api#documentation": "

The configuration of filtering the SharePoint content. For example, \n configuring regular expression patterns to include or exclude certain content.

" } - }, - "inferenceConfiguration": { - "target": "com.amazonaws.bedrockagent#InferenceConfiguration", + } + }, + "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": "

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.

" + "smithy.api#documentation": "

The endpoint information to connect to your SharePoint data source.

", + "smithy.api#required": {} } }, - "parserMode": { - "target": "com.amazonaws.bedrockagent#CreationMode", + "crawlerConfiguration": { + "target": "com.amazonaws.bedrockagent#SharePointCrawlerConfiguration", "traits": { - "smithy.api#documentation": "

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.

" + "smithy.api#documentation": "

The configuration of the SharePoint content. For example, configuring \n specific types of SharePoint content.

" } } }, "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#documentation": "

The configuration information to connect to SharePoint as your data source.

" } }, - "com.amazonaws.bedrockagent#PromptConfigurations": { + "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#PromptConfiguration" + "target": "com.amazonaws.bedrockagent#HttpsUrl" }, "traits": { "smithy.api#length": { - "max": 10 + "min": 1, + "max": 100 } } }, - "com.amazonaws.bedrockagent#PromptOverrideConfiguration": { + "com.amazonaws.bedrockagent#SharePointSourceConfiguration": { "type": "structure", "members": { - "promptConfigurations": { - "target": "com.amazonaws.bedrockagent#PromptConfigurations", + "tenantId": { + "target": "com.amazonaws.bedrockagent#Microsoft365TenantId", "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#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": {} } }, - "overrideLambda": { - "target": "com.amazonaws.bedrockagent#LambdaArn", + "siteUrls": { + "target": "com.amazonaws.bedrockagent#SharePointSiteUrls", "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.

" + "smithy.api#documentation": "

A list of one or more SharePoint site URLs.

", + "smithy.api#required": {} } - } - }, - "traits": { - "smithy.api#documentation": "

Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.

", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.bedrockagent#PromptState": { - "type": "enum", - "members": { - "ENABLED": { - "target": "smithy.api#Unit", + }, + "hostType": { + "target": "com.amazonaws.bedrockagent#SharePointHostType", "traits": { - "smithy.api#enumValue": "ENABLED" + "smithy.api#documentation": "

The supported host type, whether online/cloud or server/on-premises.

", + "smithy.api#required": {} } }, - "DISABLED": { - "target": "smithy.api#Unit", + "authType": { + "target": "com.amazonaws.bedrockagent#SharePointAuthType", "traits": { - "smithy.api#enumValue": "DISABLED" + "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#PromptType": { + "com.amazonaws.bedrockagent#SortOrder": { "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": { + "ASCENDING": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "POST_PROCESSING" + "smithy.api#enumValue": "ASCENDING" } }, - "KNOWLEDGE_BASE_RESPONSE_GENERATION": { + "DESCENDING": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "KNOWLEDGE_BASE_RESPONSE_GENERATION" + "smithy.api#enumValue": "DESCENDING" } } } }, - "com.amazonaws.bedrockagent#ProvisionedModelIdentifier": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 + "com.amazonaws.bedrockagent#StartIngestionJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#StartIngestionJobRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#StartIngestionJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" }, - "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", + { + "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#pattern": "^arn:aws(|-cn|-us-gov):rds:[a-zA-Z0-9-]*:[0-9]{12}:cluster:[a-zA-Z0-9-]{1,63}$" + "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#RdsConfiguration": { + "com.amazonaws.bedrockagent#StartIngestionJobRequest": { "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", + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", "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#documentation": "

The unique identifier of the knowledge base to which to add the data source.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "databaseName": { - "target": "com.amazonaws.bedrockagent#RdsDatabaseName", + "dataSourceId": { + "target": "com.amazonaws.bedrockagent#Id", "traits": { - "smithy.api#documentation": "

The name of your Amazon RDS database.

", + "smithy.api#documentation": "

The unique identifier of the data source to ingest.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "tableName": { - "target": "com.amazonaws.bedrockagent#RdsTableName", + "clientToken": { + "target": "com.amazonaws.bedrockagent#ClientToken", "traits": { - "smithy.api#documentation": "

The name of the table in the database.

", - "smithy.api#required": {} + "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": {} } }, - "fieldMapping": { - "target": "com.amazonaws.bedrockagent#RdsFieldMapping", + "description": { + "target": "com.amazonaws.bedrockagent#Description", "traits": { - "smithy.api#documentation": "

Contains the names of the fields to which to map information about the vector store.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A description of the ingestion job.

" } } }, "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_\\-]+$" + "smithy.api#input": {} } }, - "com.amazonaws.bedrockagent#RdsFieldMapping": { + "com.amazonaws.bedrockagent#StartIngestionJobResponse": { "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", + "ingestionJob": { + "target": "com.amazonaws.bedrockagent#IngestionJob", "traits": { - "smithy.api#documentation": "

The name of the field in which Amazon Bedrock stores metadata about the vector store.

", + "smithy.api#documentation": "

An object containing information about the ingestion job.

", "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_\\.\\-]+$" + "smithy.api#output": {} } }, - "com.amazonaws.bedrockagent#RecommendedAction": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 2048 + "com.amazonaws.bedrockagent#StepType": { + "type": "enum", + "members": { + "POST_CHUNKING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POST_CHUNKING" + } } } }, - "com.amazonaws.bedrockagent#RecommendedActions": { + "com.amazonaws.bedrockagent#StopSequences": { "type": "list", "member": { - "target": "com.amazonaws.bedrockagent#RecommendedAction" + "target": "smithy.api#String" }, "traits": { "smithy.api#length": { - "max": 2048 + "min": 0, + "max": 4 } } }, - "com.amazonaws.bedrockagent#RedisEnterpriseCloudConfiguration": { + "com.amazonaws.bedrockagent#StorageConfiguration": { "type": "structure", "members": { - "endpoint": { - "target": "com.amazonaws.bedrockagent#RedisEnterpriseCloudEndpoint", + "type": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseStorageType", "traits": { - "smithy.api#documentation": "

The endpoint URL of the Redis Enterprise Cloud database.

", + "smithy.api#documentation": "

The vector store service in which the knowledge base is stored.

", "smithy.api#required": {} } }, - "vectorIndexName": { - "target": "com.amazonaws.bedrockagent#RedisEnterpriseCloudIndexName", + "opensearchServerlessConfiguration": { + "target": "com.amazonaws.bedrockagent#OpenSearchServerlessConfiguration", "traits": { - "smithy.api#documentation": "

The name of the vector index.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.

" } }, - "credentialsSecretArn": { - "target": "com.amazonaws.bedrockagent#SecretArn", + "pineconeConfiguration": { + "target": "com.amazonaws.bedrockagent#PineconeConfiguration", "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": {} + "smithy.api#documentation": "

Contains the storage configuration of the knowledge base in Pinecone.

" } }, - "fieldMapping": { - "target": "com.amazonaws.bedrockagent#RedisEnterpriseCloudFieldMapping", + "redisEnterpriseCloudConfiguration": { + "target": "com.amazonaws.bedrockagent#RedisEnterpriseCloudConfiguration", "traits": { - "smithy.api#documentation": "

Contains the names of the fields to which to map information about the vector store.

", - "smithy.api#required": {} + "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 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.

" + "smithy.api#documentation": "

Contains the storage configuration of the knowledge base.

" } }, - "com.amazonaws.bedrockagent#RedisEnterpriseCloudEndpoint": { - "type": "string", + "com.amazonaws.bedrockagent#StorageDays": { + "type": "integer", "traits": { - "smithy.api#length": { - "max": 2048 - }, - "smithy.api#pattern": "^.*$" + "smithy.api#default": 30, + "smithy.api#range": { + "min": 0, + "max": 30 + } } }, - "com.amazonaws.bedrockagent#RedisEnterpriseCloudFieldMapping": { + "com.amazonaws.bedrockagent#StorageFlowNodeConfiguration": { "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", + "serviceConfiguration": { + "target": "com.amazonaws.bedrockagent#StorageFlowNodeServiceConfiguration", "traits": { - "smithy.api#documentation": "

The name of the field in which Amazon Bedrock stores metadata about the vector store.

", + "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 the names of the fields to which to map information about the vector store.

" + "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#RedisEnterpriseCloudIndexName": { - "type": "string", + "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#length": { - "max": 2048 - }, - "smithy.api#pattern": "^.*$" + "smithy.api#documentation": "

Contains configurations for the Amazon S3 location in which to store the input into the node.

" } }, - "com.amazonaws.bedrockagent#ResourceNotFoundException": { - "type": "structure", + "com.amazonaws.bedrockagent#StorageFlowNodeServiceConfiguration": { + "type": "union", "members": { - "message": { - "target": "com.amazonaws.bedrockagent#NonBlankString" + "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": "

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 + "smithy.api#documentation": "

Contains configurations for the service to use for storing the input into the node.

" } }, - "com.amazonaws.bedrockagent#S3BucketArn": { + "com.amazonaws.bedrockagent#TagKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, - "max": 2048 + "max": 128 }, - "smithy.api#pattern": "^arn:aws(|-cn|-us-gov):s3:::[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$" + "smithy.api#pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$" } }, - "com.amazonaws.bedrockagent#S3BucketName": { - "type": "string", + "com.amazonaws.bedrockagent#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#TagKey" + }, "traits": { "smithy.api#length": { - "min": 3, - "max": 63 + "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" }, - "smithy.api#pattern": "^[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$" + { + "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#S3DataSourceConfiguration": { + "com.amazonaws.bedrockagent#TagResourceRequest": { "type": "structure", "members": { - "bucketArn": { - "target": "com.amazonaws.bedrockagent#S3BucketArn", + "resourceArn": { + "target": "com.amazonaws.bedrockagent#TaggableResourcesArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the bucket that contains the data source.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to tag.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "inclusionPrefixes": { - "target": "com.amazonaws.bedrockagent#S3Prefixes", - "traits": { - "smithy.api#documentation": "

A list of S3 prefixes that define the object containing the data sources. For more information, see Organizing objects using prefixes.

" - } - }, - "bucketOwnerAccountId": { - "target": "com.amazonaws.bedrockagent#BucketOwnerAccountId", + "tags": { + "target": "com.amazonaws.bedrockagent#TagsMap", "traits": { - "smithy.api#documentation": "

The bucket account owner ID for the S3 bucket.

" + "smithy.api#documentation": "

An object containing key-value pairs that define the tags to attach to the resource.

", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Contains information about the S3 configuration of the data source.

" + "smithy.api#input": {} } }, - "com.amazonaws.bedrockagent#S3Identifier": { + "com.amazonaws.bedrockagent#TagResourceResponse": { "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 containing the resource.

" - } - } - }, + "members": {}, "traits": { - "smithy.api#documentation": "

Contains information about the S3 object containing the resource.

" + "smithy.api#output": {} } }, - "com.amazonaws.bedrockagent#S3ObjectKey": { + "com.amazonaws.bedrockagent#TagValue": { "type": "string", "traits": { "smithy.api#length": { - "min": 1, - "max": 1024 + "min": 0, + "max": 256 }, - "smithy.api#pattern": "^[\\.\\-\\!\\*\\_\\'\\(\\)a-zA-Z0-9][\\.\\-\\!\\*\\_\\'\\(\\)\\/a-zA-Z0-9]*$" + "smithy.api#pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$" } }, - "com.amazonaws.bedrockagent#S3Prefix": { + "com.amazonaws.bedrockagent#TaggableResourcesArn": { "type": "string", "traits": { "smithy.api#length": { - "min": 1, - "max": 300 - } + "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#S3Prefixes": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagent#S3Prefix" + "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#length": { - "min": 1, + "smithy.api#range": { + "min": 0, "max": 1 } } }, - "com.amazonaws.bedrockagent#SecretArn": { + "com.amazonaws.bedrockagent#TextPrompt": { "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}$" + "smithy.api#length": { + "min": 1, + "max": 200000 + }, + "smithy.api#sensitive": {} } }, - "com.amazonaws.bedrockagent#ServerSideEncryptionConfiguration": { + "com.amazonaws.bedrockagent#TextPromptTemplateConfiguration": { "type": "structure", "members": { - "kmsKeyArn": { - "target": "com.amazonaws.bedrockagent#KmsKeyArn", + "text": { + "target": "com.amazonaws.bedrockagent#TextPrompt", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the KMS key used to encrypt the resource.

" + "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 the configuration for server-side encryption.

" + "smithy.api#documentation": "

Contains configurations for a text prompt template. To include a variable, enclose a word in double curly braces as in {{variable}}.

", + "smithy.api#sensitive": {} } }, - "com.amazonaws.bedrockagent#ServiceQuotaExceededException": { + "com.amazonaws.bedrockagent#ThrottlingException": { "type": "structure", "members": { "message": { @@ -6907,219 +11935,135 @@ } }, "traits": { - "smithy.api#documentation": "

The number of requests exceeds the service quota. Resubmit your request later.

", + "smithy.api#documentation": "

The number of requests exceeds the limit. Resubmit your request later.

", "smithy.api#error": "client", - "smithy.api#httpError": 402 + "smithy.api#httpError": 429 } }, - "com.amazonaws.bedrockagent#SessionTTL": { + "com.amazonaws.bedrockagent#TopK": { "type": "integer", "traits": { "smithy.api#range": { - "min": 60, - "max": 3600 + "min": 0, + "max": 500 } } }, - "com.amazonaws.bedrockagent#SortOrder": { - "type": "enum", + "com.amazonaws.bedrockagent#TopP": { + "type": "float", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.bedrockagent#Transformation": { + "type": "structure", "members": { - "ASCENDING": { - "target": "smithy.api#Unit", + "transformationFunction": { + "target": "com.amazonaws.bedrockagent#TransformationFunction", "traits": { - "smithy.api#enumValue": "ASCENDING" + "smithy.api#documentation": "

A Lambda function that processes documents.

", + "smithy.api#required": {} } }, - "DESCENDING": { - "target": "smithy.api#Unit", + "stepToApply": { + "target": "com.amazonaws.bedrockagent#StepType", "traits": { - "smithy.api#enumValue": "DESCENDING" + "smithy.api#documentation": "

When the service applies the transformation.

", + "smithy.api#required": {} } } - } - }, - "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" - ] + "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.

" } }, - "com.amazonaws.bedrockagent#StartIngestionJobRequest": { + "com.amazonaws.bedrockagent#TransformationFunction": { "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", + "transformationLambdaConfiguration": { + "target": "com.amazonaws.bedrockagent#TransformationLambdaConfiguration", "traits": { - "smithy.api#documentation": "

The unique identifier of the data source to ingest.

", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

The Lambda function.

", "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": {} + "smithy.api#documentation": "

A Lambda function that processes documents.

" } }, - "com.amazonaws.bedrockagent#StartIngestionJobResponse": { + "com.amazonaws.bedrockagent#TransformationLambdaConfiguration": { "type": "structure", "members": { - "ingestionJob": { - "target": "com.amazonaws.bedrockagent#IngestionJob", + "lambdaArn": { + "target": "com.amazonaws.bedrockagent#LambdaArn", "traits": { - "smithy.api#documentation": "

An object containing information about the ingestion job.

", + "smithy.api#documentation": "

The function's ARN identifier.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#output": {} + "smithy.api#documentation": "

A Lambda function that processes documents.

" } }, - "com.amazonaws.bedrockagent#StopSequences": { + "com.amazonaws.bedrockagent#Transformations": { "type": "list", "member": { - "target": "smithy.api#String" + "target": "com.amazonaws.bedrockagent#Transformation" }, "traits": { "smithy.api#length": { - "min": 0, - "max": 4 + "min": 1, + "max": 1 } } }, - "com.amazonaws.bedrockagent#StorageConfiguration": { - "type": "structure", + "com.amazonaws.bedrockagent#Type": { + "type": "enum", "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", + "STRING": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

Contains the storage configuration of the knowledge base in Pinecone.

" + "smithy.api#enumValue": "string" } }, - "redisEnterpriseCloudConfiguration": { - "target": "com.amazonaws.bedrockagent#RedisEnterpriseCloudConfiguration", + "NUMBER": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

Contains the storage configuration of the knowledge base in Redis Enterprise Cloud.

" + "smithy.api#enumValue": "number" } }, - "rdsConfiguration": { - "target": "com.amazonaws.bedrockagent#RdsConfiguration", + "INTEGER": { + "target": "smithy.api#Unit", "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.

" + "smithy.api#enumValue": "integer" } }, - "mongoDbAtlasConfiguration": { - "target": "com.amazonaws.bedrockagent#MongoDbAtlasConfiguration", + "BOOLEAN": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

Contains the storage configuration of the knowledge base in MongoDB Atlas.

" + "smithy.api#enumValue": "boolean" } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the storage configuration of the knowledge base.

" - } - }, - "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 + "ARRAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "array" + } } } }, - "com.amazonaws.bedrockagent#TagResource": { + "com.amazonaws.bedrockagent#UntagResource": { "type": "operation", "input": { - "target": "com.amazonaws.bedrockagent#TagResourceRequest" + "target": "com.amazonaws.bedrockagent#UntagResourceRequest" }, "output": { - "target": "com.amazonaws.bedrockagent#TagResourceResponse" + "target": "com.amazonaws.bedrockagent#UntagResourceResponse" }, "errors": [ { @@ -7131,9 +12075,6 @@ { "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" }, - { - "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" - }, { "target": "com.amazonaws.bedrockagent#ThrottlingException" }, @@ -7142,29 +12083,31 @@ } ], "traits": { - "smithy.api#documentation": "

Associate tags with a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.

", + "smithy.api#documentation": "

Remove tags from a resource.

", "smithy.api#http": { "code": 200, - "method": "POST", + "method": "DELETE", "uri": "/tags/{resourceArn}" - } + }, + "smithy.api#idempotent": {} } }, - "com.amazonaws.bedrockagent#TagResourceRequest": { + "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 to tag.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource from which to remove tags.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "tags": { - "target": "com.amazonaws.bedrockagent#TagsMap", + "tagKeys": { + "target": "com.amazonaws.bedrockagent#TagKeyList", "traits": { - "smithy.api#documentation": "

An object containing key-value pairs that define the tags to attach to the resource.

", + "smithy.api#documentation": "

A list of keys of the tags to remove from the resource.

", + "smithy.api#httpQuery": "tagKeys", "smithy.api#required": {} } } @@ -7173,204 +12116,198 @@ "smithy.api#input": {} } }, - "com.amazonaws.bedrockagent#TagResourceResponse": { + "com.amazonaws.bedrockagent#UntagResourceResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, - "com.amazonaws.bedrockagent#TagValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 + "com.amazonaws.bedrockagent#UpdateAgent": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#UpdateAgentRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#UpdateAgentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" }, - "smithy.api#pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$" - } - }, - "com.amazonaws.bedrockagent#TaggableResourcesArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 1011 + { + "target": "com.amazonaws.bedrockagent#ConflictException" }, - "smithy.api#pattern": "(^arn:aws:bedrock:[a-zA-Z0-9-]+:/d{12}:(agent|agent-alias|knowledge-base)/[A-Z0-9]{10}(?:/[A-Z0-9]{10})?$)" - } - }, - "com.amazonaws.bedrockagent#TaggingResource": { - "type": "resource", - "operations": [ { - "target": "com.amazonaws.bedrockagent#ListTagsForResource" + "target": "com.amazonaws.bedrockagent#InternalServerException" }, { - "target": "com.amazonaws.bedrockagent#TagResource" + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" }, { - "target": "com.amazonaws.bedrockagent#UntagResource" + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" } - ] - }, - "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 - } + "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#ThrottlingException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.bedrockagent#NonBlankString" - } + "com.amazonaws.bedrockagent#UpdateAgentActionGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#UpdateAgentActionGroupRequest" }, - "traits": { - "smithy.api#documentation": "

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 + "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" } - } - }, - "com.amazonaws.bedrockagent#TopP": { - "type": "float", + ], "traits": { - "smithy.api#range": { - "min": 0, - "max": 1 - } + "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#Type": { - "type": "enum", + "com.amazonaws.bedrockagent#UpdateAgentActionGroupRequest": { + "type": "structure", "members": { - "STRING": { - "target": "smithy.api#Unit", + "agentId": { + "target": "com.amazonaws.bedrockagent#Id", "traits": { - "smithy.api#enumValue": "string" + "smithy.api#documentation": "

The unique identifier of the agent for which to update the action group.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "NUMBER": { - "target": "smithy.api#Unit", + "agentVersion": { + "target": "com.amazonaws.bedrockagent#DraftVersion", "traits": { - "smithy.api#enumValue": "number" + "smithy.api#documentation": "

The unique identifier of the agent version for which to update the action group.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "INTEGER": { - "target": "smithy.api#Unit", + "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.

\n

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#enumValue": "integer" + "smithy.api#documentation": "

Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.

" } }, - "BOOLEAN": { - "target": "smithy.api#Unit", + "apiSchema": { + "target": "com.amazonaws.bedrockagent#APISchema", "traits": { - "smithy.api#enumValue": "boolean" + "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.

" } }, - "ARRAY": { - "target": "smithy.api#Unit", + "functionSchema": { + "target": "com.amazonaws.bedrockagent#FunctionSchema", "traits": { - "smithy.api#enumValue": "array" + "smithy.api#documentation": "

Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.

" } } - } - }, - "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": {} + "smithy.api#input": {} } }, - "com.amazonaws.bedrockagent#UntagResourceRequest": { + "com.amazonaws.bedrockagent#UpdateAgentActionGroupResponse": { "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", + "agentActionGroup": { + "target": "com.amazonaws.bedrockagent#AgentActionGroup", "traits": { - "smithy.api#documentation": "

A list of keys of the tags to remove from the resource.

", - "smithy.api#httpQuery": "tagKeys", + "smithy.api#documentation": "

Contains details about the action group that was updated.

", "smithy.api#required": {} } } }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#UntagResourceResponse": { - "type": "structure", - "members": {}, "traits": { "smithy.api#output": {} } }, - "com.amazonaws.bedrockagent#UpdateAgent": { + "com.amazonaws.bedrockagent#UpdateAgentAlias": { "type": "operation", "input": { - "target": "com.amazonaws.bedrockagent#UpdateAgentRequest" + "target": "com.amazonaws.bedrockagent#UpdateAgentAliasRequest" }, "output": { - "target": "com.amazonaws.bedrockagent#UpdateAgentResponse" + "target": "com.amazonaws.bedrockagent#UpdateAgentAliasResponse" }, "errors": [ { @@ -7396,11 +12333,11 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the configuration of an agent.

", + "smithy.api#documentation": "

Updates configurations for an alias of an agent.

", "smithy.api#http": { "code": 202, "method": "PUT", - "uri": "/agents/{agentId}/" + "uri": "/agents/{agentId}/agentaliases/{agentAliasId}/" }, "smithy.api#idempotent": {}, "smithy.api#tags": [ @@ -7408,13 +12345,71 @@ ] } }, - "com.amazonaws.bedrockagent#UpdateAgentActionGroup": { + "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#UpdateAgentActionGroupRequest" + "target": "com.amazonaws.bedrockagent#UpdateAgentKnowledgeBaseRequest" }, "output": { - "target": "com.amazonaws.bedrockagent#UpdateAgentActionGroupResponse" + "target": "com.amazonaws.bedrockagent#UpdateAgentKnowledgeBaseResponse" }, "errors": [ { @@ -7429,9 +12424,6 @@ { "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" }, - { - "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" - }, { "target": "com.amazonaws.bedrockagent#ThrottlingException" }, @@ -7440,11 +12432,11 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the configuration for an action group for an agent.

", + "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}/actiongroups/{actionGroupId}/" + "uri": "/agents/{agentId}/agentversions/{agentVersion}/knowledgebases/{knowledgeBaseId}/" }, "smithy.api#idempotent": {}, "smithy.api#tags": [ @@ -7452,13 +12444,13 @@ ] } }, - "com.amazonaws.bedrockagent#UpdateAgentActionGroupRequest": { + "com.amazonaws.bedrockagent#UpdateAgentKnowledgeBaseRequest": { "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#documentation": "

The unique identifier of the agent associated with the knowledge base that you want to update.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -7466,60 +12458,124 @@ "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#documentation": "

The version of the agent associated with the knowledge base that you want to update.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "actionGroupId": { + "knowledgeBaseId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { - "smithy.api#documentation": "

The unique identifier of the action group.

", + "smithy.api#documentation": "

The unique identifier of the knowledge base that has been associated with an agent.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "actionGroupName": { + "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 action group.

", + "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 name for the action group.

" + "smithy.api#documentation": "

Specifies a new description of the agent.

" } }, - "parentActionGroupSignature": { - "target": "com.amazonaws.bedrockagent#ActionGroupSignature", + "idleSessionTTLInSeconds": { + "target": "com.amazonaws.bedrockagent#SessionTTL", "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.

\n

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.

" + "smithy.api#documentation": "

The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.

\n

A 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.

" } }, - "actionGroupExecutor": { - "target": "com.amazonaws.bedrockagent#ActionGroupExecutor", + "agentResourceRoleArn": { + "target": "com.amazonaws.bedrockagent#AgentRoleArn", "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.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.

", + "smithy.api#required": {} } }, - "actionGroupState": { - "target": "com.amazonaws.bedrockagent#ActionGroupState", + "customerEncryptionKeyArn": { + "target": "com.amazonaws.bedrockagent#KmsKeyArn", "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#documentation": "

The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.

" } }, - "apiSchema": { - "target": "com.amazonaws.bedrockagent#APISchema", + "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": "

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.

" + "smithy.api#documentation": "

The unique Guardrail configuration assigned to the agent when it is updated.

" } }, - "functionSchema": { - "target": "com.amazonaws.bedrockagent#FunctionSchema", + "memoryConfiguration": { + "target": "com.amazonaws.bedrockagent#MemoryConfiguration", "traits": { - "smithy.api#documentation": "

Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.

" + "smithy.api#documentation": "

Specifies the new memory configuration for the agent.

" } } }, @@ -7527,13 +12583,13 @@ "smithy.api#input": {} } }, - "com.amazonaws.bedrockagent#UpdateAgentActionGroupResponse": { + "com.amazonaws.bedrockagent#UpdateAgentResponse": { "type": "structure", "members": { - "agentActionGroup": { - "target": "com.amazonaws.bedrockagent#AgentActionGroup", + "agent": { + "target": "com.amazonaws.bedrockagent#Agent", "traits": { - "smithy.api#documentation": "

Contains details about the action group that was updated.

", + "smithy.api#documentation": "

Contains details about the agent that was updated.

", "smithy.api#required": {} } } @@ -7542,13 +12598,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.bedrockagent#UpdateAgentAlias": { + "com.amazonaws.bedrockagent#UpdateDataSource": { "type": "operation", "input": { - "target": "com.amazonaws.bedrockagent#UpdateAgentAliasRequest" + "target": "com.amazonaws.bedrockagent#UpdateDataSourceRequest" }, "output": { - "target": "com.amazonaws.bedrockagent#UpdateAgentAliasResponse" + "target": "com.amazonaws.bedrockagent#UpdateDataSourceResponse" }, "errors": [ { @@ -7563,9 +12619,6 @@ { "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" }, - { - "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" - }, { "target": "com.amazonaws.bedrockagent#ThrottlingException" }, @@ -7574,11 +12627,11 @@ } ], "traits": { - "smithy.api#documentation": "

Updates configurations for an alias of an agent.

", + "smithy.api#documentation": "

Updates the configurations for a data source connector.

\n \n

You can't change the chunkingConfiguration after you create the data source connector. Specify the existing chunkingConfiguration.

\n ", "smithy.api#http": { - "code": 202, + "code": 200, "method": "PUT", - "uri": "/agents/{agentId}/agentaliases/{agentAliasId}/" + "uri": "/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}" }, "smithy.api#idempotent": {}, "smithy.api#tags": [ @@ -7586,42 +12639,61 @@ ] } }, - "com.amazonaws.bedrockagent#UpdateAgentAliasRequest": { + "com.amazonaws.bedrockagent#UpdateDataSourceRequest": { "type": "structure", "members": { - "agentId": { + "knowledgeBaseId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { - "smithy.api#documentation": "

The unique identifier of the agent.

", + "smithy.api#documentation": "

The unique identifier of the knowledge base for the data source.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "agentAliasId": { - "target": "com.amazonaws.bedrockagent#AgentAliasId", + "dataSourceId": { + "target": "com.amazonaws.bedrockagent#Id", "traits": { - "smithy.api#documentation": "

The unique identifier of the alias.

", + "smithy.api#documentation": "

The unique identifier of the data source.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "agentAliasName": { + "name": { "target": "com.amazonaws.bedrockagent#Name", "traits": { - "smithy.api#documentation": "

Specifies a new name for the alias.

", + "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 alias.

" + "smithy.api#documentation": "

Specifies a new description for the data source.

" } }, - "routingConfiguration": { - "target": "com.amazonaws.bedrockagent#AgentAliasRoutingConfiguration", + "dataSourceConfiguration": { + "target": "com.amazonaws.bedrockagent#DataSourceConfiguration", "traits": { - "smithy.api#documentation": "

Contains details about the routing configuration of the alias.

" + "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.

" } } }, @@ -7629,13 +12701,13 @@ "smithy.api#input": {} } }, - "com.amazonaws.bedrockagent#UpdateAgentAliasResponse": { + "com.amazonaws.bedrockagent#UpdateDataSourceResponse": { "type": "structure", "members": { - "agentAlias": { - "target": "com.amazonaws.bedrockagent#AgentAlias", + "dataSource": { + "target": "com.amazonaws.bedrockagent#DataSource", "traits": { - "smithy.api#documentation": "

Contains details about the alias that was updated.

", + "smithy.api#documentation": "

Contains details about the data source.

", "smithy.api#required": {} } } @@ -7644,13 +12716,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.bedrockagent#UpdateAgentKnowledgeBase": { + "com.amazonaws.bedrockagent#UpdateFlow": { "type": "operation", "input": { - "target": "com.amazonaws.bedrockagent#UpdateAgentKnowledgeBaseRequest" + "target": "com.amazonaws.bedrockagent#UpdateFlowRequest" }, "output": { - "target": "com.amazonaws.bedrockagent#UpdateAgentKnowledgeBaseResponse" + "target": "com.amazonaws.bedrockagent#UpdateFlowResponse" }, "errors": [ { @@ -7665,6 +12737,9 @@ { "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, { "target": "com.amazonaws.bedrockagent#ThrottlingException" }, @@ -7673,11 +12748,11 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the configuration for a knowledge base that has been associated with an agent.

", + "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": "/agents/{agentId}/agentversions/{agentVersion}/knowledgebases/{knowledgeBaseId}/" + "uri": "/flows/{flowIdentifier}/" }, "smithy.api#idempotent": {}, "smithy.api#tags": [ @@ -7685,43 +12760,87 @@ ] } }, - "com.amazonaws.bedrockagent#UpdateAgentKnowledgeBaseRequest": { + "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": { - "agentId": { - "target": "com.amazonaws.bedrockagent#Id", + "name": { + "target": "com.amazonaws.bedrockagent#Name", "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#documentation": "

The name of the flow alias.

", "smithy.api#required": {} } }, - "agentVersion": { - "target": "com.amazonaws.bedrockagent#DraftVersion", + "description": { + "target": "com.amazonaws.bedrockagent#Description", "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": {} + "smithy.api#documentation": "

A description for the flow alias.

" } }, - "knowledgeBaseId": { - "target": "com.amazonaws.bedrockagent#Id", + "routingConfiguration": { + "target": "com.amazonaws.bedrockagent#FlowAliasRoutingConfiguration", "traits": { - "smithy.api#documentation": "

The unique identifier of the knowledge base that has been associated with an agent.

", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

Contains information about the version to which to map the alias.

", "smithy.api#required": {} } }, - "description": { - "target": "com.amazonaws.bedrockagent#Description", + "flowIdentifier": { + "target": "com.amazonaws.bedrockagent#FlowIdentifier", "traits": { - "smithy.api#documentation": "

Specifies a new description for the knowledge base associated with an agent.

" + "smithy.api#documentation": "

The unique identifier of the flow.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "knowledgeBaseState": { - "target": "com.amazonaws.bedrockagent#KnowledgeBaseState", + "aliasIdentifier": { + "target": "com.amazonaws.bedrockagent#FlowAliasIdentifier", "traits": { - "smithy.api#documentation": "

Specifies whether the agent uses the knowledge base or not when sending an InvokeAgent request.

" + "smithy.api#documentation": "

The unique identifier of the alias.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } }, @@ -7729,13 +12848,61 @@ "smithy.api#input": {} } }, - "com.amazonaws.bedrockagent#UpdateAgentKnowledgeBaseResponse": { + "com.amazonaws.bedrockagent#UpdateFlowAliasResponse": { "type": "structure", "members": { - "agentKnowledgeBase": { - "target": "com.amazonaws.bedrockagent#AgentKnowledgeBase", + "name": { + "target": "com.amazonaws.bedrockagent#Name", "traits": { - "smithy.api#documentation": "

Contains details about the knowledge base that has been associated with an agent.

", + "smithy.api#documentation": "

The name of the flow 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 flow alias was last updated.

", "smithy.api#required": {} } } @@ -7744,88 +12911,129 @@ "smithy.api#output": {} } }, - "com.amazonaws.bedrockagent#UpdateAgentRequest": { + "com.amazonaws.bedrockagent#UpdateFlowRequest": { "type": "structure", "members": { - "agentId": { - "target": "com.amazonaws.bedrockagent#Id", + "name": { + "target": "com.amazonaws.bedrockagent#FlowName", "traits": { - "smithy.api#documentation": "

The unique identifier of the agent.

", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

A name for the flow.

", "smithy.api#required": {} } }, - "agentName": { - "target": "com.amazonaws.bedrockagent#Name", + "description": { + "target": "com.amazonaws.bedrockagent#FlowDescription", "traits": { - "smithy.api#documentation": "

Specifies a new name for the agent.

", + "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": {} } }, - "instruction": { - "target": "com.amazonaws.bedrockagent#Instruction", + "customerEncryptionKeyArn": { + "target": "com.amazonaws.bedrockagent#KmsKeyArn", "traits": { - "smithy.api#documentation": "

Specifies new instructions that tell the agent what it should do and how it should interact with users.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the KMS key to encrypt the flow.

" } }, - "foundationModel": { - "target": "com.amazonaws.bedrockagent#ModelIdentifier", + "definition": { + "target": "com.amazonaws.bedrockagent#FlowDefinition", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Specifies a new foundation model to be used for orchestration by the agent.

", + "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#Description", + "target": "com.amazonaws.bedrockagent#FlowDescription", "traits": { - "smithy.api#documentation": "

Specifies a new description of the agent.

" + "smithy.api#documentation": "

The description of the flow.

" } }, - "idleSessionTTLInSeconds": { - "target": "com.amazonaws.bedrockagent#SessionTTL", + "executionRoleArn": { + "target": "com.amazonaws.bedrockagent#FlowExecutionRoleArn", "traits": { - "smithy.api#documentation": "

The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.

\n

A 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#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": {} } }, - "agentResourceRoleArn": { - "target": "com.amazonaws.bedrockagent#AgentRoleArn", + "customerEncryptionKeyArn": { + "target": "com.amazonaws.bedrockagent#KmsKeyArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.

", + "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.

", "smithy.api#required": {} } }, - "customerEncryptionKeyArn": { - "target": "com.amazonaws.bedrockagent#KmsKeyArn", + "createdAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.

" + "smithy.api#documentation": "

The time at which the flow was created.

", + "smithy.api#required": {} } }, - "promptOverrideConfiguration": { - "target": "com.amazonaws.bedrockagent#PromptOverrideConfiguration", + "updatedAt": { + "target": "com.amazonaws.bedrockagent#DateTimestamp", "traits": { - "smithy.api#documentation": "

Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.

" + "smithy.api#documentation": "

The time at which the flow was last updated.

", + "smithy.api#required": {} } }, - "guardrailConfiguration": { - "target": "com.amazonaws.bedrockagent#GuardrailConfiguration", + "version": { + "target": "com.amazonaws.bedrockagent#DraftVersion", "traits": { - "smithy.api#documentation": "

The unique Guardrail configuration assigned to the agent when it is updated.

" + "smithy.api#documentation": "

The version of the flow. When you update a flow, the version updated is the DRAFT version.

", + "smithy.api#required": {} } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagent#UpdateAgentResponse": { - "type": "structure", - "members": { - "agent": { - "target": "com.amazonaws.bedrockagent#Agent", + }, + "definition": { + "target": "com.amazonaws.bedrockagent#FlowDefinition", "traits": { - "smithy.api#documentation": "

Contains details about the agent that was updated.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A definition of the nodes and the connections between nodes in the flow.

" } } }, @@ -7833,13 +13041,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.bedrockagent#UpdateDataSource": { + "com.amazonaws.bedrockagent#UpdateKnowledgeBase": { "type": "operation", "input": { - "target": "com.amazonaws.bedrockagent#UpdateDataSourceRequest" + "target": "com.amazonaws.bedrockagent#UpdateKnowledgeBaseRequest" }, "output": { - "target": "com.amazonaws.bedrockagent#UpdateDataSourceResponse" + "target": "com.amazonaws.bedrockagent#UpdateKnowledgeBaseResponse" }, "errors": [ { @@ -7862,11 +13070,11 @@ } ], "traits": { - "smithy.api#documentation": "

Updates configurations for a data source.

\n \n

You can't change the chunkingConfiguration after you create the data source. Specify the existing chunkingConfiguration.

\n ", + "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.

\n

You can change the following fields:

\n \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.

", "smithy.api#http": { - "code": 200, + "code": 202, "method": "PUT", - "uri": "/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}" + "uri": "/knowledgebases/{knowledgeBaseId}" }, "smithy.api#idempotent": {}, "smithy.api#tags": [ @@ -7874,21 +13082,13 @@ ] } }, - "com.amazonaws.bedrockagent#UpdateDataSourceRequest": { + "com.amazonaws.bedrockagent#UpdateKnowledgeBaseRequest": { "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#httpLabel": {}, - "smithy.api#required": {} - } - }, - "dataSourceId": { - "target": "com.amazonaws.bedrockagent#Id", - "traits": { - "smithy.api#documentation": "

The unique identifier of the data source.

", + "smithy.api#documentation": "

The unique identifier of the knowledge base to update.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -7896,39 +13096,35 @@ "name": { "target": "com.amazonaws.bedrockagent#Name", "traits": { - "smithy.api#documentation": "

Specifies a new name for the data source.

", + "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 data source.

" + "smithy.api#documentation": "

Specifies a new description for the knowledge base.

" } }, - "dataSourceConfiguration": { - "target": "com.amazonaws.bedrockagent#DataSourceConfiguration", + "roleArn": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseRoleArn", "traits": { - "smithy.api#documentation": "

Contains details about the storage configuration of the data source.

", + "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": {} } }, - "dataDeletionPolicy": { - "target": "com.amazonaws.bedrockagent#DataDeletionPolicy", - "traits": { - "smithy.api#documentation": "

The data deletion policy of the updated data source.

" - } - }, - "serverSideEncryptionConfiguration": { - "target": "com.amazonaws.bedrockagent#ServerSideEncryptionConfiguration", + "knowledgeBaseConfiguration": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseConfiguration", "traits": { - "smithy.api#documentation": "

Contains details about server-side encryption of the data source.

" + "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": {} } }, - "vectorIngestionConfiguration": { - "target": "com.amazonaws.bedrockagent#VectorIngestionConfiguration", + "storageConfiguration": { + "target": "com.amazonaws.bedrockagent#StorageConfiguration", "traits": { - "smithy.api#documentation": "

Contains details about how to ingest the documents in the data source.

" + "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": {} } } }, @@ -7936,13 +13132,13 @@ "smithy.api#input": {} } }, - "com.amazonaws.bedrockagent#UpdateDataSourceResponse": { + "com.amazonaws.bedrockagent#UpdateKnowledgeBaseResponse": { "type": "structure", "members": { - "dataSource": { - "target": "com.amazonaws.bedrockagent#DataSource", + "knowledgeBase": { + "target": "com.amazonaws.bedrockagent#KnowledgeBase", "traits": { - "smithy.api#documentation": "

Contains details about the data source.

", + "smithy.api#documentation": "

Contains details about the knowledge base.

", "smithy.api#required": {} } } @@ -7951,13 +13147,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.bedrockagent#UpdateKnowledgeBase": { + "com.amazonaws.bedrockagent#UpdatePrompt": { "type": "operation", "input": { - "target": "com.amazonaws.bedrockagent#UpdateKnowledgeBaseRequest" + "target": "com.amazonaws.bedrockagent#UpdatePromptRequest" }, "output": { - "target": "com.amazonaws.bedrockagent#UpdateKnowledgeBaseResponse" + "target": "com.amazonaws.bedrockagent#UpdatePromptResponse" }, "errors": [ { @@ -7972,6 +13168,9 @@ { "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, { "target": "com.amazonaws.bedrockagent#ThrottlingException" }, @@ -7980,11 +13179,11 @@ } ], "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.

\n

You can change the following fields:

\n \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.

", + "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": 202, + "code": 200, "method": "PUT", - "uri": "/knowledgebases/{knowledgeBaseId}" + "uri": "/prompts/{promptIdentifier}/" }, "smithy.api#idempotent": {}, "smithy.api#tags": [ @@ -7992,69 +13191,145 @@ ] } }, - "com.amazonaws.bedrockagent#UpdateKnowledgeBaseRequest": { + "com.amazonaws.bedrockagent#UpdatePromptRequest": { "type": "structure", "members": { - "knowledgeBaseId": { - "target": "com.amazonaws.bedrockagent#Id", + "name": { + "target": "com.amazonaws.bedrockagent#PromptName", "traits": { - "smithy.api#documentation": "

The unique identifier of the knowledge base to update.

", - "smithy.api#httpLabel": {}, + "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.

" + } + }, + "variants": { + "target": "com.amazonaws.bedrockagent#PromptVariantList", + "traits": { + "smithy.api#documentation": "

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#Name", + "target": "com.amazonaws.bedrockagent#PromptName", "traits": { - "smithy.api#documentation": "

Specifies a new name for the knowledge base.

", + "smithy.api#documentation": "

The name of the prompt.

", "smithy.api#required": {} } }, "description": { - "target": "com.amazonaws.bedrockagent#Description", + "target": "com.amazonaws.bedrockagent#PromptDescription", "traits": { - "smithy.api#documentation": "

Specifies a new description for the knowledge base.

" + "smithy.api#documentation": "

The description of the prompt.

" } }, - "roleArn": { - "target": "com.amazonaws.bedrockagent#KnowledgeBaseRoleArn", + "customerEncryptionKeyArn": { + "target": "com.amazonaws.bedrockagent#KmsKeyArn", "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#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.

" + } + }, + "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": {} } }, - "knowledgeBaseConfiguration": { - "target": "com.amazonaws.bedrockagent#KnowledgeBaseConfiguration", + "arn": { + "target": "com.amazonaws.bedrockagent#PromptArn", "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#documentation": "

The Amazon Resource Name (ARN) of the prompt.

", "smithy.api#required": {} } }, - "storageConfiguration": { - "target": "com.amazonaws.bedrockagent#StorageConfiguration", + "version": { + "target": "com.amazonaws.bedrockagent#Version", "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#documentation": "

The version of the prompt. When you update a prompt, the version updated is the DRAFT version.

", + "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#input": {} + "smithy.api#output": {} } }, - "com.amazonaws.bedrockagent#UpdateKnowledgeBaseResponse": { + "com.amazonaws.bedrockagent#Url": { + "type": "string", + "traits": { + "smithy.api#pattern": "^https?://[A-Za-z0-9][^\\s]*$" + } + }, + "com.amazonaws.bedrockagent#UrlConfiguration": { "type": "structure", "members": { - "knowledgeBase": { - "target": "com.amazonaws.bedrockagent#KnowledgeBase", + "seedUrls": { + "target": "com.amazonaws.bedrockagent#SeedUrls", "traits": { - "smithy.api#documentation": "

Contains details about the knowledge base.

", - "smithy.api#required": {} + "smithy.api#documentation": "

One or more seed or starting point URLs.

" } } }, "traits": { - "smithy.api#output": {} + "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": { @@ -8112,6 +13387,18 @@ "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": { @@ -8162,6 +13449,109 @@ "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.

\n

You 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 diff --git a/codegen/sdk-codegen/aws-models/bedrock-runtime.json b/codegen/sdk-codegen/aws-models/bedrock-runtime.json index 9c3ca78f339..e6963c78089 100644 --- a/codegen/sdk-codegen/aws-models/bedrock-runtime.json +++ b/codegen/sdk-codegen/aws-models/bedrock-runtime.json @@ -35,6 +35,9 @@ "type": "service", "version": "2023-09-30", "resources": [ + { + "target": "com.amazonaws.bedrockruntime#GuardrailResource" + }, { "target": "com.amazonaws.bedrockruntime#InferenceResource" } @@ -724,6 +727,117 @@ "smithy.api#documentation": "

The model must request at least one tool (no text is generated). For example, {\"any\" : {}}.

" } }, + "com.amazonaws.bedrockruntime#ApplyGuardrail": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockruntime#ApplyGuardrailRequest" + }, + "output": { + "target": "com.amazonaws.bedrockruntime#ApplyGuardrailResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockruntime#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockruntime#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockruntime#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockruntime#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockruntime#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockruntime#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

The action to apply a guardrail.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/guardrail/{guardrailIdentifier}/version/{guardrailVersion}/apply" + } + } + }, + "com.amazonaws.bedrockruntime#ApplyGuardrailRequest": { + "type": "structure", + "members": { + "guardrailIdentifier": { + "target": "com.amazonaws.bedrockruntime#GuardrailIdentifier", + "traits": { + "smithy.api#documentation": "

The guardrail identifier used in the request to apply the guardrail.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "guardrailVersion": { + "target": "com.amazonaws.bedrockruntime#GuardrailVersion", + "traits": { + "smithy.api#documentation": "

The guardrail version used in the request to apply the guardrail.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "source": { + "target": "com.amazonaws.bedrockruntime#GuardrailContentSource", + "traits": { + "smithy.api#documentation": "

The source of data used in the request to apply the guardrail.

", + "smithy.api#required": {} + } + }, + "content": { + "target": "com.amazonaws.bedrockruntime#GuardrailContentBlockList", + "traits": { + "smithy.api#documentation": "

The content details used in the request to apply the guardrail.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockruntime#ApplyGuardrailResponse": { + "type": "structure", + "members": { + "usage": { + "target": "com.amazonaws.bedrockruntime#GuardrailUsage", + "traits": { + "smithy.api#documentation": "

The usage details in the response from the guardrail.

", + "smithy.api#required": {} + } + }, + "action": { + "target": "com.amazonaws.bedrockruntime#GuardrailAction", + "traits": { + "smithy.api#documentation": "

The action taken in the response from the guardrail.

", + "smithy.api#required": {} + } + }, + "outputs": { + "target": "com.amazonaws.bedrockruntime#GuardrailOutputContentList", + "traits": { + "smithy.api#documentation": "

The output details in the response from the guardrail.

", + "smithy.api#required": {} + } + }, + "assessments": { + "target": "com.amazonaws.bedrockruntime#GuardrailAssessmentList", + "traits": { + "smithy.api#documentation": "

The assessment details in the response from the guardrail.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.bedrockruntime#AutoToolChoice": { "type": "structure", "members": {}, @@ -764,7 +878,7 @@ "toolUse": { "target": "com.amazonaws.bedrockruntime#ToolUseBlock", "traits": { - "smithy.api#documentation": "

Information about a tool use request from a model.

" + "smithy.api#documentation": "

Information about a tool use request from a model.

" } }, "toolResult": { @@ -781,7 +895,7 @@ } }, "traits": { - "smithy.api#documentation": "

A block of content for a message that you pass to, or receive from, a model with the Converse API (Converse and ConverseStream).

" + "smithy.api#documentation": "

A block of content for a message that you pass to, or receive from, a model with the Converse or ConverseStream API operations.

" } }, "com.amazonaws.bedrockruntime#ContentBlockDelta": { @@ -1155,7 +1269,7 @@ "trace": { "target": "com.amazonaws.bedrockruntime#ConverseStreamTrace", "traits": { - "smithy.api#documentation": "

The trace object in the response from ConverseStream that contains information about the guardrail behavior.

" + "smithy.api#documentation": "

The trace object in the response from ConverseStream that contains information about the guardrail behavior.

" } } }, @@ -1335,7 +1449,7 @@ } }, "traits": { - "smithy.api#documentation": "

The trace object in a response from ConverseStream. Currently, you can only trace guardrails.

" + "smithy.api#documentation": "

The trace object in a response from ConverseStream. Currently, you can only trace guardrails.

" } }, "com.amazonaws.bedrockruntime#ConverseTrace": { @@ -1349,7 +1463,7 @@ } }, "traits": { - "smithy.api#documentation": "

The trace object in a response from Converse. Currently, you can only trace guardrails.

" + "smithy.api#documentation": "

The trace object in a response from Converse. Currently, you can only trace guardrails.

" } }, "com.amazonaws.bedrockruntime#DocumentBlock": { @@ -1365,7 +1479,7 @@ "name": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

A name for the document.

", + "smithy.api#documentation": "

A name for the document. The name can only contain the following characters:

\n \n \n

This field is vulnerable to prompt injections, because the model might inadvertently interpret it as instructions. Therefore, we recommend that you specify a neutral name.

\n ", "smithy.api#length": { "min": 1, "max": 200 @@ -1382,7 +1496,7 @@ } }, "traits": { - "smithy.api#documentation": "

A document to include in a message when sending a Converse or ConverseStream request. You can include up to 5 documents in a request. The maximum document size is 50 MB.

" + "smithy.api#documentation": "

A document to include in a message.

" } }, "com.amazonaws.bedrockruntime#DocumentFormat": { @@ -1450,7 +1564,7 @@ "bytes": { "target": "smithy.api#Blob", "traits": { - "smithy.api#documentation": "

A base64-encoded string of a UTF-8 encoded file, that is the document to include in the message.

", + "smithy.api#documentation": "

The raw bytes for the document. If you use an Amazon Web Services SDK, you don't need to encode the bytes in base64.

", "smithy.api#length": { "min": 1 } @@ -1458,7 +1572,24 @@ } }, "traits": { - "smithy.api#documentation": "

Contains the content of the document included in a message when sending a Converse or ConverseStream request or in the response.

" + "smithy.api#documentation": "

Contains the content of a document.

" + } + }, + "com.amazonaws.bedrockruntime#GuardrailAction": { + "type": "enum", + "members": { + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + }, + "GUARDRAIL_INTERVENED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GUARDRAIL_INTERVENED" + } + } } }, "com.amazonaws.bedrockruntime#GuardrailAssessment": { @@ -1487,6 +1618,12 @@ "traits": { "smithy.api#documentation": "

The sensitive information policy.

" } + }, + "contextualGroundingPolicy": { + "target": "com.amazonaws.bedrockruntime#GuardrailContextualGroundingPolicyAssessment", + "traits": { + "smithy.api#documentation": "

The contextual grounding policy used for the guardrail assessment.

" + } } }, "traits": { @@ -1543,7 +1680,27 @@ } }, "traits": { - "smithy.api#documentation": "

Configuration information for a guardrail that you use with the Converse action.

" + "smithy.api#documentation": "

Configuration information for a guardrail that you use with the Converse operation.

" + } + }, + "com.amazonaws.bedrockruntime#GuardrailContentBlock": { + "type": "union", + "members": { + "text": { + "target": "com.amazonaws.bedrockruntime#GuardrailTextBlock", + "traits": { + "smithy.api#documentation": "

Text within content block to be evaluated by the guardrail.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The content block to be evaluated by the guardrail.

" + } + }, + "com.amazonaws.bedrockruntime#GuardrailContentBlockList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockruntime#GuardrailContentBlock" } }, "com.amazonaws.bedrockruntime#GuardrailContentFilter": { @@ -1677,6 +1834,156 @@ "smithy.api#documentation": "

An assessment of a content policy for a guardrail.

" } }, + "com.amazonaws.bedrockruntime#GuardrailContentPolicyUnitsProcessed": { + "type": "integer" + }, + "com.amazonaws.bedrockruntime#GuardrailContentQualifier": { + "type": "enum", + "members": { + "GROUNDING_SOURCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "grounding_source" + } + }, + "QUERY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "query" + } + }, + "GUARD_CONTENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "guard_content" + } + } + } + }, + "com.amazonaws.bedrockruntime#GuardrailContentQualifierList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockruntime#GuardrailContentQualifier" + } + }, + "com.amazonaws.bedrockruntime#GuardrailContentSource": { + "type": "enum", + "members": { + "INPUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INPUT" + } + }, + "OUTPUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OUTPUT" + } + } + } + }, + "com.amazonaws.bedrockruntime#GuardrailContextualGroundingFilter": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrockruntime#GuardrailContextualGroundingFilterType", + "traits": { + "smithy.api#documentation": "

The contextual grounding filter type.

", + "smithy.api#required": {} + } + }, + "threshold": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "

The threshold used by contextual grounding filter to determine whether the content is grounded or not.

", + "smithy.api#range": { + "min": 0, + "max": 1 + }, + "smithy.api#required": {} + } + }, + "score": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "

The score generated by contextual grounding filter.

", + "smithy.api#range": { + "min": 0, + "max": 1 + }, + "smithy.api#required": {} + } + }, + "action": { + "target": "com.amazonaws.bedrockruntime#GuardrailContextualGroundingPolicyAction", + "traits": { + "smithy.api#documentation": "

The action performed by the guardrails contextual grounding filter.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The details for the guardrails contextual grounding filter.

" + } + }, + "com.amazonaws.bedrockruntime#GuardrailContextualGroundingFilterType": { + "type": "enum", + "members": { + "GROUNDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GROUNDING" + } + }, + "RELEVANCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RELEVANCE" + } + } + } + }, + "com.amazonaws.bedrockruntime#GuardrailContextualGroundingFilters": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockruntime#GuardrailContextualGroundingFilter" + } + }, + "com.amazonaws.bedrockruntime#GuardrailContextualGroundingPolicyAction": { + "type": "enum", + "members": { + "BLOCKED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BLOCKED" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + } + } + }, + "com.amazonaws.bedrockruntime#GuardrailContextualGroundingPolicyAssessment": { + "type": "structure", + "members": { + "filters": { + "target": "com.amazonaws.bedrockruntime#GuardrailContextualGroundingFilters", + "traits": { + "smithy.api#documentation": "

The filter details for the guardrails contextual grounding filter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The policy assessment details for the guardrails contextual grounding filter.

" + } + }, + "com.amazonaws.bedrockruntime#GuardrailContextualGroundingPolicyUnitsProcessed": { + "type": "integer" + }, "com.amazonaws.bedrockruntime#GuardrailConverseContentBlock": { "type": "union", "members": { @@ -1688,7 +1995,36 @@ } }, "traits": { - "smithy.api#documentation": "

\n

A content block for selective guarding with the Converse API (Converse and ConverseStream).\n

" + "smithy.api#documentation": "

\n

A content block for selective guarding with the Converse or ConverseStream API operations.\n

" + } + }, + "com.amazonaws.bedrockruntime#GuardrailConverseContentQualifier": { + "type": "enum", + "members": { + "GROUNDING_SOURCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "grounding_source" + } + }, + "QUERY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "query" + } + }, + "GUARD_CONTENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "guard_content" + } + } + } + }, + "com.amazonaws.bedrockruntime#GuardrailConverseContentQualifierList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockruntime#GuardrailConverseContentQualifier" } }, "com.amazonaws.bedrockruntime#GuardrailConverseTextBlock": { @@ -1700,6 +2036,12 @@ "smithy.api#documentation": "

The text that you want to guard.

", "smithy.api#required": {} } + }, + "qualifiers": { + "target": "com.amazonaws.bedrockruntime#GuardrailConverseContentQualifierList", + "traits": { + "smithy.api#documentation": "

The qualifier details for the guardrails contextual grounding filter.

" + } } }, "traits": { @@ -1789,6 +2131,26 @@ } } }, + "com.amazonaws.bedrockruntime#GuardrailOutputContent": { + "type": "structure", + "members": { + "text": { + "target": "com.amazonaws.bedrockruntime#GuardrailOutputText", + "traits": { + "smithy.api#documentation": "

The specific text for the output content produced by the guardrail.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The output content produced by the guardrail.

" + } + }, + "com.amazonaws.bedrockruntime#GuardrailOutputContentList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockruntime#GuardrailOutputContent" + } + }, "com.amazonaws.bedrockruntime#GuardrailOutputText": { "type": "string" }, @@ -2057,6 +2419,14 @@ "target": "com.amazonaws.bedrockruntime#GuardrailRegexFilter" } }, + "com.amazonaws.bedrockruntime#GuardrailResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrockruntime#ApplyGuardrail" + } + ] + }, "com.amazonaws.bedrockruntime#GuardrailSensitiveInformationPolicyAction": { "type": "enum", "members": { @@ -2096,6 +2466,12 @@ "smithy.api#documentation": "

The assessment for aPersonally Identifiable Information (PII) policy.

" } }, + "com.amazonaws.bedrockruntime#GuardrailSensitiveInformationPolicyFreeUnitsProcessed": { + "type": "integer" + }, + "com.amazonaws.bedrockruntime#GuardrailSensitiveInformationPolicyUnitsProcessed": { + "type": "integer" + }, "com.amazonaws.bedrockruntime#GuardrailStreamConfiguration": { "type": "structure", "members": { @@ -2149,6 +2525,27 @@ } } }, + "com.amazonaws.bedrockruntime#GuardrailTextBlock": { + "type": "structure", + "members": { + "text": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The input text details to be evaluated by the guardrail.

", + "smithy.api#required": {} + } + }, + "qualifiers": { + "target": "com.amazonaws.bedrockruntime#GuardrailContentQualifierList", + "traits": { + "smithy.api#documentation": "

The qualifiers describing the text block.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The text block to be evaluated by the guardrail.

" + } + }, "com.amazonaws.bedrockruntime#GuardrailTopic": { "type": "structure", "members": { @@ -2210,6 +2607,9 @@ "smithy.api#documentation": "

A behavior assessment of a topic policy.

" } }, + "com.amazonaws.bedrockruntime#GuardrailTopicPolicyUnitsProcessed": { + "type": "integer" + }, "com.amazonaws.bedrockruntime#GuardrailTopicType": { "type": "enum", "members": { @@ -2264,6 +2664,56 @@ "smithy.api#documentation": "

A Top level guardrail trace object. For more information, see ConverseTrace.

" } }, + "com.amazonaws.bedrockruntime#GuardrailUsage": { + "type": "structure", + "members": { + "topicPolicyUnits": { + "target": "com.amazonaws.bedrockruntime#GuardrailTopicPolicyUnitsProcessed", + "traits": { + "smithy.api#documentation": "

The topic policy units processed by the guardrail.

", + "smithy.api#required": {} + } + }, + "contentPolicyUnits": { + "target": "com.amazonaws.bedrockruntime#GuardrailContentPolicyUnitsProcessed", + "traits": { + "smithy.api#documentation": "

The content policy units processed by the guardrail.

", + "smithy.api#required": {} + } + }, + "wordPolicyUnits": { + "target": "com.amazonaws.bedrockruntime#GuardrailWordPolicyUnitsProcessed", + "traits": { + "smithy.api#documentation": "

The word policy units processed by the guardrail.

", + "smithy.api#required": {} + } + }, + "sensitiveInformationPolicyUnits": { + "target": "com.amazonaws.bedrockruntime#GuardrailSensitiveInformationPolicyUnitsProcessed", + "traits": { + "smithy.api#documentation": "

The sensitive information policy units processed by the guardrail.

", + "smithy.api#required": {} + } + }, + "sensitiveInformationPolicyFreeUnits": { + "target": "com.amazonaws.bedrockruntime#GuardrailSensitiveInformationPolicyFreeUnitsProcessed", + "traits": { + "smithy.api#documentation": "

The sensitive information policy free units processed by the guardrail.

", + "smithy.api#required": {} + } + }, + "contextualGroundingPolicyUnits": { + "target": "com.amazonaws.bedrockruntime#GuardrailContextualGroundingPolicyUnitsProcessed", + "traits": { + "smithy.api#documentation": "

The contextual grounding policy units processed by the guardrail.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The details on the use of the guardrail.

" + } + }, "com.amazonaws.bedrockruntime#GuardrailVersion": { "type": "string", "traits": { @@ -2303,6 +2753,9 @@ "smithy.api#documentation": "

The word policy assessment.

" } }, + "com.amazonaws.bedrockruntime#GuardrailWordPolicyUnitsProcessed": { + "type": "integer" + }, "com.amazonaws.bedrockruntime#ImageBlock": { "type": "structure", "members": { @@ -2360,7 +2813,7 @@ "bytes": { "target": "smithy.api#Blob", "traits": { - "smithy.api#documentation": "

The raw image bytes for the image. If you use an AWS SDK, you don't need to base64 encode the image bytes.

", + "smithy.api#documentation": "

The raw image bytes for the image. If you use an AWS SDK, you don't need to encode the image bytes in base64.

", "smithy.api#length": { "min": 1 } @@ -2731,7 +3184,7 @@ "content": { "target": "com.amazonaws.bedrockruntime#ContentBlocks", "traits": { - "smithy.api#documentation": "

The message content.

", + "smithy.api#documentation": "

The message content. Note the following restrictions:

\n ", "smithy.api#required": {} } } @@ -3067,7 +3520,7 @@ "guardContent": { "target": "com.amazonaws.bedrockruntime#GuardrailConverseContentBlock", "traits": { - "smithy.api#documentation": "

A content block to assess with the guardrail. Use with the Converse API (Converse and ConverseStream).

\n

For more information, see Use a guardrail with the Converse\n API in the Amazon Bedrock User Guide.

" + "smithy.api#documentation": "

A content block to assess with the guardrail. Use with the Converse or ConverseStream API operations.

\n

For more information, see Use a guardrail with the Converse\n API in the Amazon Bedrock User Guide.

" } } }, @@ -3143,7 +3596,7 @@ } }, "traits": { - "smithy.api#documentation": "

Information about a tool that you can use with the Converse API.

" + "smithy.api#documentation": "

Information about a tool that you can use with the Converse API. For more information, see Tool use (function calling) in the Amazon Bedrock User Guide.

" } }, "com.amazonaws.bedrockruntime#ToolChoice": { @@ -3193,7 +3646,7 @@ } }, "traits": { - "smithy.api#documentation": "

Configuration information for the tools that you pass to a model.

\n \n

This field is only supported by Anthropic Claude 3, Cohere Command R, Cohere Command R+, and Mistral Large models.

\n " + "smithy.api#documentation": "

Configuration information for the tools that you pass to a model. For more information, see Tool use (function calling) in the Amazon Bedrock User Guide.

\n \n

This field is only supported by Anthropic Claude 3, Cohere Command R, Cohere Command R+, and Mistral Large models.

\n " } }, "com.amazonaws.bedrockruntime#ToolInputSchema": { diff --git a/codegen/sdk-codegen/aws-models/bedrock.json b/codegen/sdk-codegen/aws-models/bedrock.json index ab3ccfd847e..77d9d57b78c 100644 --- a/codegen/sdk-codegen/aws-models/bedrock.json +++ b/codegen/sdk-codegen/aws-models/bedrock.json @@ -990,7 +990,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a guardrail to block topics and to filter out harmful content.

\n ", + "smithy.api#documentation": "

Creates a guardrail to block topics and to implement safeguards for your generative AI applications.

\n

You can configure the following policies in a guardrail to avoid undesirable and harmful content, filter \n out denied topics and words, and remove sensitive information for privacy protection.

\n \n

In addition to the above policies, you can also configure the messages to be returned to \n the user if a user input or model response is in violation of the policies defined in the guardrail.

\n

For more information, see Guardrails for Amazon Bedrock in\n the Amazon Bedrock User Guide.

", "smithy.api#http": { "code": 202, "method": "POST", @@ -1038,6 +1038,12 @@ "smithy.api#documentation": "

The sensitive information policy to configure for the guardrail.

" } }, + "contextualGroundingPolicyConfig": { + "target": "com.amazonaws.bedrock#GuardrailContextualGroundingPolicyConfig", + "traits": { + "smithy.api#documentation": "

The contextual grounding policy configuration used to create a guardrail.

" + } + }, "blockedInputMessaging": { "target": "com.amazonaws.bedrock#GuardrailBlockedMessaging", "traits": { @@ -1089,14 +1095,14 @@ "guardrailArn": { "target": "com.amazonaws.bedrock#GuardrailArn", "traits": { - "smithy.api#documentation": "

The ARN of the guardrail that was created.

", + "smithy.api#documentation": "

The ARN of the guardrail.

", "smithy.api#required": {} } }, "version": { "target": "com.amazonaws.bedrock#GuardrailDraftVersion", "traits": { - "smithy.api#documentation": "

The version of the guardrail that was created. This value should be 1.

", + "smithy.api#documentation": "

The version of the guardrail that was created. \n This value will always be DRAFT.

", "smithy.api#required": {} } }, @@ -1158,7 +1164,7 @@ "guardrailIdentifier": { "target": "com.amazonaws.bedrock#GuardrailIdentifier", "traits": { - "smithy.api#documentation": "

The unique identifier of the guardrail.

", + "smithy.api#documentation": "

The unique identifier of the guardrail. This can be an ID or the ARN.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1663,7 +1669,7 @@ "guardrailIdentifier": { "target": "com.amazonaws.bedrock#GuardrailIdentifier", "traits": { - "smithy.api#documentation": "

The unique identifier of the guardrail.

", + "smithy.api#documentation": "

The unique identifier of the guardrail. This can be an ID or the ARN.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2923,7 +2929,7 @@ "guardrailIdentifier": { "target": "com.amazonaws.bedrock#GuardrailIdentifier", "traits": { - "smithy.api#documentation": "

The unique identifier of the guardrail for which to get details.

", + "smithy.api#documentation": "

The unique identifier of the guardrail for which to get details. This can be an ID or the ARN.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2966,7 +2972,7 @@ "guardrailArn": { "target": "com.amazonaws.bedrock#GuardrailArn", "traits": { - "smithy.api#documentation": "

The ARN of the guardrail that was created.

", + "smithy.api#documentation": "

The ARN of the guardrail.

", "smithy.api#required": {} } }, @@ -3008,6 +3014,12 @@ "smithy.api#documentation": "

The sensitive information policy that was configured for the guardrail.

" } }, + "contextualGroundingPolicy": { + "target": "com.amazonaws.bedrock#GuardrailContextualGroundingPolicy", + "traits": { + "smithy.api#documentation": "

The contextual grounding policy used in the guardrail.

" + } + }, "createdAt": { "target": "com.amazonaws.bedrock#Timestamp", "traits": { @@ -3525,7 +3537,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains filter strengths for harmful content. Guardrails support the following content filters to detect and filter harmful user inputs and FM-generated outputs.

\n \n

Content filtering depends on the confidence classification of user inputs and FM\n responses across each of the four harmful categories. All input and output statements are\n classified into one of four confidence levels (NONE, LOW, MEDIUM, HIGH) for each\n harmful category. For example, if a statement is classified as\n Hate with HIGH confidence, the likelihood of the statement\n representing hateful content is high. A single statement can be classified across\n multiple categories with varying confidence levels. For example, a single statement\n can be classified as Hate with HIGH confidence, Insults with LOW confidence, Sexual with NONE confidence, and Violence with MEDIUM confidence.

\n

For more information, see Guardrails content filters.

\n

This data type is used in the following API operations:

\n " + "smithy.api#documentation": "

Contains filter strengths for harmful content. Guardrails support the following content filters to detect and filter harmful user inputs and FM-generated outputs.

\n \n

Content filtering depends on the confidence classification of user inputs and FM\n responses across each of the four harmful categories. All input and output statements are\n classified into one of four confidence levels (NONE, LOW, MEDIUM, HIGH) for each\n harmful category. For example, if a statement is classified as\n Hate with HIGH confidence, the likelihood of the statement\n representing hateful content is high. A single statement can be classified across\n multiple categories with varying confidence levels. For example, a single statement\n can be classified as Hate with HIGH confidence, Insults with LOW confidence, Sexual with NONE confidence, and Violence with MEDIUM confidence.

\n

For more information, see Guardrails content filters.

" } }, "com.amazonaws.bedrock#GuardrailContentFilterType": { @@ -3619,7 +3631,126 @@ } }, "traits": { - "smithy.api#documentation": "

Contains details about how to handle harmful content.

\n

This data type is used in the following API operations:

\n " + "smithy.api#documentation": "

Contains details about how to handle harmful content.

" + } + }, + "com.amazonaws.bedrock#GuardrailContextualGroundingFilter": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrock#GuardrailContextualGroundingFilterType", + "traits": { + "smithy.api#documentation": "

The filter type details for the guardrails contextual grounding filter.

", + "smithy.api#required": {} + } + }, + "threshold": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "

The threshold details for the guardrails contextual grounding filter.

", + "smithy.api#range": { + "min": 0 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The details for the guardrails contextual grounding filter.

" + } + }, + "com.amazonaws.bedrock#GuardrailContextualGroundingFilterConfig": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrock#GuardrailContextualGroundingFilterType", + "traits": { + "smithy.api#documentation": "

The filter details for the guardrails contextual grounding filter.

", + "smithy.api#required": {} + } + }, + "threshold": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "

The threshold details for the guardrails contextual grounding filter.

", + "smithy.api#range": { + "min": 0 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The filter configuration details for the guardrails contextual grounding filter.

" + } + }, + "com.amazonaws.bedrock#GuardrailContextualGroundingFilterType": { + "type": "enum", + "members": { + "GROUNDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GROUNDING" + } + }, + "RELEVANCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RELEVANCE" + } + } + } + }, + "com.amazonaws.bedrock#GuardrailContextualGroundingFilters": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#GuardrailContextualGroundingFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.bedrock#GuardrailContextualGroundingFiltersConfig": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#GuardrailContextualGroundingFilterConfig" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.bedrock#GuardrailContextualGroundingPolicy": { + "type": "structure", + "members": { + "filters": { + "target": "com.amazonaws.bedrock#GuardrailContextualGroundingFilters", + "traits": { + "smithy.api#documentation": "

The filter details for the guardrails contextual grounding policy.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The details for the guardrails contextual grounding policy.

" + } + }, + "com.amazonaws.bedrock#GuardrailContextualGroundingPolicyConfig": { + "type": "structure", + "members": { + "filtersConfig": { + "target": "com.amazonaws.bedrock#GuardrailContextualGroundingFiltersConfig", + "traits": { + "smithy.api#documentation": "

The filter configuration details for the guardrails contextual grounding policy.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The policy configuration details for the guardrails contextual grounding policy.

" } }, "com.amazonaws.bedrock#GuardrailDescription": { @@ -3734,7 +3865,7 @@ } }, "traits": { - "smithy.api#documentation": "

The managed word list that was configured for the guardrail.\n (This is a list of words that are pre-defined and managed by Guardrails only.)

" + "smithy.api#documentation": "

The managed word list that was configured for the guardrail.\n (This is a list of words that are pre-defined and managed by guardrails only.)

" } }, "com.amazonaws.bedrock#GuardrailManagedWordsConfig": { @@ -3832,7 +3963,7 @@ "type": { "target": "com.amazonaws.bedrock#GuardrailPiiEntityType", "traits": { - "smithy.api#documentation": "

Configure guardrail type when the PII entity is detected.

", + "smithy.api#documentation": "

Configure guardrail type when the PII entity is detected.

\n

The following PIIs are used to block or mask sensitive information:

\n ", "smithy.api#required": {} } }, @@ -4410,7 +4541,7 @@ } }, "traits": { - "smithy.api#documentation": "

Details about topics for the guardrail to identify and deny.

\n

This data type is used in the following API operations:

\n " + "smithy.api#documentation": "

Details about topics for the guardrail to identify and deny.

" } }, "com.amazonaws.bedrock#GuardrailTopicDefinition": { @@ -4483,7 +4614,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains details about topics that the guardrail should identify and deny.

\n

This data type is used in the following API operations:

\n " + "smithy.api#documentation": "

Contains details about topics that the guardrail should identify and deny.

" } }, "com.amazonaws.bedrock#GuardrailTopicType": { @@ -5225,7 +5356,7 @@ "guardrailIdentifier": { "target": "com.amazonaws.bedrock#GuardrailIdentifier", "traits": { - "smithy.api#documentation": "

The unique identifier of the guardrail.

", + "smithy.api#documentation": "

The unique identifier of the guardrail. This can be an ID or the ARN.

", "smithy.api#httpQuery": "guardrailIdentifier" } }, @@ -6791,7 +6922,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates a guardrail with the values you specify.

\n ", + "smithy.api#documentation": "

Updates a guardrail with the values you specify.

\n ", "smithy.api#http": { "code": 202, "method": "PUT", @@ -6806,7 +6937,7 @@ "guardrailIdentifier": { "target": "com.amazonaws.bedrock#GuardrailIdentifier", "traits": { - "smithy.api#documentation": "

The unique identifier of the guardrail

", + "smithy.api#documentation": "

The unique identifier of the guardrail. This can be an ID or the ARN.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6848,6 +6979,12 @@ "smithy.api#documentation": "

The sensitive information policy to configure for the guardrail.

" } }, + "contextualGroundingPolicyConfig": { + "target": "com.amazonaws.bedrock#GuardrailContextualGroundingPolicyConfig", + "traits": { + "smithy.api#documentation": "

The contextual grounding policy configuration used to update a guardrail.

" + } + }, "blockedInputMessaging": { "target": "com.amazonaws.bedrock#GuardrailBlockedMessaging", "traits": { @@ -6886,7 +7023,7 @@ "guardrailArn": { "target": "com.amazonaws.bedrock#GuardrailArn", "traits": { - "smithy.api#documentation": "

The ARN of the guardrail that was created.

", + "smithy.api#documentation": "

The ARN of the guardrail.

", "smithy.api#required": {} } }, diff --git a/codegen/sdk-codegen/aws-models/ec2.json b/codegen/sdk-codegen/aws-models/ec2.json index 9bb20e4a893..29a68f14666 100644 --- a/codegen/sdk-codegen/aws-models/ec2.json +++ b/codegen/sdk-codegen/aws-models/ec2.json @@ -15929,7 +15929,7 @@ "Locale": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

In IPAM, the locale is the Amazon Web Services Region where you want to make an IPAM pool available for allocations. Only resources in the same Region as the locale of the pool can get IP address allocations from the pool. You can only allocate a CIDR for a VPC, for example, from an IPAM pool that shares a locale with the VPC’s Region. Note that once you choose a Locale for a pool, you cannot modify it. If you do not choose a locale, resources in Regions others than the IPAM's home region cannot use CIDRs from this pool.

\n

Possible values: Any Amazon Web Services Region, such as us-east-1.

" + "smithy.api#documentation": "

In IPAM, the locale is the Amazon Web Services Region or, for IPAM IPv4 pools in the public scope, the network border group for an Amazon Web Services Local Zone where you want to make an IPAM pool available for allocations (supported Local Zones). If you do not choose a locale, resources in Regions others than the IPAM's home region cannot use CIDRs from this pool.

\n

Possible values: Any Amazon Web Services Region, such as us-east-1.

" } }, "SourceIpamPoolId": { @@ -17850,6 +17850,12 @@ "smithy.api#documentation": "

The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

", "smithy.api#xmlName": "TagSpecification" } + }, + "NetworkBorderGroup": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Availability Zone (AZ) or Local Zone (LZ) network border group that the resource that the IP address is assigned to is in. Defaults to an AZ network border group. For more information on available Local Zones, see Local Zone availability in the Amazon EC2 User Guide.

" + } } }, "traits": { @@ -24425,6 +24431,12 @@ "smithy.api#documentation": "

The ID of the public IPv4 pool you want to delete.

", "smithy.api#required": {} } + }, + "NetworkBorderGroup": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Availability Zone (AZ) or Local Zone (LZ) network border group that the resource that the IP address is assigned to is in. Defaults to an AZ network border group. For more information on available Local Zones, see Local Zone availability in the Amazon EC2 User Guide.

" + } } }, "traits": { @@ -67558,7 +67570,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "NetworkBorderGroup", - "smithy.api#documentation": "

The network border group that the resource that the IP address is assigned to is in.

", + "smithy.api#documentation": "

The Availability Zone (AZ) or Local Zone (LZ) network border group that the resource that the IP address is assigned to is in. Defaults to an AZ network border group. For more information on available Local Zones, see Local Zone availability in the Amazon EC2 User Guide.

", "smithy.api#xmlName": "networkBorderGroup" } }, @@ -67667,6 +67679,14 @@ "smithy.api#xmlName": "vpcId" } }, + "NetworkInterfaceAttachmentStatus": { + "target": "com.amazonaws.ec2#IpamNetworkInterfaceAttachmentStatus", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceAttachmentStatus", + "smithy.api#documentation": "

For elastic IP addresses, this is the status of an attached network interface.

", + "smithy.api#xmlName": "networkInterfaceAttachmentStatus" + } + }, "SampleTime": { "target": "com.amazonaws.ec2#MillisecondDateTime", "traits": { @@ -67674,6 +67694,14 @@ "smithy.api#documentation": "

The last successful resource discovery time.

", "smithy.api#xmlName": "sampleTime" } + }, + "AvailabilityZoneId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZoneId", + "smithy.api#documentation": "

The Availability Zone ID.

", + "smithy.api#xmlName": "availabilityZoneId" + } } }, "traits": { @@ -67780,6 +67808,23 @@ } } }, + "com.amazonaws.ec2#IpamNetworkInterfaceAttachmentStatus": { + "type": "enum", + "members": { + "available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "available" + } + }, + "in_use": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "in-use" + } + } + } + }, "com.amazonaws.ec2#IpamOperatingRegion": { "type": "structure", "members": { @@ -67899,7 +67944,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "Locale", - "smithy.api#documentation": "

The locale of the IPAM pool. In IPAM, the locale is the Amazon Web Services Region where you want to make an IPAM pool available for allocations. Only resources in the same Region as the locale of the pool can get IP address allocations from the pool. You can only allocate a CIDR for a VPC, for example, from an IPAM pool that shares a locale with the VPC’s Region. Note that once you choose a Locale for a pool, you cannot modify it. If you choose an Amazon Web Services Region for locale that has not been configured as an operating Region for the IPAM, you'll get an error.

", + "smithy.api#documentation": "

The locale of the IPAM pool. In IPAM, the locale is the Amazon Web Services Region or, for IPAM IPv4 pools in the public scope, the network border group for an Amazon Web Services Local Zone where you want to make an IPAM pool available for allocations (supported Local Zones). If you choose an Amazon Web Services Region for locale that has not been configured as an operating Region for the IPAM, you'll get an error.

", "smithy.api#xmlName": "locale" } }, @@ -68826,6 +68871,14 @@ "smithy.api#documentation": "

The ID of a VPC.

", "smithy.api#xmlName": "vpcId" } + }, + "AvailabilityZoneId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZoneId", + "smithy.api#documentation": "

The Availability Zone ID.

", + "smithy.api#xmlName": "availabilityZoneId" + } } }, "traits": { @@ -85236,6 +85289,12 @@ "smithy.api#documentation": "

The netmask length of the CIDR you would like to allocate to the public IPv4 pool.

", "smithy.api#required": {} } + }, + "NetworkBorderGroup": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The Availability Zone (AZ) or Local Zone (LZ) network border group that the resource that the IP address is assigned to is in. Defaults to an AZ network border group. For more information on available Local Zones, see Local Zone availability in the Amazon EC2 User Guide.

" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/glue.json b/codegen/sdk-codegen/aws-models/glue.json index 5d3acdb1955..1f7dff017eb 100644 --- a/codegen/sdk-codegen/aws-models/glue.json +++ b/codegen/sdk-codegen/aws-models/glue.json @@ -6537,6 +6537,40 @@ "smithy.api#error": "client" } }, + "com.amazonaws.glue#ConditionExpression": { + "type": "structure", + "members": { + "Condition": { + "target": "com.amazonaws.glue#DatabrewCondition", + "traits": { + "smithy.api#documentation": "

The condition of the condition expression.

", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.glue#DatabrewConditionValue", + "traits": { + "smithy.api#documentation": "

The value of the condition expression.

" + } + }, + "TargetColumn": { + "target": "com.amazonaws.glue#TargetColumn", + "traits": { + "smithy.api#documentation": "

The target column of the condition expressions.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Condition expression defined in the Glue Studio data preparation recipe node.

" + } + }, + "com.amazonaws.glue#ConditionExpressionList": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#ConditionExpression" + } + }, "com.amazonaws.glue#ConditionList": { "type": "list", "member": { @@ -11873,6 +11907,25 @@ "com.amazonaws.glue#DatabaseName": { "type": "string" }, + "com.amazonaws.glue#DatabrewCondition": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[A-Z\\_]+$" + } + }, + "com.amazonaws.glue#DatabrewConditionValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, "com.amazonaws.glue#Datatype": { "type": "structure", "members": { @@ -14385,13 +14438,13 @@ "com.amazonaws.glue#EnclosedInStringProperty": { "type": "string", "traits": { - "smithy.api#pattern": "^([\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF]|[^\\S\\r\\n\"'])*$" + "smithy.api#pattern": "^([\\u0009\\u000B\\u000C\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF])*$" } }, "com.amazonaws.glue#EnclosedInStringPropertyWithQuote": { "type": "string", "traits": { - "smithy.api#pattern": "^([\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF]|[^\\S\\r\\n])*$" + "smithy.api#pattern": "^([\\u0009\\u000B\\u000C\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF])*$" } }, "com.amazonaws.glue#EncryptionAtRest": { @@ -26461,7 +26514,7 @@ "com.amazonaws.glue#NodeName": { "type": "string", "traits": { - "smithy.api#pattern": "^([\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF]|[^\\r\\n])*$" + "smithy.api#pattern": "^([^\\r\\n])*$" } }, "com.amazonaws.glue#NodeType": { @@ -26756,6 +26809,16 @@ "smithy.api#documentation": "

A structure representing an open format table.

" } }, + "com.amazonaws.glue#Operation": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[A-Z\\_]+$" + } + }, "com.amazonaws.glue#OperationNotSupportedException": { "type": "structure", "members": { @@ -27164,6 +27227,34 @@ } } }, + "com.amazonaws.glue#ParameterMap": { + "type": "map", + "key": { + "target": "com.amazonaws.glue#ParameterName" + }, + "value": { + "target": "com.amazonaws.glue#ParameterValue" + } + }, + "com.amazonaws.glue#ParameterName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[A-Za-z0-9]+$" + } + }, + "com.amazonaws.glue#ParameterValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32768 + } + } + }, "com.amazonaws.glue#ParametersMap": { "type": "map", "key": { @@ -28456,8 +28547,13 @@ "RecipeReference": { "target": "com.amazonaws.glue#RecipeReference", "traits": { - "smithy.api#documentation": "

A reference to the DataBrew recipe used by the node.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A reference to the DataBrew recipe used by the node.

" + } + }, + "RecipeSteps": { + "target": "com.amazonaws.glue#RecipeSteps", + "traits": { + "smithy.api#documentation": "

Transform steps used in the recipe node.

" } } }, @@ -28465,6 +28561,27 @@ "smithy.api#documentation": "

A Glue Studio node that uses a Glue DataBrew recipe in Glue jobs.

" } }, + "com.amazonaws.glue#RecipeAction": { + "type": "structure", + "members": { + "Operation": { + "target": "com.amazonaws.glue#Operation", + "traits": { + "smithy.api#documentation": "

The operation of the recipe action.

", + "smithy.api#required": {} + } + }, + "Parameters": { + "target": "com.amazonaws.glue#ParameterMap", + "traits": { + "smithy.api#documentation": "

The parameters of the recipe action.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Actions defined in the Glue Studio data preparation recipe node.

" + } + }, "com.amazonaws.glue#RecipeReference": { "type": "structure", "members": { @@ -28487,6 +28604,33 @@ "smithy.api#documentation": "

A reference to a Glue DataBrew recipe.

" } }, + "com.amazonaws.glue#RecipeStep": { + "type": "structure", + "members": { + "Action": { + "target": "com.amazonaws.glue#RecipeAction", + "traits": { + "smithy.api#documentation": "

The transformation action of the recipe step.

", + "smithy.api#required": {} + } + }, + "ConditionExpressions": { + "target": "com.amazonaws.glue#ConditionExpressionList", + "traits": { + "smithy.api#documentation": "

The condition expressions for the recipe step.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A recipe step used in a Glue Studio data preparation recipe node.

" + } + }, + "com.amazonaws.glue#RecipeSteps": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#RecipeStep" + } + }, "com.amazonaws.glue#RecipeVersion": { "type": "string", "traits": { @@ -34341,6 +34485,15 @@ } } }, + "com.amazonaws.glue#TargetColumn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, "com.amazonaws.glue#TargetFormat": { "type": "enum", "members": { diff --git a/codegen/sdk-codegen/aws-models/groundstation.json b/codegen/sdk-codegen/aws-models/groundstation.json index 48e79bc409b..fbdf8a48609 100644 --- a/codegen/sdk-codegen/aws-models/groundstation.json +++ b/codegen/sdk-codegen/aws-models/groundstation.json @@ -4979,7 +4979,7 @@ } }, "traits": { - "smithy.api#documentation": "

Ephemeris data in Orbit Ephemeris Message (OEM) format.

" + "smithy.api#documentation": "

\n Ephemeris data in Orbit Ephemeris Message (OEM) format.\n

\n

\n Position, velocity, and acceleration units must be represented in km, km/s, and\n km/s**2, respectively, in ephemeris data lines. Covariance matrix line units must be\n represented in km**2 if computed from two positions, km**2/s if computed from one\n position and one velocity, and km**2/s**2 if computed from two velocities. Consult section\n 7.7.2 of The Consultative Committee for Space Data Systems (CCSDS)\n Recommended Standard for Orbit Data Messages\n for more information.\n

" } }, "com.amazonaws.groundstation#PaginationMaxResults": { diff --git a/codegen/sdk-codegen/aws-models/license-manager-linux-subscriptions.json b/codegen/sdk-codegen/aws-models/license-manager-linux-subscriptions.json index 30c6469b382..1fa1ca48cec 100644 --- a/codegen/sdk-codegen/aws-models/license-manager-linux-subscriptions.json +++ b/codegen/sdk-codegen/aws-models/license-manager-linux-subscriptions.json @@ -7,6 +7,60 @@ "com.amazonaws.licensemanagerlinuxsubscriptions#BoxLong": { "type": "long" }, + "com.amazonaws.licensemanagerlinuxsubscriptions#DeregisterSubscriptionProvider": { + "type": "operation", + "input": { + "target": "com.amazonaws.licensemanagerlinuxsubscriptions#DeregisterSubscriptionProviderRequest" + }, + "output": { + "target": "com.amazonaws.licensemanagerlinuxsubscriptions#DeregisterSubscriptionProviderResponse" + }, + "errors": [ + { + "target": "com.amazonaws.licensemanagerlinuxsubscriptions#InternalServerException" + }, + { + "target": "com.amazonaws.licensemanagerlinuxsubscriptions#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.licensemanagerlinuxsubscriptions#ThrottlingException" + }, + { + "target": "com.amazonaws.licensemanagerlinuxsubscriptions#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Remove a third-party subscription provider from the Bring Your Own License (BYOL) subscriptions \n\t\t\tregistered to your account.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/subscription/DeregisterSubscriptionProvider" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.licensemanagerlinuxsubscriptions#DeregisterSubscriptionProviderRequest": { + "type": "structure", + "members": { + "SubscriptionProviderArn": { + "target": "com.amazonaws.licensemanagerlinuxsubscriptions#SubscriptionProviderArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the subscription provider resource to deregister.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.licensemanagerlinuxsubscriptions#DeregisterSubscriptionProviderResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.licensemanagerlinuxsubscriptions#Filter": { "type": "structure", "members": { @@ -39,6 +93,97 @@ "target": "com.amazonaws.licensemanagerlinuxsubscriptions#Filter" } }, + "com.amazonaws.licensemanagerlinuxsubscriptions#GetRegisteredSubscriptionProvider": { + "type": "operation", + "input": { + "target": "com.amazonaws.licensemanagerlinuxsubscriptions#GetRegisteredSubscriptionProviderRequest" + }, + "output": { + "target": "com.amazonaws.licensemanagerlinuxsubscriptions#GetRegisteredSubscriptionProviderResponse" + }, + "errors": [ + { + "target": "com.amazonaws.licensemanagerlinuxsubscriptions#InternalServerException" + }, + { + "target": "com.amazonaws.licensemanagerlinuxsubscriptions#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.licensemanagerlinuxsubscriptions#ThrottlingException" + }, + { + "target": "com.amazonaws.licensemanagerlinuxsubscriptions#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Get details for a Bring Your Own License (BYOL) subscription that's registered to your account.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/subscription/GetRegisteredSubscriptionProvider" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.licensemanagerlinuxsubscriptions#GetRegisteredSubscriptionProviderRequest": { + "type": "structure", + "members": { + "SubscriptionProviderArn": { + "target": "com.amazonaws.licensemanagerlinuxsubscriptions#SubscriptionProviderArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the BYOL registration resource to get details for.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.licensemanagerlinuxsubscriptions#GetRegisteredSubscriptionProviderResponse": { + "type": "structure", + "members": { + "SubscriptionProviderArn": { + "target": "com.amazonaws.licensemanagerlinuxsubscriptions#SubscriptionProviderArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the BYOL registration resource specified in the request.

" + } + }, + "SubscriptionProviderSource": { + "target": "com.amazonaws.licensemanagerlinuxsubscriptions#SubscriptionProviderSource", + "traits": { + "smithy.api#documentation": "

The subscription provider for the BYOL registration resource specified \n\t\t\tin the request.

" + } + }, + "SecretArn": { + "target": "com.amazonaws.licensemanagerlinuxsubscriptions#SecretArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the third-party access secret stored in Secrets Manager for the BYOL \n\t\t\tregistration resource specified in the request.

" + } + }, + "SubscriptionProviderStatus": { + "target": "com.amazonaws.licensemanagerlinuxsubscriptions#SubscriptionProviderStatus", + "traits": { + "smithy.api#documentation": "

The status of the Linux subscription provider access token from the last \n\t\t\tsuccessful subscription data request.

" + } + }, + "SubscriptionProviderStatusMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The detailed message from your subscription provider token status.

" + } + }, + "LastSuccessfulDataRetrievalTime": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The timestamp from the last time License Manager retrieved subscription details \n\t\t\tfrom your registered third-party Linux subscription provider.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.licensemanagerlinuxsubscriptions#GetServiceSettings": { "type": "operation", "input": { @@ -59,7 +204,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the Linux subscriptions service settings.

", + "smithy.api#documentation": "

Lists the Linux subscriptions service settings for your account.

", "smithy.api#http": { "code": 200, "method": "POST", @@ -167,7 +312,37 @@ "SubscriptionName": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The name of the subscription being used by the instance.

" + "smithy.api#documentation": "

The name of the license subscription that the instance uses.

" + } + }, + "OsVersion": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The operating system software version that runs on your instance.

" + } + }, + "SubscriptionProviderCreateTime": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The timestamp when you registered the third-party Linux subscription \n\t\t\tprovider for the subscription that the instance uses.

" + } + }, + "SubscriptionProviderUpdateTime": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The timestamp from the last time that the instance synced with the registered \n\t\t\tthird-party Linux subscription provider.

" + } + }, + "DualSubscription": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

Indicates that you have two different license subscriptions for \n\t\t\tthe same software on your instance.

" + } + }, + "RegisteredWithSubscriptionProvider": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

Indicates that your instance uses a BYOL license subscription from \n\t\t\ta third-party Linux subscription provider that you've registered with License Manager.

" } } }, @@ -197,6 +372,12 @@ "type": "service", "version": "2018-05-10", "operations": [ + { + "target": "com.amazonaws.licensemanagerlinuxsubscriptions#DeregisterSubscriptionProvider" + }, + { + "target": "com.amazonaws.licensemanagerlinuxsubscriptions#GetRegisteredSubscriptionProvider" + }, { "target": "com.amazonaws.licensemanagerlinuxsubscriptions#GetServiceSettings" }, @@ -206,6 +387,21 @@ { "target": "com.amazonaws.licensemanagerlinuxsubscriptions#ListLinuxSubscriptions" }, + { + "target": "com.amazonaws.licensemanagerlinuxsubscriptions#ListRegisteredSubscriptionProviders" + }, + { + "target": "com.amazonaws.licensemanagerlinuxsubscriptions#ListTagsForResource" + }, + { + "target": "com.amazonaws.licensemanagerlinuxsubscriptions#RegisterSubscriptionProvider" + }, + { + "target": "com.amazonaws.licensemanagerlinuxsubscriptions#TagResource" + }, + { + "target": "com.amazonaws.licensemanagerlinuxsubscriptions#UntagResource" + }, { "target": "com.amazonaws.licensemanagerlinuxsubscriptions#UpdateServiceSettings" } @@ -227,15 +423,7 @@ "x-amz-content-sha256", "x-amz-user-agent", "x-amzn-platform-id", - "x-amzn-trace-id", - "content-length", - "x-api-key", - "authorization", - "x-amz-date", - "x-amz-security-token", - "Access-Control-Allow-Headers", - "Access-Control-Allow-Methods", - "Access-Control-Allow-Origin" + "x-amzn-trace-id" ], "additionalExposedHeaders": [ "x-amzn-errortype", @@ -287,7 +475,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -306,7 +493,6 @@ }, { "conditions": [], - "type": "tree", "rules": [ { "conditions": [ @@ -334,13 +520,14 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], - "type": "tree", "rules": [ { "conditions": [ @@ -353,7 +540,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -367,7 +553,6 @@ "assign": "PartitionResult" } ], - "type": "tree", "rules": [ { "conditions": [ @@ -390,7 +575,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -425,11 +609,9 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], - "type": "tree", "rules": [ { "conditions": [], @@ -440,16 +622,19 @@ }, "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": [ @@ -463,14 +648,12 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ - true, { "fn": "getAttr", "argv": [ @@ -479,15 +662,14 @@ }, "supportsFIPS" ] - } + }, + true ] } ], - "type": "tree", "rules": [ { "conditions": [], - "type": "tree", "rules": [ { "conditions": [], @@ -498,16 +680,19 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -521,7 +706,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -541,11 +725,9 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], - "type": "tree", "rules": [ { "conditions": [], @@ -556,20 +738,22 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], - "type": "tree", "rules": [ { "conditions": [], @@ -580,18 +764,22 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } - ] + ], + "type": "tree" } ] }, @@ -991,19 +1179,19 @@ "Filters": { "target": "com.amazonaws.licensemanagerlinuxsubscriptions#FilterList", "traits": { - "smithy.api#documentation": "

An array of structures that you can use to filter the results to those that match one or\n more sets of key-value pairs that you specify. For example, you can filter by the name of\n AmiID with an optional operator to see subscriptions that match, partially\n match, or don't match a certain Amazon Machine Image (AMI) ID.

\n

The valid names for this filter are:

\n \n

The valid Operators for this filter are:

\n " + "smithy.api#documentation": "

An array of structures that you can use to filter the results by your specified criteria. \n \tFor example, you can specify Region in the Name, with the \n \tcontains operator to list all subscriptions that match a partial string in the \n \tValue, such as us-west.

\n

For each filter, you can specify one of the following values for the Name key \n \tto streamline results:

\n \n

For each filter, you can use one of the following Operator values to \n \t\tdefine the behavior of the filter:

\n " } }, "MaxResults": { "target": "com.amazonaws.licensemanagerlinuxsubscriptions#BoxInteger", "traits": { - "smithy.api#documentation": "

Maximum number of results to return in a single call.

" + "smithy.api#documentation": "

The maximum items to return in a request.

" } }, "NextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Token for the next set of results.

", + "smithy.api#documentation": "

A token to specify where to start paginating. This \n\tis the nextToken from a previously truncated response.

", "smithy.api#length": { "min": 1, "max": 16384 @@ -1027,7 +1215,7 @@ "NextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Token for the next set of results.

" + "smithy.api#documentation": "

The next token used for paginated responses. When this \n\tfield isn't empty, there are additional elements that the service hasn't \n\tincluded in this request. Use this token with the next request to retrieve \n\tadditional objects.

" } } } @@ -1079,13 +1267,13 @@ "MaxResults": { "target": "com.amazonaws.licensemanagerlinuxsubscriptions#BoxInteger", "traits": { - "smithy.api#documentation": "

Maximum number of results to return in a single call.

" + "smithy.api#documentation": "

The maximum items to return in a request.

" } }, "NextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Token for the next set of results.

", + "smithy.api#documentation": "

A token to specify where to start paginating. This \n\tis the nextToken from a previously truncated response.

", "smithy.api#length": { "min": 1, "max": 16384 @@ -1109,9 +1297,152 @@ "NextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Token for the next set of results.

" + "smithy.api#documentation": "

The next token used for paginated responses. When this \n\tfield isn't empty, there are additional elements that the service hasn't \n\tincluded in this request. Use this token with the next request to retrieve \n\tadditional objects.

" + } + } + } + }, + "com.amazonaws.licensemanagerlinuxsubscriptions#ListRegisteredSubscriptionProviders": { + "type": "operation", + "input": { + "target": "com.amazonaws.licensemanagerlinuxsubscriptions#ListRegisteredSubscriptionProvidersRequest" + }, + "output": { + "target": "com.amazonaws.licensemanagerlinuxsubscriptions#ListRegisteredSubscriptionProvidersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.licensemanagerlinuxsubscriptions#InternalServerException" + }, + { + "target": "com.amazonaws.licensemanagerlinuxsubscriptions#ThrottlingException" + }, + { + "target": "com.amazonaws.licensemanagerlinuxsubscriptions#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

List Bring Your Own License (BYOL) subscription registration resources for your account.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/subscription/ListRegisteredSubscriptionProviders" + }, + "smithy.api#idempotent": {}, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults", + "items": "RegisteredSubscriptionProviders" + } + } + }, + "com.amazonaws.licensemanagerlinuxsubscriptions#ListRegisteredSubscriptionProvidersRequest": { + "type": "structure", + "members": { + "SubscriptionProviderSources": { + "target": "com.amazonaws.licensemanagerlinuxsubscriptions#SubscriptionProviderSourceList", + "traits": { + "smithy.api#documentation": "

To filter your results, specify which subscription providers to return \n\t\t\tin the list.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.licensemanagerlinuxsubscriptions#BoxInteger", + "traits": { + "smithy.api#documentation": "

The maximum items to return in a request.

", + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "NextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A token to specify where to start paginating. This \n\tis the nextToken from a previously truncated response.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.licensemanagerlinuxsubscriptions#ListRegisteredSubscriptionProvidersResponse": { + "type": "structure", + "members": { + "RegisteredSubscriptionProviders": { + "target": "com.amazonaws.licensemanagerlinuxsubscriptions#RegisteredSubscriptionProviderList", + "traits": { + "smithy.api#documentation": "

The list of BYOL registration resources that fit the criteria \n\t\t\tyou specified in the request.

" + } + }, + "NextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The next token used for paginated responses. When this \n\tfield isn't empty, there are additional elements that the service hasn't \n\tincluded in this request. Use this token with the next request to retrieve \n\tadditional objects.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.licensemanagerlinuxsubscriptions#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.licensemanagerlinuxsubscriptions#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.licensemanagerlinuxsubscriptions#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.licensemanagerlinuxsubscriptions#InternalServerException" + }, + { + "target": "com.amazonaws.licensemanagerlinuxsubscriptions#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.licensemanagerlinuxsubscriptions#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

List the metadata tags that are assigned to the \n\t\t\tspecified Amazon Web Services resource.

", + "smithy.api#http": { + "method": "GET", + "uri": "/tags/{resourceArn}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.licensemanagerlinuxsubscriptions#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.licensemanagerlinuxsubscriptions#SubscriptionProviderArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource for which to list metadata tags.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.licensemanagerlinuxsubscriptions#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.licensemanagerlinuxsubscriptions#Tags", + "traits": { + "smithy.api#documentation": "

The metadata tags for the requested resource.

" + } + } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.licensemanagerlinuxsubscriptions#Operator": { @@ -1163,6 +1494,157 @@ "target": "smithy.api#String" } }, + "com.amazonaws.licensemanagerlinuxsubscriptions#RegisterSubscriptionProvider": { + "type": "operation", + "input": { + "target": "com.amazonaws.licensemanagerlinuxsubscriptions#RegisterSubscriptionProviderRequest" + }, + "output": { + "target": "com.amazonaws.licensemanagerlinuxsubscriptions#RegisterSubscriptionProviderResponse" + }, + "errors": [ + { + "target": "com.amazonaws.licensemanagerlinuxsubscriptions#InternalServerException" + }, + { + "target": "com.amazonaws.licensemanagerlinuxsubscriptions#ThrottlingException" + }, + { + "target": "com.amazonaws.licensemanagerlinuxsubscriptions#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Register the supported third-party subscription provider for your Bring Your Own License (BYOL) subscription.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/subscription/RegisterSubscriptionProvider" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.licensemanagerlinuxsubscriptions#RegisterSubscriptionProviderRequest": { + "type": "structure", + "members": { + "SubscriptionProviderSource": { + "target": "com.amazonaws.licensemanagerlinuxsubscriptions#SubscriptionProviderSource", + "traits": { + "smithy.api#documentation": "

The supported Linux subscription provider to register.

", + "smithy.api#required": {} + } + }, + "SecretArn": { + "target": "com.amazonaws.licensemanagerlinuxsubscriptions#SecretArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the secret where you've stored your subscription provider's access token. For \n\t\t\tRHEL subscriptions managed through the Red Hat Subscription Manager (RHSM), the secret contains \n\t\t\tyour Red Hat Offline token.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.licensemanagerlinuxsubscriptions#Tags", + "traits": { + "smithy.api#documentation": "

The metadata tags to assign to your registered Linux subscription provider \n\t\t\tresource.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.licensemanagerlinuxsubscriptions#RegisterSubscriptionProviderResponse": { + "type": "structure", + "members": { + "SubscriptionProviderSource": { + "target": "com.amazonaws.licensemanagerlinuxsubscriptions#SubscriptionProviderSource", + "traits": { + "smithy.api#documentation": "

The Linux subscription provider that you registered.

" + } + }, + "SubscriptionProviderArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Linux subscription provider resource that you registered.

" + } + }, + "SubscriptionProviderStatus": { + "target": "com.amazonaws.licensemanagerlinuxsubscriptions#SubscriptionProviderStatus", + "traits": { + "smithy.api#documentation": "

Indicates the status of the registration action for the Linux subscription provider \n\t\t\tthat you requested.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.licensemanagerlinuxsubscriptions#RegisteredSubscriptionProvider": { + "type": "structure", + "members": { + "SubscriptionProviderArn": { + "target": "com.amazonaws.licensemanagerlinuxsubscriptions#SubscriptionProviderArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Linux subscription provider resource that you registered.

" + } + }, + "SubscriptionProviderSource": { + "target": "com.amazonaws.licensemanagerlinuxsubscriptions#SubscriptionProviderSource", + "traits": { + "smithy.api#documentation": "

A supported third-party Linux subscription provider. License Manager currently supports \n\t\t\tRed Hat subscriptions.

" + } + }, + "SecretArn": { + "target": "com.amazonaws.licensemanagerlinuxsubscriptions#SecretArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Secrets Manager secret that stores your registered Linux subscription provider \n\t\t\taccess token. For RHEL account subscriptions, this is the offline token.

" + } + }, + "SubscriptionProviderStatus": { + "target": "com.amazonaws.licensemanagerlinuxsubscriptions#SubscriptionProviderStatus", + "traits": { + "smithy.api#documentation": "

Indicates the status of your registered Linux subscription provider access token \n\t\t\tfrom the last time License Manager retrieved subscription data. For RHEL account subscriptions, \n\t\t\tthis is the status of the offline token.

" + } + }, + "SubscriptionProviderStatusMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A detailed message that's associated with your BYOL subscription \n\t\t\tprovider token status.

" + } + }, + "LastSuccessfulDataRetrievalTime": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The timestamp from the last time that License Manager accessed third-party subscription data \n\t\t\tfor your account from your registered Linux subscription provider.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A third-party provider for operating system (OS) platform software and license \n\t\t\tsubscriptions, such as Red Hat. When you register a third-party Linux subscription \n\t\t\tprovider, License Manager can get subscription data from the registered provider.

" + } + }, + "com.amazonaws.licensemanagerlinuxsubscriptions#RegisteredSubscriptionProviderList": { + "type": "list", + "member": { + "target": "com.amazonaws.licensemanagerlinuxsubscriptions#RegisteredSubscriptionProvider" + } + }, + "com.amazonaws.licensemanagerlinuxsubscriptions#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "

Unable to find the requested Amazon Web Services resource.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.licensemanagerlinuxsubscriptions#SecretArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:[a-z0-9-\\.]{1,63}:secretsmanager:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:secret:[^/]{1,1023}$" + } + }, "com.amazonaws.licensemanagerlinuxsubscriptions#Status": { "type": "string", "traits": { @@ -1250,6 +1732,139 @@ "target": "com.amazonaws.licensemanagerlinuxsubscriptions#Subscription" } }, + "com.amazonaws.licensemanagerlinuxsubscriptions#SubscriptionProviderArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{1,510}/[a-z0-9-\\.]{1,510}$" + } + }, + "com.amazonaws.licensemanagerlinuxsubscriptions#SubscriptionProviderSource": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "RedHat", + "value": "RedHat", + "documentation": "RedHat subscription provider namespace" + } + ] + } + }, + "com.amazonaws.licensemanagerlinuxsubscriptions#SubscriptionProviderSourceList": { + "type": "list", + "member": { + "target": "com.amazonaws.licensemanagerlinuxsubscriptions#SubscriptionProviderSource" + } + }, + "com.amazonaws.licensemanagerlinuxsubscriptions#SubscriptionProviderStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "ACTIVE", + "value": "ACTIVE", + "documentation": "ACTIVE status" + }, + { + "name": "INVALID", + "value": "INVALID", + "documentation": "INVALID status" + }, + { + "name": "PENDING", + "value": "PENDING", + "documentation": "PENDING status" + } + ] + } + }, + "com.amazonaws.licensemanagerlinuxsubscriptions#TagKeyList": { + "type": "list", + "member": { + "target": "smithy.api#String" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.licensemanagerlinuxsubscriptions#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.licensemanagerlinuxsubscriptions#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.licensemanagerlinuxsubscriptions#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.licensemanagerlinuxsubscriptions#InternalServerException" + }, + { + "target": "com.amazonaws.licensemanagerlinuxsubscriptions#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.licensemanagerlinuxsubscriptions#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Add metadata tags to the specified Amazon Web Services resource.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/tags/{resourceArn}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.licensemanagerlinuxsubscriptions#TagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.licensemanagerlinuxsubscriptions#SubscriptionProviderArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services resource to which to add the specified \n\t\t\tmetadata tags.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.licensemanagerlinuxsubscriptions#Tags", + "traits": { + "smithy.api#documentation": "

The metadata tags to assign to the Amazon Web Services resource. Tags are \n\t\t\tformatted as key value pairs.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.licensemanagerlinuxsubscriptions#TagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.licensemanagerlinuxsubscriptions#Tags": { + "type": "map", + "key": { + "target": "smithy.api#String" + }, + "value": { + "target": "smithy.api#String" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + }, + "smithy.api#sensitive": {} + } + }, "com.amazonaws.licensemanagerlinuxsubscriptions#ThrottlingException": { "type": "structure", "members": { @@ -1262,6 +1877,62 @@ "smithy.api#error": "client" } }, + "com.amazonaws.licensemanagerlinuxsubscriptions#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.licensemanagerlinuxsubscriptions#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.licensemanagerlinuxsubscriptions#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.licensemanagerlinuxsubscriptions#InternalServerException" + }, + { + "target": "com.amazonaws.licensemanagerlinuxsubscriptions#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Remove one or more metadata tag from the specified Amazon Web Services resource.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/tags/{resourceArn}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.licensemanagerlinuxsubscriptions#UntagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.licensemanagerlinuxsubscriptions#SubscriptionProviderArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services resource to remove the metadata tags from.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tagKeys": { + "target": "com.amazonaws.licensemanagerlinuxsubscriptions#TagKeyList", + "traits": { + "smithy.api#documentation": "

A list of metadata tag keys to remove from the requested \n\t\t\tresource.

", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.licensemanagerlinuxsubscriptions#UntagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.licensemanagerlinuxsubscriptions#UpdateServiceSettings": { "type": "operation", "input": { diff --git a/codegen/sdk-codegen/aws-models/mediaconnect.json b/codegen/sdk-codegen/aws-models/mediaconnect.json index 84998e7d71a..5f362e56e9b 100644 --- a/codegen/sdk-codegen/aws-models/mediaconnect.json +++ b/codegen/sdk-codegen/aws-models/mediaconnect.json @@ -991,6 +991,13 @@ "smithy.api#documentation": "The name of the VPC interface attachment to use for this output.", "smithy.api#jsonName": "vpcInterfaceAttachment" } + }, + "OutputStatus": { + "target": "com.amazonaws.mediaconnect#OutputStatus", + "traits": { + "smithy.api#documentation": "An indication of whether the new output should be enabled or disabled as soon as it is created. If you don't specify the outputStatus field in your request, MediaConnect sets it to ENABLED.", + "smithy.api#jsonName": "outputStatus" + } } }, "traits": { @@ -5326,6 +5333,9 @@ "name": "mediaconnect" }, "aws.protocols#restJson1": {}, + "smithy.api#auth": [ + "aws.auth#sigv4" + ], "smithy.api#documentation": "API for AWS Elemental MediaConnect", "smithy.api#title": "AWS MediaConnect", "smithy.rules#endpointRuleSet": { @@ -6714,12 +6724,36 @@ "smithy.api#documentation": "The bridge output ports currently in use.", "smithy.api#jsonName": "bridgePorts" } + }, + "OutputStatus": { + "target": "com.amazonaws.mediaconnect#OutputStatus", + "traits": { + "smithy.api#documentation": "An indication of whether the output is transmitting data or not.", + "smithy.api#jsonName": "outputStatus" + } } }, "traits": { "smithy.api#documentation": "The settings for an output." } }, + "com.amazonaws.mediaconnect#OutputStatus": { + "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.mediaconnect#PriceUnits": { "type": "enum", "members": { @@ -9719,6 +9753,13 @@ "smithy.api#documentation": "The name of the VPC interface attachment to use for this output.", "smithy.api#jsonName": "vpcInterfaceAttachment" } + }, + "OutputStatus": { + "target": "com.amazonaws.mediaconnect#OutputStatus", + "traits": { + "smithy.api#documentation": "An indication of whether the output should transmit data or not. If you don't specify the outputStatus field in your request, MediaConnect leaves the value unchanged.", + "smithy.api#jsonName": "outputStatus" + } } }, "traits": {