AWS cli low security documentation change
Summary
Updated CLI version reference and restructured knowledge base configuration documentation with added details about vector embeddings, IAM roles, multimodal data storage, and database configurations
Security assessment
Added documentation for 'roleArn' field specifying IAM role permissions for knowledge base operations, which is a security-related configuration. However there is no indication this addresses a specific vulnerability.
Diff
diff --git a/cli/latest/reference/bedrock-agent/get-knowledge-base.md b/cli/latest/reference/bedrock-agent/get-knowledge-base.md index e438160d4..f18f9886d 100644 --- a//cli/latest/reference/bedrock-agent/get-knowledge-base.md +++ b//cli/latest/reference/bedrock-agent/get-knowledge-base.md @@ -15 +15 @@ - * [AWS CLI 2.28.8 Command Reference](../../index.html) » + * [AWS CLI 2.28.11 Command Reference](../../index.html) » @@ -199,5 +199 @@ knowledgeBase -> (structure) -> createdAt -> (timestamp) -> ->> The time the knowledge base was created. -> -> description -> (string) +> knowledgeBaseId -> (string) @@ -205 +201 @@ knowledgeBase -> (structure) ->> The description of the knowledge base. +>> The unique identifier of the knowledge base. @@ -207 +203 @@ knowledgeBase -> (structure) -> failureReasons -> (list) +> name -> (string) @@ -209,3 +205 @@ knowledgeBase -> (structure) ->> A list of reasons that the API operation on the knowledge base failed. ->> ->> (string) +>> The name of the knowledge base. @@ -216,0 +211,8 @@ knowledgeBase -> (structure) +> description -> (string) +> +>> The description of the knowledge base. +> +> roleArn -> (string) +> +>> The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base. +> @@ -220,0 +223,52 @@ knowledgeBase -> (structure) +>> type -> (string) +>> +>>> The type of data that the data source is converted into for the knowledge base. +>> +>> vectorKnowledgeBaseConfiguration -> (structure) +>> +>>> Contains details about the model that’s used to convert the data source into vector embeddings. +>>> +>>> embeddingModelArn -> (string) +>>> +>>>> The Amazon Resource Name (ARN) of the model used to create vector embeddings for the knowledge base. +>>> +>>> embeddingModelConfiguration -> (structure) +>>> +>>>> The embeddings model configuration details for the vector model used in Knowledge Base. +>>>> +>>>> bedrockEmbeddingModelConfiguration -> (structure) +>>>> +>>>>> The vector configuration details on the Bedrock embeddings model. +>>>>> +>>>>> dimensions -> (integer) +>>>>> +>>>>>> The dimensions details for the vector configuration used on the Bedrock embeddings model. +>>>>> +>>>>> embeddingDataType -> (string) +>>>>> +>>>>>> The data type for the vectors when using a model to convert text into vector embeddings. The model must support the specified data type for vector embeddings. Floating-point (float32) is the default data type, and is supported by most models for vector embeddings. See [Supported embeddings models](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-supported.html) for information on the available models and their vector data types. +>>> +>>> supplementalDataStorageConfiguration -> (structure) +>>> +>>>> If you include multimodal data from your data source, use this object to specify configurations for the storage location of the images extracted from your documents. These images can be retrieved and returned to the end user. They can also be used in generation when using [RetrieveAndGenerate](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html) . +>>>> +>>>> storageLocations -> (list) +>>>> +>>>>> A list of objects specifying storage locations for images extracted from multimodal documents in your data source. +>>>>> +>>>>> (structure) +>>>>> +>>>>>> Contains information about a storage location for images extracted from multimodal documents in your data source. +>>>>>> +>>>>>> type -> (string) +>>>>>> +>>>>>>> Specifies the storage service used for this location. +>>>>>> +>>>>>> s3Location -> (structure) +>>>>>> +>>>>>>> Contains information about the Amazon S3 location for the extracted images. +>>>>>>> +>>>>>>> uri -> (string) +>>>>>>> +>>>>>>>> The location’s URI. For example, `s3://my-bucket/chunk-processor/` . +>> @@ -232,0 +287,4 @@ knowledgeBase -> (structure) +>>> type -> (string) +>>> +>>>> The type of SQL database to connect to the knowledge base. +>>> @@ -236,0 +295,30 @@ knowledgeBase -> (structure) +>>>> storageConfigurations -> (list) +>>>> +>>>>> Specifies configurations for Amazon Redshift database storage. +>>>>> +>>>>> (structure) +>>>>> +>>>>>> Contains configurations for Amazon Redshift data storage. Specify the data storage service to use in the `type` field and include the corresponding field. For more information, see [Build a knowledge base by connecting to a structured data source](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-build-structured.html) in the Amazon Bedrock User Guide. +>>>>>> +>>>>>> type -> (string) +>>>>>> +>>>>>>> The data storage service to use. +>>>>>> +>>>>>> awsDataCatalogConfiguration -> (structure) +>>>>>> +>>>>>>> Specifies configurations for storage in Glue Data Catalog. +>>>>>>> +>>>>>>> tableNames -> (list) +>>>>>>> +>>>>>>>> A list of names of the tables to use. +>>>>>>>> +>>>>>>>> (string) +>>>>>> +>>>>>> redshiftConfiguration -> (structure) +>>>>>> +>>>>>>> Specifies configurations for storage in Amazon Redshift. +>>>>>>> +>>>>>>> databaseName -> (string) +>>>>>>> +>>>>>>>> The name of the Amazon Redshift database. +>>>> @@ -241 +329 @@ knowledgeBase -> (structure) ->>>>> provisionedConfiguration -> (structure) +>>>>> type -> (string) @@ -243 +331,9 @@ knowledgeBase -> (structure) ->>>>>> Specifies configurations for a provisioned Amazon Redshift query engine. +>>>>>> The type of query engine. +>>>>> +>>>>> serverlessConfiguration -> (structure) +>>>>> +>>>>>> Specifies configurations for a serverless Amazon Redshift query engine. +>>>>>> +>>>>>> workgroupArn -> (string) +>>>>>> +>>>>>>> The ARN of the Amazon Redshift workgroup. @@ -247,5 +343 @@ knowledgeBase -> (structure) ->>>>>>> Specifies configurations for authentication to Amazon Redshift. ->>>>>>> ->>>>>>> databaseUser -> (string) ->>>>>>> ->>>>>>>> The database username for authentication to an Amazon Redshift provisioned data warehouse. +>>>>>>> Specifies configurations for authentication to an Amazon Redshift provisioned data warehouse. @@ -259,0 +352,4 @@ knowledgeBase -> (structure) +>>>>> +>>>>> provisionedConfiguration -> (structure) +>>>>> +>>>>>> Specifies configurations for a provisioned Amazon Redshift query engine. @@ -264,4 +359,0 @@ knowledgeBase -> (structure) ->>>>> ->>>>> serverlessConfiguration -> (structure) ->>>>> ->>>>>> Specifies configurations for a serverless Amazon Redshift query engine. @@ -271 +363 @@ knowledgeBase -> (structure) ->>>>>>> Specifies configurations for authentication to an Amazon Redshift provisioned data warehouse. +>>>>>>> Specifies configurations for authentication to Amazon Redshift. @@ -276,0 +369,4 @@ knowledgeBase -> (structure) +>>>>>>> databaseUser -> (string) +>>>>>>> +>>>>>>>> The database username for authentication to an Amazon Redshift provisioned data warehouse. +>>>>>>> @@ -280,8 +375,0 @@ knowledgeBase -> (structure) ->>>>>> ->>>>>> workgroupArn -> (string) ->>>>>> ->>>>>>> The ARN of the Amazon Redshift workgroup. ->>>>> ->>>>> type -> (string) ->>>>> ->>>>>> The type of query engine. @@ -301 +389 @@ knowledgeBase -> (structure) ->>>>>> curatedQueries -> (list) +>>>>>> tables -> (list) @@ -303 +391 @@ knowledgeBase -> (structure) ->>>>>>> An array of objects, each of which defines information about example queries to help the query engine generate appropriate SQL queries. +>>>>>>> An array of objects, each of which defines information about a table in the database. @@ -307 +395 @@ knowledgeBase -> (structure) ->>>>>>>> Contains configurations for a query, each of which defines information about example queries to help the query engine generate appropriate SQL queries. +>>>>>>>> Contains information about a table for the query engine to consider. @@ -309 +397 @@ knowledgeBase -> (structure) ->>>>>>>> naturalLanguage -> (string) +>>>>>>>> name -> (string) @@ -311 +399 @@ knowledgeBase -> (structure) ->>>>>>>>> An example natural language query. +>>>>>>>>> The name of the table for which the other fields in this object apply. @@ -313 +401 @@ knowledgeBase -> (structure) ->>>>>>>> sql -> (string) +>>>>>>>> description -> (string) @@ -315,9 +403,5 @@ knowledgeBase -> (structure) ->>>>>>>>> The SQL equivalent of the natural language query. ->>>>>> ->>>>>> tables -> (list) ->>>>>> ->>>>>>> An array of objects, each of which defines information about a table in the database. ->>>>>>> ->>>>>>> (structure) ->>>>>>> ->>>>>>>> Contains information about a table for the query engine to consider. +>>>>>>>>> A description of the table that helps the query engine understand the contents of the table.