AWS cli documentation change
Summary
Updated AWS CLI version reference from 2.28.8 to 2.28.11. Restructured command parameters, added detailed documentation for knowledge base configurations including vector embeddings, SQL database connections, storage configurations, and security-related IAM role parameters. Expanded JSON syntax examples and response structures.
Security assessment
The changes include documentation for IAM role permissions (--role-arn) and secret management (credentialsSecretArn), which are security-related features. However, there is no evidence of addressing a specific security vulnerability or incident. The updates primarily enhance documentation clarity and detail existing security practices without indicating a security patch.
Diff
diff --git a/cli/latest/reference/bedrock-agent/create-knowledge-base.md b/cli/latest/reference/bedrock-agent/create-knowledge-base.md index ebf8d9815..134b92978 100644 --- a//cli/latest/reference/bedrock-agent/create-knowledge-base.md +++ b//cli/latest/reference/bedrock-agent/create-knowledge-base.md @@ -15 +15 @@ - * [AWS CLI 2.28.8 Command Reference](../../index.html) » + * [AWS CLI 2.28.11 Command Reference](../../index.html) » @@ -83,2 +82,0 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc - [--description <value>] - --knowledge-base-configuration <value> @@ -85,0 +84 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc + [--description <value>] @@ -86,0 +86 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc + --knowledge-base-configuration <value> @@ -116,0 +117,4 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc +`--name` (string) + +> A name for the knowledge base. + @@ -120,0 +125,4 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc +`--role-arn` (string) + +> The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base. + @@ -124,0 +133,52 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc +> 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/` . +> @@ -136,0 +197,4 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc +>> type -> (string) +>> +>>> The type of SQL database to connect to the knowledge base. +>> @@ -140,0 +205,30 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc +>>> 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. +>>> @@ -145 +239 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc ->>>> provisionedConfiguration -> (structure) +>>>> type -> (string) @@ -147 +241,9 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc ->>>>> 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. @@ -151,5 +253 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc ->>>>>> 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. @@ -163,0 +262,4 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc +>>>> +>>>> provisionedConfiguration -> (structure) +>>>> +>>>>> Specifies configurations for a provisioned Amazon Redshift query engine. @@ -168,4 +269,0 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc ->>>> ->>>> serverlessConfiguration -> (structure) ->>>> ->>>>> Specifies configurations for a serverless Amazon Redshift query engine. @@ -175 +273 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc ->>>>>> Specifies configurations for authentication to an Amazon Redshift provisioned data warehouse. +>>>>>> Specifies configurations for authentication to Amazon Redshift. @@ -180,0 +279,4 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc +>>>>>> databaseUser -> (string) +>>>>>> +>>>>>>> The database username for authentication to an Amazon Redshift provisioned data warehouse. +>>>>>> @@ -184,8 +285,0 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc ->>>>> ->>>>> workgroupArn -> (string) ->>>>> ->>>>>> The ARN of the Amazon Redshift workgroup. ->>>> ->>>> type -> (string) ->>>> ->>>>> The type of query engine. @@ -205 +299 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc ->>>>> curatedQueries -> (list) +>>>>> tables -> (list) @@ -207 +301 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc ->>>>>> 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. @@ -211 +305 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc ->>>>>>> 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. @@ -213 +307 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc ->>>>>>> naturalLanguage -> (string) +>>>>>>> name -> (string) @@ -215 +309 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc ->>>>>>>> An example natural language query. +>>>>>>>> The name of the table for which the other fields in this object apply. @@ -217 +311 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc ->>>>>>> sql -> (string) +>>>>>>> description -> (string) @@ -219,9 +313,5 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc ->>>>>>>> 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. +>>>>>>> +>>>>>>> inclusion -> (string) +>>>>>>> +>>>>>>>> Specifies whether to include or exclude the table during query generation. If you specify `EXCLUDE` , the table will be ignored. If you specify `INCLUDE` , all other tables will be ignored. @@ -236,0 +327,4 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc +>>>>>>>>> name -> (string) +>>>>>>>>> +>>>>>>>>>> The name of the column for which the other fields in this object apply. +>>>>>>>>> @@ -244,24 +337,0 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedroc