diff --git a/.changes/2.1587.0.json b/.changes/2.1587.0.json new file mode 100644 index 0000000000..9e4378eb5d --- /dev/null +++ b/.changes/2.1587.0.json @@ -0,0 +1,27 @@ +[ + { + "type": "bugfix", + "category": "Endpoints", + "description": "Add endpoint override for eu-isoe-* region" + }, + { + "type": "feature", + "category": "Batch", + "description": "This feature allows AWS Batch to support configuration of imagePullSecrets and allowPrivilegeEscalation for jobs running on EKS" + }, + { + "type": "feature", + "category": "BedrockAgent", + "description": "This changes introduces metadata documents statistics and also updates the documentation for bedrock agent." + }, + { + "type": "feature", + "category": "BedrockAgentRuntime", + "description": "This release introduces filtering support on Retrieve and RetrieveAndGenerate APIs." + }, + { + "type": "feature", + "category": "ElastiCache", + "description": "Added minimum capacity to Amazon ElastiCache Serverless. This feature allows customer to ensure minimum capacity even without current load" + } +] \ No newline at end of file diff --git a/.changes/next-release/bugfix-Endpoints-52ee1372.json b/.changes/next-release/bugfix-Endpoints-52ee1372.json deleted file mode 100644 index 39d0eefc57..0000000000 --- a/.changes/next-release/bugfix-Endpoints-52ee1372.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "type": "bugfix", - "category": "Endpoints", - "description": "Add endpoint override for eu-isoe-* region" -} \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index 912763e74e..3bb0184e0f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,7 +1,14 @@ # Changelog for AWS SDK for JavaScript - + +## 2.1587.0 +* bugfix: Endpoints: Add endpoint override for eu-isoe-* region +* feature: Batch: This feature allows AWS Batch to support configuration of imagePullSecrets and allowPrivilegeEscalation for jobs running on EKS +* feature: BedrockAgent: This changes introduces metadata documents statistics and also updates the documentation for bedrock agent. +* feature: BedrockAgentRuntime: This release introduces filtering support on Retrieve and RetrieveAndGenerate APIs. +* feature: ElastiCache: Added minimum capacity to Amazon ElastiCache Serverless. This feature allows customer to ensure minimum capacity even without current load + ## 2.1586.0 * feature: BedrockAgentRuntime: This release adds support to customize prompts sent through the RetrieveAndGenerate API in Agents for Amazon Bedrock. * feature: CostExplorer: Adds support for backfill of cost allocation tags, with new StartCostAllocationTagBackfill and ListCostAllocationTagBackfillHistory API. diff --git a/README.md b/README.md index aae94f334c..4f8f0bc0fc 100644 --- a/README.md +++ b/README.md @@ -64,7 +64,7 @@ require('aws-sdk/lib/maintenance_mode_message').suppress = true; To use the SDK in the browser, simply add the following script tag to your HTML pages: - + You can also build a custom browser SDK with your specified set of AWS services. This can allow you to reduce the SDK's size, specify different API versions of diff --git a/apis/batch-2016-08-10.min.json b/apis/batch-2016-08-10.min.json index 678653f81f..01100ae058 100644 --- a/apis/batch-2016-08-10.min.json +++ b/apis/batch-2016-08-10.min.json @@ -465,7 +465,7 @@ "reason": {}, "logStreamName": {}, "networkInterfaces": { - "shape": "S43" + "shape": "S45" } } }, @@ -493,7 +493,7 @@ "type": "long" }, "dependsOn": { - "shape": "S45" + "shape": "S47" }, "jobDefinition": {}, "parameters": { @@ -542,7 +542,7 @@ "logStreamName": {}, "instanceType": {}, "networkInterfaces": { - "shape": "S43" + "shape": "S45" }, "resourceRequirements": { "shape": "S27" @@ -628,19 +628,22 @@ "type": "boolean" }, "dnsPolicy": {}, + "imagePullSecrets": { + "shape": "S37" + }, "containers": { - "shape": "S4e" + "shape": "S4g" }, "initContainers": { - "shape": "S4e" + "shape": "S4g" }, "volumes": { - "shape": "S3j" + "shape": "S3l" }, "podName": {}, "nodeName": {}, "metadata": { - "shape": "S3o" + "shape": "S3q" }, "shareProcessNamespace": { "type": "boolean" @@ -655,10 +658,10 @@ "type": "structure", "members": { "containers": { - "shape": "S4i" + "shape": "S4k" }, "initContainers": { - "shape": "S4i" + "shape": "S4k" }, "podName": {}, "nodeName": {}, @@ -733,7 +736,7 @@ "reason": {}, "logStreamName": {}, "networkInterfaces": { - "shape": "S43" + "shape": "S45" } } } @@ -1064,14 +1067,14 @@ } }, "dependsOn": { - "shape": "S45" + "shape": "S47" }, "jobDefinition": {}, "parameters": { "shape": "S1o" }, "containerOverrides": { - "shape": "S5d" + "shape": "S5f" }, "nodeOverrides": { "type": "structure", @@ -1089,10 +1092,10 @@ "members": { "targetNodes": {}, "containerOverrides": { - "shape": "S5d" + "shape": "S5f" }, "ecsPropertiesOverride": { - "shape": "S5h" + "shape": "S5j" }, "instanceTypes": { "shape": "Sb" @@ -1121,20 +1124,20 @@ "type": "structure", "members": { "containers": { - "shape": "S5o" + "shape": "S5q" }, "initContainers": { - "shape": "S5o" + "shape": "S5q" }, "metadata": { - "shape": "S3o" + "shape": "S3q" } } } } }, "ecsPropertiesOverride": { - "shape": "S5h" + "shape": "S5j" } } }, @@ -1994,17 +1997,20 @@ "type": "boolean" }, "dnsPolicy": {}, - "containers": { + "imagePullSecrets": { "shape": "S37" }, + "containers": { + "shape": "S39" + }, "initContainers": { - "shape": "S37" + "shape": "S39" }, "volumes": { - "shape": "S3j" + "shape": "S3l" }, "metadata": { - "shape": "S3o" + "shape": "S3q" }, "shareProcessNamespace": { "type": "boolean" @@ -2014,6 +2020,18 @@ } }, "S37": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "name" + ], + "members": { + "name": {} + } + } + }, + "S39": { "type": "list", "member": { "type": "structure", @@ -2031,21 +2049,21 @@ "shape": "Sb" }, "env": { - "shape": "S39" + "shape": "S3b" }, "resources": { - "shape": "S3b" + "shape": "S3d" }, "volumeMounts": { - "shape": "S3f" + "shape": "S3h" }, "securityContext": { - "shape": "S3h" + "shape": "S3j" } } } }, - "S39": { + "S3b": { "type": "list", "member": { "type": "structure", @@ -2058,7 +2076,7 @@ } } }, - "S3b": { + "S3d": { "type": "structure", "members": { "limits": { @@ -2073,7 +2091,7 @@ } } }, - "S3f": { + "S3h": { "type": "list", "member": { "type": "structure", @@ -2086,7 +2104,7 @@ } } }, - "S3h": { + "S3j": { "type": "structure", "members": { "runAsUser": { @@ -2098,6 +2116,9 @@ "privileged": { "type": "boolean" }, + "allowPrivilegeEscalation": { + "type": "boolean" + }, "readOnlyRootFilesystem": { "type": "boolean" }, @@ -2106,7 +2127,7 @@ } } }, - "S3j": { + "S3l": { "type": "list", "member": { "type": "structure", @@ -2143,7 +2164,7 @@ } } }, - "S3o": { + "S3q": { "type": "structure", "members": { "labels": { @@ -2153,7 +2174,7 @@ } } }, - "S43": { + "S45": { "type": "list", "member": { "type": "structure", @@ -2164,7 +2185,7 @@ } } }, - "S45": { + "S47": { "type": "list", "member": { "type": "structure", @@ -2174,7 +2195,7 @@ } } }, - "S4e": { + "S4g": { "type": "list", "member": { "type": "structure", @@ -2189,25 +2210,25 @@ "shape": "Sb" }, "env": { - "shape": "S39" + "shape": "S3b" }, "resources": { - "shape": "S3b" + "shape": "S3d" }, "exitCode": { "type": "integer" }, "reason": {}, "volumeMounts": { - "shape": "S3f" + "shape": "S3h" }, "securityContext": { - "shape": "S3h" + "shape": "S3j" } } } }, - "S4i": { + "S4k": { "type": "list", "member": { "type": "structure", @@ -2219,7 +2240,7 @@ } } }, - "S5d": { + "S5f": { "type": "structure", "members": { "vcpus": { @@ -2244,7 +2265,7 @@ } } }, - "S5h": { + "S5j": { "type": "structure", "members": { "taskProperties": { @@ -2275,7 +2296,7 @@ } } }, - "S5o": { + "S5q": { "type": "list", "member": { "type": "structure", @@ -2289,10 +2310,10 @@ "shape": "Sb" }, "env": { - "shape": "S39" + "shape": "S3b" }, "resources": { - "shape": "S3b" + "shape": "S3d" } } } diff --git a/apis/batch-2016-08-10.normal.json b/apis/batch-2016-08-10.normal.json index bca4917848..af812bfabc 100644 --- a/apis/batch-2016-08-10.normal.json +++ b/apis/batch-2016-08-10.normal.json @@ -2157,6 +2157,10 @@ "shape": "Boolean", "documentation": "
When this parameter is true
, the container is given elevated permissions on the host container instance. The level of permissions are similar to the root
user permissions. The default value is false
. This parameter maps to privileged
policy in the Privileged pod security policies in the Kubernetes documentation.
Whether or not a container or a Kubernetes pod is allowed to gain more privileges than its parent process. The default value is false
.
When this parameter is true
, the container is given read-only access to its root file system. The default value is false
. This parameter maps to ReadOnlyRootFilesystem
policy in the Volumes and file systems pod security policies in the Kubernetes documentation.
The DNS policy for the pod. The default value is ClusterFirst
. If the hostNetwork
parameter is not specified, the default is ClusterFirstWithHostNet
. ClusterFirst
indicates that any DNS query that does not match the configured cluster domain suffix is forwarded to the upstream nameserver inherited from the node. For more information, see Pod's DNS policy in the Kubernetes documentation.
Valid values: Default
| ClusterFirst
| ClusterFirstWithHostNet
References a Kubernetes secret resource. This object must start and end with an alphanumeric character, is required to be lowercase, can include periods (.) and hyphens (-), and can't contain more than 253 characters.
ImagePullSecret$name
is required when this object is used.
The properties of the container that's used on the Amazon EKS pod.
" @@ -2303,6 +2311,10 @@ "shape": "String", "documentation": "The DNS policy for the pod. The default value is ClusterFirst
. If the hostNetwork
parameter is not specified, the default is ClusterFirstWithHostNet
. ClusterFirst
indicates that any DNS query that does not match the configured cluster domain suffix is forwarded to the upstream nameserver inherited from the node. If no value was specified for dnsPolicy
in the RegisterJobDefinition API operation, then no value will be returned for dnsPolicy
by either of DescribeJobDefinitions or DescribeJobs API operations. The pod spec setting will contain either ClusterFirst
or ClusterFirstWithHostNet
, depending on the value of the hostNetwork
parameter. For more information, see Pod's DNS policy in the Kubernetes documentation.
Valid values: Default
| ClusterFirst
| ClusterFirstWithHostNet
Displays the reference pointer to the Kubernetes secret resource.
" + }, "containers": { "shape": "EksContainerDetails", "documentation": "The properties of the container that's used on the Amazon EKS pod.
" @@ -2535,6 +2547,25 @@ "max": 256, "min": 1 }, + "ImagePullSecret": { + "type": "structure", + "required": [ + "name" + ], + "members": { + "name": { + "shape": "String", + "documentation": "Provides a unique identifier for the ImagePullSecret
. This object is required when EksPodProperties$imagePullSecrets
is used.
References a Kubernetes configuration resource that holds a list of secrets. These secrets help to gain access to pull an image from a private registry.
" + }, + "ImagePullSecrets": { + "type": "list", + "member": { + "shape": "ImagePullSecret" + } + }, "ImageType": { "type": "string", "max": 256, diff --git a/apis/bedrock-agent-2023-06-05.min.json b/apis/bedrock-agent-2023-06-05.min.json index c8574da913..06bae08f84 100644 --- a/apis/bedrock-agent-2023-06-05.min.json +++ b/apis/bedrock-agent-2023-06-05.min.json @@ -23,8 +23,8 @@ "required": [ "agentId", "agentVersion", - "knowledgeBaseId", - "description" + "description", + "knowledgeBaseId" ], "members": { "agentId": { @@ -35,8 +35,8 @@ "location": "uri", "locationName": "agentVersion" }, - "knowledgeBaseId": {}, "description": {}, + "knowledgeBaseId": {}, "knowledgeBaseState": {} } }, @@ -67,24 +67,24 @@ ], "members": { "agentName": {}, + "agentResourceRoleArn": {}, "clientToken": { "idempotencyToken": true }, - "instruction": { - "shape": "Sd" - }, - "foundationModel": {}, + "customerEncryptionKeyArn": {}, "description": {}, + "foundationModel": {}, "idleSessionTTLInSeconds": { "type": "integer" }, - "agentResourceRoleArn": {}, - "customerEncryptionKeyArn": {}, - "tags": { - "shape": "Si" + "instruction": { + "shape": "Sh" }, "promptOverrideConfiguration": { - "shape": "Sl" + "shape": "Si" + }, + "tags": { + "shape": "Sx" } } }, @@ -110,11 +110,16 @@ "input": { "type": "structure", "required": [ + "actionGroupName", "agentId", - "agentVersion", - "actionGroupName" + "agentVersion" ], "members": { + "actionGroupExecutor": { + "shape": "S19" + }, + "actionGroupName": {}, + "actionGroupState": {}, "agentId": { "location": "uri", "locationName": "agentId" @@ -123,19 +128,14 @@ "location": "uri", "locationName": "agentVersion" }, - "actionGroupName": {}, + "apiSchema": { + "shape": "S1b" + }, "clientToken": { "idempotencyToken": true }, "description": {}, - "parentActionGroupSignature": {}, - "actionGroupExecutor": { - "shape": "S1a" - }, - "apiSchema": { - "shape": "S1b" - }, - "actionGroupState": {} + "parentActionGroupSignature": {} } }, "output": { @@ -160,15 +160,15 @@ "input": { "type": "structure", "required": [ - "agentId", - "agentAliasName" + "agentAliasName", + "agentId" ], "members": { + "agentAliasName": {}, "agentId": { "location": "uri", "locationName": "agentId" }, - "agentAliasName": {}, "clientToken": { "idempotencyToken": true }, @@ -177,7 +177,7 @@ "shape": "S1k" }, "tags": { - "shape": "Si" + "shape": "Sx" } } }, @@ -203,23 +203,23 @@ "input": { "type": "structure", "required": [ + "dataSourceConfiguration", "knowledgeBaseId", - "name", - "dataSourceConfiguration" + "name" ], "members": { - "knowledgeBaseId": { - "location": "uri", - "locationName": "knowledgeBaseId" - }, "clientToken": { "idempotencyToken": true }, - "name": {}, - "description": {}, "dataSourceConfiguration": { "shape": "S1u" }, + "description": {}, + "knowledgeBaseId": { + "location": "uri", + "locationName": "knowledgeBaseId" + }, + "name": {}, "serverSideEncryptionConfiguration": { "shape": "S20" }, @@ -250,26 +250,26 @@ "input": { "type": "structure", "required": [ + "knowledgeBaseConfiguration", "name", "roleArn", - "knowledgeBaseConfiguration", "storageConfiguration" ], "members": { "clientToken": { "idempotencyToken": true }, - "name": {}, "description": {}, - "roleArn": {}, "knowledgeBaseConfiguration": { - "shape": "S2c" + "shape": "S2b" }, + "name": {}, + "roleArn": {}, "storageConfiguration": { "shape": "S2g" }, "tags": { - "shape": "Si" + "shape": "Sx" } } }, @@ -331,11 +331,15 @@ "input": { "type": "structure", "required": [ + "actionGroupId", "agentId", - "agentVersion", - "actionGroupId" + "agentVersion" ], "members": { + "actionGroupId": { + "location": "uri", + "locationName": "actionGroupId" + }, "agentId": { "location": "uri", "locationName": "agentId" @@ -344,10 +348,6 @@ "location": "uri", "locationName": "agentVersion" }, - "actionGroupId": { - "location": "uri", - "locationName": "actionGroupId" - }, "skipResourceInUseCheck": { "location": "querystring", "locationName": "skipResourceInUseCheck", @@ -370,31 +370,31 @@ "input": { "type": "structure", "required": [ - "agentId", - "agentAliasId" + "agentAliasId", + "agentId" ], "members": { - "agentId": { - "location": "uri", - "locationName": "agentId" - }, "agentAliasId": { "location": "uri", "locationName": "agentAliasId" + }, + "agentId": { + "location": "uri", + "locationName": "agentId" } } }, "output": { "type": "structure", "required": [ - "agentId", "agentAliasId", - "agentAliasStatus" + "agentAliasStatus", + "agentId" ], "members": { - "agentId": {}, "agentAliasId": {}, - "agentAliasStatus": {} + "agentAliasStatus": {}, + "agentId": {} } }, "idempotent": true @@ -431,13 +431,13 @@ "type": "structure", "required": [ "agentId", - "agentVersion", - "agentStatus" + "agentStatus", + "agentVersion" ], "members": { "agentId": {}, - "agentVersion": {}, - "agentStatus": {} + "agentStatus": {}, + "agentVersion": {} } }, "idempotent": true @@ -451,30 +451,30 @@ "input": { "type": "structure", "required": [ - "knowledgeBaseId", - "dataSourceId" + "dataSourceId", + "knowledgeBaseId" ], "members": { - "knowledgeBaseId": { - "location": "uri", - "locationName": "knowledgeBaseId" - }, "dataSourceId": { "location": "uri", "locationName": "dataSourceId" + }, + "knowledgeBaseId": { + "location": "uri", + "locationName": "knowledgeBaseId" } } }, "output": { "type": "structure", "required": [ - "knowledgeBaseId", "dataSourceId", + "knowledgeBaseId", "status" ], "members": { - "knowledgeBaseId": {}, "dataSourceId": {}, + "knowledgeBaseId": {}, "status": {} } }, @@ -584,11 +584,15 @@ "input": { "type": "structure", "required": [ + "actionGroupId", "agentId", - "agentVersion", - "actionGroupId" + "agentVersion" ], "members": { + "actionGroupId": { + "location": "uri", + "locationName": "actionGroupId" + }, "agentId": { "location": "uri", "locationName": "agentId" @@ -596,10 +600,6 @@ "agentVersion": { "location": "uri", "locationName": "agentVersion" - }, - "actionGroupId": { - "location": "uri", - "locationName": "actionGroupId" } } }, @@ -624,17 +624,17 @@ "input": { "type": "structure", "required": [ - "agentId", - "agentAliasId" + "agentAliasId", + "agentId" ], "members": { - "agentId": { - "location": "uri", - "locationName": "agentId" - }, "agentAliasId": { "location": "uri", "locationName": "agentAliasId" + }, + "agentId": { + "location": "uri", + "locationName": "agentId" } } }, @@ -722,47 +722,47 @@ "agentVersion": { "type": "structure", "required": [ + "agentArn", "agentId", "agentName", - "agentArn", - "version", - "agentStatus", - "idleSessionTTLInSeconds", "agentResourceRoleArn", + "agentStatus", "createdAt", - "updatedAt" + "idleSessionTTLInSeconds", + "updatedAt", + "version" ], "members": { + "agentArn": {}, "agentId": {}, "agentName": {}, - "agentArn": {}, - "version": {}, - "instruction": { - "shape": "Sd" - }, - "agentStatus": {}, - "foundationModel": {}, - "description": {}, - "idleSessionTTLInSeconds": { - "type": "integer" - }, "agentResourceRoleArn": {}, - "customerEncryptionKeyArn": {}, + "agentStatus": {}, "createdAt": { "shape": "S9" }, - "updatedAt": { - "shape": "S9" - }, + "customerEncryptionKeyArn": {}, + "description": {}, "failureReasons": { "shape": "S14" }, + "foundationModel": {}, + "idleSessionTTLInSeconds": { + "type": "integer" + }, + "instruction": { + "shape": "Sh" + }, + "promptOverrideConfiguration": { + "shape": "Si" + }, "recommendedActions": { "shape": "S16" }, - "promptOverrideConfiguration": { - "shape": "Sl" - } + "updatedAt": { + "shape": "S9" + }, + "version": {} } } } @@ -777,17 +777,17 @@ "input": { "type": "structure", "required": [ - "knowledgeBaseId", - "dataSourceId" + "dataSourceId", + "knowledgeBaseId" ], "members": { - "knowledgeBaseId": { - "location": "uri", - "locationName": "knowledgeBaseId" - }, "dataSourceId": { "location": "uri", "locationName": "dataSourceId" + }, + "knowledgeBaseId": { + "location": "uri", + "locationName": "knowledgeBaseId" } } }, @@ -812,15 +812,11 @@ "input": { "type": "structure", "required": [ - "knowledgeBaseId", "dataSourceId", - "ingestionJobId" + "ingestionJobId", + "knowledgeBaseId" ], "members": { - "knowledgeBaseId": { - "location": "uri", - "locationName": "knowledgeBaseId" - }, "dataSourceId": { "location": "uri", "locationName": "dataSourceId" @@ -828,6 +824,10 @@ "ingestionJobId": { "location": "uri", "locationName": "ingestionJobId" + }, + "knowledgeBaseId": { + "location": "uri", + "locationName": "knowledgeBaseId" } } }, @@ -971,14 +971,14 @@ "members": { "agentAliasId": {}, "agentAliasName": {}, - "description": {}, - "routingConfiguration": { - "shape": "S1k" - }, "agentAliasStatus": {}, "createdAt": { "shape": "S9" }, + "description": {}, + "routingConfiguration": { + "shape": "S1k" + }, "updatedAt": { "shape": "S9" } @@ -1031,8 +1031,8 @@ "updatedAt" ], "members": { - "knowledgeBaseId": {}, "description": {}, + "knowledgeBaseId": {}, "knowledgeBaseState": {}, "updatedAt": { "shape": "S9" @@ -1089,10 +1089,10 @@ "createdAt": { "shape": "S9" }, + "description": {}, "updatedAt": { "shape": "S9" - }, - "description": {} + } } } }, @@ -1135,10 +1135,10 @@ "agentName": {}, "agentStatus": {}, "description": {}, + "latestAgentVersion": {}, "updatedAt": { "shape": "S9" - }, - "latestAgentVersion": {} + } } } }, @@ -1178,18 +1178,18 @@ "member": { "type": "structure", "required": [ - "knowledgeBaseId", "dataSourceId", + "knowledgeBaseId", "name", "status", "updatedAt" ], "members": { - "knowledgeBaseId": {}, "dataSourceId": {}, + "description": {}, + "knowledgeBaseId": {}, "name": {}, "status": {}, - "description": {}, "updatedAt": { "shape": "S9" } @@ -1208,14 +1208,10 @@ "input": { "type": "structure", "required": [ - "knowledgeBaseId", - "dataSourceId" + "dataSourceId", + "knowledgeBaseId" ], "members": { - "knowledgeBaseId": { - "location": "uri", - "locationName": "knowledgeBaseId" - }, "dataSourceId": { "location": "uri", "locationName": "dataSourceId" @@ -1239,6 +1235,14 @@ } } }, + "knowledgeBaseId": { + "location": "uri", + "locationName": "knowledgeBaseId" + }, + "maxResults": { + "type": "integer" + }, + "nextToken": {}, "sortBy": { "type": "structure", "required": [ @@ -1249,11 +1253,7 @@ "attribute": {}, "order": {} } - }, - "maxResults": { - "type": "integer" - }, - "nextToken": {} + } } }, "output": { @@ -1267,27 +1267,27 @@ "member": { "type": "structure", "required": [ - "knowledgeBaseId", "dataSourceId", "ingestionJobId", - "status", + "knowledgeBaseId", "startedAt", + "status", "updatedAt" ], "members": { - "knowledgeBaseId": {}, "dataSourceId": {}, - "ingestionJobId": {}, "description": {}, - "status": {}, + "ingestionJobId": {}, + "knowledgeBaseId": {}, "startedAt": { "shape": "S9" }, + "statistics": { + "shape": "S42" + }, + "status": {}, "updatedAt": { "shape": "S9" - }, - "statistics": { - "shape": "S43" } } } @@ -1327,9 +1327,9 @@ "updatedAt" ], "members": { + "description": {}, "knowledgeBaseId": {}, "name": {}, - "description": {}, "status": {}, "updatedAt": { "shape": "S9" @@ -1363,7 +1363,7 @@ "type": "structure", "members": { "tags": { - "shape": "Si" + "shape": "Sx" } } } @@ -1412,24 +1412,24 @@ "input": { "type": "structure", "required": [ - "knowledgeBaseId", - "dataSourceId" + "dataSourceId", + "knowledgeBaseId" ], "members": { - "knowledgeBaseId": { - "location": "uri", - "locationName": "knowledgeBaseId" + "clientToken": { + "idempotencyToken": true }, "dataSourceId": { "location": "uri", "locationName": "dataSourceId" }, - "clientToken": { - "idempotencyToken": true - }, - "description": {} - } - }, + "description": {}, + "knowledgeBaseId": { + "location": "uri", + "locationName": "knowledgeBaseId" + } + } + }, "output": { "type": "structure", "required": [ @@ -1460,7 +1460,7 @@ "locationName": "resourceArn" }, "tags": { - "shape": "Si" + "shape": "Sx" } } }, @@ -1511,7 +1511,8 @@ "required": [ "agentId", "agentName", - "agentResourceRoleArn" + "agentResourceRoleArn", + "foundationModel" ], "members": { "agentId": { @@ -1519,18 +1520,18 @@ "locationName": "agentId" }, "agentName": {}, - "instruction": { - "shape": "Sd" - }, - "foundationModel": {}, + "agentResourceRoleArn": {}, + "customerEncryptionKeyArn": {}, "description": {}, + "foundationModel": {}, "idleSessionTTLInSeconds": { "type": "integer" }, - "agentResourceRoleArn": {}, - "customerEncryptionKeyArn": {}, + "instruction": { + "shape": "Sh" + }, "promptOverrideConfiguration": { - "shape": "Sl" + "shape": "Si" } } }, @@ -1556,12 +1557,21 @@ "input": { "type": "structure", "required": [ - "agentId", - "agentVersion", "actionGroupId", - "actionGroupName" + "actionGroupName", + "agentId", + "agentVersion" ], "members": { + "actionGroupExecutor": { + "shape": "S19" + }, + "actionGroupId": { + "location": "uri", + "locationName": "actionGroupId" + }, + "actionGroupName": {}, + "actionGroupState": {}, "agentId": { "location": "uri", "locationName": "agentId" @@ -1570,20 +1580,11 @@ "location": "uri", "locationName": "agentVersion" }, - "actionGroupId": { - "location": "uri", - "locationName": "actionGroupId" - }, - "actionGroupName": {}, - "description": {}, - "parentActionGroupSignature": {}, - "actionGroupExecutor": { - "shape": "S1a" - }, - "actionGroupState": {}, "apiSchema": { "shape": "S1b" - } + }, + "description": {}, + "parentActionGroupSignature": {} } }, "output": { @@ -1608,20 +1609,20 @@ "input": { "type": "structure", "required": [ - "agentId", "agentAliasId", - "agentAliasName" + "agentAliasName", + "agentId" ], "members": { - "agentId": { - "location": "uri", - "locationName": "agentId" - }, "agentAliasId": { "location": "uri", "locationName": "agentAliasId" }, "agentAliasName": {}, + "agentId": { + "location": "uri", + "locationName": "agentId" + }, "description": {}, "routingConfiguration": { "shape": "S1k" @@ -1663,11 +1664,11 @@ "location": "uri", "locationName": "agentVersion" }, + "description": {}, "knowledgeBaseId": { "location": "uri", "locationName": "knowledgeBaseId" }, - "description": {}, "knowledgeBaseState": {} } }, @@ -1693,25 +1694,25 @@ "input": { "type": "structure", "required": [ - "knowledgeBaseId", + "dataSourceConfiguration", "dataSourceId", - "name", - "dataSourceConfiguration" + "knowledgeBaseId", + "name" ], "members": { - "knowledgeBaseId": { - "location": "uri", - "locationName": "knowledgeBaseId" + "dataSourceConfiguration": { + "shape": "S1u" }, "dataSourceId": { "location": "uri", "locationName": "dataSourceId" }, - "name": {}, "description": {}, - "dataSourceConfiguration": { - "shape": "S1u" + "knowledgeBaseId": { + "location": "uri", + "locationName": "knowledgeBaseId" }, + "name": {}, "serverSideEncryptionConfiguration": { "shape": "S20" }, @@ -1742,23 +1743,23 @@ "input": { "type": "structure", "required": [ + "knowledgeBaseConfiguration", "knowledgeBaseId", "name", "roleArn", - "knowledgeBaseConfiguration", "storageConfiguration" ], "members": { + "description": {}, + "knowledgeBaseConfiguration": { + "shape": "S2b" + }, "knowledgeBaseId": { "location": "uri", "locationName": "knowledgeBaseId" }, "name": {}, - "description": {}, "roleArn": {}, - "knowledgeBaseConfiguration": { - "shape": "S2c" - }, "storageConfiguration": { "shape": "S2g" } @@ -1784,130 +1785,130 @@ "required": [ "agentId", "agentVersion", - "knowledgeBaseId", - "description", "createdAt", - "updatedAt", - "knowledgeBaseState" + "description", + "knowledgeBaseId", + "knowledgeBaseState", + "updatedAt" ], "members": { "agentId": {}, "agentVersion": {}, - "knowledgeBaseId": {}, - "description": {}, "createdAt": { "shape": "S9" }, + "description": {}, + "knowledgeBaseId": {}, + "knowledgeBaseState": {}, "updatedAt": { "shape": "S9" - }, - "knowledgeBaseState": {} + } } }, "S9": { "type": "timestamp", "timestampFormat": "iso8601" }, - "Sd": { + "Sh": { "type": "string", "sensitive": true }, "Si": { - "type": "map", - "key": {}, - "value": {} - }, - "Sl": { "type": "structure", "required": [ "promptConfigurations" ], "members": { + "overrideLambda": {}, "promptConfigurations": { "type": "list", "member": { "type": "structure", "members": { - "promptType": {}, - "promptCreationMode": {}, - "promptState": {}, "basePromptTemplate": {}, "inferenceConfiguration": { "type": "structure", "members": { - "temperature": { - "type": "float" - }, - "topP": { - "type": "float" - }, - "topK": { - "type": "integer" - }, "maximumLength": { "type": "integer" }, "stopSequences": { "type": "list", "member": {} + }, + "temperature": { + "type": "float" + }, + "topK": { + "type": "integer" + }, + "topP": { + "type": "float" } } }, - "parserMode": {} + "parserMode": {}, + "promptCreationMode": {}, + "promptState": {}, + "promptType": {} } } - }, - "overrideLambda": {} + } }, "sensitive": true }, + "Sx": { + "type": "map", + "key": {}, + "value": {} + }, "S11": { "type": "structure", "required": [ + "agentArn", "agentId", "agentName", - "agentArn", - "agentVersion", - "agentStatus", - "idleSessionTTLInSeconds", "agentResourceRoleArn", + "agentStatus", + "agentVersion", "createdAt", + "idleSessionTTLInSeconds", "updatedAt" ], "members": { + "agentArn": {}, "agentId": {}, "agentName": {}, - "agentArn": {}, + "agentResourceRoleArn": {}, + "agentStatus": {}, "agentVersion": {}, "clientToken": {}, - "instruction": { - "shape": "Sd" + "createdAt": { + "shape": "S9" }, - "agentStatus": {}, - "foundationModel": {}, + "customerEncryptionKeyArn": {}, "description": {}, + "failureReasons": { + "shape": "S14" + }, + "foundationModel": {}, "idleSessionTTLInSeconds": { "type": "integer" }, - "agentResourceRoleArn": {}, - "customerEncryptionKeyArn": {}, - "createdAt": { - "shape": "S9" - }, - "updatedAt": { - "shape": "S9" + "instruction": { + "shape": "Sh" }, "preparedAt": { "shape": "S9" }, - "failureReasons": { - "shape": "S14" + "promptOverrideConfiguration": { + "shape": "Si" }, "recommendedActions": { "shape": "S16" }, - "promptOverrideConfiguration": { - "shape": "Sl" + "updatedAt": { + "shape": "S9" } } }, @@ -1919,7 +1920,7 @@ "type": "list", "member": {} }, - "S1a": { + "S19": { "type": "structure", "members": { "lambda": {} @@ -1929,16 +1930,16 @@ "S1b": { "type": "structure", "members": { + "payload": { + "type": "string", + "sensitive": true + }, "s3": { "type": "structure", "members": { "s3BucketName": {}, "s3ObjectKey": {} } - }, - "payload": { - "type": "string", - "sensitive": true } }, "union": true @@ -1946,35 +1947,35 @@ "S1i": { "type": "structure", "required": [ - "agentId", - "agentVersion", "actionGroupId", "actionGroupName", + "actionGroupState", + "agentId", + "agentVersion", "createdAt", - "updatedAt", - "actionGroupState" + "updatedAt" ], "members": { - "agentId": {}, - "agentVersion": {}, + "actionGroupExecutor": { + "shape": "S19" + }, "actionGroupId": {}, "actionGroupName": {}, + "actionGroupState": {}, + "agentId": {}, + "agentVersion": {}, + "apiSchema": { + "shape": "S1b" + }, "clientToken": {}, - "description": {}, "createdAt": { "shape": "S9" }, + "description": {}, + "parentActionSignature": {}, "updatedAt": { "shape": "S9" - }, - "parentActionSignature": {}, - "actionGroupExecutor": { - "shape": "S1a" - }, - "apiSchema": { - "shape": "S1b" - }, - "actionGroupState": {} + } } }, "S1k": { @@ -1992,49 +1993,49 @@ "S1n": { "type": "structure", "required": [ - "agentId", + "agentAliasArn", "agentAliasId", "agentAliasName", - "agentAliasArn", - "routingConfiguration", + "agentAliasStatus", + "agentId", "createdAt", - "updatedAt", - "agentAliasStatus" + "routingConfiguration", + "updatedAt" ], "members": { - "agentId": {}, - "agentAliasId": {}, - "agentAliasName": {}, "agentAliasArn": {}, - "clientToken": {}, - "description": {}, - "routingConfiguration": { - "shape": "S1k" - }, - "createdAt": { - "shape": "S9" - }, - "updatedAt": { - "shape": "S9" - }, "agentAliasHistoryEvents": { "type": "list", "member": { "type": "structure", "members": { - "routingConfiguration": { - "shape": "S1k" - }, "endDate": { "shape": "S9" }, + "routingConfiguration": { + "shape": "S1k" + }, "startDate": { "shape": "S9" } } } }, - "agentAliasStatus": {} + "agentAliasId": {}, + "agentAliasName": {}, + "agentAliasStatus": {}, + "agentId": {}, + "clientToken": {}, + "createdAt": { + "shape": "S9" + }, + "description": {}, + "routingConfiguration": { + "shape": "S1k" + }, + "updatedAt": { + "shape": "S9" + } } }, "S1u": { @@ -2043,7 +2044,6 @@ "type" ], "members": { - "type": {}, "s3Configuration": { "type": "structure", "required": [ @@ -2056,7 +2056,8 @@ "member": {} } } - } + }, + "type": {} } }, "S20": { @@ -2097,38 +2098,38 @@ "S28": { "type": "structure", "required": [ - "knowledgeBaseId", + "createdAt", + "dataSourceConfiguration", "dataSourceId", + "knowledgeBaseId", "name", "status", - "dataSourceConfiguration", - "createdAt", "updatedAt" ], "members": { - "knowledgeBaseId": {}, - "dataSourceId": {}, - "name": {}, - "status": {}, - "description": {}, + "createdAt": { + "shape": "S9" + }, "dataSourceConfiguration": { "shape": "S1u" }, + "dataSourceId": {}, + "description": {}, + "knowledgeBaseId": {}, + "name": {}, "serverSideEncryptionConfiguration": { "shape": "S20" }, - "vectorIngestionConfiguration": { - "shape": "S21" - }, - "createdAt": { - "shape": "S9" - }, + "status": {}, "updatedAt": { "shape": "S9" + }, + "vectorIngestionConfiguration": { + "shape": "S21" } } }, - "S2c": { + "S2b": { "type": "structure", "required": [ "type" @@ -2152,30 +2153,29 @@ "type" ], "members": { - "type": {}, "opensearchServerlessConfiguration": { "type": "structure", "required": [ "collectionArn", - "vectorIndexName", - "fieldMapping" + "fieldMapping", + "vectorIndexName" ], "members": { "collectionArn": {}, - "vectorIndexName": {}, "fieldMapping": { "type": "structure", "required": [ - "vectorField", + "metadataField", "textField", - "metadataField" + "vectorField" ], "members": { - "vectorField": {}, + "metadataField": {}, "textField": {}, - "metadataField": {} + "vectorField": {} } - } + }, + "vectorIndexName": {} } }, "pineconeConfiguration": { @@ -2188,163 +2188,170 @@ "members": { "connectionString": {}, "credentialsSecretArn": {}, - "namespace": {}, "fieldMapping": { "type": "structure", "required": [ - "textField", - "metadataField" + "metadataField", + "textField" ], "members": { - "textField": {}, - "metadataField": {} + "metadataField": {}, + "textField": {} } - } + }, + "namespace": {} } }, - "redisEnterpriseCloudConfiguration": { + "rdsConfiguration": { "type": "structure", "required": [ - "endpoint", - "vectorIndexName", "credentialsSecretArn", - "fieldMapping" + "databaseName", + "fieldMapping", + "resourceArn", + "tableName" ], "members": { - "endpoint": {}, - "vectorIndexName": {}, "credentialsSecretArn": {}, + "databaseName": {}, "fieldMapping": { "type": "structure", "required": [ - "vectorField", + "metadataField", + "primaryKeyField", "textField", - "metadataField" + "vectorField" ], "members": { - "vectorField": {}, + "metadataField": {}, + "primaryKeyField": {}, "textField": {}, - "metadataField": {} + "vectorField": {} } - } + }, + "resourceArn": {}, + "tableName": {} } }, - "rdsConfiguration": { + "redisEnterpriseCloudConfiguration": { "type": "structure", "required": [ - "resourceArn", "credentialsSecretArn", - "databaseName", - "tableName", - "fieldMapping" + "endpoint", + "fieldMapping", + "vectorIndexName" ], "members": { - "resourceArn": {}, "credentialsSecretArn": {}, - "databaseName": {}, - "tableName": {}, + "endpoint": {}, "fieldMapping": { "type": "structure", "required": [ - "primaryKeyField", - "vectorField", + "metadataField", "textField", - "metadataField" + "vectorField" ], "members": { - "primaryKeyField": {}, - "vectorField": {}, + "metadataField": {}, "textField": {}, - "metadataField": {} + "vectorField": {} } - } + }, + "vectorIndexName": {} } - } + }, + "type": {} } }, "S33": { "type": "structure", "required": [ + "createdAt", + "knowledgeBaseArn", + "knowledgeBaseConfiguration", "knowledgeBaseId", "name", - "knowledgeBaseArn", "roleArn", - "knowledgeBaseConfiguration", - "storageConfiguration", "status", - "createdAt", + "storageConfiguration", "updatedAt" ], "members": { - "knowledgeBaseId": {}, - "name": {}, - "knowledgeBaseArn": {}, + "createdAt": { + "shape": "S9" + }, "description": {}, - "roleArn": {}, + "failureReasons": { + "shape": "S14" + }, + "knowledgeBaseArn": {}, "knowledgeBaseConfiguration": { - "shape": "S2c" + "shape": "S2b" }, + "knowledgeBaseId": {}, + "name": {}, + "roleArn": {}, + "status": {}, "storageConfiguration": { "shape": "S2g" }, - "status": {}, - "createdAt": { - "shape": "S9" - }, "updatedAt": { "shape": "S9" - }, - "failureReasons": { - "shape": "S14" } } }, "S41": { "type": "structure", "required": [ - "knowledgeBaseId", "dataSourceId", "ingestionJobId", - "status", + "knowledgeBaseId", "startedAt", + "status", "updatedAt" ], "members": { - "knowledgeBaseId": {}, "dataSourceId": {}, - "ingestionJobId": {}, "description": {}, - "status": {}, - "statistics": { - "shape": "S43" - }, "failureReasons": { "shape": "S14" }, + "ingestionJobId": {}, + "knowledgeBaseId": {}, "startedAt": { "shape": "S9" }, + "statistics": { + "shape": "S42" + }, + "status": {}, "updatedAt": { "shape": "S9" } } }, - "S43": { + "S42": { "type": "structure", "members": { + "numberOfDocumentsDeleted": { + "type": "long" + }, + "numberOfDocumentsFailed": { + "type": "long" + }, "numberOfDocumentsScanned": { "type": "long" }, - "numberOfNewDocumentsIndexed": { + "numberOfMetadataDocumentsModified": { "type": "long" }, - "numberOfModifiedDocumentsIndexed": { + "numberOfMetadataDocumentsScanned": { "type": "long" }, - "numberOfDocumentsDeleted": { + "numberOfModifiedDocumentsIndexed": { "type": "long" }, - "numberOfDocumentsFailed": { + "numberOfNewDocumentsIndexed": { "type": "long" } } diff --git a/apis/bedrock-agent-2023-06-05.normal.json b/apis/bedrock-agent-2023-06-05.normal.json index 7372dc88ae..4dd641cdf1 100644 --- a/apis/bedrock-agent-2023-06-05.normal.json +++ b/apis/bedrock-agent-2023-06-05.normal.json @@ -48,7 +48,7 @@ "shape": "ServiceQuotaExceededException" } ], - "documentation": "Associate a Knowledge Base to an existing Amazon Bedrock Agent
", + "documentation": "Associates a knowledge base with an agent. If a knowledge base is associated and its indexState
is set to Enabled
, the agent queries the knowledge base for information to augment its response to the user.
Creates an Amazon Bedrock Agent
", + "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.
Specify the following fields for security purposes.
agentResourceRoleArn
– The ARN of the role with permissions to create an agent.
(Optional) customerEncryptionKeyArn
– The ARN of a KMS key to encrypt the creation of the agent.
(Optional) idleSessionTTLinSeconds
– Specify the number of seconds for which the agent should maintain session information. After this time expires, the subsequent InvokeAgent
request begins a new session.
To override the default prompt behavior for agent orchestration and to use advanced prompts, include a promptOverrideConfiguration
object. For more information, see Advanced prompts.
If you agent fails to be created, the response returns a list of failureReasons
alongside a list of recommendedActions
for you to troubleshoot.
Creates an Action Group for existing Amazon Bedrock Agent
", + "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.
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.
Creates an Alias for an existing Amazon Bedrock Agent
", + "documentation": "Creates an alias of an agent that can be used to deploy the agent.
", "idempotent": true }, "CreateDataSource": { @@ -201,7 +201,7 @@ "shape": "ServiceQuotaExceededException" } ], - "documentation": "Create a new data source
", + "documentation": "Sets up a data source to be added to a knowledge base.
You can't change the chunkingConfiguration
after you create the data source.
Create a new knowledge base
", + "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.
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.
Provide the name
and an optional description
.
Provide the ARN with permissions to create a knowledge base in the roleArn
field.
Provide the embedding model to use in the embeddingModelArn
field in the knowledgeBaseConfiguration
object.
Provide the configuration for your vector store in the storageConfiguration
object.
For an Amazon OpenSearch Service database, use the opensearchServerlessConfiguration
object. For more information, see Create a vector store in Amazon OpenSearch Service.
For an Amazon Aurora database, use the RdsConfiguration
object. For more information, see Create a vector store in Amazon Aurora.
For a Pinecone database, use the pineconeConfiguration
object. For more information, see Create a vector store in Pinecone.
For a Redis Enterprise Cloud database, use the redisEnterpriseCloudConfiguration
object. For more information, see Create a vector store in Redis Enterprise Cloud.
Deletes an Agent for existing Amazon Bedrock Agent
", + "documentation": "Deletes an agent.
", "idempotent": true }, "DeleteAgentActionGroup": { @@ -309,7 +309,7 @@ "shape": "ConflictException" } ], - "documentation": "Deletes an Action Group for existing Amazon Bedrock Agent.
", + "documentation": "Deletes an action group in an agent.
", "idempotent": true }, "DeleteAgentAlias": { @@ -342,7 +342,7 @@ "shape": "ResourceNotFoundException" } ], - "documentation": "Deletes an Alias for a Amazon Bedrock Agent
", + "documentation": "Deletes an alias of an agent.
", "idempotent": true }, "DeleteAgentVersion": { @@ -378,7 +378,7 @@ "shape": "ConflictException" } ], - "documentation": "Deletes an Agent version for existing Amazon Bedrock Agent
", + "documentation": "Deletes a version of an agent.
", "idempotent": true }, "DeleteDataSource": { @@ -414,7 +414,7 @@ "shape": "ConflictException" } ], - "documentation": "Delete an existing data source
", + "documentation": "Deletes a data source from a knowledge base.
", "idempotent": true }, "DeleteKnowledgeBase": { @@ -450,7 +450,7 @@ "shape": "ConflictException" } ], - "documentation": "Delete an existing knowledge base
", + "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.
", "idempotent": true }, "DisassociateAgentKnowledgeBase": { @@ -486,7 +486,7 @@ "shape": "ConflictException" } ], - "documentation": "Disassociate an existing Knowledge Base from an Amazon Bedrock Agent
", + "documentation": "Disassociates a knowledge base from an agent.
", "idempotent": true }, "GetAgent": { @@ -519,7 +519,7 @@ "shape": "ResourceNotFoundException" } ], - "documentation": "Gets an Agent for existing Amazon Bedrock Agent
" + "documentation": "Gets information about an agent.
" }, "GetAgentActionGroup": { "name": "GetAgentActionGroup", @@ -551,7 +551,7 @@ "shape": "ResourceNotFoundException" } ], - "documentation": "Gets an Action Group for existing Amazon Bedrock Agent Version
" + "documentation": "Gets information about an action group for an agent.
" }, "GetAgentAlias": { "name": "GetAgentAlias", @@ -583,7 +583,7 @@ "shape": "ResourceNotFoundException" } ], - "documentation": "Describes an Alias for a Amazon Bedrock Agent
" + "documentation": "Gets information about an alias of an agent.
" }, "GetAgentKnowledgeBase": { "name": "GetAgentKnowledgeBase", @@ -615,7 +615,7 @@ "shape": "ResourceNotFoundException" } ], - "documentation": "Gets a knowledge base associated to an existing Amazon Bedrock Agent Version
" + "documentation": "Gets information about a knowledge base associated with an agent.
" }, "GetAgentVersion": { "name": "GetAgentVersion", @@ -647,7 +647,7 @@ "shape": "ResourceNotFoundException" } ], - "documentation": "Gets an Agent version for existing Amazon Bedrock Agent
" + "documentation": "Gets details about a version of an agent.
" }, "GetDataSource": { "name": "GetDataSource", @@ -679,7 +679,7 @@ "shape": "ResourceNotFoundException" } ], - "documentation": "Get an existing data source
" + "documentation": "Gets information about a data source.
" }, "GetIngestionJob": { "name": "GetIngestionJob", @@ -711,7 +711,7 @@ "shape": "ResourceNotFoundException" } ], - "documentation": "Get an ingestion job
" + "documentation": "Gets information about a ingestion job, in which a data source is added to a knowledge base.
" }, "GetKnowledgeBase": { "name": "GetKnowledgeBase", @@ -743,7 +743,7 @@ "shape": "ResourceNotFoundException" } ], - "documentation": "Get an existing knowledge base
" + "documentation": "Gets information about a knoweldge base.
" }, "ListAgentActionGroups": { "name": "ListAgentActionGroups", @@ -775,7 +775,7 @@ "shape": "ResourceNotFoundException" } ], - "documentation": "Lists an Action Group for existing Amazon Bedrock Agent Version
" + "documentation": "Lists the action groups for an agent and information about each one.
" }, "ListAgentAliases": { "name": "ListAgentAliases", @@ -807,7 +807,7 @@ "shape": "ResourceNotFoundException" } ], - "documentation": "Lists all the Aliases for an Amazon Bedrock Agent
" + "documentation": "Lists the aliases of an agent and information about each one.
" }, "ListAgentKnowledgeBases": { "name": "ListAgentKnowledgeBases", @@ -839,7 +839,7 @@ "shape": "ResourceNotFoundException" } ], - "documentation": "List of Knowledge Bases associated to an existing Amazon Bedrock Agent Version
" + "documentation": "Lists knowledge bases associated with an agent and information about each one.
" }, "ListAgentVersions": { "name": "ListAgentVersions", @@ -871,7 +871,7 @@ "shape": "ResourceNotFoundException" } ], - "documentation": "Lists Agent Versions
" + "documentation": "Lists the versions of an agent and information about each version.
" }, "ListAgents": { "name": "ListAgents", @@ -900,7 +900,7 @@ "shape": "InternalServerException" } ], - "documentation": "Lists Agents
" + "documentation": "Lists the agents belonging to an account and information about each agent.
" }, "ListDataSources": { "name": "ListDataSources", @@ -932,7 +932,7 @@ "shape": "ResourceNotFoundException" } ], - "documentation": "List data sources
" + "documentation": "Lists the data sources in a knowledge base and information about each one.
" }, "ListIngestionJobs": { "name": "ListIngestionJobs", @@ -964,7 +964,7 @@ "shape": "ResourceNotFoundException" } ], - "documentation": "List ingestion jobs
" + "documentation": "Lists the ingestion jobs for a data source and information about each of them.
" }, "ListKnowledgeBases": { "name": "ListKnowledgeBases", @@ -993,7 +993,7 @@ "shape": "InternalServerException" } ], - "documentation": "List Knowledge Bases
" + "documentation": "Lists the knowledge bases in an account and information about each of them.
" }, "ListTagsForResource": { "name": "ListTagsForResource", @@ -1025,7 +1025,7 @@ "shape": "ResourceNotFoundException" } ], - "documentation": "List tags for a resource
" + "documentation": "List all the tags for the resource you specify.
" }, "PrepareAgent": { "name": "PrepareAgent", @@ -1063,7 +1063,7 @@ "shape": "ServiceQuotaExceededException" } ], - "documentation": "Prepares an existing Amazon Bedrock Agent to receive runtime requests
" + "documentation": "Creates a DRAFT
version of the agent that can be used for internal testing.
Start a new ingestion job
", + "documentation": "Begins an ingestion job, in which a data source is added to a knowledge base.
", "idempotent": true }, "TagResource": { @@ -1137,7 +1137,7 @@ "shape": "ServiceQuotaExceededException" } ], - "documentation": "Tag a resource
" + "documentation": "Associate tags with a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.
" }, "UntagResource": { "name": "UntagResource", @@ -1169,7 +1169,7 @@ "shape": "ResourceNotFoundException" } ], - "documentation": "Untag a resource
", + "documentation": "Remove tags from a resource.
", "idempotent": true }, "UpdateAgent": { @@ -1208,7 +1208,7 @@ "shape": "ServiceQuotaExceededException" } ], - "documentation": "Updates an existing Amazon Bedrock Agent
", + "documentation": "Updates the configuration of an agent.
", "idempotent": true }, "UpdateAgentActionGroup": { @@ -1247,7 +1247,7 @@ "shape": "ServiceQuotaExceededException" } ], - "documentation": "Updates an existing Action Group for Amazon Bedrock Agent
", + "documentation": "Updates the configuration for an action group for an agent.
", "idempotent": true }, "UpdateAgentAlias": { @@ -1286,7 +1286,7 @@ "shape": "ServiceQuotaExceededException" } ], - "documentation": "Updates an existing Alias for an Amazon Bedrock Agent
", + "documentation": "Updates configurations for an alias of an agent.
", "idempotent": true }, "UpdateAgentKnowledgeBase": { @@ -1322,7 +1322,7 @@ "shape": "ConflictException" } ], - "documentation": "Updates an existing Knowledge Base associated to an Amazon Bedrock Agent
", + "documentation": "Updates the configuration for a knowledge base that has been associated with an agent.
", "idempotent": true }, "UpdateDataSource": { @@ -1358,7 +1358,7 @@ "shape": "ConflictException" } ], - "documentation": "Update an existing data source
", + "documentation": "Updates configurations for a data source.
You can't change the chunkingConfiguration
after you create the data source. Specify the existing chunkingConfiguration
.
Update an existing knowledge base
", + "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.
You can change the following fields:
name
description
roleArn
You can't change the knowledgeBaseConfiguration
or storageConfiguration
fields, so you must specify the same configurations as when you created the knowledge base. You can send a GetKnowledgeBase request and copy the same configurations.
The JSON or YAML-formatted payload defining the OpenAPI schema for the action group. For more information, see Action group OpenAPI schemas.
" + }, + "s3": { + "shape": "S3Identifier", + "documentation": "Contains details about the S3 object containing the OpenAPI schema for the action group. For more information, see Action group OpenAPI schemas.
" } }, - "documentation": "Contains information about the API Schema for the Action Group
", + "documentation": "Contains details about the OpenAPI schema for the action group. For more information, see Action group OpenAPI schemas. You can either include the schema directly in the payload
field or you can upload it to an S3 bucket and specify the S3 bucket location in the s3
field.
The ARN of the Lambda function containing the business logic that is carried out upon invoking the action.
" } }, - "documentation": "Type of Executors for an Action Group
", + "documentation": "Contains details about the Lambda function containing the business logic that is carried out upon invoking the action.
", "union": true }, "ActionGroupSignature": { "type": "string", - "documentation": "Action Group Signature for a BuiltIn Action
", "enum": [ "AMAZON.UserInput" ] }, "ActionGroupState": { "type": "string", - "documentation": "State of the action group
", "enum": [ "ENABLED", "DISABLED" @@ -1442,7 +1443,6 @@ "member": { "shape": "ActionGroupSummary" }, - "documentation": "List of ActionGroup Summaries
", "max": 10, "min": 0 }, @@ -1456,238 +1456,283 @@ ], "members": { "actionGroupId": { - "shape": "Id" + "shape": "Id", + "documentation": "The unique identifier of the action group.
" }, "actionGroupName": { - "shape": "Name" + "shape": "Name", + "documentation": "The name of the action group.
" }, "actionGroupState": { - "shape": "ActionGroupState" + "shape": "ActionGroupState", + "documentation": "Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
" }, "description": { - "shape": "Description" + "shape": "Description", + "documentation": "The description of the action group.
" }, "updatedAt": { - "shape": "DateTimestamp" + "shape": "DateTimestamp", + "documentation": "The time at which the action group was last updated.
" } }, - "documentation": "ActionGroup Summary
" + "documentation": "Contains details about an action group.
" }, "Agent": { "type": "structure", "required": [ + "agentArn", "agentId", "agentName", - "agentArn", - "agentVersion", - "agentStatus", - "idleSessionTTLInSeconds", "agentResourceRoleArn", + "agentStatus", + "agentVersion", "createdAt", + "idleSessionTTLInSeconds", "updatedAt" ], "members": { + "agentArn": { + "shape": "AgentArn", + "documentation": "The ARN of the agent.
" + }, "agentId": { - "shape": "Id" + "shape": "Id", + "documentation": "The unique identifier of the agent.
" }, "agentName": { - "shape": "Name" + "shape": "Name", + "documentation": "The name of the agent.
" }, - "agentArn": { - "shape": "AgentArn" + "agentResourceRoleArn": { + "shape": "AgentRoleArn", + "documentation": "The ARN of the IAM role with permissions to call API operations on the agent. The ARN must begin with AmazonBedrockExecutionRoleForAgents_
.
The status of the agent and whether it is ready for use. The following statuses are possible:
CREATING – The agent is being created.
PREPARING – The agent is being prepared.
PREPARED – The agent is prepared and ready to be invoked.
NOT_PREPARED – The agent has been created but not yet prepared.
FAILED – The agent API operation failed.
UPDATING – The agent is being updated.
DELETING – The agent is being deleted.
The version of the agent.
" }, "clientToken": { - "shape": "ClientToken" - }, - "instruction": { - "shape": "Instruction" + "shape": "ClientToken", + "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, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
" }, - "agentStatus": { - "shape": "AgentStatus" + "createdAt": { + "shape": "DateTimestamp", + "documentation": "The time at which the agent was created.
" }, - "foundationModel": { - "shape": "ModelIdentifier" + "customerEncryptionKeyArn": { + "shape": "KmsKeyArn", + "documentation": "The ARN of the KMS key that encrypts the agent.
" }, "description": { - "shape": "Description" + "shape": "Description", + "documentation": "The description of the agent.
" }, - "idleSessionTTLInSeconds": { - "shape": "SessionTTL" - }, - "agentResourceRoleArn": { - "shape": "AgentRoleArn" + "failureReasons": { + "shape": "FailureReasons", + "documentation": "Contains reasons that the agent-related API that you invoked failed.
" }, - "customerEncryptionKeyArn": { - "shape": "KmsKeyArn" + "foundationModel": { + "shape": "ModelIdentifier", + "documentation": "The foundation model used for orchestration by the agent.
" }, - "createdAt": { - "shape": "DateTimestamp" + "idleSessionTTLInSeconds": { + "shape": "SessionTTL", + "documentation": "The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.
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.
" }, - "updatedAt": { - "shape": "DateTimestamp" + "instruction": { + "shape": "Instruction", + "documentation": "Instructions that tell the agent what it should do and how it should interact with users.
" }, "preparedAt": { - "shape": "DateTimestamp" + "shape": "DateTimestamp", + "documentation": "The time at which the agent was last prepared.
" }, - "failureReasons": { - "shape": "FailureReasons" + "promptOverrideConfiguration": { + "shape": "PromptOverrideConfiguration", + "documentation": "Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts.
" }, "recommendedActions": { - "shape": "RecommendedActions" + "shape": "RecommendedActions", + "documentation": "Contains recommended actions to take for the agent-related API that you invoked to succeed.
" }, - "promptOverrideConfiguration": { - "shape": "PromptOverrideConfiguration" + "updatedAt": { + "shape": "DateTimestamp", + "documentation": "The time at which the agent was last updated.
" } }, - "documentation": "Contains the information of an agent
" + "documentation": "Contains details about an agent.
" }, "AgentActionGroup": { "type": "structure", "required": [ - "agentId", - "agentVersion", "actionGroupId", "actionGroupName", + "actionGroupState", + "agentId", + "agentVersion", "createdAt", - "updatedAt", - "actionGroupState" + "updatedAt" ], "members": { - "agentId": { - "shape": "Id" - }, - "agentVersion": { - "shape": "Version" + "actionGroupExecutor": { + "shape": "ActionGroupExecutor", + "documentation": "The ARN of the Lambda function containing the business logic that is carried out upon invoking the action.
" }, "actionGroupId": { - "shape": "Id" + "shape": "Id", + "documentation": "The unique identifier of the action group.
" }, "actionGroupName": { - "shape": "Name" + "shape": "Name", + "documentation": "The name of the action group.
" }, - "clientToken": { - "shape": "ClientToken" + "actionGroupState": { + "shape": "ActionGroupState", + "documentation": "Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
" }, - "description": { - "shape": "Description" + "agentId": { + "shape": "Id", + "documentation": "The unique identifier of the agent to which the action group belongs.
" }, - "createdAt": { - "shape": "DateTimestamp" + "agentVersion": { + "shape": "Version", + "documentation": "The version of the agent to which the action group belongs.
" }, - "updatedAt": { - "shape": "DateTimestamp" + "apiSchema": { + "shape": "APISchema", + "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.
" }, - "parentActionSignature": { - "shape": "ActionGroupSignature" + "clientToken": { + "shape": "ClientToken", + "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, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
" }, - "actionGroupExecutor": { - "shape": "ActionGroupExecutor" + "createdAt": { + "shape": "DateTimestamp", + "documentation": "The time at which the action group was created.
" }, - "apiSchema": { - "shape": "APISchema" + "description": { + "shape": "Description", + "documentation": "The description of the action group.
" }, - "actionGroupState": { - "shape": "ActionGroupState" + "parentActionSignature": { + "shape": "ActionGroupSignature", + "documentation": "If this field is set as AMAZON.UserInput
, the agent can request the user for additional information when trying to complete a task. The description
, apiSchema
, and actionGroupExecutor
fields must be blank for this action group.
During orchestration, if the agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.
" + }, + "updatedAt": { + "shape": "DateTimestamp", + "documentation": "The time at which the action group was last updated.
" } }, - "documentation": "Contains the information of an Agent Action Group
" + "documentation": "Contains details about an action group.
" }, "AgentAlias": { "type": "structure", "required": [ - "agentId", + "agentAliasArn", "agentAliasId", "agentAliasName", - "agentAliasArn", - "routingConfiguration", + "agentAliasStatus", + "agentId", "createdAt", - "updatedAt", - "agentAliasStatus" + "routingConfiguration", + "updatedAt" ], "members": { - "agentId": { - "shape": "Id" + "agentAliasArn": { + "shape": "AgentAliasArn", + "documentation": "The ARN of the alias of the agent.
" + }, + "agentAliasHistoryEvents": { + "shape": "AgentAliasHistoryEvents", + "documentation": "Contains details about the history of the alias.
" }, "agentAliasId": { - "shape": "AgentAliasId" + "shape": "AgentAliasId", + "documentation": "The unique identifier of the alias of the agent.
" }, "agentAliasName": { - "shape": "Name" + "shape": "Name", + "documentation": "The name of the alias of the agent.
" }, - "agentAliasArn": { - "shape": "AgentAliasArn" + "agentAliasStatus": { + "shape": "AgentAliasStatus", + "documentation": "The status of the alias of the agent and whether it is ready for use. The following statuses are possible:
CREATING – The agent alias is being created.
PREPARED – The agent alias is finished being created or updated and is ready to be invoked.
FAILED – The agent alias API operation failed.
UPDATING – The agent alias is being updated.
DELETING – The agent alias is being deleted.
The unique identifier of the agent.
" }, "clientToken": { - "shape": "ClientToken" + "shape": "ClientToken", + "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, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
" + }, + "createdAt": { + "shape": "DateTimestamp", + "documentation": "The time at which the alias of the agent was created.
" }, "description": { - "shape": "Description" + "shape": "Description", + "documentation": "The description of the alias of the agent.
" }, "routingConfiguration": { - "shape": "AgentAliasRoutingConfiguration" - }, - "createdAt": { - "shape": "DateTimestamp" + "shape": "AgentAliasRoutingConfiguration", + "documentation": "Contains details about the routing configuration of the alias.
" }, "updatedAt": { - "shape": "DateTimestamp" - }, - "agentAliasHistoryEvents": { - "shape": "AgentAliasHistoryEvents" - }, - "agentAliasStatus": { - "shape": "AgentAliasStatus" + "shape": "DateTimestamp", + "documentation": "The time at which the alias was last updated.
" } }, - "documentation": "Contains the information of an agent alias
" + "documentation": "Contains details about an alias of an agent.
" }, "AgentAliasArn": { "type": "string", - "documentation": "Arn representation of the Agent Alias.
", "max": 2048, "min": 0, - "pattern": "arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent-alias/[0-9a-zA-Z]{10}/[0-9a-zA-Z]{10}" + "pattern": "^arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent-alias/[0-9a-zA-Z]{10}/[0-9a-zA-Z]{10}$" }, "AgentAliasHistoryEvent": { "type": "structure", "members": { - "routingConfiguration": { - "shape": "AgentAliasRoutingConfiguration" - }, "endDate": { - "shape": "DateTimestamp" + "shape": "DateTimestamp", + "documentation": "The date that the alias stopped being associated to the version in the routingConfiguration
object
Contains details about the version of the agent with which the alias is associated.
" }, "startDate": { - "shape": "DateTimestamp" + "shape": "DateTimestamp", + "documentation": "The date that the alias began being associated to the version in the routingConfiguration
object.
History event for an alias for an Agent.
" + "documentation": "Contains details about the history of the alias.
" }, "AgentAliasHistoryEvents": { "type": "list", "member": { "shape": "AgentAliasHistoryEvent" }, - "documentation": "The list of history events for an alias for an Agent.
", "max": 10, "min": 0 }, "AgentAliasId": { "type": "string", - "documentation": "Id for an Agent Alias generated at the server side.
", "max": 10, "min": 10, - "pattern": "(\\bTSTALIASID\\b|[0-9a-zA-Z]+)" + "pattern": "^(\\bTSTALIASID\\b|[0-9a-zA-Z]+)$" }, "AgentAliasRoutingConfiguration": { "type": "list", "member": { "shape": "AgentAliasRoutingConfigurationListItem" }, - "documentation": "Routing configuration for an Agent alias.
", "max": 1, "min": 0 }, @@ -1698,14 +1743,14 @@ ], "members": { "agentVersion": { - "shape": "Version" + "shape": "Version", + "documentation": "The version of the agent with which the alias is associated.
" } }, - "documentation": "Details about the routing configuration for an Agent alias.
" + "documentation": "Contains details about the routing configuration of the alias.
" }, "AgentAliasStatus": { "type": "string", - "documentation": "The statuses an Agent Alias can be in.
", "enum": [ "CREATING", "PREPARED", @@ -1719,7 +1764,6 @@ "member": { "shape": "AgentAliasSummary" }, - "documentation": "The list of summaries of all the aliases for an Agent.
", "max": 10, "min": 0 }, @@ -1734,78 +1778,90 @@ ], "members": { "agentAliasId": { - "shape": "AgentAliasId" + "shape": "AgentAliasId", + "documentation": "Contains details about
" }, "agentAliasName": { - "shape": "Name" - }, - "description": { - "shape": "Description" - }, - "routingConfiguration": { - "shape": "AgentAliasRoutingConfiguration" + "shape": "Name", + "documentation": "The name of the alias.
" }, "agentAliasStatus": { - "shape": "AgentAliasStatus" + "shape": "AgentAliasStatus", + "documentation": "The status of the alias.
" }, "createdAt": { - "shape": "DateTimestamp" + "shape": "DateTimestamp", + "documentation": "The time at which the alias of the agent was created.
" + }, + "description": { + "shape": "Description", + "documentation": "The description of the alias.
" + }, + "routingConfiguration": { + "shape": "AgentAliasRoutingConfiguration", + "documentation": "Contains details about the version of the agent with which the alias is associated.
" }, "updatedAt": { - "shape": "DateTimestamp" + "shape": "DateTimestamp", + "documentation": "The time at which the alias was last updated.
" } }, - "documentation": "Summary of an alias for an Agent.
" + "documentation": "Contains details about an alias of an agent.
" }, "AgentArn": { "type": "string", - "documentation": "Arn representation of the Agent.
", "max": 2048, "min": 0, - "pattern": "arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent/[0-9a-zA-Z]{10}" + "pattern": "^arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent/[0-9a-zA-Z]{10}$" }, "AgentKnowledgeBase": { "type": "structure", "required": [ "agentId", "agentVersion", - "knowledgeBaseId", - "description", "createdAt", - "updatedAt", - "knowledgeBaseState" + "description", + "knowledgeBaseId", + "knowledgeBaseState", + "updatedAt" ], "members": { "agentId": { - "shape": "Id" + "shape": "Id", + "documentation": "The unique identifier of the agent with which the knowledge base is associated.
" }, "agentVersion": { - "shape": "Version" + "shape": "Version", + "documentation": "The version of the agent with which the knowledge base is associated.
" }, - "knowledgeBaseId": { - "shape": "Id" + "createdAt": { + "shape": "DateTimestamp", + "documentation": "The time at which the association between the agent and the knowledge base was created.
" }, "description": { - "shape": "Description" + "shape": "Description", + "documentation": "The description of the association between the agent and the knowledge base.
" }, - "createdAt": { - "shape": "DateTimestamp" - }, - "updatedAt": { - "shape": "DateTimestamp" + "knowledgeBaseId": { + "shape": "Id", + "documentation": "The unique identifier of the association between the agent and the knowledge base.
" }, "knowledgeBaseState": { - "shape": "KnowledgeBaseState" + "shape": "KnowledgeBaseState", + "documentation": "Specifies whether to use the knowledge base or not when sending an InvokeAgent request.
" + }, + "updatedAt": { + "shape": "DateTimestamp", + "documentation": "The time at which the association between the agent and the knowledge base was last updated.
" } }, - "documentation": "Contains the information of an Agent Knowledge Base.
" + "documentation": "Contains details about a knowledge base that is associated with an agent.
" }, "AgentKnowledgeBaseSummaries": { "type": "list", "member": { "shape": "AgentKnowledgeBaseSummary" }, - "documentation": "List of Agent Knowledge Base Summaries
", "max": 10, "min": 0 }, @@ -1817,31 +1873,33 @@ "updatedAt" ], "members": { - "knowledgeBaseId": { - "shape": "Id" - }, "description": { - "shape": "Description" + "shape": "Description", + "documentation": "The description of the knowledge base associated with an agent.
" + }, + "knowledgeBaseId": { + "shape": "Id", + "documentation": "The unique identifier of the knowledge base associated with an agent.
" }, "knowledgeBaseState": { - "shape": "KnowledgeBaseState" + "shape": "KnowledgeBaseState", + "documentation": "Specifies whether the agent uses the knowledge base or not when sending an InvokeAgent request.
" }, "updatedAt": { - "shape": "DateTimestamp" + "shape": "DateTimestamp", + "documentation": "The time at which the knowledge base associated with an agent was last updated.
" } }, - "documentation": "Agent Knowledge Base Summary
" + "documentation": "Contains details about a knowledge base associated with an agent.
" }, "AgentRoleArn": { "type": "string", - "documentation": "ARN of a IAM role.
", "max": 2048, "min": 0, - "pattern": "arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/(service-role/)?AmazonBedrockExecutionRoleForAgents.+" + "pattern": "^arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/(service-role/)?AmazonBedrockExecutionRoleForAgents_.+$" }, "AgentStatus": { "type": "string", - "documentation": "Schema Type for Action APIs.
", "enum": [ "CREATING", "PREPARING", @@ -1858,7 +1916,6 @@ "member": { "shape": "AgentSummary" }, - "documentation": "List of AgentSummary.
", "max": 10, "min": 0 }, @@ -1872,97 +1929,118 @@ ], "members": { "agentId": { - "shape": "Id" + "shape": "Id", + "documentation": "The unique identifier of the agent.
" }, "agentName": { - "shape": "Name" + "shape": "Name", + "documentation": "The name of the agent.
" }, "agentStatus": { - "shape": "AgentStatus" + "shape": "AgentStatus", + "documentation": "The status of the agent.
" }, "description": { - "shape": "Description" - }, - "updatedAt": { - "shape": "DateTimestamp" + "shape": "Description", + "documentation": "The description of the agent.
" }, "latestAgentVersion": { - "shape": "Version" + "shape": "Version", + "documentation": "The latest version of the agent.
" + }, + "updatedAt": { + "shape": "DateTimestamp", + "documentation": "The time at which the agent was last updated.
" } }, - "documentation": "Summary of Agent.
" + "documentation": "Contains details about an agent.
" }, "AgentVersion": { "type": "structure", "required": [ + "agentArn", "agentId", "agentName", - "agentArn", - "version", - "agentStatus", - "idleSessionTTLInSeconds", "agentResourceRoleArn", + "agentStatus", "createdAt", - "updatedAt" + "idleSessionTTLInSeconds", + "updatedAt", + "version" ], "members": { + "agentArn": { + "shape": "AgentArn", + "documentation": "The ARN of the agent that the version belongs to.
" + }, "agentId": { - "shape": "Id" + "shape": "Id", + "documentation": "The unique identifier of the agent that the version belongs to.
" }, "agentName": { - "shape": "Name" + "shape": "Name", + "documentation": "The name of the agent that the version belongs to.
" }, - "agentArn": { - "shape": "AgentArn" - }, - "version": { - "shape": "NumericalVersion" - }, - "instruction": { - "shape": "Instruction" + "agentResourceRoleArn": { + "shape": "AgentRoleArn", + "documentation": "The ARN of the IAM role with permissions to invoke API operations on the agent. The ARN must begin with AmazonBedrockExecutionRoleForAgents_
.
The status of the agent that the version belongs to.
" }, - "foundationModel": { - "shape": "ModelIdentifier" + "createdAt": { + "shape": "DateTimestamp", + "documentation": "The time at which the version was created.
" }, - "description": { - "shape": "Description" + "customerEncryptionKeyArn": { + "shape": "KmsKeyArn", + "documentation": "The ARN of the KMS key that encrypts the agent.
" }, - "idleSessionTTLInSeconds": { - "shape": "SessionTTL" + "description": { + "shape": "Description", + "documentation": "The description of the version.
" }, - "agentResourceRoleArn": { - "shape": "AgentRoleArn" + "failureReasons": { + "shape": "FailureReasons", + "documentation": "A list of reasons that the API operation on the version failed.
" }, - "customerEncryptionKeyArn": { - "shape": "KmsKeyArn" + "foundationModel": { + "shape": "ModelIdentifier", + "documentation": "The foundation model that the version invokes.
" }, - "createdAt": { - "shape": "DateTimestamp" + "idleSessionTTLInSeconds": { + "shape": "SessionTTL", + "documentation": "The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.
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.
" }, - "updatedAt": { - "shape": "DateTimestamp" + "instruction": { + "shape": "Instruction", + "documentation": "The instructions provided to the agent.
" }, - "failureReasons": { - "shape": "FailureReasons" + "promptOverrideConfiguration": { + "shape": "PromptOverrideConfiguration", + "documentation": "Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts.
" }, "recommendedActions": { - "shape": "RecommendedActions" + "shape": "RecommendedActions", + "documentation": "A list of recommended actions to take for the failed API operation on the version to succeed.
" }, - "promptOverrideConfiguration": { - "shape": "PromptOverrideConfiguration" + "updatedAt": { + "shape": "DateTimestamp", + "documentation": "The time at which the version was last updated.
" + }, + "version": { + "shape": "NumericalVersion", + "documentation": "The version number.
" } }, - "documentation": "Contains the information of an agent version.
" + "documentation": "Contains details about a version of an agent.
" }, "AgentVersionSummaries": { "type": "list", "member": { "shape": "AgentVersionSummary" }, - "documentation": "List of AgentVersionSummary.
", "max": 10, "min": 0 }, @@ -1977,58 +2055,66 @@ ], "members": { "agentName": { - "shape": "Name" + "shape": "Name", + "documentation": "The name of the agent to which the version belongs.
" }, "agentStatus": { - "shape": "AgentStatus" + "shape": "AgentStatus", + "documentation": "The status of the agent to which the version belongs.
" }, "agentVersion": { - "shape": "Version" + "shape": "Version", + "documentation": "The version of the agent.
" }, "createdAt": { - "shape": "DateTimestamp" - }, - "updatedAt": { - "shape": "DateTimestamp" + "shape": "DateTimestamp", + "documentation": "The time at which the version was created.
" }, "description": { - "shape": "Description" + "shape": "Description", + "documentation": "The description of the version of the agent.
" + }, + "updatedAt": { + "shape": "DateTimestamp", + "documentation": "The time at which the version was last updated.
" } }, - "documentation": "Summary of agent version.
" + "documentation": "Contains details about a version of an agent.
" }, "AssociateAgentKnowledgeBaseRequest": { "type": "structure", "required": [ "agentId", "agentVersion", - "knowledgeBaseId", - "description" + "description", + "knowledgeBaseId" ], "members": { "agentId": { "shape": "Id", - "documentation": "Id generated at the server side when an Agent is created
", + "documentation": "The unique identifier of the agent with which you want to associate the knowledge base.
", "location": "uri", "locationName": "agentId" }, "agentVersion": { "shape": "DraftVersion", - "documentation": "Draft Version of the Agent.
", + "documentation": "The version of the agent with which you want to associate the knowledge base.
", "location": "uri", "locationName": "agentVersion" }, - "knowledgeBaseId": { - "shape": "Id" - }, "description": { - "shape": "Description" + "shape": "Description", + "documentation": "A description of what the agent should use the knowledge base for.
" + }, + "knowledgeBaseId": { + "shape": "Id", + "documentation": "The unique identifier of the knowledge base to associate with the agent.
" }, "knowledgeBaseState": { - "shape": "KnowledgeBaseState" + "shape": "KnowledgeBaseState", + "documentation": "Specifies whether to use the knowledge base or not when sending an InvokeAgent request.
" } - }, - "documentation": "Associate Agent Knowledge Base Request
" + } }, "AssociateAgentKnowledgeBaseResponse": { "type": "structure", @@ -2037,23 +2123,21 @@ ], "members": { "agentKnowledgeBase": { - "shape": "AgentKnowledgeBase" + "shape": "AgentKnowledgeBase", + "documentation": "Contains details about the knowledge base that has been associated with the agent.
" } - }, - "documentation": "Associate Agent Knowledge Base Response
" + } }, "BasePromptTemplate": { "type": "string", - "documentation": "Base Prompt Template.
", "max": 100000, "min": 1 }, "BedrockEmbeddingModelArn": { "type": "string", - "documentation": "Arn of a Bedrock model.
", "max": 1011, "min": 20, - "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}))" + "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}))$" }, "Boolean": { "type": "boolean", @@ -2066,17 +2150,18 @@ ], "members": { "chunkingStrategy": { - "shape": "ChunkingStrategy" + "shape": "ChunkingStrategy", + "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.
FIXED_SIZE
– Amazon Bedrock splits your source data into chunks of the approximate size that you set in the fixedSizeChunkingConfiguration
.
NONE
– Amazon Bedrock treats each file as one chunk. If you choose this option, you may want to pre-process your documents by splitting them into separate files.
Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy
as NONE
, exclude this field.
Configures chunking strategy
" + "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.
" }, "ChunkingStrategy": { "type": "string", - "documentation": "The type of chunking strategy
", "enum": [ "FIXED_SIZE", "NONE" @@ -2084,62 +2169,66 @@ }, "ClientToken": { "type": "string", - "documentation": "Client specified token used for idempotency checks
", "max": 256, "min": 33, - "pattern": "[a-zA-Z0-9](-*[a-zA-Z0-9])*" + "pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$" }, "ColumnName": { "type": "string", - "documentation": "Name of the column
", "max": 63, "min": 0, - "pattern": "[a-zA-Z0-9_\\-]+" + "pattern": "^[a-zA-Z0-9_\\-]+$" }, "CreateAgentActionGroupRequest": { "type": "structure", "required": [ + "actionGroupName", "agentId", - "agentVersion", - "actionGroupName" + "agentVersion" ], "members": { + "actionGroupExecutor": { + "shape": "ActionGroupExecutor", + "documentation": "The ARN of the Lambda function containing the business logic that is carried out upon invoking the action.
" + }, + "actionGroupName": { + "shape": "Name", + "documentation": "The name to give the action group.
" + }, + "actionGroupState": { + "shape": "ActionGroupState", + "documentation": "Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
" + }, "agentId": { "shape": "Id", - "documentation": "Id generated at the server side when an Agent is created
", + "documentation": "The unique identifier of the agent for which to create the action group.
", "location": "uri", "locationName": "agentId" }, "agentVersion": { "shape": "DraftVersion", - "documentation": "Draft Version of the Agent.
", + "documentation": "The version of the agent for which to create the action group.
", "location": "uri", "locationName": "agentVersion" }, - "actionGroupName": { - "shape": "Name" + "apiSchema": { + "shape": "APISchema", + "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.
" }, "clientToken": { "shape": "ClientToken", + "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, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", "idempotencyToken": true }, "description": { - "shape": "Description" + "shape": "Description", + "documentation": "A description of the action group.
" }, "parentActionGroupSignature": { - "shape": "ActionGroupSignature" - }, - "actionGroupExecutor": { - "shape": "ActionGroupExecutor" - }, - "apiSchema": { - "shape": "APISchema" - }, - "actionGroupState": { - "shape": "ActionGroupState" + "shape": "ActionGroupSignature", + "documentation": "To allow your agent to request the user for additional information when trying to complete a task, set this field to AMAZON.UserInput
. You must leave the description
, apiSchema
, and actionGroupExecutor
fields blank for this action group.
During orchestration, if your agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.
" } - }, - "documentation": "Create Action Group Request
" + } }, "CreateAgentActionGroupResponse": { "type": "structure", @@ -2148,42 +2237,46 @@ ], "members": { "agentActionGroup": { - "shape": "AgentActionGroup" + "shape": "AgentActionGroup", + "documentation": "Contains details about the action group that was created.
" } - }, - "documentation": "Create Action Group Response
" + } }, "CreateAgentAliasRequest": { "type": "structure", "required": [ - "agentId", - "agentAliasName" + "agentAliasName", + "agentId" ], "members": { + "agentAliasName": { + "shape": "Name", + "documentation": "The name of the alias.
" + }, "agentId": { "shape": "Id", - "documentation": "Id generated at the server side when an Agent is created
", + "documentation": "The unique identifier of the agent.
", "location": "uri", "locationName": "agentId" }, - "agentAliasName": { - "shape": "Name" - }, "clientToken": { "shape": "ClientToken", + "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, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", "idempotencyToken": true }, "description": { - "shape": "Description" + "shape": "Description", + "documentation": "A description of the alias of the agent.
" }, "routingConfiguration": { - "shape": "AgentAliasRoutingConfiguration" + "shape": "AgentAliasRoutingConfiguration", + "documentation": "Contains details about the routing configuration of the alias.
" }, "tags": { - "shape": "TagsMap" + "shape": "TagsMap", + "documentation": "Any tags that you want to attach to the alias of the agent.
" } - }, - "documentation": "Create Agent Alias Request
" + } }, "CreateAgentAliasResponse": { "type": "structure", @@ -2192,10 +2285,10 @@ ], "members": { "agentAlias": { - "shape": "AgentAlias" + "shape": "AgentAlias", + "documentation": "Contains details about the alias that was created.
" } - }, - "documentation": "Create Agent Alias Response
" + } }, "CreateAgentRequest": { "type": "structure", @@ -2205,38 +2298,47 @@ ], "members": { "agentName": { - "shape": "Name" + "shape": "Name", + "documentation": "A name for the agent that you create.
" + }, + "agentResourceRoleArn": { + "shape": "AgentRoleArn", + "documentation": "The ARN of the IAM role with permissions to create the agent. The ARN must begin with AmazonBedrockExecutionRoleForAgents_
.
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", "idempotencyToken": true }, - "instruction": { - "shape": "Instruction" - }, - "foundationModel": { - "shape": "ModelIdentifier" + "customerEncryptionKeyArn": { + "shape": "KmsKeyArn", + "documentation": "The ARN of the KMS key with which to encrypt the agent.
" }, "description": { - "shape": "Description" + "shape": "Description", + "documentation": "A description of the agent.
" + }, + "foundationModel": { + "shape": "ModelIdentifier", + "documentation": "The foundation model to be used for orchestration by the agent you create.
" }, "idleSessionTTLInSeconds": { - "shape": "SessionTTL" + "shape": "SessionTTL", + "documentation": "The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.
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.
" }, - "agentResourceRoleArn": { - "shape": "AgentRoleArn" + "instruction": { + "shape": "Instruction", + "documentation": "Instructions that tell the agent what it should do and how it should interact with users.
" }, - "customerEncryptionKeyArn": { - "shape": "KmsKeyArn" + "promptOverrideConfiguration": { + "shape": "PromptOverrideConfiguration", + "documentation": "Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.
" }, "tags": { - "shape": "TagsMap" - }, - "promptOverrideConfiguration": { - "shape": "PromptOverrideConfiguration" + "shape": "TagsMap", + "documentation": "Any tags that you want to attach to the agent.
" } - }, - "documentation": "Create Agent Request
" + } }, "CreateAgentResponse": { "type": "structure", @@ -2245,42 +2347,49 @@ ], "members": { "agent": { - "shape": "Agent" + "shape": "Agent", + "documentation": "Contains details about the agent created.
" } - }, - "documentation": "Create Agent Response
" + } }, "CreateDataSourceRequest": { "type": "structure", "required": [ + "dataSourceConfiguration", "knowledgeBaseId", - "name", - "dataSourceConfiguration" + "name" ], "members": { - "knowledgeBaseId": { - "shape": "Id", - "location": "uri", - "locationName": "knowledgeBaseId" - }, "clientToken": { "shape": "ClientToken", + "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, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", "idempotencyToken": true }, - "name": { - "shape": "Name" + "dataSourceConfiguration": { + "shape": "DataSourceConfiguration", + "documentation": "Contains metadata about where the data source is stored.
" }, "description": { - "shape": "Description" + "shape": "Description", + "documentation": "A description of the data source.
" }, - "dataSourceConfiguration": { - "shape": "DataSourceConfiguration" + "knowledgeBaseId": { + "shape": "Id", + "documentation": "The unique identifier of the knowledge base to which to add the data source.
", + "location": "uri", + "locationName": "knowledgeBaseId" + }, + "name": { + "shape": "Name", + "documentation": "The name of the data source.
" }, "serverSideEncryptionConfiguration": { - "shape": "ServerSideEncryptionConfiguration" + "shape": "ServerSideEncryptionConfiguration", + "documentation": "Contains details about the server-side encryption for the data source.
" }, "vectorIngestionConfiguration": { - "shape": "VectorIngestionConfiguration" + "shape": "VectorIngestionConfiguration", + "documentation": "Contains details about how to ingest the documents in the data source.
" } } }, @@ -2291,40 +2400,48 @@ ], "members": { "dataSource": { - "shape": "DataSource" + "shape": "DataSource", + "documentation": "Contains details about the data source.
" } } }, "CreateKnowledgeBaseRequest": { "type": "structure", "required": [ + "knowledgeBaseConfiguration", "name", "roleArn", - "knowledgeBaseConfiguration", "storageConfiguration" ], "members": { "clientToken": { "shape": "ClientToken", + "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, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", "idempotencyToken": true }, - "name": { - "shape": "Name" - }, "description": { - "shape": "Description" - }, - "roleArn": { - "shape": "KnowledgeBaseRoleArn" + "shape": "Description", + "documentation": "A description of the knowledge base.
" }, "knowledgeBaseConfiguration": { - "shape": "KnowledgeBaseConfiguration" + "shape": "KnowledgeBaseConfiguration", + "documentation": "Contains details about the embeddings model used for the knowledge base.
" + }, + "name": { + "shape": "Name", + "documentation": "A name for the knowledge base.
" + }, + "roleArn": { + "shape": "KnowledgeBaseRoleArn", + "documentation": "The ARN of the IAM role with permissions to create the knowledge base.
" }, "storageConfiguration": { - "shape": "StorageConfiguration" + "shape": "StorageConfiguration", + "documentation": "Contains details about the configuration of the vector database used for the knowledge base.
" }, "tags": { - "shape": "TagsMap" + "shape": "TagsMap", + "documentation": "Specify the key-value pairs for the tags that you want to attach to your knowledge base in this object.
" } } }, @@ -2335,13 +2452,13 @@ ], "members": { "knowledgeBase": { - "shape": "KnowledgeBase" + "shape": "KnowledgeBase", + "documentation": "Contains details about the knowledge base.
" } } }, "CreationMode": { "type": "string", - "documentation": "Creation Mode for Prompt Configuration.
", "enum": [ "DEFAULT", "OVERRIDDEN" @@ -2350,47 +2467,57 @@ "DataSource": { "type": "structure", "required": [ - "knowledgeBaseId", + "createdAt", + "dataSourceConfiguration", "dataSourceId", + "knowledgeBaseId", "name", "status", - "dataSourceConfiguration", - "createdAt", "updatedAt" ], "members": { - "knowledgeBaseId": { - "shape": "Id" - }, - "dataSourceId": { - "shape": "Id" + "createdAt": { + "shape": "DateTimestamp", + "documentation": "The time at which the data source was created.
" }, - "name": { - "shape": "Name" + "dataSourceConfiguration": { + "shape": "DataSourceConfiguration", + "documentation": "Contains details about how the data source is stored.
" }, - "status": { - "shape": "DataSourceStatus" + "dataSourceId": { + "shape": "Id", + "documentation": "The unique identifier of the data source.
" }, "description": { - "shape": "Description" + "shape": "Description", + "documentation": "The description of the data source.
" }, - "dataSourceConfiguration": { - "shape": "DataSourceConfiguration" + "knowledgeBaseId": { + "shape": "Id", + "documentation": "The unique identifier of the knowledge base to which the data source belongs.
" }, - "serverSideEncryptionConfiguration": { - "shape": "ServerSideEncryptionConfiguration" + "name": { + "shape": "Name", + "documentation": "The name of the data source.
" }, - "vectorIngestionConfiguration": { - "shape": "VectorIngestionConfiguration" + "serverSideEncryptionConfiguration": { + "shape": "ServerSideEncryptionConfiguration", + "documentation": "Contains details about the configuration of the server-side encryption.
" }, - "createdAt": { - "shape": "DateTimestamp" + "status": { + "shape": "DataSourceStatus", + "documentation": "The status of the data source. The following statuses are possible:
Available – The data source has been created and is ready for ingestion into the knowledge base.
Deleting – The data source is being deleted.
The time at which the data source was last updated.
" + }, + "vectorIngestionConfiguration": { + "shape": "VectorIngestionConfiguration", + "documentation": "Contains details about how to ingest the documents in the data source.
" } }, - "documentation": "Contains the information of a data source.
" + "documentation": "Contains details about a data source.
" }, "DataSourceConfiguration": { "type": "structure", @@ -2398,18 +2525,19 @@ "type" ], "members": { - "type": { - "shape": "DataSourceType" - }, "s3Configuration": { - "shape": "S3DataSourceConfiguration" + "shape": "S3DataSourceConfiguration", + "documentation": "Contains details about the configuration of the S3 object containing the data source.
" + }, + "type": { + "shape": "DataSourceType", + "documentation": "The type of storage for the data source.
" } }, - "documentation": "Specifies a raw data source location to ingest.
" + "documentation": "Contains details about how a data source is stored.
" }, "DataSourceStatus": { "type": "string", - "documentation": "The status of a data source.
", "enum": [ "AVAILABLE", "DELETING" @@ -2419,133 +2547,135 @@ "type": "list", "member": { "shape": "DataSourceSummary" - }, - "documentation": "list of data source summaries
" + } }, "DataSourceSummary": { "type": "structure", "required": [ - "knowledgeBaseId", "dataSourceId", + "knowledgeBaseId", "name", "status", "updatedAt" ], "members": { - "knowledgeBaseId": { - "shape": "Id" - }, "dataSourceId": { - "shape": "Id" + "shape": "Id", + "documentation": "The unique identifier of the data source.
" + }, + "description": { + "shape": "Description", + "documentation": "The description of the data source.
" + }, + "knowledgeBaseId": { + "shape": "Id", + "documentation": "The unique identifier of the knowledge base to which the data source belongs.
" }, "name": { - "shape": "Name" + "shape": "Name", + "documentation": "The name of the data source.
" }, "status": { - "shape": "DataSourceStatus" - }, - "description": { - "shape": "Description" + "shape": "DataSourceStatus", + "documentation": "The status of the data source.
" }, "updatedAt": { - "shape": "DateTimestamp" + "shape": "DateTimestamp", + "documentation": "The time at which the data source was last updated.
" } }, - "documentation": "Summary information of a data source.
" + "documentation": "Contains details about a data source.
" }, "DataSourceType": { "type": "string", - "documentation": "The type of the data source location.
", "enum": [ "S3" ] }, "DateTimestamp": { "type": "timestamp", - "documentation": "Time Stamp.
", "timestampFormat": "iso8601" }, "DeleteAgentActionGroupRequest": { "type": "structure", "required": [ + "actionGroupId", "agentId", - "agentVersion", - "actionGroupId" + "agentVersion" ], "members": { + "actionGroupId": { + "shape": "Id", + "documentation": "The unique identifier of the action group to delete.
", + "location": "uri", + "locationName": "actionGroupId" + }, "agentId": { "shape": "Id", - "documentation": "Id generated at the server side when an Agent is created
", + "documentation": "The unique identifier of the agent that the action group belongs to.
", "location": "uri", "locationName": "agentId" }, "agentVersion": { "shape": "DraftVersion", - "documentation": "Draft Version of the Agent.
", + "documentation": "The version of the agent that the action group belongs to.
", "location": "uri", "locationName": "agentVersion" }, - "actionGroupId": { - "shape": "Id", - "documentation": "Id generated at the server side when an Agent ActionGroup is created
", - "location": "uri", - "locationName": "actionGroupId" - }, "skipResourceInUseCheck": { "shape": "Boolean", - "documentation": "Skips checking if resource is in use when set to true. Defaults to false
", + "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.
Delete Action Group Request
" + } }, "DeleteAgentActionGroupResponse": { "type": "structure", - "members": {}, - "documentation": "Delete Action Group Response
" + "members": {} }, "DeleteAgentAliasRequest": { "type": "structure", "required": [ - "agentId", - "agentAliasId" + "agentAliasId", + "agentId" ], "members": { - "agentId": { - "shape": "Id", - "documentation": "Id generated at the server side when an Agent is created
", - "location": "uri", - "locationName": "agentId" - }, "agentAliasId": { "shape": "AgentAliasId", - "documentation": "Id generated at the server side when an Agent Alias is created
", + "documentation": "The unique identifier of the alias to delete.
", "location": "uri", "locationName": "agentAliasId" + }, + "agentId": { + "shape": "Id", + "documentation": "The unique identifier of the agent that the alias belongs to.
", + "location": "uri", + "locationName": "agentId" } - }, - "documentation": "Delete Agent Alias Request
" + } }, "DeleteAgentAliasResponse": { "type": "structure", "required": [ - "agentId", "agentAliasId", - "agentAliasStatus" + "agentAliasStatus", + "agentId" ], "members": { - "agentId": { - "shape": "Id" - }, "agentAliasId": { - "shape": "AgentAliasId" + "shape": "AgentAliasId", + "documentation": "The unique identifier of the alias that was deleted.
" }, "agentAliasStatus": { - "shape": "AgentAliasStatus" + "shape": "AgentAliasStatus", + "documentation": "The status of the alias.
" + }, + "agentId": { + "shape": "Id", + "documentation": "The unique identifier of the agent that the alias belongs to.
" } - }, - "documentation": "Delete Agent Alias Response
" + } }, "DeleteAgentRequest": { "type": "structure", @@ -2555,18 +2685,17 @@ "members": { "agentId": { "shape": "Id", - "documentation": "Id generated at the server side when an Agent is created
", + "documentation": "The unique identifier of the agent to delete.
", "location": "uri", "locationName": "agentId" }, "skipResourceInUseCheck": { "shape": "Boolean", - "documentation": "Skips checking if resource is in use when set to true. Defaults to false
", + "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.
Delete Agent Request
" + } }, "DeleteAgentResponse": { "type": "structure", @@ -2576,13 +2705,14 @@ ], "members": { "agentId": { - "shape": "Id" + "shape": "Id", + "documentation": "The unique identifier of the agent that was deleted.
" }, "agentStatus": { - "shape": "AgentStatus" + "shape": "AgentStatus", + "documentation": "The status of the agent.
" } - }, - "documentation": "Delete Agent Response
" + } }, "DeleteAgentVersionRequest": { "type": "structure", @@ -2593,79 +2723,86 @@ "members": { "agentId": { "shape": "Id", - "documentation": "Id generated at the server side when an Agent is created
", + "documentation": "The unique identifier of the agent that the version belongs to.
", "location": "uri", "locationName": "agentId" }, "agentVersion": { "shape": "NumericalVersion", + "documentation": "The version of the agent to delete.
", "location": "uri", "locationName": "agentVersion" }, "skipResourceInUseCheck": { "shape": "Boolean", - "documentation": "Skips checking if resource is in use when set to true. Defaults to false
", + "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.
Delete Agent Version Request
" + } }, "DeleteAgentVersionResponse": { "type": "structure", "required": [ "agentId", - "agentVersion", - "agentStatus" + "agentStatus", + "agentVersion" ], "members": { "agentId": { - "shape": "Id" - }, - "agentVersion": { - "shape": "NumericalVersion" + "shape": "Id", + "documentation": "The unique identifier of the agent that the version belongs to.
" }, "agentStatus": { - "shape": "AgentStatus" + "shape": "AgentStatus", + "documentation": "The status of the agent version.
" + }, + "agentVersion": { + "shape": "NumericalVersion", + "documentation": "The version that was deleted.
" } - }, - "documentation": "Delete Agent Version Response
" + } }, "DeleteDataSourceRequest": { "type": "structure", "required": [ - "knowledgeBaseId", - "dataSourceId" + "dataSourceId", + "knowledgeBaseId" ], "members": { - "knowledgeBaseId": { + "dataSourceId": { "shape": "Id", + "documentation": "The unique identifier of the data source to delete.
", "location": "uri", - "locationName": "knowledgeBaseId" + "locationName": "dataSourceId" }, - "dataSourceId": { + "knowledgeBaseId": { "shape": "Id", + "documentation": "The unique identifier of the knowledge base from which to delete the data source.
", "location": "uri", - "locationName": "dataSourceId" + "locationName": "knowledgeBaseId" } } }, "DeleteDataSourceResponse": { "type": "structure", "required": [ - "knowledgeBaseId", "dataSourceId", + "knowledgeBaseId", "status" ], "members": { - "knowledgeBaseId": { - "shape": "Id" - }, "dataSourceId": { - "shape": "Id" + "shape": "Id", + "documentation": "The unique identifier of the data source that was deleted.
" + }, + "knowledgeBaseId": { + "shape": "Id", + "documentation": "The unique identifier of the knowledge base to which the data source that was deleted belonged.
" }, "status": { - "shape": "DataSourceStatus" + "shape": "DataSourceStatus", + "documentation": "The status of the data source.
" } } }, @@ -2677,6 +2814,7 @@ "members": { "knowledgeBaseId": { "shape": "Id", + "documentation": "The unique identifier of the knowledge base to delete.
", "location": "uri", "locationName": "knowledgeBaseId" } @@ -2690,16 +2828,17 @@ ], "members": { "knowledgeBaseId": { - "shape": "Id" + "shape": "Id", + "documentation": "The unique identifier of the knowledge base that was deleted.
" }, "status": { - "shape": "KnowledgeBaseStatus" + "shape": "KnowledgeBaseStatus", + "documentation": "The status of the knowledge base and whether it has been successfully deleted.
" } } }, "Description": { "type": "string", - "documentation": "Description of the Resource.
", "max": 200, "min": 1 }, @@ -2713,40 +2852,36 @@ "members": { "agentId": { "shape": "Id", - "documentation": "Id generated at the server side when an Agent is created
", + "documentation": "The unique identifier of the agent from which to disassociate the knowledge base.
", "location": "uri", "locationName": "agentId" }, "agentVersion": { "shape": "DraftVersion", - "documentation": "Draft Version of the Agent.
", + "documentation": "The version of the agent from which to disassociate the knowledge base.
", "location": "uri", "locationName": "agentVersion" }, "knowledgeBaseId": { "shape": "Id", - "documentation": "Id generated at the server side when a Knowledge Base is associated to an Agent
", + "documentation": "The unique identifier of the knowledge base to disassociate.
", "location": "uri", "locationName": "knowledgeBaseId" } - }, - "documentation": "Disassociate Agent Knowledge Base Request
" + } }, "DisassociateAgentKnowledgeBaseResponse": { "type": "structure", - "members": {}, - "documentation": "Disassociate Agent Knowledge Base Response
" + "members": {} }, "DraftVersion": { "type": "string", - "documentation": "Draft Agent Version.
", "max": 5, "min": 5, - "pattern": "DRAFT" + "pattern": "^DRAFT$" }, "FailureReason": { "type": "string", - "documentation": "Failure Reason for Error.
", "max": 2048, "min": 0 }, @@ -2755,16 +2890,14 @@ "member": { "shape": "FailureReason" }, - "documentation": "Failure Reasons for Error.
", "max": 2048, "min": 0 }, "FieldName": { "type": "string", - "documentation": "Name of the field
", "max": 2048, "min": 0, - "pattern": ".*" + "pattern": "^.*$" }, "FixedSizeChunkingConfiguration": { "type": "structure", @@ -2775,14 +2908,14 @@ "members": { "maxTokens": { "shape": "FixedSizeChunkingConfigurationMaxTokensInteger", - "documentation": "The maximum number of tokens per chunk.
" + "documentation": "The maximum number of tokens to include in a chunk.
" }, "overlapPercentage": { "shape": "FixedSizeChunkingConfigurationOverlapPercentageInteger", - "documentation": "The overlap percentage between adjacent chunks.
" + "documentation": "The percentage of overlap between adjacent chunks of a data source.
" } }, - "documentation": "Configures fixed size chunking strategy
" + "documentation": "Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy
as NONE
, exclude this field.
The unique identifier of the action group for which to get information.
", + "location": "uri", + "locationName": "actionGroupId" + }, "agentId": { "shape": "Id", - "documentation": "Id generated at the server side when an Agent is created
", + "documentation": "The unique identifier of the agent that the action group belongs to.
", "location": "uri", "locationName": "agentId" }, "agentVersion": { "shape": "Version", - "documentation": "Version number generated when a version is created
", + "documentation": "The version of the agent that the action group belongs to.
", "location": "uri", "locationName": "agentVersion" - }, - "actionGroupId": { - "shape": "Id", - "documentation": "Id generated at the server side when an Agent Action Group is created
", - "location": "uri", - "locationName": "actionGroupId" } - }, - "documentation": "Get Action Group Request
" + } }, "GetAgentActionGroupResponse": { "type": "structure", @@ -2831,32 +2963,31 @@ ], "members": { "agentActionGroup": { - "shape": "AgentActionGroup" + "shape": "AgentActionGroup", + "documentation": "Contains details about the action group.
" } - }, - "documentation": "Get Action Group Response
" + } }, "GetAgentAliasRequest": { "type": "structure", "required": [ - "agentId", - "agentAliasId" + "agentAliasId", + "agentId" ], "members": { - "agentId": { - "shape": "Id", - "documentation": "Id generated at the server side when an Agent is created
", - "location": "uri", - "locationName": "agentId" - }, "agentAliasId": { "shape": "AgentAliasId", - "documentation": "Id generated at the server side when an Agent Alias is created
", + "documentation": "The unique identifier of the alias for which to get information.
", "location": "uri", "locationName": "agentAliasId" + }, + "agentId": { + "shape": "Id", + "documentation": "The unique identifier of the agent to which the alias to get information belongs.
", + "location": "uri", + "locationName": "agentId" } - }, - "documentation": "Get Agent Alias Request
" + } }, "GetAgentAliasResponse": { "type": "structure", @@ -2865,10 +2996,10 @@ ], "members": { "agentAlias": { - "shape": "AgentAlias" + "shape": "AgentAlias", + "documentation": "Contains information about the alias.
" } - }, - "documentation": "Get Agent Alias Response
" + } }, "GetAgentKnowledgeBaseRequest": { "type": "structure", @@ -2880,24 +3011,23 @@ "members": { "agentId": { "shape": "Id", - "documentation": "Id generated at the server side when an Agent is created
", + "documentation": "The unique identifier of the agent with which the knowledge base is associated.
", "location": "uri", "locationName": "agentId" }, "agentVersion": { "shape": "Version", - "documentation": "Version number generated when a version is created
", + "documentation": "The version of the agent with which the knowledge base is associated.
", "location": "uri", "locationName": "agentVersion" }, "knowledgeBaseId": { "shape": "Id", - "documentation": "Id generated at the server side when a Knowledge Base is associated
", + "documentation": "The unique identifier of the knowledge base associated with the agent.
", "location": "uri", "locationName": "knowledgeBaseId" } - }, - "documentation": "Get Agent Knowledge Base Request
" + } }, "GetAgentKnowledgeBaseResponse": { "type": "structure", @@ -2906,10 +3036,10 @@ ], "members": { "agentKnowledgeBase": { - "shape": "AgentKnowledgeBase" + "shape": "AgentKnowledgeBase", + "documentation": "Contains details about a knowledge base attached to an agent.
" } - }, - "documentation": "Get Agent Knowledge Base Response
" + } }, "GetAgentRequest": { "type": "structure", @@ -2919,12 +3049,11 @@ "members": { "agentId": { "shape": "Id", - "documentation": "Id generated at the server side when an Agent is created
", + "documentation": "The unique identifier of the agent.
", "location": "uri", "locationName": "agentId" } - }, - "documentation": "Get Agent Request
" + } }, "GetAgentResponse": { "type": "structure", @@ -2933,10 +3062,10 @@ ], "members": { "agent": { - "shape": "Agent" + "shape": "Agent", + "documentation": "Contains details about the agent.
" } - }, - "documentation": "Get Agent Response
" + } }, "GetAgentVersionRequest": { "type": "structure", @@ -2947,17 +3076,17 @@ "members": { "agentId": { "shape": "Id", - "documentation": "Id generated at the server side when an Agent is created
", + "documentation": "The unique identifier of the agent.
", "location": "uri", "locationName": "agentId" }, "agentVersion": { "shape": "NumericalVersion", + "documentation": "The version of the agent.
", "location": "uri", "locationName": "agentVersion" } - }, - "documentation": "Get Agent Version Request
" + } }, "GetAgentVersionResponse": { "type": "structure", @@ -2966,27 +3095,29 @@ ], "members": { "agentVersion": { - "shape": "AgentVersion" + "shape": "AgentVersion", + "documentation": "Contains details about the version of the agent.
" } - }, - "documentation": "Get Agent Version Response
" + } }, "GetDataSourceRequest": { "type": "structure", "required": [ - "knowledgeBaseId", - "dataSourceId" + "dataSourceId", + "knowledgeBaseId" ], "members": { - "knowledgeBaseId": { + "dataSourceId": { "shape": "Id", + "documentation": "The unique identifier of the data source.
", "location": "uri", - "locationName": "knowledgeBaseId" + "locationName": "dataSourceId" }, - "dataSourceId": { + "knowledgeBaseId": { "shape": "Id", + "documentation": "The unique identifier of the knowledge base that the data source was added to.
", "location": "uri", - "locationName": "dataSourceId" + "locationName": "knowledgeBaseId" } } }, @@ -2997,32 +3128,36 @@ ], "members": { "dataSource": { - "shape": "DataSource" + "shape": "DataSource", + "documentation": "Contains details about the data source.
" } } }, "GetIngestionJobRequest": { "type": "structure", "required": [ - "knowledgeBaseId", "dataSourceId", - "ingestionJobId" + "ingestionJobId", + "knowledgeBaseId" ], "members": { - "knowledgeBaseId": { - "shape": "Id", - "location": "uri", - "locationName": "knowledgeBaseId" - }, "dataSourceId": { "shape": "Id", + "documentation": "The unique identifier of the data source in the ingestion job.
", "location": "uri", "locationName": "dataSourceId" }, "ingestionJobId": { "shape": "Id", + "documentation": "The unique identifier of the ingestion job.
", "location": "uri", "locationName": "ingestionJobId" + }, + "knowledgeBaseId": { + "shape": "Id", + "documentation": "The unique identifier of the knowledge base for which the ingestion job applies.
", + "location": "uri", + "locationName": "knowledgeBaseId" } } }, @@ -3033,7 +3168,8 @@ ], "members": { "ingestionJob": { - "shape": "IngestionJob" + "shape": "IngestionJob", + "documentation": "Contains details about the ingestion job.
" } } }, @@ -3045,6 +3181,7 @@ "members": { "knowledgeBaseId": { "shape": "Id", + "documentation": "The unique identifier of the knowledge base for which to get information.
", "location": "uri", "locationName": "knowledgeBaseId" } @@ -3057,76 +3194,90 @@ ], "members": { "knowledgeBase": { - "shape": "KnowledgeBase" + "shape": "KnowledgeBase", + "documentation": "Contains details about the knowledge base.
" } } }, "Id": { "type": "string", - "documentation": "Identifier for a resource.
", - "pattern": "[0-9a-zA-Z]{10}" + "pattern": "^[0-9a-zA-Z]{10}$" }, "InferenceConfiguration": { "type": "structure", "members": { - "temperature": { - "shape": "Temperature" + "maximumLength": { + "shape": "MaximumLength", + "documentation": "The maximum number of tokens to allow in the generated response.
" }, - "topP": { - "shape": "TopP" + "stopSequences": { + "shape": "StopSequences", + "documentation": "A list of stop sequences. A stop sequence is a sequence of characters that causes the model to stop generating the response.
" }, - "topK": { - "shape": "TopK" + "temperature": { + "shape": "Temperature", + "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.
" }, - "maximumLength": { - "shape": "MaximumLength" + "topK": { + "shape": "TopK", + "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.
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.
Configuration for inference in prompt configuration
" + "documentation": "Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the promptType
. For more information, see Inference parameters for foundation models.
The unique identifier of the ingested data source.
" }, "description": { - "shape": "Description" + "shape": "Description", + "documentation": "The description of the ingestion job.
" }, - "status": { - "shape": "IngestionJobStatus" + "failureReasons": { + "shape": "FailureReasons", + "documentation": "A list of reasons that the ingestion job failed.
" }, - "statistics": { - "shape": "IngestionJobStatistics" + "ingestionJobId": { + "shape": "Id", + "documentation": "The unique identifier of the ingestion job.
" }, - "failureReasons": { - "shape": "FailureReasons" + "knowledgeBaseId": { + "shape": "Id", + "documentation": "The unique identifier of the knowledge base to which the data source is being added.
" }, "startedAt": { - "shape": "DateTimestamp" + "shape": "DateTimestamp", + "documentation": "The time at which the ingestion job started.
" + }, + "statistics": { + "shape": "IngestionJobStatistics", + "documentation": "Contains statistics about the ingestion job.
" + }, + "status": { + "shape": "IngestionJobStatus", + "documentation": "The status of the ingestion job.
" }, "updatedAt": { - "shape": "DateTimestamp" + "shape": "DateTimestamp", + "documentation": "The time at which the ingestion job was last updated.
" } }, - "documentation": "Contains the information of an ingestion job.
" + "documentation": "Contains details about an ingestion job, which converts a data source to embeddings for a vector store in knowledge base.
This data type is used in the following API operations:
" }, "IngestionJobFilter": { "type": "structure", @@ -3137,44 +3288,43 @@ ], "members": { "attribute": { - "shape": "IngestionJobFilterAttribute" + "shape": "IngestionJobFilterAttribute", + "documentation": "The attribute by which to filter the results.
" }, "operator": { - "shape": "IngestionJobFilterOperator" + "shape": "IngestionJobFilterOperator", + "documentation": "The operation to carry out between the attribute and the values.
" }, "values": { - "shape": "IngestionJobFilterValues" + "shape": "IngestionJobFilterValues", + "documentation": "A list of values for the attribute.
" } }, - "documentation": "Filters the response returned by ListIngestionJobs operation.
" + "documentation": "Defines a filter by which to filter the results.
" }, "IngestionJobFilterAttribute": { "type": "string", - "documentation": "The name of the field to filter ingestion jobs.
", "enum": [ "STATUS" ] }, "IngestionJobFilterOperator": { "type": "string", - "documentation": "The operator used to filter ingestion jobs.
", "enum": [ "EQ" ] }, "IngestionJobFilterValue": { "type": "string", - "documentation": "The value used to filter ingestion jobs.
", "max": 100, "min": 0, - "pattern": ".*" + "pattern": "^.*$" }, "IngestionJobFilterValues": { "type": "list", "member": { "shape": "IngestionJobFilterValue" }, - "documentation": "The list of values used to filter ingestion jobs.
", "max": 10, "min": 0 }, @@ -3183,7 +3333,6 @@ "member": { "shape": "IngestionJobFilter" }, - "documentation": "List of IngestionJobFilters
", "max": 1, "min": 1 }, @@ -3195,17 +3344,18 @@ ], "members": { "attribute": { - "shape": "IngestionJobSortByAttribute" + "shape": "IngestionJobSortByAttribute", + "documentation": "The attribute by which to sort the results.
" }, "order": { - "shape": "SortOrder" + "shape": "SortOrder", + "documentation": "The order by which to sort the results.
" } }, - "documentation": "Sorts the response returned by ListIngestionJobs operation.
" + "documentation": "Parameters by which to sort the results.
" }, "IngestionJobSortByAttribute": { "type": "string", - "documentation": "The name of the field to sort ingestion jobs.
", "enum": [ "STATUS", "STARTED_AT" @@ -3214,32 +3364,39 @@ "IngestionJobStatistics": { "type": "structure", "members": { + "numberOfDocumentsDeleted": { + "shape": "PrimitiveLong", + "documentation": "The number of source documents that was deleted.
" + }, + "numberOfDocumentsFailed": { + "shape": "PrimitiveLong", + "documentation": "The number of source documents that failed to be ingested.
" + }, "numberOfDocumentsScanned": { "shape": "PrimitiveLong", - "documentation": "Number of scanned documents
" + "documentation": "The total number of source documents that were scanned. Includes new, updated, and unchanged documents.
" }, - "numberOfNewDocumentsIndexed": { + "numberOfMetadataDocumentsModified": { "shape": "PrimitiveLong", - "documentation": "Number of indexed documents
" + "documentation": "The number of metadata files that were updated or deleted.
" }, - "numberOfModifiedDocumentsIndexed": { + "numberOfMetadataDocumentsScanned": { "shape": "PrimitiveLong", - "documentation": "Number of modified documents indexed
" + "documentation": "The total number of metadata files that were scanned. Includes new, updated, and unchanged files.
" }, - "numberOfDocumentsDeleted": { + "numberOfModifiedDocumentsIndexed": { "shape": "PrimitiveLong", - "documentation": "Number of deleted documents
" + "documentation": "The number of modified source documents in the data source that were successfully indexed.
" }, - "numberOfDocumentsFailed": { + "numberOfNewDocumentsIndexed": { "shape": "PrimitiveLong", - "documentation": "Number of failed documents
" + "documentation": "The number of new source documents in the data source that were successfully indexed.
" } }, - "documentation": "The document level statistics of an ingestion job
" + "documentation": "Contains the statistics for the ingestion job.
" }, "IngestionJobStatus": { "type": "string", - "documentation": "The status of an ingestion job.
", "enum": [ "STARTING", "IN_PROGRESS", @@ -3251,117 +3408,132 @@ "type": "list", "member": { "shape": "IngestionJobSummary" - }, - "documentation": "List of IngestionJobSummaries
" + } }, "IngestionJobSummary": { "type": "structure", "required": [ - "knowledgeBaseId", "dataSourceId", "ingestionJobId", - "status", + "knowledgeBaseId", "startedAt", + "status", "updatedAt" ], "members": { - "knowledgeBaseId": { - "shape": "Id" - }, "dataSourceId": { - "shape": "Id" - }, - "ingestionJobId": { - "shape": "Id" + "shape": "Id", + "documentation": "The unique identifier of the data source in the ingestion job.
" }, "description": { - "shape": "Description" + "shape": "Description", + "documentation": "The description of the ingestion job.
" }, - "status": { - "shape": "IngestionJobStatus" + "ingestionJobId": { + "shape": "Id", + "documentation": "The unique identifier of the ingestion job.
" }, - "startedAt": { - "shape": "DateTimestamp" + "knowledgeBaseId": { + "shape": "Id", + "documentation": "The unique identifier of the knowledge base to which the data source is added.
" }, - "updatedAt": { - "shape": "DateTimestamp" + "startedAt": { + "shape": "DateTimestamp", + "documentation": "The time at which the ingestion job was started.
" }, "statistics": { - "shape": "IngestionJobStatistics" + "shape": "IngestionJobStatistics", + "documentation": "Contains statistics for the ingestion job.
" + }, + "status": { + "shape": "IngestionJobStatus", + "documentation": "The status of the ingestion job.
" + }, + "updatedAt": { + "shape": "DateTimestamp", + "documentation": "The time at which the ingestion job was last updated.
" } }, - "documentation": "Summary information of an ingestion job.
" + "documentation": "Contains details about an ingestion job.
" }, "Instruction": { "type": "string", - "documentation": "Instruction for the agent.
", "max": 1200, "min": 40, "sensitive": true }, "KmsKeyArn": { "type": "string", - "documentation": "A KMS key ARN
", "max": 2048, "min": 1, - "pattern": "arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}" + "pattern": "^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$" }, "KnowledgeBase": { "type": "structure", "required": [ + "createdAt", + "knowledgeBaseArn", + "knowledgeBaseConfiguration", "knowledgeBaseId", "name", - "knowledgeBaseArn", "roleArn", - "knowledgeBaseConfiguration", - "storageConfiguration", "status", - "createdAt", + "storageConfiguration", "updatedAt" ], "members": { - "knowledgeBaseId": { - "shape": "Id" + "createdAt": { + "shape": "DateTimestamp", + "documentation": "The time at which the knowledge base was created.
" }, - "name": { - "shape": "Name" + "description": { + "shape": "Description", + "documentation": "The description of the knowledge base.
" + }, + "failureReasons": { + "shape": "FailureReasons", + "documentation": "A list of reasons that the API operation on the knowledge base failed.
" }, "knowledgeBaseArn": { - "shape": "KnowledgeBaseArn" + "shape": "KnowledgeBaseArn", + "documentation": "The ARN of the knowledge base.
" }, - "description": { - "shape": "Description" + "knowledgeBaseConfiguration": { + "shape": "KnowledgeBaseConfiguration", + "documentation": "Contains details about the embeddings configuration of the knowledge base.
" }, - "roleArn": { - "shape": "KnowledgeBaseRoleArn" + "knowledgeBaseId": { + "shape": "Id", + "documentation": "The unique identifier of the knowledge base.
" }, - "knowledgeBaseConfiguration": { - "shape": "KnowledgeBaseConfiguration" + "name": { + "shape": "Name", + "documentation": "The name of the knowledge base.
" }, - "storageConfiguration": { - "shape": "StorageConfiguration" + "roleArn": { + "shape": "KnowledgeBaseRoleArn", + "documentation": "The ARN of the IAM role with permissions to invoke API operations on the knowledge base. The ARN must begin with AmazonBedrockExecutionRoleForKnowledgeBase_
.
The status of the knowledge base. The following statuses are possible:
CREATING – The knowledge base is being created.
ACTIVE – The knowledge base is ready to be queried.
DELETING – The knowledge base is being deleted.
UPDATING – The knowledge base is being updated.
FAILED – The knowledge base API operation failed.
Contains details about the storage configuration of the knowledge base.
" }, "updatedAt": { - "shape": "DateTimestamp" - }, - "failureReasons": { - "shape": "FailureReasons" + "shape": "DateTimestamp", + "documentation": "The time at which the knowledge base was last updated.
" } }, - "documentation": "Contains the information of a knowledge base.
" + "documentation": "Contains information about a knowledge base.
" }, "KnowledgeBaseArn": { "type": "string", - "documentation": "ARN of a KnowledgeBase
", "max": 128, "min": 0, - "pattern": "arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:knowledge-base/[0-9a-zA-Z]+" + "pattern": "^arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:knowledge-base/[0-9a-zA-Z]+$" }, "KnowledgeBaseConfiguration": { "type": "structure", @@ -3370,24 +3542,24 @@ ], "members": { "type": { - "shape": "KnowledgeBaseType" + "shape": "KnowledgeBaseType", + "documentation": "The type of data that the data source is converted into for the knowledge base.
" }, "vectorKnowledgeBaseConfiguration": { - "shape": "VectorKnowledgeBaseConfiguration" + "shape": "VectorKnowledgeBaseConfiguration", + "documentation": "Contains details about the embeddings model that'sused to convert the data source.
" } }, - "documentation": "Configures a bedrock knowledge base.
" + "documentation": "Contains details about the embeddings configuration of the knowledge base.
" }, "KnowledgeBaseRoleArn": { "type": "string", - "documentation": "ARN of a IAM role.
", "max": 2048, "min": 0, - "pattern": "arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/(service-role/)?AmazonBedrockExecutionRoleForKnowledgeBase.+" + "pattern": "^arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+$" }, "KnowledgeBaseState": { "type": "string", - "documentation": "State of the knowledge base; whether it is enabled or disabled
", "enum": [ "ENABLED", "DISABLED" @@ -3395,7 +3567,6 @@ }, "KnowledgeBaseStatus": { "type": "string", - "documentation": "The status of a knowledge base.
", "enum": [ "CREATING", "ACTIVE", @@ -3406,7 +3577,6 @@ }, "KnowledgeBaseStorageType": { "type": "string", - "documentation": "The storage type of a knowledge base.
", "enum": [ "OPENSEARCH_SERVERLESS", "PINECONE", @@ -3418,8 +3588,7 @@ "type": "list", "member": { "shape": "KnowledgeBaseSummary" - }, - "documentation": "List of KnowledgeBaseSummaries
" + } }, "KnowledgeBaseSummary": { "type": "structure", @@ -3430,37 +3599,40 @@ "updatedAt" ], "members": { + "description": { + "shape": "Description", + "documentation": "The description of the knowledge base.
" + }, "knowledgeBaseId": { - "shape": "Id" + "shape": "Id", + "documentation": "The unique identifier of the knowledge base.
" }, "name": { - "shape": "Name" - }, - "description": { - "shape": "Description" + "shape": "Name", + "documentation": "The name of the knowledge base.
" }, "status": { - "shape": "KnowledgeBaseStatus" + "shape": "KnowledgeBaseStatus", + "documentation": "The status of the knowledge base.
" }, "updatedAt": { - "shape": "DateTimestamp" + "shape": "DateTimestamp", + "documentation": "The time at which the knowledge base was last updated.
" } }, - "documentation": "Summary information of a knowledge base.
" + "documentation": "Contains details about a knowledge base.
" }, "KnowledgeBaseType": { "type": "string", - "documentation": "The type of a knowledge base.
", "enum": [ "VECTOR" ] }, "LambdaArn": { "type": "string", - "documentation": "ARN of a Lambda.
", "max": 2048, "min": 0, - "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-_]+))?" + "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-_]+))?$" }, "ListAgentActionGroupsRequest": { "type": "structure", @@ -3471,24 +3643,25 @@ "members": { "agentId": { "shape": "Id", - "documentation": "Id generated at the server side when an Agent is Listed
", + "documentation": "The unique identifier of the agent.
", "location": "uri", "locationName": "agentId" }, "agentVersion": { "shape": "Version", - "documentation": "Id generated at the server side when an Agent is Listed
", + "documentation": "The version of the agent.
", "location": "uri", "locationName": "agentVersion" }, "maxResults": { - "shape": "MaxResults" + "shape": "MaxResults", + "documentation": "The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken
field when making another request to return the next batch of results.
If the total number of results is greater than the maxResults
value provided in the request, enter the token returned in the nextToken
field in the response in this field to return the next batch of results.
List Action Groups Request
" + } }, "ListAgentActionGroupsResponse": { "type": "structure", @@ -3497,13 +3670,14 @@ ], "members": { "actionGroupSummaries": { - "shape": "ActionGroupSummaries" + "shape": "ActionGroupSummaries", + "documentation": "A list of objects, each of which contains information about an action group.
" }, "nextToken": { - "shape": "NextToken" + "shape": "NextToken", + "documentation": "If the total number of results is greater than the maxResults
value provided in the request, use this token when making another request in the nextToken
field to return the next batch of results.
List Action Groups Response
" + } }, "ListAgentAliasesRequest": { "type": "structure", @@ -3513,18 +3687,19 @@ "members": { "agentId": { "shape": "Id", - "documentation": "Id generated at the server side when an Agent is created
", + "documentation": "The unique identifier of the agent.
", "location": "uri", "locationName": "agentId" }, "maxResults": { - "shape": "MaxResults" + "shape": "MaxResults", + "documentation": "The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken
field when making another request to return the next batch of results.
If the total number of results is greater than the maxResults
value provided in the request, enter the token returned in the nextToken
field in the response in this field to return the next batch of results.
List Agent Aliases Request
" + } }, "ListAgentAliasesResponse": { "type": "structure", @@ -3533,13 +3708,14 @@ ], "members": { "agentAliasSummaries": { - "shape": "AgentAliasSummaries" + "shape": "AgentAliasSummaries", + "documentation": "A list of objects, each of which contains information about an alias of the agent.
" }, "nextToken": { - "shape": "NextToken" + "shape": "NextToken", + "documentation": "If the total number of results is greater than the maxResults
value provided in the request, use this token when making another request in the nextToken
field to return the next batch of results.
List Agent Aliases Response
" + } }, "ListAgentKnowledgeBasesRequest": { "type": "structure", @@ -3550,24 +3726,25 @@ "members": { "agentId": { "shape": "Id", - "documentation": "Id generated at the server side when an Agent is created
", + "documentation": "The unique identifier of the agent for which to return information about knowledge bases associated with it.
", "location": "uri", "locationName": "agentId" }, "agentVersion": { "shape": "Version", - "documentation": "Version number generated when a version is created
", + "documentation": "The version of the agent for which to return information about knowledge bases associated with it.
", "location": "uri", "locationName": "agentVersion" }, "maxResults": { - "shape": "MaxResults" + "shape": "MaxResults", + "documentation": "The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken
field when making another request to return the next batch of results.
If the total number of results is greater than the maxResults
value provided in the request, enter the token returned in the nextToken
field in the response in this field to return the next batch of results.
List Agent Knowledge Bases Request
" + } }, "ListAgentKnowledgeBasesResponse": { "type": "structure", @@ -3576,13 +3753,14 @@ ], "members": { "agentKnowledgeBaseSummaries": { - "shape": "AgentKnowledgeBaseSummaries" + "shape": "AgentKnowledgeBaseSummaries", + "documentation": "A list of objects, each of which contains information about a knowledge base associated with the agent.
" }, "nextToken": { - "shape": "NextToken" + "shape": "NextToken", + "documentation": "If the total number of results is greater than the maxResults
value provided in the request, use this token when making another request in the nextToken
field to return the next batch of results.
List Agent Knowledge Bases Response
" + } }, "ListAgentVersionsRequest": { "type": "structure", @@ -3592,18 +3770,19 @@ "members": { "agentId": { "shape": "Id", - "documentation": "Id generated at the server side when an Agent is created
", + "documentation": "The unique identifier of the agent.
", "location": "uri", "locationName": "agentId" }, "maxResults": { - "shape": "MaxResults" + "shape": "MaxResults", + "documentation": "The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken
field when making another request to return the next batch of results.
If the total number of results is greater than the maxResults
value provided in the request, enter the token returned in the nextToken
field in the response in this field to return the next batch of results.
List Agent Versions Request
" + } }, "ListAgentVersionsResponse": { "type": "structure", @@ -3612,25 +3791,27 @@ ], "members": { "agentVersionSummaries": { - "shape": "AgentVersionSummaries" + "shape": "AgentVersionSummaries", + "documentation": "A list of objects, each of which contains information about a version of the agent.
" }, "nextToken": { - "shape": "NextToken" + "shape": "NextToken", + "documentation": "If the total number of results is greater than the maxResults
value provided in the request, use this token when making another request in the nextToken
field to return the next batch of results.
List Agent Versions Response
" + } }, "ListAgentsRequest": { "type": "structure", "members": { "maxResults": { - "shape": "MaxResults" + "shape": "MaxResults", + "documentation": "The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken
field when making another request to return the next batch of results.
If the total number of results is greater than the maxResults
value provided in the request, enter the token returned in the nextToken
field in the response in this field to return the next batch of results.
List Agent Request
" + } }, "ListAgentsResponse": { "type": "structure", @@ -3639,13 +3820,14 @@ ], "members": { "agentSummaries": { - "shape": "AgentSummaries" + "shape": "AgentSummaries", + "documentation": "A list of objects, each of which contains information about an agent.
" }, "nextToken": { - "shape": "NextToken" + "shape": "NextToken", + "documentation": "If the total number of results is greater than the maxResults
value provided in the request, use this token when making another request in the nextToken
field to return the next batch of results.
List Agent Response
" + } }, "ListDataSourcesRequest": { "type": "structure", @@ -3655,14 +3837,17 @@ "members": { "knowledgeBaseId": { "shape": "Id", + "documentation": "The unique identifier of the knowledge base for which to return a list of information.
", "location": "uri", "locationName": "knowledgeBaseId" }, "maxResults": { - "shape": "MaxResults" + "shape": "MaxResults", + "documentation": "The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken
field when making another request to return the next batch of results.
If the total number of results is greater than the maxResults
value provided in the request, enter the token returned in the nextToken
field in the response in this field to return the next batch of results.
A list of objects, each of which contains information about a data source.
" }, "nextToken": { - "shape": "NextToken" + "shape": "NextToken", + "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.
The unique identifier of the data source for which to return ingestion jobs.
", "location": "uri", "locationName": "dataSourceId" }, "filters": { - "shape": "IngestionJobFilters" + "shape": "IngestionJobFilters", + "documentation": "Contains a definition of a filter for which to filter the results.
" }, - "sortBy": { - "shape": "IngestionJobSortBy" + "knowledgeBaseId": { + "shape": "Id", + "documentation": "The unique identifier of the knowledge base for which to return ingestion jobs.
", + "location": "uri", + "locationName": "knowledgeBaseId" }, "maxResults": { - "shape": "MaxResults" + "shape": "MaxResults", + "documentation": "The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken
field when making another request to return the next batch of results.
If the total number of results is greater than the maxResults
value provided in the request, enter the token returned in the nextToken
field in the response in this field to return the next batch of results.
Contains details about how to sort the results.
" } } }, @@ -3718,10 +3911,12 @@ ], "members": { "ingestionJobSummaries": { - "shape": "IngestionJobSummaries" + "shape": "IngestionJobSummaries", + "documentation": "A list of objects, each of which contains information about an ingestion job.
" }, "nextToken": { - "shape": "NextToken" + "shape": "NextToken", + "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.
The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken
field when making another request to return the next batch of results.
If the total number of results is greater than the maxResults
value provided in the request, enter the token returned in the nextToken
field in the response in this field to return the next batch of results.
A list of objects, each of which contains information about a knowledge base.
" }, "nextToken": { - "shape": "NextToken" + "shape": "NextToken", + "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.
The ARN of the resource for which to list tags.
", "location": "uri", "locationName": "resourceArn" } @@ -3767,105 +3967,103 @@ "type": "structure", "members": { "tags": { - "shape": "TagsMap" + "shape": "TagsMap", + "documentation": "The key-value pairs for the tags associated with the resource.
" } } }, "MaxResults": { "type": "integer", - "documentation": "Max Results.
", "box": true, "max": 1000, "min": 1 }, "MaximumLength": { "type": "integer", - "documentation": "Maximum length of output
", "box": true, "max": 4096, "min": 0 }, "ModelIdentifier": { "type": "string", - "documentation": "ARN or name of a Bedrock model.
", "max": 2048, "min": 1, - "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][_-]?)+)" + "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][_-]?)+)$" }, "Name": { "type": "string", - "documentation": "Name for a resource.
", - "pattern": "([0-9a-zA-Z][_-]?){1,100}" + "pattern": "^([0-9a-zA-Z][_-]?){1,100}$" }, "NextToken": { "type": "string", - "documentation": "Opaque continuation token of previous paginated response.
", "max": 2048, "min": 1, - "pattern": "\\S*" + "pattern": "^\\S*$" }, "NumericalVersion": { "type": "string", - "documentation": "Numerical Agent Version.
", - "pattern": "[0-9]{1,5}" + "pattern": "^[0-9]{1,5}$" }, "OpenSearchServerlessCollectionArn": { "type": "string", - "documentation": "Arn of an OpenSearch Serverless collection.
", "max": 2048, "min": 0, - "pattern": "arn:aws:aoss:[a-z]{2}(-gov)?-[a-z]+-\\d{1}:\\d{12}:collection/[a-z0-9-]{3,32}" + "pattern": "^arn:aws:aoss:[a-z]{2}(-gov)?-[a-z]+-\\d{1}:\\d{12}:collection/[a-z0-9-]{3,32}$" }, "OpenSearchServerlessConfiguration": { "type": "structure", "required": [ "collectionArn", - "vectorIndexName", - "fieldMapping" + "fieldMapping", + "vectorIndexName" ], "members": { "collectionArn": { - "shape": "OpenSearchServerlessCollectionArn" - }, - "vectorIndexName": { - "shape": "OpenSearchServerlessIndexName" + "shape": "OpenSearchServerlessCollectionArn", + "documentation": "The ARN of the OpenSearch Service vector store.
" }, "fieldMapping": { - "shape": "OpenSearchServerlessFieldMapping" + "shape": "OpenSearchServerlessFieldMapping", + "documentation": "Contains the names of the fields to which to map information about the vector store.
" + }, + "vectorIndexName": { + "shape": "OpenSearchServerlessIndexName", + "documentation": "The name of the vector store.
" } }, - "documentation": "Contains the configurations to use OpenSearch Serverless to store knowledge base data.
" + "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.
" }, "OpenSearchServerlessFieldMapping": { "type": "structure", "required": [ - "vectorField", + "metadataField", "textField", - "metadataField" + "vectorField" ], "members": { - "vectorField": { - "shape": "FieldName" + "metadataField": { + "shape": "FieldName", + "documentation": "The name of the field in which Amazon Bedrock stores metadata about the vector store.
" }, "textField": { - "shape": "FieldName" + "shape": "FieldName", + "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.
" }, - "metadataField": { - "shape": "FieldName" + "vectorField": { + "shape": "FieldName", + "documentation": "The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
" } }, - "documentation": "A mapping of Bedrock Knowledge Base fields to OpenSearch Serverless field names
" + "documentation": "Contains the names of the fields to which to map information about the vector store.
" }, "OpenSearchServerlessIndexName": { "type": "string", - "documentation": "Arn of an OpenSearch Serverless index.
", "max": 2048, "min": 0, - "pattern": ".*" + "pattern": "^.*$" }, "Payload": { "type": "string", - "documentation": "String OpenAPI Payload
", "sensitive": true }, "PineconeConfiguration": { @@ -3877,49 +4075,53 @@ ], "members": { "connectionString": { - "shape": "PineconeConnectionString" + "shape": "PineconeConnectionString", + "documentation": "The endpoint URL for your index management page.
" }, "credentialsSecretArn": { - "shape": "SecretArn" - }, - "namespace": { - "shape": "PineconeNamespace" + "shape": "SecretArn", + "documentation": "The ARN of the secret that you created in Secrets Manager that is linked to your Pinecone API key.
" }, "fieldMapping": { - "shape": "PineconeFieldMapping" + "shape": "PineconeFieldMapping", + "documentation": "Contains the names of the fields to which to map information about the vector store.
" + }, + "namespace": { + "shape": "PineconeNamespace", + "documentation": "The namespace to be used to write new data to your database.
" } }, - "documentation": "Contains the configurations to use Pinecone to store knowledge base data.
" + "documentation": "Contains details about the storage configuration of the knowledge base in Pinecone. For more information, see Create a vector index in Pinecone.
" }, "PineconeConnectionString": { "type": "string", - "documentation": "Pinecone connection string
", "max": 2048, "min": 0, - "pattern": ".*" + "pattern": "^.*$" }, "PineconeFieldMapping": { "type": "structure", "required": [ - "textField", - "metadataField" + "metadataField", + "textField" ], "members": { - "textField": { - "shape": "FieldName" - }, "metadataField": { - "shape": "FieldName" + "shape": "FieldName", + "documentation": "The name of the field in which Amazon Bedrock stores metadata about the vector store.
" + }, + "textField": { + "shape": "FieldName", + "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.
" } }, - "documentation": "A mapping of Bedrock Knowledge Base fields to Pinecone field names
" + "documentation": "Contains the names of the fields to which to map information about the vector store.
" }, "PineconeNamespace": { "type": "string", - "documentation": "Pinecone namespace
", "max": 2048, "min": 0, - "pattern": ".*" + "pattern": "^.*$" }, "PrepareAgentRequest": { "type": "structure", @@ -3929,12 +4131,11 @@ "members": { "agentId": { "shape": "Id", - "documentation": "Id generated at the server side when an Agent is created
", + "documentation": "The unique identifier of the agent for which to create a DRAFT
version.
PrepareAgent Request
" + } }, "PrepareAgentResponse": { "type": "structure", @@ -3946,19 +4147,22 @@ ], "members": { "agentId": { - "shape": "Id" + "shape": "Id", + "documentation": "The unique identifier of the agent for which the DRAFT
version was created.
The status of the DRAFT
version and whether it is ready for use.
The version of the agent.
" }, "preparedAt": { - "shape": "DateTimestamp" + "shape": "DateTimestamp", + "documentation": "The time at which the DRAFT
version of the agent was last prepared.
PrepareAgent Response
" + } }, "PrimitiveLong": { "type": "long" @@ -3966,33 +4170,38 @@ "PromptConfiguration": { "type": "structure", "members": { - "promptType": { - "shape": "PromptType" - }, - "promptCreationMode": { - "shape": "CreationMode" - }, - "promptState": { - "shape": "PromptState" - }, "basePromptTemplate": { - "shape": "BasePromptTemplate" + "shape": "BasePromptTemplate", + "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.
" }, "inferenceConfiguration": { - "shape": "InferenceConfiguration" + "shape": "InferenceConfiguration", + "documentation": "Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the promptType
. For more information, see Inference parameters for foundation models.
Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the promptType
. If you set the field as OVERRIDEN
, the overrideLambda
field in the PromptOverrideConfiguration must be specified with the ARN of a Lambda function.
Specifies whether to override the default prompt template for this promptType
. Set this value to OVERRIDDEN
to use the prompt that you provide in the basePromptTemplate
. If you leave it as DEFAULT
, the agent uses a default prompt template.
Specifies whether to allow the agent to carry out the step specified in the promptType
. If you set this value to DISABLED
, the agent skips that step. The default state for each promptType
is as follows.
PRE_PROCESSING
– ENABLED
ORCHESTRATION
– ENABLED
KNOWLEDGE_BASE_RESPONSE_GENERATION
– ENABLED
POST_PROCESSING
– DISABLED
The step in the agent sequence that this prompt configuration applies to.
" } }, - "documentation": "BasePromptConfiguration per Prompt Type.
" + "documentation": "Contains configurations to override a prompt template in one part of an agent sequence. For more information, see Advanced prompts.
" }, "PromptConfigurations": { "type": "list", "member": { "shape": "PromptConfiguration" }, - "documentation": "List of BasePromptConfiguration
", "max": 10, "min": 0 }, @@ -4002,19 +4211,20 @@ "promptConfigurations" ], "members": { - "promptConfigurations": { - "shape": "PromptConfigurations" - }, "overrideLambda": { - "shape": "LambdaArn" + "shape": "LambdaArn", + "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
.
Contains configurations to override a prompt template in one part of an agent sequence. For more information, see Advanced prompts.
" } }, - "documentation": "Configuration for prompt override.
", + "documentation": "Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.
", "sensitive": true }, "PromptState": { "type": "string", - "documentation": "Prompt State.
", "enum": [ "ENABLED", "DISABLED" @@ -4022,7 +4232,6 @@ }, "PromptType": { "type": "string", - "documentation": "Prompt Type.
", "enum": [ "PRE_PROCESSING", "ORCHESTRATION", @@ -4032,78 +4241,83 @@ }, "RdsArn": { "type": "string", - "documentation": "Arn of a RDS Resource.
", - "pattern": "arn:aws(|-cn|-us-gov):rds:[a-zA-Z0-9-]*:[0-9]{12}:cluster:[a-zA-Z0-9-]{1,63}" + "pattern": "^arn:aws(|-cn|-us-gov):rds:[a-zA-Z0-9-]*:[0-9]{12}:cluster:[a-zA-Z0-9-]{1,63}$" }, "RdsConfiguration": { "type": "structure", "required": [ - "resourceArn", "credentialsSecretArn", "databaseName", - "tableName", - "fieldMapping" + "fieldMapping", + "resourceArn", + "tableName" ], "members": { - "resourceArn": { - "shape": "RdsArn" - }, "credentialsSecretArn": { - "shape": "SecretArn" + "shape": "SecretArn", + "documentation": "The ARN of the secret that you created in Secrets Manager that is linked to your Amazon RDS database.
" }, "databaseName": { - "shape": "RdsDatabaseName" - }, - "tableName": { - "shape": "RdsTableName" + "shape": "RdsDatabaseName", + "documentation": "The name of your Amazon RDS database.
" }, "fieldMapping": { - "shape": "RdsFieldMapping" + "shape": "RdsFieldMapping", + "documentation": "Contains the names of the fields to which to map information about the vector store.
" + }, + "resourceArn": { + "shape": "RdsArn", + "documentation": "The ARN of the vector store.
" + }, + "tableName": { + "shape": "RdsTableName", + "documentation": "The name of the table in the database.
" } }, - "documentation": "Contains the configurations to use RDS to store knowledge base data.
" + "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.
" }, "RdsDatabaseName": { "type": "string", - "documentation": "Name of the database within RDS
", "max": 63, "min": 0, - "pattern": "[a-zA-Z0-9_\\-]+" + "pattern": "^[a-zA-Z0-9_\\-]+$" }, "RdsFieldMapping": { "type": "structure", "required": [ + "metadataField", "primaryKeyField", - "vectorField", "textField", - "metadataField" + "vectorField" ], "members": { - "primaryKeyField": { - "shape": "ColumnName" + "metadataField": { + "shape": "ColumnName", + "documentation": "The name of the field in which Amazon Bedrock stores metadata about the vector store.
" }, - "vectorField": { - "shape": "ColumnName" + "primaryKeyField": { + "shape": "ColumnName", + "documentation": "The name of the field in which Amazon Bedrock stores the ID for each entry.
" }, "textField": { - "shape": "ColumnName" + "shape": "ColumnName", + "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.
" }, - "metadataField": { - "shape": "ColumnName" + "vectorField": { + "shape": "ColumnName", + "documentation": "The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
" } }, - "documentation": "A mapping of Bedrock Knowledge Base fields to RDS column names
" + "documentation": "Contains the names of the fields to which to map information about the vector store.
" }, "RdsTableName": { "type": "string", - "documentation": "Name of the table within RDS
", "max": 63, "min": 0, - "pattern": "[a-zA-Z0-9_\\.\\-]+" + "pattern": "^[a-zA-Z0-9_\\.\\-]+$" }, "RecommendedAction": { "type": "string", - "documentation": "The recommended action users can take to resolve an error in failureReasons.
", "max": 2048, "min": 0 }, @@ -4112,81 +4326,83 @@ "member": { "shape": "RecommendedAction" }, - "documentation": "The recommended actions users can take to resolve an error in failureReasons.
", "max": 2048, "min": 0 }, "RedisEnterpriseCloudConfiguration": { "type": "structure", "required": [ - "endpoint", - "vectorIndexName", "credentialsSecretArn", - "fieldMapping" + "endpoint", + "fieldMapping", + "vectorIndexName" ], "members": { - "endpoint": { - "shape": "RedisEnterpriseCloudEndpoint" - }, - "vectorIndexName": { - "shape": "RedisEnterpriseCloudIndexName" - }, "credentialsSecretArn": { - "shape": "SecretArn" + "shape": "SecretArn", + "documentation": "The ARN of the secret that you created in Secrets Manager that is linked to your Redis Enterprise Cloud database.
" + }, + "endpoint": { + "shape": "RedisEnterpriseCloudEndpoint", + "documentation": "The endpoint URL of the Redis Enterprise Cloud database.
" }, "fieldMapping": { - "shape": "RedisEnterpriseCloudFieldMapping" + "shape": "RedisEnterpriseCloudFieldMapping", + "documentation": "Contains the names of the fields to which to map information about the vector store.
" + }, + "vectorIndexName": { + "shape": "RedisEnterpriseCloudIndexName", + "documentation": "The name of the vector index.
" } }, - "documentation": "Contains the configurations to use Redis Enterprise Cloud to store knowledge base data.
" + "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.
" }, "RedisEnterpriseCloudEndpoint": { "type": "string", - "documentation": "Redis enterprise cloud endpoint
", "max": 2048, "min": 0, - "pattern": ".*" + "pattern": "^.*$" }, "RedisEnterpriseCloudFieldMapping": { "type": "structure", "required": [ - "vectorField", + "metadataField", "textField", - "metadataField" + "vectorField" ], "members": { - "vectorField": { - "shape": "FieldName" + "metadataField": { + "shape": "FieldName", + "documentation": "The name of the field in which Amazon Bedrock stores metadata about the vector store.
" }, "textField": { - "shape": "FieldName" + "shape": "FieldName", + "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.
" }, - "metadataField": { - "shape": "FieldName" + "vectorField": { + "shape": "FieldName", + "documentation": "The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
" } }, - "documentation": "A mapping of Bedrock Knowledge Base fields to Redis Cloud field names
" + "documentation": "Contains the names of the fields to which to map information about the vector store.
" }, "RedisEnterpriseCloudIndexName": { "type": "string", - "documentation": "Name of a redis enterprise cloud index
", "max": 2048, "min": 0, - "pattern": ".*" + "pattern": "^.*$" }, "S3BucketArn": { "type": "string", - "documentation": "A S3 bucket ARN
", "max": 2048, "min": 1, - "pattern": "arn:aws(|-cn|-us-gov):s3:::[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]" + "pattern": "^arn:aws(|-cn|-us-gov):s3:::[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$" }, "S3BucketName": { "type": "string", - "documentation": "A bucket in S3.
", "max": 63, "min": 3, - "pattern": "[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]" + "pattern": "^[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$" }, "S3DataSourceConfiguration": { "type": "structure", @@ -4195,36 +4411,38 @@ ], "members": { "bucketArn": { - "shape": "S3BucketArn" + "shape": "S3BucketArn", + "documentation": "The ARN of the bucket that contains the data source.
" }, "inclusionPrefixes": { - "shape": "S3Prefixes" + "shape": "S3Prefixes", + "documentation": "A list of S3 prefixes that define the object containing the data sources. For more information, see Organizing objects using prefixes.
" } }, - "documentation": "Configures an S3 data source location.
" + "documentation": "Contains information about the S3 configuration of the data source.
" }, "S3Identifier": { "type": "structure", "members": { "s3BucketName": { - "shape": "S3BucketName" + "shape": "S3BucketName", + "documentation": "The name of the S3 bucket.
" }, "s3ObjectKey": { - "shape": "S3ObjectKey" + "shape": "S3ObjectKey", + "documentation": "The S3 object key containing the resource.
" } }, - "documentation": "The identifier for the S3 resource.
" + "documentation": "Contains information about the S3 object containing the resource.
" }, "S3ObjectKey": { "type": "string", - "documentation": "A object key in S3.
", "max": 1024, "min": 1, - "pattern": "[\\.\\-\\!\\*\\_\\'\\(\\)a-zA-Z0-9][\\.\\-\\!\\*\\_\\'\\(\\)\\/a-zA-Z0-9]*" + "pattern": "^[\\.\\-\\!\\*\\_\\'\\(\\)a-zA-Z0-9][\\.\\-\\!\\*\\_\\'\\(\\)\\/a-zA-Z0-9]*$" }, "S3Prefix": { "type": "string", - "documentation": "Prefix for s3 object.
", "max": 300, "min": 1 }, @@ -4233,34 +4451,31 @@ "member": { "shape": "S3Prefix" }, - "documentation": "A list of S3 prefixes.
", "max": 1, "min": 1 }, "SecretArn": { "type": "string", - "documentation": "Arn of a SecretsManager Secret.
", - "pattern": "arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9!/_+=.@-]{1,512}" + "pattern": "^arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9!/_+=.@-]{1,512}$" }, "ServerSideEncryptionConfiguration": { "type": "structure", "members": { "kmsKeyArn": { - "shape": "KmsKeyArn" + "shape": "KmsKeyArn", + "documentation": "The ARN of the KMS key used to encrypt the resource.
" } }, - "documentation": "Server-side encryption configuration.
" + "documentation": "Contains the configuration for server-side encryption.
" }, "SessionTTL": { "type": "integer", - "documentation": "Max Session Time.
", "box": true, "max": 3600, "min": 60 }, "SortOrder": { "type": "string", - "documentation": "Order to sort results by.
", "enum": [ "ASCENDING", "DESCENDING" @@ -4269,26 +4484,30 @@ "StartIngestionJobRequest": { "type": "structure", "required": [ - "knowledgeBaseId", - "dataSourceId" + "dataSourceId", + "knowledgeBaseId" ], "members": { - "knowledgeBaseId": { - "shape": "Id", - "location": "uri", - "locationName": "knowledgeBaseId" + "clientToken": { + "shape": "ClientToken", + "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, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", + "idempotencyToken": true }, "dataSourceId": { "shape": "Id", + "documentation": "The unique identifier of the data source to ingest.
", "location": "uri", "locationName": "dataSourceId" }, - "clientToken": { - "shape": "ClientToken", - "idempotencyToken": true - }, "description": { - "shape": "Description" + "shape": "Description", + "documentation": "A description of the ingestion job.
" + }, + "knowledgeBaseId": { + "shape": "Id", + "documentation": "The unique identifier of the knowledge base to which to add the data source.
", + "location": "uri", + "locationName": "knowledgeBaseId" } } }, @@ -4299,7 +4518,8 @@ ], "members": { "ingestionJob": { - "shape": "IngestionJob" + "shape": "IngestionJob", + "documentation": "An object containing information about the ingestion job.
" } } }, @@ -4308,7 +4528,6 @@ "member": { "shape": "String" }, - "documentation": "List of stop sequences
", "max": 4, "min": 0 }, @@ -4318,40 +4537,43 @@ "type" ], "members": { - "type": { - "shape": "KnowledgeBaseStorageType" - }, "opensearchServerlessConfiguration": { - "shape": "OpenSearchServerlessConfiguration" + "shape": "OpenSearchServerlessConfiguration", + "documentation": "Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.
" }, "pineconeConfiguration": { - "shape": "PineconeConfiguration" + "shape": "PineconeConfiguration", + "documentation": "Contains the storage configuration of the knowledge base in Pinecone.
" + }, + "rdsConfiguration": { + "shape": "RdsConfiguration", + "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.
" }, "redisEnterpriseCloudConfiguration": { - "shape": "RedisEnterpriseCloudConfiguration" + "shape": "RedisEnterpriseCloudConfiguration", + "documentation": "Contains the storage configuration of the knowledge base in Redis Enterprise Cloud.
" }, - "rdsConfiguration": { - "shape": "RdsConfiguration" + "type": { + "shape": "KnowledgeBaseStorageType", + "documentation": "The vector store service in which the knowledge base is stored.
" } }, - "documentation": "Configures the physical storage of ingested data in a knowledge base.
" + "documentation": "Contains the storage configuration of the knowledge base.
" }, "String": { "type": "string" }, "TagKey": { "type": "string", - "documentation": "Key of a tag
", "max": 128, "min": 1, - "pattern": "[a-zA-Z0-9\\s._:/=+@-]*" + "pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$" }, "TagKeyList": { "type": "list", "member": { "shape": "TagKey" }, - "documentation": "List of Tag Keys
", "max": 200, "min": 0 }, @@ -4364,11 +4586,13 @@ "members": { "resourceArn": { "shape": "TaggableResourcesArn", + "documentation": "The ARN of the resource to tag.
", "location": "uri", "locationName": "resourceArn" }, "tags": { - "shape": "TagsMap" + "shape": "TagsMap", + "documentation": "An object containing key-value pairs that define the tags to attach to the resource.
" } } }, @@ -4378,17 +4602,15 @@ }, "TagValue": { "type": "string", - "documentation": "Value of a tag
", "max": 256, "min": 0, - "pattern": "[a-zA-Z0-9\\s._:/=+@-]*" + "pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$" }, "TaggableResourcesArn": { "type": "string", - "documentation": "ARN of Taggable resources: [Agent, AgentAlias, Knowledge-Base]
", "max": 1011, "min": 20, - "pattern": ".*(^arn:aws:bedrock:[a-zA-Z0-9-]+:/d{12}:(agent|agent-alias|knowledge-base)/[A-Z0-9]{10}(?:/[A-Z0-9]{10})?$).*" + "pattern": "(^arn:aws:bedrock:[a-zA-Z0-9-]+:/d{12}:(agent|agent-alias|knowledge-base)/[A-Z0-9]{10}(?:/[A-Z0-9]{10})?$)" }, "TagsMap": { "type": "map", @@ -4397,26 +4619,22 @@ }, "value": { "shape": "TagValue" - }, - "documentation": "A map of tag keys and values
" + } }, "Temperature": { "type": "float", - "documentation": "Controls randomness, higher values increase diversity
", "box": true, "max": 1, "min": 0 }, "TopK": { "type": "integer", - "documentation": "Sample from the k most likely next tokens
", "box": true, "max": 500, "min": 0 }, "TopP": { "type": "float", - "documentation": "Cumulative probability cutoff for token selection
", "box": true, "max": 1, "min": 0 @@ -4430,11 +4648,13 @@ "members": { "resourceArn": { "shape": "TaggableResourcesArn", + "documentation": "The ARN of the resource from which to remove tags.
", "location": "uri", "locationName": "resourceArn" }, "tagKeys": { "shape": "TagKeyList", + "documentation": "A list of keys of the tags to remove from the resource.
", "location": "querystring", "locationName": "tagKeys" } @@ -4447,50 +4667,55 @@ "UpdateAgentActionGroupRequest": { "type": "structure", "required": [ - "agentId", - "agentVersion", "actionGroupId", - "actionGroupName" + "actionGroupName", + "agentId", + "agentVersion" ], "members": { + "actionGroupExecutor": { + "shape": "ActionGroupExecutor", + "documentation": "The ARN of the Lambda function containing the business logic that is carried out upon invoking the action.
" + }, + "actionGroupId": { + "shape": "Id", + "documentation": "The unique identifier of the action group.
", + "location": "uri", + "locationName": "actionGroupId" + }, + "actionGroupName": { + "shape": "Name", + "documentation": "Specifies a new name for the action group.
" + }, + "actionGroupState": { + "shape": "ActionGroupState", + "documentation": "Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
" + }, "agentId": { "shape": "Id", - "documentation": "Id generated at the server side when an Agent is created
", + "documentation": "The unique identifier of the agent for which to update the action group.
", "location": "uri", "locationName": "agentId" }, "agentVersion": { "shape": "DraftVersion", - "documentation": "Draft Version of the Agent.
", + "documentation": "The unique identifier of the agent version for which to update the action group.
", "location": "uri", "locationName": "agentVersion" }, - "actionGroupId": { - "shape": "Id", - "documentation": "Id generated at the server side when an Action Group is created under Agent
", - "location": "uri", - "locationName": "actionGroupId" - }, - "actionGroupName": { - "shape": "Name" + "apiSchema": { + "shape": "APISchema", + "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.
" }, "description": { - "shape": "Description" + "shape": "Description", + "documentation": "Specifies a new name for the action group.
" }, "parentActionGroupSignature": { - "shape": "ActionGroupSignature" - }, - "actionGroupExecutor": { - "shape": "ActionGroupExecutor" - }, - "actionGroupState": { - "shape": "ActionGroupState" - }, - "apiSchema": { - "shape": "APISchema" + "shape": "ActionGroupSignature", + "documentation": "To allow your agent to request the user for additional information when trying to complete a task, set this field to AMAZON.UserInput
. You must leave the description
, apiSchema
, and actionGroupExecutor
fields blank for this action group.
During orchestration, if your agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.
" } - }, - "documentation": "Update Action Group Request
" + } }, "UpdateAgentActionGroupResponse": { "type": "structure", @@ -4499,42 +4724,44 @@ ], "members": { "agentActionGroup": { - "shape": "AgentActionGroup" + "shape": "AgentActionGroup", + "documentation": "Contains details about the action group that was updated.
" } - }, - "documentation": "Update Action Group Response
" + } }, "UpdateAgentAliasRequest": { "type": "structure", "required": [ - "agentId", "agentAliasId", - "agentAliasName" + "agentAliasName", + "agentId" ], "members": { - "agentId": { - "shape": "Id", - "documentation": "Id generated at the server side when an Agent is created
", - "location": "uri", - "locationName": "agentId" - }, "agentAliasId": { "shape": "AgentAliasId", - "documentation": "Id generated at the server side when an Agent Alias is created
", + "documentation": "The unique identifier of the alias.
", "location": "uri", "locationName": "agentAliasId" }, "agentAliasName": { - "shape": "Name" + "shape": "Name", + "documentation": "Specifies a new name for the alias.
" + }, + "agentId": { + "shape": "Id", + "documentation": "The unique identifier of the agent.
", + "location": "uri", + "locationName": "agentId" }, "description": { - "shape": "Description" + "shape": "Description", + "documentation": "Specifies a new description for the alias.
" }, "routingConfiguration": { - "shape": "AgentAliasRoutingConfiguration" + "shape": "AgentAliasRoutingConfiguration", + "documentation": "Contains details about the routing configuration of the alias.
" } - }, - "documentation": "Update Agent Alias Request
" + } }, "UpdateAgentAliasResponse": { "type": "structure", @@ -4543,10 +4770,10 @@ ], "members": { "agentAlias": { - "shape": "AgentAlias" + "shape": "AgentAlias", + "documentation": "Contains details about the alias that was updated.
" } - }, - "documentation": "Update Agent Alias Response
" + } }, "UpdateAgentKnowledgeBaseRequest": { "type": "structure", @@ -4558,30 +4785,31 @@ "members": { "agentId": { "shape": "Id", - "documentation": "Id generated at the server side when an Agent is created
", + "documentation": "The unique identifier of the agent associated with the knowledge base that you want to update.
", "location": "uri", "locationName": "agentId" }, "agentVersion": { "shape": "DraftVersion", - "documentation": "Draft Version of the Agent.
", + "documentation": "The version of the agent associated with the knowledge base that you want to update.
", "location": "uri", "locationName": "agentVersion" }, + "description": { + "shape": "Description", + "documentation": "Specifies a new description for the knowledge base associated with an agent.
" + }, "knowledgeBaseId": { "shape": "Id", - "documentation": "Id generated at the server side when a Knowledge Base is associated to an Agent
", + "documentation": "The unique identifier of the knowledge base that has been associated with an agent.
", "location": "uri", "locationName": "knowledgeBaseId" }, - "description": { - "shape": "Description" - }, "knowledgeBaseState": { - "shape": "KnowledgeBaseState" + "shape": "KnowledgeBaseState", + "documentation": "Specifies whether the agent uses the knowledge base or not when sending an InvokeAgent request.
" } - }, - "documentation": "Update Agent Knowledge Base Request
" + } }, "UpdateAgentKnowledgeBaseResponse": { "type": "structure", @@ -4590,51 +4818,59 @@ ], "members": { "agentKnowledgeBase": { - "shape": "AgentKnowledgeBase" + "shape": "AgentKnowledgeBase", + "documentation": "Contains details about the knowledge base that has been associated with an agent.
" } - }, - "documentation": "Update Agent Knowledge Base Response
" + } }, "UpdateAgentRequest": { "type": "structure", "required": [ "agentId", "agentName", - "agentResourceRoleArn" + "agentResourceRoleArn", + "foundationModel" ], "members": { "agentId": { "shape": "Id", - "documentation": "Id generated at the server side when an Agent is created
", + "documentation": "The unique identifier of the agent.
", "location": "uri", "locationName": "agentId" }, "agentName": { - "shape": "Name" + "shape": "Name", + "documentation": "Specifies a new name for the agent.
" }, - "instruction": { - "shape": "Instruction" + "agentResourceRoleArn": { + "shape": "AgentRoleArn", + "documentation": "The ARN of the IAM role with permissions to update the agent. The ARN must begin with AmazonBedrockExecutionRoleForAgents_
.
The ARN of the KMS key with which to encrypt the agent.
" }, "description": { - "shape": "Description" + "shape": "Description", + "documentation": "Specifies a new description of the agent.
" }, - "idleSessionTTLInSeconds": { - "shape": "SessionTTL" + "foundationModel": { + "shape": "ModelIdentifier", + "documentation": "Specifies a new foundation model to be used for orchestration by the agent.
" }, - "agentResourceRoleArn": { - "shape": "AgentRoleArn" + "idleSessionTTLInSeconds": { + "shape": "SessionTTL", + "documentation": "The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.
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.
" }, - "customerEncryptionKeyArn": { - "shape": "KmsKeyArn" + "instruction": { + "shape": "Instruction", + "documentation": "Specifies new instructions that tell the agent what it should do and how it should interact with users.
" }, "promptOverrideConfiguration": { - "shape": "PromptOverrideConfiguration" + "shape": "PromptOverrideConfiguration", + "documentation": "Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.
" } - }, - "documentation": "Update Agent Request
" + } }, "UpdateAgentResponse": { "type": "structure", @@ -4643,44 +4879,51 @@ ], "members": { "agent": { - "shape": "Agent" + "shape": "Agent", + "documentation": "Contains details about the agent that was updated.
" } - }, - "documentation": "Update Agent Response
" + } }, "UpdateDataSourceRequest": { "type": "structure", "required": [ - "knowledgeBaseId", + "dataSourceConfiguration", "dataSourceId", - "name", - "dataSourceConfiguration" + "knowledgeBaseId", + "name" ], "members": { - "knowledgeBaseId": { - "shape": "Id", - "location": "uri", - "locationName": "knowledgeBaseId" + "dataSourceConfiguration": { + "shape": "DataSourceConfiguration", + "documentation": "Contains details about the storage configuration of the data source.
" }, "dataSourceId": { "shape": "Id", + "documentation": "The unique identifier of the data source.
", "location": "uri", "locationName": "dataSourceId" }, - "name": { - "shape": "Name" - }, "description": { - "shape": "Description" + "shape": "Description", + "documentation": "Specifies a new description for the data source.
" }, - "dataSourceConfiguration": { - "shape": "DataSourceConfiguration" + "knowledgeBaseId": { + "shape": "Id", + "documentation": "The unique identifier of the knowledge base to which the data source belongs.
", + "location": "uri", + "locationName": "knowledgeBaseId" + }, + "name": { + "shape": "Name", + "documentation": "Specifies a new name for the data source.
" }, "serverSideEncryptionConfiguration": { - "shape": "ServerSideEncryptionConfiguration" + "shape": "ServerSideEncryptionConfiguration", + "documentation": "Contains details about server-side encryption of the data source.
" }, "vectorIngestionConfiguration": { - "shape": "VectorIngestionConfiguration" + "shape": "VectorIngestionConfiguration", + "documentation": "Contains details about how to ingest the documents in the data source.
" } } }, @@ -4691,39 +4934,46 @@ ], "members": { "dataSource": { - "shape": "DataSource" + "shape": "DataSource", + "documentation": "Contains details about the data source.
" } } }, "UpdateKnowledgeBaseRequest": { "type": "structure", "required": [ + "knowledgeBaseConfiguration", "knowledgeBaseId", "name", "roleArn", - "knowledgeBaseConfiguration", "storageConfiguration" ], "members": { + "description": { + "shape": "Description", + "documentation": "Specifies a new description for the knowledge base.
" + }, + "knowledgeBaseConfiguration": { + "shape": "KnowledgeBaseConfiguration", + "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.
" + }, "knowledgeBaseId": { "shape": "Id", + "documentation": "The unique identifier of the knowledge base to update.
", "location": "uri", "locationName": "knowledgeBaseId" }, "name": { - "shape": "Name" - }, - "description": { - "shape": "Description" + "shape": "Name", + "documentation": "Specifies a new name for the knowledge base.
" }, "roleArn": { - "shape": "KnowledgeBaseRoleArn" - }, - "knowledgeBaseConfiguration": { - "shape": "KnowledgeBaseConfiguration" + "shape": "KnowledgeBaseRoleArn", + "documentation": "Specifies a different Amazon Resource Name (ARN) of the IAM role with permissions to modify the knowledge base.
" }, "storageConfiguration": { - "shape": "StorageConfiguration" + "shape": "StorageConfiguration", + "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.
" } } }, @@ -4734,7 +4984,8 @@ ], "members": { "knowledgeBase": { - "shape": "KnowledgeBase" + "shape": "KnowledgeBase", + "documentation": "Contains details about the knowledge base.
" } } }, @@ -4742,10 +4993,11 @@ "type": "structure", "members": { "chunkingConfiguration": { - "shape": "ChunkingConfiguration" + "shape": "ChunkingConfiguration", + "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.
" } }, - "documentation": "Configures ingestion for a vector knowledge base
" + "documentation": "Contains details about how to ingest the documents in a data source.
" }, "VectorKnowledgeBaseConfiguration": { "type": "structure", @@ -4754,18 +5006,18 @@ ], "members": { "embeddingModelArn": { - "shape": "BedrockEmbeddingModelArn" + "shape": "BedrockEmbeddingModelArn", + "documentation": "The ARN of the model used to create vector embeddings for the knowledge base.
" } }, - "documentation": "Configurations for a vector knowledge base.
" + "documentation": "Contains details about the model used to create vector embeddings for the knowledge base.
" }, "Version": { "type": "string", - "documentation": "Agent Version.
", "max": 5, "min": 1, - "pattern": "(DRAFT|[0-9]{0,4}[1-9][0-9]{0,4})" + "pattern": "^(DRAFT|[0-9]{0,4}[1-9][0-9]{0,4})$" } }, - "documentation": "An example service, deployed with the Octane Service creator, which will echo the string
" + "documentation": "Describes the API operations for creating and managing Amazon Bedrock agents.
" } \ No newline at end of file diff --git a/apis/bedrock-agent-runtime-2023-07-26.min.json b/apis/bedrock-agent-runtime-2023-07-26.min.json index 2e5d736ed8..6375c4cc95 100644 --- a/apis/bedrock-agent-runtime-2023-07-26.min.json +++ b/apis/bedrock-agent-runtime-2023-07-26.min.json @@ -223,7 +223,7 @@ "sensitive": true }, "parameters": { - "shape": "S1c" + "shape": "S1f" }, "requestBody": { "type": "structure", @@ -232,7 +232,7 @@ "type": "map", "key": {}, "value": { - "shape": "S1c" + "shape": "S1f" } } } @@ -262,7 +262,7 @@ "sensitive": true }, "modelInvocationInput": { - "shape": "S1l" + "shape": "S1o" }, "observation": { "type": "structure", @@ -313,7 +313,7 @@ "type": "structure", "members": { "text": { - "shape": "S26" + "shape": "S29" }, "traceId": {} }, @@ -327,7 +327,7 @@ "type": "structure", "members": { "modelInvocationInput": { - "shape": "S1l" + "shape": "S1o" }, "modelInvocationOutput": { "type": "structure", @@ -354,7 +354,7 @@ "type": "structure", "members": { "modelInvocationInput": { - "shape": "S1l" + "shape": "S1o" }, "modelInvocationOutput": { "type": "structure", @@ -366,7 +366,7 @@ "type": "boolean" }, "rationale": { - "shape": "S26" + "shape": "S29" } }, "sensitive": true @@ -431,7 +431,7 @@ }, "nextToken": {}, "retrievalConfiguration": { - "shape": "S2j" + "shape": "S2m" }, "retrievalQuery": { "type": "structure", @@ -466,6 +466,9 @@ "location": { "shape": "Ss" }, + "metadata": { + "shape": "Sv" + }, "score": { "type": "double" } @@ -527,7 +530,7 @@ "knowledgeBaseId": {}, "modelArn": {}, "retrievalConfiguration": { - "shape": "S2j" + "shape": "S2m" } } }, @@ -616,6 +619,9 @@ }, "location": { "shape": "Ss" + }, + "metadata": { + "shape": "Sv" } } } @@ -646,7 +652,17 @@ }, "sensitive": true }, - "S1c": { + "Sv": { + "type": "map", + "key": {}, + "value": { + "type": "structure", + "members": {}, + "document": true + }, + "sensitive": true + }, + "S1f": { "type": "list", "member": { "type": "structure", @@ -657,7 +673,7 @@ } } }, - "S1l": { + "S1o": { "type": "structure", "members": { "inferenceConfiguration": { @@ -693,11 +709,11 @@ }, "sensitive": true }, - "S26": { + "S29": { "type": "string", "sensitive": true }, - "S2j": { + "S2m": { "type": "structure", "required": [ "vectorSearchConfiguration" @@ -706,6 +722,9 @@ "vectorSearchConfiguration": { "type": "structure", "members": { + "filter": { + "shape": "S2o" + }, "numberOfResults": { "type": "integer" }, @@ -713,6 +732,67 @@ } } } + }, + "S2o": { + "type": "structure", + "members": { + "andAll": { + "shape": "S2p" + }, + "equals": { + "shape": "S2q" + }, + "greaterThan": { + "shape": "S2q" + }, + "greaterThanOrEquals": { + "shape": "S2q" + }, + "in": { + "shape": "S2q" + }, + "lessThan": { + "shape": "S2q" + }, + "lessThanOrEquals": { + "shape": "S2q" + }, + "notEquals": { + "shape": "S2q" + }, + "notIn": { + "shape": "S2q" + }, + "orAll": { + "shape": "S2p" + }, + "startsWith": { + "shape": "S2q" + } + }, + "sensitive": true, + "union": true + }, + "S2p": { + "type": "list", + "member": { + "shape": "S2o" + } + }, + "S2q": { + "type": "structure", + "required": [ + "key", + "value" + ], + "members": { + "key": {}, + "value": { + "type": "structure", + "members": {}, + "document": true + } + } } } } \ No newline at end of file diff --git a/apis/bedrock-agent-runtime-2023-07-26.normal.json b/apis/bedrock-agent-runtime-2023-07-26.normal.json index 602c598bc7..72b7f4aafc 100644 --- a/apis/bedrock-agent-runtime-2023-07-26.normal.json +++ b/apis/bedrock-agent-runtime-2023-07-26.normal.json @@ -142,7 +142,7 @@ "shape": "ServiceQuotaExceededException" } ], - "documentation": "Queries a knowledge base and generates responses based on the retrieved results. The response cites up to five sources but only selects the ones that are relevant to the query.
" + "documentation": "Queries a knowledge base and generates responses based on the retrieved results. The response only cites sources that are relevant to the query.
" } }, "shapes": { @@ -349,6 +349,34 @@ "documentation": "Contains information about the failure of the interaction.
", "sensitive": true }, + "FilterAttribute": { + "type": "structure", + "required": [ + "key", + "value" + ], + "members": { + "key": { + "shape": "FilterKey", + "documentation": "The name that the metadata attribute must match.
" + }, + "value": { + "shape": "FilterValue", + "documentation": "The value to whcih to compare the value of the metadata attribute.
" + } + }, + "documentation": "Specifies the name that the metadata attribute must match and the value to which to compare the value of the metadata attribute. For more information, see Query configurations.
This data type is used in the following API operations:
" + }, + "FilterKey": { + "type": "string", + "max": 100, + "min": 1 + }, + "FilterValue": { + "type": "structure", + "members": {}, + "document": true + }, "FinalResponse": { "type": "structure", "members": { @@ -618,6 +646,10 @@ "shape": "RetrievalResultLocation", "documentation": "Contains information about the location of the data source.
" }, + "metadata": { + "shape": "RetrievalResultMetadata", + "documentation": "Contains metadata attributes and their values for the file in the data source. For more information, see Metadata and filtering.
" + }, "score": { "shape": "Double", "documentation": "The level of relevance of the result to the query.
" @@ -661,6 +693,10 @@ "KnowledgeBaseVectorSearchConfiguration": { "type": "structure", "members": { + "filter": { + "shape": "RetrievalFilter", + "documentation": "Specifies the filters to use on the metadata in the knowledge base data sources before returning results. For more information, see Query configurations.
" + }, "numberOfResults": { "shape": "KnowledgeBaseVectorSearchConfigurationNumberOfResultsInteger", "documentation": "The number of source chunks to retrieve.
", @@ -946,7 +982,7 @@ "documentation": "The template for the prompt that's sent to the model for response generation. You can include prompt placeholders, which become replaced before the prompt is sent to the model to provide instructions and context to the model. In addition, you can include XML tags to delineate meaningful sections of the prompt template.
For more information, see the following resources:
" } }, - "documentation": "Contains the template for the prompt that's sent to the model for response generation. For more information, see Knowledge base prompt templates.
This data type is used in the following API operations:
" + "documentation": "Contains the template for the prompt that's sent to the model for response generation. For more information, see Knowledge base prompt templates.
This data type is used in the following API operations:
RetrieveAndGenerate request – in the filter
field
The response from invoking the agent and associated citations and trace information.
", "eventstream": true }, + "RetrievalFilter": { + "type": "structure", + "members": { + "andAll": { + "shape": "RetrievalFilterList", + "documentation": "Knowledge base data sources whose metadata attributes fulfill all the filter conditions inside this list are returned.
" + }, + "equals": { + "shape": "FilterAttribute", + "documentation": "Knowledge base data sources that contain a metadata attribute whose name matches the key
and whose value matches the value
in this object are returned.
Knowledge base data sources that contain a metadata attribute whose name matches the key
and whose value is greater than the value
in this object are returned.
Knowledge base data sources that contain a metadata attribute whose name matches the key
and whose value is greater than or equal to the value
in this object are returned.
Knowledge base data sources that contain a metadata attribute whose name matches the key
and whose value is in the list specified in the value
in this object are returned.
Knowledge base data sources that contain a metadata attribute whose name matches the key
and whose value is less than the value
in this object are returned.
Knowledge base data sources that contain a metadata attribute whose name matches the key
and whose value is less than or equal to the value
in this object are returned.
Knowledge base data sources that contain a metadata attribute whose name matches the key
and whose value doesn't match the value
in this object are returned.
Knowledge base data sources that contain a metadata attribute whose name matches the key
and whose value isn't in the list specified in the value
in this object are returned.
Knowledge base data sources whose metadata attributes fulfill at least one of the filter conditions inside this list are returned.
" + }, + "startsWith": { + "shape": "FilterAttribute", + "documentation": "Knowledge base data sources that contain a metadata attribute whose name matches the key
and whose value starts with the value
in this object are returned. This filter is currently only supported for Amazon OpenSearch Serverless vector stores.
Specifies the filters to use on the metadata attributes in the knowledge base data sources before returning results. For more information, see Query configurations.
This data type is used in the following API operations:
Retrieve request – in the filter
field
RetrieveAndGenerate request – in the filter
field
Contains information about the location of the data source.
" + }, + "metadata": { + "shape": "RetrievalResultMetadata", + "documentation": "Contains metadata attributes and their values for the file in the data source. For more information, see Metadata and filtering.
" } }, "documentation": "Contains metadata about a source cited for the generated response.
This data type is used in the following API operations:
RetrieveAndGenerate response – in the retrievedReferences
field
Retrieve response – in the retrievedReferences
field
The upper limit for data storage the cache is set to use.
" }, + "Minimum": { + "shape": "IntegerOptional", + "documentation": "The lower limit for data storage the cache is set to use.
" + }, "Unit": { "shape": "DataStorageUnit", "documentation": "The unit that the storage is measured in, in GB.
" @@ -5177,13 +5180,14 @@ }, "ECPUPerSecond": { "type": "structure", - "required": [ - "Maximum" - ], "members": { "Maximum": { "shape": "IntegerOptional", "documentation": "The configuration for the maximum number of ECPUs the cache can consume per second.
" + }, + "Minimum": { + "shape": "IntegerOptional", + "documentation": "The configuration for the minimum number of ECPUs the cache should be able consume per second.
" } }, "documentation": "The configuration for the number of ElastiCache Processing Units (ECPU) the cache can consume per second.
" diff --git a/apis/secretsmanager-2017-10-17.normal.json b/apis/secretsmanager-2017-10-17.normal.json index 4d957dee48..83fe5322e7 100644 --- a/apis/secretsmanager-2017-10-17.normal.json +++ b/apis/secretsmanager-2017-10-17.normal.json @@ -1444,7 +1444,7 @@ }, "BlockPublicPolicy": { "shape": "BooleanType", - "documentation": "Specifies whether to block resource-based policies that allow broad access to the secret, for example those that use a wildcard for the principal. By default, public policies aren't blocked.
", + "documentation": "Specifies whether to block resource-based policies that allow broad access to the secret, for example those that use a wildcard for the principal. By default, public policies aren't blocked.
Resource policy validation and the BlockPublicPolicy parameter help protect your resources by preventing public access from being granted through the resource policies that are directly attached to your secrets. In addition to using these features, carefully inspect the following policies to confirm that they do not grant public access:
Identity-based policies attached to associated Amazon Web Services principals (for example, IAM roles)
Resource-based policies attached to associated Amazon Web Services resources (for example, Key Management Service (KMS) keys)
To review permissions to your secrets, see Determine who has permissions to your secrets.
>1,l=23===i?Math.pow(2,-24)-Math.pow(2,-77):0,d=a?0:s-1,y=a?1:-1,b=t<0||0===t&&1/t<0?1:0;for(t=Math.abs(t),isNaN(t)||t===1/0?(n=isNaN(t)?1:0,o=m):(o=Math.floor(Math.log(t)/Math.LN2),t*(u=Math.pow(2,-o))<1&&(o--,u*=2),t+=o+c>=1?l/u:l*Math.pow(2,1-c),t*u>=2&&(o++,u/=2),o+c>=m?(n=0,o=m):o+c>=1?(n=(t*u-1)*Math.pow(2,i),o+=c):(n=t*Math.pow(2,c-1)*Math.pow(2,i),o=0));i>=8;e[r+d]=255&n,d+=y,n/=256,i-=8);for(o=o<0;e[r+d]=255&o,d+=y,o/=256,p-=8);e[r+d-y]|=128*b}},{}],443:[function(e,t,r){var a={}.toString;t.exports=Array.isArray||function(e){return"[object Array]"==a.call(e)}},{}],444:[function(e,t,r){!function(e){"use strict";function t(e){return null!==e&&"[object Array]"===Object.prototype.toString.call(e)}function r(e){return null!==e&&"[object Object]"===Object.prototype.toString.call(e)}function a(e,i){if(e===i)return!0;if(Object.prototype.toString.call(e)!==Object.prototype.toString.call(i))return!1;if(!0===t(e)){if(e.length!==i.length)return!1;for(var s=0;s G((f-r)/g)&&i("overflow"),r+=(p-t)*g,t=p,u=0;u =0?(c=b.substr(0,S),l=b.substr(S+1)):(c=b,l=""),d=decodeURIComponent(c),y=decodeURIComponent(l),a(o,d)?i(o[d])?o[d].push(y):o[d]=[o[d],y]:o[d]=y}return o};var i=Array.isArray||function(e){return"[object Array]"===Object.prototype.toString.call(e)}},{}],448:[function(e,t,r){"use strict";function a(e,t){if(e.map)return e.map(t);for(var r=[],a=0;a >1,l=23===i?Math.pow(2,-24)-Math.pow(2,-77):0,d=a?0:s-1,y=a?1:-1,b=t<0||0===t&&1/t<0?1:0;for(t=Math.abs(t),isNaN(t)||t===1/0?(n=isNaN(t)?1:0,o=m):(o=Math.floor(Math.log(t)/Math.LN2),t*(u=Math.pow(2,-o))<1&&(o--,u*=2),t+=o+c>=1?l/u:l*Math.pow(2,1-c),t*u>=2&&(o++,u/=2),o+c>=m?(n=0,o=m):o+c>=1?(n=(t*u-1)*Math.pow(2,i),o+=c):(n=t*Math.pow(2,c-1)*Math.pow(2,i),o=0));i>=8;e[r+d]=255&n,d+=y,n/=256,i-=8);for(o=o<0;e[r+d]=255&o,d+=y,o/=256,p-=8);e[r+d-y]|=128*b}},{}],443:[function(e,t,r){var a={}.toString;t.exports=Array.isArray||function(e){return"[object Array]"==a.call(e)}},{}],444:[function(e,t,r){!function(e){"use strict";function t(e){return null!==e&&"[object Array]"===Object.prototype.toString.call(e)}function r(e){return null!==e&&"[object Object]"===Object.prototype.toString.call(e)}function a(e,i){if(e===i)return!0;if(Object.prototype.toString.call(e)!==Object.prototype.toString.call(i))return!1;if(!0===t(e)){if(e.length!==i.length)return!1;for(var s=0;s=55296&&t<=56319&&i65535&&(e-=65536,t+=w(e>>>10&1023|55296),e=56320|1023&e),t+=w(e)}).join("")}function p(e){return e-48<10?e-22:e-65<26?e-65:e-97<26?e-97:T}function m(e,t){return e+22+75*(e<26)-((0!=t)<<5)}function c(e,t,r){var a=0;for(e=r?G(e/R):e>>1,e+=G(e/t);e>L*k>>1;a+=T)e=G(e/L);return G(a+(L+1)*e/(e+A))}function l(e){var t,r,a,s,o,n,m,l,d,y,b=[],S=e.length,g=0,h=v,I=D;for(r=e.lastIndexOf(x),r<0&&(r=0),a=0;a=S&&i("invalid-input"),l=p(e.charCodeAt(s++)),(l>=T||l>G((f-g)/n))&&i("overflow"),g+=l*n,d=m<=I?C:m>=I+k?k:m-I,!(l=t&&bf&&i("overflow"),b==t){for(l=r,d=T;y=d<=o?C:d>=o+k?k:d-o,!(l=0&&delete e.httpRequest.headers["Content-Length"]}function i(e){var t=new l,r=e.service.api.operations[e.operation].input;if(r.payload){var a={},i=r.members[r.payload];a=e.params[r.payload],"structure"===i.type?(e.httpRequest.body=t.build(a||{},i),s(e)):void 0!==a&&(e.httpRequest.body=a,("binary"===i.type||i.isStreaming)&&s(e,!0))}else e.httpRequest.body=t.build(e.params,r),s(e)}function s(e,t){if(!e.httpRequest.headers["Content-Type"]){var r=t?"binary/octet-stream":"application/json";e.httpRequest.headers["Content-Type"]=r}}function o(e){m.buildRequest(e),y.indexOf(e.httpRequest.method)<0&&i(e)}function n(e){c.extractError(e)}function u(e){m.extractData(e);var t,r=e.request,a=r.service.api.operations[r.operation],i=r.service.api.operations[r.operation].output||{};a.hasEventOutput;if(i.payload){var s=i.members[i.payload],o=e.httpResponse.body;if(s.isEventStream)t=new d,e.data[payload]=p.createEventStream(2===AWS.HttpClient.streamsApiVersion?e.httpResponse.stream:o,t,s);else if("structure"===s.type||"list"===s.type){var t=new d;e.data[i.payload]=t.parse(o,s)}else"binary"===s.type||s.isStreaming?e.data[i.payload]=o:e.data[i.payload]=s.toType(o)}else{var n=e.data;c.extractData(e),e.data=p.merge(n,e.data)}}var p=e("../util"),m=e("./rest"),c=e("./json"),l=e("../json/builder"),d=e("../json/parser"),y=["GET","HEAD","DELETE"];t.exports={buildRequest:o,extractError:n,extractData:u,unsetContentLength:a}},{"../json/builder":374,"../json/parser":375,"../util":428,"./json":386,"./rest":388}],390:[function(e,t,r){function a(e){var t=e.service.api.operations[e.operation].input,r=new n.XML.Builder,a=e.params,i=t.payload;if(i){var s=t.members[i];if(void 0===(a=a[i]))return;if("structure"===s.type){var o=s.name;e.httpRequest.body=r.toXML(a,s,o,!0)}else e.httpRequest.body=a}else e.httpRequest.body=r.toXML(a,t,t.name||t.shape||u.string.upperFirst(e.operation)+"Request")}function i(e){p.buildRequest(e),["GET","HEAD"].indexOf(e.httpRequest.method)<0&&a(e)}function s(e){p.extractError(e);var t;try{t=(new n.XML.Parser).parse(e.httpResponse.body.toString())}catch(r){t={Code:e.httpResponse.statusCode,Message:e.httpResponse.statusMessage}}t.Errors&&(t=t.Errors),t.Error&&(t=t.Error),t.Code?e.error=u.error(new Error,{code:t.Code,message:t.Message}):e.error=u.error(new Error,{code:e.httpResponse.statusCode,message:null})}function o(e){p.extractData(e);var t,r=e.request,a=e.httpResponse.body,i=r.service.api.operations[r.operation],s=i.output,o=(i.hasEventOutput,s.payload);if(o){var m=s.members[o];m.isEventStream?(t=new n.XML.Parser,e.data[o]=u.createEventStream(2===n.HttpClient.streamsApiVersion?e.httpResponse.stream:e.httpResponse.body,t,m)):"structure"===m.type?(t=new n.XML.Parser,e.data[o]=t.parse(a.toString(),m)):"binary"===m.type||m.isStreaming?e.data[o]=a:e.data[o]=m.toType(a)}else if(a.length>0){t=new n.XML.Parser;var c=t.parse(a.toString(),s);u.update(e.data,c)}}var n=e("../core"),u=e("../util"),p=e("./rest");t.exports={buildRequest:i,extractError:s,extractData:o}},{"../core":350,"../util":428,"./rest":388}],391:[function(e,t,r){function a(){}function i(e){return e.isQueryName||"ec2"!==e.api.protocol?e.name:e.name[0].toUpperCase()+e.name.substr(1)}function s(e,t,r,a){p.each(r.members,function(r,s){var o=t[r];if(null!==o&&void 0!==o){var n=i(s);n=e?e+"."+n:n,u(n,o,s,a)}})}function o(e,t,r,a){var i=1;p.each(t,function(t,s){var o=r.flattened?".":".entry.",n=o+i+++".",p=n+(r.key.name||"key"),m=n+(r.value.name||"value");u(e+p,t,r.key,a),u(e+m,s,r.value,a)})}function n(e,t,r,a){var s=r.member||{};if(0===t.length)return void a.call(this,e,null);p.arrayEach(t,function(t,o){var n="."+(o+1);if("ec2"===r.api.protocol)n+="";else if(r.flattened){if(s.name){var p=e.split(".");p.pop(),p.push(i(s)),e=p.join(".")}}else n="."+(s.name?s.name:"member")+n;u(e+n,t,s,a)})}function u(e,t,r,a){null!==t&&void 0!==t&&("structure"===r.type?s(e,t,r,a):"list"===r.type?n(e,t,r,a):"map"===r.type?o(e,t,r,a):a(e,r.toWireFormat(t).toString()))}var p=e("../util");a.prototype.serialize=function(e,t,r){s("",e,t,r)},t.exports=a},{"../util":428}],392:[function(e,t,r){var a=e("../core"),i=null,s={signatureVersion:"v4",signingName:"rds-db",operations:{}},o={region:"string",hostname:"string",port:"number",username:"string"};a.RDS.Signer=a.util.inherit({constructor:function(e){this.options=e||{}},convertUrlToAuthToken:function(e){if(0===e.indexOf("https://"))return e.substring("https://".length)},getAuthToken:function(e,t){"function"==typeof e&&void 0===t&&(t=e,e={});var r=this,o="function"==typeof t;e=a.util.merge(this.options,e);var n=this.validateAuthTokenOptions(e);if(!0!==n){if(o)return t(n,null);throw n}var u={region:e.region,endpoint:new a.Endpoint(e.hostname+":"+e.port),paramValidation:!1,signatureVersion:"v4"};e.credentials&&(u.credentials=e.credentials),i=new a.Service(u),i.api=s;var p=i.makeRequest();if(this.modifyRequestForAuthToken(p,e),!o){var m=p.presign(900);return this.convertUrlToAuthToken(m)}p.presign(900,function(e,a){a&&(a=r.convertUrlToAuthToken(a)),t(e,a)})},modifyRequestForAuthToken:function(e,t){e.on("build",e.buildAsGet),e.httpRequest.body=a.util.queryParamsToString({Action:"connect",DBUser:t.username})},validateAuthTokenOptions:function(e){var t="";e=e||{};for(var r in o)Object.prototype.hasOwnProperty.call(o,r)&&typeof e[r]!==o[r]&&(t+="option '"+r+"' should have been type '"+o[r]+"', was '"+typeof e[r]+"'.\n");return!t.length||a.util.error(new Error,{code:"InvalidParameter",message:t})}})},{"../core":350}],393:[function(e,t,r){t.exports={now:function(){return"undefined"!=typeof performance&&"function"==typeof performance.now?performance.now():Date.now()}}},{}],394:[function(e,t,r){function a(e){return"string"==typeof e&&(e.startsWith("fips-")||e.endsWith("-fips"))}function i(e){return"string"==typeof e&&["aws-global","aws-us-gov-global"].includes(e)}function s(e){return["fips-aws-global","aws-fips","aws-global"].includes(e)?"us-east-1":["fips-aws-us-gov-global","aws-us-gov-global"].includes(e)?"us-gov-west-1":e.replace(/fips-(dkr-|prod-)?|-fips/,"")}t.exports={isFipsRegion:a,isGlobalRegion:i,getRealRegion:s}},{}],395:[function(e,t,r){function a(e){if(!e)return null;var t=e.split("-");return t.length<3?null:t.slice(0,t.length-2).join("-")+"-*"}function i(e){var t=e.config.region,r=a(t),i=e.api.endpointPrefix;return[[t,i],[r,i],[t,"*"],[r,"*"],["*",i],[t,"internal-*"],["*","*"]].map(function(e){return e[0]&&e[1]?e.join("/"):null})}function s(e,t){u.each(t,function(t,r){"globalEndpoint"!==t&&(void 0!==e.config[t]&&null!==e.config[t]||(e.config[t]=r))})}function o(e){for(var t=i(e),r=e.config.useFipsEndpoint,a=e.config.useDualstackEndpoint,o=0;o=a())throw new RangeError("Attempt to allocate Buffer larger than maximum size: 0x"+a().toString(16)+" bytes");return 0|e}function b(e){return+e!=e&&(e=0),s.alloc(+e)}function S(e,t){if(s.isBuffer(e))return e.length;if("undefined"!=typeof ArrayBuffer&&"function"==typeof ArrayBuffer.isView&&(ArrayBuffer.isView(e)||e instanceof ArrayBuffer))return e.byteLength;"string"!=typeof e&&(e=""+e);var r=e.length;if(0===r)return 0;for(var a=!1;;)switch(t){case"ascii":case"latin1":case"binary":return r;case"utf8":case"utf-8":case void 0:return K(e).length;case"ucs2":case"ucs-2":case"utf16le":case"utf-16le":return 2*r;case"hex":return r>>>1;case"base64":return H(e).length;default:if(a)return K(e).length;t=(""+t).toLowerCase(),a=!0}}function g(e,t,r){var a=!1;if((void 0===t||t<0)&&(t=0),t>this.length)return"";if((void 0===r||r>this.length)&&(r=this.length),r<=0)return"";if(r>>>=0,t>>>=0,r<=t)return"";for(e||(e="utf8");;)switch(e){case"hex":return E(this,t,r);case"utf8":case"utf-8":return v(this,t,r);case"ascii":return P(this,t,r);case"latin1":case"binary":return q(this,t,r);case"base64":return D(this,t,r);case"ucs2":case"ucs-2":case"utf16le":case"utf-16le":return M(this,t,r);default:if(a)throw new TypeError("Unknown encoding: "+e);e=(e+"").toLowerCase(),a=!0}}function h(e,t,r){var a=e[t];e[t]=e[r],e[r]=a}function I(e,t,r,a,i){if(0===e.length)return-1;if("string"==typeof r?(a=r,r=0):r>2147483647?r=2147483647:r<-2147483648&&(r=-2147483648),r=+r,isNaN(r)&&(r=i?0:e.length-1),r<0&&(r=e.length+r),r>=e.length){if(i)return-1;r=e.length-1}else if(r<0){if(!i)return-1;r=0}if("string"==typeof t&&(t=s.from(t,a)),s.isBuffer(t))return 0===t.length?-1:N(e,t,r,a,i);if("number"==typeof t)return t&=255,s.TYPED_ARRAY_SUPPORT&&"function"==typeof Uint8Array.prototype.indexOf?i?Uint8Array.prototype.indexOf.call(e,t,r):Uint8Array.prototype.lastIndexOf.call(e,t,r):N(e,[t],r,a,i);throw new TypeError("val must be string, number or Buffer")}function N(e,t,r,a,i){function s(e,t){return 1===o?e[t]:e.readUInt16BE(t*o)}var o=1,n=e.length,u=t.length;if(void 0!==a&&("ucs2"===(a=String(a).toLowerCase())||"ucs-2"===a||"utf16le"===a||"utf-16le"===a)){if(e.length<2||t.length<2)return-1;o=2,n/=2,u/=2,r/=2}var p;if(i){var m=-1;for(p=r;p>>8*(a?i:1-i)}function B(e,t,r,a){t<0&&(t=4294967295+t+1);for(var i=0,s=Math.min(e.length-r,4);i>>8*(a?i:3-i)&255}function U(e,t,r,a,i,s){if(r+a>e.length)throw new RangeError("Index out of range");if(r<0)throw new RangeError("Index out of range")}function _(e,t,r,a,i){return i||U(e,t,r,4,3.4028234663852886e38,-3.4028234663852886e38),X.write(e,t,r,a,23,4),r+4}function F(e,t,r,a,i){return i||U(e,t,r,8,1.7976931348623157e308,-1.7976931348623157e308),X.write(e,t,r,a,52,8),r+8}function O(e){if(e=V(e).replace(ee,""),e.length<2)return"";for(;e.length%4!=0;)e+="=";return e}function V(e){return e.trim?e.trim():e.replace(/^\s+|\s+$/g,"")}function z(e){return e<16?"0"+e.toString(16):e.toString(16)}function K(e,t){t=t||1/0;for(var r,a=e.length,i=null,s=[],o=0;o55295&&r<57344){if(!i){if(r>56319){(t-=3)>-1&&s.push(239,191,189);continue}if(o+1===a){(t-=3)>-1&&s.push(239,191,189);continue}i=r;continue}if(r<56320){(t-=3)>-1&&s.push(239,191,189),i=r;continue}r=65536+(i-55296<<10|r-56320)}else i&&(t-=3)>-1&&s.push(239,191,189);if(i=null,r<128){if((t-=1)<0)break;s.push(r)}else if(r<2048){if((t-=2)<0)break;s.push(r>>6|192,63&r|128)}else if(r<65536){if((t-=3)<0)break;s.push(r>>12|224,r>>6&63|128,63&r|128)}else{if(!(r<1114112))throw new Error("Invalid code point");if((t-=4)<0)break;s.push(r>>18|240,r>>12&63|128,r>>6&63|128,63&r|128)}}return s}function j(e){for(var t=[],r=0;r