NAME
Paws::Kendra::Document
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::Document object:
$service_obj->Method(Att1 => { AccessControlList => $value, ..., Title => $value });
Results returned from an API call
Use accessors for each attribute. If Att1 is expected to be an Paws::Kendra::Document object:
$result = $service_obj->Method(...);
$result->Att1->AccessControlList
DESCRIPTION
A document in an index.
ATTRIBUTES
AccessControlList => ArrayRef[Paws::Kendra::Principal]
Information to use for user context filtering.
Attributes => ArrayRef[Paws::Kendra::DocumentAttribute]
Custom attributes to apply to the document. Use the custom attributes to provide additional information for searching, to provide facets for refining searches, and to provide additional information in the query response.
Blob => Str
The contents of the document.
Documents passed to the Blob
parameter must be base64 encoded. Your code might not need to encode the document file bytes if you're using an AWS SDK to call Amazon Kendra operations. If you are calling the Amazon Kendra endpoint directly using REST, you must base64 encode the contents before sending.
ContentType => Str
The file type of the document in the Blob
field.
REQUIRED Id => Str
A unique identifier of the document in the index.
S3Path => Paws::Kendra::S3Path
Title => Str
The title of the document.
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