AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Agents for Amazon Bedrock UpdateKnowledgeBase API operation.

Syntax

Update-AABKnowledgeBase
-KnowledgeBaseId <String>
-ProvisionedConfiguration_ClusterIdentifier <String>
-OpensearchServerlessConfiguration_CollectionArn <String>
-MongoDbAtlasConfiguration_CollectionName <String>
-PineconeConfiguration_ConnectionString <String>
-MongoDbAtlasConfiguration_CredentialsSecretArn <String>
-PineconeConfiguration_CredentialsSecretArn <String>
-RdsConfiguration_CredentialsSecretArn <String>
-RedisEnterpriseCloudConfiguration_CredentialsSecretArn <String>
-GenerationContext_CuratedQuery <CuratedQuery[]>
-FieldMapping_CustomMetadataField <String>
-MongoDbAtlasConfiguration_DatabaseName <String>
-RdsConfiguration_DatabaseName <String>
-AuthConfiguration_DatabaseUser <String>
-Description <String>
-BedrockEmbeddingModelConfiguration_Dimension <Int32>
-OpensearchManagedClusterConfiguration_DomainArn <String>
-OpensearchManagedClusterConfiguration_DomainEndpoint <String>
-BedrockEmbeddingModelConfiguration_EmbeddingDataType <EmbeddingDataType>
-VectorKnowledgeBaseConfiguration_EmbeddingModelArn <String>
-MongoDbAtlasConfiguration_Endpoint <String>
-RedisEnterpriseCloudConfiguration_Endpoint <String>
-MongoDbAtlasConfiguration_EndpointServiceName <String>
-QueryGenerationConfiguration_ExecutionTimeoutSecond <Int32>
-NeptuneAnalyticsConfiguration_GraphArn <String>
-S3VectorsConfiguration_IndexArn <String>
-S3VectorsConfiguration_IndexName <String>
-KendraKnowledgeBaseConfiguration_KendraIndexArn <String>
-StorageConfiguration_MongoDbAtlasConfiguration_FieldMapping_MetadataField <String>
-StorageConfiguration_NeptuneAnalyticsConfiguration_FieldMapping_MetadataField <String>
-StorageConfiguration_OpensearchManagedClusterConfiguration_FieldMapping_MetadataField <String>
-StorageConfiguration_OpensearchServerlessConfiguration_FieldMapping_MetadataField <String>
-StorageConfiguration_PineconeConfiguration_FieldMapping_MetadataField <String>
-StorageConfiguration_RdsConfiguration_FieldMapping_MetadataField <String>
-StorageConfiguration_RedisEnterpriseCloudConfiguration_FieldMapping_MetadataField <String>
-Name <String>
-PineconeConfiguration_Namespace <String>
-FieldMapping_PrimaryKeyField <String>
-RdsConfiguration_ResourceArn <String>
-RoleArn <String>
-RedshiftConfiguration_StorageConfiguration <RedshiftQueryEngineStorageConfiguration[]>
-SupplementalDataStorageConfiguration_StorageLocation <SupplementalDataStorageLocation[]>
-RdsConfiguration_TableName <String>
-GenerationContext_Table <QueryGenerationTable[]>
-StorageConfiguration_MongoDbAtlasConfiguration_FieldMapping_TextField <String>
-StorageConfiguration_NeptuneAnalyticsConfiguration_FieldMapping_TextField <String>
-StorageConfiguration_OpensearchManagedClusterConfiguration_FieldMapping_TextField <String>
-StorageConfiguration_OpensearchServerlessConfiguration_FieldMapping_TextField <String>
-StorageConfiguration_PineconeConfiguration_FieldMapping_TextField <String>
-StorageConfiguration_RdsConfiguration_FieldMapping_TextField <String>
-StorageConfiguration_RedisEnterpriseCloudConfiguration_FieldMapping_TextField <String>
-MongoDbAtlasConfiguration_TextIndexName <String>
-KnowledgeBaseConfiguration_SqlKnowledgeBaseConfiguration_RedshiftConfiguration_QueryEngineConfiguration_ProvisionedConfiguration_AuthConfiguration_Type <RedshiftProvisionedAuthType>
-AuthConfiguration_Type <RedshiftServerlessAuthType>
-QueryEngineConfiguration_Type <RedshiftQueryEngineType>
-SqlKnowledgeBaseConfiguration_Type <QueryEngineType>
-KnowledgeBaseConfiguration_Type <KnowledgeBaseType>
-StorageConfiguration_Type <KnowledgeBaseStorageType>
-KnowledgeBaseConfiguration_SqlKnowledgeBaseConfiguration_RedshiftConfiguration_QueryEngineConfiguration_ProvisionedConfiguration_AuthConfiguration_UsernamePasswordSecretArn <String>
-AuthConfiguration_UsernamePasswordSecretArn <String>
-S3VectorsConfiguration_VectorBucketArn <String>
-StorageConfiguration_MongoDbAtlasConfiguration_FieldMapping_VectorField <String>
-StorageConfiguration_OpensearchManagedClusterConfiguration_FieldMapping_VectorField <String>
-StorageConfiguration_OpensearchServerlessConfiguration_FieldMapping_VectorField <String>
-StorageConfiguration_RdsConfiguration_FieldMapping_VectorField <String>
-StorageConfiguration_RedisEnterpriseCloudConfiguration_FieldMapping_VectorField <String>
-MongoDbAtlasConfiguration_VectorIndexName <String>
-OpensearchManagedClusterConfiguration_VectorIndexName <String>
-OpensearchServerlessConfiguration_VectorIndexName <String>
-RedisEnterpriseCloudConfiguration_VectorIndexName <String>
-ServerlessConfiguration_WorkgroupArn <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonBedrockAgentConfig>

Description

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.

Parameters

-AuthConfiguration_DatabaseUser <String>
The database username for authentication to an Amazon Redshift provisioned data warehouse.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesKnowledgeBaseConfiguration_SqlKnowledgeBaseConfiguration_RedshiftConfiguration_QueryEngineConfiguration_ProvisionedConfiguration_AuthConfiguration_DatabaseUser
-AuthConfiguration_Type <RedshiftServerlessAuthType>
The type of authentication to use.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesKnowledgeBaseConfiguration_SqlKnowledgeBaseConfiguration_RedshiftConfiguration_QueryEngineConfiguration_ServerlessConfiguration_AuthConfiguration_Type
-AuthConfiguration_UsernamePasswordSecretArn <String>
The ARN of an Secrets Manager secret for authentication.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesKnowledgeBaseConfiguration_SqlKnowledgeBaseConfiguration_RedshiftConfiguration_QueryEngineConfiguration_ServerlessConfiguration_AuthConfiguration_UsernamePasswordSecretArn
-BedrockEmbeddingModelConfiguration_Dimension <Int32>
The dimensions details for the vector configuration used on the Bedrock embeddings model.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesKnowledgeBaseConfiguration_VectorKnowledgeBaseConfiguration_EmbeddingModelConfiguration_BedrockEmbeddingModelConfiguration_Dimensions
-BedrockEmbeddingModelConfiguration_EmbeddingDataType <EmbeddingDataType>
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 for information on the available models and their vector data types.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesKnowledgeBaseConfiguration_VectorKnowledgeBaseConfiguration_EmbeddingModelConfiguration_BedrockEmbeddingModelConfiguration_EmbeddingDataType
-ClientConfig <AmazonBedrockAgentConfig>
Amazon.PowerShell.Cmdlets.AAB.AmazonBedrockAgentClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Description <String>
Specifies a new description for the knowledge base.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FieldMapping_CustomMetadataField <String>
Provide a name for the universal metadata field where Amazon Bedrock will store any custom metadata from your data source.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStorageConfiguration_RdsConfiguration_FieldMapping_CustomMetadataField
-FieldMapping_PrimaryKeyField <String>
The name of the field in which Amazon Bedrock stores the ID for each entry.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStorageConfiguration_RdsConfiguration_FieldMapping_PrimaryKeyField
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-GenerationContext_CuratedQuery <CuratedQuery[]>
An array of objects, each of which defines information about example queries to help the query engine generate appropriate SQL queries.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesKnowledgeBaseConfiguration_SqlKnowledgeBaseConfiguration_RedshiftConfiguration_QueryGenerationConfiguration_GenerationContext_CuratedQueries
-GenerationContext_Table <QueryGenerationTable[]>
An array of objects, each of which defines information about a table in the database.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesKnowledgeBaseConfiguration_SqlKnowledgeBaseConfiguration_RedshiftConfiguration_QueryGenerationConfiguration_GenerationContext_Tables
-KendraKnowledgeBaseConfiguration_KendraIndexArn <String>
The ARN of the Amazon Kendra index.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesKnowledgeBaseConfiguration_KendraKnowledgeBaseConfiguration_KendraIndexArn
-KnowledgeBaseConfiguration_SqlKnowledgeBaseConfiguration_RedshiftConfiguration_QueryEngineConfiguration_ProvisionedConfiguration_AuthConfiguration_Type <RedshiftProvisionedAuthType>
The type of authentication to use.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-KnowledgeBaseConfiguration_SqlKnowledgeBaseConfiguration_RedshiftConfiguration_QueryEngineConfiguration_ProvisionedConfiguration_AuthConfiguration_UsernamePasswordSecretArn <String>
The ARN of an Secrets Manager secret for authentication.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-KnowledgeBaseConfiguration_Type <KnowledgeBaseType>
The type of data that the data source is converted into for the knowledge base.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-KnowledgeBaseId <String>
The unique identifier of the knowledge base to update.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-MongoDbAtlasConfiguration_CollectionName <String>
The collection name of the knowledge base in MongoDB Atlas.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStorageConfiguration_MongoDbAtlasConfiguration_CollectionName
-MongoDbAtlasConfiguration_CredentialsSecretArn <String>
The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that contains user credentials for your MongoDB Atlas cluster.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStorageConfiguration_MongoDbAtlasConfiguration_CredentialsSecretArn
-MongoDbAtlasConfiguration_DatabaseName <String>
The database name in your MongoDB Atlas cluster for your knowledge base.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStorageConfiguration_MongoDbAtlasConfiguration_DatabaseName
-MongoDbAtlasConfiguration_Endpoint <String>
The endpoint URL of your MongoDB Atlas cluster for your knowledge base.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStorageConfiguration_MongoDbAtlasConfiguration_Endpoint
-MongoDbAtlasConfiguration_EndpointServiceName <String>
The name of the VPC endpoint service in your account that is connected to your MongoDB Atlas cluster.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStorageConfiguration_MongoDbAtlasConfiguration_EndpointServiceName
-MongoDbAtlasConfiguration_TextIndexName <String>
The name of the text search index in the MongoDB collection. This is required for using the hybrid search feature.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStorageConfiguration_MongoDbAtlasConfiguration_TextIndexName
-MongoDbAtlasConfiguration_VectorIndexName <String>
The name of the MongoDB Atlas vector search index.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStorageConfiguration_MongoDbAtlasConfiguration_VectorIndexName
-Name <String>
Specifies a new name for the knowledge base.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-NeptuneAnalyticsConfiguration_GraphArn <String>
The Amazon Resource Name (ARN) of the Neptune Analytics vector store.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStorageConfiguration_NeptuneAnalyticsConfiguration_GraphArn
-OpensearchManagedClusterConfiguration_DomainArn <String>
The Amazon Resource Name (ARN) of the OpenSearch domain.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStorageConfiguration_OpensearchManagedClusterConfiguration_DomainArn
-OpensearchManagedClusterConfiguration_DomainEndpoint <String>
The endpoint URL the OpenSearch domain.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStorageConfiguration_OpensearchManagedClusterConfiguration_DomainEndpoint
-OpensearchManagedClusterConfiguration_VectorIndexName <String>
The name of the vector store.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStorageConfiguration_OpensearchManagedClusterConfiguration_VectorIndexName
-OpensearchServerlessConfiguration_CollectionArn <String>
The Amazon Resource Name (ARN) of the OpenSearch Service vector store.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStorageConfiguration_OpensearchServerlessConfiguration_CollectionArn
-OpensearchServerlessConfiguration_VectorIndexName <String>
The name of the vector store.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStorageConfiguration_OpensearchServerlessConfiguration_VectorIndexName
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the KnowledgeBaseId parameter. The -PassThru parameter is deprecated, use -Select '^KnowledgeBaseId' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PineconeConfiguration_ConnectionString <String>
The endpoint URL for your index management page.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStorageConfiguration_PineconeConfiguration_ConnectionString
-PineconeConfiguration_CredentialsSecretArn <String>
The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Pinecone API key.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStorageConfiguration_PineconeConfiguration_CredentialsSecretArn
-PineconeConfiguration_Namespace <String>
The namespace to be used to write new data to your database.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStorageConfiguration_PineconeConfiguration_Namespace
-ProvisionedConfiguration_ClusterIdentifier <String>
The ID of the Amazon Redshift cluster.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesKnowledgeBaseConfiguration_SqlKnowledgeBaseConfiguration_RedshiftConfiguration_QueryEngineConfiguration_ProvisionedConfiguration_ClusterIdentifier
-QueryEngineConfiguration_Type <RedshiftQueryEngineType>
The type of query engine.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesKnowledgeBaseConfiguration_SqlKnowledgeBaseConfiguration_RedshiftConfiguration_QueryEngineConfiguration_Type
-QueryGenerationConfiguration_ExecutionTimeoutSecond <Int32>
The time after which query generation will time out.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesKnowledgeBaseConfiguration_SqlKnowledgeBaseConfiguration_RedshiftConfiguration_QueryGenerationConfiguration_ExecutionTimeoutSeconds
-RdsConfiguration_CredentialsSecretArn <String>
The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Amazon RDS database.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStorageConfiguration_RdsConfiguration_CredentialsSecretArn
-RdsConfiguration_DatabaseName <String>
The name of your Amazon RDS database.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStorageConfiguration_RdsConfiguration_DatabaseName
-RdsConfiguration_ResourceArn <String>
The Amazon Resource Name (ARN) of the vector store.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStorageConfiguration_RdsConfiguration_ResourceArn
-RdsConfiguration_TableName <String>
The name of the table in the database.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStorageConfiguration_RdsConfiguration_TableName
-RedisEnterpriseCloudConfiguration_CredentialsSecretArn <String>
The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Redis Enterprise Cloud database.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStorageConfiguration_RedisEnterpriseCloudConfiguration_CredentialsSecretArn
-RedisEnterpriseCloudConfiguration_Endpoint <String>
The endpoint URL of the Redis Enterprise Cloud database.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStorageConfiguration_RedisEnterpriseCloudConfiguration_Endpoint
-RedisEnterpriseCloudConfiguration_VectorIndexName <String>
The name of the vector index.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStorageConfiguration_RedisEnterpriseCloudConfiguration_VectorIndexName
-RedshiftConfiguration_StorageConfiguration <RedshiftQueryEngineStorageConfiguration[]>
Specifies configurations for Amazon Redshift database storage.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesKnowledgeBaseConfiguration_SqlKnowledgeBaseConfiguration_RedshiftConfiguration_StorageConfigurations
-RoleArn <String>
Specifies a different Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-S3VectorsConfiguration_IndexArn <String>
The Amazon Resource Name (ARN) of the vector index used for the knowledge base. This ARN identifies the specific vector index resource within Amazon Bedrock.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStorageConfiguration_S3VectorsConfiguration_IndexArn
-S3VectorsConfiguration_IndexName <String>
The name of the vector index used for the knowledge base. This name identifies the vector index within the Amazon Bedrock service.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStorageConfiguration_S3VectorsConfiguration_IndexName
-S3VectorsConfiguration_VectorBucketArn <String>
The Amazon Resource Name (ARN) of the S3 bucket where vector embeddings are stored. This bucket contains the vector data used by the knowledge base.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStorageConfiguration_S3VectorsConfiguration_VectorBucketArn
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'KnowledgeBase'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgent.Model.UpdateKnowledgeBaseResponse). Specifying the name of a property of type Amazon.BedrockAgent.Model.UpdateKnowledgeBaseResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ServerlessConfiguration_WorkgroupArn <String>
The ARN of the Amazon Redshift workgroup.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesKnowledgeBaseConfiguration_SqlKnowledgeBaseConfiguration_RedshiftConfiguration_QueryEngineConfiguration_ServerlessConfiguration_WorkgroupArn
-SqlKnowledgeBaseConfiguration_Type <QueryEngineType>
The type of SQL database to connect to the knowledge base.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesKnowledgeBaseConfiguration_SqlKnowledgeBaseConfiguration_Type
-StorageConfiguration_MongoDbAtlasConfiguration_FieldMapping_MetadataField <String>
The name of the field in which Amazon Bedrock stores metadata about the vector store.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StorageConfiguration_MongoDbAtlasConfiguration_FieldMapping_TextField <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StorageConfiguration_MongoDbAtlasConfiguration_FieldMapping_VectorField <String>
The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StorageConfiguration_NeptuneAnalyticsConfiguration_FieldMapping_MetadataField <String>
The name of the field in which Amazon Bedrock stores metadata about the vector store.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StorageConfiguration_NeptuneAnalyticsConfiguration_FieldMapping_TextField <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StorageConfiguration_OpensearchManagedClusterConfiguration_FieldMapping_MetadataField <String>
The name of the field in which Amazon Bedrock stores metadata about the vector store.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StorageConfiguration_OpensearchManagedClusterConfiguration_FieldMapping_TextField <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StorageConfiguration_OpensearchManagedClusterConfiguration_FieldMapping_VectorField <String>
The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StorageConfiguration_OpensearchServerlessConfiguration_FieldMapping_MetadataField <String>
The name of the field in which Amazon Bedrock stores metadata about the vector store.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StorageConfiguration_OpensearchServerlessConfiguration_FieldMapping_TextField <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StorageConfiguration_OpensearchServerlessConfiguration_FieldMapping_VectorField <String>
The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StorageConfiguration_PineconeConfiguration_FieldMapping_MetadataField <String>
The name of the field in which Amazon Bedrock stores metadata about the vector store.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StorageConfiguration_PineconeConfiguration_FieldMapping_TextField <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StorageConfiguration_RdsConfiguration_FieldMapping_MetadataField <String>
The name of the field in which Amazon Bedrock stores metadata about the vector store.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFieldMapping_MetadataField
-StorageConfiguration_RdsConfiguration_FieldMapping_TextField <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFieldMapping_TextField
-StorageConfiguration_RdsConfiguration_FieldMapping_VectorField <String>
The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFieldMapping_VectorField
-StorageConfiguration_RedisEnterpriseCloudConfiguration_FieldMapping_MetadataField <String>
The name of the field in which Amazon Bedrock stores metadata about the vector store.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StorageConfiguration_RedisEnterpriseCloudConfiguration_FieldMapping_TextField <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StorageConfiguration_RedisEnterpriseCloudConfiguration_FieldMapping_VectorField <String>
The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StorageConfiguration_Type <KnowledgeBaseStorageType>
The vector store service in which the knowledge base is stored.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SupplementalDataStorageConfiguration_StorageLocation <SupplementalDataStorageLocation[]>
A list of objects specifying storage locations for images extracted from multimodal documents in your data source.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesKnowledgeBaseConfiguration_VectorKnowledgeBaseConfiguration_SupplementalDataStorageConfiguration_StorageLocations
-VectorKnowledgeBaseConfiguration_EmbeddingModelArn <String>
The Amazon Resource Name (ARN) of the model used to create vector embeddings for the knowledge base.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesKnowledgeBaseConfiguration_VectorKnowledgeBaseConfiguration_EmbeddingModelArn

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.BedrockAgent.Model.KnowledgeBase or Amazon.BedrockAgent.Model.UpdateKnowledgeBaseResponse
This cmdlet returns an Amazon.BedrockAgent.Model.KnowledgeBase object. The service call response (type Amazon.BedrockAgent.Model.UpdateKnowledgeBaseResponse) can be returned by specifying '-Select *'.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z