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.
Write-KNDRDocumentBatch-IndexId <String>-CustomDocumentEnrichmentConfiguration_PostExtractionHookConfiguration_InvocationCondition_ConditionDocumentAttributeKey <String>-CustomDocumentEnrichmentConfiguration_PreExtractionHookConfiguration_InvocationCondition_ConditionDocumentAttributeKey <String>-CustomDocumentEnrichmentConfiguration_PostExtractionHookConfiguration_InvocationCondition_ConditionOnValue_DateValue <DateTime>-CustomDocumentEnrichmentConfiguration_PreExtractionHookConfiguration_InvocationCondition_ConditionOnValue_DateValue <DateTime>-Document <Document[]>-CustomDocumentEnrichmentConfiguration_InlineConfiguration <InlineCustomDocumentEnrichmentConfiguration[]>-PostExtractionHookConfiguration_LambdaArn <String>-PreExtractionHookConfiguration_LambdaArn <String>-CustomDocumentEnrichmentConfiguration_PostExtractionHookConfiguration_InvocationCondition_ConditionOnValue_LongValue <Int64>-CustomDocumentEnrichmentConfiguration_PreExtractionHookConfiguration_InvocationCondition_ConditionOnValue_LongValue <Int64>-CustomDocumentEnrichmentConfiguration_PostExtractionHookConfiguration_InvocationCondition_Operator <ConditionOperator>-CustomDocumentEnrichmentConfiguration_PreExtractionHookConfiguration_InvocationCondition_Operator <ConditionOperator>-CustomDocumentEnrichmentConfiguration_RoleArn <String>-RoleArn <String>-PostExtractionHookConfiguration_S3Bucket <String>-PreExtractionHookConfiguration_S3Bucket <String>-CustomDocumentEnrichmentConfiguration_PostExtractionHookConfiguration_InvocationCondition_ConditionOnValue_StringListValue <String[]>-CustomDocumentEnrichmentConfiguration_PreExtractionHookConfiguration_InvocationCondition_ConditionOnValue_StringListValue <String[]>-CustomDocumentEnrichmentConfiguration_PostExtractionHookConfiguration_InvocationCondition_ConditionOnValue_StringValue <String>-CustomDocumentEnrichmentConfiguration_PreExtractionHookConfiguration_InvocationCondition_ConditionOnValue_StringValue <String>-Select <String>-PassThru <SwitchParameter>-Force <SwitchParameter>
BatchPutDocument
API enables you to ingest inline documents or a set of documents stored in an Amazon S3 bucket. Use this API to ingest your text and unstructured text into an index, add custom attributes to the documents, and to attach an access control list to the documents added to the index.
The documents are indexed asynchronously. You can see the progress of the batch using Amazon Web Services CloudWatch. Any error messages related to processing the batch are sent to your Amazon Web Services CloudWatch log.
For an example of ingesting inline documents using Python and Java SDKs, see Adding files directly to an index. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | CustomDocumentEnrichmentConfiguration_InlineConfigurations |
_document_body
as an attribute key used for the condition. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | PostExtractionHookConfiguration_InvocationCondition_ConditionDocumentAttributeKey |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | PostExtractionHookConfiguration_InvocationCondition_ConditionOnValue_DateValue |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | PostExtractionHookConfiguration_InvocationCondition_ConditionOnValue_LongValue |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | PostExtractionHookConfiguration_InvocationCondition_ConditionOnValue_StringListValue |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | PostExtractionHookConfiguration_InvocationCondition_ConditionOnValue_StringValue |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | PostExtractionHookConfiguration_InvocationCondition_Operator |
_document_body
as an attribute key used for the condition. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | PreExtractionHookConfiguration_InvocationCondition_ConditionDocumentAttributeKey |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | PreExtractionHookConfiguration_InvocationCondition_ConditionOnValue_DateValue |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | PreExtractionHookConfiguration_InvocationCondition_ConditionOnValue_LongValue |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | PreExtractionHookConfiguration_InvocationCondition_ConditionOnValue_StringListValue |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | PreExtractionHookConfiguration_InvocationCondition_ConditionOnValue_StringValue |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | PreExtractionHookConfiguration_InvocationCondition_Operator |
PreExtractionHookConfiguration
and PostExtractionHookConfiguration
for altering document metadata and content during the document ingestion process. For more information, see IAM roles for Amazon Kendra. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | True |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | Documents |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
CreateIndex
API. Required? | True |
Position? | 1 |
Accept pipeline input? | True (ByValue, ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | CustomDocumentEnrichmentConfiguration_PostExtractionHookConfiguration_LambdaArn |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | CustomDocumentEnrichmentConfiguration_PostExtractionHookConfiguration_S3Bucket |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | CustomDocumentEnrichmentConfiguration_PreExtractionHookConfiguration_LambdaArn |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | CustomDocumentEnrichmentConfiguration_PreExtractionHookConfiguration_S3Bucket |
BatchPutDocument
API. For more information, see IAM Roles for Amazon Kendra. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | AK |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByValue, ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByValue, ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | AWSProfilesLocation, ProfilesLocation |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | StoredCredentials, AWSProfileName |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | RegionToCall |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | SK, SecretAccessKey |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ST |
AWS Tools for PowerShell: 2.x.y.z