When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ReadonlyRootfs in the Create a container section of the Docker Remote API and the --read-only option to docker run.
When this parameter is true, the container is given elevated permissions on the host container instance (similar to the root user). This parameter maps to Privileged in the Create a container section of the Docker Remote API and the --privileged option to docker run. The default value is false.
This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided, or specified as false.
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.
When this parameter is specified, the container is run as a user with a uid other than 0. If this parameter isn't specified, so such rule is enforced. This parameter maps to RunAsUser and MustRunAsNonRoot policy in the Users and groups pod security policies in the Kubernetes documentation.
If this value is true, the container has read-only access to the volume. Otherwise, the container can write to the volume. The default value is false.
The AMI ID used for instances launched in the compute environment that match the image type. This setting overrides the imageId set in the computeResource object.
The AMI that you choose for a compute environment must match the architecture of the instance types that you intend to use for that compute environment. For example, if your compute environment uses A1 instance types, the compute resource AMI that you choose must support ARM instances. Amazon ECS vends both x86 and ARM versions of the Amazon ECS-optimized Amazon Linux 2 AMI. For more information, see Amazon ECS-optimized Amazon Linux 2 AMI in the Amazon Elastic Container Service Developer Guide.
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.
", + "refs": { + "ImagePullSecrets$member": null + } + }, + "ImagePullSecrets": { + "base": null, + "refs": { + "EksPodProperties$imagePullSecrets": "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.
Displays the reference pointer to the Kubernetes secret resource.
" + } + }, "ImageType": { "base": null, "refs": { @@ -1444,6 +1458,7 @@ "EvaluateOnExit$onExitCode": "Contains a glob pattern to match against the decimal representation of the ExitCode returned for a job. The pattern can be up to 512 characters long. It can contain only numbers, and can end with an asterisk (*) so that only the start of the string needs to be an exact match.
The string can contain up to 512 characters.
", "FargatePlatformConfiguration$platformVersion": "The Fargate platform version where the jobs are running. A platform version is specified only for jobs that are running on Fargate resources. If one isn't specified, the LATEST platform version is used by default. This uses a recent, approved version of the Fargate platform for compute resources. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.
The path on the host container instance that's presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If this parameter contains a file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the source path location doesn't exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.
This parameter isn't applicable to jobs that run on Fargate resources. Don't provide this for these jobs.
Provides a unique identifier for the ImagePullSecret. This object is required when EksPodProperties$imagePullSecrets is used.
The name of the job definition.
", "JobDefinition$jobDefinitionArn": "The Amazon Resource Name (ARN) for the job definition.
", "JobDefinition$status": "The status of the job definition.
", diff --git a/models/apis/bedrock-agent-runtime/2023-07-26/api-2.json b/models/apis/bedrock-agent-runtime/2023-07-26/api-2.json index 14f6990d199..1245c496c7c 100644 --- a/models/apis/bedrock-agent-runtime/2023-07-26/api-2.json +++ b/models/apis/bedrock-agent-runtime/2023-07-26/api-2.json @@ -1,934 +1,1370 @@ { - "version":"2.0", - "metadata":{ - "apiVersion":"2023-07-26", - "endpointPrefix":"bedrock-agent-runtime", - "jsonVersion":"1.1", - "protocol":"rest-json", - "serviceFullName":"Agents for Amazon Bedrock Runtime", - "serviceId":"Bedrock Agent Runtime", - "signatureVersion":"v4", - "signingName":"bedrock", - "uid":"bedrock-agent-runtime-2023-07-26" + "metadata": { + "apiVersion": "2023-07-26", + "endpointPrefix": "bedrock-agent-runtime", + "jsonVersion": "1.1", + "protocol": "rest-json", + "serviceFullName": "Agents for Amazon Bedrock Runtime", + "serviceId": "Bedrock Agent Runtime", + "signatureVersion": "v4", + "signingName": "bedrock", + "uid": "bedrock-agent-runtime-2023-07-26" }, - "operations":{ - "InvokeAgent":{ - "name":"InvokeAgent", - "http":{ - "method":"POST", - "requestUri":"/agents/{agentId}/agentAliases/{agentAliasId}/sessions/{sessionId}/text", - "responseCode":200 - }, - "input":{"shape":"InvokeAgentRequest"}, - "output":{"shape":"InvokeAgentResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ValidationException"}, - {"shape":"InternalServerException"}, - {"shape":"DependencyFailedException"}, - {"shape":"BadGatewayException"}, - {"shape":"ThrottlingException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ServiceQuotaExceededException"} - ] - }, - "Retrieve":{ - "name":"Retrieve", - "http":{ - "method":"POST", - "requestUri":"/knowledgebases/{knowledgeBaseId}/retrieve", - "responseCode":200 - }, - "input":{"shape":"RetrieveRequest"}, - "output":{"shape":"RetrieveResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ValidationException"}, - {"shape":"InternalServerException"}, - {"shape":"DependencyFailedException"}, - {"shape":"BadGatewayException"}, - {"shape":"ThrottlingException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ServiceQuotaExceededException"} - ] - }, - "RetrieveAndGenerate":{ - "name":"RetrieveAndGenerate", - "http":{ - "method":"POST", - "requestUri":"/retrieveAndGenerate", - "responseCode":200 - }, - "input":{"shape":"RetrieveAndGenerateRequest"}, - "output":{"shape":"RetrieveAndGenerateResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ValidationException"}, - {"shape":"InternalServerException"}, - {"shape":"DependencyFailedException"}, - {"shape":"BadGatewayException"}, - {"shape":"ThrottlingException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ServiceQuotaExceededException"} - ] - } - }, - "shapes":{ - "AccessDeniedException":{ - "type":"structure", - "members":{ - "message":{"shape":"NonBlankString"} - }, - "error":{ - "httpStatusCode":403, - "senderFault":true - }, - "exception":true - }, - "ActionGroupInvocationInput":{ - "type":"structure", - "members":{ - "actionGroupName":{"shape":"ActionGroupName"}, - "apiPath":{"shape":"ApiPath"}, - "parameters":{"shape":"Parameters"}, - "requestBody":{"shape":"RequestBody"}, - "verb":{"shape":"Verb"} + "operations": { + "InvokeAgent": { + "errors": [ + { + "shape": "ConflictException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "DependencyFailedException" + }, + { + "shape": "BadGatewayException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ServiceQuotaExceededException" + } + ], + "http": { + "method": "POST", + "requestUri": "/agents/{agentId}/agentAliases/{agentAliasId}/sessions/{sessionId}/text", + "responseCode": 200 + }, + "input": { + "shape": "InvokeAgentRequest" + }, + "name": "InvokeAgent", + "output": { + "shape": "InvokeAgentResponse" } }, - "ActionGroupInvocationOutput":{ - "type":"structure", - "members":{ - "text":{"shape":"ActionGroupOutputString"} + "Retrieve": { + "errors": [ + { + "shape": "ConflictException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "DependencyFailedException" + }, + { + "shape": "BadGatewayException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ServiceQuotaExceededException" + } + ], + "http": { + "method": "POST", + "requestUri": "/knowledgebases/{knowledgeBaseId}/retrieve", + "responseCode": 200 + }, + "input": { + "shape": "RetrieveRequest" + }, + "name": "Retrieve", + "output": { + "shape": "RetrieveResponse" } }, - "ActionGroupName":{ - "type":"string", - "sensitive":true - }, - "ActionGroupOutputString":{ - "type":"string", - "sensitive":true - }, - "AgentAliasId":{ - "type":"string", - "max":10, - "min":0, - "pattern":"^[0-9a-zA-Z]+$" - }, - "AgentId":{ - "type":"string", - "max":10, - "min":0, - "pattern":"^[0-9a-zA-Z]+$" - }, - "ApiPath":{ - "type":"string", - "sensitive":true - }, - "Attribution":{ - "type":"structure", - "members":{ - "citations":{"shape":"Citations"} + "RetrieveAndGenerate": { + "errors": [ + { + "shape": "ConflictException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "DependencyFailedException" + }, + { + "shape": "BadGatewayException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ServiceQuotaExceededException" + } + ], + "http": { + "method": "POST", + "requestUri": "/retrieveAndGenerate", + "responseCode": 200 + }, + "input": { + "shape": "RetrieveAndGenerateRequest" + }, + "name": "RetrieveAndGenerate", + "output": { + "shape": "RetrieveAndGenerateResponse" } + } + }, + "shapes": { + "AccessDeniedException": { + "error": { + "httpStatusCode": 403, + "senderFault": true + }, + "exception": true, + "members": { + "message": { + "shape": "NonBlankString" + } + }, + "type": "structure" }, - "BadGatewayException":{ - "type":"structure", - "members":{ - "message":{"shape":"NonBlankString"}, - "resourceName":{"shape":"NonBlankString"} - }, - "error":{"httpStatusCode":502}, - "exception":true, - "fault":true - }, - "BedrockModelArn":{ - "type":"string", - "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}))$" - }, - "Boolean":{ - "type":"boolean", - "box":true - }, - "Citation":{ - "type":"structure", - "members":{ - "generatedResponsePart":{"shape":"GeneratedResponsePart"}, - "retrievedReferences":{"shape":"RetrievedReferences"} - } + "ActionGroupInvocationInput": { + "members": { + "actionGroupName": { + "shape": "ActionGroupName" + }, + "apiPath": { + "shape": "ApiPath" + }, + "parameters": { + "shape": "Parameters" + }, + "requestBody": { + "shape": "RequestBody" + }, + "verb": { + "shape": "Verb" + } + }, + "type": "structure" }, - "Citations":{ - "type":"list", - "member":{"shape":"Citation"} + "ActionGroupInvocationOutput": { + "members": { + "text": { + "shape": "ActionGroupOutputString" + } + }, + "type": "structure" + }, + "ActionGroupName": { + "sensitive": true, + "type": "string" + }, + "ActionGroupOutputString": { + "sensitive": true, + "type": "string" + }, + "AgentAliasId": { + "max": 10, + "min": 0, + "pattern": "^[0-9a-zA-Z]+$", + "type": "string" + }, + "AgentId": { + "max": 10, + "min": 0, + "pattern": "^[0-9a-zA-Z]+$", + "type": "string" + }, + "ApiPath": { + "sensitive": true, + "type": "string" + }, + "Attribution": { + "members": { + "citations": { + "shape": "Citations" + } + }, + "type": "structure" }, - "ConflictException":{ - "type":"structure", - "members":{ - "message":{"shape":"NonBlankString"} + "BadGatewayException": { + "error": { + "httpStatusCode": 502 }, - "error":{ - "httpStatusCode":409, - "senderFault":true + "exception": true, + "fault": true, + "members": { + "message": { + "shape": "NonBlankString" + }, + "resourceName": { + "shape": "NonBlankString" + } + }, + "type": "structure" + }, + "BedrockModelArn": { + "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}))$", + "type": "string" + }, + "Boolean": { + "box": true, + "type": "boolean" + }, + "Citation": { + "members": { + "generatedResponsePart": { + "shape": "GeneratedResponsePart" + }, + "retrievedReferences": { + "shape": "RetrievedReferences" + } }, - "exception":true + "type": "structure" }, - "ContentMap":{ - "type":"map", - "key":{"shape":"String"}, - "value":{"shape":"Parameters"} + "Citations": { + "member": { + "shape": "Citation" + }, + "type": "list" }, - "CreationMode":{ - "type":"string", - "enum":[ + "ConflictException": { + "error": { + "httpStatusCode": 409, + "senderFault": true + }, + "exception": true, + "members": { + "message": { + "shape": "NonBlankString" + } + }, + "type": "structure" + }, + "ContentMap": { + "key": { + "shape": "String" + }, + "type": "map", + "value": { + "shape": "Parameters" + } + }, + "CreationMode": { + "enum": [ "DEFAULT", "OVERRIDDEN" - ] + ], + "type": "string" }, - "DependencyFailedException":{ - "type":"structure", - "members":{ - "message":{"shape":"NonBlankString"}, - "resourceName":{"shape":"NonBlankString"} + "DependencyFailedException": { + "error": { + "httpStatusCode": 424, + "senderFault": true }, - "error":{ - "httpStatusCode":424, - "senderFault":true + "exception": true, + "members": { + "message": { + "shape": "NonBlankString" + }, + "resourceName": { + "shape": "NonBlankString" + } }, - "exception":true + "type": "structure" }, - "Double":{ - "type":"double", - "box":true + "Double": { + "box": true, + "type": "double" }, - "FailureReasonString":{ - "type":"string", - "sensitive":true + "FailureReasonString": { + "sensitive": true, + "type": "string" }, - "FailureTrace":{ - "type":"structure", - "members":{ - "failureReason":{"shape":"FailureReasonString"}, - "traceId":{"shape":"TraceId"} + "FailureTrace": { + "members": { + "failureReason": { + "shape": "FailureReasonString" + }, + "traceId": { + "shape": "TraceId" + } + }, + "sensitive": true, + "type": "structure" + }, + "FilterKey": { + "max": 100, + "min": 1, + "type": "string" + }, + "FinalResponse": { + "members": { + "text": { + "shape": "FinalResponseString" + } }, - "sensitive":true + "type": "structure" }, - "FinalResponse":{ - "type":"structure", - "members":{ - "text":{"shape":"FinalResponseString"} - } + "FinalResponseString": { + "sensitive": true, + "type": "string" }, - "FinalResponseString":{ - "type":"string", - "sensitive":true + "GeneratedResponsePart": { + "members": { + "textResponsePart": { + "shape": "TextResponsePart" + } + }, + "type": "structure" }, - "GeneratedResponsePart":{ - "type":"structure", - "members":{ - "textResponsePart":{"shape":"TextResponsePart"} - } + "GenerationConfiguration": { + "members": { + "promptTemplate": { + "shape": "PromptTemplate" + } + }, + "type": "structure" }, - "GenerationConfiguration":{ - "type":"structure", - "members":{ - "promptTemplate":{"shape":"PromptTemplate"} - } + "InferenceConfiguration": { + "members": { + "maximumLength": { + "shape": "MaximumLength" + }, + "stopSequences": { + "shape": "StopSequences" + }, + "temperature": { + "shape": "Temperature" + }, + "topK": { + "shape": "TopK" + }, + "topP": { + "shape": "TopP" + } + }, + "type": "structure" }, - "InferenceConfiguration":{ - "type":"structure", - "members":{ - "maximumLength":{"shape":"MaximumLength"}, - "stopSequences":{"shape":"StopSequences"}, - "temperature":{"shape":"Temperature"}, - "topK":{"shape":"TopK"}, - "topP":{"shape":"TopP"} - } + "InputText": { + "max": 25000000, + "min": 0, + "sensitive": true, + "type": "string" }, - "InputText":{ - "type":"string", - "max":25000000, - "min":0, - "sensitive":true - }, - "InternalServerException":{ - "type":"structure", - "members":{ - "message":{"shape":"NonBlankString"} - }, - "error":{"httpStatusCode":500}, - "exception":true, - "fault":true - }, - "InvocationInput":{ - "type":"structure", - "members":{ - "actionGroupInvocationInput":{"shape":"ActionGroupInvocationInput"}, - "invocationType":{"shape":"InvocationType"}, - "knowledgeBaseLookupInput":{"shape":"KnowledgeBaseLookupInput"}, - "traceId":{"shape":"TraceId"} - }, - "sensitive":true - }, - "InvocationType":{ - "type":"string", - "enum":[ + "InternalServerException": { + "error": { + "httpStatusCode": 500 + }, + "exception": true, + "fault": true, + "members": { + "message": { + "shape": "NonBlankString" + } + }, + "type": "structure" + }, + "InvocationInput": { + "members": { + "actionGroupInvocationInput": { + "shape": "ActionGroupInvocationInput" + }, + "invocationType": { + "shape": "InvocationType" + }, + "knowledgeBaseLookupInput": { + "shape": "KnowledgeBaseLookupInput" + }, + "traceId": { + "shape": "TraceId" + } + }, + "sensitive": true, + "type": "structure" + }, + "InvocationType": { + "enum": [ "ACTION_GROUP", "KNOWLEDGE_BASE", "FINISH" - ] - }, - "InvokeAgentRequest":{ - "type":"structure", - "required":[ + ], + "type": "string" + }, + "InvokeAgentRequest": { + "members": { + "agentAliasId": { + "location": "uri", + "locationName": "agentAliasId", + "shape": "AgentAliasId" + }, + "agentId": { + "location": "uri", + "locationName": "agentId", + "shape": "AgentId" + }, + "enableTrace": { + "shape": "Boolean" + }, + "endSession": { + "shape": "Boolean" + }, + "inputText": { + "shape": "InputText" + }, + "sessionId": { + "location": "uri", + "locationName": "sessionId", + "shape": "SessionId" + }, + "sessionState": { + "shape": "SessionState" + } + }, + "required": [ "agentAliasId", "agentId", "inputText", "sessionId" ], - "members":{ - "agentAliasId":{ - "shape":"AgentAliasId", - "location":"uri", - "locationName":"agentAliasId" - }, - "agentId":{ - "shape":"AgentId", - "location":"uri", - "locationName":"agentId" - }, - "enableTrace":{"shape":"Boolean"}, - "endSession":{"shape":"Boolean"}, - "inputText":{"shape":"InputText"}, - "sessionId":{ - "shape":"SessionId", - "location":"uri", - "locationName":"sessionId" - }, - "sessionState":{"shape":"SessionState"} - } + "type": "structure" }, - "InvokeAgentResponse":{ - "type":"structure", - "required":[ + "InvokeAgentResponse": { + "members": { + "completion": { + "shape": "ResponseStream" + }, + "contentType": { + "location": "header", + "locationName": "x-amzn-bedrock-agent-content-type", + "shape": "MimeType" + }, + "sessionId": { + "location": "header", + "locationName": "x-amz-bedrock-agent-session-id", + "shape": "SessionId" + } + }, + "payload": "completion", + "required": [ "completion", "contentType", "sessionId" ], - "members":{ - "completion":{"shape":"ResponseStream"}, - "contentType":{ - "shape":"MimeType", - "location":"header", - "locationName":"x-amzn-bedrock-agent-content-type" - }, - "sessionId":{ - "shape":"SessionId", - "location":"header", - "locationName":"x-amz-bedrock-agent-session-id" - } - }, - "payload":"completion" - }, - "KmsKeyArn":{ - "type":"string", - "max":2048, - "min":1, - "pattern":"^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$" - }, - "KnowledgeBaseId":{ - "type":"string", - "max":10, - "min":0, - "pattern":"^[0-9a-zA-Z]+$" - }, - "KnowledgeBaseLookupInput":{ - "type":"structure", - "members":{ - "knowledgeBaseId":{"shape":"TraceKnowledgeBaseId"}, - "text":{"shape":"KnowledgeBaseLookupInputString"} - } - }, - "KnowledgeBaseLookupInputString":{ - "type":"string", - "sensitive":true + "type": "structure" + }, + "KmsKeyArn": { + "max": 2048, + "min": 1, + "pattern": "^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$", + "type": "string" + }, + "KnowledgeBaseId": { + "max": 10, + "min": 0, + "pattern": "^[0-9a-zA-Z]+$", + "type": "string" + }, + "KnowledgeBaseLookupInput": { + "members": { + "knowledgeBaseId": { + "shape": "TraceKnowledgeBaseId" + }, + "text": { + "shape": "KnowledgeBaseLookupInputString" + } + }, + "type": "structure" }, - "KnowledgeBaseLookupOutput":{ - "type":"structure", - "members":{ - "retrievedReferences":{"shape":"RetrievedReferences"} - } + "KnowledgeBaseLookupInputString": { + "sensitive": true, + "type": "string" }, - "KnowledgeBaseQuery":{ - "type":"structure", - "required":["text"], - "members":{ - "text":{"shape":"KnowledgeBaseQueryTextString"} + "KnowledgeBaseLookupOutput": { + "members": { + "retrievedReferences": { + "shape": "RetrievedReferences" + } }, - "sensitive":true - }, - "KnowledgeBaseQueryTextString":{ - "type":"string", - "max":1000, - "min":0 + "type": "structure" }, - "KnowledgeBaseRetrievalConfiguration":{ - "type":"structure", - "required":["vectorSearchConfiguration"], - "members":{ - "vectorSearchConfiguration":{"shape":"KnowledgeBaseVectorSearchConfiguration"} - } + "KnowledgeBaseQuery": { + "members": { + "text": { + "shape": "KnowledgeBaseQueryTextString" + } + }, + "required": [ + "text" + ], + "sensitive": true, + "type": "structure" + }, + "KnowledgeBaseQueryTextString": { + "max": 1000, + "min": 0, + "type": "string" + }, + "KnowledgeBaseRetrievalConfiguration": { + "members": { + "vectorSearchConfiguration": { + "shape": "KnowledgeBaseVectorSearchConfiguration" + } + }, + "required": [ + "vectorSearchConfiguration" + ], + "type": "structure" }, - "KnowledgeBaseRetrievalResult":{ - "type":"structure", - "required":["content"], - "members":{ - "content":{"shape":"RetrievalResultContent"}, - "location":{"shape":"RetrievalResultLocation"}, - "score":{"shape":"Double"} - } + "KnowledgeBaseRetrievalResult": { + "members": { + "content": { + "shape": "RetrievalResultContent" + }, + "location": { + "shape": "RetrievalResultLocation" + }, + "score": { + "shape": "Double" + } + }, + "required": [ + "content" + ], + "type": "structure" }, - "KnowledgeBaseRetrievalResults":{ - "type":"list", - "member":{"shape":"KnowledgeBaseRetrievalResult"}, - "sensitive":true + "KnowledgeBaseRetrievalResults": { + "member": { + "shape": "KnowledgeBaseRetrievalResult" + }, + "sensitive": true, + "type": "list" }, - "KnowledgeBaseRetrieveAndGenerateConfiguration":{ - "type":"structure", - "required":[ + "KnowledgeBaseRetrieveAndGenerateConfiguration": { + "members": { + "generationConfiguration": { + "shape": "GenerationConfiguration" + }, + "knowledgeBaseId": { + "shape": "KnowledgeBaseId" + }, + "modelArn": { + "shape": "BedrockModelArn" + }, + "retrievalConfiguration": { + "shape": "KnowledgeBaseRetrievalConfiguration" + } + }, + "required": [ "knowledgeBaseId", "modelArn" ], - "members":{ - "generationConfiguration":{"shape":"GenerationConfiguration"}, - "knowledgeBaseId":{"shape":"KnowledgeBaseId"}, - "modelArn":{"shape":"BedrockModelArn"}, - "retrievalConfiguration":{"shape":"KnowledgeBaseRetrievalConfiguration"} - } + "type": "structure" }, - "KnowledgeBaseVectorSearchConfiguration":{ - "type":"structure", - "members":{ - "numberOfResults":{ - "shape":"KnowledgeBaseVectorSearchConfigurationNumberOfResultsInteger", - "box":true + "KnowledgeBaseVectorSearchConfiguration": { + "members": { + "filter": { + "shape": "RetrievalFilter" }, - "overrideSearchType":{"shape":"SearchType"} - } + "numberOfResults": { + "box": true, + "shape": "KnowledgeBaseVectorSearchConfigurationNumberOfResultsInteger" + }, + "overrideSearchType": { + "shape": "SearchType" + } + }, + "type": "structure" + }, + "KnowledgeBaseVectorSearchConfigurationNumberOfResultsInteger": { + "box": true, + "max": 100, + "min": 1, + "type": "integer" + }, + "LambdaArn": { + "type": "string" + }, + "MaximumLength": { + "box": true, + "max": 4096, + "min": 0, + "type": "integer" + }, + "MimeType": { + "type": "string" + }, + "ModelInvocationInput": { + "members": { + "inferenceConfiguration": { + "shape": "InferenceConfiguration" + }, + "overrideLambda": { + "shape": "LambdaArn" + }, + "parserMode": { + "shape": "CreationMode" + }, + "promptCreationMode": { + "shape": "CreationMode" + }, + "text": { + "shape": "PromptText" + }, + "traceId": { + "shape": "TraceId" + }, + "type": { + "shape": "PromptType" + } + }, + "sensitive": true, + "type": "structure" + }, + "NextToken": { + "max": 2048, + "min": 1, + "pattern": "^\\S*$", + "type": "string" + }, + "NonBlankString": { + "pattern": "^[\\s\\S]*$", + "type": "string" + }, + "Observation": { + "members": { + "actionGroupInvocationOutput": { + "shape": "ActionGroupInvocationOutput" + }, + "finalResponse": { + "shape": "FinalResponse" + }, + "knowledgeBaseLookupOutput": { + "shape": "KnowledgeBaseLookupOutput" + }, + "repromptResponse": { + "shape": "RepromptResponse" + }, + "traceId": { + "shape": "TraceId" + }, + "type": { + "shape": "Type" + } + }, + "sensitive": true, + "type": "structure" }, - "KnowledgeBaseVectorSearchConfigurationNumberOfResultsInteger":{ - "type":"integer", - "box":true, - "max":100, - "min":1 - }, - "LambdaArn":{"type":"string"}, - "MaximumLength":{ - "type":"integer", - "box":true, - "max":4096, - "min":0 - }, - "MimeType":{"type":"string"}, - "ModelInvocationInput":{ - "type":"structure", - "members":{ - "inferenceConfiguration":{"shape":"InferenceConfiguration"}, - "overrideLambda":{"shape":"LambdaArn"}, - "parserMode":{"shape":"CreationMode"}, - "promptCreationMode":{"shape":"CreationMode"}, - "text":{"shape":"PromptText"}, - "traceId":{"shape":"TraceId"}, - "type":{"shape":"PromptType"} - }, - "sensitive":true - }, - "NextToken":{ - "type":"string", - "max":2048, - "min":1, - "pattern":"^\\S*$" - }, - "NonBlankString":{ - "type":"string", - "pattern":"^[\\s\\S]*$" - }, - "Observation":{ - "type":"structure", - "members":{ - "actionGroupInvocationOutput":{"shape":"ActionGroupInvocationOutput"}, - "finalResponse":{"shape":"FinalResponse"}, - "knowledgeBaseLookupOutput":{"shape":"KnowledgeBaseLookupOutput"}, - "repromptResponse":{"shape":"RepromptResponse"}, - "traceId":{"shape":"TraceId"}, - "type":{"shape":"Type"} - }, - "sensitive":true - }, - "OrchestrationTrace":{ - "type":"structure", - "members":{ - "invocationInput":{"shape":"InvocationInput"}, - "modelInvocationInput":{"shape":"ModelInvocationInput"}, - "observation":{"shape":"Observation"}, - "rationale":{"shape":"Rationale"} - }, - "sensitive":true, - "union":true - }, - "OutputString":{ - "type":"string", - "sensitive":true - }, - "Parameter":{ - "type":"structure", - "members":{ - "name":{"shape":"String"}, - "type":{"shape":"String"}, - "value":{"shape":"String"} - } + "OrchestrationTrace": { + "members": { + "invocationInput": { + "shape": "InvocationInput" + }, + "modelInvocationInput": { + "shape": "ModelInvocationInput" + }, + "observation": { + "shape": "Observation" + }, + "rationale": { + "shape": "Rationale" + } + }, + "sensitive": true, + "type": "structure", + "union": true + }, + "OutputString": { + "sensitive": true, + "type": "string" + }, + "Parameter": { + "members": { + "name": { + "shape": "String" + }, + "type": { + "shape": "String" + }, + "value": { + "shape": "String" + } + }, + "type": "structure" }, - "Parameters":{ - "type":"list", - "member":{"shape":"Parameter"} - }, - "PartBody":{ - "type":"blob", - "max":1000000, - "min":0, - "sensitive":true - }, - "PayloadPart":{ - "type":"structure", - "members":{ - "attribution":{"shape":"Attribution"}, - "bytes":{"shape":"PartBody"} - }, - "event":true, - "sensitive":true - }, - "PostProcessingModelInvocationOutput":{ - "type":"structure", - "members":{ - "parsedResponse":{"shape":"PostProcessingParsedResponse"}, - "traceId":{"shape":"TraceId"} - }, - "sensitive":true - }, - "PostProcessingParsedResponse":{ - "type":"structure", - "members":{ - "text":{"shape":"OutputString"} - }, - "sensitive":true - }, - "PostProcessingTrace":{ - "type":"structure", - "members":{ - "modelInvocationInput":{"shape":"ModelInvocationInput"}, - "modelInvocationOutput":{"shape":"PostProcessingModelInvocationOutput"} - }, - "sensitive":true, - "union":true - }, - "PreProcessingModelInvocationOutput":{ - "type":"structure", - "members":{ - "parsedResponse":{"shape":"PreProcessingParsedResponse"}, - "traceId":{"shape":"TraceId"} - }, - "sensitive":true - }, - "PreProcessingParsedResponse":{ - "type":"structure", - "members":{ - "isValid":{"shape":"Boolean"}, - "rationale":{"shape":"RationaleString"} - }, - "sensitive":true - }, - "PreProcessingTrace":{ - "type":"structure", - "members":{ - "modelInvocationInput":{"shape":"ModelInvocationInput"}, - "modelInvocationOutput":{"shape":"PreProcessingModelInvocationOutput"} - }, - "sensitive":true, - "union":true - }, - "PromptSessionAttributesMap":{ - "type":"map", - "key":{"shape":"String"}, - "value":{"shape":"String"} - }, - "PromptTemplate":{ - "type":"structure", - "members":{ - "textPromptTemplate":{"shape":"TextPromptTemplate"} + "Parameters": { + "member": { + "shape": "Parameter" + }, + "type": "list" + }, + "PartBody": { + "max": 1000000, + "min": 0, + "sensitive": true, + "type": "blob" + }, + "PayloadPart": { + "event": true, + "members": { + "attribution": { + "shape": "Attribution" + }, + "bytes": { + "shape": "PartBody" + } + }, + "sensitive": true, + "type": "structure" + }, + "PostProcessingModelInvocationOutput": { + "members": { + "parsedResponse": { + "shape": "PostProcessingParsedResponse" + }, + "traceId": { + "shape": "TraceId" + } + }, + "sensitive": true, + "type": "structure" + }, + "PostProcessingParsedResponse": { + "members": { + "text": { + "shape": "OutputString" + } + }, + "sensitive": true, + "type": "structure" + }, + "PostProcessingTrace": { + "members": { + "modelInvocationInput": { + "shape": "ModelInvocationInput" + }, + "modelInvocationOutput": { + "shape": "PostProcessingModelInvocationOutput" + } + }, + "sensitive": true, + "type": "structure", + "union": true + }, + "PreProcessingModelInvocationOutput": { + "members": { + "parsedResponse": { + "shape": "PreProcessingParsedResponse" + }, + "traceId": { + "shape": "TraceId" + } + }, + "sensitive": true, + "type": "structure" + }, + "PreProcessingParsedResponse": { + "members": { + "isValid": { + "shape": "Boolean" + }, + "rationale": { + "shape": "RationaleString" + } + }, + "sensitive": true, + "type": "structure" + }, + "PreProcessingTrace": { + "members": { + "modelInvocationInput": { + "shape": "ModelInvocationInput" + }, + "modelInvocationOutput": { + "shape": "PreProcessingModelInvocationOutput" + } + }, + "sensitive": true, + "type": "structure", + "union": true + }, + "PromptSessionAttributesMap": { + "key": { + "shape": "String" + }, + "type": "map", + "value": { + "shape": "String" } }, - "PromptText":{ - "type":"string", - "sensitive":true + "PromptTemplate": { + "members": { + "textPromptTemplate": { + "shape": "TextPromptTemplate" + } + }, + "type": "structure" + }, + "PromptText": { + "sensitive": true, + "type": "string" }, - "PromptType":{ - "type":"string", - "enum":[ + "PromptType": { + "enum": [ "PRE_PROCESSING", "ORCHESTRATION", "KNOWLEDGE_BASE_RESPONSE_GENERATION", "POST_PROCESSING" - ] + ], + "type": "string" + }, + "Rationale": { + "members": { + "text": { + "shape": "RationaleString" + }, + "traceId": { + "shape": "TraceId" + } + }, + "sensitive": true, + "type": "structure" }, - "Rationale":{ - "type":"structure", - "members":{ - "text":{"shape":"RationaleString"}, - "traceId":{"shape":"TraceId"} + "RationaleString": { + "sensitive": true, + "type": "string" + }, + "RepromptResponse": { + "members": { + "source": { + "shape": "Source" + }, + "text": { + "shape": "String" + } }, - "sensitive":true + "sensitive": true, + "type": "structure" }, - "RationaleString":{ - "type":"string", - "sensitive":true + "RequestBody": { + "members": { + "content": { + "shape": "ContentMap" + } + }, + "type": "structure" }, - "RepromptResponse":{ - "type":"structure", - "members":{ - "source":{"shape":"Source"}, - "text":{"shape":"String"} + "ResourceNotFoundException": { + "error": { + "httpStatusCode": 404, + "senderFault": true }, - "sensitive":true + "exception": true, + "members": { + "message": { + "shape": "NonBlankString" + } + }, + "type": "structure" }, - "RequestBody":{ - "type":"structure", - "members":{ - "content":{"shape":"ContentMap"} - } + "ResponseStream": { + "eventstream": true, + "members": { + "accessDeniedException": { + "shape": "AccessDeniedException" + }, + "badGatewayException": { + "shape": "BadGatewayException" + }, + "chunk": { + "shape": "PayloadPart" + }, + "conflictException": { + "shape": "ConflictException" + }, + "dependencyFailedException": { + "shape": "DependencyFailedException" + }, + "internalServerException": { + "shape": "InternalServerException" + }, + "resourceNotFoundException": { + "shape": "ResourceNotFoundException" + }, + "serviceQuotaExceededException": { + "shape": "ServiceQuotaExceededException" + }, + "throttlingException": { + "shape": "ThrottlingException" + }, + "trace": { + "shape": "TracePart" + }, + "validationException": { + "shape": "ValidationException" + } + }, + "type": "structure" }, - "ResourceNotFoundException":{ - "type":"structure", - "members":{ - "message":{"shape":"NonBlankString"} - }, - "error":{ - "httpStatusCode":404, - "senderFault":true - }, - "exception":true - }, - "ResponseStream":{ - "type":"structure", - "members":{ - "accessDeniedException":{"shape":"AccessDeniedException"}, - "badGatewayException":{"shape":"BadGatewayException"}, - "chunk":{"shape":"PayloadPart"}, - "conflictException":{"shape":"ConflictException"}, - "dependencyFailedException":{"shape":"DependencyFailedException"}, - "internalServerException":{"shape":"InternalServerException"}, - "resourceNotFoundException":{"shape":"ResourceNotFoundException"}, - "serviceQuotaExceededException":{"shape":"ServiceQuotaExceededException"}, - "throttlingException":{"shape":"ThrottlingException"}, - "trace":{"shape":"TracePart"}, - "validationException":{"shape":"ValidationException"} - }, - "eventstream":true - }, - "RetrievalResultContent":{ - "type":"structure", - "required":["text"], - "members":{ - "text":{"shape":"String"} - }, - "sensitive":true - }, - "RetrievalResultLocation":{ - "type":"structure", - "required":["type"], - "members":{ - "s3Location":{"shape":"RetrievalResultS3Location"}, - "type":{"shape":"RetrievalResultLocationType"} - }, - "sensitive":true - }, - "RetrievalResultLocationType":{ - "type":"string", - "enum":["S3"] - }, - "RetrievalResultS3Location":{ - "type":"structure", - "members":{ - "uri":{"shape":"String"} - } + "RetrievalFilter": { + "members": { + "andAll": { + "shape": "RetrievalFilterList" + }, + "orAll": { + "shape": "RetrievalFilterList" + } + }, + "sensitive": true, + "type": "structure", + "union": true + }, + "RetrievalFilterList": { + "max": 5, + "member": { + "shape": "RetrievalFilter" + }, + "min": 2, + "type": "list" }, - "RetrieveAndGenerateConfiguration":{ - "type":"structure", - "required":["type"], - "members":{ - "knowledgeBaseConfiguration":{"shape":"KnowledgeBaseRetrieveAndGenerateConfiguration"}, - "type":{"shape":"RetrieveAndGenerateType"} - } + "RetrievalResultContent": { + "members": { + "text": { + "shape": "String" + } + }, + "required": [ + "text" + ], + "sensitive": true, + "type": "structure" }, - "RetrieveAndGenerateInput":{ - "type":"structure", - "required":["text"], - "members":{ - "text":{"shape":"RetrieveAndGenerateInputTextString"} - }, - "sensitive":true - }, - "RetrieveAndGenerateInputTextString":{ - "type":"string", - "max":1000, - "min":0 - }, - "RetrieveAndGenerateOutput":{ - "type":"structure", - "required":["text"], - "members":{ - "text":{"shape":"String"} - }, - "sensitive":true - }, - "RetrieveAndGenerateRequest":{ - "type":"structure", - "required":["input"], - "members":{ - "input":{"shape":"RetrieveAndGenerateInput"}, - "retrieveAndGenerateConfiguration":{"shape":"RetrieveAndGenerateConfiguration"}, - "sessionConfiguration":{"shape":"RetrieveAndGenerateSessionConfiguration"}, - "sessionId":{"shape":"SessionId"} - } + "RetrievalResultLocation": { + "members": { + "s3Location": { + "shape": "RetrievalResultS3Location" + }, + "type": { + "shape": "RetrievalResultLocationType" + } + }, + "required": [ + "type" + ], + "sensitive": true, + "type": "structure" + }, + "RetrievalResultLocationType": { + "enum": [ + "S3" + ], + "type": "string" + }, + "RetrievalResultMetadataKey": { + "max": 100, + "min": 1, + "type": "string" + }, + "RetrievalResultS3Location": { + "members": { + "uri": { + "shape": "String" + } + }, + "type": "structure" + }, + "RetrieveAndGenerateConfiguration": { + "members": { + "knowledgeBaseConfiguration": { + "shape": "KnowledgeBaseRetrieveAndGenerateConfiguration" + }, + "type": { + "shape": "RetrieveAndGenerateType" + } + }, + "required": [ + "type" + ], + "type": "structure" + }, + "RetrieveAndGenerateInput": { + "members": { + "text": { + "shape": "RetrieveAndGenerateInputTextString" + } + }, + "required": [ + "text" + ], + "sensitive": true, + "type": "structure" + }, + "RetrieveAndGenerateInputTextString": { + "max": 1000, + "min": 0, + "type": "string" + }, + "RetrieveAndGenerateOutput": { + "members": { + "text": { + "shape": "String" + } + }, + "required": [ + "text" + ], + "sensitive": true, + "type": "structure" }, - "RetrieveAndGenerateResponse":{ - "type":"structure", - "required":[ + "RetrieveAndGenerateRequest": { + "members": { + "input": { + "shape": "RetrieveAndGenerateInput" + }, + "retrieveAndGenerateConfiguration": { + "shape": "RetrieveAndGenerateConfiguration" + }, + "sessionConfiguration": { + "shape": "RetrieveAndGenerateSessionConfiguration" + }, + "sessionId": { + "shape": "SessionId" + } + }, + "required": [ + "input" + ], + "type": "structure" + }, + "RetrieveAndGenerateResponse": { + "members": { + "citations": { + "shape": "Citations" + }, + "output": { + "shape": "RetrieveAndGenerateOutput" + }, + "sessionId": { + "shape": "SessionId" + } + }, + "required": [ "output", "sessionId" ], - "members":{ - "citations":{"shape":"Citations"}, - "output":{"shape":"RetrieveAndGenerateOutput"}, - "sessionId":{"shape":"SessionId"} - } + "type": "structure" }, - "RetrieveAndGenerateSessionConfiguration":{ - "type":"structure", - "required":["kmsKeyArn"], - "members":{ - "kmsKeyArn":{"shape":"KmsKeyArn"} - } - }, - "RetrieveAndGenerateType":{ - "type":"string", - "enum":["KNOWLEDGE_BASE"] + "RetrieveAndGenerateSessionConfiguration": { + "members": { + "kmsKeyArn": { + "shape": "KmsKeyArn" + } + }, + "required": [ + "kmsKeyArn" + ], + "type": "structure" }, - "RetrieveRequest":{ - "type":"structure", - "required":[ + "RetrieveAndGenerateType": { + "enum": [ + "KNOWLEDGE_BASE" + ], + "type": "string" + }, + "RetrieveRequest": { + "members": { + "knowledgeBaseId": { + "location": "uri", + "locationName": "knowledgeBaseId", + "shape": "KnowledgeBaseId" + }, + "nextToken": { + "shape": "NextToken" + }, + "retrievalConfiguration": { + "shape": "KnowledgeBaseRetrievalConfiguration" + }, + "retrievalQuery": { + "shape": "KnowledgeBaseQuery" + } + }, + "required": [ "knowledgeBaseId", "retrievalQuery" ], - "members":{ - "knowledgeBaseId":{ - "shape":"KnowledgeBaseId", - "location":"uri", - "locationName":"knowledgeBaseId" - }, - "nextToken":{"shape":"NextToken"}, - "retrievalConfiguration":{"shape":"KnowledgeBaseRetrievalConfiguration"}, - "retrievalQuery":{"shape":"KnowledgeBaseQuery"} - } + "type": "structure" }, - "RetrieveResponse":{ - "type":"structure", - "required":["retrievalResults"], - "members":{ - "nextToken":{"shape":"NextToken"}, - "retrievalResults":{"shape":"KnowledgeBaseRetrievalResults"} - } + "RetrieveResponse": { + "members": { + "nextToken": { + "shape": "NextToken" + }, + "retrievalResults": { + "shape": "KnowledgeBaseRetrievalResults" + } + }, + "required": [ + "retrievalResults" + ], + "type": "structure" }, - "RetrievedReference":{ - "type":"structure", - "members":{ - "content":{"shape":"RetrievalResultContent"}, - "location":{"shape":"RetrievalResultLocation"} - } + "RetrievedReference": { + "members": { + "content": { + "shape": "RetrievalResultContent" + }, + "location": { + "shape": "RetrievalResultLocation" + } + }, + "type": "structure" }, - "RetrievedReferences":{ - "type":"list", - "member":{"shape":"RetrievedReference"} + "RetrievedReferences": { + "member": { + "shape": "RetrievedReference" + }, + "type": "list" }, - "SearchType":{ - "type":"string", - "enum":[ + "SearchType": { + "enum": [ "HYBRID", "SEMANTIC" - ] - }, - "ServiceQuotaExceededException":{ - "type":"structure", - "members":{ - "message":{"shape":"NonBlankString"} - }, - "error":{ - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "SessionAttributesMap":{ - "type":"map", - "key":{"shape":"String"}, - "value":{"shape":"String"} - }, - "SessionId":{ - "type":"string", - "max":100, - "min":2, - "pattern":"^[0-9a-zA-Z._:-]+$" - }, - "SessionState":{ - "type":"structure", - "members":{ - "promptSessionAttributes":{"shape":"PromptSessionAttributesMap"}, - "sessionAttributes":{"shape":"SessionAttributesMap"} + ], + "type": "string" + }, + "ServiceQuotaExceededException": { + "error": { + "httpStatusCode": 400, + "senderFault": true + }, + "exception": true, + "members": { + "message": { + "shape": "NonBlankString" + } + }, + "type": "structure" + }, + "SessionAttributesMap": { + "key": { + "shape": "String" + }, + "type": "map", + "value": { + "shape": "String" } }, - "Source":{ - "type":"string", - "enum":[ + "SessionId": { + "max": 100, + "min": 2, + "pattern": "^[0-9a-zA-Z._:-]+$", + "type": "string" + }, + "SessionState": { + "members": { + "promptSessionAttributes": { + "shape": "PromptSessionAttributesMap" + }, + "sessionAttributes": { + "shape": "SessionAttributesMap" + } + }, + "type": "structure" + }, + "Source": { + "enum": [ "ACTION_GROUP", "KNOWLEDGE_BASE", "PARSER" ], - "sensitive":true + "sensitive": true, + "type": "string" }, - "Span":{ - "type":"structure", - "members":{ - "end":{"shape":"SpanEndInteger"}, - "start":{"shape":"SpanStartInteger"} - } + "Span": { + "members": { + "end": { + "shape": "SpanEndInteger" + }, + "start": { + "shape": "SpanStartInteger" + } + }, + "type": "structure" + }, + "SpanEndInteger": { + "box": true, + "min": 0, + "type": "integer" + }, + "SpanStartInteger": { + "box": true, + "min": 0, + "type": "integer" + }, + "StopSequences": { + "max": 4, + "member": { + "shape": "String" + }, + "min": 0, + "type": "list" + }, + "String": { + "type": "string" + }, + "Temperature": { + "box": true, + "max": 1, + "min": 0, + "type": "float" + }, + "TextPromptTemplate": { + "max": 4000, + "min": 1, + "sensitive": true, + "type": "string" + }, + "TextResponsePart": { + "members": { + "span": { + "shape": "Span" + }, + "text": { + "shape": "String" + } + }, + "sensitive": true, + "type": "structure" + }, + "ThrottlingException": { + "error": { + "httpStatusCode": 429, + "senderFault": true + }, + "exception": true, + "members": { + "message": { + "shape": "NonBlankString" + } + }, + "type": "structure" + }, + "TopK": { + "box": true, + "max": 500, + "min": 0, + "type": "integer" + }, + "TopP": { + "box": true, + "max": 1, + "min": 0, + "type": "float" + }, + "Trace": { + "members": { + "failureTrace": { + "shape": "FailureTrace" + }, + "orchestrationTrace": { + "shape": "OrchestrationTrace" + }, + "postProcessingTrace": { + "shape": "PostProcessingTrace" + }, + "preProcessingTrace": { + "shape": "PreProcessingTrace" + } + }, + "sensitive": true, + "type": "structure", + "union": true + }, + "TraceId": { + "max": 16, + "min": 2, + "type": "string" + }, + "TraceKnowledgeBaseId": { + "sensitive": true, + "type": "string" + }, + "TracePart": { + "event": true, + "members": { + "agentAliasId": { + "shape": "AgentAliasId" + }, + "agentId": { + "shape": "AgentId" + }, + "sessionId": { + "shape": "SessionId" + }, + "trace": { + "shape": "Trace" + } + }, + "sensitive": true, + "type": "structure" }, - "SpanEndInteger":{ - "type":"integer", - "box":true, - "min":0 - }, - "SpanStartInteger":{ - "type":"integer", - "box":true, - "min":0 - }, - "StopSequences":{ - "type":"list", - "member":{"shape":"String"}, - "max":4, - "min":0 - }, - "String":{"type":"string"}, - "Temperature":{ - "type":"float", - "box":true, - "max":1, - "min":0 - }, - "TextPromptTemplate":{ - "type":"string", - "max":4000, - "min":1, - "sensitive":true - }, - "TextResponsePart":{ - "type":"structure", - "members":{ - "span":{"shape":"Span"}, - "text":{"shape":"String"} - }, - "sensitive":true - }, - "ThrottlingException":{ - "type":"structure", - "members":{ - "message":{"shape":"NonBlankString"} - }, - "error":{ - "httpStatusCode":429, - "senderFault":true - }, - "exception":true - }, - "TopK":{ - "type":"integer", - "box":true, - "max":500, - "min":0 - }, - "TopP":{ - "type":"float", - "box":true, - "max":1, - "min":0 - }, - "Trace":{ - "type":"structure", - "members":{ - "failureTrace":{"shape":"FailureTrace"}, - "orchestrationTrace":{"shape":"OrchestrationTrace"}, - "postProcessingTrace":{"shape":"PostProcessingTrace"}, - "preProcessingTrace":{"shape":"PreProcessingTrace"} - }, - "sensitive":true, - "union":true - }, - "TraceId":{ - "type":"string", - "max":16, - "min":2 - }, - "TraceKnowledgeBaseId":{ - "type":"string", - "sensitive":true - }, - "TracePart":{ - "type":"structure", - "members":{ - "agentAliasId":{"shape":"AgentAliasId"}, - "agentId":{"shape":"AgentId"}, - "sessionId":{"shape":"SessionId"}, - "trace":{"shape":"Trace"} - }, - "event":true, - "sensitive":true - }, - "Type":{ - "type":"string", - "enum":[ + "Type": { + "enum": [ "ACTION_GROUP", "KNOWLEDGE_BASE", "FINISH", "ASK_USER", "REPROMPT" - ] + ], + "type": "string" }, - "ValidationException":{ - "type":"structure", - "members":{ - "message":{"shape":"NonBlankString"} + "ValidationException": { + "error": { + "httpStatusCode": 400, + "senderFault": true }, - "error":{ - "httpStatusCode":400, - "senderFault":true + "exception": true, + "members": { + "message": { + "shape": "NonBlankString" + } }, - "exception":true + "type": "structure" }, - "Verb":{ - "type":"string", - "sensitive":true + "Verb": { + "sensitive": true, + "type": "string" } - } -} + }, + "version": "2.0" +} \ No newline at end of file diff --git a/models/apis/bedrock-agent-runtime/2023-07-26/docs-2.json b/models/apis/bedrock-agent-runtime/2023-07-26/docs-2.json index 47db6d4dacd..11c30ab827e 100644 --- a/models/apis/bedrock-agent-runtime/2023-07-26/docs-2.json +++ b/models/apis/bedrock-agent-runtime/2023-07-26/docs-2.json @@ -4,7 +4,7 @@ "operations": { "InvokeAgent": "Sends a prompt for the agent to process and respond to.
The CLI doesn't support InvokeAgent.
To continue the same conversation with an agent, use the same sessionId value in the request.
To activate trace enablement, turn enableTrace to true. Trace enablement helps you follow the agent's reasoning process that led it to the information it processed, the actions it took, and the final result it yielded. For more information, see Trace enablement.
End a conversation by setting endSession to true.
Include attributes for the session or prompt in the sessionState object.
The response is returned in the bytes field of the chunk object.
The attribution object contains citations for parts of the response.
If you set enableTrace to true in the request, you can trace the agent's steps and reasoning process that led it to the response.
Errors are also surfaced in the response.
Queries a knowledge base and retrieves information from it.
", - "RetrieveAndGenerate": "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.
" + "RetrieveAndGenerate": "Queries a knowledge base and generates responses based on the retrieved results. The response only cites sources that are relevant to the query.
" }, "shapes": { "AccessDeniedException": { @@ -139,6 +139,32 @@ "Trace$failureTrace": "Contains information about the failure of the interaction.
" } }, + "FilterAttribute": { + "base": "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:
", + "refs": { + "RetrievalFilter$equals": "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 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.
The name that the metadata attribute must match.
" + } + }, + "FilterValue": { + "base": null, + "refs": { + "FilterAttribute$value": "The value to whcih to compare the value of the metadata attribute.
" + } + }, "FinalResponse": { "base": "Contains details about the response to the user.
", "refs": { @@ -418,7 +444,7 @@ } }, "PromptTemplate": { - "base": "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:
", + "base": "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
Contains the template for the prompt that's sent to the model for response generation.
" } @@ -472,6 +498,20 @@ "InvokeAgentResponse$completion": "The agent's response to the user prompt.
" } }, + "RetrievalFilter": { + "base": "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
Specifies the filters to use on the metadata in the knowledge base data sources before returning results. For more information, see Query configurations.
", + "RetrievalFilterList$member": null + } + }, + "RetrievalFilterList": { + "base": null, + "refs": { + "RetrievalFilter$andAll": "Knowledge base data sources whose metadata attributes fulfill all the filter conditions inside this list are returned.
", + "RetrievalFilter$orAll": "Knowledge base data sources whose metadata attributes fulfill at least one of the filter conditions inside this list are returned.
" + } + }, "RetrievalResultContent": { "base": "Contains the cited text from the data source.
This data type is used in the following API operations:
Retrieve response – in the content field
RetrieveAndGenerate response – in the content field
Retrieve response – in the content field
The type of the location of the data source.
" } }, + "RetrievalResultMetadata": { + "base": null, + "refs": { + "KnowledgeBaseRetrievalResult$metadata": "Contains metadata attributes and their values for the file in the data source. For more information, see Metadata and filtering.
", + "RetrievedReference$metadata": "Contains metadata attributes and their values for the file in the data source. For more information, see Metadata and filtering.
" + } + }, + "RetrievalResultMetadataKey": { + "base": null, + "refs": { + "RetrievalResultMetadata$key": null + } + }, + "RetrievalResultMetadataValue": { + "base": null, + "refs": { + "RetrievalResultMetadata$value": null + } + }, "RetrievalResultS3Location": { "base": "Contains the S3 location of the data source.
This data type is used in the following API operations:
Retrieve response – in the s3Location field
RetrieveAndGenerate response – in the s3Location field
Retrieve response – in the s3Location field
An example service, deployed with the Octane Service creator, which will echo the string
", + "service": "Describes the API operations for creating and managing Amazon Bedrock agents.
", "operations": { - "AssociateAgentKnowledgeBase": "Associate a Knowledge Base to an existing Amazon Bedrock Agent
", - "CreateAgent": "Creates an Amazon Bedrock Agent
", - "CreateAgentActionGroup": "Creates an Action Group for existing Amazon Bedrock Agent
", - "CreateAgentAlias": "Creates an Alias for an existing Amazon Bedrock Agent
", - "CreateDataSource": "Create a new data source
", - "CreateKnowledgeBase": "Create a new knowledge base
", - "DeleteAgent": "Deletes an Agent for existing Amazon Bedrock Agent
", - "DeleteAgentActionGroup": "Deletes an Action Group for existing Amazon Bedrock Agent.
", - "DeleteAgentAlias": "Deletes an Alias for a Amazon Bedrock Agent
", - "DeleteAgentVersion": "Deletes an Agent version for existing Amazon Bedrock Agent
", - "DeleteDataSource": "Delete an existing data source
", - "DeleteKnowledgeBase": "Delete an existing knowledge base
", - "DisassociateAgentKnowledgeBase": "Disassociate an existing Knowledge Base from an Amazon Bedrock Agent
", - "GetAgent": "Gets an Agent for existing Amazon Bedrock Agent
", - "GetAgentActionGroup": "Gets an Action Group for existing Amazon Bedrock Agent Version
", - "GetAgentAlias": "Describes an Alias for a Amazon Bedrock Agent
", - "GetAgentKnowledgeBase": "Gets a knowledge base associated to an existing Amazon Bedrock Agent Version
", - "GetAgentVersion": "Gets an Agent version for existing Amazon Bedrock Agent
", - "GetDataSource": "Get an existing data source
", - "GetIngestionJob": "Get an ingestion job
", - "GetKnowledgeBase": "Get an existing knowledge base
", - "ListAgentActionGroups": "Lists an Action Group for existing Amazon Bedrock Agent Version
", - "ListAgentAliases": "Lists all the Aliases for an Amazon Bedrock Agent
", - "ListAgentKnowledgeBases": "List of Knowledge Bases associated to an existing Amazon Bedrock Agent Version
", - "ListAgentVersions": "Lists Agent Versions
", - "ListAgents": "Lists Agents
", - "ListDataSources": "List data sources
", - "ListIngestionJobs": "List ingestion jobs
", - "ListKnowledgeBases": "List Knowledge Bases
", - "ListTagsForResource": "List tags for a resource
", - "PrepareAgent": "Prepares an existing Amazon Bedrock Agent to receive runtime requests
", - "StartIngestionJob": "Start a new ingestion job
", - "TagResource": "Tag a resource
", - "UntagResource": "Untag a resource
", - "UpdateAgent": "Updates an existing Amazon Bedrock Agent
", - "UpdateAgentActionGroup": "Updates an existing Action Group for Amazon Bedrock Agent
", - "UpdateAgentAlias": "Updates an existing Alias for an Amazon Bedrock Agent
", - "UpdateAgentKnowledgeBase": "Updates an existing Knowledge Base associated to an Amazon Bedrock Agent
", - "UpdateDataSource": "Update an existing data source
", - "UpdateKnowledgeBase": "Update an existing knowledge base
" + "AssociateAgentKnowledgeBase": "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 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 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 of an agent that can be used to deploy the agent.
", + "CreateDataSource": "Sets up a data source to be added to a knowledge base.
You can't change the chunkingConfiguration after you create the data source.
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.
", + "DeleteAgentActionGroup": "Deletes an action group in an agent.
", + "DeleteAgentAlias": "Deletes an alias of an agent.
", + "DeleteAgentVersion": "Deletes a version of an agent.
", + "DeleteDataSource": "Deletes a data source from a knowledge base.
", + "DeleteKnowledgeBase": "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.
", + "DisassociateAgentKnowledgeBase": "Disassociates a knowledge base from an agent.
", + "GetAgent": "Gets information about an agent.
", + "GetAgentActionGroup": "Gets information about an action group for an agent.
", + "GetAgentAlias": "Gets information about an alias of an agent.
", + "GetAgentKnowledgeBase": "Gets information about a knowledge base associated with an agent.
", + "GetAgentVersion": "Gets details about a version of an agent.
", + "GetDataSource": "Gets information about a data source.
", + "GetIngestionJob": "Gets information about a ingestion job, in which a data source is added to a knowledge base.
", + "GetKnowledgeBase": "Gets information about a knoweldge base.
", + "ListAgentActionGroups": "Lists the action groups for an agent and information about each one.
", + "ListAgentAliases": "Lists the aliases of an agent and information about each one.
", + "ListAgentKnowledgeBases": "Lists knowledge bases associated with an agent and information about each one.
", + "ListAgentVersions": "Lists the versions of an agent and information about each version.
", + "ListAgents": "Lists the agents belonging to an account and information about each agent.
", + "ListDataSources": "Lists the data sources in a knowledge base and information about each one.
", + "ListIngestionJobs": "Lists the ingestion jobs for a data source and information about each of them.
", + "ListKnowledgeBases": "Lists the knowledge bases in an account and information about each of them.
", + "ListTagsForResource": "List all the tags for the resource you specify.
", + "PrepareAgent": "Creates a DRAFT version of the agent that can be used for internal testing.
Begins an ingestion job, in which a data source is added to a knowledge base.
", + "TagResource": "Associate tags with a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.
", + "UntagResource": "Remove tags from a resource.
", + "UpdateAgent": "Updates the configuration of an agent.
", + "UpdateAgentActionGroup": "Updates the configuration for an action group for an agent.
", + "UpdateAgentAlias": "Updates configurations for an alias of an agent.
", + "UpdateAgentKnowledgeBase": "Updates the configuration for a knowledge base that has been associated with an agent.
", + "UpdateDataSource": "Updates configurations for a data source.
You can't change the chunkingConfiguration after you create the data source. Specify the existing chunkingConfiguration.
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.
Contains information about the API Schema for the Action Group
", + "base": "Contains details about the OpenAPI schema for the action group. For more information, see Action group OpenAPI schemas. You can either include the schema directly in the payload field or you can upload it to an S3 bucket and specify the S3 bucket location in the s3 field.
Contains 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.
", + "CreateAgentActionGroupRequest$apiSchema": "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.
", + "UpdateAgentActionGroupRequest$apiSchema": "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.
" } }, "AccessDeniedException": { - "base": "This exception is thrown when a request is denied per access permissions
", + "base": "The request is denied because of missing access permissions.
", "refs": { } }, "ActionGroupExecutor": { - "base": "Type of Executors for an Action Group
", + "base": "Contains details about the Lambda function containing the business logic that is carried out upon invoking the action.
", "refs": { - "AgentActionGroup$actionGroupExecutor": null, - "CreateAgentActionGroupRequest$actionGroupExecutor": null, - "UpdateAgentActionGroupRequest$actionGroupExecutor": null + "AgentActionGroup$actionGroupExecutor": "The ARN of the Lambda function containing the business logic that is carried out upon invoking the action.
", + "CreateAgentActionGroupRequest$actionGroupExecutor": "The ARN of the Lambda function containing the business logic that is carried out upon invoking the action.
", + "UpdateAgentActionGroupRequest$actionGroupExecutor": "The ARN of the Lambda function containing the business logic that is carried out upon invoking the action.
" } }, "ActionGroupSignature": { - "base": "Action Group Signature for a BuiltIn Action
", + "base": null, "refs": { - "AgentActionGroup$parentActionSignature": null, - "CreateAgentActionGroupRequest$parentActionGroupSignature": null, - "UpdateAgentActionGroupRequest$parentActionGroupSignature": null + "AgentActionGroup$parentActionSignature": "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.
", + "CreateAgentActionGroupRequest$parentActionGroupSignature": "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.
", + "UpdateAgentActionGroupRequest$parentActionGroupSignature": "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.
" } }, "ActionGroupState": { - "base": "State of the action group
", + "base": null, "refs": { - "ActionGroupSummary$actionGroupState": null, - "AgentActionGroup$actionGroupState": null, - "CreateAgentActionGroupRequest$actionGroupState": null, - "UpdateAgentActionGroupRequest$actionGroupState": null + "ActionGroupSummary$actionGroupState": "Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
", + "AgentActionGroup$actionGroupState": "Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
", + "CreateAgentActionGroupRequest$actionGroupState": "Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
", + "UpdateAgentActionGroupRequest$actionGroupState": "Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
" } }, "ActionGroupSummaries": { - "base": "List of ActionGroup Summaries
", + "base": null, "refs": { - "ListAgentActionGroupsResponse$actionGroupSummaries": null + "ListAgentActionGroupsResponse$actionGroupSummaries": "A list of objects, each of which contains information about an action group.
" } }, "ActionGroupSummary": { - "base": "ActionGroup Summary
", + "base": "Contains details about an action group.
", "refs": { "ActionGroupSummaries$member": null } }, "Agent": { - "base": "Contains the information of an agent
", + "base": "Contains details about an agent.
", "refs": { - "CreateAgentResponse$agent": null, - "GetAgentResponse$agent": null, - "UpdateAgentResponse$agent": null + "CreateAgentResponse$agent": "Contains details about the agent created.
", + "GetAgentResponse$agent": "Contains details about the agent.
", + "UpdateAgentResponse$agent": "Contains details about the agent that was updated.
" } }, "AgentActionGroup": { - "base": "Contains the information of an Agent Action Group
", + "base": "Contains details about an action group.
", "refs": { - "CreateAgentActionGroupResponse$agentActionGroup": null, - "GetAgentActionGroupResponse$agentActionGroup": null, - "UpdateAgentActionGroupResponse$agentActionGroup": null + "CreateAgentActionGroupResponse$agentActionGroup": "Contains details about the action group that was created.
", + "GetAgentActionGroupResponse$agentActionGroup": "Contains details about the action group.
", + "UpdateAgentActionGroupResponse$agentActionGroup": "Contains details about the action group that was updated.
" } }, "AgentAlias": { - "base": "Contains the information of an agent alias
", + "base": "Contains details about an alias of an agent.
", "refs": { - "CreateAgentAliasResponse$agentAlias": null, - "GetAgentAliasResponse$agentAlias": null, - "UpdateAgentAliasResponse$agentAlias": null + "CreateAgentAliasResponse$agentAlias": "Contains details about the alias that was created.
", + "GetAgentAliasResponse$agentAlias": "Contains information about the alias.
", + "UpdateAgentAliasResponse$agentAlias": "Contains details about the alias that was updated.
" } }, "AgentAliasArn": { - "base": "Arn representation of the Agent Alias.
", + "base": null, "refs": { - "AgentAlias$agentAliasArn": null + "AgentAlias$agentAliasArn": "The ARN of the alias of the agent.
" } }, "AgentAliasHistoryEvent": { - "base": "History event for an alias for an Agent.
", + "base": "Contains details about the history of the alias.
", "refs": { "AgentAliasHistoryEvents$member": null } }, "AgentAliasHistoryEvents": { - "base": "The list of history events for an alias for an Agent.
", + "base": null, "refs": { - "AgentAlias$agentAliasHistoryEvents": null + "AgentAlias$agentAliasHistoryEvents": "Contains details about the history of the alias.
" } }, "AgentAliasId": { - "base": "Id for an Agent Alias generated at the server side.
", + "base": null, "refs": { - "AgentAlias$agentAliasId": null, - "AgentAliasSummary$agentAliasId": null, - "DeleteAgentAliasRequest$agentAliasId": "Id generated at the server side when an Agent Alias is created
", - "DeleteAgentAliasResponse$agentAliasId": null, - "GetAgentAliasRequest$agentAliasId": "Id generated at the server side when an Agent Alias is created
", - "UpdateAgentAliasRequest$agentAliasId": "Id generated at the server side when an Agent Alias is created
" + "AgentAlias$agentAliasId": "The unique identifier of the alias of the agent.
", + "AgentAliasSummary$agentAliasId": "Contains details about
", + "DeleteAgentAliasRequest$agentAliasId": "The unique identifier of the alias to delete.
", + "DeleteAgentAliasResponse$agentAliasId": "The unique identifier of the alias that was deleted.
", + "GetAgentAliasRequest$agentAliasId": "The unique identifier of the alias for which to get information.
", + "UpdateAgentAliasRequest$agentAliasId": "The unique identifier of the alias.
" } }, "AgentAliasRoutingConfiguration": { - "base": "Routing configuration for an Agent alias.
", + "base": null, "refs": { - "AgentAlias$routingConfiguration": null, - "AgentAliasHistoryEvent$routingConfiguration": null, - "AgentAliasSummary$routingConfiguration": null, - "CreateAgentAliasRequest$routingConfiguration": null, - "UpdateAgentAliasRequest$routingConfiguration": null + "AgentAlias$routingConfiguration": "Contains details about the routing configuration of the alias.
", + "AgentAliasHistoryEvent$routingConfiguration": "Contains details about the version of the agent with which the alias is associated.
", + "AgentAliasSummary$routingConfiguration": "Contains details about the version of the agent with which the alias is associated.
", + "CreateAgentAliasRequest$routingConfiguration": "Contains details about the routing configuration of the alias.
", + "UpdateAgentAliasRequest$routingConfiguration": "Contains details about the routing configuration of the alias.
" } }, "AgentAliasRoutingConfigurationListItem": { - "base": "Details about the routing configuration for an Agent alias.
", + "base": "Contains details about the routing configuration of the alias.
", "refs": { "AgentAliasRoutingConfiguration$member": null } }, "AgentAliasStatus": { - "base": "The statuses an Agent Alias can be in.
", + "base": null, "refs": { - "AgentAlias$agentAliasStatus": null, - "AgentAliasSummary$agentAliasStatus": null, - "DeleteAgentAliasResponse$agentAliasStatus": null + "AgentAlias$agentAliasStatus": "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 status of the alias.
", + "DeleteAgentAliasResponse$agentAliasStatus": "The status of the alias.
" } }, "AgentAliasSummaries": { - "base": "The list of summaries of all the aliases for an Agent.
", + "base": null, "refs": { - "ListAgentAliasesResponse$agentAliasSummaries": null + "ListAgentAliasesResponse$agentAliasSummaries": "A list of objects, each of which contains information about an alias of the agent.
" } }, "AgentAliasSummary": { - "base": "Summary of an alias for an Agent.
", + "base": "Contains details about an alias of an agent.
", "refs": { "AgentAliasSummaries$member": null } }, "AgentArn": { - "base": "Arn representation of the Agent.
", + "base": null, "refs": { - "Agent$agentArn": null, - "AgentVersion$agentArn": null + "Agent$agentArn": "The ARN of the agent.
", + "AgentVersion$agentArn": "The ARN of the agent that the version belongs to.
" } }, "AgentKnowledgeBase": { - "base": "Contains the information of an Agent Knowledge Base.
", + "base": "Contains details about a knowledge base that is associated with an agent.
", "refs": { - "AssociateAgentKnowledgeBaseResponse$agentKnowledgeBase": null, - "GetAgentKnowledgeBaseResponse$agentKnowledgeBase": null, - "UpdateAgentKnowledgeBaseResponse$agentKnowledgeBase": null + "AssociateAgentKnowledgeBaseResponse$agentKnowledgeBase": "Contains details about the knowledge base that has been associated with the agent.
", + "GetAgentKnowledgeBaseResponse$agentKnowledgeBase": "Contains details about a knowledge base attached to an agent.
", + "UpdateAgentKnowledgeBaseResponse$agentKnowledgeBase": "Contains details about the knowledge base that has been associated with an agent.
" } }, "AgentKnowledgeBaseSummaries": { - "base": "List of Agent Knowledge Base Summaries
", + "base": null, "refs": { - "ListAgentKnowledgeBasesResponse$agentKnowledgeBaseSummaries": null + "ListAgentKnowledgeBasesResponse$agentKnowledgeBaseSummaries": "A list of objects, each of which contains information about a knowledge base associated with the agent.
" } }, "AgentKnowledgeBaseSummary": { - "base": "Agent Knowledge Base Summary
", + "base": "Contains details about a knowledge base associated with an agent.
", "refs": { "AgentKnowledgeBaseSummaries$member": null } }, "AgentRoleArn": { - "base": "ARN of a IAM role.
", + "base": null, "refs": { - "Agent$agentResourceRoleArn": null, - "AgentVersion$agentResourceRoleArn": null, - "CreateAgentRequest$agentResourceRoleArn": null, - "UpdateAgentRequest$agentResourceRoleArn": null + "Agent$agentResourceRoleArn": "The ARN of the IAM role with permissions to call API operations on the agent. The ARN must begin with AmazonBedrockExecutionRoleForAgents_.
The ARN of the IAM role with permissions to invoke API operations on the agent. The ARN must begin with AmazonBedrockExecutionRoleForAgents_.
The ARN of the IAM role with permissions to create the agent. The ARN must begin with AmazonBedrockExecutionRoleForAgents_.
The ARN of the IAM role with permissions to update the agent. The ARN must begin with AmazonBedrockExecutionRoleForAgents_.
Schema Type for Action APIs.
", + "base": null, "refs": { - "Agent$agentStatus": null, - "AgentSummary$agentStatus": null, - "AgentVersion$agentStatus": null, - "AgentVersionSummary$agentStatus": null, - "DeleteAgentResponse$agentStatus": null, - "DeleteAgentVersionResponse$agentStatus": null, - "PrepareAgentResponse$agentStatus": null + "Agent$agentStatus": "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 status of the agent.
", + "AgentVersion$agentStatus": "The status of the agent that the version belongs to.
", + "AgentVersionSummary$agentStatus": "The status of the agent to which the version belongs.
", + "DeleteAgentResponse$agentStatus": "The status of the agent.
", + "DeleteAgentVersionResponse$agentStatus": "The status of the agent version.
", + "PrepareAgentResponse$agentStatus": "The status of the DRAFT version and whether it is ready for use.
List of AgentSummary.
", + "base": null, "refs": { - "ListAgentsResponse$agentSummaries": null + "ListAgentsResponse$agentSummaries": "A list of objects, each of which contains information about an agent.
" } }, "AgentSummary": { - "base": "Summary of Agent.
", + "base": "Contains details about an agent.
", "refs": { "AgentSummaries$member": null } }, "AgentVersion": { - "base": "Contains the information of an agent version.
", + "base": "Contains details about a version of an agent.
", "refs": { - "GetAgentVersionResponse$agentVersion": null + "GetAgentVersionResponse$agentVersion": "Contains details about the version of the agent.
" } }, "AgentVersionSummaries": { - "base": "List of AgentVersionSummary.
", + "base": null, "refs": { - "ListAgentVersionsResponse$agentVersionSummaries": null + "ListAgentVersionsResponse$agentVersionSummaries": "A list of objects, each of which contains information about a version of the agent.
" } }, "AgentVersionSummary": { - "base": "Summary of agent version.
", + "base": "Contains details about a version of an agent.
", "refs": { "AgentVersionSummaries$member": null } }, "AssociateAgentKnowledgeBaseRequest": { - "base": "Associate Agent Knowledge Base Request
", + "base": null, "refs": { } }, "AssociateAgentKnowledgeBaseResponse": { - "base": "Associate Agent Knowledge Base Response
", + "base": null, "refs": { } }, "BasePromptTemplate": { - "base": "Base Prompt Template.
", + "base": null, "refs": { - "PromptConfiguration$basePromptTemplate": null + "PromptConfiguration$basePromptTemplate": "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.
" } }, "BedrockEmbeddingModelArn": { - "base": "Arn of a Bedrock model.
", + "base": null, "refs": { - "VectorKnowledgeBaseConfiguration$embeddingModelArn": null + "VectorKnowledgeBaseConfiguration$embeddingModelArn": "The ARN of the model used to create vector embeddings for the knowledge base.
" } }, "Boolean": { "base": null, "refs": { - "DeleteAgentActionGroupRequest$skipResourceInUseCheck": "Skips checking if resource is in use when set to true. Defaults to false
", - "DeleteAgentRequest$skipResourceInUseCheck": "Skips checking if resource is in use when set to true. Defaults to false
", - "DeleteAgentVersionRequest$skipResourceInUseCheck": "Skips checking if resource is in use when set to true. Defaults to false
" + "DeleteAgentActionGroupRequest$skipResourceInUseCheck": "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.
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.
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.
Configures chunking strategy
", + "base": "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.
", "refs": { - "VectorIngestionConfiguration$chunkingConfiguration": null + "VectorIngestionConfiguration$chunkingConfiguration": "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": { - "base": "The type of chunking strategy
", + "base": null, "refs": { - "ChunkingConfiguration$chunkingStrategy": null + "ChunkingConfiguration$chunkingStrategy": "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.
Client specified token used for idempotency checks
", + "base": null, "refs": { - "Agent$clientToken": null, - "AgentActionGroup$clientToken": null, - "AgentAlias$clientToken": null, - "CreateAgentActionGroupRequest$clientToken": null, - "CreateAgentAliasRequest$clientToken": null, - "CreateAgentRequest$clientToken": null, - "CreateDataSourceRequest$clientToken": null, - "CreateKnowledgeBaseRequest$clientToken": null, - "StartIngestionJobRequest$clientToken": null + "Agent$clientToken": "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.
", + "AgentActionGroup$clientToken": "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.
", + "AgentAlias$clientToken": "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.
", + "CreateAgentActionGroupRequest$clientToken": "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.
", + "CreateAgentAliasRequest$clientToken": "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.
", + "CreateAgentRequest$clientToken": "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.
", + "CreateDataSourceRequest$clientToken": "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.
", + "CreateKnowledgeBaseRequest$clientToken": "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.
", + "StartIngestionJobRequest$clientToken": "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.
" } }, "ColumnName": { - "base": "Name of the column
", + "base": null, "refs": { - "RdsFieldMapping$primaryKeyField": null, - "RdsFieldMapping$vectorField": null, - "RdsFieldMapping$textField": null, - "RdsFieldMapping$metadataField": null + "RdsFieldMapping$metadataField": "The name of the field in which Amazon Bedrock stores metadata about the vector store.
", + "RdsFieldMapping$primaryKeyField": "The name of the field in which Amazon Bedrock stores the ID for each entry.
", + "RdsFieldMapping$textField": "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.
", + "RdsFieldMapping$vectorField": "The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
" } }, "ConflictException": { - "base": "This exception is thrown when there is a conflict performing an operation
", + "base": "There was a conflict performing an operation.
", "refs": { } }, "CreateAgentActionGroupRequest": { - "base": "Create Action Group Request
", + "base": null, "refs": { } }, "CreateAgentActionGroupResponse": { - "base": "Create Action Group Response
", + "base": null, "refs": { } }, "CreateAgentAliasRequest": { - "base": "Create Agent Alias Request
", + "base": null, "refs": { } }, "CreateAgentAliasResponse": { - "base": "Create Agent Alias Response
", + "base": null, "refs": { } }, "CreateAgentRequest": { - "base": "Create Agent Request
", + "base": null, "refs": { } }, "CreateAgentResponse": { - "base": "Create Agent Response
", + "base": null, "refs": { } }, @@ -382,127 +382,127 @@ } }, "CreationMode": { - "base": "Creation Mode for Prompt Configuration.
", + "base": null, "refs": { - "PromptConfiguration$promptCreationMode": null, - "PromptConfiguration$parserMode": null + "PromptConfiguration$parserMode": "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.
Contains the information of a data source.
", + "base": "Contains details about a data source.
", "refs": { - "CreateDataSourceResponse$dataSource": null, - "GetDataSourceResponse$dataSource": null, - "UpdateDataSourceResponse$dataSource": null + "CreateDataSourceResponse$dataSource": "Contains details about the data source.
", + "GetDataSourceResponse$dataSource": "Contains details about the data source.
", + "UpdateDataSourceResponse$dataSource": "Contains details about the data source.
" } }, "DataSourceConfiguration": { - "base": "Specifies a raw data source location to ingest.
", + "base": "Contains details about how a data source is stored.
", "refs": { - "CreateDataSourceRequest$dataSourceConfiguration": null, - "DataSource$dataSourceConfiguration": null, - "UpdateDataSourceRequest$dataSourceConfiguration": null + "CreateDataSourceRequest$dataSourceConfiguration": "Contains metadata about where the data source is stored.
", + "DataSource$dataSourceConfiguration": "Contains details about how the data source is stored.
", + "UpdateDataSourceRequest$dataSourceConfiguration": "Contains details about the storage configuration of the data source.
" } }, "DataSourceStatus": { - "base": "The status of a data source.
", + "base": null, "refs": { - "DataSource$status": null, - "DataSourceSummary$status": null, - "DeleteDataSourceResponse$status": null + "DataSource$status": "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 status of the data source.
", + "DeleteDataSourceResponse$status": "The status of the data source.
" } }, "DataSourceSummaries": { - "base": "list of data source summaries
", + "base": null, "refs": { - "ListDataSourcesResponse$dataSourceSummaries": null + "ListDataSourcesResponse$dataSourceSummaries": "A list of objects, each of which contains information about a data source.
" } }, "DataSourceSummary": { - "base": "Summary information of a data source.
", + "base": "Contains details about a data source.
", "refs": { "DataSourceSummaries$member": null } }, "DataSourceType": { - "base": "The type of the data source location.
", + "base": null, "refs": { - "DataSourceConfiguration$type": null + "DataSourceConfiguration$type": "The type of storage for the data source.
" } }, "DateTimestamp": { - "base": "Time Stamp.
", - "refs": { - "ActionGroupSummary$updatedAt": null, - "Agent$createdAt": null, - "Agent$updatedAt": null, - "Agent$preparedAt": null, - "AgentActionGroup$createdAt": null, - "AgentActionGroup$updatedAt": null, - "AgentAlias$createdAt": null, - "AgentAlias$updatedAt": null, - "AgentAliasHistoryEvent$endDate": null, - "AgentAliasHistoryEvent$startDate": null, - "AgentAliasSummary$createdAt": null, - "AgentAliasSummary$updatedAt": null, - "AgentKnowledgeBase$createdAt": null, - "AgentKnowledgeBase$updatedAt": null, - "AgentKnowledgeBaseSummary$updatedAt": null, - "AgentSummary$updatedAt": null, - "AgentVersion$createdAt": null, - "AgentVersion$updatedAt": null, - "AgentVersionSummary$createdAt": null, - "AgentVersionSummary$updatedAt": null, - "DataSource$createdAt": null, - "DataSource$updatedAt": null, - "DataSourceSummary$updatedAt": null, - "IngestionJob$startedAt": null, - "IngestionJob$updatedAt": null, - "IngestionJobSummary$startedAt": null, - "IngestionJobSummary$updatedAt": null, - "KnowledgeBase$createdAt": null, - "KnowledgeBase$updatedAt": null, - "KnowledgeBaseSummary$updatedAt": null, - "PrepareAgentResponse$preparedAt": null + "base": null, + "refs": { + "ActionGroupSummary$updatedAt": "The time at which the action group was last updated.
", + "Agent$createdAt": "The time at which the agent was created.
", + "Agent$preparedAt": "The time at which the agent was last prepared.
", + "Agent$updatedAt": "The time at which the agent was last updated.
", + "AgentActionGroup$createdAt": "The time at which the action group was created.
", + "AgentActionGroup$updatedAt": "The time at which the action group was last updated.
", + "AgentAlias$createdAt": "The time at which the alias of the agent was created.
", + "AgentAlias$updatedAt": "The time at which the alias was last updated.
", + "AgentAliasHistoryEvent$endDate": "The date that the alias stopped being associated to the version in the routingConfiguration object
The date that the alias began being associated to the version in the routingConfiguration object.
The time at which the alias of the agent was created.
", + "AgentAliasSummary$updatedAt": "The time at which the alias was last updated.
", + "AgentKnowledgeBase$createdAt": "The time at which the association between the agent and the knowledge base was created.
", + "AgentKnowledgeBase$updatedAt": "The time at which the association between the agent and the knowledge base was last updated.
", + "AgentKnowledgeBaseSummary$updatedAt": "The time at which the knowledge base associated with an agent was last updated.
", + "AgentSummary$updatedAt": "The time at which the agent was last updated.
", + "AgentVersion$createdAt": "The time at which the version was created.
", + "AgentVersion$updatedAt": "The time at which the version was last updated.
", + "AgentVersionSummary$createdAt": "The time at which the version was created.
", + "AgentVersionSummary$updatedAt": "The time at which the version was last updated.
", + "DataSource$createdAt": "The time at which the data source was created.
", + "DataSource$updatedAt": "The time at which the data source was last updated.
", + "DataSourceSummary$updatedAt": "The time at which the data source was last updated.
", + "IngestionJob$startedAt": "The time at which the ingestion job started.
", + "IngestionJob$updatedAt": "The time at which the ingestion job was last updated.
", + "IngestionJobSummary$startedAt": "The time at which the ingestion job was started.
", + "IngestionJobSummary$updatedAt": "The time at which the ingestion job was last updated.
", + "KnowledgeBase$createdAt": "The time at which the knowledge base was created.
", + "KnowledgeBase$updatedAt": "The time at which the knowledge base was last updated.
", + "KnowledgeBaseSummary$updatedAt": "The time at which the knowledge base was last updated.
", + "PrepareAgentResponse$preparedAt": "The time at which the DRAFT version of the agent was last prepared.
Delete Action Group Request
", + "base": null, "refs": { } }, "DeleteAgentActionGroupResponse": { - "base": "Delete Action Group Response
", + "base": null, "refs": { } }, "DeleteAgentAliasRequest": { - "base": "Delete Agent Alias Request
", + "base": null, "refs": { } }, "DeleteAgentAliasResponse": { - "base": "Delete Agent Alias Response
", + "base": null, "refs": { } }, "DeleteAgentRequest": { - "base": "Delete Agent Request
", + "base": null, "refs": { } }, "DeleteAgentResponse": { - "base": "Delete Agent Response
", + "base": null, "refs": { } }, "DeleteAgentVersionRequest": { - "base": "Delete Agent Version Request
", + "base": null, "refs": { } }, "DeleteAgentVersionResponse": { - "base": "Delete Agent Version Response
", + "base": null, "refs": { } }, @@ -527,154 +527,154 @@ } }, "Description": { - "base": "Description of the Resource.
", - "refs": { - "ActionGroupSummary$description": null, - "Agent$description": null, - "AgentActionGroup$description": null, - "AgentAlias$description": null, - "AgentAliasSummary$description": null, - "AgentKnowledgeBase$description": null, - "AgentKnowledgeBaseSummary$description": null, - "AgentSummary$description": null, - "AgentVersion$description": null, - "AgentVersionSummary$description": null, - "AssociateAgentKnowledgeBaseRequest$description": null, - "CreateAgentActionGroupRequest$description": null, - "CreateAgentAliasRequest$description": null, - "CreateAgentRequest$description": null, - "CreateDataSourceRequest$description": null, - "CreateKnowledgeBaseRequest$description": null, - "DataSource$description": null, - "DataSourceSummary$description": null, - "IngestionJob$description": null, - "IngestionJobSummary$description": null, - "KnowledgeBase$description": null, - "KnowledgeBaseSummary$description": null, - "StartIngestionJobRequest$description": null, - "UpdateAgentActionGroupRequest$description": null, - "UpdateAgentAliasRequest$description": null, - "UpdateAgentKnowledgeBaseRequest$description": null, - "UpdateAgentRequest$description": null, - "UpdateDataSourceRequest$description": null, - "UpdateKnowledgeBaseRequest$description": null + "base": null, + "refs": { + "ActionGroupSummary$description": "The description of the action group.
", + "Agent$description": "The description of the agent.
", + "AgentActionGroup$description": "The description of the action group.
", + "AgentAlias$description": "The description of the alias of the agent.
", + "AgentAliasSummary$description": "The description of the alias.
", + "AgentKnowledgeBase$description": "The description of the association between the agent and the knowledge base.
", + "AgentKnowledgeBaseSummary$description": "The description of the knowledge base associated with an agent.
", + "AgentSummary$description": "The description of the agent.
", + "AgentVersion$description": "The description of the version.
", + "AgentVersionSummary$description": "The description of the version of the agent.
", + "AssociateAgentKnowledgeBaseRequest$description": "A description of what the agent should use the knowledge base for.
", + "CreateAgentActionGroupRequest$description": "A description of the action group.
", + "CreateAgentAliasRequest$description": "A description of the alias of the agent.
", + "CreateAgentRequest$description": "A description of the agent.
", + "CreateDataSourceRequest$description": "A description of the data source.
", + "CreateKnowledgeBaseRequest$description": "A description of the knowledge base.
", + "DataSource$description": "The description of the data source.
", + "DataSourceSummary$description": "The description of the data source.
", + "IngestionJob$description": "The description of the ingestion job.
", + "IngestionJobSummary$description": "The description of the ingestion job.
", + "KnowledgeBase$description": "The description of the knowledge base.
", + "KnowledgeBaseSummary$description": "The description of the knowledge base.
", + "StartIngestionJobRequest$description": "A description of the ingestion job.
", + "UpdateAgentActionGroupRequest$description": "Specifies a new name for the action group.
", + "UpdateAgentAliasRequest$description": "Specifies a new description for the alias.
", + "UpdateAgentKnowledgeBaseRequest$description": "Specifies a new description for the knowledge base associated with an agent.
", + "UpdateAgentRequest$description": "Specifies a new description of the agent.
", + "UpdateDataSourceRequest$description": "Specifies a new description for the data source.
", + "UpdateKnowledgeBaseRequest$description": "Specifies a new description for the knowledge base.
" } }, "DisassociateAgentKnowledgeBaseRequest": { - "base": "Disassociate Agent Knowledge Base Request
", + "base": null, "refs": { } }, "DisassociateAgentKnowledgeBaseResponse": { - "base": "Disassociate Agent Knowledge Base Response
", + "base": null, "refs": { } }, "DraftVersion": { - "base": "Draft Agent Version.
", + "base": null, "refs": { - "Agent$agentVersion": null, - "AssociateAgentKnowledgeBaseRequest$agentVersion": "Draft Version of the Agent.
", - "CreateAgentActionGroupRequest$agentVersion": "Draft Version of the Agent.
", - "DeleteAgentActionGroupRequest$agentVersion": "Draft Version of the Agent.
", - "DisassociateAgentKnowledgeBaseRequest$agentVersion": "Draft Version of the Agent.
", - "UpdateAgentActionGroupRequest$agentVersion": "Draft Version of the Agent.
", - "UpdateAgentKnowledgeBaseRequest$agentVersion": "Draft Version of the Agent.
" + "Agent$agentVersion": "The version of the agent.
", + "AssociateAgentKnowledgeBaseRequest$agentVersion": "The version of the agent with which you want to associate the knowledge base.
", + "CreateAgentActionGroupRequest$agentVersion": "The version of the agent for which to create the action group.
", + "DeleteAgentActionGroupRequest$agentVersion": "The version of the agent that the action group belongs to.
", + "DisassociateAgentKnowledgeBaseRequest$agentVersion": "The version of the agent from which to disassociate the knowledge base.
", + "UpdateAgentActionGroupRequest$agentVersion": "The unique identifier of the agent version for which to update the action group.
", + "UpdateAgentKnowledgeBaseRequest$agentVersion": "The version of the agent associated with the knowledge base that you want to update.
" } }, "FailureReason": { - "base": "Failure Reason for Error.
", + "base": null, "refs": { "FailureReasons$member": null } }, "FailureReasons": { - "base": "Failure Reasons for Error.
", + "base": null, "refs": { - "Agent$failureReasons": null, - "AgentVersion$failureReasons": null, - "IngestionJob$failureReasons": null, - "KnowledgeBase$failureReasons": null + "Agent$failureReasons": "Contains reasons that the agent-related API that you invoked failed.
", + "AgentVersion$failureReasons": "A list of reasons that the API operation on the version failed.
", + "IngestionJob$failureReasons": "A list of reasons that the ingestion job failed.
", + "KnowledgeBase$failureReasons": "A list of reasons that the API operation on the knowledge base failed.
" } }, "FieldName": { - "base": "Name of the field
", + "base": null, "refs": { - "OpenSearchServerlessFieldMapping$vectorField": null, - "OpenSearchServerlessFieldMapping$textField": null, - "OpenSearchServerlessFieldMapping$metadataField": null, - "PineconeFieldMapping$textField": null, - "PineconeFieldMapping$metadataField": null, - "RedisEnterpriseCloudFieldMapping$vectorField": null, - "RedisEnterpriseCloudFieldMapping$textField": null, - "RedisEnterpriseCloudFieldMapping$metadataField": null + "OpenSearchServerlessFieldMapping$metadataField": "The name of the field in which Amazon Bedrock stores metadata about the vector store.
", + "OpenSearchServerlessFieldMapping$textField": "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.
", + "OpenSearchServerlessFieldMapping$vectorField": "The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
", + "PineconeFieldMapping$metadataField": "The name of the field in which Amazon Bedrock stores metadata about the vector store.
", + "PineconeFieldMapping$textField": "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.
", + "RedisEnterpriseCloudFieldMapping$metadataField": "The name of the field in which Amazon Bedrock stores metadata about the vector store.
", + "RedisEnterpriseCloudFieldMapping$textField": "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.
", + "RedisEnterpriseCloudFieldMapping$vectorField": "The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
" } }, "FixedSizeChunkingConfiguration": { - "base": "Configures fixed size chunking strategy
", + "base": "Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy as NONE, exclude this field.
Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy as NONE, exclude this field.
The maximum number of tokens per chunk.
" + "FixedSizeChunkingConfiguration$maxTokens": "The maximum number of tokens to include in a chunk.
" } }, "FixedSizeChunkingConfigurationOverlapPercentageInteger": { "base": null, "refs": { - "FixedSizeChunkingConfiguration$overlapPercentage": "The overlap percentage between adjacent chunks.
" + "FixedSizeChunkingConfiguration$overlapPercentage": "The percentage of overlap between adjacent chunks of a data source.
" } }, "GetAgentActionGroupRequest": { - "base": "Get Action Group Request
", + "base": null, "refs": { } }, "GetAgentActionGroupResponse": { - "base": "Get Action Group Response
", + "base": null, "refs": { } }, "GetAgentAliasRequest": { - "base": "Get Agent Alias Request
", + "base": null, "refs": { } }, "GetAgentAliasResponse": { - "base": "Get Agent Alias Response
", + "base": null, "refs": { } }, "GetAgentKnowledgeBaseRequest": { - "base": "Get Agent Knowledge Base Request
", + "base": null, "refs": { } }, "GetAgentKnowledgeBaseResponse": { - "base": "Get Agent Knowledge Base Response
", + "base": null, "refs": { } }, "GetAgentRequest": { - "base": "Get Agent Request
", + "base": null, "refs": { } }, "GetAgentResponse": { - "base": "Get Agent Response
", + "base": null, "refs": { } }, "GetAgentVersionRequest": { - "base": "Get Agent Version Request
", + "base": null, "refs": { } }, "GetAgentVersionResponse": { - "base": "Get Agent Version Response
", + "base": null, "refs": { } }, @@ -709,322 +709,322 @@ } }, "Id": { - "base": "Identifier for a resource.
", - "refs": { - "ActionGroupSummary$actionGroupId": null, - "Agent$agentId": null, - "AgentActionGroup$agentId": null, - "AgentActionGroup$actionGroupId": null, - "AgentAlias$agentId": null, - "AgentKnowledgeBase$agentId": null, - "AgentKnowledgeBase$knowledgeBaseId": null, - "AgentKnowledgeBaseSummary$knowledgeBaseId": null, - "AgentSummary$agentId": null, - "AgentVersion$agentId": null, - "AssociateAgentKnowledgeBaseRequest$agentId": "Id generated at the server side when an Agent is created
", - "AssociateAgentKnowledgeBaseRequest$knowledgeBaseId": null, - "CreateAgentActionGroupRequest$agentId": "Id generated at the server side when an Agent is created
", - "CreateAgentAliasRequest$agentId": "Id generated at the server side when an Agent is created
", - "CreateDataSourceRequest$knowledgeBaseId": null, - "DataSource$knowledgeBaseId": null, - "DataSource$dataSourceId": null, - "DataSourceSummary$knowledgeBaseId": null, - "DataSourceSummary$dataSourceId": null, - "DeleteAgentActionGroupRequest$agentId": "Id generated at the server side when an Agent is created
", - "DeleteAgentActionGroupRequest$actionGroupId": "Id generated at the server side when an Agent ActionGroup is created
", - "DeleteAgentAliasRequest$agentId": "Id generated at the server side when an Agent is created
", - "DeleteAgentAliasResponse$agentId": null, - "DeleteAgentRequest$agentId": "Id generated at the server side when an Agent is created
", - "DeleteAgentResponse$agentId": null, - "DeleteAgentVersionRequest$agentId": "Id generated at the server side when an Agent is created
", - "DeleteAgentVersionResponse$agentId": null, - "DeleteDataSourceRequest$knowledgeBaseId": null, - "DeleteDataSourceRequest$dataSourceId": null, - "DeleteDataSourceResponse$knowledgeBaseId": null, - "DeleteDataSourceResponse$dataSourceId": null, - "DeleteKnowledgeBaseRequest$knowledgeBaseId": null, - "DeleteKnowledgeBaseResponse$knowledgeBaseId": null, - "DisassociateAgentKnowledgeBaseRequest$agentId": "Id generated at the server side when an Agent is created
", - "DisassociateAgentKnowledgeBaseRequest$knowledgeBaseId": "Id generated at the server side when a Knowledge Base is associated to an Agent
", - "GetAgentActionGroupRequest$agentId": "Id generated at the server side when an Agent is created
", - "GetAgentActionGroupRequest$actionGroupId": "Id generated at the server side when an Agent Action Group is created
", - "GetAgentAliasRequest$agentId": "Id generated at the server side when an Agent is created
", - "GetAgentKnowledgeBaseRequest$agentId": "Id generated at the server side when an Agent is created
", - "GetAgentKnowledgeBaseRequest$knowledgeBaseId": "Id generated at the server side when a Knowledge Base is associated
", - "GetAgentRequest$agentId": "Id generated at the server side when an Agent is created
", - "GetAgentVersionRequest$agentId": "Id generated at the server side when an Agent is created
", - "GetDataSourceRequest$knowledgeBaseId": null, - "GetDataSourceRequest$dataSourceId": null, - "GetIngestionJobRequest$knowledgeBaseId": null, - "GetIngestionJobRequest$dataSourceId": null, - "GetIngestionJobRequest$ingestionJobId": null, - "GetKnowledgeBaseRequest$knowledgeBaseId": null, - "IngestionJob$knowledgeBaseId": null, - "IngestionJob$dataSourceId": null, - "IngestionJob$ingestionJobId": null, - "IngestionJobSummary$knowledgeBaseId": null, - "IngestionJobSummary$dataSourceId": null, - "IngestionJobSummary$ingestionJobId": null, - "KnowledgeBase$knowledgeBaseId": null, - "KnowledgeBaseSummary$knowledgeBaseId": null, - "ListAgentActionGroupsRequest$agentId": "Id generated at the server side when an Agent is Listed
", - "ListAgentAliasesRequest$agentId": "Id generated at the server side when an Agent is created
", - "ListAgentKnowledgeBasesRequest$agentId": "Id generated at the server side when an Agent is created
", - "ListAgentVersionsRequest$agentId": "Id generated at the server side when an Agent is created
", - "ListDataSourcesRequest$knowledgeBaseId": null, - "ListIngestionJobsRequest$knowledgeBaseId": null, - "ListIngestionJobsRequest$dataSourceId": null, - "PrepareAgentRequest$agentId": "Id generated at the server side when an Agent is created
", - "PrepareAgentResponse$agentId": null, - "StartIngestionJobRequest$knowledgeBaseId": null, - "StartIngestionJobRequest$dataSourceId": null, - "UpdateAgentActionGroupRequest$agentId": "Id generated at the server side when an Agent is created
", - "UpdateAgentActionGroupRequest$actionGroupId": "Id generated at the server side when an Action Group is created under Agent
", - "UpdateAgentAliasRequest$agentId": "Id generated at the server side when an Agent is created
", - "UpdateAgentKnowledgeBaseRequest$agentId": "Id generated at the server side when an Agent is created
", - "UpdateAgentKnowledgeBaseRequest$knowledgeBaseId": "Id generated at the server side when a Knowledge Base is associated to an Agent
", - "UpdateAgentRequest$agentId": "Id generated at the server side when an Agent is created
", - "UpdateDataSourceRequest$knowledgeBaseId": null, - "UpdateDataSourceRequest$dataSourceId": null, - "UpdateKnowledgeBaseRequest$knowledgeBaseId": null + "base": null, + "refs": { + "ActionGroupSummary$actionGroupId": "The unique identifier of the action group.
", + "Agent$agentId": "The unique identifier of the agent.
", + "AgentActionGroup$actionGroupId": "The unique identifier of the action group.
", + "AgentActionGroup$agentId": "The unique identifier of the agent to which the action group belongs.
", + "AgentAlias$agentId": "The unique identifier of the agent.
", + "AgentKnowledgeBase$agentId": "The unique identifier of the agent with which the knowledge base is associated.
", + "AgentKnowledgeBase$knowledgeBaseId": "The unique identifier of the association between the agent and the knowledge base.
", + "AgentKnowledgeBaseSummary$knowledgeBaseId": "The unique identifier of the knowledge base associated with an agent.
", + "AgentSummary$agentId": "The unique identifier of the agent.
", + "AgentVersion$agentId": "The unique identifier of the agent that the version belongs to.
", + "AssociateAgentKnowledgeBaseRequest$agentId": "The unique identifier of the agent with which you want to associate the knowledge base.
", + "AssociateAgentKnowledgeBaseRequest$knowledgeBaseId": "The unique identifier of the knowledge base to associate with the agent.
", + "CreateAgentActionGroupRequest$agentId": "The unique identifier of the agent for which to create the action group.
", + "CreateAgentAliasRequest$agentId": "The unique identifier of the agent.
", + "CreateDataSourceRequest$knowledgeBaseId": "The unique identifier of the knowledge base to which to add the data source.
", + "DataSource$dataSourceId": "The unique identifier of the data source.
", + "DataSource$knowledgeBaseId": "The unique identifier of the knowledge base to which the data source belongs.
", + "DataSourceSummary$dataSourceId": "The unique identifier of the data source.
", + "DataSourceSummary$knowledgeBaseId": "The unique identifier of the knowledge base to which the data source belongs.
", + "DeleteAgentActionGroupRequest$actionGroupId": "The unique identifier of the action group to delete.
", + "DeleteAgentActionGroupRequest$agentId": "The unique identifier of the agent that the action group belongs to.
", + "DeleteAgentAliasRequest$agentId": "The unique identifier of the agent that the alias belongs to.
", + "DeleteAgentAliasResponse$agentId": "The unique identifier of the agent that the alias belongs to.
", + "DeleteAgentRequest$agentId": "The unique identifier of the agent to delete.
", + "DeleteAgentResponse$agentId": "The unique identifier of the agent that was deleted.
", + "DeleteAgentVersionRequest$agentId": "The unique identifier of the agent that the version belongs to.
", + "DeleteAgentVersionResponse$agentId": "The unique identifier of the agent that the version belongs to.
", + "DeleteDataSourceRequest$dataSourceId": "The unique identifier of the data source to delete.
", + "DeleteDataSourceRequest$knowledgeBaseId": "The unique identifier of the knowledge base from which to delete the data source.
", + "DeleteDataSourceResponse$dataSourceId": "The unique identifier of the data source that was deleted.
", + "DeleteDataSourceResponse$knowledgeBaseId": "The unique identifier of the knowledge base to which the data source that was deleted belonged.
", + "DeleteKnowledgeBaseRequest$knowledgeBaseId": "The unique identifier of the knowledge base to delete.
", + "DeleteKnowledgeBaseResponse$knowledgeBaseId": "The unique identifier of the knowledge base that was deleted.
", + "DisassociateAgentKnowledgeBaseRequest$agentId": "The unique identifier of the agent from which to disassociate the knowledge base.
", + "DisassociateAgentKnowledgeBaseRequest$knowledgeBaseId": "The unique identifier of the knowledge base to disassociate.
", + "GetAgentActionGroupRequest$actionGroupId": "The unique identifier of the action group for which to get information.
", + "GetAgentActionGroupRequest$agentId": "The unique identifier of the agent that the action group belongs to.
", + "GetAgentAliasRequest$agentId": "The unique identifier of the agent to which the alias to get information belongs.
", + "GetAgentKnowledgeBaseRequest$agentId": "The unique identifier of the agent with which the knowledge base is associated.
", + "GetAgentKnowledgeBaseRequest$knowledgeBaseId": "The unique identifier of the knowledge base associated with the agent.
", + "GetAgentRequest$agentId": "The unique identifier of the agent.
", + "GetAgentVersionRequest$agentId": "The unique identifier of the agent.
", + "GetDataSourceRequest$dataSourceId": "The unique identifier of the data source.
", + "GetDataSourceRequest$knowledgeBaseId": "The unique identifier of the knowledge base that the data source was added to.
", + "GetIngestionJobRequest$dataSourceId": "The unique identifier of the data source in the ingestion job.
", + "GetIngestionJobRequest$ingestionJobId": "The unique identifier of the ingestion job.
", + "GetIngestionJobRequest$knowledgeBaseId": "The unique identifier of the knowledge base for which the ingestion job applies.
", + "GetKnowledgeBaseRequest$knowledgeBaseId": "The unique identifier of the knowledge base for which to get information.
", + "IngestionJob$dataSourceId": "The unique identifier of the ingested data source.
", + "IngestionJob$ingestionJobId": "The unique identifier of the ingestion job.
", + "IngestionJob$knowledgeBaseId": "The unique identifier of the knowledge base to which the data source is being added.
", + "IngestionJobSummary$dataSourceId": "The unique identifier of the data source in the ingestion job.
", + "IngestionJobSummary$ingestionJobId": "The unique identifier of the ingestion job.
", + "IngestionJobSummary$knowledgeBaseId": "The unique identifier of the knowledge base to which the data source is added.
", + "KnowledgeBase$knowledgeBaseId": "The unique identifier of the knowledge base.
", + "KnowledgeBaseSummary$knowledgeBaseId": "The unique identifier of the knowledge base.
", + "ListAgentActionGroupsRequest$agentId": "The unique identifier of the agent.
", + "ListAgentAliasesRequest$agentId": "The unique identifier of the agent.
", + "ListAgentKnowledgeBasesRequest$agentId": "The unique identifier of the agent for which to return information about knowledge bases associated with it.
", + "ListAgentVersionsRequest$agentId": "The unique identifier of the agent.
", + "ListDataSourcesRequest$knowledgeBaseId": "The unique identifier of the knowledge base for which to return a list of information.
", + "ListIngestionJobsRequest$dataSourceId": "The unique identifier of the data source for which to return ingestion jobs.
", + "ListIngestionJobsRequest$knowledgeBaseId": "The unique identifier of the knowledge base for which to return ingestion jobs.
", + "PrepareAgentRequest$agentId": "The unique identifier of the agent for which to create a DRAFT version.
The unique identifier of the agent for which the DRAFT version was created.
The unique identifier of the data source to ingest.
", + "StartIngestionJobRequest$knowledgeBaseId": "The unique identifier of the knowledge base to which to add the data source.
", + "UpdateAgentActionGroupRequest$actionGroupId": "The unique identifier of the action group.
", + "UpdateAgentActionGroupRequest$agentId": "The unique identifier of the agent for which to update the action group.
", + "UpdateAgentAliasRequest$agentId": "The unique identifier of the agent.
", + "UpdateAgentKnowledgeBaseRequest$agentId": "The unique identifier of the agent associated with the knowledge base that you want to update.
", + "UpdateAgentKnowledgeBaseRequest$knowledgeBaseId": "The unique identifier of the knowledge base that has been associated with an agent.
", + "UpdateAgentRequest$agentId": "The unique identifier of the agent.
", + "UpdateDataSourceRequest$dataSourceId": "The unique identifier of the data source.
", + "UpdateDataSourceRequest$knowledgeBaseId": "The unique identifier of the knowledge base to which the data source belongs.
", + "UpdateKnowledgeBaseRequest$knowledgeBaseId": "The unique identifier of the knowledge base to update.
" } }, "InferenceConfiguration": { - "base": "Configuration for inference in prompt configuration
", + "base": "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.
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.
Contains the information of an ingestion job.
", + "base": "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:
", "refs": { - "GetIngestionJobResponse$ingestionJob": null, - "StartIngestionJobResponse$ingestionJob": null + "GetIngestionJobResponse$ingestionJob": "Contains details about the ingestion job.
", + "StartIngestionJobResponse$ingestionJob": "An object containing information about the ingestion job.
" } }, "IngestionJobFilter": { - "base": "Filters the response returned by ListIngestionJobs operation.
", + "base": "Defines a filter by which to filter the results.
", "refs": { "IngestionJobFilters$member": null } }, "IngestionJobFilterAttribute": { - "base": "The name of the field to filter ingestion jobs.
", + "base": null, "refs": { - "IngestionJobFilter$attribute": null + "IngestionJobFilter$attribute": "The attribute by which to filter the results.
" } }, "IngestionJobFilterOperator": { - "base": "The operator used to filter ingestion jobs.
", + "base": null, "refs": { - "IngestionJobFilter$operator": null + "IngestionJobFilter$operator": "The operation to carry out between the attribute and the values.
" } }, "IngestionJobFilterValue": { - "base": "The value used to filter ingestion jobs.
", + "base": null, "refs": { "IngestionJobFilterValues$member": null } }, "IngestionJobFilterValues": { - "base": "The list of values used to filter ingestion jobs.
", + "base": null, "refs": { - "IngestionJobFilter$values": null + "IngestionJobFilter$values": "A list of values for the attribute.
" } }, "IngestionJobFilters": { - "base": "List of IngestionJobFilters
", + "base": null, "refs": { - "ListIngestionJobsRequest$filters": null + "ListIngestionJobsRequest$filters": "Contains a definition of a filter for which to filter the results.
" } }, "IngestionJobSortBy": { - "base": "Sorts the response returned by ListIngestionJobs operation.
", + "base": "Parameters by which to sort the results.
", "refs": { - "ListIngestionJobsRequest$sortBy": null + "ListIngestionJobsRequest$sortBy": "Contains details about how to sort the results.
" } }, "IngestionJobSortByAttribute": { - "base": "The name of the field to sort ingestion jobs.
", + "base": null, "refs": { - "IngestionJobSortBy$attribute": null + "IngestionJobSortBy$attribute": "The attribute by which to sort the results.
" } }, "IngestionJobStatistics": { - "base": "The document level statistics of an ingestion job
", + "base": "Contains the statistics for the ingestion job.
", "refs": { - "IngestionJob$statistics": null, - "IngestionJobSummary$statistics": null + "IngestionJob$statistics": "Contains statistics about the ingestion job.
", + "IngestionJobSummary$statistics": "Contains statistics for the ingestion job.
" } }, "IngestionJobStatus": { - "base": "The status of an ingestion job.
", + "base": null, "refs": { - "IngestionJob$status": null, - "IngestionJobSummary$status": null + "IngestionJob$status": "The status of the ingestion job.
", + "IngestionJobSummary$status": "The status of the ingestion job.
" } }, "IngestionJobSummaries": { - "base": "List of IngestionJobSummaries
", + "base": null, "refs": { - "ListIngestionJobsResponse$ingestionJobSummaries": null + "ListIngestionJobsResponse$ingestionJobSummaries": "A list of objects, each of which contains information about an ingestion job.
" } }, "IngestionJobSummary": { - "base": "Summary information of an ingestion job.
", + "base": "Contains details about an ingestion job.
", "refs": { "IngestionJobSummaries$member": null } }, "Instruction": { - "base": "Instruction for the agent.
", + "base": null, "refs": { - "Agent$instruction": null, - "AgentVersion$instruction": null, - "CreateAgentRequest$instruction": null, - "UpdateAgentRequest$instruction": null + "Agent$instruction": "Instructions that tell the agent what it should do and how it should interact with users.
", + "AgentVersion$instruction": "The instructions provided to the agent.
", + "CreateAgentRequest$instruction": "Instructions that tell the agent what it should do and how it should interact with users.
", + "UpdateAgentRequest$instruction": "Specifies new instructions that tell the agent what it should do and how it should interact with users.
" } }, "InternalServerException": { - "base": "This exception is thrown if there was an unexpected error during processing of request
", + "base": "An internal server error occurred. Retry your request.
", "refs": { } }, "KmsKeyArn": { - "base": "A KMS key ARN
", + "base": null, "refs": { - "Agent$customerEncryptionKeyArn": null, - "AgentVersion$customerEncryptionKeyArn": null, - "CreateAgentRequest$customerEncryptionKeyArn": null, - "ServerSideEncryptionConfiguration$kmsKeyArn": null, - "UpdateAgentRequest$customerEncryptionKeyArn": null + "Agent$customerEncryptionKeyArn": "The ARN of the KMS key that encrypts the agent.
", + "AgentVersion$customerEncryptionKeyArn": "The ARN of the KMS key that encrypts the agent.
", + "CreateAgentRequest$customerEncryptionKeyArn": "The ARN of the KMS key with which to encrypt the agent.
", + "ServerSideEncryptionConfiguration$kmsKeyArn": "The ARN of the KMS key used to encrypt the resource.
", + "UpdateAgentRequest$customerEncryptionKeyArn": "The ARN of the KMS key with which to encrypt the agent.
" } }, "KnowledgeBase": { - "base": "Contains the information of a knowledge base.
", + "base": "Contains information about a knowledge base.
", "refs": { - "CreateKnowledgeBaseResponse$knowledgeBase": null, - "GetKnowledgeBaseResponse$knowledgeBase": null, - "UpdateKnowledgeBaseResponse$knowledgeBase": null + "CreateKnowledgeBaseResponse$knowledgeBase": "Contains details about the knowledge base.
", + "GetKnowledgeBaseResponse$knowledgeBase": "Contains details about the knowledge base.
", + "UpdateKnowledgeBaseResponse$knowledgeBase": "Contains details about the knowledge base.
" } }, "KnowledgeBaseArn": { - "base": "ARN of a KnowledgeBase
", + "base": null, "refs": { - "KnowledgeBase$knowledgeBaseArn": null + "KnowledgeBase$knowledgeBaseArn": "The ARN of the knowledge base.
" } }, "KnowledgeBaseConfiguration": { - "base": "Configures a bedrock knowledge base.
", + "base": "Contains details about the embeddings configuration of the knowledge base.
", "refs": { - "CreateKnowledgeBaseRequest$knowledgeBaseConfiguration": null, - "KnowledgeBase$knowledgeBaseConfiguration": null, - "UpdateKnowledgeBaseRequest$knowledgeBaseConfiguration": null + "CreateKnowledgeBaseRequest$knowledgeBaseConfiguration": "Contains details about the embeddings model used for the knowledge base.
", + "KnowledgeBase$knowledgeBaseConfiguration": "Contains details about the embeddings configuration of the knowledge base.
", + "UpdateKnowledgeBaseRequest$knowledgeBaseConfiguration": "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.
" } }, "KnowledgeBaseRoleArn": { - "base": "ARN of a IAM role.
", + "base": null, "refs": { - "CreateKnowledgeBaseRequest$roleArn": null, - "KnowledgeBase$roleArn": null, - "UpdateKnowledgeBaseRequest$roleArn": null + "CreateKnowledgeBaseRequest$roleArn": "The ARN of the IAM role with permissions to create the knowledge base.
", + "KnowledgeBase$roleArn": "The ARN of the IAM role with permissions to invoke API operations on the knowledge base. The ARN must begin with AmazonBedrockExecutionRoleForKnowledgeBase_.
Specifies a different Amazon Resource Name (ARN) of the IAM role with permissions to modify the knowledge base.
" } }, "KnowledgeBaseState": { - "base": "State of the knowledge base; whether it is enabled or disabled
", + "base": null, "refs": { - "AgentKnowledgeBase$knowledgeBaseState": null, - "AgentKnowledgeBaseSummary$knowledgeBaseState": null, - "AssociateAgentKnowledgeBaseRequest$knowledgeBaseState": null, - "UpdateAgentKnowledgeBaseRequest$knowledgeBaseState": null + "AgentKnowledgeBase$knowledgeBaseState": "Specifies whether to use the knowledge base or not when sending an InvokeAgent request.
", + "AgentKnowledgeBaseSummary$knowledgeBaseState": "Specifies whether the agent uses the knowledge base or not when sending an InvokeAgent request.
", + "AssociateAgentKnowledgeBaseRequest$knowledgeBaseState": "Specifies whether to use the knowledge base or not when sending an InvokeAgent request.
", + "UpdateAgentKnowledgeBaseRequest$knowledgeBaseState": "Specifies whether the agent uses the knowledge base or not when sending an InvokeAgent request.
" } }, "KnowledgeBaseStatus": { - "base": "The status of a knowledge base.
", + "base": null, "refs": { - "DeleteKnowledgeBaseResponse$status": null, - "KnowledgeBase$status": null, - "KnowledgeBaseSummary$status": null + "DeleteKnowledgeBaseResponse$status": "The status of the knowledge base and whether it has been successfully deleted.
", + "KnowledgeBase$status": "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.
The status of the knowledge base.
" } }, "KnowledgeBaseStorageType": { - "base": "The storage type of a knowledge base.
", + "base": null, "refs": { - "StorageConfiguration$type": null + "StorageConfiguration$type": "The vector store service in which the knowledge base is stored.
" } }, "KnowledgeBaseSummaries": { - "base": "List of KnowledgeBaseSummaries
", + "base": null, "refs": { - "ListKnowledgeBasesResponse$knowledgeBaseSummaries": null + "ListKnowledgeBasesResponse$knowledgeBaseSummaries": "A list of objects, each of which contains information about a knowledge base.
" } }, "KnowledgeBaseSummary": { - "base": "Summary information of a knowledge base.
", + "base": "Contains details about a knowledge base.
", "refs": { "KnowledgeBaseSummaries$member": null } }, "KnowledgeBaseType": { - "base": "The type of a knowledge base.
", + "base": null, "refs": { - "KnowledgeBaseConfiguration$type": null + "KnowledgeBaseConfiguration$type": "The type of data that the data source is converted into for the knowledge base.
" } }, "LambdaArn": { - "base": "ARN of a Lambda.
", + "base": null, "refs": { - "ActionGroupExecutor$lambda": null, - "PromptOverrideConfiguration$overrideLambda": null + "ActionGroupExecutor$lambda": "The ARN of the Lambda function containing the business logic that is carried out upon invoking the action.
", + "PromptOverrideConfiguration$overrideLambda": "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.
List Action Groups Request
", + "base": null, "refs": { } }, "ListAgentActionGroupsResponse": { - "base": "List Action Groups Response
", + "base": null, "refs": { } }, "ListAgentAliasesRequest": { - "base": "List Agent Aliases Request
", + "base": null, "refs": { } }, "ListAgentAliasesResponse": { - "base": "List Agent Aliases Response
", + "base": null, "refs": { } }, "ListAgentKnowledgeBasesRequest": { - "base": "List Agent Knowledge Bases Request
", + "base": null, "refs": { } }, "ListAgentKnowledgeBasesResponse": { - "base": "List Agent Knowledge Bases Response
", + "base": null, "refs": { } }, "ListAgentVersionsRequest": { - "base": "List Agent Versions Request
", + "base": null, "refs": { } }, "ListAgentVersionsResponse": { - "base": "List Agent Versions Response
", + "base": null, "refs": { } }, "ListAgentsRequest": { - "base": "List Agent Request
", + "base": null, "refs": { } }, "ListAgentsResponse": { - "base": "List Agent Response
", + "base": null, "refs": { } }, @@ -1069,83 +1069,83 @@ } }, "MaxResults": { - "base": "Max Results.
", + "base": null, "refs": { - "ListAgentActionGroupsRequest$maxResults": null, - "ListAgentAliasesRequest$maxResults": null, - "ListAgentKnowledgeBasesRequest$maxResults": null, - "ListAgentVersionsRequest$maxResults": null, - "ListAgentsRequest$maxResults": null, - "ListDataSourcesRequest$maxResults": null, - "ListIngestionJobsRequest$maxResults": null, - "ListKnowledgeBasesRequest$maxResults": null + "ListAgentActionGroupsRequest$maxResults": "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.
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.
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.
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.
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.
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.
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.
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.
Maximum length of output
", + "base": null, "refs": { - "InferenceConfiguration$maximumLength": null + "InferenceConfiguration$maximumLength": "The maximum number of tokens to allow in the generated response.
" } }, "ModelIdentifier": { - "base": "ARN or name of a Bedrock model.
", + "base": null, "refs": { - "Agent$foundationModel": null, - "AgentVersion$foundationModel": null, - "CreateAgentRequest$foundationModel": null, - "UpdateAgentRequest$foundationModel": null + "Agent$foundationModel": "The foundation model used for orchestration by the agent.
", + "AgentVersion$foundationModel": "The foundation model that the version invokes.
", + "CreateAgentRequest$foundationModel": "The foundation model to be used for orchestration by the agent you create.
", + "UpdateAgentRequest$foundationModel": "Specifies a new foundation model to be used for orchestration by the agent.
" } }, "Name": { - "base": "Name for a resource.
", - "refs": { - "ActionGroupSummary$actionGroupName": null, - "Agent$agentName": null, - "AgentActionGroup$actionGroupName": null, - "AgentAlias$agentAliasName": null, - "AgentAliasSummary$agentAliasName": null, - "AgentSummary$agentName": null, - "AgentVersion$agentName": null, - "AgentVersionSummary$agentName": null, - "CreateAgentActionGroupRequest$actionGroupName": null, - "CreateAgentAliasRequest$agentAliasName": null, - "CreateAgentRequest$agentName": null, - "CreateDataSourceRequest$name": null, - "CreateKnowledgeBaseRequest$name": null, - "DataSource$name": null, - "DataSourceSummary$name": null, - "KnowledgeBase$name": null, - "KnowledgeBaseSummary$name": null, - "UpdateAgentActionGroupRequest$actionGroupName": null, - "UpdateAgentAliasRequest$agentAliasName": null, - "UpdateAgentRequest$agentName": null, - "UpdateDataSourceRequest$name": null, - "UpdateKnowledgeBaseRequest$name": null + "base": null, + "refs": { + "ActionGroupSummary$actionGroupName": "The name of the action group.
", + "Agent$agentName": "The name of the agent.
", + "AgentActionGroup$actionGroupName": "The name of the action group.
", + "AgentAlias$agentAliasName": "The name of the alias of the agent.
", + "AgentAliasSummary$agentAliasName": "The name of the alias.
", + "AgentSummary$agentName": "The name of the agent.
", + "AgentVersion$agentName": "The name of the agent that the version belongs to.
", + "AgentVersionSummary$agentName": "The name of the agent to which the version belongs.
", + "CreateAgentActionGroupRequest$actionGroupName": "The name to give the action group.
", + "CreateAgentAliasRequest$agentAliasName": "The name of the alias.
", + "CreateAgentRequest$agentName": "A name for the agent that you create.
", + "CreateDataSourceRequest$name": "The name of the data source.
", + "CreateKnowledgeBaseRequest$name": "A name for the knowledge base.
", + "DataSource$name": "The name of the data source.
", + "DataSourceSummary$name": "The name of the data source.
", + "KnowledgeBase$name": "The name of the knowledge base.
", + "KnowledgeBaseSummary$name": "The name of the knowledge base.
", + "UpdateAgentActionGroupRequest$actionGroupName": "Specifies a new name for the action group.
", + "UpdateAgentAliasRequest$agentAliasName": "Specifies a new name for the alias.
", + "UpdateAgentRequest$agentName": "Specifies a new name for the agent.
", + "UpdateDataSourceRequest$name": "Specifies a new name for the data source.
", + "UpdateKnowledgeBaseRequest$name": "Specifies a new name for the knowledge base.
" } }, "NextToken": { - "base": "Opaque continuation token of previous paginated response.
", - "refs": { - "ListAgentActionGroupsRequest$nextToken": null, - "ListAgentActionGroupsResponse$nextToken": null, - "ListAgentAliasesRequest$nextToken": null, - "ListAgentAliasesResponse$nextToken": null, - "ListAgentKnowledgeBasesRequest$nextToken": null, - "ListAgentKnowledgeBasesResponse$nextToken": null, - "ListAgentVersionsRequest$nextToken": null, - "ListAgentVersionsResponse$nextToken": null, - "ListAgentsRequest$nextToken": null, - "ListAgentsResponse$nextToken": null, - "ListDataSourcesRequest$nextToken": null, - "ListDataSourcesResponse$nextToken": null, - "ListIngestionJobsRequest$nextToken": null, - "ListIngestionJobsResponse$nextToken": null, - "ListKnowledgeBasesRequest$nextToken": null, - "ListKnowledgeBasesResponse$nextToken": null + "base": null, + "refs": { + "ListAgentActionGroupsRequest$nextToken": "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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
Non Blank String
", + "base": null, "refs": { "AccessDeniedException$message": null, "ConflictException$message": null, @@ -1154,274 +1154,276 @@ "ServiceQuotaExceededException$message": null, "ThrottlingException$message": null, "ValidationException$message": null, - "ValidationExceptionField$name": null, - "ValidationExceptionField$message": null + "ValidationExceptionField$message": "A message describing why this field failed validation.
", + "ValidationExceptionField$name": "The name of the field.
" } }, "NumericalVersion": { - "base": "Numerical Agent Version.
", + "base": null, "refs": { - "AgentVersion$version": null, - "DeleteAgentVersionRequest$agentVersion": null, - "DeleteAgentVersionResponse$agentVersion": null, - "GetAgentVersionRequest$agentVersion": null + "AgentVersion$version": "The version number.
", + "DeleteAgentVersionRequest$agentVersion": "The version of the agent to delete.
", + "DeleteAgentVersionResponse$agentVersion": "The version that was deleted.
", + "GetAgentVersionRequest$agentVersion": "The version of the agent.
" } }, "OpenSearchServerlessCollectionArn": { - "base": "Arn of an OpenSearch Serverless collection.
", + "base": null, "refs": { - "OpenSearchServerlessConfiguration$collectionArn": null + "OpenSearchServerlessConfiguration$collectionArn": "The ARN of the OpenSearch Service vector store.
" } }, "OpenSearchServerlessConfiguration": { - "base": "Contains the configurations to use OpenSearch Serverless to store knowledge base data.
", + "base": "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.
", "refs": { - "StorageConfiguration$opensearchServerlessConfiguration": null + "StorageConfiguration$opensearchServerlessConfiguration": "Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.
" } }, "OpenSearchServerlessFieldMapping": { - "base": "A mapping of Bedrock Knowledge Base fields to OpenSearch Serverless field names
", + "base": "Contains the names of the fields to which to map information about the vector store.
", "refs": { - "OpenSearchServerlessConfiguration$fieldMapping": null + "OpenSearchServerlessConfiguration$fieldMapping": "Contains the names of the fields to which to map information about the vector store.
" } }, "OpenSearchServerlessIndexName": { - "base": "Arn of an OpenSearch Serverless index.
", + "base": null, "refs": { - "OpenSearchServerlessConfiguration$vectorIndexName": null + "OpenSearchServerlessConfiguration$vectorIndexName": "The name of the vector store.
" } }, "Payload": { - "base": "String OpenAPI Payload
", + "base": null, "refs": { - "APISchema$payload": null + "APISchema$payload": "The JSON or YAML-formatted payload defining the OpenAPI schema for the action group. For more information, see Action group OpenAPI schemas.
" } }, "PineconeConfiguration": { - "base": "Contains the configurations to use Pinecone to store knowledge base data.
", + "base": "Contains details about the storage configuration of the knowledge base in Pinecone. For more information, see Create a vector index in Pinecone.
", "refs": { - "StorageConfiguration$pineconeConfiguration": null + "StorageConfiguration$pineconeConfiguration": "Contains the storage configuration of the knowledge base in Pinecone.
" } }, "PineconeConnectionString": { - "base": "Pinecone connection string
", + "base": null, "refs": { - "PineconeConfiguration$connectionString": null + "PineconeConfiguration$connectionString": "The endpoint URL for your index management page.
" } }, "PineconeFieldMapping": { - "base": "A mapping of Bedrock Knowledge Base fields to Pinecone field names
", + "base": "Contains the names of the fields to which to map information about the vector store.
", "refs": { - "PineconeConfiguration$fieldMapping": null + "PineconeConfiguration$fieldMapping": "Contains the names of the fields to which to map information about the vector store.
" } }, "PineconeNamespace": { - "base": "Pinecone namespace
", + "base": null, "refs": { - "PineconeConfiguration$namespace": null + "PineconeConfiguration$namespace": "The namespace to be used to write new data to your database.
" } }, "PrepareAgentRequest": { - "base": "PrepareAgent Request
", + "base": null, "refs": { } }, "PrepareAgentResponse": { - "base": "PrepareAgent Response
", + "base": null, "refs": { } }, "PrimitiveLong": { "base": null, "refs": { - "IngestionJobStatistics$numberOfDocumentsScanned": "Number of scanned documents
", - "IngestionJobStatistics$numberOfNewDocumentsIndexed": "Number of indexed documents
", - "IngestionJobStatistics$numberOfModifiedDocumentsIndexed": "Number of modified documents indexed
", - "IngestionJobStatistics$numberOfDocumentsDeleted": "Number of deleted documents
", - "IngestionJobStatistics$numberOfDocumentsFailed": "Number of failed documents
" + "IngestionJobStatistics$numberOfDocumentsDeleted": "The number of source documents that was deleted.
", + "IngestionJobStatistics$numberOfDocumentsFailed": "The number of source documents that failed to be ingested.
", + "IngestionJobStatistics$numberOfDocumentsScanned": "The total number of source documents that were scanned. Includes new, updated, and unchanged documents.
", + "IngestionJobStatistics$numberOfMetadataDocumentsModified": "The number of metadata files that were updated or deleted.
", + "IngestionJobStatistics$numberOfMetadataDocumentsScanned": "The total number of metadata files that were scanned. Includes new, updated, and unchanged files.
", + "IngestionJobStatistics$numberOfModifiedDocumentsIndexed": "The number of modified source documents in the data source that were successfully indexed.
", + "IngestionJobStatistics$numberOfNewDocumentsIndexed": "The number of new source documents in the data source that were successfully indexed.
" } }, "PromptConfiguration": { - "base": "BasePromptConfiguration per Prompt Type.
", + "base": "Contains configurations to override a prompt template in one part of an agent sequence. For more information, see Advanced prompts.
", "refs": { "PromptConfigurations$member": null } }, "PromptConfigurations": { - "base": "List of BasePromptConfiguration
", + "base": null, "refs": { - "PromptOverrideConfiguration$promptConfigurations": null + "PromptOverrideConfiguration$promptConfigurations": "Contains configurations to override a prompt template in one part of an agent sequence. For more information, see Advanced prompts.
" } }, "PromptOverrideConfiguration": { - "base": "Configuration for prompt override.
", + "base": "Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.
", "refs": { - "Agent$promptOverrideConfiguration": null, - "AgentVersion$promptOverrideConfiguration": null, - "CreateAgentRequest$promptOverrideConfiguration": null, - "UpdateAgentRequest$promptOverrideConfiguration": null + "Agent$promptOverrideConfiguration": "Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts.
", + "AgentVersion$promptOverrideConfiguration": "Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts.
", + "CreateAgentRequest$promptOverrideConfiguration": "Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.
", + "UpdateAgentRequest$promptOverrideConfiguration": "Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.
" } }, "PromptState": { - "base": "Prompt State.
", + "base": null, "refs": { - "PromptConfiguration$promptState": null + "PromptConfiguration$promptState": "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
Prompt Type.
", + "base": null, "refs": { - "PromptConfiguration$promptType": null + "PromptConfiguration$promptType": "The step in the agent sequence that this prompt configuration applies to.
" } }, "RdsArn": { - "base": "Arn of a RDS Resource.
", + "base": null, "refs": { - "RdsConfiguration$resourceArn": null + "RdsConfiguration$resourceArn": "The ARN of the vector store.
" } }, "RdsConfiguration": { - "base": "Contains the configurations to use RDS to store knowledge base data.
", + "base": "Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS.
", "refs": { - "StorageConfiguration$rdsConfiguration": null + "StorageConfiguration$rdsConfiguration": "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": { - "base": "Name of the database within RDS
", + "base": null, "refs": { - "RdsConfiguration$databaseName": null + "RdsConfiguration$databaseName": "The name of your Amazon RDS database.
" } }, "RdsFieldMapping": { - "base": "A mapping of Bedrock Knowledge Base fields to RDS column names
", + "base": "Contains the names of the fields to which to map information about the vector store.
", "refs": { - "RdsConfiguration$fieldMapping": null + "RdsConfiguration$fieldMapping": "Contains the names of the fields to which to map information about the vector store.
" } }, "RdsTableName": { - "base": "Name of the table within RDS
", + "base": null, "refs": { - "RdsConfiguration$tableName": null + "RdsConfiguration$tableName": "The name of the table in the database.
" } }, "RecommendedAction": { - "base": "The recommended action users can take to resolve an error in failureReasons.
", + "base": null, "refs": { "RecommendedActions$member": null } }, "RecommendedActions": { - "base": "The recommended actions users can take to resolve an error in failureReasons.
", + "base": null, "refs": { - "Agent$recommendedActions": null, - "AgentVersion$recommendedActions": null + "Agent$recommendedActions": "Contains recommended actions to take for the agent-related API that you invoked to succeed.
", + "AgentVersion$recommendedActions": "A list of recommended actions to take for the failed API operation on the version to succeed.
" } }, "RedisEnterpriseCloudConfiguration": { - "base": "Contains the configurations to use Redis Enterprise Cloud to store knowledge base data.
", + "base": "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.
", "refs": { - "StorageConfiguration$redisEnterpriseCloudConfiguration": null + "StorageConfiguration$redisEnterpriseCloudConfiguration": "Contains the storage configuration of the knowledge base in Redis Enterprise Cloud.
" } }, "RedisEnterpriseCloudEndpoint": { - "base": "Redis enterprise cloud endpoint
", + "base": null, "refs": { - "RedisEnterpriseCloudConfiguration$endpoint": null + "RedisEnterpriseCloudConfiguration$endpoint": "The endpoint URL of the Redis Enterprise Cloud database.
" } }, "RedisEnterpriseCloudFieldMapping": { - "base": "A mapping of Bedrock Knowledge Base fields to Redis Cloud field names
", + "base": "Contains the names of the fields to which to map information about the vector store.
", "refs": { - "RedisEnterpriseCloudConfiguration$fieldMapping": null + "RedisEnterpriseCloudConfiguration$fieldMapping": "Contains the names of the fields to which to map information about the vector store.
" } }, "RedisEnterpriseCloudIndexName": { - "base": "Name of a redis enterprise cloud index
", + "base": null, "refs": { - "RedisEnterpriseCloudConfiguration$vectorIndexName": null + "RedisEnterpriseCloudConfiguration$vectorIndexName": "The name of the vector index.
" } }, "ResourceNotFoundException": { - "base": "This exception is thrown when a resource referenced by the operation does not exist
", + "base": "The specified resource ARN was not found. Check the ARN and try your request again.
", "refs": { } }, "S3BucketArn": { - "base": "A S3 bucket ARN
", + "base": null, "refs": { - "S3DataSourceConfiguration$bucketArn": null + "S3DataSourceConfiguration$bucketArn": "The ARN of the bucket that contains the data source.
" } }, "S3BucketName": { - "base": "A bucket in S3.
", + "base": null, "refs": { - "S3Identifier$s3BucketName": null + "S3Identifier$s3BucketName": "The name of the S3 bucket.
" } }, "S3DataSourceConfiguration": { - "base": "Configures an S3 data source location.
", + "base": "Contains information about the S3 configuration of the data source.
", "refs": { - "DataSourceConfiguration$s3Configuration": null + "DataSourceConfiguration$s3Configuration": "Contains details about the configuration of the S3 object containing the data source.
" } }, "S3Identifier": { - "base": "The identifier for the S3 resource.
", + "base": "Contains information about the S3 object containing the resource.
", "refs": { - "APISchema$s3": null + "APISchema$s3": "Contains details about the S3 object containing the OpenAPI schema for the action group. For more information, see Action group OpenAPI schemas.
" } }, "S3ObjectKey": { - "base": "A object key in S3.
", + "base": null, "refs": { - "S3Identifier$s3ObjectKey": null + "S3Identifier$s3ObjectKey": "The S3 object key containing the resource.
" } }, "S3Prefix": { - "base": "Prefix for s3 object.
", + "base": null, "refs": { "S3Prefixes$member": null } }, "S3Prefixes": { - "base": "A list of S3 prefixes.
", + "base": null, "refs": { - "S3DataSourceConfiguration$inclusionPrefixes": null + "S3DataSourceConfiguration$inclusionPrefixes": "A list of S3 prefixes that define the object containing the data sources. For more information, see Organizing objects using prefixes.
" } }, "SecretArn": { - "base": "Arn of a SecretsManager Secret.
", + "base": null, "refs": { - "PineconeConfiguration$credentialsSecretArn": null, - "RdsConfiguration$credentialsSecretArn": null, - "RedisEnterpriseCloudConfiguration$credentialsSecretArn": null + "PineconeConfiguration$credentialsSecretArn": "The ARN of the secret that you created in Secrets Manager that is linked to your Pinecone API key.
", + "RdsConfiguration$credentialsSecretArn": "The ARN of the secret that you created in Secrets Manager that is linked to your Amazon RDS database.
", + "RedisEnterpriseCloudConfiguration$credentialsSecretArn": "The ARN of the secret that you created in Secrets Manager that is linked to your Redis Enterprise Cloud database.
" } }, "ServerSideEncryptionConfiguration": { - "base": "Server-side encryption configuration.
", + "base": "Contains the configuration for server-side encryption.
", "refs": { - "CreateDataSourceRequest$serverSideEncryptionConfiguration": null, - "DataSource$serverSideEncryptionConfiguration": null, - "UpdateDataSourceRequest$serverSideEncryptionConfiguration": null + "CreateDataSourceRequest$serverSideEncryptionConfiguration": "Contains details about the server-side encryption for the data source.
", + "DataSource$serverSideEncryptionConfiguration": "Contains details about the configuration of the server-side encryption.
", + "UpdateDataSourceRequest$serverSideEncryptionConfiguration": "Contains details about server-side encryption of the data source.
" } }, "ServiceQuotaExceededException": { - "base": "This exception is thrown when a request is made beyond the service quota
", + "base": "The number of requests exceeds the service quota. Resubmit your request later.
", "refs": { } }, "SessionTTL": { - "base": "Max Session Time.
", + "base": null, "refs": { - "Agent$idleSessionTTLInSeconds": null, - "AgentVersion$idleSessionTTLInSeconds": null, - "CreateAgentRequest$idleSessionTTLInSeconds": null, - "UpdateAgentRequest$idleSessionTTLInSeconds": null + "Agent$idleSessionTTLInSeconds": "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.
", + "AgentVersion$idleSessionTTLInSeconds": "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.
", + "CreateAgentRequest$idleSessionTTLInSeconds": "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.
", + "UpdateAgentRequest$idleSessionTTLInSeconds": "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.
" } }, "SortOrder": { - "base": "Order to sort results by.
", + "base": null, "refs": { - "IngestionJobSortBy$order": null + "IngestionJobSortBy$order": "The order by which to sort the results.
" } }, "StartIngestionJobRequest": { @@ -1435,17 +1437,17 @@ } }, "StopSequences": { - "base": "List of stop sequences
", + "base": null, "refs": { - "InferenceConfiguration$stopSequences": null + "InferenceConfiguration$stopSequences": "A list of stop sequences. A stop sequence is a sequence of characters that causes the model to stop generating the response.
" } }, "StorageConfiguration": { - "base": "Configures the physical storage of ingested data in a knowledge base.
", + "base": "Contains the storage configuration of the knowledge base.
", "refs": { - "CreateKnowledgeBaseRequest$storageConfiguration": null, - "KnowledgeBase$storageConfiguration": null, - "UpdateKnowledgeBaseRequest$storageConfiguration": null + "CreateKnowledgeBaseRequest$storageConfiguration": "Contains details about the configuration of the vector database used for the knowledge base.
", + "KnowledgeBase$storageConfiguration": "Contains details about the storage configuration of the knowledge base.
", + "UpdateKnowledgeBaseRequest$storageConfiguration": "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.
" } }, "String": { @@ -1455,16 +1457,16 @@ } }, "TagKey": { - "base": "Key of a tag
", + "base": null, "refs": { "TagKeyList$member": null, "TagsMap$key": null } }, "TagKeyList": { - "base": "List of Tag Keys
", + "base": null, "refs": { - "UntagResourceRequest$tagKeys": null + "UntagResourceRequest$tagKeys": "A list of keys of the tags to remove from the resource.
" } }, "TagResourceRequest": { @@ -1478,50 +1480,50 @@ } }, "TagValue": { - "base": "Value of a tag
", + "base": null, "refs": { "TagsMap$value": null } }, "TaggableResourcesArn": { - "base": "ARN of Taggable resources: [Agent, AgentAlias, Knowledge-Base]
", + "base": null, "refs": { - "ListTagsForResourceRequest$resourceArn": null, - "TagResourceRequest$resourceArn": null, - "UntagResourceRequest$resourceArn": null + "ListTagsForResourceRequest$resourceArn": "The ARN of the resource for which to list tags.
", + "TagResourceRequest$resourceArn": "The ARN of the resource to tag.
", + "UntagResourceRequest$resourceArn": "The ARN of the resource from which to remove tags.
" } }, "TagsMap": { - "base": "A map of tag keys and values
", + "base": null, "refs": { - "CreateAgentAliasRequest$tags": null, - "CreateAgentRequest$tags": null, - "CreateKnowledgeBaseRequest$tags": null, - "ListTagsForResourceResponse$tags": null, - "TagResourceRequest$tags": null + "CreateAgentAliasRequest$tags": "Any tags that you want to attach to the alias of the agent.
", + "CreateAgentRequest$tags": "Any tags that you want to attach to the agent.
", + "CreateKnowledgeBaseRequest$tags": "Specify the key-value pairs for the tags that you want to attach to your knowledge base in this object.
", + "ListTagsForResourceResponse$tags": "The key-value pairs for the tags associated with the resource.
", + "TagResourceRequest$tags": "An object containing key-value pairs that define the tags to attach to the resource.
" } }, "Temperature": { - "base": "Controls randomness, higher values increase diversity
", + "base": null, "refs": { - "InferenceConfiguration$temperature": null + "InferenceConfiguration$temperature": "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.
" } }, "ThrottlingException": { - "base": "This exception is thrown when the number of requests exceeds the limit
", + "base": "The number of requests exceeds the limit. Resubmit your request later.
", "refs": { } }, "TopK": { - "base": "Sample from the k most likely next tokens
", + "base": null, "refs": { - "InferenceConfiguration$topK": null + "InferenceConfiguration$topK": "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.
Cumulative probability cutoff for token selection
", + "base": null, "refs": { - "InferenceConfiguration$topP": null + "InferenceConfiguration$topP": "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.
Update Action Group Request
", + "base": null, "refs": { } }, "UpdateAgentActionGroupResponse": { - "base": "Update Action Group Response
", + "base": null, "refs": { } }, "UpdateAgentAliasRequest": { - "base": "Update Agent Alias Request
", + "base": null, "refs": { } }, "UpdateAgentAliasResponse": { - "base": "Update Agent Alias Response
", + "base": null, "refs": { } }, "UpdateAgentKnowledgeBaseRequest": { - "base": "Update Agent Knowledge Base Request
", + "base": null, "refs": { } }, "UpdateAgentKnowledgeBaseResponse": { - "base": "Update Agent Knowledge Base Response
", + "base": null, "refs": { } }, "UpdateAgentRequest": { - "base": "Update Agent Request
", + "base": null, "refs": { } }, "UpdateAgentResponse": { - "base": "Update Agent Response
", + "base": null, "refs": { } }, @@ -1595,49 +1597,49 @@ } }, "ValidationException": { - "base": "This exception is thrown when the request's input validation fails
", + "base": "Input validation failed. Check your request parameters and retry the request.
", "refs": { } }, "ValidationExceptionField": { - "base": "Stores information about a field passed inside a request that resulted in an exception
", + "base": "Stores information about a field passed inside a request that resulted in an validation error.
", "refs": { "ValidationExceptionFieldList$member": null } }, "ValidationExceptionFieldList": { - "base": "list of ValidationExceptionField
", + "base": null, "refs": { - "ValidationException$fieldList": null + "ValidationException$fieldList": "A list of objects containing fields that caused validation errors and their corresponding validation error messages.
" } }, "VectorIngestionConfiguration": { - "base": "Configures ingestion for a vector knowledge base
", + "base": "Contains details about how to ingest the documents in a data source.
", "refs": { - "CreateDataSourceRequest$vectorIngestionConfiguration": null, - "DataSource$vectorIngestionConfiguration": null, - "UpdateDataSourceRequest$vectorIngestionConfiguration": null + "CreateDataSourceRequest$vectorIngestionConfiguration": "Contains details about how to ingest the documents in the data source.
", + "DataSource$vectorIngestionConfiguration": "Contains details about how to ingest the documents in the data source.
", + "UpdateDataSourceRequest$vectorIngestionConfiguration": "Contains details about how to ingest the documents in the data source.
" } }, "VectorKnowledgeBaseConfiguration": { - "base": "Configurations for a vector knowledge base.
", + "base": "Contains details about the model used to create vector embeddings for the knowledge base.
", "refs": { - "KnowledgeBaseConfiguration$vectorKnowledgeBaseConfiguration": null + "KnowledgeBaseConfiguration$vectorKnowledgeBaseConfiguration": "Contains details about the embeddings model that'sused to convert the data source.
" } }, "Version": { - "base": "Agent Version.
", - "refs": { - "AgentActionGroup$agentVersion": null, - "AgentAliasRoutingConfigurationListItem$agentVersion": null, - "AgentKnowledgeBase$agentVersion": null, - "AgentSummary$latestAgentVersion": null, - "AgentVersionSummary$agentVersion": null, - "GetAgentActionGroupRequest$agentVersion": "Version number generated when a version is created
", - "GetAgentKnowledgeBaseRequest$agentVersion": "Version number generated when a version is created
", - "ListAgentActionGroupsRequest$agentVersion": "Id generated at the server side when an Agent is Listed
", - "ListAgentKnowledgeBasesRequest$agentVersion": "Version number generated when a version is created
", - "PrepareAgentResponse$agentVersion": null + "base": null, + "refs": { + "AgentActionGroup$agentVersion": "The version of the agent to which the action group belongs.
", + "AgentAliasRoutingConfigurationListItem$agentVersion": "The version of the agent with which the alias is associated.
", + "AgentKnowledgeBase$agentVersion": "The version of the agent with which the knowledge base is associated.
", + "AgentSummary$latestAgentVersion": "The latest version of the agent.
", + "AgentVersionSummary$agentVersion": "The version of the agent.
", + "GetAgentActionGroupRequest$agentVersion": "The version of the agent that the action group belongs to.
", + "GetAgentKnowledgeBaseRequest$agentVersion": "The version of the agent with which the knowledge base is associated.
", + "ListAgentActionGroupsRequest$agentVersion": "The version of the agent.
", + "ListAgentKnowledgeBasesRequest$agentVersion": "The version of the agent for which to return information about knowledge bases associated with it.
", + "PrepareAgentResponse$agentVersion": "The version of the agent.
" } } } diff --git a/models/apis/elasticache/2015-02-02/api-2.json b/models/apis/elasticache/2015-02-02/api-2.json index 175fe743c92..e01d82c54d4 100644 --- a/models/apis/elasticache/2015-02-02/api-2.json +++ b/models/apis/elasticache/2015-02-02/api-2.json @@ -2467,12 +2467,10 @@ }, "DataStorage":{ "type":"structure", - "required":[ - "Maximum", - "Unit" - ], + "required":["Unit"], "members":{ "Maximum":{"shape":"IntegerOptional"}, + "Minimum":{"shape":"IntegerOptional"}, "Unit":{"shape":"DataStorageUnit"} } }, @@ -2971,9 +2969,9 @@ }, "ECPUPerSecond":{ "type":"structure", - "required":["Maximum"], "members":{ - "Maximum":{"shape":"IntegerOptional"} + "Maximum":{"shape":"IntegerOptional"}, + "Minimum":{"shape":"IntegerOptional"} } }, "Endpoint":{ diff --git a/models/apis/elasticache/2015-02-02/docs-2.json b/models/apis/elasticache/2015-02-02/docs-2.json index 4e78fc97672..751b7a4abf8 100644 --- a/models/apis/elasticache/2015-02-02/docs-2.json +++ b/models/apis/elasticache/2015-02-02/docs-2.json @@ -1282,6 +1282,7 @@ "CreateServerlessCacheRequest$SnapshotRetentionLimit": "The number of snapshots that will be retained for the serverless cache that is being created. As new snapshots beyond this limit are added, the oldest snapshots will be deleted on a rolling basis. Available for Redis only.
", "CustomerNodeEndpoint$Port": "The port of the node endpoint
", "DataStorage$Maximum": "The upper limit for data storage the cache is set to use.
", + "DataStorage$Minimum": "The lower limit for data storage the cache is set to use.
", "DecreaseReplicaCountMessage$NewReplicaCount": "The number of read replica nodes you want at the completion of this operation. For Redis (cluster mode disabled) replication groups, this is the number of replica nodes in the replication group. For Redis (cluster mode enabled) replication groups, this is the number of replica nodes in each of the replication group's node groups.
The minimum number of replicas in a shard or replication group is:
Redis (cluster mode disabled)
If Multi-AZ is enabled: 1
If Multi-AZ is not enabled: 0
Redis (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails)
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20; maximum 100.
", "DescribeCacheEngineVersionsMessage$MaxRecords": "The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20; maximum 100.
", @@ -1304,6 +1305,7 @@ "DescribeUserGroupsMessage$MaxRecords": "The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.
", "DescribeUsersMessage$MaxRecords": "The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.
", "ECPUPerSecond$Maximum": "The configuration for the maximum number of ECPUs the cache can consume per second.
", + "ECPUPerSecond$Minimum": "The configuration for the minimum number of ECPUs the cache should be able consume per second.
", "IncreaseReplicaCountMessage$NewReplicaCount": "The number of read replica nodes you want at the completion of this operation. For Redis (cluster mode disabled) replication groups, this is the number of replica nodes in the replication group. For Redis (cluster mode enabled) replication groups, this is the number of replica nodes in each of the replication group's node groups.
", "ModifyCacheClusterMessage$NumCacheNodes": "The number of cache nodes that the cluster should have. If the value for NumCacheNodes is greater than the sum of the number of current cache nodes and the number of cache nodes pending creation (which may be zero), more nodes are added. If the value is less than the number of existing cache nodes, nodes are removed. If the value is equal to the number of current cache nodes, any pending add or remove requests are canceled.
If you are removing cache nodes, you must use the CacheNodeIdsToRemove parameter to provide the IDs of the specific cache nodes to remove.
For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.
Adding or removing Memcached cache nodes can be applied immediately or as a pending operation (see ApplyImmediately).
A pending operation to modify the number of cache nodes in a cluster during its maintenance window, whether by adding or removing nodes in accordance with the scale out architecture, is not queued. The customer's latest request to add or remove nodes to the cluster overrides any previous pending operations to modify the number of cache nodes in the cluster. For example, a request to remove 2 nodes would override a previous pending operation to remove 3 nodes. Similarly, a request to add 2 nodes would override a previous pending operation to remove 3 nodes and vice versa. As Memcached cache nodes may now be provisioned in different Availability Zones with flexible cache node placement, a request to add nodes does not automatically override a previous pending operation to add nodes. The customer can modify the previous pending operation to add more nodes or explicitly cancel the pending request and retry the new request. To cancel pending operations to modify the number of cache nodes in a cluster, use the ModifyCacheCluster request and set NumCacheNodes equal to the number of cache nodes currently in the cluster.
The number of days for which ElastiCache retains automatic cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.
If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
Specifies whether to delete the secret without any recovery window. You can't use both this parameter and RecoveryWindowInDays in the same call. If you don't use either, then by default Secrets Manager uses a 30 day recovery window.
Secrets Manager performs the actual deletion with an asynchronous background process, so there might be a short delay before the secret is permanently deleted. If you delete a secret and then immediately create a secret with the same name, use appropriate back off and retry logic.
If you forcibly delete an already deleted or nonexistent secret, the operation does not return ResourceNotFoundException.
Use this parameter with caution. This parameter causes the operation to skip the normal recovery window before the permanent deletion that Secrets Manager would normally impose with the RecoveryWindowInDays parameter. If you delete a secret with the ForceDeleteWithoutRecovery parameter, then you have no opportunity to recover the secret. You lose the secret permanently.
Specifies whether to include versions of secrets that don't have any staging labels attached to them. Versions without staging labels are considered deprecated and are subject to deletion by Secrets Manager. By default, versions without staging labels aren't included.
", "ListSecretsRequest$IncludePlannedDeletion": "Specifies whether to include secrets scheduled for deletion. By default, secrets scheduled for deletion aren't included.
", - "PutResourcePolicyRequest$BlockPublicPolicy": "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.
", + "PutResourcePolicyRequest$BlockPublicPolicy": "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.
Specifies whether to overwrite a secret with the same name in the destination Region. By default, secrets aren't overwritten.
", "RotateSecretRequest$RotateImmediately": "Specifies whether to rotate the secret immediately or wait until the next scheduled rotation window. The rotation schedule is defined in RotateSecretRequest$RotationRules.
For secrets that use a Lambda rotation function to rotate, if you don't immediately rotate the secret, Secrets Manager tests the rotation configuration by running the testSecret step of the Lambda rotation function. The test creates an AWSPENDING version of the secret and then removes it.
By default, Secrets Manager rotates the secret immediately.
", "ValidateResourcePolicyResponse$PolicyValidationPassed": "True if your policy passes validation, otherwise false.
" diff --git a/models/endpoints/endpoints.json b/models/endpoints/endpoints.json index c111a2b648c..b54a34aab79 100644 --- a/models/endpoints/endpoints.json +++ b/models/endpoints/endpoints.json @@ -11814,6 +11814,7 @@ "deprecated" : true, "hostname" : "mediaconvert-fips.us-west-2.amazonaws.com" }, + "me-central-1" : { }, "sa-east-1" : { }, "us-east-1" : { "variants" : [ { @@ -11847,6 +11848,7 @@ "ap-northeast-2" : { }, "ap-northeast-3" : { }, "ap-south-1" : { }, + "ap-south-2" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, "ap-southeast-4" : { }, @@ -11877,6 +11879,7 @@ "deprecated" : true, "hostname" : "medialive-fips.us-west-2.amazonaws.com" }, + "me-central-1" : { }, "sa-east-1" : { }, "us-east-1" : { "variants" : [ { diff --git a/service/batch/api.go b/service/batch/api.go index 6846f1f8020..b6f4ad5f462 100644 --- a/service/batch/api.go +++ b/service/batch/api.go @@ -8052,6 +8052,10 @@ func (s *EksContainerResourceRequirements) SetRequests(v map[string]*string) *Ek type EksContainerSecurityContext struct { _ struct{} `type:"structure"` + // Whether or not a container or a Kubernetes pod is allowed to gain more privileges + // than its parent process. The default value is false. + AllowPrivilegeEscalation *bool `locationName:"allowPrivilegeEscalation" type:"boolean"` + // 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 @@ -8105,6 +8109,12 @@ func (s EksContainerSecurityContext) GoString() string { return s.String() } +// SetAllowPrivilegeEscalation sets the AllowPrivilegeEscalation field's value. +func (s *EksContainerSecurityContext) SetAllowPrivilegeEscalation(v bool) *EksContainerSecurityContext { + s.AllowPrivilegeEscalation = &v + return s +} + // SetPrivileged sets the Privileged field's value. func (s *EksContainerSecurityContext) SetPrivileged(v bool) *EksContainerSecurityContext { s.Privileged = &v @@ -8362,6 +8372,13 @@ type EksPodProperties struct { // in the Kubernetes documentation. HostNetwork *bool `locationName:"hostNetwork" type:"boolean"` + // 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. + ImagePullSecrets []*ImagePullSecret `locationName:"imagePullSecrets" type:"list"` + // These containers run before application containers, always runs to completion, // and must complete successfully before the next container starts. These containers // are registered with the Amazon EKS Connector agent and persists the registration @@ -8424,6 +8441,16 @@ func (s *EksPodProperties) Validate() error { } } } + if s.ImagePullSecrets != nil { + for i, v := range s.ImagePullSecrets { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "ImagePullSecrets", i), err.(request.ErrInvalidParams)) + } + } + } if s.InitContainers != nil { for i, v := range s.InitContainers { if v == nil { @@ -8469,6 +8496,12 @@ func (s *EksPodProperties) SetHostNetwork(v bool) *EksPodProperties { return s } +// SetImagePullSecrets sets the ImagePullSecrets field's value. +func (s *EksPodProperties) SetImagePullSecrets(v []*ImagePullSecret) *EksPodProperties { + s.ImagePullSecrets = v + return s +} + // SetInitContainers sets the InitContainers field's value. func (s *EksPodProperties) SetInitContainers(v []*EksContainer) *EksPodProperties { s.InitContainers = v @@ -8531,6 +8564,9 @@ type EksPodPropertiesDetail struct { // in the Kubernetes documentation. HostNetwork *bool `locationName:"hostNetwork" type:"boolean"` + // Displays the reference pointer to the Kubernetes secret resource. + ImagePullSecrets []*ImagePullSecret `locationName:"imagePullSecrets" type:"list"` + // The container registered with the Amazon EKS Connector agent and persists // the registration information in the Kubernetes backend data store. InitContainers []*EksContainerDetail `locationName:"initContainers" type:"list"` @@ -8599,6 +8635,12 @@ func (s *EksPodPropertiesDetail) SetHostNetwork(v bool) *EksPodPropertiesDetail return s } +// SetImagePullSecrets sets the ImagePullSecrets field's value. +func (s *EksPodPropertiesDetail) SetImagePullSecrets(v []*ImagePullSecret) *EksPodPropertiesDetail { + s.ImagePullSecrets = v + return s +} + // SetInitContainers sets the InitContainers field's value. func (s *EksPodPropertiesDetail) SetInitContainers(v []*EksContainerDetail) *EksPodPropertiesDetail { s.InitContainers = v @@ -9322,6 +9364,55 @@ func (s *Host) SetSourcePath(v string) *Host { return s } +// 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. +type ImagePullSecret struct { + _ struct{} `type:"structure"` + + // Provides a unique identifier for the ImagePullSecret. This object is required + // when EksPodProperties$imagePullSecrets is used. + // + // Name is a required field + Name *string `locationName:"name" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ImagePullSecret) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ImagePullSecret) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ImagePullSecret) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ImagePullSecret"} + if s.Name == nil { + invalidParams.Add(request.NewErrParamRequired("Name")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetName sets the Name field's value. +func (s *ImagePullSecret) SetName(v string) *ImagePullSecret { + s.Name = &v + return s +} + // An object that represents an Batch job definition. type JobDefinition struct { _ struct{} `type:"structure"` diff --git a/service/bedrockagent/api.go b/service/bedrockagent/api.go index 95e5e75b639..04f48ff3df3 100644 --- a/service/bedrockagent/api.go +++ b/service/bedrockagent/api.go @@ -56,7 +56,9 @@ func (c *BedrockAgent) AssociateAgentKnowledgeBaseRequest(input *AssociateAgentK // AssociateAgentKnowledgeBase API operation for Agents for Amazon Bedrock. // -// # Associate a Knowledge Base to an existing Amazon Bedrock Agent +// 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. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -68,27 +70,26 @@ func (c *BedrockAgent) AssociateAgentKnowledgeBaseRequest(input *AssociateAgentK // Returned Error Types: // // - ThrottlingException -// This exception is thrown when the number of requests exceeds the limit +// The number of requests exceeds the limit. Resubmit your request later. // // - AccessDeniedException -// This exception is thrown when a request is denied per access permissions +// The request is denied because of missing access permissions. // // - ValidationException -// This exception is thrown when the request's input validation fails +// Input validation failed. Check your request parameters and retry the request. // // - InternalServerException -// This exception is thrown if there was an unexpected error during processing -// of request +// An internal server error occurred. Retry your request. // // - ResourceNotFoundException -// This exception is thrown when a resource referenced by the operation does -// not exist +// The specified resource ARN was not found. Check the ARN and try your request +// again. // // - ConflictException -// This exception is thrown when there is a conflict performing an operation +// There was a conflict performing an operation. // // - ServiceQuotaExceededException -// This exception is thrown when a request is made beyond the service quota +// The number of requests exceeds the service quota. Resubmit your request later. // // See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/AssociateAgentKnowledgeBase func (c *BedrockAgent) AssociateAgentKnowledgeBase(input *AssociateAgentKnowledgeBaseInput) (*AssociateAgentKnowledgeBaseOutput, error) { @@ -155,7 +156,23 @@ func (c *BedrockAgent) CreateAgentRequest(input *CreateAgentInput) (req *request // CreateAgent API operation for Agents for Amazon Bedrock. // -// # Creates an Amazon Bedrock Agent +// 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 (https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html). +// +// - If you agent fails to be created, the response returns a list of failureReasons +// alongside a list of recommendedActions for you to troubleshoot. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -167,23 +184,22 @@ func (c *BedrockAgent) CreateAgentRequest(input *CreateAgentInput) (req *request // Returned Error Types: // // - ThrottlingException -// This exception is thrown when the number of requests exceeds the limit +// The number of requests exceeds the limit. Resubmit your request later. // // - AccessDeniedException -// This exception is thrown when a request is denied per access permissions +// The request is denied because of missing access permissions. // // - ValidationException -// This exception is thrown when the request's input validation fails +// Input validation failed. Check your request parameters and retry the request. // // - InternalServerException -// This exception is thrown if there was an unexpected error during processing -// of request +// An internal server error occurred. Retry your request. // // - ConflictException -// This exception is thrown when there is a conflict performing an operation +// There was a conflict performing an operation. // // - ServiceQuotaExceededException -// This exception is thrown when a request is made beyond the service quota +// The number of requests exceeds the service quota. Resubmit your request later. // // See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/CreateAgent func (c *BedrockAgent) CreateAgent(input *CreateAgentInput) (*CreateAgentOutput, error) { @@ -250,7 +266,18 @@ func (c *BedrockAgent) CreateAgentActionGroupRequest(input *CreateAgentActionGro // CreateAgentActionGroup API operation for Agents for Amazon Bedrock. // -// # Creates an Action Group for existing Amazon Bedrock Agent +// 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 (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Observation.html) +// reprompting the user for more information. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -262,27 +289,26 @@ func (c *BedrockAgent) CreateAgentActionGroupRequest(input *CreateAgentActionGro // Returned Error Types: // // - ThrottlingException -// This exception is thrown when the number of requests exceeds the limit +// The number of requests exceeds the limit. Resubmit your request later. // // - AccessDeniedException -// This exception is thrown when a request is denied per access permissions +// The request is denied because of missing access permissions. // // - ValidationException -// This exception is thrown when the request's input validation fails +// Input validation failed. Check your request parameters and retry the request. // // - InternalServerException -// This exception is thrown if there was an unexpected error during processing -// of request +// An internal server error occurred. Retry your request. // // - ResourceNotFoundException -// This exception is thrown when a resource referenced by the operation does -// not exist +// The specified resource ARN was not found. Check the ARN and try your request +// again. // // - ConflictException -// This exception is thrown when there is a conflict performing an operation +// There was a conflict performing an operation. // // - ServiceQuotaExceededException -// This exception is thrown when a request is made beyond the service quota +// The number of requests exceeds the service quota. Resubmit your request later. // // See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/CreateAgentActionGroup func (c *BedrockAgent) CreateAgentActionGroup(input *CreateAgentActionGroupInput) (*CreateAgentActionGroupOutput, error) { @@ -349,7 +375,7 @@ func (c *BedrockAgent) CreateAgentAliasRequest(input *CreateAgentAliasInput) (re // CreateAgentAlias API operation for Agents for Amazon Bedrock. // -// # Creates an Alias for an existing Amazon Bedrock Agent +// Creates an alias of an agent that can be used to deploy the agent. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -361,27 +387,26 @@ func (c *BedrockAgent) CreateAgentAliasRequest(input *CreateAgentAliasInput) (re // Returned Error Types: // // - ThrottlingException -// This exception is thrown when the number of requests exceeds the limit +// The number of requests exceeds the limit. Resubmit your request later. // // - AccessDeniedException -// This exception is thrown when a request is denied per access permissions +// The request is denied because of missing access permissions. // // - ValidationException -// This exception is thrown when the request's input validation fails +// Input validation failed. Check your request parameters and retry the request. // // - InternalServerException -// This exception is thrown if there was an unexpected error during processing -// of request +// An internal server error occurred. Retry your request. // // - ResourceNotFoundException -// This exception is thrown when a resource referenced by the operation does -// not exist +// The specified resource ARN was not found. Check the ARN and try your request +// again. // // - ConflictException -// This exception is thrown when there is a conflict performing an operation +// There was a conflict performing an operation. // // - ServiceQuotaExceededException -// This exception is thrown when a request is made beyond the service quota +// The number of requests exceeds the service quota. Resubmit your request later. // // See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/CreateAgentAlias func (c *BedrockAgent) CreateAgentAlias(input *CreateAgentAliasInput) (*CreateAgentAliasOutput, error) { @@ -448,7 +473,9 @@ func (c *BedrockAgent) CreateDataSourceRequest(input *CreateDataSourceInput) (re // CreateDataSource API operation for Agents for Amazon Bedrock. // -// # Create a new data source +// Sets up a data source to be added to a knowledge base. +// +// You can't change the chunkingConfiguration after you create the data source. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -460,27 +487,26 @@ func (c *BedrockAgent) CreateDataSourceRequest(input *CreateDataSourceInput) (re // Returned Error Types: // // - ThrottlingException -// This exception is thrown when the number of requests exceeds the limit +// The number of requests exceeds the limit. Resubmit your request later. // // - AccessDeniedException -// This exception is thrown when a request is denied per access permissions +// The request is denied because of missing access permissions. // // - ValidationException -// This exception is thrown when the request's input validation fails +// Input validation failed. Check your request parameters and retry the request. // // - InternalServerException -// This exception is thrown if there was an unexpected error during processing -// of request +// An internal server error occurred. Retry your request. // // - ResourceNotFoundException -// This exception is thrown when a resource referenced by the operation does -// not exist +// The specified resource ARN was not found. Check the ARN and try your request +// again. // // - ConflictException -// This exception is thrown when there is a conflict performing an operation +// There was a conflict performing an operation. // // - ServiceQuotaExceededException -// This exception is thrown when a request is made beyond the service quota +// The number of requests exceeds the service quota. Resubmit your request later. // // See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/CreateDataSource func (c *BedrockAgent) CreateDataSource(input *CreateDataSourceInput) (*CreateDataSourceOutput, error) { @@ -547,7 +573,34 @@ func (c *BedrockAgent) CreateKnowledgeBaseRequest(input *CreateKnowledgeBaseInpu // CreateKnowledgeBase API operation for Agents for Amazon Bedrock. // -// # Create a new knowledge base +// 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 (https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup.html). +// +// 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 (https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-create). +// +// - 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 (https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-oss.html). +// For an Amazon Aurora database, use the RdsConfiguration object. For more +// information, see Create a vector store in Amazon Aurora (https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-rds.html). +// For a Pinecone database, use the pineconeConfiguration object. For more +// information, see Create a vector store in Pinecone (https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-pinecone.html). +// For a Redis Enterprise Cloud database, use the redisEnterpriseCloudConfiguration +// object. For more information, see Create a vector store in Redis Enterprise +// Cloud (https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-redis.html). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -559,23 +612,22 @@ func (c *BedrockAgent) CreateKnowledgeBaseRequest(input *CreateKnowledgeBaseInpu // Returned Error Types: // // - ThrottlingException -// This exception is thrown when the number of requests exceeds the limit +// The number of requests exceeds the limit. Resubmit your request later. // // - AccessDeniedException -// This exception is thrown when a request is denied per access permissions +// The request is denied because of missing access permissions. // // - ValidationException -// This exception is thrown when the request's input validation fails +// Input validation failed. Check your request parameters and retry the request. // // - InternalServerException -// This exception is thrown if there was an unexpected error during processing -// of request +// An internal server error occurred. Retry your request. // // - ConflictException -// This exception is thrown when there is a conflict performing an operation +// There was a conflict performing an operation. // // - ServiceQuotaExceededException -// This exception is thrown when a request is made beyond the service quota +// The number of requests exceeds the service quota. Resubmit your request later. // // See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/CreateKnowledgeBase func (c *BedrockAgent) CreateKnowledgeBase(input *CreateKnowledgeBaseInput) (*CreateKnowledgeBaseOutput, error) { @@ -642,7 +694,7 @@ func (c *BedrockAgent) DeleteAgentRequest(input *DeleteAgentInput) (req *request // DeleteAgent API operation for Agents for Amazon Bedrock. // -// # Deletes an Agent for existing Amazon Bedrock Agent +// Deletes an agent. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -654,24 +706,23 @@ func (c *BedrockAgent) DeleteAgentRequest(input *DeleteAgentInput) (req *request // Returned Error Types: // // - ThrottlingException -// This exception is thrown when the number of requests exceeds the limit +// The number of requests exceeds the limit. Resubmit your request later. // // - AccessDeniedException -// This exception is thrown when a request is denied per access permissions +// The request is denied because of missing access permissions. // // - ValidationException -// This exception is thrown when the request's input validation fails +// Input validation failed. Check your request parameters and retry the request. // // - InternalServerException -// This exception is thrown if there was an unexpected error during processing -// of request +// An internal server error occurred. Retry your request. // // - ResourceNotFoundException -// This exception is thrown when a resource referenced by the operation does -// not exist +// The specified resource ARN was not found. Check the ARN and try your request +// again. // // - ConflictException -// This exception is thrown when there is a conflict performing an operation +// There was a conflict performing an operation. // // See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteAgent func (c *BedrockAgent) DeleteAgent(input *DeleteAgentInput) (*DeleteAgentOutput, error) { @@ -739,7 +790,7 @@ func (c *BedrockAgent) DeleteAgentActionGroupRequest(input *DeleteAgentActionGro // DeleteAgentActionGroup API operation for Agents for Amazon Bedrock. // -// Deletes an Action Group for existing Amazon Bedrock Agent. +// Deletes an action group in an agent. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -751,24 +802,23 @@ func (c *BedrockAgent) DeleteAgentActionGroupRequest(input *DeleteAgentActionGro // Returned Error Types: // // - ThrottlingException -// This exception is thrown when the number of requests exceeds the limit +// The number of requests exceeds the limit. Resubmit your request later. // // - AccessDeniedException -// This exception is thrown when a request is denied per access permissions +// The request is denied because of missing access permissions. // // - ValidationException -// This exception is thrown when the request's input validation fails +// Input validation failed. Check your request parameters and retry the request. // // - InternalServerException -// This exception is thrown if there was an unexpected error during processing -// of request +// An internal server error occurred. Retry your request. // // - ResourceNotFoundException -// This exception is thrown when a resource referenced by the operation does -// not exist +// The specified resource ARN was not found. Check the ARN and try your request +// again. // // - ConflictException -// This exception is thrown when there is a conflict performing an operation +// There was a conflict performing an operation. // // See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteAgentActionGroup func (c *BedrockAgent) DeleteAgentActionGroup(input *DeleteAgentActionGroupInput) (*DeleteAgentActionGroupOutput, error) { @@ -835,7 +885,7 @@ func (c *BedrockAgent) DeleteAgentAliasRequest(input *DeleteAgentAliasInput) (re // DeleteAgentAlias API operation for Agents for Amazon Bedrock. // -// # Deletes an Alias for a Amazon Bedrock Agent +// Deletes an alias of an agent. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -847,21 +897,20 @@ func (c *BedrockAgent) DeleteAgentAliasRequest(input *DeleteAgentAliasInput) (re // Returned Error Types: // // - ThrottlingException -// This exception is thrown when the number of requests exceeds the limit +// The number of requests exceeds the limit. Resubmit your request later. // // - AccessDeniedException -// This exception is thrown when a request is denied per access permissions +// The request is denied because of missing access permissions. // // - ValidationException -// This exception is thrown when the request's input validation fails +// Input validation failed. Check your request parameters and retry the request. // // - InternalServerException -// This exception is thrown if there was an unexpected error during processing -// of request +// An internal server error occurred. Retry your request. // // - ResourceNotFoundException -// This exception is thrown when a resource referenced by the operation does -// not exist +// The specified resource ARN was not found. Check the ARN and try your request +// again. // // See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteAgentAlias func (c *BedrockAgent) DeleteAgentAlias(input *DeleteAgentAliasInput) (*DeleteAgentAliasOutput, error) { @@ -928,7 +977,7 @@ func (c *BedrockAgent) DeleteAgentVersionRequest(input *DeleteAgentVersionInput) // DeleteAgentVersion API operation for Agents for Amazon Bedrock. // -// # Deletes an Agent version for existing Amazon Bedrock Agent +// Deletes a version of an agent. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -940,24 +989,23 @@ func (c *BedrockAgent) DeleteAgentVersionRequest(input *DeleteAgentVersionInput) // Returned Error Types: // // - ThrottlingException -// This exception is thrown when the number of requests exceeds the limit +// The number of requests exceeds the limit. Resubmit your request later. // // - AccessDeniedException -// This exception is thrown when a request is denied per access permissions +// The request is denied because of missing access permissions. // // - ValidationException -// This exception is thrown when the request's input validation fails +// Input validation failed. Check your request parameters and retry the request. // // - InternalServerException -// This exception is thrown if there was an unexpected error during processing -// of request +// An internal server error occurred. Retry your request. // // - ResourceNotFoundException -// This exception is thrown when a resource referenced by the operation does -// not exist +// The specified resource ARN was not found. Check the ARN and try your request +// again. // // - ConflictException -// This exception is thrown when there is a conflict performing an operation +// There was a conflict performing an operation. // // See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteAgentVersion func (c *BedrockAgent) DeleteAgentVersion(input *DeleteAgentVersionInput) (*DeleteAgentVersionOutput, error) { @@ -1024,7 +1072,7 @@ func (c *BedrockAgent) DeleteDataSourceRequest(input *DeleteDataSourceInput) (re // DeleteDataSource API operation for Agents for Amazon Bedrock. // -// # Delete an existing data source +// Deletes a data source from a knowledge base. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1036,24 +1084,23 @@ func (c *BedrockAgent) DeleteDataSourceRequest(input *DeleteDataSourceInput) (re // Returned Error Types: // // - ThrottlingException -// This exception is thrown when the number of requests exceeds the limit +// The number of requests exceeds the limit. Resubmit your request later. // // - AccessDeniedException -// This exception is thrown when a request is denied per access permissions +// The request is denied because of missing access permissions. // // - ValidationException -// This exception is thrown when the request's input validation fails +// Input validation failed. Check your request parameters and retry the request. // // - InternalServerException -// This exception is thrown if there was an unexpected error during processing -// of request +// An internal server error occurred. Retry your request. // // - ResourceNotFoundException -// This exception is thrown when a resource referenced by the operation does -// not exist +// The specified resource ARN was not found. Check the ARN and try your request +// again. // // - ConflictException -// This exception is thrown when there is a conflict performing an operation +// There was a conflict performing an operation. // // See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteDataSource func (c *BedrockAgent) DeleteDataSource(input *DeleteDataSourceInput) (*DeleteDataSourceOutput, error) { @@ -1120,7 +1167,10 @@ func (c *BedrockAgent) DeleteKnowledgeBaseRequest(input *DeleteKnowledgeBaseInpu // DeleteKnowledgeBase API operation for Agents for Amazon Bedrock. // -// # Delete an existing knowledge base +// 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 (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_DisassociateAgentKnowledgeBase.html) +// request. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1132,24 +1182,23 @@ func (c *BedrockAgent) DeleteKnowledgeBaseRequest(input *DeleteKnowledgeBaseInpu // Returned Error Types: // // - ThrottlingException -// This exception is thrown when the number of requests exceeds the limit +// The number of requests exceeds the limit. Resubmit your request later. // // - AccessDeniedException -// This exception is thrown when a request is denied per access permissions +// The request is denied because of missing access permissions. // // - ValidationException -// This exception is thrown when the request's input validation fails +// Input validation failed. Check your request parameters and retry the request. // // - InternalServerException -// This exception is thrown if there was an unexpected error during processing -// of request +// An internal server error occurred. Retry your request. // // - ResourceNotFoundException -// This exception is thrown when a resource referenced by the operation does -// not exist +// The specified resource ARN was not found. Check the ARN and try your request +// again. // // - ConflictException -// This exception is thrown when there is a conflict performing an operation +// There was a conflict performing an operation. // // See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteKnowledgeBase func (c *BedrockAgent) DeleteKnowledgeBase(input *DeleteKnowledgeBaseInput) (*DeleteKnowledgeBaseOutput, error) { @@ -1217,7 +1266,7 @@ func (c *BedrockAgent) DisassociateAgentKnowledgeBaseRequest(input *Disassociate // DisassociateAgentKnowledgeBase API operation for Agents for Amazon Bedrock. // -// # Disassociate an existing Knowledge Base from an Amazon Bedrock Agent +// Disassociates a knowledge base from an agent. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1229,24 +1278,23 @@ func (c *BedrockAgent) DisassociateAgentKnowledgeBaseRequest(input *Disassociate // Returned Error Types: // // - ThrottlingException -// This exception is thrown when the number of requests exceeds the limit +// The number of requests exceeds the limit. Resubmit your request later. // // - AccessDeniedException -// This exception is thrown when a request is denied per access permissions +// The request is denied because of missing access permissions. // // - ValidationException -// This exception is thrown when the request's input validation fails +// Input validation failed. Check your request parameters and retry the request. // // - InternalServerException -// This exception is thrown if there was an unexpected error during processing -// of request +// An internal server error occurred. Retry your request. // // - ResourceNotFoundException -// This exception is thrown when a resource referenced by the operation does -// not exist +// The specified resource ARN was not found. Check the ARN and try your request +// again. // // - ConflictException -// This exception is thrown when there is a conflict performing an operation +// There was a conflict performing an operation. // // See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DisassociateAgentKnowledgeBase func (c *BedrockAgent) DisassociateAgentKnowledgeBase(input *DisassociateAgentKnowledgeBaseInput) (*DisassociateAgentKnowledgeBaseOutput, error) { @@ -1313,7 +1361,7 @@ func (c *BedrockAgent) GetAgentRequest(input *GetAgentInput) (req *request.Reque // GetAgent API operation for Agents for Amazon Bedrock. // -// # Gets an Agent for existing Amazon Bedrock Agent +// Gets information about an agent. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1325,21 +1373,20 @@ func (c *BedrockAgent) GetAgentRequest(input *GetAgentInput) (req *request.Reque // Returned Error Types: // // - ThrottlingException -// This exception is thrown when the number of requests exceeds the limit +// The number of requests exceeds the limit. Resubmit your request later. // // - AccessDeniedException -// This exception is thrown when a request is denied per access permissions +// The request is denied because of missing access permissions. // // - ValidationException -// This exception is thrown when the request's input validation fails +// Input validation failed. Check your request parameters and retry the request. // // - InternalServerException -// This exception is thrown if there was an unexpected error during processing -// of request +// An internal server error occurred. Retry your request. // // - ResourceNotFoundException -// This exception is thrown when a resource referenced by the operation does -// not exist +// The specified resource ARN was not found. Check the ARN and try your request +// again. // // See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetAgent func (c *BedrockAgent) GetAgent(input *GetAgentInput) (*GetAgentOutput, error) { @@ -1406,7 +1453,7 @@ func (c *BedrockAgent) GetAgentActionGroupRequest(input *GetAgentActionGroupInpu // GetAgentActionGroup API operation for Agents for Amazon Bedrock. // -// # Gets an Action Group for existing Amazon Bedrock Agent Version +// Gets information about an action group for an agent. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1418,21 +1465,20 @@ func (c *BedrockAgent) GetAgentActionGroupRequest(input *GetAgentActionGroupInpu // Returned Error Types: // // - ThrottlingException -// This exception is thrown when the number of requests exceeds the limit +// The number of requests exceeds the limit. Resubmit your request later. // // - AccessDeniedException -// This exception is thrown when a request is denied per access permissions +// The request is denied because of missing access permissions. // // - ValidationException -// This exception is thrown when the request's input validation fails +// Input validation failed. Check your request parameters and retry the request. // // - InternalServerException -// This exception is thrown if there was an unexpected error during processing -// of request +// An internal server error occurred. Retry your request. // // - ResourceNotFoundException -// This exception is thrown when a resource referenced by the operation does -// not exist +// The specified resource ARN was not found. Check the ARN and try your request +// again. // // See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetAgentActionGroup func (c *BedrockAgent) GetAgentActionGroup(input *GetAgentActionGroupInput) (*GetAgentActionGroupOutput, error) { @@ -1499,7 +1545,7 @@ func (c *BedrockAgent) GetAgentAliasRequest(input *GetAgentAliasInput) (req *req // GetAgentAlias API operation for Agents for Amazon Bedrock. // -// # Describes an Alias for a Amazon Bedrock Agent +// Gets information about an alias of an agent. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1511,21 +1557,20 @@ func (c *BedrockAgent) GetAgentAliasRequest(input *GetAgentAliasInput) (req *req // Returned Error Types: // // - ThrottlingException -// This exception is thrown when the number of requests exceeds the limit +// The number of requests exceeds the limit. Resubmit your request later. // // - AccessDeniedException -// This exception is thrown when a request is denied per access permissions +// The request is denied because of missing access permissions. // // - ValidationException -// This exception is thrown when the request's input validation fails +// Input validation failed. Check your request parameters and retry the request. // // - InternalServerException -// This exception is thrown if there was an unexpected error during processing -// of request +// An internal server error occurred. Retry your request. // // - ResourceNotFoundException -// This exception is thrown when a resource referenced by the operation does -// not exist +// The specified resource ARN was not found. Check the ARN and try your request +// again. // // See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetAgentAlias func (c *BedrockAgent) GetAgentAlias(input *GetAgentAliasInput) (*GetAgentAliasOutput, error) { @@ -1592,7 +1637,7 @@ func (c *BedrockAgent) GetAgentKnowledgeBaseRequest(input *GetAgentKnowledgeBase // GetAgentKnowledgeBase API operation for Agents for Amazon Bedrock. // -// # Gets a knowledge base associated to an existing Amazon Bedrock Agent Version +// Gets information about a knowledge base associated with an agent. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1604,21 +1649,20 @@ func (c *BedrockAgent) GetAgentKnowledgeBaseRequest(input *GetAgentKnowledgeBase // Returned Error Types: // // - ThrottlingException -// This exception is thrown when the number of requests exceeds the limit +// The number of requests exceeds the limit. Resubmit your request later. // // - AccessDeniedException -// This exception is thrown when a request is denied per access permissions +// The request is denied because of missing access permissions. // // - ValidationException -// This exception is thrown when the request's input validation fails +// Input validation failed. Check your request parameters and retry the request. // // - InternalServerException -// This exception is thrown if there was an unexpected error during processing -// of request +// An internal server error occurred. Retry your request. // // - ResourceNotFoundException -// This exception is thrown when a resource referenced by the operation does -// not exist +// The specified resource ARN was not found. Check the ARN and try your request +// again. // // See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetAgentKnowledgeBase func (c *BedrockAgent) GetAgentKnowledgeBase(input *GetAgentKnowledgeBaseInput) (*GetAgentKnowledgeBaseOutput, error) { @@ -1685,7 +1729,7 @@ func (c *BedrockAgent) GetAgentVersionRequest(input *GetAgentVersionInput) (req // GetAgentVersion API operation for Agents for Amazon Bedrock. // -// # Gets an Agent version for existing Amazon Bedrock Agent +// Gets details about a version of an agent. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1697,21 +1741,20 @@ func (c *BedrockAgent) GetAgentVersionRequest(input *GetAgentVersionInput) (req // Returned Error Types: // // - ThrottlingException -// This exception is thrown when the number of requests exceeds the limit +// The number of requests exceeds the limit. Resubmit your request later. // // - AccessDeniedException -// This exception is thrown when a request is denied per access permissions +// The request is denied because of missing access permissions. // // - ValidationException -// This exception is thrown when the request's input validation fails +// Input validation failed. Check your request parameters and retry the request. // // - InternalServerException -// This exception is thrown if there was an unexpected error during processing -// of request +// An internal server error occurred. Retry your request. // // - ResourceNotFoundException -// This exception is thrown when a resource referenced by the operation does -// not exist +// The specified resource ARN was not found. Check the ARN and try your request +// again. // // See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetAgentVersion func (c *BedrockAgent) GetAgentVersion(input *GetAgentVersionInput) (*GetAgentVersionOutput, error) { @@ -1778,7 +1821,7 @@ func (c *BedrockAgent) GetDataSourceRequest(input *GetDataSourceInput) (req *req // GetDataSource API operation for Agents for Amazon Bedrock. // -// # Get an existing data source +// Gets information about a data source. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1790,21 +1833,20 @@ func (c *BedrockAgent) GetDataSourceRequest(input *GetDataSourceInput) (req *req // Returned Error Types: // // - ThrottlingException -// This exception is thrown when the number of requests exceeds the limit +// The number of requests exceeds the limit. Resubmit your request later. // // - AccessDeniedException -// This exception is thrown when a request is denied per access permissions +// The request is denied because of missing access permissions. // // - ValidationException -// This exception is thrown when the request's input validation fails +// Input validation failed. Check your request parameters and retry the request. // // - InternalServerException -// This exception is thrown if there was an unexpected error during processing -// of request +// An internal server error occurred. Retry your request. // // - ResourceNotFoundException -// This exception is thrown when a resource referenced by the operation does -// not exist +// The specified resource ARN was not found. Check the ARN and try your request +// again. // // See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetDataSource func (c *BedrockAgent) GetDataSource(input *GetDataSourceInput) (*GetDataSourceOutput, error) { @@ -1871,7 +1913,8 @@ func (c *BedrockAgent) GetIngestionJobRequest(input *GetIngestionJobInput) (req // GetIngestionJob API operation for Agents for Amazon Bedrock. // -// # Get an ingestion job +// Gets information about a ingestion job, in which a data source is added to +// a knowledge base. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1883,21 +1926,20 @@ func (c *BedrockAgent) GetIngestionJobRequest(input *GetIngestionJobInput) (req // Returned Error Types: // // - ThrottlingException -// This exception is thrown when the number of requests exceeds the limit +// The number of requests exceeds the limit. Resubmit your request later. // // - AccessDeniedException -// This exception is thrown when a request is denied per access permissions +// The request is denied because of missing access permissions. // // - ValidationException -// This exception is thrown when the request's input validation fails +// Input validation failed. Check your request parameters and retry the request. // // - InternalServerException -// This exception is thrown if there was an unexpected error during processing -// of request +// An internal server error occurred. Retry your request. // // - ResourceNotFoundException -// This exception is thrown when a resource referenced by the operation does -// not exist +// The specified resource ARN was not found. Check the ARN and try your request +// again. // // See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetIngestionJob func (c *BedrockAgent) GetIngestionJob(input *GetIngestionJobInput) (*GetIngestionJobOutput, error) { @@ -1964,7 +2006,7 @@ func (c *BedrockAgent) GetKnowledgeBaseRequest(input *GetKnowledgeBaseInput) (re // GetKnowledgeBase API operation for Agents for Amazon Bedrock. // -// # Get an existing knowledge base +// Gets information about a knoweldge base. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1976,21 +2018,20 @@ func (c *BedrockAgent) GetKnowledgeBaseRequest(input *GetKnowledgeBaseInput) (re // Returned Error Types: // // - ThrottlingException -// This exception is thrown when the number of requests exceeds the limit +// The number of requests exceeds the limit. Resubmit your request later. // // - AccessDeniedException -// This exception is thrown when a request is denied per access permissions +// The request is denied because of missing access permissions. // // - ValidationException -// This exception is thrown when the request's input validation fails +// Input validation failed. Check your request parameters and retry the request. // // - InternalServerException -// This exception is thrown if there was an unexpected error during processing -// of request +// An internal server error occurred. Retry your request. // // - ResourceNotFoundException -// This exception is thrown when a resource referenced by the operation does -// not exist +// The specified resource ARN was not found. Check the ARN and try your request +// again. // // See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetKnowledgeBase func (c *BedrockAgent) GetKnowledgeBase(input *GetKnowledgeBaseInput) (*GetKnowledgeBaseOutput, error) { @@ -2063,7 +2104,7 @@ func (c *BedrockAgent) ListAgentActionGroupsRequest(input *ListAgentActionGroups // ListAgentActionGroups API operation for Agents for Amazon Bedrock. // -// # Lists an Action Group for existing Amazon Bedrock Agent Version +// Lists the action groups for an agent and information about each one. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2075,21 +2116,20 @@ func (c *BedrockAgent) ListAgentActionGroupsRequest(input *ListAgentActionGroups // Returned Error Types: // // - ThrottlingException -// This exception is thrown when the number of requests exceeds the limit +// The number of requests exceeds the limit. Resubmit your request later. // // - AccessDeniedException -// This exception is thrown when a request is denied per access permissions +// The request is denied because of missing access permissions. // // - ValidationException -// This exception is thrown when the request's input validation fails +// Input validation failed. Check your request parameters and retry the request. // // - InternalServerException -// This exception is thrown if there was an unexpected error during processing -// of request +// An internal server error occurred. Retry your request. // // - ResourceNotFoundException -// This exception is thrown when a resource referenced by the operation does -// not exist +// The specified resource ARN was not found. Check the ARN and try your request +// again. // // See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListAgentActionGroups func (c *BedrockAgent) ListAgentActionGroups(input *ListAgentActionGroupsInput) (*ListAgentActionGroupsOutput, error) { @@ -2213,7 +2253,7 @@ func (c *BedrockAgent) ListAgentAliasesRequest(input *ListAgentAliasesInput) (re // ListAgentAliases API operation for Agents for Amazon Bedrock. // -// # Lists all the Aliases for an Amazon Bedrock Agent +// Lists the aliases of an agent and information about each one. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2225,21 +2265,20 @@ func (c *BedrockAgent) ListAgentAliasesRequest(input *ListAgentAliasesInput) (re // Returned Error Types: // // - ThrottlingException -// This exception is thrown when the number of requests exceeds the limit +// The number of requests exceeds the limit. Resubmit your request later. // // - AccessDeniedException -// This exception is thrown when a request is denied per access permissions +// The request is denied because of missing access permissions. // // - ValidationException -// This exception is thrown when the request's input validation fails +// Input validation failed. Check your request parameters and retry the request. // // - InternalServerException -// This exception is thrown if there was an unexpected error during processing -// of request +// An internal server error occurred. Retry your request. // // - ResourceNotFoundException -// This exception is thrown when a resource referenced by the operation does -// not exist +// The specified resource ARN was not found. Check the ARN and try your request +// again. // // See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListAgentAliases func (c *BedrockAgent) ListAgentAliases(input *ListAgentAliasesInput) (*ListAgentAliasesOutput, error) { @@ -2363,7 +2402,8 @@ func (c *BedrockAgent) ListAgentKnowledgeBasesRequest(input *ListAgentKnowledgeB // ListAgentKnowledgeBases API operation for Agents for Amazon Bedrock. // -// # List of Knowledge Bases associated to an existing Amazon Bedrock Agent Version +// Lists knowledge bases associated with an agent and information about each +// one. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2375,21 +2415,20 @@ func (c *BedrockAgent) ListAgentKnowledgeBasesRequest(input *ListAgentKnowledgeB // Returned Error Types: // // - ThrottlingException -// This exception is thrown when the number of requests exceeds the limit +// The number of requests exceeds the limit. Resubmit your request later. // // - AccessDeniedException -// This exception is thrown when a request is denied per access permissions +// The request is denied because of missing access permissions. // // - ValidationException -// This exception is thrown when the request's input validation fails +// Input validation failed. Check your request parameters and retry the request. // // - InternalServerException -// This exception is thrown if there was an unexpected error during processing -// of request +// An internal server error occurred. Retry your request. // // - ResourceNotFoundException -// This exception is thrown when a resource referenced by the operation does -// not exist +// The specified resource ARN was not found. Check the ARN and try your request +// again. // // See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListAgentKnowledgeBases func (c *BedrockAgent) ListAgentKnowledgeBases(input *ListAgentKnowledgeBasesInput) (*ListAgentKnowledgeBasesOutput, error) { @@ -2513,7 +2552,7 @@ func (c *BedrockAgent) ListAgentVersionsRequest(input *ListAgentVersionsInput) ( // ListAgentVersions API operation for Agents for Amazon Bedrock. // -// # Lists Agent Versions +// Lists the versions of an agent and information about each version. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2525,21 +2564,20 @@ func (c *BedrockAgent) ListAgentVersionsRequest(input *ListAgentVersionsInput) ( // Returned Error Types: // // - ThrottlingException -// This exception is thrown when the number of requests exceeds the limit +// The number of requests exceeds the limit. Resubmit your request later. // // - AccessDeniedException -// This exception is thrown when a request is denied per access permissions +// The request is denied because of missing access permissions. // // - ValidationException -// This exception is thrown when the request's input validation fails +// Input validation failed. Check your request parameters and retry the request. // // - InternalServerException -// This exception is thrown if there was an unexpected error during processing -// of request +// An internal server error occurred. Retry your request. // // - ResourceNotFoundException -// This exception is thrown when a resource referenced by the operation does -// not exist +// The specified resource ARN was not found. Check the ARN and try your request +// again. // // See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListAgentVersions func (c *BedrockAgent) ListAgentVersions(input *ListAgentVersionsInput) (*ListAgentVersionsOutput, error) { @@ -2663,7 +2701,7 @@ func (c *BedrockAgent) ListAgentsRequest(input *ListAgentsInput) (req *request.R // ListAgents API operation for Agents for Amazon Bedrock. // -// # Lists Agents +// Lists the agents belonging to an account and information about each agent. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2675,17 +2713,16 @@ func (c *BedrockAgent) ListAgentsRequest(input *ListAgentsInput) (req *request.R // Returned Error Types: // // - ThrottlingException -// This exception is thrown when the number of requests exceeds the limit +// The number of requests exceeds the limit. Resubmit your request later. // // - AccessDeniedException -// This exception is thrown when a request is denied per access permissions +// The request is denied because of missing access permissions. // // - ValidationException -// This exception is thrown when the request's input validation fails +// Input validation failed. Check your request parameters and retry the request. // // - InternalServerException -// This exception is thrown if there was an unexpected error during processing -// of request +// An internal server error occurred. Retry your request. // // See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListAgents func (c *BedrockAgent) ListAgents(input *ListAgentsInput) (*ListAgentsOutput, error) { @@ -2809,7 +2846,7 @@ func (c *BedrockAgent) ListDataSourcesRequest(input *ListDataSourcesInput) (req // ListDataSources API operation for Agents for Amazon Bedrock. // -// # List data sources +// Lists the data sources in a knowledge base and information about each one. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2821,21 +2858,20 @@ func (c *BedrockAgent) ListDataSourcesRequest(input *ListDataSourcesInput) (req // Returned Error Types: // // - ThrottlingException -// This exception is thrown when the number of requests exceeds the limit +// The number of requests exceeds the limit. Resubmit your request later. // // - AccessDeniedException -// This exception is thrown when a request is denied per access permissions +// The request is denied because of missing access permissions. // // - ValidationException -// This exception is thrown when the request's input validation fails +// Input validation failed. Check your request parameters and retry the request. // // - InternalServerException -// This exception is thrown if there was an unexpected error during processing -// of request +// An internal server error occurred. Retry your request. // // - ResourceNotFoundException -// This exception is thrown when a resource referenced by the operation does -// not exist +// The specified resource ARN was not found. Check the ARN and try your request +// again. // // See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListDataSources func (c *BedrockAgent) ListDataSources(input *ListDataSourcesInput) (*ListDataSourcesOutput, error) { @@ -2959,7 +2995,8 @@ func (c *BedrockAgent) ListIngestionJobsRequest(input *ListIngestionJobsInput) ( // ListIngestionJobs API operation for Agents for Amazon Bedrock. // -// # List ingestion jobs +// Lists the ingestion jobs for a data source and information about each of +// them. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2971,21 +3008,20 @@ func (c *BedrockAgent) ListIngestionJobsRequest(input *ListIngestionJobsInput) ( // Returned Error Types: // // - ThrottlingException -// This exception is thrown when the number of requests exceeds the limit +// The number of requests exceeds the limit. Resubmit your request later. // // - AccessDeniedException -// This exception is thrown when a request is denied per access permissions +// The request is denied because of missing access permissions. // // - ValidationException -// This exception is thrown when the request's input validation fails +// Input validation failed. Check your request parameters and retry the request. // // - InternalServerException -// This exception is thrown if there was an unexpected error during processing -// of request +// An internal server error occurred. Retry your request. // // - ResourceNotFoundException -// This exception is thrown when a resource referenced by the operation does -// not exist +// The specified resource ARN was not found. Check the ARN and try your request +// again. // // See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListIngestionJobs func (c *BedrockAgent) ListIngestionJobs(input *ListIngestionJobsInput) (*ListIngestionJobsOutput, error) { @@ -3109,7 +3145,7 @@ func (c *BedrockAgent) ListKnowledgeBasesRequest(input *ListKnowledgeBasesInput) // ListKnowledgeBases API operation for Agents for Amazon Bedrock. // -// # List Knowledge Bases +// Lists the knowledge bases in an account and information about each of them. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3121,17 +3157,16 @@ func (c *BedrockAgent) ListKnowledgeBasesRequest(input *ListKnowledgeBasesInput) // Returned Error Types: // // - ThrottlingException -// This exception is thrown when the number of requests exceeds the limit +// The number of requests exceeds the limit. Resubmit your request later. // // - AccessDeniedException -// This exception is thrown when a request is denied per access permissions +// The request is denied because of missing access permissions. // // - ValidationException -// This exception is thrown when the request's input validation fails +// Input validation failed. Check your request parameters and retry the request. // // - InternalServerException -// This exception is thrown if there was an unexpected error during processing -// of request +// An internal server error occurred. Retry your request. // // See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListKnowledgeBases func (c *BedrockAgent) ListKnowledgeBases(input *ListKnowledgeBasesInput) (*ListKnowledgeBasesOutput, error) { @@ -3249,7 +3284,7 @@ func (c *BedrockAgent) ListTagsForResourceRequest(input *ListTagsForResourceInpu // ListTagsForResource API operation for Agents for Amazon Bedrock. // -// # List tags for a resource +// List all the tags for the resource you specify. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3261,21 +3296,20 @@ func (c *BedrockAgent) ListTagsForResourceRequest(input *ListTagsForResourceInpu // Returned Error Types: // // - ThrottlingException -// This exception is thrown when the number of requests exceeds the limit +// The number of requests exceeds the limit. Resubmit your request later. // // - AccessDeniedException -// This exception is thrown when a request is denied per access permissions +// The request is denied because of missing access permissions. // // - ValidationException -// This exception is thrown when the request's input validation fails +// Input validation failed. Check your request parameters and retry the request. // // - InternalServerException -// This exception is thrown if there was an unexpected error during processing -// of request +// An internal server error occurred. Retry your request. // // - ResourceNotFoundException -// This exception is thrown when a resource referenced by the operation does -// not exist +// The specified resource ARN was not found. Check the ARN and try your request +// again. // // See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListTagsForResource func (c *BedrockAgent) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error) { @@ -3342,7 +3376,7 @@ func (c *BedrockAgent) PrepareAgentRequest(input *PrepareAgentInput) (req *reque // PrepareAgent API operation for Agents for Amazon Bedrock. // -// # Prepares an existing Amazon Bedrock Agent to receive runtime requests +// Creates a DRAFT version of the agent that can be used for internal testing. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3354,27 +3388,26 @@ func (c *BedrockAgent) PrepareAgentRequest(input *PrepareAgentInput) (req *reque // Returned Error Types: // // - ThrottlingException -// This exception is thrown when the number of requests exceeds the limit +// The number of requests exceeds the limit. Resubmit your request later. // // - AccessDeniedException -// This exception is thrown when a request is denied per access permissions +// The request is denied because of missing access permissions. // // - ValidationException -// This exception is thrown when the request's input validation fails +// Input validation failed. Check your request parameters and retry the request. // // - InternalServerException -// This exception is thrown if there was an unexpected error during processing -// of request +// An internal server error occurred. Retry your request. // // - ResourceNotFoundException -// This exception is thrown when a resource referenced by the operation does -// not exist +// The specified resource ARN was not found. Check the ARN and try your request +// again. // // - ConflictException -// This exception is thrown when there is a conflict performing an operation +// There was a conflict performing an operation. // // - ServiceQuotaExceededException -// This exception is thrown when a request is made beyond the service quota +// The number of requests exceeds the service quota. Resubmit your request later. // // See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/PrepareAgent func (c *BedrockAgent) PrepareAgent(input *PrepareAgentInput) (*PrepareAgentOutput, error) { @@ -3441,7 +3474,7 @@ func (c *BedrockAgent) StartIngestionJobRequest(input *StartIngestionJobInput) ( // StartIngestionJob API operation for Agents for Amazon Bedrock. // -// # Start a new ingestion job +// Begins an ingestion job, in which a data source is added to a knowledge base. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3453,27 +3486,26 @@ func (c *BedrockAgent) StartIngestionJobRequest(input *StartIngestionJobInput) ( // Returned Error Types: // // - ThrottlingException -// This exception is thrown when the number of requests exceeds the limit +// The number of requests exceeds the limit. Resubmit your request later. // // - AccessDeniedException -// This exception is thrown when a request is denied per access permissions +// The request is denied because of missing access permissions. // // - ValidationException -// This exception is thrown when the request's input validation fails +// Input validation failed. Check your request parameters and retry the request. // // - InternalServerException -// This exception is thrown if there was an unexpected error during processing -// of request +// An internal server error occurred. Retry your request. // // - ResourceNotFoundException -// This exception is thrown when a resource referenced by the operation does -// not exist +// The specified resource ARN was not found. Check the ARN and try your request +// again. // // - ConflictException -// This exception is thrown when there is a conflict performing an operation +// There was a conflict performing an operation. // // - ServiceQuotaExceededException -// This exception is thrown when a request is made beyond the service quota +// The number of requests exceeds the service quota. Resubmit your request later. // // See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/StartIngestionJob func (c *BedrockAgent) StartIngestionJob(input *StartIngestionJobInput) (*StartIngestionJobOutput, error) { @@ -3541,7 +3573,9 @@ func (c *BedrockAgent) TagResourceRequest(input *TagResourceInput) (req *request // TagResource API operation for Agents for Amazon Bedrock. // -// # Tag a resource +// Associate tags with a resource. For more information, see Tagging resources +// (https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html) +// in the Amazon Bedrock User Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3553,24 +3587,23 @@ func (c *BedrockAgent) TagResourceRequest(input *TagResourceInput) (req *request // Returned Error Types: // // - ThrottlingException -// This exception is thrown when the number of requests exceeds the limit +// The number of requests exceeds the limit. Resubmit your request later. // // - AccessDeniedException -// This exception is thrown when a request is denied per access permissions +// The request is denied because of missing access permissions. // // - ValidationException -// This exception is thrown when the request's input validation fails +// Input validation failed. Check your request parameters and retry the request. // // - InternalServerException -// This exception is thrown if there was an unexpected error during processing -// of request +// An internal server error occurred. Retry your request. // // - ResourceNotFoundException -// This exception is thrown when a resource referenced by the operation does -// not exist +// The specified resource ARN was not found. Check the ARN and try your request +// again. // // - ServiceQuotaExceededException -// This exception is thrown when a request is made beyond the service quota +// The number of requests exceeds the service quota. Resubmit your request later. // // See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/TagResource func (c *BedrockAgent) TagResource(input *TagResourceInput) (*TagResourceOutput, error) { @@ -3638,7 +3671,7 @@ func (c *BedrockAgent) UntagResourceRequest(input *UntagResourceInput) (req *req // UntagResource API operation for Agents for Amazon Bedrock. // -// # Untag a resource +// Remove tags from a resource. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3650,21 +3683,20 @@ func (c *BedrockAgent) UntagResourceRequest(input *UntagResourceInput) (req *req // Returned Error Types: // // - ThrottlingException -// This exception is thrown when the number of requests exceeds the limit +// The number of requests exceeds the limit. Resubmit your request later. // // - AccessDeniedException -// This exception is thrown when a request is denied per access permissions +// The request is denied because of missing access permissions. // // - ValidationException -// This exception is thrown when the request's input validation fails +// Input validation failed. Check your request parameters and retry the request. // // - InternalServerException -// This exception is thrown if there was an unexpected error during processing -// of request +// An internal server error occurred. Retry your request. // // - ResourceNotFoundException -// This exception is thrown when a resource referenced by the operation does -// not exist +// The specified resource ARN was not found. Check the ARN and try your request +// again. // // See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/UntagResource func (c *BedrockAgent) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error) { @@ -3731,7 +3763,7 @@ func (c *BedrockAgent) UpdateAgentRequest(input *UpdateAgentInput) (req *request // UpdateAgent API operation for Agents for Amazon Bedrock. // -// # Updates an existing Amazon Bedrock Agent +// Updates the configuration of an agent. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3743,27 +3775,26 @@ func (c *BedrockAgent) UpdateAgentRequest(input *UpdateAgentInput) (req *request // Returned Error Types: // // - ThrottlingException -// This exception is thrown when the number of requests exceeds the limit +// The number of requests exceeds the limit. Resubmit your request later. // // - AccessDeniedException -// This exception is thrown when a request is denied per access permissions +// The request is denied because of missing access permissions. // // - ValidationException -// This exception is thrown when the request's input validation fails +// Input validation failed. Check your request parameters and retry the request. // // - InternalServerException -// This exception is thrown if there was an unexpected error during processing -// of request +// An internal server error occurred. Retry your request. // // - ResourceNotFoundException -// This exception is thrown when a resource referenced by the operation does -// not exist +// The specified resource ARN was not found. Check the ARN and try your request +// again. // // - ConflictException -// This exception is thrown when there is a conflict performing an operation +// There was a conflict performing an operation. // // - ServiceQuotaExceededException -// This exception is thrown when a request is made beyond the service quota +// The number of requests exceeds the service quota. Resubmit your request later. // // See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/UpdateAgent func (c *BedrockAgent) UpdateAgent(input *UpdateAgentInput) (*UpdateAgentOutput, error) { @@ -3830,7 +3861,7 @@ func (c *BedrockAgent) UpdateAgentActionGroupRequest(input *UpdateAgentActionGro // UpdateAgentActionGroup API operation for Agents for Amazon Bedrock. // -// # Updates an existing Action Group for Amazon Bedrock Agent +// Updates the configuration for an action group for an agent. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3842,27 +3873,26 @@ func (c *BedrockAgent) UpdateAgentActionGroupRequest(input *UpdateAgentActionGro // Returned Error Types: // // - ThrottlingException -// This exception is thrown when the number of requests exceeds the limit +// The number of requests exceeds the limit. Resubmit your request later. // // - AccessDeniedException -// This exception is thrown when a request is denied per access permissions +// The request is denied because of missing access permissions. // // - ValidationException -// This exception is thrown when the request's input validation fails +// Input validation failed. Check your request parameters and retry the request. // // - InternalServerException -// This exception is thrown if there was an unexpected error during processing -// of request +// An internal server error occurred. Retry your request. // // - ResourceNotFoundException -// This exception is thrown when a resource referenced by the operation does -// not exist +// The specified resource ARN was not found. Check the ARN and try your request +// again. // // - ConflictException -// This exception is thrown when there is a conflict performing an operation +// There was a conflict performing an operation. // // - ServiceQuotaExceededException -// This exception is thrown when a request is made beyond the service quota +// The number of requests exceeds the service quota. Resubmit your request later. // // See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/UpdateAgentActionGroup func (c *BedrockAgent) UpdateAgentActionGroup(input *UpdateAgentActionGroupInput) (*UpdateAgentActionGroupOutput, error) { @@ -3929,7 +3959,7 @@ func (c *BedrockAgent) UpdateAgentAliasRequest(input *UpdateAgentAliasInput) (re // UpdateAgentAlias API operation for Agents for Amazon Bedrock. // -// # Updates an existing Alias for an Amazon Bedrock Agent +// Updates configurations for an alias of an agent. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3941,27 +3971,26 @@ func (c *BedrockAgent) UpdateAgentAliasRequest(input *UpdateAgentAliasInput) (re // Returned Error Types: // // - ThrottlingException -// This exception is thrown when the number of requests exceeds the limit +// The number of requests exceeds the limit. Resubmit your request later. // // - AccessDeniedException -// This exception is thrown when a request is denied per access permissions +// The request is denied because of missing access permissions. // // - ValidationException -// This exception is thrown when the request's input validation fails +// Input validation failed. Check your request parameters and retry the request. // // - InternalServerException -// This exception is thrown if there was an unexpected error during processing -// of request +// An internal server error occurred. Retry your request. // // - ResourceNotFoundException -// This exception is thrown when a resource referenced by the operation does -// not exist +// The specified resource ARN was not found. Check the ARN and try your request +// again. // // - ConflictException -// This exception is thrown when there is a conflict performing an operation +// There was a conflict performing an operation. // // - ServiceQuotaExceededException -// This exception is thrown when a request is made beyond the service quota +// The number of requests exceeds the service quota. Resubmit your request later. // // See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/UpdateAgentAlias func (c *BedrockAgent) UpdateAgentAlias(input *UpdateAgentAliasInput) (*UpdateAgentAliasOutput, error) { @@ -4028,7 +4057,8 @@ func (c *BedrockAgent) UpdateAgentKnowledgeBaseRequest(input *UpdateAgentKnowled // UpdateAgentKnowledgeBase API operation for Agents for Amazon Bedrock. // -// # Updates an existing Knowledge Base associated to an Amazon Bedrock Agent +// Updates the configuration for a knowledge base that has been associated with +// an agent. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -4040,24 +4070,23 @@ func (c *BedrockAgent) UpdateAgentKnowledgeBaseRequest(input *UpdateAgentKnowled // Returned Error Types: // // - ThrottlingException -// This exception is thrown when the number of requests exceeds the limit +// The number of requests exceeds the limit. Resubmit your request later. // // - AccessDeniedException -// This exception is thrown when a request is denied per access permissions +// The request is denied because of missing access permissions. // // - ValidationException -// This exception is thrown when the request's input validation fails +// Input validation failed. Check your request parameters and retry the request. // // - InternalServerException -// This exception is thrown if there was an unexpected error during processing -// of request +// An internal server error occurred. Retry your request. // // - ResourceNotFoundException -// This exception is thrown when a resource referenced by the operation does -// not exist +// The specified resource ARN was not found. Check the ARN and try your request +// again. // // - ConflictException -// This exception is thrown when there is a conflict performing an operation +// There was a conflict performing an operation. // // See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/UpdateAgentKnowledgeBase func (c *BedrockAgent) UpdateAgentKnowledgeBase(input *UpdateAgentKnowledgeBaseInput) (*UpdateAgentKnowledgeBaseOutput, error) { @@ -4124,7 +4153,10 @@ func (c *BedrockAgent) UpdateDataSourceRequest(input *UpdateDataSourceInput) (re // UpdateDataSource API operation for Agents for Amazon Bedrock. // -// # Update an existing data source +// Updates configurations for a data source. +// +// You can't change the chunkingConfiguration after you create the data source. +// Specify the existing chunkingConfiguration. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -4136,24 +4168,23 @@ func (c *BedrockAgent) UpdateDataSourceRequest(input *UpdateDataSourceInput) (re // Returned Error Types: // // - ThrottlingException -// This exception is thrown when the number of requests exceeds the limit +// The number of requests exceeds the limit. Resubmit your request later. // // - AccessDeniedException -// This exception is thrown when a request is denied per access permissions +// The request is denied because of missing access permissions. // // - ValidationException -// This exception is thrown when the request's input validation fails +// Input validation failed. Check your request parameters and retry the request. // // - InternalServerException -// This exception is thrown if there was an unexpected error during processing -// of request +// An internal server error occurred. Retry your request. // // - ResourceNotFoundException -// This exception is thrown when a resource referenced by the operation does -// not exist +// The specified resource ARN was not found. Check the ARN and try your request +// again. // // - ConflictException -// This exception is thrown when there is a conflict performing an operation +// There was a conflict performing an operation. // // See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/UpdateDataSource func (c *BedrockAgent) UpdateDataSource(input *UpdateDataSourceInput) (*UpdateDataSourceOutput, error) { @@ -4220,7 +4251,22 @@ func (c *BedrockAgent) UpdateKnowledgeBaseRequest(input *UpdateKnowledgeBaseInpu // UpdateKnowledgeBase API operation for Agents for Amazon Bedrock. // -// # Update an existing knowledge base +// 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 (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetKnowledgeBase.html) +// request and copy the same configurations. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -4232,24 +4278,23 @@ func (c *BedrockAgent) UpdateKnowledgeBaseRequest(input *UpdateKnowledgeBaseInpu // Returned Error Types: // // - ThrottlingException -// This exception is thrown when the number of requests exceeds the limit +// The number of requests exceeds the limit. Resubmit your request later. // // - AccessDeniedException -// This exception is thrown when a request is denied per access permissions +// The request is denied because of missing access permissions. // // - ValidationException -// This exception is thrown when the request's input validation fails +// Input validation failed. Check your request parameters and retry the request. // // - InternalServerException -// This exception is thrown if there was an unexpected error during processing -// of request +// An internal server error occurred. Retry your request. // // - ResourceNotFoundException -// This exception is thrown when a resource referenced by the operation does -// not exist +// The specified resource ARN was not found. Check the ARN and try your request +// again. // // - ConflictException -// This exception is thrown when there is a conflict performing an operation +// There was a conflict performing an operation. // // See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/UpdateKnowledgeBase func (c *BedrockAgent) UpdateKnowledgeBase(input *UpdateKnowledgeBaseInput) (*UpdateKnowledgeBaseOutput, error) { @@ -4273,18 +4318,23 @@ func (c *BedrockAgent) UpdateKnowledgeBaseWithContext(ctx aws.Context, input *Up return out, req.Send() } -// Contains information about the API Schema for the Action Group +// Contains details about the OpenAPI schema for the action group. For more +// information, see Action group OpenAPI schemas (https://docs.aws.amazon.com/bedrock/latest/userguide/agents-api-schema.html). +// 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. type APISchema struct { _ struct{} `type:"structure"` - // String OpenAPI Payload + // The JSON or YAML-formatted payload defining the OpenAPI schema for the action + // group. For more information, see Action group OpenAPI schemas (https://docs.aws.amazon.com/bedrock/latest/userguide/agents-api-schema.html). // // Payload is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by APISchema's // String and GoString methods. Payload *string `locationName:"payload" type:"string" sensitive:"true"` - // The identifier for the S3 resource. + // Contains details about the S3 object containing the OpenAPI schema for the + // action group. For more information, see Action group OpenAPI schemas (https://docs.aws.amazon.com/bedrock/latest/userguide/agents-api-schema.html). S3 *S3Identifier `locationName:"s3" type:"structure"` } @@ -4333,12 +4383,11 @@ func (s *APISchema) SetS3(v *S3Identifier) *APISchema { return s } -// This exception is thrown when a request is denied per access permissions +// The request is denied because of missing access permissions. type AccessDeniedException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` - // Non Blank String Message_ *string `locationName:"message" type:"string"` } @@ -4398,11 +4447,13 @@ func (s *AccessDeniedException) RequestID() string { return s.RespMetadata.RequestID } -// Type of Executors for an Action Group +// Contains details about the Lambda function containing the business logic +// that is carried out upon invoking the action. type ActionGroupExecutor struct { _ struct{} `type:"structure"` - // ARN of a Lambda. + // The ARN of the Lambda function containing the business logic that is carried + // out upon invoking the action. Lambda *string `locationName:"lambda" type:"string"` } @@ -4430,29 +4481,31 @@ func (s *ActionGroupExecutor) SetLambda(v string) *ActionGroupExecutor { return s } -// ActionGroup Summary +// Contains details about an action group. type ActionGroupSummary struct { _ struct{} `type:"structure"` - // Identifier for a resource. + // The unique identifier of the action group. // // ActionGroupId is a required field ActionGroupId *string `locationName:"actionGroupId" type:"string" required:"true"` - // Name for a resource. + // The name of the action group. // // ActionGroupName is a required field ActionGroupName *string `locationName:"actionGroupName" type:"string" required:"true"` - // State of the action group + // Specifies whether the action group is available for the agent to invoke or + // not when sending an InvokeAgent (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html) + // request. // // ActionGroupState is a required field ActionGroupState *string `locationName:"actionGroupState" type:"string" required:"true" enum:"ActionGroupState"` - // Description of the Resource. + // The description of the action group. Description *string `locationName:"description" min:"1" type:"string"` - // Time Stamp. + // The time at which the action group was last updated. // // UpdatedAt is a required field UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp" timestampFormat:"iso8601" required:"true"` @@ -4506,86 +4559,113 @@ func (s *ActionGroupSummary) SetUpdatedAt(v time.Time) *ActionGroupSummary { return s } -// Contains the information of an agent +// Contains details about an agent. type Agent struct { _ struct{} `type:"structure"` - // Arn representation of the Agent. + // The ARN of the agent. // // AgentArn is a required field AgentArn *string `locationName:"agentArn" type:"string" required:"true"` - // Identifier for a resource. + // The unique identifier of the agent. // // AgentId is a required field AgentId *string `locationName:"agentId" type:"string" required:"true"` - // Name for a resource. + // The name of the agent. // // AgentName is a required field AgentName *string `locationName:"agentName" type:"string" required:"true"` - // ARN of a IAM role. + // The ARN of the IAM role with permissions to call API operations on the agent. + // The ARN must begin with AmazonBedrockExecutionRoleForAgents_. // // AgentResourceRoleArn is a required field AgentResourceRoleArn *string `locationName:"agentResourceRoleArn" type:"string" required:"true"` - // Schema Type for Action APIs. + // 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. // // AgentStatus is a required field AgentStatus *string `locationName:"agentStatus" type:"string" required:"true" enum:"AgentStatus"` - // Draft Agent Version. + // The version of the agent. // // AgentVersion is a required field AgentVersion *string `locationName:"agentVersion" min:"5" type:"string" required:"true"` - // Client specified token used for idempotency checks + // 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 (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). ClientToken *string `locationName:"clientToken" min:"33" type:"string"` - // Time Stamp. + // The time at which the agent was created. // // CreatedAt is a required field CreatedAt *time.Time `locationName:"createdAt" type:"timestamp" timestampFormat:"iso8601" required:"true"` - // A KMS key ARN + // The ARN of the KMS key that encrypts the agent. CustomerEncryptionKeyArn *string `locationName:"customerEncryptionKeyArn" min:"1" type:"string"` - // Description of the Resource. + // The description of the agent. Description *string `locationName:"description" min:"1" type:"string"` - // Failure Reasons for Error. + // Contains reasons that the agent-related API that you invoked failed. FailureReasons []*string `locationName:"failureReasons" type:"list"` - // ARN or name of a Bedrock model. + // The foundation model used for orchestration by the agent. FoundationModel *string `locationName:"foundationModel" min:"1" type:"string"` - // Max Session Time. + // 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. // // IdleSessionTTLInSeconds is a required field IdleSessionTTLInSeconds *int64 `locationName:"idleSessionTTLInSeconds" min:"60" type:"integer" required:"true"` - // Instruction for the agent. + // Instructions that tell the agent what it should do and how it should interact + // with users. // // Instruction is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by Agent's // String and GoString methods. Instruction *string `locationName:"instruction" min:"40" type:"string" sensitive:"true"` - // Time Stamp. + // The time at which the agent was last prepared. PreparedAt *time.Time `locationName:"preparedAt" type:"timestamp" timestampFormat:"iso8601"` - // Configuration for prompt override. + // Contains configurations to override prompt templates in different parts of + // an agent sequence. For more information, see Advanced prompts (https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html). // // PromptOverrideConfiguration is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by Agent's // String and GoString methods. PromptOverrideConfiguration *PromptOverrideConfiguration `locationName:"promptOverrideConfiguration" type:"structure" sensitive:"true"` - // The recommended actions users can take to resolve an error in failureReasons. + // Contains recommended actions to take for the agent-related API that you invoked + // to succeed. RecommendedActions []*string `locationName:"recommendedActions" type:"list"` - // Time Stamp. + // The time at which the agent was last updated. // // UpdatedAt is a required field UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp" timestampFormat:"iso8601" required:"true"` @@ -4717,56 +4797,72 @@ func (s *Agent) SetUpdatedAt(v time.Time) *Agent { return s } -// Contains the information of an Agent Action Group +// Contains details about an action group. type AgentActionGroup struct { _ struct{} `type:"structure"` - // Type of Executors for an Action Group + // The ARN of the Lambda function containing the business logic that is carried + // out upon invoking the action. ActionGroupExecutor *ActionGroupExecutor `locationName:"actionGroupExecutor" type:"structure"` - // Identifier for a resource. + // The unique identifier of the action group. // // ActionGroupId is a required field ActionGroupId *string `locationName:"actionGroupId" type:"string" required:"true"` - // Name for a resource. + // The name of the action group. // // ActionGroupName is a required field ActionGroupName *string `locationName:"actionGroupName" type:"string" required:"true"` - // State of the action group + // Specifies whether the action group is available for the agent to invoke or + // not when sending an InvokeAgent (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html) + // request. // // ActionGroupState is a required field ActionGroupState *string `locationName:"actionGroupState" type:"string" required:"true" enum:"ActionGroupState"` - // Identifier for a resource. + // The unique identifier of the agent to which the action group belongs. // // AgentId is a required field AgentId *string `locationName:"agentId" type:"string" required:"true"` - // Agent Version. + // The version of the agent to which the action group belongs. // // AgentVersion is a required field AgentVersion *string `locationName:"agentVersion" min:"1" type:"string" required:"true"` - // Contains information about the API Schema for the Action Group + // 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 (https://docs.aws.amazon.com/bedrock/latest/userguide/agents-api-schema.html). ApiSchema *APISchema `locationName:"apiSchema" type:"structure"` - // Client specified token used for idempotency checks + // 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 (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). ClientToken *string `locationName:"clientToken" min:"33" type:"string"` - // Time Stamp. + // The time at which the action group was created. // // CreatedAt is a required field CreatedAt *time.Time `locationName:"createdAt" type:"timestamp" timestampFormat:"iso8601" required:"true"` - // Description of the Resource. + // The description of the action group. Description *string `locationName:"description" min:"1" type:"string"` - // Action Group Signature for a BuiltIn Action + // 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 + // (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Observation.html) + // reprompting the user for more information. ParentActionSignature *string `locationName:"parentActionSignature" type:"string" enum:"ActionGroupSignature"` - // Time Stamp. + // The time at which the action group was last updated. // // UpdatedAt is a required field UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp" timestampFormat:"iso8601" required:"true"` @@ -4862,55 +4958,70 @@ func (s *AgentActionGroup) SetUpdatedAt(v time.Time) *AgentActionGroup { return s } -// Contains the information of an agent alias +// Contains details about an alias of an agent. type AgentAlias struct { _ struct{} `type:"structure"` - // Arn representation of the Agent Alias. + // The ARN of the alias of the agent. // // AgentAliasArn is a required field AgentAliasArn *string `locationName:"agentAliasArn" type:"string" required:"true"` - // The list of history events for an alias for an Agent. + // Contains details about the history of the alias. AgentAliasHistoryEvents []*AgentAliasHistoryEvent `locationName:"agentAliasHistoryEvents" type:"list"` - // Id for an Agent Alias generated at the server side. + // The unique identifier of the alias of the agent. // // AgentAliasId is a required field AgentAliasId *string `locationName:"agentAliasId" min:"10" type:"string" required:"true"` - // Name for a resource. + // The name of the alias of the agent. // // AgentAliasName is a required field AgentAliasName *string `locationName:"agentAliasName" type:"string" required:"true"` - // The statuses an Agent Alias can be in. + // 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. // // AgentAliasStatus is a required field AgentAliasStatus *string `locationName:"agentAliasStatus" type:"string" required:"true" enum:"AgentAliasStatus"` - // Identifier for a resource. + // The unique identifier of the agent. // // AgentId is a required field AgentId *string `locationName:"agentId" type:"string" required:"true"` - // Client specified token used for idempotency checks + // 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 (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). ClientToken *string `locationName:"clientToken" min:"33" type:"string"` - // Time Stamp. + // The time at which the alias of the agent was created. // // CreatedAt is a required field CreatedAt *time.Time `locationName:"createdAt" type:"timestamp" timestampFormat:"iso8601" required:"true"` - // Description of the Resource. + // The description of the alias of the agent. Description *string `locationName:"description" min:"1" type:"string"` - // Routing configuration for an Agent alias. + // Contains details about the routing configuration of the alias. // // RoutingConfiguration is a required field RoutingConfiguration []*AgentAliasRoutingConfigurationListItem `locationName:"routingConfiguration" type:"list" required:"true"` - // Time Stamp. + // The time at which the alias was last updated. // // UpdatedAt is a required field UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp" timestampFormat:"iso8601" required:"true"` @@ -5000,17 +5111,19 @@ func (s *AgentAlias) SetUpdatedAt(v time.Time) *AgentAlias { return s } -// History event for an alias for an Agent. +// Contains details about the history of the alias. type AgentAliasHistoryEvent struct { _ struct{} `type:"structure"` - // Time Stamp. + // The date that the alias stopped being associated to the version in the routingConfiguration + // object EndDate *time.Time `locationName:"endDate" type:"timestamp" timestampFormat:"iso8601"` - // Routing configuration for an Agent alias. + // Contains details about the version of the agent with which the alias is associated. RoutingConfiguration []*AgentAliasRoutingConfigurationListItem `locationName:"routingConfiguration" type:"list"` - // Time Stamp. + // The date that the alias began being associated to the version in the routingConfiguration + // object. StartDate *time.Time `locationName:"startDate" type:"timestamp" timestampFormat:"iso8601"` } @@ -5050,11 +5163,11 @@ func (s *AgentAliasHistoryEvent) SetStartDate(v time.Time) *AgentAliasHistoryEve return s } -// Details about the routing configuration for an Agent alias. +// Contains details about the routing configuration of the alias. type AgentAliasRoutingConfigurationListItem struct { _ struct{} `type:"structure"` - // Agent Version. + // The version of the agent with which the alias is associated. // // AgentVersion is a required field AgentVersion *string `locationName:"agentVersion" min:"1" type:"string" required:"true"` @@ -5100,37 +5213,37 @@ func (s *AgentAliasRoutingConfigurationListItem) SetAgentVersion(v string) *Agen return s } -// Summary of an alias for an Agent. +// Contains details about an alias of an agent. type AgentAliasSummary struct { _ struct{} `type:"structure"` - // Id for an Agent Alias generated at the server side. + // Contains details about // // AgentAliasId is a required field AgentAliasId *string `locationName:"agentAliasId" min:"10" type:"string" required:"true"` - // Name for a resource. + // The name of the alias. // // AgentAliasName is a required field AgentAliasName *string `locationName:"agentAliasName" type:"string" required:"true"` - // The statuses an Agent Alias can be in. + // The status of the alias. // // AgentAliasStatus is a required field AgentAliasStatus *string `locationName:"agentAliasStatus" type:"string" required:"true" enum:"AgentAliasStatus"` - // Time Stamp. + // The time at which the alias of the agent was created. // // CreatedAt is a required field CreatedAt *time.Time `locationName:"createdAt" type:"timestamp" timestampFormat:"iso8601" required:"true"` - // Description of the Resource. + // The description of the alias. Description *string `locationName:"description" min:"1" type:"string"` - // Routing configuration for an Agent alias. + // Contains details about the version of the agent with which the alias is associated. RoutingConfiguration []*AgentAliasRoutingConfigurationListItem `locationName:"routingConfiguration" type:"list"` - // Time Stamp. + // The time at which the alias was last updated. // // UpdatedAt is a required field UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp" timestampFormat:"iso8601" required:"true"` @@ -5196,41 +5309,46 @@ func (s *AgentAliasSummary) SetUpdatedAt(v time.Time) *AgentAliasSummary { return s } -// Contains the information of an Agent Knowledge Base. +// Contains details about a knowledge base that is associated with an agent. type AgentKnowledgeBase struct { _ struct{} `type:"structure"` - // Identifier for a resource. + // The unique identifier of the agent with which the knowledge base is associated. // // AgentId is a required field AgentId *string `locationName:"agentId" type:"string" required:"true"` - // Agent Version. + // The version of the agent with which the knowledge base is associated. // // AgentVersion is a required field AgentVersion *string `locationName:"agentVersion" min:"1" type:"string" required:"true"` - // Time Stamp. + // The time at which the association between the agent and the knowledge base + // was created. // // CreatedAt is a required field CreatedAt *time.Time `locationName:"createdAt" type:"timestamp" timestampFormat:"iso8601" required:"true"` - // Description of the Resource. + // The description of the association between the agent and the knowledge base. // // Description is a required field Description *string `locationName:"description" min:"1" type:"string" required:"true"` - // Identifier for a resource. + // The unique identifier of the association between the agent and the knowledge + // base. // // KnowledgeBaseId is a required field KnowledgeBaseId *string `locationName:"knowledgeBaseId" type:"string" required:"true"` - // State of the knowledge base; whether it is enabled or disabled + // Specifies whether to use the knowledge base or not when sending an InvokeAgent + // (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html) + // request. // // KnowledgeBaseState is a required field KnowledgeBaseState *string `locationName:"knowledgeBaseState" type:"string" required:"true" enum:"KnowledgeBaseState"` - // Time Stamp. + // The time at which the association between the agent and the knowledge base + // was last updated. // // UpdatedAt is a required field UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp" timestampFormat:"iso8601" required:"true"` @@ -5296,24 +5414,26 @@ func (s *AgentKnowledgeBase) SetUpdatedAt(v time.Time) *AgentKnowledgeBase { return s } -// Agent Knowledge Base Summary +// Contains details about a knowledge base associated with an agent. type AgentKnowledgeBaseSummary struct { _ struct{} `type:"structure"` - // Description of the Resource. + // The description of the knowledge base associated with an agent. Description *string `locationName:"description" min:"1" type:"string"` - // Identifier for a resource. + // The unique identifier of the knowledge base associated with an agent. // // KnowledgeBaseId is a required field KnowledgeBaseId *string `locationName:"knowledgeBaseId" type:"string" required:"true"` - // State of the knowledge base; whether it is enabled or disabled + // Specifies whether the agent uses the knowledge base or not when sending an + // InvokeAgent (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html) + // request. // // KnowledgeBaseState is a required field KnowledgeBaseState *string `locationName:"knowledgeBaseState" type:"string" required:"true" enum:"KnowledgeBaseState"` - // Time Stamp. + // The time at which the knowledge base associated with an agent was last updated. // // UpdatedAt is a required field UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp" timestampFormat:"iso8601" required:"true"` @@ -5361,32 +5481,32 @@ func (s *AgentKnowledgeBaseSummary) SetUpdatedAt(v time.Time) *AgentKnowledgeBas return s } -// Summary of Agent. +// Contains details about an agent. type AgentSummary struct { _ struct{} `type:"structure"` - // Identifier for a resource. + // The unique identifier of the agent. // // AgentId is a required field AgentId *string `locationName:"agentId" type:"string" required:"true"` - // Name for a resource. + // The name of the agent. // // AgentName is a required field AgentName *string `locationName:"agentName" type:"string" required:"true"` - // Schema Type for Action APIs. + // The status of the agent. // // AgentStatus is a required field AgentStatus *string `locationName:"agentStatus" type:"string" required:"true" enum:"AgentStatus"` - // Description of the Resource. + // The description of the agent. Description *string `locationName:"description" min:"1" type:"string"` - // Agent Version. + // The latest version of the agent. LatestAgentVersion *string `locationName:"latestAgentVersion" min:"1" type:"string"` - // Time Stamp. + // The time at which the agent was last updated. // // UpdatedAt is a required field UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp" timestampFormat:"iso8601" required:"true"` @@ -5446,80 +5566,88 @@ func (s *AgentSummary) SetUpdatedAt(v time.Time) *AgentSummary { return s } -// Contains the information of an agent version. +// Contains details about a version of an agent. type AgentVersion struct { _ struct{} `type:"structure"` - // Arn representation of the Agent. + // The ARN of the agent that the version belongs to. // // AgentArn is a required field AgentArn *string `locationName:"agentArn" type:"string" required:"true"` - // Identifier for a resource. + // The unique identifier of the agent that the version belongs to. // // AgentId is a required field AgentId *string `locationName:"agentId" type:"string" required:"true"` - // Name for a resource. + // The name of the agent that the version belongs to. // // AgentName is a required field AgentName *string `locationName:"agentName" type:"string" required:"true"` - // ARN of a IAM role. + // The ARN of the IAM role with permissions to invoke API operations on the + // agent. The ARN must begin with AmazonBedrockExecutionRoleForAgents_. // // AgentResourceRoleArn is a required field AgentResourceRoleArn *string `locationName:"agentResourceRoleArn" type:"string" required:"true"` - // Schema Type for Action APIs. + // The status of the agent that the version belongs to. // // AgentStatus is a required field AgentStatus *string `locationName:"agentStatus" type:"string" required:"true" enum:"AgentStatus"` - // Time Stamp. + // The time at which the version was created. // // CreatedAt is a required field CreatedAt *time.Time `locationName:"createdAt" type:"timestamp" timestampFormat:"iso8601" required:"true"` - // A KMS key ARN + // The ARN of the KMS key that encrypts the agent. CustomerEncryptionKeyArn *string `locationName:"customerEncryptionKeyArn" min:"1" type:"string"` - // Description of the Resource. + // The description of the version. Description *string `locationName:"description" min:"1" type:"string"` - // Failure Reasons for Error. + // A list of reasons that the API operation on the version failed. FailureReasons []*string `locationName:"failureReasons" type:"list"` - // ARN or name of a Bedrock model. + // The foundation model that the version invokes. FoundationModel *string `locationName:"foundationModel" min:"1" type:"string"` - // Max Session Time. + // 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. // // IdleSessionTTLInSeconds is a required field IdleSessionTTLInSeconds *int64 `locationName:"idleSessionTTLInSeconds" min:"60" type:"integer" required:"true"` - // Instruction for the agent. + // The instructions provided to the agent. // // Instruction is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by AgentVersion's // String and GoString methods. Instruction *string `locationName:"instruction" min:"40" type:"string" sensitive:"true"` - // Configuration for prompt override. + // Contains configurations to override prompt templates in different parts of + // an agent sequence. For more information, see Advanced prompts (https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html). // // PromptOverrideConfiguration is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by AgentVersion's // String and GoString methods. PromptOverrideConfiguration *PromptOverrideConfiguration `locationName:"promptOverrideConfiguration" type:"structure" sensitive:"true"` - // The recommended actions users can take to resolve an error in failureReasons. + // A list of recommended actions to take for the failed API operation on the + // version to succeed. RecommendedActions []*string `locationName:"recommendedActions" type:"list"` - // Time Stamp. + // The time at which the version was last updated. // // UpdatedAt is a required field UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp" timestampFormat:"iso8601" required:"true"` - // Numerical Agent Version. + // The version number. // // Version is a required field Version *string `locationName:"version" type:"string" required:"true"` @@ -5639,34 +5767,34 @@ func (s *AgentVersion) SetVersion(v string) *AgentVersion { return s } -// Summary of agent version. +// Contains details about a version of an agent. type AgentVersionSummary struct { _ struct{} `type:"structure"` - // Name for a resource. + // The name of the agent to which the version belongs. // // AgentName is a required field AgentName *string `locationName:"agentName" type:"string" required:"true"` - // Schema Type for Action APIs. + // The status of the agent to which the version belongs. // // AgentStatus is a required field AgentStatus *string `locationName:"agentStatus" type:"string" required:"true" enum:"AgentStatus"` - // Agent Version. + // The version of the agent. // // AgentVersion is a required field AgentVersion *string `locationName:"agentVersion" min:"1" type:"string" required:"true"` - // Time Stamp. + // The time at which the version was created. // // CreatedAt is a required field CreatedAt *time.Time `locationName:"createdAt" type:"timestamp" timestampFormat:"iso8601" required:"true"` - // Description of the Resource. + // The description of the version of the agent. Description *string `locationName:"description" min:"1" type:"string"` - // Time Stamp. + // The time at which the version was last updated. // // UpdatedAt is a required field UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp" timestampFormat:"iso8601" required:"true"` @@ -5726,31 +5854,33 @@ func (s *AgentVersionSummary) SetUpdatedAt(v time.Time) *AgentVersionSummary { return s } -// Associate Agent Knowledge Base Request type AssociateAgentKnowledgeBaseInput struct { _ struct{} `type:"structure"` - // Id generated at the server side when an Agent is created + // The unique identifier of the agent with which you want to associate the knowledge + // base. // // AgentId is a required field AgentId *string `location:"uri" locationName:"agentId" type:"string" required:"true"` - // Draft Version of the Agent. + // The version of the agent with which you want to associate the knowledge base. // // AgentVersion is a required field AgentVersion *string `location:"uri" locationName:"agentVersion" min:"5" type:"string" required:"true"` - // Description of the Resource. + // A description of what the agent should use the knowledge base for. // // Description is a required field Description *string `locationName:"description" min:"1" type:"string" required:"true"` - // Identifier for a resource. + // The unique identifier of the knowledge base to associate with the agent. // // KnowledgeBaseId is a required field KnowledgeBaseId *string `locationName:"knowledgeBaseId" type:"string" required:"true"` - // State of the knowledge base; whether it is enabled or disabled + // Specifies whether to use the knowledge base or not when sending an InvokeAgent + // (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html) + // request. KnowledgeBaseState *string `locationName:"knowledgeBaseState" type:"string" enum:"KnowledgeBaseState"` } @@ -5833,11 +5963,11 @@ func (s *AssociateAgentKnowledgeBaseInput) SetKnowledgeBaseState(v string) *Asso return s } -// Associate Agent Knowledge Base Response type AssociateAgentKnowledgeBaseOutput struct { _ struct{} `type:"structure"` - // Contains the information of an Agent Knowledge Base. + // Contains details about the knowledge base that has been associated with the + // agent. // // AgentKnowledgeBase is a required field AgentKnowledgeBase *AgentKnowledgeBase `locationName:"agentKnowledgeBase" type:"structure" required:"true"` @@ -5867,16 +5997,30 @@ func (s *AssociateAgentKnowledgeBaseOutput) SetAgentKnowledgeBase(v *AgentKnowle return s } -// Configures chunking strategy +// 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. type ChunkingConfiguration struct { _ struct{} `type:"structure"` - // The type of chunking strategy + // 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. // // ChunkingStrategy is a required field ChunkingStrategy *string `locationName:"chunkingStrategy" type:"string" required:"true" enum:"ChunkingStrategy"` - // Configures fixed size chunking strategy + // Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy + // as NONE, exclude this field. FixedSizeChunkingConfiguration *FixedSizeChunkingConfiguration `locationName:"fixedSizeChunkingConfiguration" type:"structure"` } @@ -5928,12 +6072,11 @@ func (s *ChunkingConfiguration) SetFixedSizeChunkingConfiguration(v *FixedSizeCh return s } -// This exception is thrown when there is a conflict performing an operation +// There was a conflict performing an operation. type ConflictException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` - // Non Blank String Message_ *string `locationName:"message" type:"string"` } @@ -5993,41 +6136,57 @@ func (s *ConflictException) RequestID() string { return s.RespMetadata.RequestID } -// Create Action Group Request type CreateAgentActionGroupInput struct { _ struct{} `type:"structure"` - // Type of Executors for an Action Group + // The ARN of the Lambda function containing the business logic that is carried + // out upon invoking the action. ActionGroupExecutor *ActionGroupExecutor `locationName:"actionGroupExecutor" type:"structure"` - // Name for a resource. + // The name to give the action group. // // ActionGroupName is a required field ActionGroupName *string `locationName:"actionGroupName" type:"string" required:"true"` - // State of the action group + // Specifies whether the action group is available for the agent to invoke or + // not when sending an InvokeAgent (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html) + // request. ActionGroupState *string `locationName:"actionGroupState" type:"string" enum:"ActionGroupState"` - // Id generated at the server side when an Agent is created + // The unique identifier of the agent for which to create the action group. // // AgentId is a required field AgentId *string `location:"uri" locationName:"agentId" type:"string" required:"true"` - // Draft Version of the Agent. + // The version of the agent for which to create the action group. // // AgentVersion is a required field AgentVersion *string `location:"uri" locationName:"agentVersion" min:"5" type:"string" required:"true"` - // Contains information about the API Schema for the Action Group + // 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 (https://docs.aws.amazon.com/bedrock/latest/userguide/agents-api-schema.html). ApiSchema *APISchema `locationName:"apiSchema" type:"structure"` - // Client specified token used for idempotency checks + // 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 (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). ClientToken *string `locationName:"clientToken" min:"33" type:"string" idempotencyToken:"true"` - // Description of the Resource. + // A description of the action group. Description *string `locationName:"description" min:"1" type:"string"` - // Action Group Signature for a BuiltIn Action + // 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 + // (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Observation.html) + // reprompting the user for more information. ParentActionGroupSignature *string `locationName:"parentActionGroupSignature" type:"string" enum:"ActionGroupSignature"` } @@ -6139,11 +6298,10 @@ func (s *CreateAgentActionGroupInput) SetParentActionGroupSignature(v string) *C return s } -// Create Action Group Response type CreateAgentActionGroupOutput struct { _ struct{} `type:"structure"` - // Contains the information of an Agent Action Group + // Contains details about the action group that was created. // // AgentActionGroup is a required field AgentActionGroup *AgentActionGroup `locationName:"agentActionGroup" type:"structure" required:"true"` @@ -6173,30 +6331,32 @@ func (s *CreateAgentActionGroupOutput) SetAgentActionGroup(v *AgentActionGroup) return s } -// Create Agent Alias Request type CreateAgentAliasInput struct { _ struct{} `type:"structure"` - // Name for a resource. + // The name of the alias. // // AgentAliasName is a required field AgentAliasName *string `locationName:"agentAliasName" type:"string" required:"true"` - // Id generated at the server side when an Agent is created + // The unique identifier of the agent. // // AgentId is a required field AgentId *string `location:"uri" locationName:"agentId" type:"string" required:"true"` - // Client specified token used for idempotency checks + // 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 (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). ClientToken *string `locationName:"clientToken" min:"33" type:"string" idempotencyToken:"true"` - // Description of the Resource. + // A description of the alias of the agent. Description *string `locationName:"description" min:"1" type:"string"` - // Routing configuration for an Agent alias. + // Contains details about the routing configuration of the alias. RoutingConfiguration []*AgentAliasRoutingConfigurationListItem `locationName:"routingConfiguration" type:"list"` - // A map of tag keys and values + // Any tags that you want to attach to the alias of the agent. Tags map[string]*string `locationName:"tags" type:"map"` } @@ -6289,11 +6449,10 @@ func (s *CreateAgentAliasInput) SetTags(v map[string]*string) *CreateAgentAliasI return s } -// Create Agent Alias Response type CreateAgentAliasOutput struct { _ struct{} `type:"structure"` - // Contains the information of an agent alias + // Contains details about the alias that was created. // // AgentAlias is a required field AgentAlias *AgentAlias `locationName:"agentAlias" type:"structure" required:"true"` @@ -6323,50 +6482,60 @@ func (s *CreateAgentAliasOutput) SetAgentAlias(v *AgentAlias) *CreateAgentAliasO return s } -// Create Agent Request type CreateAgentInput struct { _ struct{} `type:"structure"` - // Name for a resource. + // A name for the agent that you create. // // AgentName is a required field AgentName *string `locationName:"agentName" type:"string" required:"true"` - // ARN of a IAM role. + // The ARN of the IAM role with permissions to create the agent. The ARN must + // begin with AmazonBedrockExecutionRoleForAgents_. // // AgentResourceRoleArn is a required field AgentResourceRoleArn *string `locationName:"agentResourceRoleArn" type:"string" required:"true"` - // Client specified token used for idempotency checks + // 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 (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). ClientToken *string `locationName:"clientToken" min:"33" type:"string" idempotencyToken:"true"` - // A KMS key ARN + // The ARN of the KMS key with which to encrypt the agent. CustomerEncryptionKeyArn *string `locationName:"customerEncryptionKeyArn" min:"1" type:"string"` - // Description of the Resource. + // A description of the agent. Description *string `locationName:"description" min:"1" type:"string"` - // ARN or name of a Bedrock model. + // The foundation model to be used for orchestration by the agent you create. FoundationModel *string `locationName:"foundationModel" min:"1" type:"string"` - // Max Session Time. + // 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. IdleSessionTTLInSeconds *int64 `locationName:"idleSessionTTLInSeconds" min:"60" type:"integer"` - // Instruction for the agent. + // Instructions that tell the agent what it should do and how it should interact + // with users. // // Instruction is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by CreateAgentInput's // String and GoString methods. Instruction *string `locationName:"instruction" min:"40" type:"string" sensitive:"true"` - // Configuration for prompt override. + // Contains configurations to override prompts in different parts of an agent + // sequence. For more information, see Advanced prompts (https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html). // // PromptOverrideConfiguration is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by CreateAgentInput's // String and GoString methods. PromptOverrideConfiguration *PromptOverrideConfiguration `locationName:"promptOverrideConfiguration" type:"structure" sensitive:"true"` - // A map of tag keys and values + // Any tags that you want to attach to the agent. Tags map[string]*string `locationName:"tags" type:"map"` } @@ -6487,11 +6656,10 @@ func (s *CreateAgentInput) SetTags(v map[string]*string) *CreateAgentInput { return s } -// Create Agent Response type CreateAgentOutput struct { _ struct{} `type:"structure"` - // Contains the information of an agent + // Contains details about the agent created. // // Agent is a required field Agent *Agent `locationName:"agent" type:"structure" required:"true"` @@ -6524,31 +6692,34 @@ func (s *CreateAgentOutput) SetAgent(v *Agent) *CreateAgentOutput { type CreateDataSourceInput struct { _ struct{} `type:"structure"` - // Client specified token used for idempotency checks + // 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 (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). ClientToken *string `locationName:"clientToken" min:"33" type:"string" idempotencyToken:"true"` - // Specifies a raw data source location to ingest. + // Contains metadata about where the data source is stored. // // DataSourceConfiguration is a required field DataSourceConfiguration *DataSourceConfiguration `locationName:"dataSourceConfiguration" type:"structure" required:"true"` - // Description of the Resource. + // A description of the data source. Description *string `locationName:"description" min:"1" type:"string"` - // Identifier for a resource. + // The unique identifier of the knowledge base to which to add the data source. // // KnowledgeBaseId is a required field KnowledgeBaseId *string `location:"uri" locationName:"knowledgeBaseId" type:"string" required:"true"` - // Name for a resource. + // The name of the data source. // // Name is a required field Name *string `locationName:"name" type:"string" required:"true"` - // Server-side encryption configuration. + // Contains details about the server-side encryption for the data source. ServerSideEncryptionConfiguration *ServerSideEncryptionConfiguration `locationName:"serverSideEncryptionConfiguration" type:"structure"` - // Configures ingestion for a vector knowledge base + // Contains details about how to ingest the documents in the data source. VectorIngestionConfiguration *VectorIngestionConfiguration `locationName:"vectorIngestionConfiguration" type:"structure"` } @@ -6658,7 +6829,7 @@ func (s *CreateDataSourceInput) SetVectorIngestionConfiguration(v *VectorIngesti type CreateDataSourceOutput struct { _ struct{} `type:"structure"` - // Contains the information of a data source. + // Contains details about the data source. // // DataSource is a required field DataSource *DataSource `locationName:"dataSource" type:"structure" required:"true"` @@ -6691,33 +6862,38 @@ func (s *CreateDataSourceOutput) SetDataSource(v *DataSource) *CreateDataSourceO type CreateKnowledgeBaseInput struct { _ struct{} `type:"structure"` - // Client specified token used for idempotency checks + // 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 (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). ClientToken *string `locationName:"clientToken" min:"33" type:"string" idempotencyToken:"true"` - // Description of the Resource. + // A description of the knowledge base. Description *string `locationName:"description" min:"1" type:"string"` - // Configures a bedrock knowledge base. + // Contains details about the embeddings model used for the knowledge base. // // KnowledgeBaseConfiguration is a required field KnowledgeBaseConfiguration *KnowledgeBaseConfiguration `locationName:"knowledgeBaseConfiguration" type:"structure" required:"true"` - // Name for a resource. + // A name for the knowledge base. // // Name is a required field Name *string `locationName:"name" type:"string" required:"true"` - // ARN of a IAM role. + // The ARN of the IAM role with permissions to create the knowledge base. // // RoleArn is a required field RoleArn *string `locationName:"roleArn" type:"string" required:"true"` - // Configures the physical storage of ingested data in a knowledge base. + // Contains details about the configuration of the vector database used for + // the knowledge base. // // StorageConfiguration is a required field StorageConfiguration *StorageConfiguration `locationName:"storageConfiguration" type:"structure" required:"true"` - // A map of tag keys and values + // Specify the key-value pairs for the tags that you want to attach to your + // knowledge base in this object. Tags map[string]*string `locationName:"tags" type:"map"` } @@ -6822,7 +6998,7 @@ func (s *CreateKnowledgeBaseInput) SetTags(v map[string]*string) *CreateKnowledg type CreateKnowledgeBaseOutput struct { _ struct{} `type:"structure"` - // Contains the information of a knowledge base. + // Contains details about the knowledge base. // // KnowledgeBase is a required field KnowledgeBase *KnowledgeBase `locationName:"knowledgeBase" type:"structure" required:"true"` @@ -6852,52 +7028,57 @@ func (s *CreateKnowledgeBaseOutput) SetKnowledgeBase(v *KnowledgeBase) *CreateKn return s } -// Contains the information of a data source. +// Contains details about a data source. type DataSource struct { _ struct{} `type:"structure"` - // Time Stamp. + // The time at which the data source was created. // // CreatedAt is a required field CreatedAt *time.Time `locationName:"createdAt" type:"timestamp" timestampFormat:"iso8601" required:"true"` - // Specifies a raw data source location to ingest. + // Contains details about how the data source is stored. // // DataSourceConfiguration is a required field DataSourceConfiguration *DataSourceConfiguration `locationName:"dataSourceConfiguration" type:"structure" required:"true"` - // Identifier for a resource. + // The unique identifier of the data source. // // DataSourceId is a required field DataSourceId *string `locationName:"dataSourceId" type:"string" required:"true"` - // Description of the Resource. + // The description of the data source. Description *string `locationName:"description" min:"1" type:"string"` - // Identifier for a resource. + // The unique identifier of the knowledge base to which the data source belongs. // // KnowledgeBaseId is a required field KnowledgeBaseId *string `locationName:"knowledgeBaseId" type:"string" required:"true"` - // Name for a resource. + // The name of the data source. // // Name is a required field Name *string `locationName:"name" type:"string" required:"true"` - // Server-side encryption configuration. + // Contains details about the configuration of the server-side encryption. ServerSideEncryptionConfiguration *ServerSideEncryptionConfiguration `locationName:"serverSideEncryptionConfiguration" type:"structure"` - // The status of a data source. + // 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. // // Status is a required field Status *string `locationName:"status" type:"string" required:"true" enum:"DataSourceStatus"` - // Time Stamp. + // The time at which the data source was last updated. // // UpdatedAt is a required field UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp" timestampFormat:"iso8601" required:"true"` - // Configures ingestion for a vector knowledge base + // Contains details about how to ingest the documents in the data source. VectorIngestionConfiguration *VectorIngestionConfiguration `locationName:"vectorIngestionConfiguration" type:"structure"` } @@ -6979,14 +7160,15 @@ func (s *DataSource) SetVectorIngestionConfiguration(v *VectorIngestionConfigura return s } -// Specifies a raw data source location to ingest. +// Contains details about how a data source is stored. type DataSourceConfiguration struct { _ struct{} `type:"structure"` - // Configures an S3 data source location. + // Contains details about the configuration of the S3 object containing the + // data source. S3Configuration *S3DataSourceConfiguration `locationName:"s3Configuration" type:"structure"` - // The type of the data source location. + // The type of storage for the data source. // // Type is a required field Type *string `locationName:"type" type:"string" required:"true" enum:"DataSourceType"` @@ -7040,34 +7222,34 @@ func (s *DataSourceConfiguration) SetType(v string) *DataSourceConfiguration { return s } -// Summary information of a data source. +// Contains details about a data source. type DataSourceSummary struct { _ struct{} `type:"structure"` - // Identifier for a resource. + // The unique identifier of the data source. // // DataSourceId is a required field DataSourceId *string `locationName:"dataSourceId" type:"string" required:"true"` - // Description of the Resource. + // The description of the data source. Description *string `locationName:"description" min:"1" type:"string"` - // Identifier for a resource. + // The unique identifier of the knowledge base to which the data source belongs. // // KnowledgeBaseId is a required field KnowledgeBaseId *string `locationName:"knowledgeBaseId" type:"string" required:"true"` - // Name for a resource. + // The name of the data source. // // Name is a required field Name *string `locationName:"name" type:"string" required:"true"` - // The status of a data source. + // The status of the data source. // // Status is a required field Status *string `locationName:"status" type:"string" required:"true" enum:"DataSourceStatus"` - // Time Stamp. + // The time at which the data source was last updated. // // UpdatedAt is a required field UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp" timestampFormat:"iso8601" required:"true"` @@ -7127,26 +7309,27 @@ func (s *DataSourceSummary) SetUpdatedAt(v time.Time) *DataSourceSummary { return s } -// Delete Action Group Request type DeleteAgentActionGroupInput struct { _ struct{} `type:"structure" nopayload:"true"` - // Id generated at the server side when an Agent ActionGroup is created + // The unique identifier of the action group to delete. // // ActionGroupId is a required field ActionGroupId *string `location:"uri" locationName:"actionGroupId" type:"string" required:"true"` - // Id generated at the server side when an Agent is created + // The unique identifier of the agent that the action group belongs to. // // AgentId is a required field AgentId *string `location:"uri" locationName:"agentId" type:"string" required:"true"` - // Draft Version of the Agent. + // The version of the agent that the action group belongs to. // // AgentVersion is a required field AgentVersion *string `location:"uri" locationName:"agentVersion" min:"5" type:"string" required:"true"` - // Skips checking if resource is in use when set to true. Defaults to false + // 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. SkipResourceInUseCheck *bool `location:"querystring" locationName:"skipResourceInUseCheck" type:"boolean"` } @@ -7220,7 +7403,6 @@ func (s *DeleteAgentActionGroupInput) SetSkipResourceInUseCheck(v bool) *DeleteA return s } -// Delete Action Group Response type DeleteAgentActionGroupOutput struct { _ struct{} `type:"structure"` } @@ -7243,16 +7425,15 @@ func (s DeleteAgentActionGroupOutput) GoString() string { return s.String() } -// Delete Agent Alias Request type DeleteAgentAliasInput struct { _ struct{} `type:"structure" nopayload:"true"` - // Id generated at the server side when an Agent Alias is created + // The unique identifier of the alias to delete. // // AgentAliasId is a required field AgentAliasId *string `location:"uri" locationName:"agentAliasId" min:"10" type:"string" required:"true"` - // Id generated at the server side when an Agent is created + // The unique identifier of the agent that the alias belongs to. // // AgentId is a required field AgentId *string `location:"uri" locationName:"agentId" type:"string" required:"true"` @@ -7310,21 +7491,20 @@ func (s *DeleteAgentAliasInput) SetAgentId(v string) *DeleteAgentAliasInput { return s } -// Delete Agent Alias Response type DeleteAgentAliasOutput struct { _ struct{} `type:"structure"` - // Id for an Agent Alias generated at the server side. + // The unique identifier of the alias that was deleted. // // AgentAliasId is a required field AgentAliasId *string `locationName:"agentAliasId" min:"10" type:"string" required:"true"` - // The statuses an Agent Alias can be in. + // The status of the alias. // // AgentAliasStatus is a required field AgentAliasStatus *string `locationName:"agentAliasStatus" type:"string" required:"true" enum:"AgentAliasStatus"` - // Identifier for a resource. + // The unique identifier of the agent that the alias belongs to. // // AgentId is a required field AgentId *string `locationName:"agentId" type:"string" required:"true"` @@ -7366,16 +7546,17 @@ func (s *DeleteAgentAliasOutput) SetAgentId(v string) *DeleteAgentAliasOutput { return s } -// Delete Agent Request type DeleteAgentInput struct { _ struct{} `type:"structure" nopayload:"true"` - // Id generated at the server side when an Agent is created + // The unique identifier of the agent to delete. // // AgentId is a required field AgentId *string `location:"uri" locationName:"agentId" type:"string" required:"true"` - // Skips checking if resource is in use when set to true. Defaults to false + // 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. SkipResourceInUseCheck *bool `location:"querystring" locationName:"skipResourceInUseCheck" type:"boolean"` } @@ -7425,16 +7606,15 @@ func (s *DeleteAgentInput) SetSkipResourceInUseCheck(v bool) *DeleteAgentInput { return s } -// Delete Agent Response type DeleteAgentOutput struct { _ struct{} `type:"structure"` - // Identifier for a resource. + // The unique identifier of the agent that was deleted. // // AgentId is a required field AgentId *string `locationName:"agentId" type:"string" required:"true"` - // Schema Type for Action APIs. + // The status of the agent. // // AgentStatus is a required field AgentStatus *string `locationName:"agentStatus" type:"string" required:"true" enum:"AgentStatus"` @@ -7470,21 +7650,22 @@ func (s *DeleteAgentOutput) SetAgentStatus(v string) *DeleteAgentOutput { return s } -// Delete Agent Version Request type DeleteAgentVersionInput struct { _ struct{} `type:"structure" nopayload:"true"` - // Id generated at the server side when an Agent is created + // The unique identifier of the agent that the version belongs to. // // AgentId is a required field AgentId *string `location:"uri" locationName:"agentId" type:"string" required:"true"` - // Numerical Agent Version. + // The version of the agent to delete. // // AgentVersion is a required field AgentVersion *string `location:"uri" locationName:"agentVersion" type:"string" required:"true"` - // Skips checking if resource is in use when set to true. Defaults to false + // 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. SkipResourceInUseCheck *bool `location:"querystring" locationName:"skipResourceInUseCheck" type:"boolean"` } @@ -7546,21 +7727,20 @@ func (s *DeleteAgentVersionInput) SetSkipResourceInUseCheck(v bool) *DeleteAgent return s } -// Delete Agent Version Response type DeleteAgentVersionOutput struct { _ struct{} `type:"structure"` - // Identifier for a resource. + // The unique identifier of the agent that the version belongs to. // // AgentId is a required field AgentId *string `locationName:"agentId" type:"string" required:"true"` - // Schema Type for Action APIs. + // The status of the agent version. // // AgentStatus is a required field AgentStatus *string `locationName:"agentStatus" type:"string" required:"true" enum:"AgentStatus"` - // Numerical Agent Version. + // The version that was deleted. // // AgentVersion is a required field AgentVersion *string `locationName:"agentVersion" type:"string" required:"true"` @@ -7605,12 +7785,13 @@ func (s *DeleteAgentVersionOutput) SetAgentVersion(v string) *DeleteAgentVersion type DeleteDataSourceInput struct { _ struct{} `type:"structure" nopayload:"true"` - // Identifier for a resource. + // The unique identifier of the data source to delete. // // DataSourceId is a required field DataSourceId *string `location:"uri" locationName:"dataSourceId" type:"string" required:"true"` - // Identifier for a resource. + // The unique identifier of the knowledge base from which to delete the data + // source. // // KnowledgeBaseId is a required field KnowledgeBaseId *string `location:"uri" locationName:"knowledgeBaseId" type:"string" required:"true"` @@ -7671,17 +7852,18 @@ func (s *DeleteDataSourceInput) SetKnowledgeBaseId(v string) *DeleteDataSourceIn type DeleteDataSourceOutput struct { _ struct{} `type:"structure"` - // Identifier for a resource. + // The unique identifier of the data source that was deleted. // // DataSourceId is a required field DataSourceId *string `locationName:"dataSourceId" type:"string" required:"true"` - // Identifier for a resource. + // The unique identifier of the knowledge base to which the data source that + // was deleted belonged. // // KnowledgeBaseId is a required field KnowledgeBaseId *string `locationName:"knowledgeBaseId" type:"string" required:"true"` - // The status of a data source. + // The status of the data source. // // Status is a required field Status *string `locationName:"status" type:"string" required:"true" enum:"DataSourceStatus"` @@ -7726,7 +7908,7 @@ func (s *DeleteDataSourceOutput) SetStatus(v string) *DeleteDataSourceOutput { type DeleteKnowledgeBaseInput struct { _ struct{} `type:"structure" nopayload:"true"` - // Identifier for a resource. + // The unique identifier of the knowledge base to delete. // // KnowledgeBaseId is a required field KnowledgeBaseId *string `location:"uri" locationName:"knowledgeBaseId" type:"string" required:"true"` @@ -7775,12 +7957,12 @@ func (s *DeleteKnowledgeBaseInput) SetKnowledgeBaseId(v string) *DeleteKnowledge type DeleteKnowledgeBaseOutput struct { _ struct{} `type:"structure"` - // Identifier for a resource. + // The unique identifier of the knowledge base that was deleted. // // KnowledgeBaseId is a required field KnowledgeBaseId *string `locationName:"knowledgeBaseId" type:"string" required:"true"` - // The status of a knowledge base. + // The status of the knowledge base and whether it has been successfully deleted. // // Status is a required field Status *string `locationName:"status" type:"string" required:"true" enum:"KnowledgeBaseStatus"` @@ -7816,22 +7998,21 @@ func (s *DeleteKnowledgeBaseOutput) SetStatus(v string) *DeleteKnowledgeBaseOutp return s } -// Disassociate Agent Knowledge Base Request type DisassociateAgentKnowledgeBaseInput struct { _ struct{} `type:"structure" nopayload:"true"` - // Id generated at the server side when an Agent is created + // The unique identifier of the agent from which to disassociate the knowledge + // base. // // AgentId is a required field AgentId *string `location:"uri" locationName:"agentId" type:"string" required:"true"` - // Draft Version of the Agent. + // The version of the agent from which to disassociate the knowledge base. // // AgentVersion is a required field AgentVersion *string `location:"uri" locationName:"agentVersion" min:"5" type:"string" required:"true"` - // Id generated at the server side when a Knowledge Base is associated to an - // Agent + // The unique identifier of the knowledge base to disassociate. // // KnowledgeBaseId is a required field KnowledgeBaseId *string `location:"uri" locationName:"knowledgeBaseId" type:"string" required:"true"` @@ -7901,7 +8082,6 @@ func (s *DisassociateAgentKnowledgeBaseInput) SetKnowledgeBaseId(v string) *Disa return s } -// Disassociate Agent Knowledge Base Response type DisassociateAgentKnowledgeBaseOutput struct { _ struct{} `type:"structure"` } @@ -7924,16 +8104,17 @@ func (s DisassociateAgentKnowledgeBaseOutput) GoString() string { return s.String() } -// Configures fixed size chunking strategy +// Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy +// as NONE, exclude this field. type FixedSizeChunkingConfiguration struct { _ struct{} `type:"structure"` - // The maximum number of tokens per chunk. + // The maximum number of tokens to include in a chunk. // // MaxTokens is a required field MaxTokens *int64 `locationName:"maxTokens" min:"1" type:"integer" required:"true"` - // The overlap percentage between adjacent chunks. + // The percentage of overlap between adjacent chunks of a data source. // // OverlapPercentage is a required field OverlapPercentage *int64 `locationName:"overlapPercentage" min:"1" type:"integer" required:"true"` @@ -7991,21 +8172,20 @@ func (s *FixedSizeChunkingConfiguration) SetOverlapPercentage(v int64) *FixedSiz return s } -// Get Action Group Request type GetAgentActionGroupInput struct { _ struct{} `type:"structure" nopayload:"true"` - // Id generated at the server side when an Agent Action Group is created + // The unique identifier of the action group for which to get information. // // ActionGroupId is a required field ActionGroupId *string `location:"uri" locationName:"actionGroupId" type:"string" required:"true"` - // Id generated at the server side when an Agent is created + // The unique identifier of the agent that the action group belongs to. // // AgentId is a required field AgentId *string `location:"uri" locationName:"agentId" type:"string" required:"true"` - // Version number generated when a version is created + // The version of the agent that the action group belongs to. // // AgentVersion is a required field AgentVersion *string `location:"uri" locationName:"agentVersion" min:"1" type:"string" required:"true"` @@ -8075,11 +8255,10 @@ func (s *GetAgentActionGroupInput) SetAgentVersion(v string) *GetAgentActionGrou return s } -// Get Action Group Response type GetAgentActionGroupOutput struct { _ struct{} `type:"structure"` - // Contains the information of an Agent Action Group + // Contains details about the action group. // // AgentActionGroup is a required field AgentActionGroup *AgentActionGroup `locationName:"agentActionGroup" type:"structure" required:"true"` @@ -8109,16 +8288,16 @@ func (s *GetAgentActionGroupOutput) SetAgentActionGroup(v *AgentActionGroup) *Ge return s } -// Get Agent Alias Request type GetAgentAliasInput struct { _ struct{} `type:"structure" nopayload:"true"` - // Id generated at the server side when an Agent Alias is created + // The unique identifier of the alias for which to get information. // // AgentAliasId is a required field AgentAliasId *string `location:"uri" locationName:"agentAliasId" min:"10" type:"string" required:"true"` - // Id generated at the server side when an Agent is created + // The unique identifier of the agent to which the alias to get information + // belongs. // // AgentId is a required field AgentId *string `location:"uri" locationName:"agentId" type:"string" required:"true"` @@ -8176,11 +8355,10 @@ func (s *GetAgentAliasInput) SetAgentId(v string) *GetAgentAliasInput { return s } -// Get Agent Alias Response type GetAgentAliasOutput struct { _ struct{} `type:"structure"` - // Contains the information of an agent alias + // Contains information about the alias. // // AgentAlias is a required field AgentAlias *AgentAlias `locationName:"agentAlias" type:"structure" required:"true"` @@ -8210,11 +8388,10 @@ func (s *GetAgentAliasOutput) SetAgentAlias(v *AgentAlias) *GetAgentAliasOutput return s } -// Get Agent Request type GetAgentInput struct { _ struct{} `type:"structure" nopayload:"true"` - // Id generated at the server side when an Agent is created + // The unique identifier of the agent. // // AgentId is a required field AgentId *string `location:"uri" locationName:"agentId" type:"string" required:"true"` @@ -8260,21 +8437,20 @@ func (s *GetAgentInput) SetAgentId(v string) *GetAgentInput { return s } -// Get Agent Knowledge Base Request type GetAgentKnowledgeBaseInput struct { _ struct{} `type:"structure" nopayload:"true"` - // Id generated at the server side when an Agent is created + // The unique identifier of the agent with which the knowledge base is associated. // // AgentId is a required field AgentId *string `location:"uri" locationName:"agentId" type:"string" required:"true"` - // Version number generated when a version is created + // The version of the agent with which the knowledge base is associated. // // AgentVersion is a required field AgentVersion *string `location:"uri" locationName:"agentVersion" min:"1" type:"string" required:"true"` - // Id generated at the server side when a Knowledge Base is associated + // The unique identifier of the knowledge base associated with the agent. // // KnowledgeBaseId is a required field KnowledgeBaseId *string `location:"uri" locationName:"knowledgeBaseId" type:"string" required:"true"` @@ -8344,11 +8520,10 @@ func (s *GetAgentKnowledgeBaseInput) SetKnowledgeBaseId(v string) *GetAgentKnowl return s } -// Get Agent Knowledge Base Response type GetAgentKnowledgeBaseOutput struct { _ struct{} `type:"structure"` - // Contains the information of an Agent Knowledge Base. + // Contains details about a knowledge base attached to an agent. // // AgentKnowledgeBase is a required field AgentKnowledgeBase *AgentKnowledgeBase `locationName:"agentKnowledgeBase" type:"structure" required:"true"` @@ -8378,11 +8553,10 @@ func (s *GetAgentKnowledgeBaseOutput) SetAgentKnowledgeBase(v *AgentKnowledgeBas return s } -// Get Agent Response type GetAgentOutput struct { _ struct{} `type:"structure"` - // Contains the information of an agent + // Contains details about the agent. // // Agent is a required field Agent *Agent `locationName:"agent" type:"structure" required:"true"` @@ -8412,16 +8586,15 @@ func (s *GetAgentOutput) SetAgent(v *Agent) *GetAgentOutput { return s } -// Get Agent Version Request type GetAgentVersionInput struct { _ struct{} `type:"structure" nopayload:"true"` - // Id generated at the server side when an Agent is created + // The unique identifier of the agent. // // AgentId is a required field AgentId *string `location:"uri" locationName:"agentId" type:"string" required:"true"` - // Numerical Agent Version. + // The version of the agent. // // AgentVersion is a required field AgentVersion *string `location:"uri" locationName:"agentVersion" type:"string" required:"true"` @@ -8479,11 +8652,10 @@ func (s *GetAgentVersionInput) SetAgentVersion(v string) *GetAgentVersionInput { return s } -// Get Agent Version Response type GetAgentVersionOutput struct { _ struct{} `type:"structure"` - // Contains the information of an agent version. + // Contains details about the version of the agent. // // AgentVersion is a required field AgentVersion *AgentVersion `locationName:"agentVersion" type:"structure" required:"true"` @@ -8516,12 +8688,13 @@ func (s *GetAgentVersionOutput) SetAgentVersion(v *AgentVersion) *GetAgentVersio type GetDataSourceInput struct { _ struct{} `type:"structure" nopayload:"true"` - // Identifier for a resource. + // The unique identifier of the data source. // // DataSourceId is a required field DataSourceId *string `location:"uri" locationName:"dataSourceId" type:"string" required:"true"` - // Identifier for a resource. + // The unique identifier of the knowledge base that the data source was added + // to. // // KnowledgeBaseId is a required field KnowledgeBaseId *string `location:"uri" locationName:"knowledgeBaseId" type:"string" required:"true"` @@ -8582,7 +8755,7 @@ func (s *GetDataSourceInput) SetKnowledgeBaseId(v string) *GetDataSourceInput { type GetDataSourceOutput struct { _ struct{} `type:"structure"` - // Contains the information of a data source. + // Contains details about the data source. // // DataSource is a required field DataSource *DataSource `locationName:"dataSource" type:"structure" required:"true"` @@ -8615,17 +8788,17 @@ func (s *GetDataSourceOutput) SetDataSource(v *DataSource) *GetDataSourceOutput type GetIngestionJobInput struct { _ struct{} `type:"structure" nopayload:"true"` - // Identifier for a resource. + // The unique identifier of the data source in the ingestion job. // // DataSourceId is a required field DataSourceId *string `location:"uri" locationName:"dataSourceId" type:"string" required:"true"` - // Identifier for a resource. + // The unique identifier of the ingestion job. // // IngestionJobId is a required field IngestionJobId *string `location:"uri" locationName:"ingestionJobId" type:"string" required:"true"` - // Identifier for a resource. + // The unique identifier of the knowledge base for which the ingestion job applies. // // KnowledgeBaseId is a required field KnowledgeBaseId *string `location:"uri" locationName:"knowledgeBaseId" type:"string" required:"true"` @@ -8698,7 +8871,7 @@ func (s *GetIngestionJobInput) SetKnowledgeBaseId(v string) *GetIngestionJobInpu type GetIngestionJobOutput struct { _ struct{} `type:"structure"` - // Contains the information of an ingestion job. + // Contains details about the ingestion job. // // IngestionJob is a required field IngestionJob *IngestionJob `locationName:"ingestionJob" type:"structure" required:"true"` @@ -8731,7 +8904,7 @@ func (s *GetIngestionJobOutput) SetIngestionJob(v *IngestionJob) *GetIngestionJo type GetKnowledgeBaseInput struct { _ struct{} `type:"structure" nopayload:"true"` - // Identifier for a resource. + // The unique identifier of the knowledge base for which to get information. // // KnowledgeBaseId is a required field KnowledgeBaseId *string `location:"uri" locationName:"knowledgeBaseId" type:"string" required:"true"` @@ -8780,7 +8953,7 @@ func (s *GetKnowledgeBaseInput) SetKnowledgeBaseId(v string) *GetKnowledgeBaseIn type GetKnowledgeBaseOutput struct { _ struct{} `type:"structure"` - // Contains the information of a knowledge base. + // Contains details about the knowledge base. // // KnowledgeBase is a required field KnowledgeBase *KnowledgeBase `locationName:"knowledgeBase" type:"structure" required:"true"` @@ -8810,23 +8983,38 @@ func (s *GetKnowledgeBaseOutput) SetKnowledgeBase(v *KnowledgeBase) *GetKnowledg return s } -// Configuration for inference in prompt configuration +// 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 (https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html). type InferenceConfiguration struct { _ struct{} `type:"structure"` - // Maximum length of output + // The maximum number of tokens to allow in the generated response. MaximumLength *int64 `locationName:"maximumLength" type:"integer"` - // List of stop sequences + // A list of stop sequences. A stop sequence is a sequence of characters that + // causes the model to stop generating the response. StopSequences []*string `locationName:"stopSequences" type:"list"` - // Controls randomness, higher values increase diversity + // 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. Temperature *float64 `locationName:"temperature" type:"float"` - // Sample from the k most likely next tokens + // While generating a response, the model determines the probability of the + // following token at each point of generation. The value that you set for topK + // is the number of most-likely candidates from which the model chooses the + // next token in the sequence. For example, if you set topK to 50, the model + // selects the next token from among the top 50 most likely choices. TopK *int64 `locationName:"topK" type:"integer"` - // Cumulative probability cutoff for token selection + // 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. TopP *float64 `locationName:"topP" type:"float"` } @@ -8878,45 +9066,55 @@ func (s *InferenceConfiguration) SetTopP(v float64) *InferenceConfiguration { return s } -// Contains the information of an ingestion job. +// 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: +// +// - StartIngestionJob response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_StartIngestionJob.html#API_agent_StartIngestionJob_ResponseSyntax) +// +// - GetIngestionJob response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetIngestionJob.html#API_agent_GetIngestionJob_ResponseSyntax) +// +// - ListIngestionJob response (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_ListIngestionJob.html#API_agent_ListIngestionJob_ResponseSyntax) type IngestionJob struct { _ struct{} `type:"structure"` - // Identifier for a resource. + // The unique identifier of the ingested data source. // // DataSourceId is a required field DataSourceId *string `locationName:"dataSourceId" type:"string" required:"true"` - // Description of the Resource. + // The description of the ingestion job. Description *string `locationName:"description" min:"1" type:"string"` - // Failure Reasons for Error. + // A list of reasons that the ingestion job failed. FailureReasons []*string `locationName:"failureReasons" type:"list"` - // Identifier for a resource. + // The unique identifier of the ingestion job. // // IngestionJobId is a required field IngestionJobId *string `locationName:"ingestionJobId" type:"string" required:"true"` - // Identifier for a resource. + // The unique identifier of the knowledge base to which the data source is being + // added. // // KnowledgeBaseId is a required field KnowledgeBaseId *string `locationName:"knowledgeBaseId" type:"string" required:"true"` - // Time Stamp. + // The time at which the ingestion job started. // // StartedAt is a required field StartedAt *time.Time `locationName:"startedAt" type:"timestamp" timestampFormat:"iso8601" required:"true"` - // The document level statistics of an ingestion job + // Contains statistics about the ingestion job. Statistics *IngestionJobStatistics `locationName:"statistics" type:"structure"` - // The status of an ingestion job. + // The status of the ingestion job. // // Status is a required field Status *string `locationName:"status" type:"string" required:"true" enum:"IngestionJobStatus"` - // Time Stamp. + // The time at which the ingestion job was last updated. // // UpdatedAt is a required field UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp" timestampFormat:"iso8601" required:"true"` @@ -8994,21 +9192,21 @@ func (s *IngestionJob) SetUpdatedAt(v time.Time) *IngestionJob { return s } -// Filters the response returned by ListIngestionJobs operation. +// Defines a filter by which to filter the results. type IngestionJobFilter struct { _ struct{} `type:"structure"` - // The name of the field to filter ingestion jobs. + // The attribute by which to filter the results. // // Attribute is a required field Attribute *string `locationName:"attribute" type:"string" required:"true" enum:"IngestionJobFilterAttribute"` - // The operator used to filter ingestion jobs. + // The operation to carry out between the attribute and the values. // // Operator is a required field Operator *string `locationName:"operator" type:"string" required:"true" enum:"IngestionJobFilterOperator"` - // The list of values used to filter ingestion jobs. + // A list of values for the attribute. // // Values is a required field Values []*string `locationName:"values" type:"list" required:"true"` @@ -9069,16 +9267,16 @@ func (s *IngestionJobFilter) SetValues(v []*string) *IngestionJobFilter { return s } -// Sorts the response returned by ListIngestionJobs operation. +// Parameters by which to sort the results. type IngestionJobSortBy struct { _ struct{} `type:"structure"` - // The name of the field to sort ingestion jobs. + // The attribute by which to sort the results. // // Attribute is a required field Attribute *string `locationName:"attribute" type:"string" required:"true" enum:"IngestionJobSortByAttribute"` - // Order to sort results by. + // The order by which to sort the results. // // Order is a required field Order *string `locationName:"order" type:"string" required:"true" enum:"SortOrder"` @@ -9130,23 +9328,33 @@ func (s *IngestionJobSortBy) SetOrder(v string) *IngestionJobSortBy { return s } -// The document level statistics of an ingestion job +// Contains the statistics for the ingestion job. type IngestionJobStatistics struct { _ struct{} `type:"structure"` - // Number of deleted documents + // The number of source documents that was deleted. NumberOfDocumentsDeleted *int64 `locationName:"numberOfDocumentsDeleted" type:"long"` - // Number of failed documents + // The number of source documents that failed to be ingested. NumberOfDocumentsFailed *int64 `locationName:"numberOfDocumentsFailed" type:"long"` - // Number of scanned documents + // The total number of source documents that were scanned. Includes new, updated, + // and unchanged documents. NumberOfDocumentsScanned *int64 `locationName:"numberOfDocumentsScanned" type:"long"` - // Number of modified documents indexed + // The number of metadata files that were updated or deleted. + NumberOfMetadataDocumentsModified *int64 `locationName:"numberOfMetadataDocumentsModified" type:"long"` + + // The total number of metadata files that were scanned. Includes new, updated, + // and unchanged files. + NumberOfMetadataDocumentsScanned *int64 `locationName:"numberOfMetadataDocumentsScanned" type:"long"` + + // The number of modified source documents in the data source that were successfully + // indexed. NumberOfModifiedDocumentsIndexed *int64 `locationName:"numberOfModifiedDocumentsIndexed" type:"long"` - // Number of indexed documents + // The number of new source documents in the data source that were successfully + // indexed. NumberOfNewDocumentsIndexed *int64 `locationName:"numberOfNewDocumentsIndexed" type:"long"` } @@ -9186,6 +9394,18 @@ func (s *IngestionJobStatistics) SetNumberOfDocumentsScanned(v int64) *Ingestion return s } +// SetNumberOfMetadataDocumentsModified sets the NumberOfMetadataDocumentsModified field's value. +func (s *IngestionJobStatistics) SetNumberOfMetadataDocumentsModified(v int64) *IngestionJobStatistics { + s.NumberOfMetadataDocumentsModified = &v + return s +} + +// SetNumberOfMetadataDocumentsScanned sets the NumberOfMetadataDocumentsScanned field's value. +func (s *IngestionJobStatistics) SetNumberOfMetadataDocumentsScanned(v int64) *IngestionJobStatistics { + s.NumberOfMetadataDocumentsScanned = &v + return s +} + // SetNumberOfModifiedDocumentsIndexed sets the NumberOfModifiedDocumentsIndexed field's value. func (s *IngestionJobStatistics) SetNumberOfModifiedDocumentsIndexed(v int64) *IngestionJobStatistics { s.NumberOfModifiedDocumentsIndexed = &v @@ -9198,42 +9418,42 @@ func (s *IngestionJobStatistics) SetNumberOfNewDocumentsIndexed(v int64) *Ingest return s } -// Summary information of an ingestion job. +// Contains details about an ingestion job. type IngestionJobSummary struct { _ struct{} `type:"structure"` - // Identifier for a resource. + // The unique identifier of the data source in the ingestion job. // // DataSourceId is a required field DataSourceId *string `locationName:"dataSourceId" type:"string" required:"true"` - // Description of the Resource. + // The description of the ingestion job. Description *string `locationName:"description" min:"1" type:"string"` - // Identifier for a resource. + // The unique identifier of the ingestion job. // // IngestionJobId is a required field IngestionJobId *string `locationName:"ingestionJobId" type:"string" required:"true"` - // Identifier for a resource. + // The unique identifier of the knowledge base to which the data source is added. // // KnowledgeBaseId is a required field KnowledgeBaseId *string `locationName:"knowledgeBaseId" type:"string" required:"true"` - // Time Stamp. + // The time at which the ingestion job was started. // // StartedAt is a required field StartedAt *time.Time `locationName:"startedAt" type:"timestamp" timestampFormat:"iso8601" required:"true"` - // The document level statistics of an ingestion job + // Contains statistics for the ingestion job. Statistics *IngestionJobStatistics `locationName:"statistics" type:"structure"` - // The status of an ingestion job. + // The status of the ingestion job. // // Status is a required field Status *string `locationName:"status" type:"string" required:"true" enum:"IngestionJobStatus"` - // Time Stamp. + // The time at which the ingestion job was last updated. // // UpdatedAt is a required field UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp" timestampFormat:"iso8601" required:"true"` @@ -9305,13 +9525,11 @@ func (s *IngestionJobSummary) SetUpdatedAt(v time.Time) *IngestionJobSummary { return s } -// This exception is thrown if there was an unexpected error during processing -// of request +// An internal server error occurred. Retry your request. type InternalServerException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` - // Non Blank String Message_ *string `locationName:"message" type:"string"` } @@ -9371,57 +9589,68 @@ func (s *InternalServerException) RequestID() string { return s.RespMetadata.RequestID } -// Contains the information of a knowledge base. +// Contains information about a knowledge base. type KnowledgeBase struct { _ struct{} `type:"structure"` - // Time Stamp. + // The time at which the knowledge base was created. // // CreatedAt is a required field CreatedAt *time.Time `locationName:"createdAt" type:"timestamp" timestampFormat:"iso8601" required:"true"` - // Description of the Resource. + // The description of the knowledge base. Description *string `locationName:"description" min:"1" type:"string"` - // Failure Reasons for Error. + // A list of reasons that the API operation on the knowledge base failed. FailureReasons []*string `locationName:"failureReasons" type:"list"` - // ARN of a KnowledgeBase + // The ARN of the knowledge base. // // KnowledgeBaseArn is a required field KnowledgeBaseArn *string `locationName:"knowledgeBaseArn" type:"string" required:"true"` - // Configures a bedrock knowledge base. + // Contains details about the embeddings configuration of the knowledge base. // // KnowledgeBaseConfiguration is a required field KnowledgeBaseConfiguration *KnowledgeBaseConfiguration `locationName:"knowledgeBaseConfiguration" type:"structure" required:"true"` - // Identifier for a resource. + // The unique identifier of the knowledge base. // // KnowledgeBaseId is a required field KnowledgeBaseId *string `locationName:"knowledgeBaseId" type:"string" required:"true"` - // Name for a resource. + // The name of the knowledge base. // // Name is a required field Name *string `locationName:"name" type:"string" required:"true"` - // ARN of a IAM role. + // The ARN of the IAM role with permissions to invoke API operations on the + // knowledge base. The ARN must begin with AmazonBedrockExecutionRoleForKnowledgeBase_. // // RoleArn is a required field RoleArn *string `locationName:"roleArn" type:"string" required:"true"` - // The status of a knowledge base. + // 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. // // Status is a required field Status *string `locationName:"status" type:"string" required:"true" enum:"KnowledgeBaseStatus"` - // Configures the physical storage of ingested data in a knowledge base. + // Contains details about the storage configuration of the knowledge base. // // StorageConfiguration is a required field StorageConfiguration *StorageConfiguration `locationName:"storageConfiguration" type:"structure" required:"true"` - // Time Stamp. + // The time at which the knowledge base was last updated. // // UpdatedAt is a required field UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp" timestampFormat:"iso8601" required:"true"` @@ -9511,16 +9740,18 @@ func (s *KnowledgeBase) SetUpdatedAt(v time.Time) *KnowledgeBase { return s } -// Configures a bedrock knowledge base. +// Contains details about the embeddings configuration of the knowledge base. type KnowledgeBaseConfiguration struct { _ struct{} `type:"structure"` - // The type of a knowledge base. + // The type of data that the data source is converted into for the knowledge + // base. // // Type is a required field Type *string `locationName:"type" type:"string" required:"true" enum:"KnowledgeBaseType"` - // Configurations for a vector knowledge base. + // Contains details about the embeddings model that'sused to convert the data + // source. VectorKnowledgeBaseConfiguration *VectorKnowledgeBaseConfiguration `locationName:"vectorKnowledgeBaseConfiguration" type:"structure"` } @@ -9572,29 +9803,29 @@ func (s *KnowledgeBaseConfiguration) SetVectorKnowledgeBaseConfiguration(v *Vect return s } -// Summary information of a knowledge base. +// Contains details about a knowledge base. type KnowledgeBaseSummary struct { _ struct{} `type:"structure"` - // Description of the Resource. + // The description of the knowledge base. Description *string `locationName:"description" min:"1" type:"string"` - // Identifier for a resource. + // The unique identifier of the knowledge base. // // KnowledgeBaseId is a required field KnowledgeBaseId *string `locationName:"knowledgeBaseId" type:"string" required:"true"` - // Name for a resource. + // The name of the knowledge base. // // Name is a required field Name *string `locationName:"name" type:"string" required:"true"` - // The status of a knowledge base. + // The status of the knowledge base. // // Status is a required field Status *string `locationName:"status" type:"string" required:"true" enum:"KnowledgeBaseStatus"` - // Time Stamp. + // The time at which the knowledge base was last updated. // // UpdatedAt is a required field UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp" timestampFormat:"iso8601" required:"true"` @@ -9648,24 +9879,28 @@ func (s *KnowledgeBaseSummary) SetUpdatedAt(v time.Time) *KnowledgeBaseSummary { return s } -// List Action Groups Request type ListAgentActionGroupsInput struct { _ struct{} `type:"structure"` - // Id generated at the server side when an Agent is Listed + // The unique identifier of the agent. // // AgentId is a required field AgentId *string `location:"uri" locationName:"agentId" type:"string" required:"true"` - // Id generated at the server side when an Agent is Listed + // The version of the agent. // // AgentVersion is a required field AgentVersion *string `location:"uri" locationName:"agentVersion" min:"1" type:"string" required:"true"` - // Max 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. MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"` - // Opaque continuation token of previous paginated response. + // 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. NextToken *string `locationName:"nextToken" min:"1" type:"string"` } @@ -9739,16 +9974,17 @@ func (s *ListAgentActionGroupsInput) SetNextToken(v string) *ListAgentActionGrou return s } -// List Action Groups Response type ListAgentActionGroupsOutput struct { _ struct{} `type:"structure"` - // List of ActionGroup Summaries + // A list of objects, each of which contains information about an action group. // // ActionGroupSummaries is a required field ActionGroupSummaries []*ActionGroupSummary `locationName:"actionGroupSummaries" type:"list" required:"true"` - // Opaque continuation token of previous paginated response. + // 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. NextToken *string `locationName:"nextToken" min:"1" type:"string"` } @@ -9782,19 +10018,23 @@ func (s *ListAgentActionGroupsOutput) SetNextToken(v string) *ListAgentActionGro return s } -// List Agent Aliases Request type ListAgentAliasesInput struct { _ struct{} `type:"structure"` - // Id generated at the server side when an Agent is created + // The unique identifier of the agent. // // AgentId is a required field AgentId *string `location:"uri" locationName:"agentId" type:"string" required:"true"` - // Max 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. MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"` - // Opaque continuation token of previous paginated response. + // 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. NextToken *string `locationName:"nextToken" min:"1" type:"string"` } @@ -9856,16 +10096,18 @@ func (s *ListAgentAliasesInput) SetNextToken(v string) *ListAgentAliasesInput { return s } -// List Agent Aliases Response type ListAgentAliasesOutput struct { _ struct{} `type:"structure"` - // The list of summaries of all the aliases for an Agent. + // A list of objects, each of which contains information about an alias of the + // agent. // // AgentAliasSummaries is a required field AgentAliasSummaries []*AgentAliasSummary `locationName:"agentAliasSummaries" type:"list" required:"true"` - // Opaque continuation token of previous paginated response. + // 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. NextToken *string `locationName:"nextToken" min:"1" type:"string"` } @@ -9899,24 +10141,30 @@ func (s *ListAgentAliasesOutput) SetNextToken(v string) *ListAgentAliasesOutput return s } -// List Agent Knowledge Bases Request type ListAgentKnowledgeBasesInput struct { _ struct{} `type:"structure"` - // Id generated at the server side when an Agent is created + // The unique identifier of the agent for which to return information about + // knowledge bases associated with it. // // AgentId is a required field AgentId *string `location:"uri" locationName:"agentId" type:"string" required:"true"` - // Version number generated when a version is created + // The version of the agent for which to return information about knowledge + // bases associated with it. // // AgentVersion is a required field AgentVersion *string `location:"uri" locationName:"agentVersion" min:"1" type:"string" required:"true"` - // Max 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. MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"` - // Opaque continuation token of previous paginated response. + // 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. NextToken *string `locationName:"nextToken" min:"1" type:"string"` } @@ -9990,16 +10238,18 @@ func (s *ListAgentKnowledgeBasesInput) SetNextToken(v string) *ListAgentKnowledg return s } -// List Agent Knowledge Bases Response type ListAgentKnowledgeBasesOutput struct { _ struct{} `type:"structure"` - // List of Agent Knowledge Base Summaries + // A list of objects, each of which contains information about a knowledge base + // associated with the agent. // // AgentKnowledgeBaseSummaries is a required field AgentKnowledgeBaseSummaries []*AgentKnowledgeBaseSummary `locationName:"agentKnowledgeBaseSummaries" type:"list" required:"true"` - // Opaque continuation token of previous paginated response. + // 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. NextToken *string `locationName:"nextToken" min:"1" type:"string"` } @@ -10033,19 +10283,23 @@ func (s *ListAgentKnowledgeBasesOutput) SetNextToken(v string) *ListAgentKnowled return s } -// List Agent Versions Request type ListAgentVersionsInput struct { _ struct{} `type:"structure"` - // Id generated at the server side when an Agent is created + // The unique identifier of the agent. // // AgentId is a required field AgentId *string `location:"uri" locationName:"agentId" type:"string" required:"true"` - // Max 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. MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"` - // Opaque continuation token of previous paginated response. + // 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. NextToken *string `locationName:"nextToken" min:"1" type:"string"` } @@ -10107,16 +10361,18 @@ func (s *ListAgentVersionsInput) SetNextToken(v string) *ListAgentVersionsInput return s } -// List Agent Versions Response type ListAgentVersionsOutput struct { _ struct{} `type:"structure"` - // List of AgentVersionSummary. + // A list of objects, each of which contains information about a version of + // the agent. // // AgentVersionSummaries is a required field AgentVersionSummaries []*AgentVersionSummary `locationName:"agentVersionSummaries" type:"list" required:"true"` - // Opaque continuation token of previous paginated response. + // 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. NextToken *string `locationName:"nextToken" min:"1" type:"string"` } @@ -10150,14 +10406,18 @@ func (s *ListAgentVersionsOutput) SetNextToken(v string) *ListAgentVersionsOutpu return s } -// List Agent Request type ListAgentsInput struct { _ struct{} `type:"structure"` - // Max 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. MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"` - // Opaque continuation token of previous paginated response. + // 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. NextToken *string `locationName:"nextToken" min:"1" type:"string"` } @@ -10207,16 +10467,17 @@ func (s *ListAgentsInput) SetNextToken(v string) *ListAgentsInput { return s } -// List Agent Response type ListAgentsOutput struct { _ struct{} `type:"structure"` - // List of AgentSummary. + // A list of objects, each of which contains information about an agent. // // AgentSummaries is a required field AgentSummaries []*AgentSummary `locationName:"agentSummaries" type:"list" required:"true"` - // Opaque continuation token of previous paginated response. + // 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. NextToken *string `locationName:"nextToken" min:"1" type:"string"` } @@ -10253,15 +10514,21 @@ func (s *ListAgentsOutput) SetNextToken(v string) *ListAgentsOutput { type ListDataSourcesInput struct { _ struct{} `type:"structure"` - // Identifier for a resource. + // The unique identifier of the knowledge base for which to return a list of + // information. // // KnowledgeBaseId is a required field KnowledgeBaseId *string `location:"uri" locationName:"knowledgeBaseId" type:"string" required:"true"` - // Max 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. MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"` - // Opaque continuation token of previous paginated response. + // 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. NextToken *string `locationName:"nextToken" min:"1" type:"string"` } @@ -10326,12 +10593,14 @@ func (s *ListDataSourcesInput) SetNextToken(v string) *ListDataSourcesInput { type ListDataSourcesOutput struct { _ struct{} `type:"structure"` - // list of data source summaries + // A list of objects, each of which contains information about a data source. // // DataSourceSummaries is a required field DataSourceSummaries []*DataSourceSummary `locationName:"dataSourceSummaries" type:"list" required:"true"` - // Opaque continuation token of previous paginated response. + // 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. NextToken *string `locationName:"nextToken" min:"1" type:"string"` } @@ -10368,26 +10637,32 @@ func (s *ListDataSourcesOutput) SetNextToken(v string) *ListDataSourcesOutput { type ListIngestionJobsInput struct { _ struct{} `type:"structure"` - // Identifier for a resource. + // The unique identifier of the data source for which to return ingestion jobs. // // DataSourceId is a required field DataSourceId *string `location:"uri" locationName:"dataSourceId" type:"string" required:"true"` - // List of IngestionJobFilters + // Contains a definition of a filter for which to filter the results. Filters []*IngestionJobFilter `locationName:"filters" min:"1" type:"list"` - // Identifier for a resource. + // The unique identifier of the knowledge base for which to return ingestion + // jobs. // // KnowledgeBaseId is a required field KnowledgeBaseId *string `location:"uri" locationName:"knowledgeBaseId" type:"string" required:"true"` - // Max 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. MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"` - // Opaque continuation token of previous paginated response. + // 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. NextToken *string `locationName:"nextToken" min:"1" type:"string"` - // Sorts the response returned by ListIngestionJobs operation. + // Contains details about how to sort the results. SortBy *IngestionJobSortBy `locationName:"sortBy" type:"structure"` } @@ -10494,12 +10769,15 @@ func (s *ListIngestionJobsInput) SetSortBy(v *IngestionJobSortBy) *ListIngestion type ListIngestionJobsOutput struct { _ struct{} `type:"structure"` - // List of IngestionJobSummaries + // A list of objects, each of which contains information about an ingestion + // job. // // IngestionJobSummaries is a required field IngestionJobSummaries []*IngestionJobSummary `locationName:"ingestionJobSummaries" type:"list" required:"true"` - // Opaque continuation token of previous paginated response. + // 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. NextToken *string `locationName:"nextToken" min:"1" type:"string"` } @@ -10536,10 +10814,15 @@ func (s *ListIngestionJobsOutput) SetNextToken(v string) *ListIngestionJobsOutpu type ListKnowledgeBasesInput struct { _ struct{} `type:"structure"` - // Max 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. MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"` - // Opaque continuation token of previous paginated response. + // 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. NextToken *string `locationName:"nextToken" min:"1" type:"string"` } @@ -10592,12 +10875,14 @@ func (s *ListKnowledgeBasesInput) SetNextToken(v string) *ListKnowledgeBasesInpu type ListKnowledgeBasesOutput struct { _ struct{} `type:"structure"` - // List of KnowledgeBaseSummaries + // A list of objects, each of which contains information about a knowledge base. // // KnowledgeBaseSummaries is a required field KnowledgeBaseSummaries []*KnowledgeBaseSummary `locationName:"knowledgeBaseSummaries" type:"list" required:"true"` - // Opaque continuation token of previous paginated response. + // 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. NextToken *string `locationName:"nextToken" min:"1" type:"string"` } @@ -10634,7 +10919,7 @@ func (s *ListKnowledgeBasesOutput) SetNextToken(v string) *ListKnowledgeBasesOut type ListTagsForResourceInput struct { _ struct{} `type:"structure" nopayload:"true"` - // ARN of Taggable resources: [Agent, AgentAlias, Knowledge-Base] + // The ARN of the resource for which to list tags. // // ResourceArn is a required field ResourceArn *string `location:"uri" locationName:"resourceArn" min:"20" type:"string" required:"true"` @@ -10683,7 +10968,7 @@ func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResource type ListTagsForResourceOutput struct { _ struct{} `type:"structure"` - // A map of tag keys and values + // The key-value pairs for the tags associated with the resource. Tags map[string]*string `locationName:"tags" type:"map"` } @@ -10711,23 +10996,24 @@ func (s *ListTagsForResourceOutput) SetTags(v map[string]*string) *ListTagsForRe return s } -// Contains the configurations to use OpenSearch Serverless to store knowledge -// base data. +// 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 (https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-oss.html). type OpenSearchServerlessConfiguration struct { _ struct{} `type:"structure"` - // Arn of an OpenSearch Serverless collection. + // The ARN of the OpenSearch Service vector store. // // CollectionArn is a required field CollectionArn *string `locationName:"collectionArn" type:"string" required:"true"` - // A mapping of Bedrock Knowledge Base fields to OpenSearch Serverless field - // names + // Contains the names of the fields to which to map information about the vector + // store. // // FieldMapping is a required field FieldMapping *OpenSearchServerlessFieldMapping `locationName:"fieldMapping" type:"structure" required:"true"` - // Arn of an OpenSearch Serverless index. + // The name of the vector store. // // VectorIndexName is a required field VectorIndexName *string `locationName:"vectorIndexName" type:"string" required:"true"` @@ -10793,22 +11079,25 @@ func (s *OpenSearchServerlessConfiguration) SetVectorIndexName(v string) *OpenSe return s } -// A mapping of Bedrock Knowledge Base fields to OpenSearch Serverless field -// names +// Contains the names of the fields to which to map information about the vector +// store. type OpenSearchServerlessFieldMapping struct { _ struct{} `type:"structure"` - // Name of the field + // The name of the field in which Amazon Bedrock stores metadata about the vector + // store. // // MetadataField is a required field MetadataField *string `locationName:"metadataField" type:"string" required:"true"` - // Name of the field + // 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. // // TextField is a required field TextField *string `locationName:"textField" type:"string" required:"true"` - // Name of the field + // The name of the field in which Amazon Bedrock stores the vector embeddings + // for your data sources. // // VectorField is a required field VectorField *string `locationName:"vectorField" type:"string" required:"true"` @@ -10869,26 +11158,29 @@ func (s *OpenSearchServerlessFieldMapping) SetVectorField(v string) *OpenSearchS return s } -// Contains the configurations to use Pinecone to store knowledge base data. +// Contains details about the storage configuration of the knowledge base in +// Pinecone. For more information, see Create a vector index in Pinecone (https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-pinecone.html). type PineconeConfiguration struct { _ struct{} `type:"structure"` - // Pinecone connection string + // The endpoint URL for your index management page. // // ConnectionString is a required field ConnectionString *string `locationName:"connectionString" type:"string" required:"true"` - // Arn of a SecretsManager Secret. + // The ARN of the secret that you created in Secrets Manager that is linked + // to your Pinecone API key. // // CredentialsSecretArn is a required field CredentialsSecretArn *string `locationName:"credentialsSecretArn" type:"string" required:"true"` - // A mapping of Bedrock Knowledge Base fields to Pinecone field names + // Contains the names of the fields to which to map information about the vector + // store. // // FieldMapping is a required field FieldMapping *PineconeFieldMapping `locationName:"fieldMapping" type:"structure" required:"true"` - // Pinecone namespace + // The namespace to be used to write new data to your database. Namespace *string `locationName:"namespace" type:"string"` } @@ -10958,16 +11250,19 @@ func (s *PineconeConfiguration) SetNamespace(v string) *PineconeConfiguration { return s } -// A mapping of Bedrock Knowledge Base fields to Pinecone field names +// Contains the names of the fields to which to map information about the vector +// store. type PineconeFieldMapping struct { _ struct{} `type:"structure"` - // Name of the field + // The name of the field in which Amazon Bedrock stores metadata about the vector + // store. // // MetadataField is a required field MetadataField *string `locationName:"metadataField" type:"string" required:"true"` - // Name of the field + // 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. // // TextField is a required field TextField *string `locationName:"textField" type:"string" required:"true"` @@ -11019,11 +11314,10 @@ func (s *PineconeFieldMapping) SetTextField(v string) *PineconeFieldMapping { return s } -// PrepareAgent Request type PrepareAgentInput struct { _ struct{} `type:"structure" nopayload:"true"` - // Id generated at the server side when an Agent is created + // The unique identifier of the agent for which to create a DRAFT version. // // AgentId is a required field AgentId *string `location:"uri" locationName:"agentId" type:"string" required:"true"` @@ -11069,26 +11363,25 @@ func (s *PrepareAgentInput) SetAgentId(v string) *PrepareAgentInput { return s } -// PrepareAgent Response type PrepareAgentOutput struct { _ struct{} `type:"structure"` - // Identifier for a resource. + // The unique identifier of the agent for which the DRAFT version was created. // // AgentId is a required field AgentId *string `locationName:"agentId" type:"string" required:"true"` - // Schema Type for Action APIs. + // The status of the DRAFT version and whether it is ready for use. // // AgentStatus is a required field AgentStatus *string `locationName:"agentStatus" type:"string" required:"true" enum:"AgentStatus"` - // Agent Version. + // The version of the agent. // // AgentVersion is a required field AgentVersion *string `locationName:"agentVersion" min:"1" type:"string" required:"true"` - // Time Stamp. + // The time at which the DRAFT version of the agent was last prepared. // // PreparedAt is a required field PreparedAt *time.Time `locationName:"preparedAt" type:"timestamp" timestampFormat:"iso8601" required:"true"` @@ -11136,26 +11429,48 @@ func (s *PrepareAgentOutput) SetPreparedAt(v time.Time) *PrepareAgentOutput { return s } -// BasePromptConfiguration per Prompt Type. +// Contains configurations to override a prompt template in one part of an agent +// sequence. For more information, see Advanced prompts (https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html). type PromptConfiguration struct { _ struct{} `type:"structure"` - // Base Prompt Template. + // 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 + // (https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-placeholders.html). BasePromptTemplate *string `locationName:"basePromptTemplate" min:"1" type:"string"` - // Configuration for inference in prompt configuration + // 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 (https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html). InferenceConfiguration *InferenceConfiguration `locationName:"inferenceConfiguration" type:"structure"` - // Creation Mode for Prompt Configuration. + // 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 (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html) + // must be specified with the ARN of a Lambda function. ParserMode *string `locationName:"parserMode" type:"string" enum:"CreationMode"` - // Creation Mode for Prompt Configuration. + // 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. PromptCreationMode *string `locationName:"promptCreationMode" type:"string" enum:"CreationMode"` - // Prompt State. + // 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 PromptState *string `locationName:"promptState" type:"string" enum:"PromptState"` - // Prompt Type. + // The step in the agent sequence that this prompt configuration applies to. PromptType *string `locationName:"promptType" type:"string" enum:"PromptType"` } @@ -11226,14 +11541,19 @@ func (s *PromptConfiguration) SetPromptType(v string) *PromptConfiguration { return s } -// Configuration for prompt override. +// Contains configurations to override prompts in different parts of an agent +// sequence. For more information, see Advanced prompts (https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html). type PromptOverrideConfiguration struct { _ struct{} `type:"structure" sensitive:"true"` - // ARN of a Lambda. + // 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. OverrideLambda *string `locationName:"overrideLambda" type:"string"` - // List of BasePromptConfiguration + // Contains configurations to override a prompt template in one part of an agent + // sequence. For more information, see Advanced prompts (https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html). // // PromptConfigurations is a required field PromptConfigurations []*PromptConfiguration `locationName:"promptConfigurations" type:"list" required:"true"` @@ -11292,31 +11612,35 @@ func (s *PromptOverrideConfiguration) SetPromptConfigurations(v []*PromptConfigu return s } -// Contains the configurations to use RDS to store knowledge base data. +// Contains details about the storage configuration of the knowledge base in +// Amazon RDS. For more information, see Create a vector index in Amazon RDS +// (https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-rds.html). type RdsConfiguration struct { _ struct{} `type:"structure"` - // Arn of a SecretsManager Secret. + // The ARN of the secret that you created in Secrets Manager that is linked + // to your Amazon RDS database. // // CredentialsSecretArn is a required field CredentialsSecretArn *string `locationName:"credentialsSecretArn" type:"string" required:"true"` - // Name of the database within RDS + // The name of your Amazon RDS database. // // DatabaseName is a required field DatabaseName *string `locationName:"databaseName" type:"string" required:"true"` - // A mapping of Bedrock Knowledge Base fields to RDS column names + // Contains the names of the fields to which to map information about the vector + // store. // // FieldMapping is a required field FieldMapping *RdsFieldMapping `locationName:"fieldMapping" type:"structure" required:"true"` - // Arn of a RDS Resource. + // The ARN of the vector store. // // ResourceArn is a required field ResourceArn *string `locationName:"resourceArn" type:"string" required:"true"` - // Name of the table within RDS + // The name of the table in the database. // // TableName is a required field TableName *string `locationName:"tableName" type:"string" required:"true"` @@ -11400,26 +11724,30 @@ func (s *RdsConfiguration) SetTableName(v string) *RdsConfiguration { return s } -// A mapping of Bedrock Knowledge Base fields to RDS column names +// Contains the names of the fields to which to map information about the vector +// store. type RdsFieldMapping struct { _ struct{} `type:"structure"` - // Name of the column + // The name of the field in which Amazon Bedrock stores metadata about the vector + // store. // // MetadataField is a required field MetadataField *string `locationName:"metadataField" type:"string" required:"true"` - // Name of the column + // The name of the field in which Amazon Bedrock stores the ID for each entry. // // PrimaryKeyField is a required field PrimaryKeyField *string `locationName:"primaryKeyField" type:"string" required:"true"` - // Name of the column + // 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. // // TextField is a required field TextField *string `locationName:"textField" type:"string" required:"true"` - // Name of the column + // The name of the field in which Amazon Bedrock stores the vector embeddings + // for your data sources. // // VectorField is a required field VectorField *string `locationName:"vectorField" type:"string" required:"true"` @@ -11489,27 +11817,30 @@ func (s *RdsFieldMapping) SetVectorField(v string) *RdsFieldMapping { return s } -// Contains the configurations to use Redis Enterprise Cloud to store knowledge -// base data. +// 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 (https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-oss.html). type RedisEnterpriseCloudConfiguration struct { _ struct{} `type:"structure"` - // Arn of a SecretsManager Secret. + // The ARN of the secret that you created in Secrets Manager that is linked + // to your Redis Enterprise Cloud database. // // CredentialsSecretArn is a required field CredentialsSecretArn *string `locationName:"credentialsSecretArn" type:"string" required:"true"` - // Redis enterprise cloud endpoint + // The endpoint URL of the Redis Enterprise Cloud database. // // Endpoint is a required field Endpoint *string `locationName:"endpoint" type:"string" required:"true"` - // A mapping of Bedrock Knowledge Base fields to Redis Cloud field names + // Contains the names of the fields to which to map information about the vector + // store. // // FieldMapping is a required field FieldMapping *RedisEnterpriseCloudFieldMapping `locationName:"fieldMapping" type:"structure" required:"true"` - // Name of a redis enterprise cloud index + // The name of the vector index. // // VectorIndexName is a required field VectorIndexName *string `locationName:"vectorIndexName" type:"string" required:"true"` @@ -11584,21 +11915,25 @@ func (s *RedisEnterpriseCloudConfiguration) SetVectorIndexName(v string) *RedisE return s } -// A mapping of Bedrock Knowledge Base fields to Redis Cloud field names +// Contains the names of the fields to which to map information about the vector +// store. type RedisEnterpriseCloudFieldMapping struct { _ struct{} `type:"structure"` - // Name of the field + // The name of the field in which Amazon Bedrock stores metadata about the vector + // store. // // MetadataField is a required field MetadataField *string `locationName:"metadataField" type:"string" required:"true"` - // Name of the field + // 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. // // TextField is a required field TextField *string `locationName:"textField" type:"string" required:"true"` - // Name of the field + // The name of the field in which Amazon Bedrock stores the vector embeddings + // for your data sources. // // VectorField is a required field VectorField *string `locationName:"vectorField" type:"string" required:"true"` @@ -11659,13 +11994,12 @@ func (s *RedisEnterpriseCloudFieldMapping) SetVectorField(v string) *RedisEnterp return s } -// This exception is thrown when a resource referenced by the operation does -// not exist +// The specified resource ARN was not found. Check the ARN and try your request +// again. type ResourceNotFoundException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` - // Non Blank String Message_ *string `locationName:"message" type:"string"` } @@ -11725,16 +12059,17 @@ func (s *ResourceNotFoundException) RequestID() string { return s.RespMetadata.RequestID } -// Configures an S3 data source location. +// Contains information about the S3 configuration of the data source. type S3DataSourceConfiguration struct { _ struct{} `type:"structure"` - // A S3 bucket ARN + // The ARN of the bucket that contains the data source. // // BucketArn is a required field BucketArn *string `locationName:"bucketArn" min:"1" type:"string" required:"true"` - // A list of S3 prefixes. + // A list of S3 prefixes that define the object containing the data sources. + // For more information, see Organizing objects using prefixes (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-prefixes.html). InclusionPrefixes []*string `locationName:"inclusionPrefixes" min:"1" type:"list"` } @@ -11787,14 +12122,14 @@ func (s *S3DataSourceConfiguration) SetInclusionPrefixes(v []*string) *S3DataSou return s } -// The identifier for the S3 resource. +// Contains information about the S3 object containing the resource. type S3Identifier struct { _ struct{} `type:"structure"` - // A bucket in S3. + // The name of the S3 bucket. S3BucketName *string `locationName:"s3BucketName" min:"3" type:"string"` - // A object key in S3. + // The S3 object key containing the resource. S3ObjectKey *string `locationName:"s3ObjectKey" min:"1" type:"string"` } @@ -11844,11 +12179,11 @@ func (s *S3Identifier) SetS3ObjectKey(v string) *S3Identifier { return s } -// Server-side encryption configuration. +// Contains the configuration for server-side encryption. type ServerSideEncryptionConfiguration struct { _ struct{} `type:"structure"` - // A KMS key ARN + // The ARN of the KMS key used to encrypt the resource. KmsKeyArn *string `locationName:"kmsKeyArn" min:"1" type:"string"` } @@ -11889,12 +12224,11 @@ func (s *ServerSideEncryptionConfiguration) SetKmsKeyArn(v string) *ServerSideEn return s } -// This exception is thrown when a request is made beyond the service quota +// The number of requests exceeds the service quota. Resubmit your request later. type ServiceQuotaExceededException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` - // Non Blank String Message_ *string `locationName:"message" type:"string"` } @@ -11957,18 +12291,21 @@ func (s *ServiceQuotaExceededException) RequestID() string { type StartIngestionJobInput struct { _ struct{} `type:"structure"` - // Client specified token used for idempotency checks + // 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 (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). ClientToken *string `locationName:"clientToken" min:"33" type:"string" idempotencyToken:"true"` - // Identifier for a resource. + // The unique identifier of the data source to ingest. // // DataSourceId is a required field DataSourceId *string `location:"uri" locationName:"dataSourceId" type:"string" required:"true"` - // Description of the Resource. + // A description of the ingestion job. Description *string `locationName:"description" min:"1" type:"string"` - // Identifier for a resource. + // The unique identifier of the knowledge base to which to add the data source. // // KnowledgeBaseId is a required field KnowledgeBaseId *string `location:"uri" locationName:"knowledgeBaseId" type:"string" required:"true"` @@ -12047,7 +12384,7 @@ func (s *StartIngestionJobInput) SetKnowledgeBaseId(v string) *StartIngestionJob type StartIngestionJobOutput struct { _ struct{} `type:"structure"` - // Contains the information of an ingestion job. + // An object containing information about the ingestion job. // // IngestionJob is a required field IngestionJob *IngestionJob `locationName:"ingestionJob" type:"structure" required:"true"` @@ -12077,25 +12414,27 @@ func (s *StartIngestionJobOutput) SetIngestionJob(v *IngestionJob) *StartIngesti return s } -// Configures the physical storage of ingested data in a knowledge base. +// Contains the storage configuration of the knowledge base. type StorageConfiguration struct { _ struct{} `type:"structure"` - // Contains the configurations to use OpenSearch Serverless to store knowledge - // base data. + // Contains the storage configuration of the knowledge base in Amazon OpenSearch + // Service. OpensearchServerlessConfiguration *OpenSearchServerlessConfiguration `locationName:"opensearchServerlessConfiguration" type:"structure"` - // Contains the configurations to use Pinecone to store knowledge base data. + // Contains the storage configuration of the knowledge base in Pinecone. PineconeConfiguration *PineconeConfiguration `locationName:"pineconeConfiguration" type:"structure"` - // Contains the configurations to use RDS to store knowledge base data. + // Contains details about the storage configuration of the knowledge base in + // Amazon RDS. For more information, see Create a vector index in Amazon RDS + // (https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-rds.html). RdsConfiguration *RdsConfiguration `locationName:"rdsConfiguration" type:"structure"` - // Contains the configurations to use Redis Enterprise Cloud to store knowledge - // base data. + // Contains the storage configuration of the knowledge base in Redis Enterprise + // Cloud. RedisEnterpriseCloudConfiguration *RedisEnterpriseCloudConfiguration `locationName:"redisEnterpriseCloudConfiguration" type:"structure"` - // The storage type of a knowledge base. + // The vector store service in which the knowledge base is stored. // // Type is a required field Type *string `locationName:"type" type:"string" required:"true" enum:"KnowledgeBaseStorageType"` @@ -12185,12 +12524,13 @@ func (s *StorageConfiguration) SetType(v string) *StorageConfiguration { type TagResourceInput struct { _ struct{} `type:"structure"` - // ARN of Taggable resources: [Agent, AgentAlias, Knowledge-Base] + // The ARN of the resource to tag. // // ResourceArn is a required field ResourceArn *string `location:"uri" locationName:"resourceArn" min:"20" type:"string" required:"true"` - // A map of tag keys and values + // An object containing key-value pairs that define the tags to attach to the + // resource. // // Tags is a required field Tags map[string]*string `locationName:"tags" type:"map" required:"true"` @@ -12267,12 +12607,11 @@ func (s TagResourceOutput) GoString() string { return s.String() } -// This exception is thrown when the number of requests exceeds the limit +// The number of requests exceeds the limit. Resubmit your request later. type ThrottlingException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` - // Non Blank String Message_ *string `locationName:"message" type:"string"` } @@ -12335,12 +12674,12 @@ func (s *ThrottlingException) RequestID() string { type UntagResourceInput struct { _ struct{} `type:"structure" nopayload:"true"` - // ARN of Taggable resources: [Agent, AgentAlias, Knowledge-Base] + // The ARN of the resource from which to remove tags. // // ResourceArn is a required field ResourceArn *string `location:"uri" locationName:"resourceArn" min:"20" type:"string" required:"true"` - // List of Tag Keys + // A list of keys of the tags to remove from the resource. // // TagKeys is a required field TagKeys []*string `location:"querystring" locationName:"tagKeys" type:"list" required:"true"` @@ -12417,43 +12756,57 @@ func (s UntagResourceOutput) GoString() string { return s.String() } -// Update Action Group Request type UpdateAgentActionGroupInput struct { _ struct{} `type:"structure"` - // Type of Executors for an Action Group + // The ARN of the Lambda function containing the business logic that is carried + // out upon invoking the action. ActionGroupExecutor *ActionGroupExecutor `locationName:"actionGroupExecutor" type:"structure"` - // Id generated at the server side when an Action Group is created under Agent + // The unique identifier of the action group. // // ActionGroupId is a required field ActionGroupId *string `location:"uri" locationName:"actionGroupId" type:"string" required:"true"` - // Name for a resource. + // Specifies a new name for the action group. // // ActionGroupName is a required field ActionGroupName *string `locationName:"actionGroupName" type:"string" required:"true"` - // State of the action group + // Specifies whether the action group is available for the agent to invoke or + // not when sending an InvokeAgent (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html) + // request. ActionGroupState *string `locationName:"actionGroupState" type:"string" enum:"ActionGroupState"` - // Id generated at the server side when an Agent is created + // The unique identifier of the agent for which to update the action group. // // AgentId is a required field AgentId *string `location:"uri" locationName:"agentId" type:"string" required:"true"` - // Draft Version of the Agent. + // The unique identifier of the agent version for which to update the action + // group. // // AgentVersion is a required field AgentVersion *string `location:"uri" locationName:"agentVersion" min:"5" type:"string" required:"true"` - // Contains information about the API Schema for the Action Group + // 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 (https://docs.aws.amazon.com/bedrock/latest/userguide/agents-api-schema.html). ApiSchema *APISchema `locationName:"apiSchema" type:"structure"` - // Description of the Resource. + // Specifies a new name for the action group. Description *string `locationName:"description" min:"1" type:"string"` - // Action Group Signature for a BuiltIn Action + // 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 + // (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Observation.html) + // reprompting the user for more information. ParentActionGroupSignature *string `locationName:"parentActionGroupSignature" type:"string" enum:"ActionGroupSignature"` } @@ -12568,11 +12921,10 @@ func (s *UpdateAgentActionGroupInput) SetParentActionGroupSignature(v string) *U return s } -// Update Action Group Response type UpdateAgentActionGroupOutput struct { _ struct{} `type:"structure"` - // Contains the information of an Agent Action Group + // Contains details about the action group that was updated. // // AgentActionGroup is a required field AgentActionGroup *AgentActionGroup `locationName:"agentActionGroup" type:"structure" required:"true"` @@ -12602,29 +12954,28 @@ func (s *UpdateAgentActionGroupOutput) SetAgentActionGroup(v *AgentActionGroup) return s } -// Update Agent Alias Request type UpdateAgentAliasInput struct { _ struct{} `type:"structure"` - // Id generated at the server side when an Agent Alias is created + // The unique identifier of the alias. // // AgentAliasId is a required field AgentAliasId *string `location:"uri" locationName:"agentAliasId" min:"10" type:"string" required:"true"` - // Name for a resource. + // Specifies a new name for the alias. // // AgentAliasName is a required field AgentAliasName *string `locationName:"agentAliasName" type:"string" required:"true"` - // Id generated at the server side when an Agent is created + // The unique identifier of the agent. // // AgentId is a required field AgentId *string `location:"uri" locationName:"agentId" type:"string" required:"true"` - // Description of the Resource. + // Specifies a new description for the alias. Description *string `locationName:"description" min:"1" type:"string"` - // Routing configuration for an Agent alias. + // Contains details about the routing configuration of the alias. RoutingConfiguration []*AgentAliasRoutingConfigurationListItem `locationName:"routingConfiguration" type:"list"` } @@ -12714,11 +13065,10 @@ func (s *UpdateAgentAliasInput) SetRoutingConfiguration(v []*AgentAliasRoutingCo return s } -// Update Agent Alias Response type UpdateAgentAliasOutput struct { _ struct{} `type:"structure"` - // Contains the information of an agent alias + // Contains details about the alias that was updated. // // AgentAlias is a required field AgentAlias *AgentAlias `locationName:"agentAlias" type:"structure" required:"true"` @@ -12748,45 +13098,54 @@ func (s *UpdateAgentAliasOutput) SetAgentAlias(v *AgentAlias) *UpdateAgentAliasO return s } -// Update Agent Request type UpdateAgentInput struct { _ struct{} `type:"structure"` - // Id generated at the server side when an Agent is created + // The unique identifier of the agent. // // AgentId is a required field AgentId *string `location:"uri" locationName:"agentId" type:"string" required:"true"` - // Name for a resource. + // Specifies a new name for the agent. // // AgentName is a required field AgentName *string `locationName:"agentName" type:"string" required:"true"` - // ARN of a IAM role. + // The ARN of the IAM role with permissions to update the agent. The ARN must + // begin with AmazonBedrockExecutionRoleForAgents_. // // AgentResourceRoleArn is a required field AgentResourceRoleArn *string `locationName:"agentResourceRoleArn" type:"string" required:"true"` - // A KMS key ARN + // The ARN of the KMS key with which to encrypt the agent. CustomerEncryptionKeyArn *string `locationName:"customerEncryptionKeyArn" min:"1" type:"string"` - // Description of the Resource. + // Specifies a new description of the agent. Description *string `locationName:"description" min:"1" type:"string"` - // ARN or name of a Bedrock model. - FoundationModel *string `locationName:"foundationModel" min:"1" type:"string"` + // Specifies a new foundation model to be used for orchestration by the agent. + // + // FoundationModel is a required field + FoundationModel *string `locationName:"foundationModel" min:"1" type:"string" required:"true"` - // Max Session Time. + // 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. IdleSessionTTLInSeconds *int64 `locationName:"idleSessionTTLInSeconds" min:"60" type:"integer"` - // Instruction for the agent. + // Specifies new instructions that tell the agent what it should do and how + // it should interact with users. // // Instruction is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by UpdateAgentInput's // String and GoString methods. Instruction *string `locationName:"instruction" min:"40" type:"string" sensitive:"true"` - // Configuration for prompt override. + // Contains configurations to override prompts in different parts of an agent + // sequence. For more information, see Advanced prompts (https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html). // // PromptOverrideConfiguration is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by UpdateAgentInput's @@ -12833,6 +13192,9 @@ func (s *UpdateAgentInput) Validate() error { if s.Description != nil && len(*s.Description) < 1 { invalidParams.Add(request.NewErrParamMinLen("Description", 1)) } + if s.FoundationModel == nil { + invalidParams.Add(request.NewErrParamRequired("FoundationModel")) + } if s.FoundationModel != nil && len(*s.FoundationModel) < 1 { invalidParams.Add(request.NewErrParamMinLen("FoundationModel", 1)) } @@ -12908,30 +13270,33 @@ func (s *UpdateAgentInput) SetPromptOverrideConfiguration(v *PromptOverrideConfi return s } -// Update Agent Knowledge Base Request type UpdateAgentKnowledgeBaseInput struct { _ struct{} `type:"structure"` - // Id generated at the server side when an Agent is created + // The unique identifier of the agent associated with the knowledge base that + // you want to update. // // AgentId is a required field AgentId *string `location:"uri" locationName:"agentId" type:"string" required:"true"` - // Draft Version of the Agent. + // The version of the agent associated with the knowledge base that you want + // to update. // // AgentVersion is a required field AgentVersion *string `location:"uri" locationName:"agentVersion" min:"5" type:"string" required:"true"` - // Description of the Resource. + // Specifies a new description for the knowledge base associated with an agent. Description *string `locationName:"description" min:"1" type:"string"` - // Id generated at the server side when a Knowledge Base is associated to an - // Agent + // The unique identifier of the knowledge base that has been associated with + // an agent. // // KnowledgeBaseId is a required field KnowledgeBaseId *string `location:"uri" locationName:"knowledgeBaseId" type:"string" required:"true"` - // State of the knowledge base; whether it is enabled or disabled + // Specifies whether the agent uses the knowledge base or not when sending an + // InvokeAgent (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html) + // request. KnowledgeBaseState *string `locationName:"knowledgeBaseState" type:"string" enum:"KnowledgeBaseState"` } @@ -13014,11 +13379,11 @@ func (s *UpdateAgentKnowledgeBaseInput) SetKnowledgeBaseState(v string) *UpdateA return s } -// Update Agent Knowledge Base Response type UpdateAgentKnowledgeBaseOutput struct { _ struct{} `type:"structure"` - // Contains the information of an Agent Knowledge Base. + // Contains details about the knowledge base that has been associated with an + // agent. // // AgentKnowledgeBase is a required field AgentKnowledgeBase *AgentKnowledgeBase `locationName:"agentKnowledgeBase" type:"structure" required:"true"` @@ -13048,11 +13413,10 @@ func (s *UpdateAgentKnowledgeBaseOutput) SetAgentKnowledgeBase(v *AgentKnowledge return s } -// Update Agent Response type UpdateAgentOutput struct { _ struct{} `type:"structure"` - // Contains the information of an agent + // Contains details about the agent that was updated. // // Agent is a required field Agent *Agent `locationName:"agent" type:"structure" required:"true"` @@ -13085,33 +13449,33 @@ func (s *UpdateAgentOutput) SetAgent(v *Agent) *UpdateAgentOutput { type UpdateDataSourceInput struct { _ struct{} `type:"structure"` - // Specifies a raw data source location to ingest. + // Contains details about the storage configuration of the data source. // // DataSourceConfiguration is a required field DataSourceConfiguration *DataSourceConfiguration `locationName:"dataSourceConfiguration" type:"structure" required:"true"` - // Identifier for a resource. + // The unique identifier of the data source. // // DataSourceId is a required field DataSourceId *string `location:"uri" locationName:"dataSourceId" type:"string" required:"true"` - // Description of the Resource. + // Specifies a new description for the data source. Description *string `locationName:"description" min:"1" type:"string"` - // Identifier for a resource. + // The unique identifier of the knowledge base to which the data source belongs. // // KnowledgeBaseId is a required field KnowledgeBaseId *string `location:"uri" locationName:"knowledgeBaseId" type:"string" required:"true"` - // Name for a resource. + // Specifies a new name for the data source. // // Name is a required field Name *string `locationName:"name" type:"string" required:"true"` - // Server-side encryption configuration. + // Contains details about server-side encryption of the data source. ServerSideEncryptionConfiguration *ServerSideEncryptionConfiguration `locationName:"serverSideEncryptionConfiguration" type:"structure"` - // Configures ingestion for a vector knowledge base + // Contains details about how to ingest the documents in the data source. VectorIngestionConfiguration *VectorIngestionConfiguration `locationName:"vectorIngestionConfiguration" type:"structure"` } @@ -13224,7 +13588,7 @@ func (s *UpdateDataSourceInput) SetVectorIngestionConfiguration(v *VectorIngesti type UpdateDataSourceOutput struct { _ struct{} `type:"structure"` - // Contains the information of a data source. + // Contains details about the data source. // // DataSource is a required field DataSource *DataSource `locationName:"dataSource" type:"structure" required:"true"` @@ -13257,30 +13621,34 @@ func (s *UpdateDataSourceOutput) SetDataSource(v *DataSource) *UpdateDataSourceO type UpdateKnowledgeBaseInput struct { _ struct{} `type:"structure"` - // Description of the Resource. + // Specifies a new description for the knowledge base. Description *string `locationName:"description" min:"1" type:"string"` - // Configures a bedrock knowledge base. + // 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. // // KnowledgeBaseConfiguration is a required field KnowledgeBaseConfiguration *KnowledgeBaseConfiguration `locationName:"knowledgeBaseConfiguration" type:"structure" required:"true"` - // Identifier for a resource. + // The unique identifier of the knowledge base to update. // // KnowledgeBaseId is a required field KnowledgeBaseId *string `location:"uri" locationName:"knowledgeBaseId" type:"string" required:"true"` - // Name for a resource. + // Specifies a new name for the knowledge base. // // Name is a required field Name *string `locationName:"name" type:"string" required:"true"` - // ARN of a IAM role. + // Specifies a different Amazon Resource Name (ARN) of the IAM role with permissions + // to modify the knowledge base. // // RoleArn is a required field RoleArn *string `locationName:"roleArn" type:"string" required:"true"` - // Configures the physical storage of ingested data in a knowledge base. + // 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. // // StorageConfiguration is a required field StorageConfiguration *StorageConfiguration `locationName:"storageConfiguration" type:"structure" required:"true"` @@ -13384,7 +13752,7 @@ func (s *UpdateKnowledgeBaseInput) SetStorageConfiguration(v *StorageConfigurati type UpdateKnowledgeBaseOutput struct { _ struct{} `type:"structure"` - // Contains the information of a knowledge base. + // Contains details about the knowledge base. // // KnowledgeBase is a required field KnowledgeBase *KnowledgeBase `locationName:"knowledgeBase" type:"structure" required:"true"` @@ -13414,15 +13782,15 @@ func (s *UpdateKnowledgeBaseOutput) SetKnowledgeBase(v *KnowledgeBase) *UpdateKn return s } -// This exception is thrown when the request's input validation fails +// Input validation failed. Check your request parameters and retry the request. type ValidationException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` - // list of ValidationExceptionField + // A list of objects containing fields that caused validation errors and their + // corresponding validation error messages. FieldList []*ValidationExceptionField `locationName:"fieldList" type:"list"` - // Non Blank String Message_ *string `locationName:"message" type:"string"` } @@ -13483,16 +13851,16 @@ func (s *ValidationException) RequestID() string { } // Stores information about a field passed inside a request that resulted in -// an exception +// an validation error. type ValidationExceptionField struct { _ struct{} `type:"structure"` - // Non Blank String + // A message describing why this field failed validation. // // Message is a required field Message *string `locationName:"message" type:"string" required:"true"` - // Non Blank String + // The name of the field. // // Name is a required field Name *string `locationName:"name" type:"string" required:"true"` @@ -13528,11 +13896,13 @@ func (s *ValidationExceptionField) SetName(v string) *ValidationExceptionField { return s } -// Configures ingestion for a vector knowledge base +// Contains details about how to ingest the documents in a data source. type VectorIngestionConfiguration struct { _ struct{} `type:"structure"` - // Configures chunking strategy + // 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. ChunkingConfiguration *ChunkingConfiguration `locationName:"chunkingConfiguration" type:"structure"` } @@ -13575,11 +13945,12 @@ func (s *VectorIngestionConfiguration) SetChunkingConfiguration(v *ChunkingConfi return s } -// Configurations for a vector knowledge base. +// Contains details about the model used to create vector embeddings for the +// knowledge base. type VectorKnowledgeBaseConfiguration struct { _ struct{} `type:"structure"` - // Arn of a Bedrock model. + // The ARN of the model used to create vector embeddings for the knowledge base. // // EmbeddingModelArn is a required field EmbeddingModelArn *string `locationName:"embeddingModelArn" min:"20" type:"string" required:"true"` @@ -13625,7 +13996,6 @@ func (s *VectorKnowledgeBaseConfiguration) SetEmbeddingModelArn(v string) *Vecto return s } -// Action Group Signature for a BuiltIn Action const ( // ActionGroupSignatureAmazonUserInput is a ActionGroupSignature enum value ActionGroupSignatureAmazonUserInput = "AMAZON.UserInput" @@ -13638,7 +14008,6 @@ func ActionGroupSignature_Values() []string { } } -// State of the action group const ( // ActionGroupStateEnabled is a ActionGroupState enum value ActionGroupStateEnabled = "ENABLED" @@ -13655,7 +14024,6 @@ func ActionGroupState_Values() []string { } } -// The statuses an Agent Alias can be in. const ( // AgentAliasStatusCreating is a AgentAliasStatus enum value AgentAliasStatusCreating = "CREATING" @@ -13684,7 +14052,6 @@ func AgentAliasStatus_Values() []string { } } -// Schema Type for Action APIs. const ( // AgentStatusCreating is a AgentStatus enum value AgentStatusCreating = "CREATING" @@ -13725,7 +14092,6 @@ func AgentStatus_Values() []string { } } -// The type of chunking strategy const ( // ChunkingStrategyFixedSize is a ChunkingStrategy enum value ChunkingStrategyFixedSize = "FIXED_SIZE" @@ -13742,7 +14108,6 @@ func ChunkingStrategy_Values() []string { } } -// Creation Mode for Prompt Configuration. const ( // CreationModeDefault is a CreationMode enum value CreationModeDefault = "DEFAULT" @@ -13759,7 +14124,6 @@ func CreationMode_Values() []string { } } -// The status of a data source. const ( // DataSourceStatusAvailable is a DataSourceStatus enum value DataSourceStatusAvailable = "AVAILABLE" @@ -13776,7 +14140,6 @@ func DataSourceStatus_Values() []string { } } -// The type of the data source location. const ( // DataSourceTypeS3 is a DataSourceType enum value DataSourceTypeS3 = "S3" @@ -13789,7 +14152,6 @@ func DataSourceType_Values() []string { } } -// The name of the field to filter ingestion jobs. const ( // IngestionJobFilterAttributeStatus is a IngestionJobFilterAttribute enum value IngestionJobFilterAttributeStatus = "STATUS" @@ -13802,7 +14164,6 @@ func IngestionJobFilterAttribute_Values() []string { } } -// The operator used to filter ingestion jobs. const ( // IngestionJobFilterOperatorEq is a IngestionJobFilterOperator enum value IngestionJobFilterOperatorEq = "EQ" @@ -13815,7 +14176,6 @@ func IngestionJobFilterOperator_Values() []string { } } -// The name of the field to sort ingestion jobs. const ( // IngestionJobSortByAttributeStatus is a IngestionJobSortByAttribute enum value IngestionJobSortByAttributeStatus = "STATUS" @@ -13832,7 +14192,6 @@ func IngestionJobSortByAttribute_Values() []string { } } -// The status of an ingestion job. const ( // IngestionJobStatusStarting is a IngestionJobStatus enum value IngestionJobStatusStarting = "STARTING" @@ -13857,7 +14216,6 @@ func IngestionJobStatus_Values() []string { } } -// State of the knowledge base; whether it is enabled or disabled const ( // KnowledgeBaseStateEnabled is a KnowledgeBaseState enum value KnowledgeBaseStateEnabled = "ENABLED" @@ -13874,7 +14232,6 @@ func KnowledgeBaseState_Values() []string { } } -// The status of a knowledge base. const ( // KnowledgeBaseStatusCreating is a KnowledgeBaseStatus enum value KnowledgeBaseStatusCreating = "CREATING" @@ -13903,7 +14260,6 @@ func KnowledgeBaseStatus_Values() []string { } } -// The storage type of a knowledge base. const ( // KnowledgeBaseStorageTypeOpensearchServerless is a KnowledgeBaseStorageType enum value KnowledgeBaseStorageTypeOpensearchServerless = "OPENSEARCH_SERVERLESS" @@ -13928,7 +14284,6 @@ func KnowledgeBaseStorageType_Values() []string { } } -// The type of a knowledge base. const ( // KnowledgeBaseTypeVector is a KnowledgeBaseType enum value KnowledgeBaseTypeVector = "VECTOR" @@ -13941,7 +14296,6 @@ func KnowledgeBaseType_Values() []string { } } -// Prompt State. const ( // PromptStateEnabled is a PromptState enum value PromptStateEnabled = "ENABLED" @@ -13958,7 +14312,6 @@ func PromptState_Values() []string { } } -// Prompt Type. const ( // PromptTypePreProcessing is a PromptType enum value PromptTypePreProcessing = "PRE_PROCESSING" @@ -13983,7 +14336,6 @@ func PromptType_Values() []string { } } -// Order to sort results by. const ( // SortOrderAscending is a SortOrder enum value SortOrderAscending = "ASCENDING" diff --git a/service/bedrockagent/doc.go b/service/bedrockagent/doc.go index c497aa38c3c..4fe65c2f7c8 100644 --- a/service/bedrockagent/doc.go +++ b/service/bedrockagent/doc.go @@ -3,8 +3,7 @@ // Package bedrockagent provides the client and types for making API // requests to Agents for Amazon Bedrock. // -// An example service, deployed with the Octane Service creator, which will -// echo the string +// Describes the API operations for creating and managing Amazon Bedrock agents. // // See https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05 for more information on this service. // diff --git a/service/bedrockagent/errors.go b/service/bedrockagent/errors.go index 24505c2917d..52cffd0bb89 100644 --- a/service/bedrockagent/errors.go +++ b/service/bedrockagent/errors.go @@ -11,45 +11,44 @@ const ( // ErrCodeAccessDeniedException for service response error code // "AccessDeniedException". // - // This exception is thrown when a request is denied per access permissions + // The request is denied because of missing access permissions. ErrCodeAccessDeniedException = "AccessDeniedException" // ErrCodeConflictException for service response error code // "ConflictException". // - // This exception is thrown when there is a conflict performing an operation + // There was a conflict performing an operation. ErrCodeConflictException = "ConflictException" // ErrCodeInternalServerException for service response error code // "InternalServerException". // - // This exception is thrown if there was an unexpected error during processing - // of request + // An internal server error occurred. Retry your request. ErrCodeInternalServerException = "InternalServerException" // ErrCodeResourceNotFoundException for service response error code // "ResourceNotFoundException". // - // This exception is thrown when a resource referenced by the operation does - // not exist + // The specified resource ARN was not found. Check the ARN and try your request + // again. ErrCodeResourceNotFoundException = "ResourceNotFoundException" // ErrCodeServiceQuotaExceededException for service response error code // "ServiceQuotaExceededException". // - // This exception is thrown when a request is made beyond the service quota + // The number of requests exceeds the service quota. Resubmit your request later. ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException" // ErrCodeThrottlingException for service response error code // "ThrottlingException". // - // This exception is thrown when the number of requests exceeds the limit + // The number of requests exceeds the limit. Resubmit your request later. ErrCodeThrottlingException = "ThrottlingException" // ErrCodeValidationException for service response error code // "ValidationException". // - // This exception is thrown when the request's input validation fails + // Input validation failed. Check your request parameters and retry the request. ErrCodeValidationException = "ValidationException" ) diff --git a/service/bedrockagentruntime/api.go b/service/bedrockagentruntime/api.go index 77440a62b57..f993ed651b2 100644 --- a/service/bedrockagentruntime/api.go +++ b/service/bedrockagentruntime/api.go @@ -516,8 +516,7 @@ func (c *BedrockAgentRuntime) RetrieveAndGenerateRequest(input *RetrieveAndGener // RetrieveAndGenerate API operation for Agents for Amazon Bedrock Runtime. // // 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. +// The response only cites sources that are relevant to the query. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2140,6 +2139,15 @@ func (s *KnowledgeBaseRetrieveAndGenerateConfiguration) SetRetrievalConfiguratio type KnowledgeBaseVectorSearchConfiguration struct { _ struct{} `type:"structure"` + // Specifies the filters to use on the metadata in the knowledge base data sources + // before returning results. For more information, see Query configurations + // (https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html). + // + // Filter is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by KnowledgeBaseVectorSearchConfiguration's + // String and GoString methods. + Filter *RetrievalFilter `locationName:"filter" type:"structure" sensitive:"true"` + // The number of source chunks to retrieve. NumberOfResults *int64 `locationName:"numberOfResults" min:"1" type:"integer"` @@ -2176,6 +2184,11 @@ func (s *KnowledgeBaseVectorSearchConfiguration) Validate() error { if s.NumberOfResults != nil && *s.NumberOfResults < 1 { invalidParams.Add(request.NewErrParamMinValue("NumberOfResults", 1)) } + if s.Filter != nil { + if err := s.Filter.Validate(); err != nil { + invalidParams.AddNested("Filter", err.(request.ErrInvalidParams)) + } + } if invalidParams.Len() > 0 { return invalidParams @@ -2183,6 +2196,12 @@ func (s *KnowledgeBaseVectorSearchConfiguration) Validate() error { return nil } +// SetFilter sets the Filter field's value. +func (s *KnowledgeBaseVectorSearchConfiguration) SetFilter(v *RetrievalFilter) *KnowledgeBaseVectorSearchConfiguration { + s.Filter = v + return s +} + // SetNumberOfResults sets the NumberOfResults field's value. func (s *KnowledgeBaseVectorSearchConfiguration) SetNumberOfResults(v int64) *KnowledgeBaseVectorSearchConfiguration { s.NumberOfResults = &v @@ -2907,6 +2926,7 @@ func (s *PreProcessingTrace) SetModelInvocationOutput(v *PreProcessingModelInvoc // This data type is used in the following API operations: // // - RetrieveAndGenerate request (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax) +// – in the filter field type PromptTemplate struct { _ struct{} `type:"structure"` @@ -3356,6 +3376,95 @@ func (e *ResponseStreamUnknownEvent) UnmarshalEvent( return nil } +// Specifies the filters to use on the metadata attributes in the knowledge +// base data sources before returning results. For more information, see Query +// configurations (https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html). +// +// This data type is used in the following API operations: +// +// - Retrieve request (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax) +// – in the filter field +// +// - RetrieveAndGenerate request (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax) +// – in the filter field +type RetrievalFilter struct { + _ struct{} `type:"structure" sensitive:"true"` + + // Knowledge base data sources whose metadata attributes fulfill all the filter + // conditions inside this list are returned. + AndAll []*RetrievalFilter `locationName:"andAll" min:"2" type:"list"` + + // Knowledge base data sources whose metadata attributes fulfill at least one + // of the filter conditions inside this list are returned. + OrAll []*RetrievalFilter `locationName:"orAll" min:"2" type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s RetrievalFilter) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s RetrievalFilter) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *RetrievalFilter) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "RetrievalFilter"} + if s.AndAll != nil && len(s.AndAll) < 2 { + invalidParams.Add(request.NewErrParamMinLen("AndAll", 2)) + } + if s.OrAll != nil && len(s.OrAll) < 2 { + invalidParams.Add(request.NewErrParamMinLen("OrAll", 2)) + } + if s.AndAll != nil { + for i, v := range s.AndAll { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "AndAll", i), err.(request.ErrInvalidParams)) + } + } + } + if s.OrAll != nil { + for i, v := range s.OrAll { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "OrAll", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAndAll sets the AndAll field's value. +func (s *RetrievalFilter) SetAndAll(v []*RetrievalFilter) *RetrievalFilter { + s.AndAll = v + return s +} + +// SetOrAll sets the OrAll field's value. +func (s *RetrievalFilter) SetOrAll(v []*RetrievalFilter) *RetrievalFilter { + s.OrAll = v + return s +} + // Contains the cited text from the data source. // // This data type is used in the following API operations: diff --git a/service/elasticache/api.go b/service/elasticache/api.go index 7af48207425..01b8c0d0dc9 100644 --- a/service/elasticache/api.go +++ b/service/elasticache/api.go @@ -10456,11 +10456,6 @@ func (s *CacheUsageLimits) Validate() error { invalidParams.AddNested("DataStorage", err.(request.ErrInvalidParams)) } } - if s.ECPUPerSecond != nil { - if err := s.ECPUPerSecond.Validate(); err != nil { - invalidParams.AddNested("ECPUPerSecond", err.(request.ErrInvalidParams)) - } - } if invalidParams.Len() > 0 { return invalidParams @@ -13556,9 +13551,10 @@ type DataStorage struct { _ struct{} `type:"structure"` // The upper limit for data storage the cache is set to use. - // - // Maximum is a required field - Maximum *int64 `type:"integer" required:"true"` + Maximum *int64 `type:"integer"` + + // The lower limit for data storage the cache is set to use. + Minimum *int64 `type:"integer"` // The unit that the storage is measured in, in GB. // @@ -13587,9 +13583,6 @@ func (s DataStorage) GoString() string { // Validate inspects the fields of the type to determine if they are valid. func (s *DataStorage) Validate() error { invalidParams := request.ErrInvalidParams{Context: "DataStorage"} - if s.Maximum == nil { - invalidParams.Add(request.NewErrParamRequired("Maximum")) - } if s.Unit == nil { invalidParams.Add(request.NewErrParamRequired("Unit")) } @@ -13606,6 +13599,12 @@ func (s *DataStorage) SetMaximum(v int64) *DataStorage { return s } +// SetMinimum sets the Minimum field's value. +func (s *DataStorage) SetMinimum(v int64) *DataStorage { + s.Minimum = &v + return s +} + // SetUnit sets the Unit field's value. func (s *DataStorage) SetUnit(v string) *DataStorage { s.Unit = &v @@ -17582,9 +17581,11 @@ type ECPUPerSecond struct { // The configuration for the maximum number of ECPUs the cache can consume per // second. - // - // Maximum is a required field - Maximum *int64 `type:"integer" required:"true"` + Maximum *int64 `type:"integer"` + + // The configuration for the minimum number of ECPUs the cache should be able + // consume per second. + Minimum *int64 `type:"integer"` } // String returns the string representation. @@ -17605,25 +17606,18 @@ func (s ECPUPerSecond) GoString() string { return s.String() } -// Validate inspects the fields of the type to determine if they are valid. -func (s *ECPUPerSecond) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "ECPUPerSecond"} - if s.Maximum == nil { - invalidParams.Add(request.NewErrParamRequired("Maximum")) - } - - if invalidParams.Len() > 0 { - return invalidParams - } - return nil -} - // SetMaximum sets the Maximum field's value. func (s *ECPUPerSecond) SetMaximum(v int64) *ECPUPerSecond { s.Maximum = &v return s } +// SetMinimum sets the Minimum field's value. +func (s *ECPUPerSecond) SetMinimum(v int64) *ECPUPerSecond { + s.Minimum = &v + return s +} + // Represents the information required for client programs to connect to a cache // node. This value is read-only. type Endpoint struct { diff --git a/service/secretsmanager/api.go b/service/secretsmanager/api.go index 4b72692d274..97c1ac7b74d 100644 --- a/service/secretsmanager/api.go +++ b/service/secretsmanager/api.go @@ -5643,6 +5643,21 @@ type PutResourcePolicyInput struct { // 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 (https://docs.aws.amazon.com/secretsmanager/latest/userguide/determine-acccess_examine-iam-policies.html). BlockPublicPolicy *bool `type:"boolean"` // A JSON-formatted string for an Amazon Web Services resource-based policy.