DocumentAttributeValueCountPair

PDF

Provides the count of documents that match a particular document attribute or field when doing a faceted search.

Contents

Count

The number of documents in the response that have the attribute/field value for the key.

Type: Integer

Required: No

DocumentAttributeValue

The value of the attribute/field. For example, "HR".

Type: DocumentAttributeValue object

Required: No

FacetResults

Contains the results of a document attribute/field that is a nested facet. A FacetResult contains the counts for each facet nested within a facet.

For example, the document attribute or facet "Department" includes a value called "Engineering". In addition, the document attribute or facet "SubDepartment" includes the values "Frontend" and "Backend" for documents assigned to "Engineering". You can display nested facets in the search results so that documents can be searched not only by department but also by a sub department within a department. The counts for documents that belong to "Frontend" and "Backend" within "Engineering" are returned for a query.

Type: Array of FacetResult objects

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Java V2

• AWS SDK for Ruby V3