|
|
@@ -3454,7 +3454,7 @@
|
|
|
"documentation":"<p>The value of the attribute.</p>"
|
|
|
}
|
|
|
},
|
|
|
- "documentation":"<p>A custom attribute value assigned to a document.</p> <p>For more information on how to create custom document attributes, see <a href=\"https://docs.aws.amazon.com/kendra/latest/dg/custom-attributes.html\">Custom Attributes</a>.</p>"
|
|
|
+ "documentation":"<p>A document attribute or metadata field. To create custom document attributes, see <a href=\"https://docs.aws.amazon.com/kendra/latest/dg/custom-attributes.html\">Custom attributes</a>.</p>"
|
|
|
},
|
|
|
"DocumentAttributeCondition":{
|
|
|
"type":"structure",
|
|
|
@@ -3541,18 +3541,22 @@
|
|
|
"documentation":"<p>A date expressed as an ISO 8601 string.</p> <p>It is important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.</p>"
|
|
|
}
|
|
|
},
|
|
|
- "documentation":"<p>The value of a custom document attribute. You can only provide one value for a custom attribute.</p>"
|
|
|
+ "documentation":"<p>The value of a document attribute. You can only provide one value for a document attribute.</p>"
|
|
|
},
|
|
|
"DocumentAttributeValueCountPair":{
|
|
|
"type":"structure",
|
|
|
"members":{
|
|
|
"DocumentAttributeValue":{
|
|
|
"shape":"DocumentAttributeValue",
|
|
|
- "documentation":"<p>The value of the attribute. For example, \"HR.\"</p>"
|
|
|
+ "documentation":"<p>The value of the attribute. For example, \"HR\".</p>"
|
|
|
},
|
|
|
"Count":{
|
|
|
"shape":"Integer",
|
|
|
"documentation":"<p>The number of documents in the response that have the attribute value for the key.</p>"
|
|
|
+ },
|
|
|
+ "FacetResults":{
|
|
|
+ "shape":"FacetResultList",
|
|
|
+ "documentation":"<p>Contains the results of a document attribute that is a nested facet. A <code>FacetResult</code> contains the counts for each facet nested within a facet.</p> <p>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.</p>"
|
|
|
}
|
|
|
},
|
|
|
"documentation":"<p>Provides the count of documents that match a particular attribute when doing a faceted search.</p>"
|
|
|
@@ -3951,9 +3955,17 @@
|
|
|
"DocumentAttributeKey":{
|
|
|
"shape":"DocumentAttributeKey",
|
|
|
"documentation":"<p>The unique key for the document attribute.</p>"
|
|
|
+ },
|
|
|
+ "Facets":{
|
|
|
+ "shape":"FacetList",
|
|
|
+ "documentation":"<p>An array of document attributes that are nested facets within a facet.</p> <p>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. This helps your users further narrow their search.</p> <p>You can only have one nested facet within a facet. If you want to increase this limit, contact <a href=\"http://aws.amazon.com/contact-us/\">Support</a>.</p>"
|
|
|
+ },
|
|
|
+ "MaxResults":{
|
|
|
+ "shape":"TopDocumentAttributeValueCountPairsSize",
|
|
|
+ "documentation":"<p>Maximum number of facet values per facet. The default is 10. You can use this to limit the number of facet values to less than 10. If you want to increase the default, contact <a href=\"http://aws.amazon.com/contact-us/\">Support</a>.</p>"
|
|
|
}
|
|
|
},
|
|
|
- "documentation":"<p>Information about a document attribute</p>"
|
|
|
+ "documentation":"<p>Information about a document attribute. You can use document attributes as facets.</p> <p>For example, the document attribute or facet \"Department\" includes the values \"HR\", \"Engineering\", and \"Accounting\". You can display these values in the search results so that documents can be searched by department.</p> <p>You can display up to 10 facet values per facet for a query. If you want to increase this limit, contact <a href=\"http://aws.amazon.com/contact-us/\">Support</a>.</p>"
|
|
|
},
|
|
|
"FacetList":{
|
|
|
"type":"list",
|
|
|
@@ -5487,11 +5499,11 @@
|
|
|
},
|
|
|
"Facets":{
|
|
|
"shape":"FacetList",
|
|
|
- "documentation":"<p>An array of documents attributes. Amazon Kendra returns a count for each attribute key specified. You can use this information to help narrow the search for your user.</p>"
|
|
|
+ "documentation":"<p>An array of documents attributes. Amazon Kendra returns a count for each attribute key specified. This helps your users narrow their search.</p>"
|
|
|
},
|
|
|
"RequestedDocumentAttributes":{
|
|
|
"shape":"DocumentAttributeKeyList",
|
|
|
- "documentation":"<p>An array of document attributes to include in the response. No other document attributes are included in the response. By default all document attributes are included in the response. </p>"
|
|
|
+ "documentation":"<p>An array of document attributes to include in the response. You can limit the response to include certain document attributes. By default all document attributes are included in the response.</p>"
|
|
|
},
|
|
|
"QueryResultTypeFilter":{
|
|
|
"shape":"QueryResultType",
|
|
|
@@ -5589,7 +5601,7 @@
|
|
|
},
|
|
|
"DocumentAttributes":{
|
|
|
"shape":"DocumentAttributeList",
|
|
|
- "documentation":"<p>An array of document attributes for the document that the query result maps to. For example, the document author (Author) or the source URI (SourceUri) of the document.</p>"
|
|
|
+ "documentation":"<p>An array of document attributes assigned to a document in the search results. For example, the document author (<code>_author</code>) or the source URI (<code>_source_uri</code>) of the document.</p>"
|
|
|
},
|
|
|
"ScoreAttributes":{
|
|
|
"shape":"ScoreAttributes",
|
|
|
@@ -5697,23 +5709,23 @@
|
|
|
"members":{
|
|
|
"Domain":{
|
|
|
"shape":"Domain",
|
|
|
- "documentation":"<p>The configuration information to connect to your Quip data source domain.</p>"
|
|
|
+ "documentation":"<p>The Quip site domain.</p>"
|
|
|
},
|
|
|
"SecretArn":{
|
|
|
"shape":"SecretArn",
|
|
|
- "documentation":"<p>The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs that are required to connect to your Quip file system. Windows is currently the only supported type. The secret must contain a JSON structure with the following keys:</p> <ul> <li> <p>username—The Active Directory user name, along with the Domain Name System (DNS) domain name. For example, <i>user@corp.example.com</i>. The Active Directory user account must have read and mounting access to the Quip file system for Windows.</p> </li> <li> <p>password—The password of the Active Directory user account with read and mounting access to the Quip Windows file system.</p> </li> </ul>"
|
|
|
+ "documentation":"<p>The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs that are required to connect to your Quip. The secret must contain a JSON structure with the following keys:</p> <ul> <li> <p>accessToken—The token created in Quip. For more information, see <a href=\"https://docs.aws.amazon.com/kendra/latest/dg/data-source-slack.html#quip-authentication\">Authentication for a Quip data source</a>.</p> </li> </ul>"
|
|
|
},
|
|
|
"CrawlFileComments":{
|
|
|
"shape":"Boolean",
|
|
|
- "documentation":"<p>Specify whether to crawl file comments in your Quip data source. You can specify one or more of these options.</p>"
|
|
|
+ "documentation":"<p>Specify whether to crawl file comments in Quip. You can specify one or more of these options.</p>"
|
|
|
},
|
|
|
"CrawlChatRooms":{
|
|
|
"shape":"Boolean",
|
|
|
- "documentation":"<p>Specify whether to crawl chat rooms in your Quip data source. You can specify one or more of these options.</p>"
|
|
|
+ "documentation":"<p>Specify whether to crawl chat rooms in Quip. You can specify one or more of these options.</p>"
|
|
|
},
|
|
|
"CrawlAttachments":{
|
|
|
"shape":"Boolean",
|
|
|
- "documentation":"<p>Specify whether to crawl attachments in your Quip data source. You can specify one or more of these options.</p>"
|
|
|
+ "documentation":"<p>Specify whether to crawl attachments in Quip. You can specify one or more of these options.</p>"
|
|
|
},
|
|
|
"FolderIds":{
|
|
|
"shape":"FolderIdList",
|
|
|
@@ -5721,15 +5733,15 @@
|
|
|
},
|
|
|
"ThreadFieldMappings":{
|
|
|
"shape":"DataSourceToIndexFieldMappingList",
|
|
|
- "documentation":"<p>A list of field mappings to apply when indexing Quip threads.</p>"
|
|
|
+ "documentation":"<p>A list of <code>DataSourceToIndexFieldMapping</code> objects that map attributes or field names of Quip threads to Amazon Kendra index field names. To create custom fields, use the <code>UpdateIndex</code> API before you map to Quip fields. For more information, see <a href=\"https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html\">Mapping data source fields</a>. The Quip field names must exist in your Quip custom metadata.</p>"
|
|
|
},
|
|
|
"MessageFieldMappings":{
|
|
|
"shape":"DataSourceToIndexFieldMappingList",
|
|
|
- "documentation":"<p>A list of field mappings to apply when indexing Quip messages.</p>"
|
|
|
+ "documentation":"<p>A list of <code>DataSourceToIndexFieldMapping</code> objects that map attributes or field names of Quip messages to Amazon Kendra index field names. To create custom fields, use the <code>UpdateIndex</code> API before you map to Quip fields. For more information, see <a href=\"https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html\">Mapping data source fields</a>. The Quip field names must exist in your Quip custom metadata.</p>"
|
|
|
},
|
|
|
"AttachmentFieldMappings":{
|
|
|
"shape":"DataSourceToIndexFieldMappingList",
|
|
|
- "documentation":"<p>A list of field mappings to apply when indexing Quip attachments.</p>"
|
|
|
+ "documentation":"<p>A list of <code>DataSourceToIndexFieldMapping</code> objects that map attributes or field names of Quip attachments to Amazon Kendra index field names. To create custom fields, use the <code>UpdateIndex</code> API before you map to Quip fields. For more information, see <a href=\"https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html\">Mapping data source fields</a>. The Quip field names must exist in your Quip custom metadata.</p>"
|
|
|
},
|
|
|
"InclusionPatterns":{
|
|
|
"shape":"DataSourceInclusionsExclusionsStrings",
|
|
|
@@ -5741,7 +5753,7 @@
|
|
|
},
|
|
|
"VpcConfiguration":{
|
|
|
"shape":"DataSourceVpcConfiguration",
|
|
|
- "documentation":"<p>Configuration information for connecting to an Amazon Virtual Private Cloud (VPC) for your Quip. Your Quip instance must reside inside your VPC.</p>"
|
|
|
+ "documentation":"<p>Configuration information for an Amazon Virtual Private Cloud (VPC) to connect to your Quip. For more information, see <a href=\"https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html\">Configuring a VPC</a>.</p>"
|
|
|
}
|
|
|
},
|
|
|
"documentation":"<p>Provides the configuration information to connect to Quip as your data source.</p>"
|
|
|
@@ -7012,6 +7024,11 @@
|
|
|
"min":1,
|
|
|
"pattern":"^\\P{C}*$"
|
|
|
},
|
|
|
+ "TopDocumentAttributeValueCountPairsSize":{
|
|
|
+ "type":"integer",
|
|
|
+ "max":5000,
|
|
|
+ "min":0
|
|
|
+ },
|
|
|
"UntagResourceRequest":{
|
|
|
"type":"structure",
|
|
|
"required":[
|
arcadia-devtools