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

Syntax

Update-QSKnowledgeBase
-MediaExtractionConfiguration_AudioExtractionConfiguration_AudioExtractionStatus <AudioExtractionStatus>
-AwsAccountId <String>
-Description <String>
-MediaExtractionConfiguration_ImageExtractionConfiguration_ImageExtractionStatus <ImageExtractionStatus>
-AccessControlConfiguration_IsACLEnabled <Boolean>
-IsEmailNotificationOptedForIngestionFailure <Boolean>
-KnowledgeBaseId <String>
-Name <String>
-KnowledgeBaseConfiguration_TemplateConfiguration_Template <PSObject>
-MediaExtractionConfiguration_VideoExtractionConfiguration_VideoExtractionStatus <VideoExtractionStatus>
-MediaExtractionConfiguration_VideoExtractionConfiguration_VideoExtractionType <VideoExtractionType>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonQuickSightConfig>

Description

Updates the properties of an existing knowledge base.

Parameters

-AccessControlConfiguration_IsACLEnabled <Boolean>
Specifies whether ACLs are enabled for the knowledge base.This setting works together with the data source connector's ACL crawling. To enforce document-level access control end to end, set isACLEnabled to true and enable ACL crawling on the connector. For example, for an Amazon S3 data source, set accessControlConfiguration.crawlAcl to true in the connector template. For more information, see KbTemplateConfiguration. Enabling only one of the two settings does not produce a fully ACL-enforced 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)
-Description <String>
A description for the knowledge base. If you don't specify a description, the existing description is retained.
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)
-IsEmailNotificationOptedForIngestionFailure <Boolean>
Specifies whether email notifications are enabled for ingestion failures.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesIsEmailNotificationOptedForIngestionFailures
-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. All connector types share the following top-level keys. The value of type and the contents of connectionConfiguration vary by connector type.
  • type – (Required) The connector type of the data source. This value identifies the connector. Valid values: S3V2, WEBCRAWLERV3, GOOGLEDRIVEV3, ONEDRIVEV3, SHAREPOINTV3. For the fields required by each connector, see the connector-specific list that follows.
  • connectionConfiguration – (Required) The connection details for the data source. The keys in this object vary by connector type; see the connector-specific list that follows.
  • filterConfiguration – (Optional) Rules that determine which content is crawled, such as inclusion and exclusion prefixes, patterns, or file-size limits.
  • accessControlConfiguration – (Optional) Document-level access control (ACL) settings. Supported by all connector types except Web Crawler (WEBCRAWLERV3). The available fields depend on the connector type.
  • deletionProtectionConfiguration – (Optional) Deletion-protection settings, supported by all connector types. Contains enableDeletionProtection (Boolean) and deletionProtectionThreshold (String; a value from 1 to 100).
The following list describes the valid type value, the connectionConfiguration contents, and any connector-specific fields for each connector type:
  • Amazon S3 (type: S3V2) – The type value must be S3V2. connectionConfiguration is required and contains:
    • bucketName – (Required) The name of the Amazon S3 bucket to crawl. Type: String. Length: 3–63 characters. Pattern: ^[a-z0-9][.\-a-z0-9]{1,61}[a-z0-9]$.
    • bucketOwnerAccountId – (Required) The ID of the AWS account that owns the bucket. Type: String. Pattern: ^\d{12}$.
    Amazon S3 supports the following optional filterConfiguration fields:
    • inclusionPrefixes or exclusionPrefixes – Amazon S3 key prefixes to include or exclude. Type: Array of String. Up to 350 items, each 1–1,024 characters.
    • inclusionPatterns or exclusionPatterns – Patterns to include or exclude objects. Type: Array of String. Up to 350 items, each 1–1,024 characters.
    • maxFileSizeInMegaBytes – The maximum size, in MB, of a file to ingest. Type: String. Pattern: ^\d+$.
    For Amazon S3, accessControlConfiguration supports the following fields:
    • crawlAcl – Specifies whether the connector crawls and enforces document access control lists (ACLs). Type: Boolean. When set to true, provide ACLs either in a global ACL configuration file (aclConfigurationFilePath) or in per-document metadata files.
    • aclConfigurationFilePath – The Amazon S3 URI of the global ACL configuration file. Type: String. Length: 1–1,024 characters. Optional. If you don't provide a global ACL configuration file, define ACLs in per-document metadata files.
    • defaultAccessType – The access behavior applied to Amazon S3 prefixes that are not listed in the ACL configuration. Type: String. The only supported value is ALLOW.
    metadataFilesPrefix – (Optional) The Amazon S3 prefix under which per-document metadata files are stored. Each metadata file describes a single source document and its indexable attributes. This is not the global ACL configuration file. For a single global ACL file, use accessControlConfiguration.aclConfigurationFilePath. Type: String. Length: 1–1,024 characters.
  • Google Drive (type: GOOGLEDRIVEV3) – Requires connectionConfiguration with authType set to SERVICE_ACCOUNT. Supports dataEntityConfiguration with crawlMyDrive, crawlSharedWithMe, and crawlSharedDrives.
  • OneDrive (type: 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 (type: SHAREPOINTV3) – Requires connectionConfiguration with tenantId in UUID format. Supports dataEntityConfiguration with siteUrls, crawlFiles, and crawlPages.
  • Web Crawler (type: 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.
Enabling document-level access control for Amazon S3For an Amazon S3 (S3V2) knowledge base, document-level access control is governed by two settings that must both be enabled:
  1. In this template, set accessControlConfiguration.crawlAcl to true. Define ACLs either in a global ACL configuration file, referenced by accessControlConfiguration.aclConfigurationFilePath, or in per-document metadata files. To control access for prefixes that are not listed in the ACL file, you can also set accessControlConfiguration.defaultAccessType.
  2. In the CreateKnowledgeBase or UpdateKnowledgeBase request, set the top-level AccessControlConfiguration.isACLEnabled to true.
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. If you don't specify a name, the existing name is retained.
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.UpdateKnowledgeBaseResponse). Specifying the name of a property of type Amazon.QuickSight.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)

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.UpdateKnowledgeBaseResponse
This cmdlet returns an Amazon.QuickSight.Model.UpdateKnowledgeBaseResponse 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