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 UpdateDataSource API operation.

Syntax

Update-AABDataSource
-DataSourceId <String>
-DataSourceConfiguration_ConfluenceConfiguration_SourceConfiguration_AuthType <ConfluenceAuthType>
-DataSourceConfiguration_SalesforceConfiguration_SourceConfiguration_AuthType <SalesforceAuthType>
-DataSourceConfiguration_SharePointConfiguration_SourceConfiguration_AuthType <SharePointAuthType>
-SemanticChunkingConfiguration_BreakpointPercentileThreshold <Int32>
-S3Configuration_BucketArn <String>
-S3Configuration_BucketOwnerAccountId <String>
-SemanticChunkingConfiguration_BufferSize <Int32>
-ChunkingConfiguration_ChunkingStrategy <ChunkingStrategy>
-DataSourceConfiguration_ConfluenceConfiguration_SourceConfiguration_CredentialsSecretArn <String>
-DataSourceConfiguration_SalesforceConfiguration_SourceConfiguration_CredentialsSecretArn <String>
-DataSourceConfiguration_SharePointConfiguration_SourceConfiguration_CredentialsSecretArn <String>
-DataDeletionPolicy <DataDeletionPolicy>
-Description <String>
-SourceConfiguration_Domain <String>
-CrawlerConfiguration_ExclusionFilter <String[]>
-DataSourceConfiguration_ConfluenceConfiguration_CrawlerConfiguration_FilterConfiguration_PatternObjectFilter_Filters <PatternObjectFilter[]>
-DataSourceConfiguration_SalesforceConfiguration_CrawlerConfiguration_FilterConfiguration_PatternObjectFilter_Filters <PatternObjectFilter[]>
-DataSourceConfiguration_SharePointConfiguration_CrawlerConfiguration_FilterConfiguration_PatternObjectFilter_Filters <PatternObjectFilter[]>
-DataSourceConfiguration_ConfluenceConfiguration_SourceConfiguration_HostType <ConfluenceHostType>
-DataSourceConfiguration_SharePointConfiguration_SourceConfiguration_HostType <SharePointHostType>
-DataSourceConfiguration_ConfluenceConfiguration_SourceConfiguration_HostUrl <String>
-DataSourceConfiguration_SalesforceConfiguration_SourceConfiguration_HostUrl <String>
-CrawlerConfiguration_InclusionFilter <String[]>
-S3Configuration_InclusionPrefix <String[]>
-ServerSideEncryptionConfiguration_KmsKeyArn <String>
-KnowledgeBaseId <String>
-HierarchicalChunkingConfiguration_LevelConfiguration <HierarchicalChunkingLevelConfiguration[]>
-FixedSizeChunkingConfiguration_MaxToken <Int32>
-SemanticChunkingConfiguration_MaxToken <Int32>
-BedrockFoundationModelConfiguration_ModelArn <String>
-Name <String>
-FixedSizeChunkingConfiguration_OverlapPercentage <Int32>
-HierarchicalChunkingConfiguration_OverlapToken <Int32>
-ParsingPrompt_ParsingPromptText <String>
-ParsingConfiguration_ParsingStrategy <ParsingStrategy>
-CrawlerLimits_RateLimit <Int32>
-CrawlerConfiguration_Scope <WebScopeType>
-UrlConfiguration_SeedUrl <SeedUrl[]>
-SourceConfiguration_SiteUrl <String[]>
-SourceConfiguration_TenantId <String>
-CustomTransformationConfiguration_Transformation <Transformation[]>
-DataSourceConfiguration_ConfluenceConfiguration_CrawlerConfiguration_FilterConfiguration_Type <CrawlFilterConfigurationType>
-DataSourceConfiguration_SalesforceConfiguration_CrawlerConfiguration_FilterConfiguration_Type <CrawlFilterConfigurationType>
-DataSourceConfiguration_SharePointConfiguration_CrawlerConfiguration_FilterConfiguration_Type <CrawlFilterConfigurationType>
-DataSourceConfiguration_Type <DataSourceType>
-S3Location_Uri <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonBedrockAgentConfig>

Description

Updates the configurations for a data source connector. You can't change the chunkingConfiguration after you create the data source connector. Specify the existing chunkingConfiguration.

Parameters

-BedrockFoundationModelConfiguration_ModelArn <String>
The model's ARN.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesVectorIngestionConfiguration_ParsingConfiguration_BedrockFoundationModelConfiguration_ModelArn
-ChunkingConfiguration_ChunkingStrategy <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.
  • HIERARCHICAL – Split documents into layers of chunks where the first layer contains large chunks, and the second layer contains smaller chunks derived from the first layer.
  • SEMANTIC – Split documents into chunks based on groups of similar content derived with natural language processing.
  • 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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesVectorIngestionConfiguration_ChunkingConfiguration_ChunkingStrategy
-ClientConfig <AmazonBedrockAgentConfig>
Amazon.PowerShell.Cmdlets.AAB.AmazonBedrockAgentClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CrawlerConfiguration_ExclusionFilter <String[]>
A list of one or more exclusion regular expression patterns to exclude certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataSourceConfiguration_WebConfiguration_CrawlerConfiguration_ExclusionFilters
-CrawlerConfiguration_InclusionFilter <String[]>
A list of one or more inclusion regular expression patterns to include certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataSourceConfiguration_WebConfiguration_CrawlerConfiguration_InclusionFilters
-CrawlerConfiguration_Scope <WebScopeType>
The scope of what is crawled for your URLs.You can choose to crawl only web pages that belong to the same host or primary domain. For example, only web pages that contain the seed URL "https://docs.aws.amazon.com/bedrock/latest/userguide/" and no other domains. You can choose to include sub domains in addition to the host or primary domain. For example, web pages that contain "aws.amazon.com" can also include sub domain "docs.aws.amazon.com".
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataSourceConfiguration_WebConfiguration_CrawlerConfiguration_Scope
-CrawlerLimits_RateLimit <Int32>
The max rate at which pages are crawled, up to 300 per minute per host.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataSourceConfiguration_WebConfiguration_CrawlerConfiguration_CrawlerLimits_RateLimit
-CustomTransformationConfiguration_Transformation <Transformation[]>
A Lambda function that processes documents.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesVectorIngestionConfiguration_CustomTransformationConfiguration_Transformations
-DataDeletionPolicy <DataDeletionPolicy>
The data deletion policy for the data source that you want to update.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DataSourceConfiguration_ConfluenceConfiguration_CrawlerConfiguration_FilterConfiguration_PatternObjectFilter_Filters <PatternObjectFilter[]>
The configuration of specific filters applied to your data source content. You can filter out or include certain content.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DataSourceConfiguration_ConfluenceConfiguration_CrawlerConfiguration_FilterConfiguration_Type <CrawlFilterConfigurationType>
The type of filtering that you want to apply to certain objects or content of the data source. For example, the PATTERN type is regular expression patterns you can apply to filter your content.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DataSourceConfiguration_ConfluenceConfiguration_SourceConfiguration_AuthType <ConfluenceAuthType>
The supported authentication type to authenticate and connect to your Confluence instance.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DataSourceConfiguration_ConfluenceConfiguration_SourceConfiguration_CredentialsSecretArn <String>
The Amazon Resource Name of an Secrets Manager secret that stores your authentication credentials for your Confluence instance URL. For more information on the key-value pairs that must be included in your secret, depending on your authentication type, see Confluence connection configuration.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DataSourceConfiguration_ConfluenceConfiguration_SourceConfiguration_HostType <ConfluenceHostType>
The supported host type, whether online/cloud or server/on-premises.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DataSourceConfiguration_ConfluenceConfiguration_SourceConfiguration_HostUrl <String>
The Confluence host URL or instance URL.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DataSourceConfiguration_SalesforceConfiguration_CrawlerConfiguration_FilterConfiguration_PatternObjectFilter_Filters <PatternObjectFilter[]>
The configuration of specific filters applied to your data source content. You can filter out or include certain content.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DataSourceConfiguration_SalesforceConfiguration_CrawlerConfiguration_FilterConfiguration_Type <CrawlFilterConfigurationType>
The type of filtering that you want to apply to certain objects or content of the data source. For example, the PATTERN type is regular expression patterns you can apply to filter your content.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DataSourceConfiguration_SalesforceConfiguration_SourceConfiguration_AuthType <SalesforceAuthType>
The supported authentication type to authenticate and connect to your Salesforce instance.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DataSourceConfiguration_SalesforceConfiguration_SourceConfiguration_CredentialsSecretArn <String>
The Amazon Resource Name of an Secrets Manager secret that stores your authentication credentials for your Salesforce instance URL. For more information on the key-value pairs that must be included in your secret, depending on your authentication type, see Salesforce connection configuration.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DataSourceConfiguration_SalesforceConfiguration_SourceConfiguration_HostUrl <String>
The Salesforce host URL or instance URL.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DataSourceConfiguration_SharePointConfiguration_CrawlerConfiguration_FilterConfiguration_PatternObjectFilter_Filters <PatternObjectFilter[]>
The configuration of specific filters applied to your data source content. You can filter out or include certain content.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DataSourceConfiguration_SharePointConfiguration_CrawlerConfiguration_FilterConfiguration_Type <CrawlFilterConfigurationType>
The type of filtering that you want to apply to certain objects or content of the data source. For example, the PATTERN type is regular expression patterns you can apply to filter your content.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DataSourceConfiguration_SharePointConfiguration_SourceConfiguration_AuthType <SharePointAuthType>
The supported authentication type to authenticate and connect to your SharePoint site/sites.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DataSourceConfiguration_SharePointConfiguration_SourceConfiguration_CredentialsSecretArn <String>
The Amazon Resource Name of an Secrets Manager secret that stores your authentication credentials for your SharePoint site/sites. For more information on the key-value pairs that must be included in your secret, depending on your authentication type, see SharePoint connection configuration.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DataSourceConfiguration_SharePointConfiguration_SourceConfiguration_HostType <SharePointHostType>
The supported host type, whether online/cloud or server/on-premises.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DataSourceConfiguration_Type <DataSourceType>
The type of data source.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-DataSourceId <String>
The unique identifier of the data source.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-Description <String>
Specifies a new description for the data source.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FixedSizeChunkingConfiguration_MaxToken <Int32>
The maximum number of tokens to include in a chunk.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesVectorIngestionConfiguration_ChunkingConfiguration_FixedSizeChunkingConfiguration_MaxTokens
-FixedSizeChunkingConfiguration_OverlapPercentage <Int32>
The percentage of overlap between adjacent chunks of a data source.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesVectorIngestionConfiguration_ChunkingConfiguration_FixedSizeChunkingConfiguration_OverlapPercentage
-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)
-HierarchicalChunkingConfiguration_LevelConfiguration <HierarchicalChunkingLevelConfiguration[]>
Token settings for each layer.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesVectorIngestionConfiguration_ChunkingConfiguration_HierarchicalChunkingConfiguration_LevelConfigurations
-HierarchicalChunkingConfiguration_OverlapToken <Int32>
The number of tokens to repeat across chunks in the same layer.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesVectorIngestionConfiguration_ChunkingConfiguration_HierarchicalChunkingConfiguration_OverlapTokens
-KnowledgeBaseId <String>
The unique identifier of the knowledge base for the data source.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Name <String>
Specifies a new name for the data source.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ParsingConfiguration_ParsingStrategy <ParsingStrategy>
The parsing strategy for the data source.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesVectorIngestionConfiguration_ParsingConfiguration_ParsingStrategy
-ParsingPrompt_ParsingPromptText <String>
Instructions for interpreting the contents of a document.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesVectorIngestionConfiguration_ParsingConfiguration_BedrockFoundationModelConfiguration_ParsingPrompt_ParsingPromptText
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the DataSourceId parameter. The -PassThru parameter is deprecated, use -Select '^DataSourceId' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-S3Configuration_BucketArn <String>
The Amazon Resource Name (ARN) of the S3 bucket that contains your data.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataSourceConfiguration_S3Configuration_BucketArn
-S3Configuration_BucketOwnerAccountId <String>
The account ID for the owner of the S3 bucket.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataSourceConfiguration_S3Configuration_BucketOwnerAccountId
-S3Configuration_InclusionPrefix <String[]>
A list of S3 prefixes to include certain files or content. For more information, see Organizing objects using prefixes.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataSourceConfiguration_S3Configuration_InclusionPrefixes
-S3Location_Uri <String>
The location's URI. For example, s3://my-bucket/chunk-processor/.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesVectorIngestionConfiguration_CustomTransformationConfiguration_IntermediateStorage_S3Location_Uri
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'DataSource'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgent.Model.UpdateDataSourceResponse). Specifying the name of a property of type Amazon.BedrockAgent.Model.UpdateDataSourceResponse 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)
-SemanticChunkingConfiguration_BreakpointPercentileThreshold <Int32>
The dissimilarity threshold for splitting chunks.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesVectorIngestionConfiguration_ChunkingConfiguration_SemanticChunkingConfiguration_BreakpointPercentileThreshold
-SemanticChunkingConfiguration_BufferSize <Int32>
The buffer size.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesVectorIngestionConfiguration_ChunkingConfiguration_SemanticChunkingConfiguration_BufferSize
-SemanticChunkingConfiguration_MaxToken <Int32>
The maximum number of tokens that a chunk can contain.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesVectorIngestionConfiguration_ChunkingConfiguration_SemanticChunkingConfiguration_MaxTokens
-ServerSideEncryptionConfiguration_KmsKeyArn <String>
The Amazon Resource Name (ARN) of the KMS key used to encrypt the resource.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SourceConfiguration_Domain <String>
The domain of your SharePoint instance or site URL/URLs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataSourceConfiguration_SharePointConfiguration_SourceConfiguration_Domain
-SourceConfiguration_SiteUrl <String[]>
A list of one or more SharePoint site URLs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataSourceConfiguration_SharePointConfiguration_SourceConfiguration_SiteUrls
-SourceConfiguration_TenantId <String>
The identifier of your Microsoft 365 tenant.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataSourceConfiguration_SharePointConfiguration_SourceConfiguration_TenantId
-UrlConfiguration_SeedUrl <SeedUrl[]>
One or more seed or starting point URLs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataSourceConfiguration_WebConfiguration_SourceConfiguration_UrlConfiguration_SeedUrls

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.DataSource or Amazon.BedrockAgent.Model.UpdateDataSourceResponse
This cmdlet returns an Amazon.BedrockAgent.Model.DataSource object. The service call response (type Amazon.BedrockAgent.Model.UpdateDataSourceResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
AWS Tools for PowerShell User Guide

Supported Version

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