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 Amazon QBusiness CreateDataSource API operation.

Syntax

New-QBUSDataSource
-ApplicationId <String>
-AudioExtractionConfiguration_AudioExtractionStatus <AudioExtractionStatus>
-Configuration <PSObject>
-DocumentEnrichmentConfiguration_PostInvocationCondition_DateValue <DateTime>
-DocumentEnrichmentConfiguration_PreInvocationCondition_DateValue <DateTime>
-Description <String>
-DisplayName <String>
-ImageExtractionConfiguration_ImageExtractionStatus <ImageExtractionStatus>
-IndexId <String>
-DocumentEnrichmentConfiguration_InlineConfiguration <InlineDocumentEnrichmentConfiguration[]>
-DocumentEnrichmentConfiguration_PostInvocationCondition_Key <String>
-DocumentEnrichmentConfiguration_PreInvocationCondition_Key <String>
-PostExtractionHookConfiguration_LambdaArn <String>
-PreExtractionHookConfiguration_LambdaArn <String>
-DocumentEnrichmentConfiguration_PostInvocationCondition_LongValue <Int64>
-DocumentEnrichmentConfiguration_PreInvocationCondition_LongValue <Int64>
-DocumentEnrichmentConfiguration_PostInvocationCondition_Operator <DocumentEnrichmentConditionOperator>
-DocumentEnrichmentConfiguration_PreInvocationCondition_Operator <DocumentEnrichmentConditionOperator>
-PostExtractionHookConfiguration_RoleArn <String>
-PreExtractionHookConfiguration_RoleArn <String>
-RoleArn <String>
-PostExtractionHookConfiguration_S3BucketName <String>
-PreExtractionHookConfiguration_S3BucketName <String>
-VpcConfiguration_SecurityGroupId <String[]>
-DocumentEnrichmentConfiguration_PostInvocationCondition_StringListValue <String[]>
-DocumentEnrichmentConfiguration_PreInvocationCondition_StringListValue <String[]>
-DocumentEnrichmentConfiguration_PostInvocationCondition_StringValue <String>
-DocumentEnrichmentConfiguration_PreInvocationCondition_StringValue <String>
-VpcConfiguration_SubnetId <String[]>
-SyncSchedule <String>
-Tag <Tag[]>
-VideoExtractionConfiguration_VideoExtractionStatus <VideoExtractionStatus>
-ClientToken <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonQBusinessConfig>

Description

Creates a data source connector for an Amazon Q Business application. CreateDataSource is a synchronous operation. The operation returns 200 if the data source was successfully created. Otherwise, an exception is raised.

Parameters

-ApplicationId <String>
The identifier of the Amazon Q Business application the data source will be attached to.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-AudioExtractionConfiguration_AudioExtractionStatus <AudioExtractionStatus>
The status of audio extraction (ENABLED or DISABLED) for processing audio content from files.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMediaExtractionConfiguration_AudioExtractionConfiguration_AudioExtractionStatus
-ClientConfig <AmazonQBusinessConfig>
Amazon.PowerShell.Cmdlets.QBUS.AmazonQBusinessClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientToken <String>
A token you provide to identify a request to create a data source connector. Multiple calls to the CreateDataSource API with the same client token will create only one data source connector.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Configuration <PSObject>
Configuration information to connect your data source repository to Amazon Q Business. Use this parameter to provide a JSON schema with configuration information specific to your data source connector.Each data source has a JSON schema provided by Amazon Q Business that you must use. For example, the Amazon S3 and Web Crawler connectors require the following JSON schemas:You can find configuration templates for your specific data source using the following steps:
  1. Navigate to the Supported connectors page in the Amazon Q Business User Guide, and select the data source of your choice.
  2. Then, from your specific data source connector page, select Using the API. You will find the JSON schema for your data source, including parameter descriptions, in this section.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Description <String>
A description for the data source connector.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DisplayName <String>
A name for the data source connector.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-DocumentEnrichmentConfiguration_InlineConfiguration <InlineDocumentEnrichmentConfiguration[]>
Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Q Business.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDocumentEnrichmentConfiguration_InlineConfigurations
-DocumentEnrichmentConfiguration_PostInvocationCondition_DateValue <DateTime>
A date expressed as an ISO 8601 string.It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDocumentEnrichmentConfiguration_PostExtractionHookConfiguration_InvocationCondition_Value_DateValue
-DocumentEnrichmentConfiguration_PostInvocationCondition_Key <String>
The identifier of the document attribute used for the condition.For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.Amazon Q Business currently doesn't support _document_body as an attribute key used for the condition.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDocumentEnrichmentConfiguration_PostExtractionHookConfiguration_InvocationCondition_Key
-DocumentEnrichmentConfiguration_PostInvocationCondition_LongValue <Int64>
A long integer value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDocumentEnrichmentConfiguration_PostExtractionHookConfiguration_InvocationCondition_Value_LongValue
-DocumentEnrichmentConfiguration_PostInvocationCondition_Operator <DocumentEnrichmentConditionOperator>
The identifier of the document attribute used for the condition.For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.Amazon Q Business currently does not support _document_body as an attribute key used for the condition.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDocumentEnrichmentConfiguration_PostExtractionHookConfiguration_InvocationCondition_Operator
-DocumentEnrichmentConfiguration_PostInvocationCondition_StringListValue <String[]>
A list of strings.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDocumentEnrichmentConfiguration_PostExtractionHookConfiguration_InvocationCondition_Value_StringListValue
-DocumentEnrichmentConfiguration_PostInvocationCondition_StringValue <String>
A string.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDocumentEnrichmentConfiguration_PostExtractionHookConfiguration_InvocationCondition_Value_StringValue
-DocumentEnrichmentConfiguration_PreInvocationCondition_DateValue <DateTime>
A date expressed as an ISO 8601 string.It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDocumentEnrichmentConfiguration_PreExtractionHookConfiguration_InvocationCondition_Value_DateValue
-DocumentEnrichmentConfiguration_PreInvocationCondition_Key <String>
The identifier of the document attribute used for the condition.For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.Amazon Q Business currently doesn't support _document_body as an attribute key used for the condition.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDocumentEnrichmentConfiguration_PreExtractionHookConfiguration_InvocationCondition_Key
-DocumentEnrichmentConfiguration_PreInvocationCondition_LongValue <Int64>
A long integer value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDocumentEnrichmentConfiguration_PreExtractionHookConfiguration_InvocationCondition_Value_LongValue
-DocumentEnrichmentConfiguration_PreInvocationCondition_Operator <DocumentEnrichmentConditionOperator>
The identifier of the document attribute used for the condition.For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.Amazon Q Business currently does not support _document_body as an attribute key used for the condition.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDocumentEnrichmentConfiguration_PreExtractionHookConfiguration_InvocationCondition_Operator
-DocumentEnrichmentConfiguration_PreInvocationCondition_StringListValue <String[]>
A list of strings.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDocumentEnrichmentConfiguration_PreExtractionHookConfiguration_InvocationCondition_Value_StringListValue
-DocumentEnrichmentConfiguration_PreInvocationCondition_StringValue <String>
A string.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDocumentEnrichmentConfiguration_PreExtractionHookConfiguration_InvocationCondition_Value_StringValue
-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)
-ImageExtractionConfiguration_ImageExtractionStatus <ImageExtractionStatus>
Specify whether to extract semantic meaning from images and visuals from documents.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMediaExtractionConfiguration_ImageExtractionConfiguration_ImageExtractionStatus
-IndexId <String>
The identifier of the index that you want to use with the data source connector.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the ApplicationId parameter. The -PassThru parameter is deprecated, use -Select '^ApplicationId' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PostExtractionHookConfiguration_LambdaArn <String>
The Amazon Resource Name (ARN) of the Lambda function sduring ingestion. For more information, see Using Lambda functions for Amazon Q Business document enrichment.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDocumentEnrichmentConfiguration_PostExtractionHookConfiguration_LambdaArn
-PostExtractionHookConfiguration_RoleArn <String>
The Amazon Resource Name (ARN) of a role with permission to run PreExtractionHookConfiguration and PostExtractionHookConfiguration for altering document metadata and content during the document ingestion process.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDocumentEnrichmentConfiguration_PostExtractionHookConfiguration_RoleArn
-PostExtractionHookConfiguration_S3BucketName <String>
Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see Data contracts for Lambda functions.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDocumentEnrichmentConfiguration_PostExtractionHookConfiguration_S3BucketName
-PreExtractionHookConfiguration_LambdaArn <String>
The Amazon Resource Name (ARN) of the Lambda function sduring ingestion. For more information, see Using Lambda functions for Amazon Q Business document enrichment.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDocumentEnrichmentConfiguration_PreExtractionHookConfiguration_LambdaArn
-PreExtractionHookConfiguration_RoleArn <String>
The Amazon Resource Name (ARN) of a role with permission to run PreExtractionHookConfiguration and PostExtractionHookConfiguration for altering document metadata and content during the document ingestion process.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDocumentEnrichmentConfiguration_PreExtractionHookConfiguration_RoleArn
-PreExtractionHookConfiguration_S3BucketName <String>
Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see Data contracts for Lambda functions.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDocumentEnrichmentConfiguration_PreExtractionHookConfiguration_S3BucketName
-RoleArn <String>
The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QBusiness.Model.CreateDataSourceResponse). Specifying the name of a property of type Amazon.QBusiness.Model.CreateDataSourceResponse 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)
-SyncSchedule <String>
Sets the frequency for Amazon Q Business to check the documents in your data source repository and update your index. If you don't set a schedule, Amazon Q Business won't periodically update the index.Specify a cron- format schedule string or an empty string to indicate that the index is updated on demand. You can't specify the Schedule parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Tag[]>
A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-VideoExtractionConfiguration_VideoExtractionStatus <VideoExtractionStatus>
The status of video extraction (ENABLED or DISABLED) for processing video content from files.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMediaExtractionConfiguration_VideoExtractionConfiguration_VideoExtractionStatus
-VpcConfiguration_SecurityGroupId <String[]>
A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Q Business to connect to the data source.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesVpcConfiguration_SecurityGroupIds
-VpcConfiguration_SubnetId <String[]>
A list of identifiers for subnets within your Amazon VPC. The subnets should be able to connect to each other in the VPC, and they should have outgoing access to the Internet through a NAT device.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesVpcConfiguration_SubnetIds

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.QBusiness.Model.CreateDataSourceResponse
This cmdlet returns an Amazon.QBusiness.Model.CreateDataSourceResponse object containing multiple properties.
AWS Tools for PowerShell User Guide

Supported Version

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