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

NAME

Paws::Kendra::S3DataSourceConfiguration

USAGE

This class represents one of two things:

Arguments in a call to a service

Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.

As an example, if Att1 is expected to be a Paws::Kendra::S3DataSourceConfiguration object:

$service_obj->Method(Att1 => { AccessControlListConfiguration => $value, ..., InclusionPrefixes => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::Kendra::S3DataSourceConfiguration object:

$result = $service_obj->Method(...);
$result->Att1->AccessControlListConfiguration

DESCRIPTION

Provides configuration information for a data source to index documents in an Amazon S3 bucket.

ATTRIBUTES

AccessControlListConfiguration => Paws::Kendra::AccessControlListConfiguration

Provides the path to the S3 bucket that contains the user context filtering files for the data source. For the format of the file, see Access control for S3 data sources (https://docs.aws.amazon.com/kendra/latest/dg/s3-acl.html).

REQUIRED BucketName => Str

The name of the bucket that contains the documents.

DocumentsMetadataConfiguration => Paws::Kendra::DocumentsMetadataConfiguration

ExclusionPatterns => ArrayRef[Str|Undef]

A list of glob patterns for documents that should not be indexed. If a document that matches an inclusion prefix or inclusion pattern also matches an exclusion pattern, the document is not indexed.

Some examples (https://docs.aws.amazon.com/cli/latest/reference/s3/#use-of-exclude-and-include-filters) are:

  • *.png , *.jpg will exclude all PNG and JPEG image files in a directory (files with the extensions .png and .jpg).

  • *internal* will exclude all files in a directory that contain 'internal' in the file name, such as 'internal', 'internal_only', 'company_internal'.

  • **/*internal* will exclude all internal-related files in a directory and its subdirectories.

InclusionPatterns => ArrayRef[Str|Undef]

A list of glob patterns for documents that should be indexed. If a document that matches an inclusion pattern also matches an exclusion pattern, the document is not indexed.

Some examples (https://docs.aws.amazon.com/cli/latest/reference/s3/#use-of-exclude-and-include-filters) are:

  • *.txt will include all text files in a directory (files with the extension .txt).

  • **/*.txt will include all text files in a directory and its subdirectories.

  • *tax* will include all files in a directory that contain 'tax' in the file name, such as 'tax', 'taxes', 'income_tax'.

InclusionPrefixes => ArrayRef[Str|Undef]

A list of S3 prefixes for the documents that should be included in the index.

SEE ALSO

This class forms part of Paws, describing an object used 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