/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::Kendra::BatchPutDocument

NAME

Paws::Kendra::BatchPutDocument - Arguments for method BatchPutDocument on Paws::Kendra

DESCRIPTION

This class represents the parameters used for calling the method BatchPutDocument on the AWSKendraFrontendService service. Use the attributes of this class as arguments to method BatchPutDocument.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to BatchPutDocument.

SYNOPSIS

my $kendra = Paws->service('Kendra');
my $BatchPutDocumentResponse = $kendra->BatchPutDocument(
  Documents => [
    {
      Id                => 'MyDocumentId',    # min: 1, max: 2048
      AccessControlList => [
        {
          Access => 'ALLOW',              # values: ALLOW, DENY
          Name   => 'MyPrincipalName',    # min: 1, max: 200
          Type   => 'USER',               # values: USER, GROUP

        },
        ...
      ],    # OPTIONAL
      Attributes => [
        {
          Key   => 'MyDocumentAttributeKey',    # min: 1, max: 200
          Value => {
            DateValue       => '1970-01-01T01:00:00',    # OPTIONAL
            LongValue       => 1,                        # OPTIONAL
            StringListValue => [
              'MyString', ...                            # min: 1, max: 2048
            ],    # OPTIONAL
            StringValue => 'MyDocumentAttributeStringValue'
            ,     # min: 1, max: 2048; OPTIONAL
          },

        },
        ...
      ],    # OPTIONAL
      Blob        => 'BlobBlob',    # OPTIONAL
      ContentType =>
        'PDF',    # values: PDF, HTML, MS_WORD, PLAIN_TEXT, PPT; OPTIONAL
      S3Path => {
        Bucket => 'MyS3BucketName',    # min: 3, max: 63
        Key    => 'MyS3ObjectKey',     # min: 1, max: 1024

      },    # OPTIONAL
      Title => 'MyTitle',    # OPTIONAL
    },
    ...
  ],
  IndexId => 'MyIndexId',
  RoleArn => 'MyRoleArn',    # OPTIONAL
);

# Results:
my $FailedDocuments = $BatchPutDocumentResponse->FailedDocuments;

# Returns a L<Paws::Kendra::BatchPutDocumentResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/kendra/BatchPutDocument

ATTRIBUTES

REQUIRED Documents => ArrayRef[Paws::Kendra::Document]

One or more documents to add to the index.

Documents can include custom attributes. For example, 'DataSourceId' and 'DataSourceSyncJobId' are custom attributes that provide information on the synchronization of documents running on a data source. Note, 'DataSourceSyncJobId' could be an optional custom attribute as Amazon Kendra will use the ID of a running sync job.

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 (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html).

REQUIRED IndexId => Str

The identifier of the index to add the documents to. You need to create the index first using the CreateIndex operation.

RoleArn => Str

The Amazon Resource Name (ARN) of a role that is allowed to run the BatchPutDocument operation. For more information, see IAM Roles for Amazon Kendra (https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html).

SEE ALSO

This class forms part of Paws, documenting arguments for method BatchPutDocument in Paws::Kendra

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues