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 Kendra BatchPutDocument API operation.

Syntax

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>

Description

Adds one or more documents to an index. The 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.

Parameters

-CustomDocumentEnrichmentConfiguration_InlineConfiguration <InlineCustomDocumentEnrichmentConfiguration[]>
Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Kendra.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCustomDocumentEnrichmentConfiguration_InlineConfigurations
-CustomDocumentEnrichmentConfiguration_PostExtractionHookConfiguration_InvocationCondition_ConditionDocumentAttributeKey <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 Kendra currently does not support _document_body as an attribute key used for the condition.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPostExtractionHookConfiguration_InvocationCondition_ConditionDocumentAttributeKey
-CustomDocumentEnrichmentConfiguration_PostExtractionHookConfiguration_InvocationCondition_ConditionOnValue_DateValue <DateTime>
A date expressed as an ISO 8601 string.It is 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)
AliasesPostExtractionHookConfiguration_InvocationCondition_ConditionOnValue_DateValue
-CustomDocumentEnrichmentConfiguration_PostExtractionHookConfiguration_InvocationCondition_ConditionOnValue_LongValue <Int64>
A long integer value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPostExtractionHookConfiguration_InvocationCondition_ConditionOnValue_LongValue
-CustomDocumentEnrichmentConfiguration_PostExtractionHookConfiguration_InvocationCondition_ConditionOnValue_StringListValue <String[]>
A list of strings.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPostExtractionHookConfiguration_InvocationCondition_ConditionOnValue_StringListValue
-CustomDocumentEnrichmentConfiguration_PostExtractionHookConfiguration_InvocationCondition_ConditionOnValue_StringValue <String>
A string, such as "department".
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPostExtractionHookConfiguration_InvocationCondition_ConditionOnValue_StringValue
-CustomDocumentEnrichmentConfiguration_PostExtractionHookConfiguration_InvocationCondition_Operator <ConditionOperator>
The condition operator.For example, you can use 'Contains' to partially match a string.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPostExtractionHookConfiguration_InvocationCondition_Operator
-CustomDocumentEnrichmentConfiguration_PreExtractionHookConfiguration_InvocationCondition_ConditionDocumentAttributeKey <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 Kendra currently does not support _document_body as an attribute key used for the condition.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPreExtractionHookConfiguration_InvocationCondition_ConditionDocumentAttributeKey
-CustomDocumentEnrichmentConfiguration_PreExtractionHookConfiguration_InvocationCondition_ConditionOnValue_DateValue <DateTime>
A date expressed as an ISO 8601 string.It is 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)
AliasesPreExtractionHookConfiguration_InvocationCondition_ConditionOnValue_DateValue
-CustomDocumentEnrichmentConfiguration_PreExtractionHookConfiguration_InvocationCondition_ConditionOnValue_LongValue <Int64>
A long integer value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPreExtractionHookConfiguration_InvocationCondition_ConditionOnValue_LongValue
-CustomDocumentEnrichmentConfiguration_PreExtractionHookConfiguration_InvocationCondition_ConditionOnValue_StringListValue <String[]>
A list of strings.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPreExtractionHookConfiguration_InvocationCondition_ConditionOnValue_StringListValue
-CustomDocumentEnrichmentConfiguration_PreExtractionHookConfiguration_InvocationCondition_ConditionOnValue_StringValue <String>
A string, such as "department".
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPreExtractionHookConfiguration_InvocationCondition_ConditionOnValue_StringValue
-CustomDocumentEnrichmentConfiguration_PreExtractionHookConfiguration_InvocationCondition_Operator <ConditionOperator>
The condition operator.For example, you can use 'Contains' to partially match a string.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPreExtractionHookConfiguration_InvocationCondition_Operator
-CustomDocumentEnrichmentConfiguration_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. For more information, see IAM roles for Amazon Kendra.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Document <Document[]>
One or more documents to add to the index.Documents have the following file size limits.
  • 5 MB total size for inline documents
  • 50 MB total size for files from an S3 bucket
  • 5 MB extracted text for any file
For more information about file size and transaction per second quotas, see Quotas.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDocuments
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)
-IndexId <String>
The identifier of the index to add the documents to. You need to create the index first using the CreateIndex API.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the IndexId parameter. The -PassThru parameter is deprecated, use -Select '^IndexId' 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 a role with permission to run a Lambda function during ingestion. For more information, see IAM roles for Amazon Kendra.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCustomDocumentEnrichmentConfiguration_PostExtractionHookConfiguration_LambdaArn
-PostExtractionHookConfiguration_S3Bucket <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)
AliasesCustomDocumentEnrichmentConfiguration_PostExtractionHookConfiguration_S3Bucket
-PreExtractionHookConfiguration_LambdaArn <String>
The Amazon Resource Name (ARN) of a role with permission to run a Lambda function during ingestion. For more information, see IAM roles for Amazon Kendra.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCustomDocumentEnrichmentConfiguration_PreExtractionHookConfiguration_LambdaArn
-PreExtractionHookConfiguration_S3Bucket <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)
AliasesCustomDocumentEnrichmentConfiguration_PreExtractionHookConfiguration_S3Bucket
-RoleArn <String>
The Amazon Resource Name (ARN) of a role that is allowed to run the BatchPutDocument API. For more information, see IAM Roles for Amazon Kendra.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'FailedDocuments'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Kendra.Model.BatchPutDocumentResponse). Specifying the name of a property of type Amazon.Kendra.Model.BatchPutDocumentResponse 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

This cmdlet returns a collection of Amazon.Kendra.Model.BatchPutDocumentResponseFailedDocument objects. The service call response (type Amazon.Kendra.Model.BatchPutDocumentResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Supported Version

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