NAME
Paws::Kendra::SortingConfiguration
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::SortingConfiguration object:
$service_obj->Method(Att1 => { DocumentAttributeKey => $value, ..., SortOrder => $value });Results returned from an API call
Use accessors for each attribute. If Att1 is expected to be an Paws::Kendra::SortingConfiguration object:
$result = $service_obj->Method(...);
$result->Att1->DocumentAttributeKeyDESCRIPTION
Specifies the document attribute to use to sort the response to a Amazon Kendra query. You can specify a single attribute for sorting. The attribute must have the Sortable flag set to true, otherwise Amazon Kendra returns an exception.
You can sort attributes of the following types.
Date value
Long value
String value
You can't sort attributes of the following type.
String list value
ATTRIBUTES
REQUIRED DocumentAttributeKey => Str
The name of the document attribute used to sort the response. You can use any field that has the Sortable flag set to true.
You can also sort by any of the following built-in attributes:
_category
_created_at
_last_updated_at
_version
_view_count
REQUIRED SortOrder => Str
The order that the results should be returned in. In case of ties, the relevance assigned to the result by Amazon Kendra is used as the tie-breaker.
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