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 QuickSight CreateKnowledgeBase API operation.

Syntax

New-QSKnowledgeBase
-MediaExtractionConfiguration_AudioExtractionConfiguration_AudioExtractionStatus <AudioExtractionStatus>
-AwsAccountId <String>
-DataSourceArn <String>
-Description <String>
-MediaExtractionConfiguration_ImageExtractionConfiguration_ImageExtractionStatus <ImageExtractionStatus>
-AccessControlConfiguration_IsACLEnabled <Boolean>
-KnowledgeBaseId <String>
-Name <String>
-Permission <ResourcePermission[]>
-PrimaryOwnerArn <String>
-Tag <Tag[]>
-KnowledgeBaseConfiguration_TemplateConfiguration_Template <PSObject>
-MediaExtractionConfiguration_VideoExtractionConfiguration_VideoExtractionStatus <VideoExtractionStatus>
-MediaExtractionConfiguration_VideoExtractionConfiguration_VideoExtractionType <VideoExtractionType>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonQuickSightConfig>

Description

Creates a knowledge base from a specified data source. Supported data source connector types include:
  • S3_KNOWLEDGE_BASE – Uses an Amazon S3 bucket as the data source.
  • WEB_CRAWLER – Uses web pages indexed by the built-in web crawler as the data source.
  • GOOGLE_DRIVE – Uses Google Drive as the data source. Supports service account authentication only.
  • SHAREPOINT – Uses SharePoint as the data source. Supports two-legged OAuth only.
  • ONE_DRIVE – Uses OneDrive as the data source. Supports two-legged OAuth only.

Parameters

-AccessControlConfiguration_IsACLEnabled <Boolean>
Specifies whether ACLs are enabled for the knowledge base.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AwsAccountId <String>
The ID of the Amazon Web Services account that contains the knowledge base.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonQuickSightConfig>
Amazon.PowerShell.Cmdlets.QS.AmazonQuickSightClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DataSourceArn <String>
The Amazon Resource Name (ARN) of the data source for the knowledge base.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Description <String>
A description for the knowledge base. If you don't specify a description, the knowledge base is created without one.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-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)
-KnowledgeBaseConfiguration_TemplateConfiguration_Template <PSObject>
The connector configuration for the knowledge base data source. The structure depends on the connector type of the data source referenced by DataSourceArn.The template must be a JSON object. The required fields vary by connector type:
  • Amazon S3 (S3V2) – Requires connectionConfiguration with bucketName. Supports filterConfiguration for inclusion and exclusion prefixes and patterns. Supports accessControlConfiguration and deletionProtectionConfiguration.
  • Google Drive (GOOGLEDRIVEV3) – Requires connectionConfiguration with authType set to SERVICE_ACCOUNT. Supports dataEntityConfiguration with crawlMyDrive, crawlSharedWithMe, and crawlSharedDrives.
  • OneDrive (ONEDRIVEV3) – Requires authType at the template root level set to TWO_LEGGED_OAUTH. Requires connectionConfiguration with tenantId in UUID format. Supports dataEntityConfiguration with crawlPersonalDrives and crawlSharedWithMe.
  • SharePoint (SHAREPOINTV3) – Requires connectionConfiguration with tenantId in UUID format. Supports dataEntityConfiguration with siteUrls, crawlFiles, and crawlPages.
  • Web Crawler (WEBCRAWLERV3) – Requires connectionConfiguration with seedUrls or siteMapUrls (mutually exclusive) and authType. Supports crawlConfiguration for crawl depth, rate limits, and scope. Supports filterConfiguration for file size limits and URL patterns. Valid values for authType: NO_AUTH, BASIC_AUTH, FORM, SAML.
The optional deletionProtectionConfiguration object is supported by all connector types. It contains enableDeletionProtection and deletionProtectionThreshold.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-KnowledgeBaseId <String>
The unique identifier for the knowledge base.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-MediaExtractionConfiguration_AudioExtractionConfiguration_AudioExtractionStatus <AudioExtractionStatus>
The status of audio extraction. Valid values are ENABLED and DISABLED.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MediaExtractionConfiguration_ImageExtractionConfiguration_ImageExtractionStatus <ImageExtractionStatus>
The status of image extraction. Valid values are ENABLED and DISABLED.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MediaExtractionConfiguration_VideoExtractionConfiguration_VideoExtractionStatus <VideoExtractionStatus>
The status of video extraction. Valid values are ENABLED and DISABLED.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MediaExtractionConfiguration_VideoExtractionConfiguration_VideoExtractionType <VideoExtractionType>
The type of video extraction to perform.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Name <String>
The name of the knowledge base.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Permission <ResourcePermission[]>
A list of resource permissions on the knowledge base. Each entry grants a specified Amazon QuickSight principal either owner or viewer access. If you don't specify permissions, only the primary owner (if provided) receives owner access. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPermissions
-PrimaryOwnerArn <String>
The Amazon Resource Name (ARN) of the primary owner for the knowledge base. The specified user is always granted owner access, regardless of what is specified in the Permissions field. If you don't specify a primary owner, the knowledge base is created without one.
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.QuickSight.Model.CreateKnowledgeBaseResponse). Specifying the name of a property of type Amazon.QuickSight.Model.CreateKnowledgeBaseResponse 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)
-Tag <Tag[]>
The tags to assign to the knowledge base. If you don't specify tags, the knowledge base is created without tags. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags

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.QuickSight.Model.CreateKnowledgeBaseResponse
This cmdlet returns an Amazon.QuickSight.Model.CreateKnowledgeBaseResponse object containing multiple properties.
User Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

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