# frozen_string_literal: true

# WARNING ABOUT GENERATED CODE
#
# This file is generated. See the contributing guide for more information:
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
#
# WARNING ABOUT GENERATED CODE

module Aws::Kendra
  module Types

    # Summary information on an access control configuration that you
    # created for your documents in an index.
    #
    # @!attribute [rw] id
    #   The identifier of the access control configuration.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/AccessControlConfigurationSummary AWS API Documentation
    #
    class AccessControlConfigurationSummary < Struct.new(
      :id)
      SENSITIVE = []
      include Aws::Structure
    end

    # Access Control List files for the documents in a data source. For the
    # format of the file, see [Access control for S3 data sources][1].
    #
    #
    #
    # [1]: https://docs.aws.amazon.com/kendra/latest/dg/s3-acl.html
    #
    # @!attribute [rw] key_path
    #   Path to the Amazon S3 bucket that contains the ACL files.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/AccessControlListConfiguration AWS API Documentation
    #
    class AccessControlListConfiguration < Struct.new(
      :key_path)
      SENSITIVE = []
      include Aws::Structure
    end

    # You don't have sufficient access to perform this action. Please
    # ensure you have the required permission policies and user accounts and
    # try again.
    #
    # @!attribute [rw] message
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/AccessDeniedException AWS API Documentation
    #
    class AccessDeniedException < Struct.new(
      :message)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides information about the column that should be used for
    # filtering the query response by groups.
    #
    # @!attribute [rw] allowed_groups_column_name
    #   A list of groups, separated by semi-colons, that filters a query
    #   response based on user context. The document is only returned to
    #   users that are in one of the groups specified in the `UserContext`
    #   field of the `Query` API.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/AclConfiguration AWS API Documentation
    #
    class AclConfiguration < Struct.new(
      :allowed_groups_column_name)
      SENSITIVE = []
      include Aws::Structure
    end

    # An attribute returned from an index query.
    #
    # @!attribute [rw] key
    #   The key that identifies the attribute.
    #   @return [String]
    #
    # @!attribute [rw] value_type
    #   The data type of the `Value` property.
    #   @return [String]
    #
    # @!attribute [rw] value
    #   An object that contains the attribute value.
    #   @return [Types::AdditionalResultAttributeValue]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/AdditionalResultAttribute AWS API Documentation
    #
    class AdditionalResultAttribute < Struct.new(
      :key,
      :value_type,
      :value)
      SENSITIVE = []
      include Aws::Structure
    end

    # An attribute returned with a document from a search.
    #
    # @!attribute [rw] text_with_highlights_value
    #   The text associated with the attribute and information about the
    #   highlight to apply to the text.
    #   @return [Types::TextWithHighlights]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/AdditionalResultAttributeValue AWS API Documentation
    #
    class AdditionalResultAttributeValue < Struct.new(
      :text_with_highlights_value)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides the configuration information to connect to Alfresco as your
    # data source.
    #
    # <note markdown="1"> Support for `AlfrescoConfiguration` ended May 2023. We recommend
    # migrating to or using the Alfresco data source template schema /
    # [TemplateConfiguration][1] API.
    #
    #  </note>
    #
    #
    #
    # [1]: https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html
    #
    # @!attribute [rw] site_url
    #   The URL of the Alfresco site. For example, *https://hostname:8080*.
    #   @return [String]
    #
    # @!attribute [rw] site_id
    #   The identifier of the Alfresco site. For example, *my-site*.
    #   @return [String]
    #
    # @!attribute [rw] secret_arn
    #   The Amazon Resource Name (ARN) of an Secrets Manager secret that
    #   contains the key-value pairs required to connect to your Alfresco
    #   data source. The secret must contain a JSON structure with the
    #   following keys:
    #
    #   * username—The user name of the Alfresco account.
    #
    #   * password—The password of the Alfresco account.
    #   @return [String]
    #
    # @!attribute [rw] ssl_certificate_s3_path
    #   The path to the SSL certificate stored in an Amazon S3 bucket. You
    #   use this to connect to Alfresco if you require a secure SSL
    #   connection.
    #
    #   You can simply generate a self-signed X509 certificate on any
    #   computer using OpenSSL. For an example of using OpenSSL to create an
    #   X509 certificate, see [Create and sign an X509 certificate][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/configuring-https-ssl.html
    #   @return [Types::S3Path]
    #
    # @!attribute [rw] crawl_system_folders
    #   `TRUE` to index shared files.
    #   @return [Boolean]
    #
    # @!attribute [rw] crawl_comments
    #   `TRUE` to index comments of blogs and other content.
    #   @return [Boolean]
    #
    # @!attribute [rw] entity_filter
    #   Specify whether to index document libraries, wikis, or blogs. You
    #   can specify one or more of these options.
    #   @return [Array<String>]
    #
    # @!attribute [rw] document_library_field_mappings
    #   A list of `DataSourceToIndexFieldMapping` objects that map
    #   attributes or field names of Alfresco document libraries to Amazon
    #   Kendra index field names. To create custom fields, use the
    #   `UpdateIndex` API before you map to Alfresco fields. For more
    #   information, see [ Mapping data source fields][1]. The Alfresco data
    #   source field names must exist in your Alfresco custom metadata.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
    #   @return [Array<Types::DataSourceToIndexFieldMapping>]
    #
    # @!attribute [rw] blog_field_mappings
    #   A list of `DataSourceToIndexFieldMapping` objects that map
    #   attributes or field names of Alfresco blogs to Amazon Kendra index
    #   field names. To create custom fields, use the `UpdateIndex` API
    #   before you map to Alfresco fields. For more information, see [
    #   Mapping data source fields][1]. The Alfresco data source field names
    #   must exist in your Alfresco custom metadata.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
    #   @return [Array<Types::DataSourceToIndexFieldMapping>]
    #
    # @!attribute [rw] wiki_field_mappings
    #   A list of `DataSourceToIndexFieldMapping` objects that map
    #   attributes or field names of Alfresco wikis to Amazon Kendra index
    #   field names. To create custom fields, use the `UpdateIndex` API
    #   before you map to Alfresco fields. For more information, see [
    #   Mapping data source fields][1]. The Alfresco data source field names
    #   must exist in your Alfresco custom metadata.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
    #   @return [Array<Types::DataSourceToIndexFieldMapping>]
    #
    # @!attribute [rw] inclusion_patterns
    #   A list of regular expression patterns to include certain files in
    #   your Alfresco data source. Files that match the patterns are
    #   included in the index. Files that don't match the patterns are
    #   excluded from the index. If a file matches both an inclusion pattern
    #   and an exclusion pattern, the exclusion pattern takes precedence and
    #   the file isn't included in the index.
    #   @return [Array<String>]
    #
    # @!attribute [rw] exclusion_patterns
    #   A list of regular expression patterns to exclude certain files in
    #   your Alfresco data source. Files that match the patterns are
    #   excluded from the index. Files that don't match the patterns are
    #   included in the index. If a file matches both an inclusion pattern
    #   and an exclusion pattern, the exclusion pattern takes precedence and
    #   the file isn't included in the index.
    #   @return [Array<String>]
    #
    # @!attribute [rw] vpc_configuration
    #   Configuration information for an Amazon Virtual Private Cloud to
    #   connect to your Alfresco. For more information, see [Configuring a
    #   VPC][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html
    #   @return [Types::DataSourceVpcConfiguration]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/AlfrescoConfiguration AWS API Documentation
    #
    class AlfrescoConfiguration < Struct.new(
      :site_url,
      :site_id,
      :secret_arn,
      :ssl_certificate_s3_path,
      :crawl_system_folders,
      :crawl_comments,
      :entity_filter,
      :document_library_field_mappings,
      :blog_field_mappings,
      :wiki_field_mappings,
      :inclusion_patterns,
      :exclusion_patterns,
      :vpc_configuration)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] id
    #   The identifier of your Amazon Kendra experience.
    #   @return [String]
    #
    # @!attribute [rw] index_id
    #   The identifier of the index for your Amazon Kendra experience.
    #   @return [String]
    #
    # @!attribute [rw] entity_list
    #   Lists users or groups in your IAM Identity Center identity source.
    #   @return [Array<Types::EntityConfiguration>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/AssociateEntitiesToExperienceRequest AWS API Documentation
    #
    class AssociateEntitiesToExperienceRequest < Struct.new(
      :id,
      :index_id,
      :entity_list)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] failed_entity_list
    #   Lists the users or groups in your IAM Identity Center identity
    #   source that failed to properly configure with your Amazon Kendra
    #   experience.
    #   @return [Array<Types::FailedEntity>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/AssociateEntitiesToExperienceResponse AWS API Documentation
    #
    class AssociateEntitiesToExperienceResponse < Struct.new(
      :failed_entity_list)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] id
    #   The identifier of your Amazon Kendra experience.
    #   @return [String]
    #
    # @!attribute [rw] index_id
    #   The identifier of the index for your Amazon Kendra experience.
    #   @return [String]
    #
    # @!attribute [rw] personas
    #   The personas that define the specific permissions of users or groups
    #   in your IAM Identity Center identity source. The available personas
    #   or access roles are `Owner` and `Viewer`. For more information on
    #   these personas, see [Providing access to your search page][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html#access-search-experience
    #   @return [Array<Types::EntityPersonaConfiguration>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/AssociatePersonasToEntitiesRequest AWS API Documentation
    #
    class AssociatePersonasToEntitiesRequest < Struct.new(
      :id,
      :index_id,
      :personas)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] failed_entity_list
    #   Lists the users or groups in your IAM Identity Center identity
    #   source that failed to properly configure with your Amazon Kendra
    #   experience.
    #   @return [Array<Types::FailedEntity>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/AssociatePersonasToEntitiesResponse AWS API Documentation
    #
    class AssociatePersonasToEntitiesResponse < Struct.new(
      :failed_entity_list)
      SENSITIVE = []
      include Aws::Structure
    end

    # Filters the search results based on document attributes or fields.
    #
    # You can filter results using attributes for your particular documents.
    # The attributes must exist in your index. For example, if your
    # documents include the custom attribute "Department", you can filter
    # documents that belong to the "HR" department. You would use the
    # `EqualsTo` operation to filter results or documents with
    # "Department" equals to "HR".
    #
    # You can use `AndAllFilters` and `AndOrFilters` in combination with
    # each other or with other operations such as `EqualsTo`. For example:
    #
    # `AndAllFilters`
    #
    # * `EqualsTo`: "Department", "HR"
    #
    # * `AndOrFilters`
    #
    #   * `ContainsAny`: "Project Name", \["new hires", "new hiring"\]
    #
    #   ^
    #
    # This example filters results or documents that belong to the HR
    # department *and* belong to projects that contain "new hires" *or*
    # "new hiring" in the project name (must use `ContainAny` with
    # `StringListValue`). This example is filtering with a depth of 2.
    #
    # You cannot filter more than a depth of 2, otherwise you receive a
    # `ValidationException` exception with the message "AttributeFilter
    # cannot have a depth of more than 2." Also, if you use more than 10
    # attribute filters in a given list for `AndAllFilters` or
    # `OrAllFilters`, you receive a `ValidationException` with the message
    # "AttributeFilter cannot have a length of more than 10".
    #
    # For examples of using `AttributeFilter`, see [Using document
    # attributes to filter search results][1].
    #
    #
    #
    # [1]: https://docs.aws.amazon.com/kendra/latest/dg/filtering.html#search-filtering
    #
    # @!attribute [rw] and_all_filters
    #   Performs a logical `AND` operation on all filters that you specify.
    #   @return [Array<Types::AttributeFilter>]
    #
    # @!attribute [rw] or_all_filters
    #   Performs a logical `OR` operation on all filters that you specify.
    #   @return [Array<Types::AttributeFilter>]
    #
    # @!attribute [rw] not_filter
    #   Performs a logical `NOT` operation on all filters that you specify.
    #   @return [Types::AttributeFilter]
    #
    # @!attribute [rw] equals_to
    #   Performs an equals operation on document attributes/fields and their
    #   values.
    #   @return [Types::DocumentAttribute]
    #
    # @!attribute [rw] contains_all
    #   Returns true when a document contains all of the specified document
    #   attributes/fields. This filter is only applicable to
    #   [StringListValue][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/APIReference/API_DocumentAttributeValue.html
    #   @return [Types::DocumentAttribute]
    #
    # @!attribute [rw] contains_any
    #   Returns true when a document contains any of the specified document
    #   attributes/fields. This filter is only applicable to
    #   [StringListValue][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/APIReference/API_DocumentAttributeValue.html
    #   @return [Types::DocumentAttribute]
    #
    # @!attribute [rw] greater_than
    #   Performs a greater than operation on document attributes/fields and
    #   their values. Use with the [document attribute type][1] `Date` or
    #   `Long`.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/APIReference/API_DocumentAttributeValue.html
    #   @return [Types::DocumentAttribute]
    #
    # @!attribute [rw] greater_than_or_equals
    #   Performs a greater or equals than operation on document
    #   attributes/fields and their values. Use with the [document attribute
    #   type][1] `Date` or `Long`.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/APIReference/API_DocumentAttributeValue.html
    #   @return [Types::DocumentAttribute]
    #
    # @!attribute [rw] less_than
    #   Performs a less than operation on document attributes/fields and
    #   their values. Use with the [document attribute type][1] `Date` or
    #   `Long`.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/APIReference/API_DocumentAttributeValue.html
    #   @return [Types::DocumentAttribute]
    #
    # @!attribute [rw] less_than_or_equals
    #   Performs a less than or equals operation on document
    #   attributes/fields and their values. Use with the [document attribute
    #   type][1] `Date` or `Long`.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/APIReference/API_DocumentAttributeValue.html
    #   @return [Types::DocumentAttribute]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/AttributeFilter AWS API Documentation
    #
    class AttributeFilter < Struct.new(
      :and_all_filters,
      :or_all_filters,
      :not_filter,
      :equals_to,
      :contains_all,
      :contains_any,
      :greater_than,
      :greater_than_or_equals,
      :less_than,
      :less_than_or_equals)
      SENSITIVE = []
      include Aws::Structure
    end

    # Gets information on the configuration of document fields/attributes
    # that you want to base query suggestions on. To change your
    # configuration, use [AttributeSuggestionsUpdateConfig][1] and then call
    # [UpdateQuerySuggestionsConfig][2].
    #
    #
    #
    # [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_AttributeSuggestionsUpdateConfig.html
    # [2]: https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateQuerySuggestionsConfig.html
    #
    # @!attribute [rw] suggestable_config_list
    #   The list of fields/attributes that you want to set as suggestible
    #   for query suggestions.
    #   @return [Array<Types::SuggestableConfig>]
    #
    # @!attribute [rw] attribute_suggestions_mode
    #   The mode is set to either `ACTIVE` or `INACTIVE`. If the `Mode` for
    #   query history is set to `ENABLED` when calling
    #   [UpdateQuerySuggestionsConfig][1] and `AttributeSuggestionsMode` to
    #   use fields/attributes is set to `ACTIVE`, and you haven't set your
    #   `SuggestionTypes` preference to `DOCUMENT_ATTRIBUTES`, then Amazon
    #   Kendra uses the query history.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateQuerySuggestionsConfig.html
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/AttributeSuggestionsDescribeConfig AWS API Documentation
    #
    class AttributeSuggestionsDescribeConfig < Struct.new(
      :suggestable_config_list,
      :attribute_suggestions_mode)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides the configuration information for the document
    # fields/attributes that you want to base query suggestions on.
    #
    # @!attribute [rw] suggestion_attributes
    #   The list of document field/attribute keys or field names to use for
    #   query suggestions. If the content within any of the fields match
    #   what your user starts typing as their query, then the field content
    #   is returned as a query suggestion.
    #   @return [Array<String>]
    #
    # @!attribute [rw] additional_response_attributes
    #   The list of additional document field/attribute keys or field names
    #   to include in the response. You can use additional fields to provide
    #   extra information in the response. Additional fields are not used to
    #   based suggestions on.
    #   @return [Array<String>]
    #
    # @!attribute [rw] attribute_filter
    #   Filters the search results based on document fields/attributes.
    #   @return [Types::AttributeFilter]
    #
    # @!attribute [rw] user_context
    #   Applies user context filtering so that only users who are given
    #   access to certain documents see these document in their search
    #   results.
    #   @return [Types::UserContext]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/AttributeSuggestionsGetConfig AWS API Documentation
    #
    class AttributeSuggestionsGetConfig < Struct.new(
      :suggestion_attributes,
      :additional_response_attributes,
      :attribute_filter,
      :user_context)
      SENSITIVE = []
      include Aws::Structure
    end

    # Updates the configuration information for the document
    # fields/attributes that you want to base query suggestions on.
    #
    # To deactivate using documents fields for query suggestions, set the
    # mode to `INACTIVE`. You must also set `SuggestionTypes` as either
    # `QUERY` or `DOCUMENT_ATTRIBUTES` and then call
    # [GetQuerySuggestions][1]. If you set to `QUERY`, then Amazon Kendra
    # uses the query history to base suggestions on. If you set to
    # `DOCUMENT_ATTRIBUTES`, then Amazon Kendra uses the contents of
    # document fields to base suggestions on.
    #
    #
    #
    # [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_GetQuerySuggestions.html
    #
    # @!attribute [rw] suggestable_config_list
    #   The list of fields/attributes that you want to set as suggestible
    #   for query suggestions.
    #   @return [Array<Types::SuggestableConfig>]
    #
    # @!attribute [rw] attribute_suggestions_mode
    #   You can set the mode to `ACTIVE` or `INACTIVE`. You must also set
    #   `SuggestionTypes` as either `QUERY` or `DOCUMENT_ATTRIBUTES` and
    #   then call [GetQuerySuggestions][1]. If `Mode` to use query history
    #   is set to `ENABLED` when calling [UpdateQuerySuggestionsConfig][2]
    #   and `AttributeSuggestionsMode` to use fields/attributes is set to
    #   `ACTIVE`, and you haven't set your `SuggestionTypes` preference to
    #   `DOCUMENT_ATTRIBUTES`, then Amazon Kendra uses the query history.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_GetQuerySuggestions.html
    #   [2]: https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateQuerySuggestionsConfig.html
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/AttributeSuggestionsUpdateConfig AWS API Documentation
    #
    class AttributeSuggestionsUpdateConfig < Struct.new(
      :suggestable_config_list,
      :attribute_suggestions_mode)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides the configuration information to connect to websites that
    # require user authentication.
    #
    # @!attribute [rw] basic_authentication
    #   The list of configuration information that's required to connect to
    #   and crawl a website host using basic authentication credentials.
    #
    #   The list includes the name and port number of the website host.
    #   @return [Array<Types::BasicAuthenticationConfiguration>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/AuthenticationConfiguration AWS API Documentation
    #
    class AuthenticationConfiguration < Struct.new(
      :basic_authentication)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides the configuration information to connect to websites that
    # require basic user authentication.
    #
    # @!attribute [rw] host
    #   The name of the website host you want to connect to using
    #   authentication credentials.
    #
    #   For example, the host name of https://a.example.com/page1.html is
    #   "a.example.com".
    #   @return [String]
    #
    # @!attribute [rw] port
    #   The port number of the website host you want to connect to using
    #   authentication credentials.
    #
    #   For example, the port for https://a.example.com/page1.html is 443,
    #   the standard port for HTTPS.
    #   @return [Integer]
    #
    # @!attribute [rw] credentials
    #   Your secret ARN, which you can create in [Secrets Manager][1]
    #
    #   You use a secret if basic authentication credentials are required to
    #   connect to a website. The secret stores your credentials of user
    #   name and password.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/BasicAuthenticationConfiguration AWS API Documentation
    #
    class BasicAuthenticationConfiguration < Struct.new(
      :host,
      :port,
      :credentials)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] index_id
    #   The identifier of the index that contains the documents to delete.
    #   @return [String]
    #
    # @!attribute [rw] document_id_list
    #   One or more identifiers for documents to delete from the index.
    #   @return [Array<String>]
    #
    # @!attribute [rw] data_source_sync_job_metric_target
    #   Maps a particular data source sync job to a particular data source.
    #   @return [Types::DataSourceSyncJobMetricTarget]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/BatchDeleteDocumentRequest AWS API Documentation
    #
    class BatchDeleteDocumentRequest < Struct.new(
      :index_id,
      :document_id_list,
      :data_source_sync_job_metric_target)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] failed_documents
    #   A list of documents that could not be removed from the index. Each
    #   entry contains an error message that indicates why the document
    #   couldn't be removed from the index.
    #   @return [Array<Types::BatchDeleteDocumentResponseFailedDocument>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/BatchDeleteDocumentResponse AWS API Documentation
    #
    class BatchDeleteDocumentResponse < Struct.new(
      :failed_documents)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides information about documents that could not be removed from an
    # index by the `BatchDeleteDocument` API.
    #
    # @!attribute [rw] id
    #   The identifier of the document that couldn't be removed from the
    #   index.
    #   @return [String]
    #
    # @!attribute [rw] error_code
    #   The error code for why the document couldn't be removed from the
    #   index.
    #   @return [String]
    #
    # @!attribute [rw] error_message
    #   An explanation for why the document couldn't be removed from the
    #   index.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/BatchDeleteDocumentResponseFailedDocument AWS API Documentation
    #
    class BatchDeleteDocumentResponseFailedDocument < Struct.new(
      :id,
      :error_code,
      :error_message)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides information about a set of featured results that couldn't be
    # removed from an index by the [BatchDeleteFeaturedResultsSet][1] API.
    #
    #
    #
    # [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_BatchDeleteFeaturedResultsSet.html
    #
    # @!attribute [rw] id
    #   The identifier of the set of featured results that couldn't be
    #   removed from the index.
    #   @return [String]
    #
    # @!attribute [rw] error_code
    #   The error code for why the set of featured results couldn't be
    #   removed from the index.
    #   @return [String]
    #
    # @!attribute [rw] error_message
    #   An explanation for why the set of featured results couldn't be
    #   removed from the index.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/BatchDeleteFeaturedResultsSetError AWS API Documentation
    #
    class BatchDeleteFeaturedResultsSetError < Struct.new(
      :id,
      :error_code,
      :error_message)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] index_id
    #   The identifier of the index used for featuring results.
    #   @return [String]
    #
    # @!attribute [rw] featured_results_set_ids
    #   The identifiers of the featured results sets that you want to
    #   delete.
    #   @return [Array<String>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/BatchDeleteFeaturedResultsSetRequest AWS API Documentation
    #
    class BatchDeleteFeaturedResultsSetRequest < Struct.new(
      :index_id,
      :featured_results_set_ids)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] errors
    #   The list of errors for the featured results set IDs, explaining why
    #   they couldn't be removed from the index.
    #   @return [Array<Types::BatchDeleteFeaturedResultsSetError>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/BatchDeleteFeaturedResultsSetResponse AWS API Documentation
    #
    class BatchDeleteFeaturedResultsSetResponse < Struct.new(
      :errors)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] index_id
    #   The identifier of the index to add documents to. The index ID is
    #   returned by the [CreateIndex ][1] API.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_CreateIndex.html
    #   @return [String]
    #
    # @!attribute [rw] document_info_list
    #   A list of `DocumentInfo` objects that identify the documents for
    #   which to get the status. You identify the documents by their
    #   document ID and optional attributes.
    #   @return [Array<Types::DocumentInfo>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/BatchGetDocumentStatusRequest AWS API Documentation
    #
    class BatchGetDocumentStatusRequest < Struct.new(
      :index_id,
      :document_info_list)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] errors
    #   A list of documents that Amazon Kendra couldn't get the status for.
    #   The list includes the ID of the document and the reason that the
    #   status couldn't be found.
    #   @return [Array<Types::BatchGetDocumentStatusResponseError>]
    #
    # @!attribute [rw] document_status_list
    #   The status of documents. The status indicates if the document is
    #   waiting to be indexed, is in the process of indexing, has completed
    #   indexing, or failed indexing. If a document failed indexing, the
    #   status provides the reason why.
    #   @return [Array<Types::Status>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/BatchGetDocumentStatusResponse AWS API Documentation
    #
    class BatchGetDocumentStatusResponse < Struct.new(
      :errors,
      :document_status_list)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides a response when the status of a document could not be
    # retrieved.
    #
    # @!attribute [rw] document_id
    #   The identifier of the document whose status could not be retrieved.
    #   @return [String]
    #
    # @!attribute [rw] error_code
    #   Indicates the source of the error.
    #   @return [String]
    #
    # @!attribute [rw] error_message
    #   States that the API could not get the status of a document. This
    #   could be because the request is not valid or there is a system
    #   error.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/BatchGetDocumentStatusResponseError AWS API Documentation
    #
    class BatchGetDocumentStatusResponseError < Struct.new(
      :document_id,
      :error_code,
      :error_message)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] index_id
    #   The identifier of the index to add the documents to. You need to
    #   create the index first using the `CreateIndex` API.
    #   @return [String]
    #
    # @!attribute [rw] role_arn
    #   The Amazon Resource Name (ARN) of an IAM role with permission to
    #   access your S3 bucket. For more information, see [IAM access roles
    #   for Amazon Kendra][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html
    #   @return [String]
    #
    # @!attribute [rw] documents
    #   One or more documents to add to the index.
    #
    #   Documents have the following file size limits.
    #
    #   * 50 MB total size for any file
    #
    #   * 5 MB extracted text for any file
    #
    #   For more information, see [Quotas][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
    #   @return [Array<Types::Document>]
    #
    # @!attribute [rw] custom_document_enrichment_configuration
    #   Configuration information for altering your document metadata and
    #   content during the document ingestion process when you use the
    #   `BatchPutDocument` API.
    #
    #   For more information on how to create, modify and delete document
    #   metadata, or make other content alterations when you ingest
    #   documents into Amazon Kendra, see [Customizing document metadata
    #   during the ingestion process][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html
    #   @return [Types::CustomDocumentEnrichmentConfiguration]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/BatchPutDocumentRequest AWS API Documentation
    #
    class BatchPutDocumentRequest < Struct.new(
      :index_id,
      :role_arn,
      :documents,
      :custom_document_enrichment_configuration)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] failed_documents
    #   A list of documents that were not added to the index because the
    #   document failed a validation check. Each document contains an error
    #   message that indicates why the document couldn't be added to the
    #   index.
    #
    #   If there was an error adding a document to an index the error is
    #   reported in your Amazon Web Services CloudWatch log. For more
    #   information, see [Monitoring Amazon Kendra with Amazon CloudWatch
    #   logs][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/cloudwatch-logs.html
    #   @return [Array<Types::BatchPutDocumentResponseFailedDocument>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/BatchPutDocumentResponse AWS API Documentation
    #
    class BatchPutDocumentResponse < Struct.new(
      :failed_documents)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides information about a document that could not be indexed.
    #
    # @!attribute [rw] id
    #   The identifier of the document.
    #   @return [String]
    #
    # @!attribute [rw] error_code
    #   The type of error that caused the document to fail to be indexed.
    #   @return [String]
    #
    # @!attribute [rw] error_message
    #   A description of the reason why the document could not be indexed.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/BatchPutDocumentResponseFailedDocument AWS API Documentation
    #
    class BatchPutDocumentResponseFailedDocument < Struct.new(
      :id,
      :error_code,
      :error_message)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides the configuration information to connect to Box as your data
    # source.
    #
    # @!attribute [rw] enterprise_id
    #   The identifier of the Box Enterprise platform. You can find the
    #   enterprise ID in the Box Developer Console settings or when you
    #   create an app in Box and download your authentication credentials.
    #   For example, *801234567*.
    #   @return [String]
    #
    # @!attribute [rw] secret_arn
    #   The Amazon Resource Name (ARN) of an Secrets Manager secret that
    #   contains the key-value pairs required to connect to your Box
    #   platform. The secret must contain a JSON structure with the
    #   following keys:
    #
    #   * clientID—The identifier of the client OAuth 2.0 authentication
    #     application created in Box.
    #
    #   * clientSecret—A set of characters known only to the OAuth 2.0
    #     authentication application created in Box.
    #
    #   * publicKeyId—The identifier of the public key contained within an
    #     identity certificate.
    #
    #   * privateKey—A set of characters that make up an encryption key.
    #
    #   * passphrase—A set of characters that act like a password.
    #
    #   You create an application in Box to generate the keys or credentials
    #   required for the secret. For more information, see [Using a Box data
    #   source][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/data-source-box.html
    #   @return [String]
    #
    # @!attribute [rw] use_change_log
    #   `TRUE` to use the Slack change log to determine which documents
    #   require updating in the index. Depending on the data source change
    #   log's size, it may take longer for Amazon Kendra to use the change
    #   log than to scan all of your documents.
    #   @return [Boolean]
    #
    # @!attribute [rw] crawl_comments
    #   `TRUE` to index comments.
    #   @return [Boolean]
    #
    # @!attribute [rw] crawl_tasks
    #   `TRUE` to index the contents of tasks.
    #   @return [Boolean]
    #
    # @!attribute [rw] crawl_web_links
    #   `TRUE` to index web links.
    #   @return [Boolean]
    #
    # @!attribute [rw] file_field_mappings
    #   A list of `DataSourceToIndexFieldMapping` objects that map
    #   attributes or field names of Box files to Amazon Kendra index field
    #   names. To create custom fields, use the `UpdateIndex` API before you
    #   map to Box fields. For more information, see [Mapping data source
    #   fields][1]. The Box field names must exist in your Box custom
    #   metadata.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
    #   @return [Array<Types::DataSourceToIndexFieldMapping>]
    #
    # @!attribute [rw] task_field_mappings
    #   A list of `DataSourceToIndexFieldMapping` objects that map
    #   attributes or field names of Box tasks to Amazon Kendra index field
    #   names. To create custom fields, use the `UpdateIndex` API before you
    #   map to Box fields. For more information, see [Mapping data source
    #   fields][1]. The Box field names must exist in your Box custom
    #   metadata.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
    #   @return [Array<Types::DataSourceToIndexFieldMapping>]
    #
    # @!attribute [rw] comment_field_mappings
    #   A list of `DataSourceToIndexFieldMapping` objects that map
    #   attributes or field names of Box comments to Amazon Kendra index
    #   field names. To create custom fields, use the `UpdateIndex` API
    #   before you map to Box fields. For more information, see [Mapping
    #   data source fields][1]. The Box field names must exist in your Box
    #   custom metadata.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
    #   @return [Array<Types::DataSourceToIndexFieldMapping>]
    #
    # @!attribute [rw] web_link_field_mappings
    #   A list of `DataSourceToIndexFieldMapping` objects that map
    #   attributes or field names of Box web links to Amazon Kendra index
    #   field names. To create custom fields, use the `UpdateIndex` API
    #   before you map to Box fields. For more information, see [Mapping
    #   data source fields][1]. The Box field names must exist in your Box
    #   custom metadata.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
    #   @return [Array<Types::DataSourceToIndexFieldMapping>]
    #
    # @!attribute [rw] inclusion_patterns
    #   A list of regular expression patterns to include certain files and
    #   folders in your Box platform. Files and folders that match the
    #   patterns are included in the index. Files and folders that don't
    #   match the patterns are excluded from the index. If a file or folder
    #   matches both an inclusion and exclusion pattern, the exclusion
    #   pattern takes precedence and the file or folder isn't included in
    #   the index.
    #   @return [Array<String>]
    #
    # @!attribute [rw] exclusion_patterns
    #   A list of regular expression patterns to exclude certain files and
    #   folders from your Box platform. Files and folders that match the
    #   patterns are excluded from the index.Files and folders that don't
    #   match the patterns are included in the index. If a file or folder
    #   matches both an inclusion and exclusion pattern, the exclusion
    #   pattern takes precedence and the file or folder isn't included in
    #   the index.
    #   @return [Array<String>]
    #
    # @!attribute [rw] vpc_configuration
    #   Configuration information for an Amazon VPC to connect to your Box.
    #   For more information, see [Configuring a VPC][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html
    #   @return [Types::DataSourceVpcConfiguration]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/BoxConfiguration AWS API Documentation
    #
    class BoxConfiguration < Struct.new(
      :enterprise_id,
      :secret_arn,
      :use_change_log,
      :crawl_comments,
      :crawl_tasks,
      :crawl_web_links,
      :file_field_mappings,
      :task_field_mappings,
      :comment_field_mappings,
      :web_link_field_mappings,
      :inclusion_patterns,
      :exclusion_patterns,
      :vpc_configuration)
      SENSITIVE = []
      include Aws::Structure
    end

    # Specifies additional capacity units configured for your Enterprise
    # Edition index. You can add and remove capacity units to fit your usage
    # requirements.
    #
    # @!attribute [rw] storage_capacity_units
    #   The amount of extra storage capacity for an index. A single capacity
    #   unit provides 30 GB of storage space or 100,000 documents, whichever
    #   is reached first. You can add up to 100 extra capacity units.
    #   @return [Integer]
    #
    # @!attribute [rw] query_capacity_units
    #   The amount of extra query capacity for an index and
    #   [GetQuerySuggestions][1] capacity.
    #
    #   A single extra capacity unit for an index provides 0.1 queries per
    #   second or approximately 8,000 queries per day. You can add up to 100
    #   extra capacity units.
    #
    #   `GetQuerySuggestions` capacity is five times the provisioned query
    #   capacity for an index, or the base capacity of 2.5 calls per second,
    #   whichever is higher. For example, the base capacity for an index is
    #   0.1 queries per second, and `GetQuerySuggestions` capacity has a
    #   base of 2.5 calls per second. If you add another 0.1 queries per
    #   second to total 0.2 queries per second for an index, the
    #   `GetQuerySuggestions` capacity is 2.5 calls per second (higher than
    #   five times 0.2 queries per second).
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_GetQuerySuggestions.html
    #   @return [Integer]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CapacityUnitsConfiguration AWS API Documentation
    #
    class CapacityUnitsConfiguration < Struct.new(
      :storage_capacity_units,
      :query_capacity_units)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] index_id
    #   The identifier of the index you want to clear query suggestions
    #   from.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ClearQuerySuggestionsRequest AWS API Documentation
    #
    class ClearQuerySuggestionsRequest < Struct.new(
      :index_id)
      SENSITIVE = []
      include Aws::Structure
    end

    # Gathers information about when a particular result was clicked by a
    # user. Your application uses the `SubmitFeedback` API to provide click
    # information.
    #
    # @!attribute [rw] result_id
    #   The identifier of the search result that was clicked.
    #   @return [String]
    #
    # @!attribute [rw] click_time
    #   The Unix timestamp when the result was clicked.
    #   @return [Time]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ClickFeedback AWS API Documentation
    #
    class ClickFeedback < Struct.new(
      :result_id,
      :click_time)
      SENSITIVE = []
      include Aws::Structure
    end

    # Specifies how to group results by document attribute value, and how to
    # display them collapsed/expanded under a designated primary document
    # for each group.
    #
    # @!attribute [rw] document_attribute_key
    #   The document attribute used to group search results. You can use any
    #   attribute 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".
    #   @return [String]
    #
    # @!attribute [rw] sorting_configurations
    #   A prioritized list of document attributes/fields that determine the
    #   primary document among those in a collapsed group.
    #   @return [Array<Types::SortingConfiguration>]
    #
    # @!attribute [rw] missing_attribute_key_strategy
    #   Specifies the behavior for documents without a value for the
    #   collapse attribute.
    #
    #   Amazon Kendra offers three customization options:
    #
    #   * Choose to `COLLAPSE` all documents with null or missing values in
    #     one group. This is the default configuration.
    #
    #   * Choose to `IGNORE` documents with null or missing values. Ignored
    #     documents will not appear in query results.
    #
    #   * Choose to `EXPAND` each document with a null or missing value into
    #     a group of its own.
    #   @return [String]
    #
    # @!attribute [rw] expand
    #   Specifies whether to expand the collapsed results.
    #   @return [Boolean]
    #
    # @!attribute [rw] expand_configuration
    #   Provides configuration information to customize expansion options
    #   for a collapsed group.
    #   @return [Types::ExpandConfiguration]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CollapseConfiguration AWS API Documentation
    #
    class CollapseConfiguration < Struct.new(
      :document_attribute_key,
      :sorting_configurations,
      :missing_attribute_key_strategy,
      :expand,
      :expand_configuration)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides details about a collapsed group of search results.
    #
    # @!attribute [rw] document_attribute
    #   The value of the document attribute that results are collapsed on.
    #   @return [Types::DocumentAttribute]
    #
    # @!attribute [rw] expanded_results
    #   A list of results in the collapsed group.
    #   @return [Array<Types::ExpandedResultItem>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CollapsedResultDetail AWS API Documentation
    #
    class CollapsedResultDetail < Struct.new(
      :document_attribute,
      :expanded_results)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides information about how Amazon Kendra should use the columns of
    # a database in an index.
    #
    # @!attribute [rw] document_id_column_name
    #   The column that provides the document's identifier.
    #   @return [String]
    #
    # @!attribute [rw] document_data_column_name
    #   The column that contains the contents of the document.
    #   @return [String]
    #
    # @!attribute [rw] document_title_column_name
    #   The column that contains the title of the document.
    #   @return [String]
    #
    # @!attribute [rw] field_mappings
    #   An array of objects that map database column names to the
    #   corresponding fields in an index. You must first create the fields
    #   in the index using the `UpdateIndex` API.
    #   @return [Array<Types::DataSourceToIndexFieldMapping>]
    #
    # @!attribute [rw] change_detecting_columns
    #   One to five columns that indicate when a document in the database
    #   has changed.
    #   @return [Array<String>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ColumnConfiguration AWS API Documentation
    #
    class ColumnConfiguration < Struct.new(
      :document_id_column_name,
      :document_data_column_name,
      :document_title_column_name,
      :field_mappings,
      :change_detecting_columns)
      SENSITIVE = []
      include Aws::Structure
    end

    # A conflict occurred with the request. Please fix any inconsistences
    # with your resources and try again.
    #
    # @!attribute [rw] message
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ConflictException AWS API Documentation
    #
    class ConflictException < Struct.new(
      :message)
      SENSITIVE = []
      include Aws::Structure
    end

    # Information about a conflicting query used across different sets of
    # featured results. When you create a featured results set, you must
    # check that the queries are unique per featured results set for each
    # index.
    #
    # @!attribute [rw] query_text
    #   The text of the conflicting query.
    #   @return [String]
    #
    # @!attribute [rw] set_name
    #   The name for the set of featured results that the conflicting query
    #   belongs to.
    #   @return [String]
    #
    # @!attribute [rw] set_id
    #   The identifier of the set of featured results that the conflicting
    #   query belongs to.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ConflictingItem AWS API Documentation
    #
    class ConflictingItem < Struct.new(
      :query_text,
      :set_name,
      :set_id)
      SENSITIVE = []
      include Aws::Structure
    end

    # Configuration of attachment settings for the Confluence data source.
    # Attachment settings are optional, if you don't specify settings
    # attachments, Amazon Kendra won't index them.
    #
    # @!attribute [rw] crawl_attachments
    #   `TRUE` to index attachments of pages and blogs in Confluence.
    #   @return [Boolean]
    #
    # @!attribute [rw] attachment_field_mappings
    #   Maps attributes or field names of Confluence attachments to Amazon
    #   Kendra index field names. To create custom fields, use the
    #   `UpdateIndex` API before you map to Confluence fields. For more
    #   information, see [Mapping data source fields][1]. The Confluence
    #   data source field names must exist in your Confluence custom
    #   metadata.
    #
    #   If you specify the `AttachentFieldMappings` parameter, you must
    #   specify at least one field mapping.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
    #   @return [Array<Types::ConfluenceAttachmentToIndexFieldMapping>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ConfluenceAttachmentConfiguration AWS API Documentation
    #
    class ConfluenceAttachmentConfiguration < Struct.new(
      :crawl_attachments,
      :attachment_field_mappings)
      SENSITIVE = []
      include Aws::Structure
    end

    # Maps attributes or field names of Confluence attachments to Amazon
    # Kendra index field names. To create custom fields, use the
    # `UpdateIndex` API before you map to Confluence fields. For more
    # information, see [Mapping data source fields][1]. The Confuence data
    # source field names must exist in your Confluence custom metadata.
    #
    #
    #
    # [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
    #
    # @!attribute [rw] data_source_field_name
    #   The name of the field in the data source.
    #
    #   You must first create the index field using the `UpdateIndex` API.
    #   @return [String]
    #
    # @!attribute [rw] date_field_format
    #   The format for date fields in the data source. If the field
    #   specified in `DataSourceFieldName` is a date field you must specify
    #   the date format. If the field is not a date field, an exception is
    #   thrown.
    #   @return [String]
    #
    # @!attribute [rw] index_field_name
    #   The name of the index field to map to the Confluence data source
    #   field. The index field type must match the Confluence field type.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ConfluenceAttachmentToIndexFieldMapping AWS API Documentation
    #
    class ConfluenceAttachmentToIndexFieldMapping < Struct.new(
      :data_source_field_name,
      :date_field_format,
      :index_field_name)
      SENSITIVE = []
      include Aws::Structure
    end

    # Configuration of blog settings for the Confluence data source. Blogs
    # are always indexed unless filtered from the index by the
    # `ExclusionPatterns` or `InclusionPatterns` fields in the
    # `ConfluenceConfiguration` object.
    #
    # @!attribute [rw] blog_field_mappings
    #   Maps attributes or field names of Confluence blogs to Amazon Kendra
    #   index field names. To create custom fields, use the `UpdateIndex`
    #   API before you map to Confluence fields. For more information, see
    #   [Mapping data source fields][1]. The Confluence data source field
    #   names must exist in your Confluence custom metadata.
    #
    #   If you specify the `BlogFieldMappings` parameter, you must specify
    #   at least one field mapping.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
    #   @return [Array<Types::ConfluenceBlogToIndexFieldMapping>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ConfluenceBlogConfiguration AWS API Documentation
    #
    class ConfluenceBlogConfiguration < Struct.new(
      :blog_field_mappings)
      SENSITIVE = []
      include Aws::Structure
    end

    # Maps attributes or field names of Confluence blog to Amazon Kendra
    # index field names. To create custom fields, use the `UpdateIndex` API
    # before you map to Confluence fields. For more information, see
    # [Mapping data source fields][1]. The Confluence data source field
    # names must exist in your Confluence custom metadata.
    #
    #
    #
    # [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
    #
    # @!attribute [rw] data_source_field_name
    #   The name of the field in the data source.
    #   @return [String]
    #
    # @!attribute [rw] date_field_format
    #   The format for date fields in the data source. If the field
    #   specified in `DataSourceFieldName` is a date field you must specify
    #   the date format. If the field is not a date field, an exception is
    #   thrown.
    #   @return [String]
    #
    # @!attribute [rw] index_field_name
    #   The name of the index field to map to the Confluence data source
    #   field. The index field type must match the Confluence field type.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ConfluenceBlogToIndexFieldMapping AWS API Documentation
    #
    class ConfluenceBlogToIndexFieldMapping < Struct.new(
      :data_source_field_name,
      :date_field_format,
      :index_field_name)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides the configuration information to connect to Confluence as
    # your data source.
    #
    # @!attribute [rw] server_url
    #   The URL of your Confluence instance. Use the full URL of the server.
    #   For example, *https://server.example.com:port/*. You can also use an
    #   IP address, for example, *https://192.168.1.113/*.
    #   @return [String]
    #
    # @!attribute [rw] secret_arn
    #   The Amazon Resource Name (ARN) of an Secrets Manager secret that
    #   contains the user name and password required to connect to the
    #   Confluence instance. If you use Confluence Cloud, you use a
    #   generated API token as the password.
    #
    #   You can also provide authentication credentials in the form of a
    #   personal access token. For more information, see [Using a Confluence
    #   data source][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/data-source-confluence.html
    #   @return [String]
    #
    # @!attribute [rw] version
    #   The version or the type of Confluence installation to connect to.
    #   @return [String]
    #
    # @!attribute [rw] space_configuration
    #   Configuration information for indexing Confluence spaces.
    #   @return [Types::ConfluenceSpaceConfiguration]
    #
    # @!attribute [rw] page_configuration
    #   Configuration information for indexing Confluence pages.
    #   @return [Types::ConfluencePageConfiguration]
    #
    # @!attribute [rw] blog_configuration
    #   Configuration information for indexing Confluence blogs.
    #   @return [Types::ConfluenceBlogConfiguration]
    #
    # @!attribute [rw] attachment_configuration
    #   Configuration information for indexing attachments to Confluence
    #   blogs and pages.
    #   @return [Types::ConfluenceAttachmentConfiguration]
    #
    # @!attribute [rw] vpc_configuration
    #   Configuration information for an Amazon Virtual Private Cloud to
    #   connect to your Confluence. For more information, see [Configuring a
    #   VPC][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html
    #   @return [Types::DataSourceVpcConfiguration]
    #
    # @!attribute [rw] inclusion_patterns
    #   A list of regular expression patterns to include certain blog posts,
    #   pages, spaces, or attachments in your Confluence. Content that
    #   matches the patterns are included in the index. Content that
    #   doesn't match the patterns is excluded from the index. If content
    #   matches both an inclusion and exclusion pattern, the exclusion
    #   pattern takes precedence and the content isn't included in the
    #   index.
    #   @return [Array<String>]
    #
    # @!attribute [rw] exclusion_patterns
    #   A list of regular expression patterns to exclude certain blog posts,
    #   pages, spaces, or attachments in your Confluence. Content that
    #   matches the patterns are excluded from the index. Content that
    #   doesn't match the patterns is included in the index. If content
    #   matches both an inclusion and exclusion pattern, the exclusion
    #   pattern takes precedence and the content isn't included in the
    #   index.
    #   @return [Array<String>]
    #
    # @!attribute [rw] proxy_configuration
    #   Configuration information to connect to your Confluence URL instance
    #   via a web proxy. You can use this option for Confluence Server.
    #
    #   You must provide the website host name and port number. For example,
    #   the host name of *https://a.example.com/page1.html* is
    #   "a.example.com" and the port is 443, the standard port for HTTPS.
    #
    #   Web proxy credentials are optional and you can use them to connect
    #   to a web proxy server that requires basic authentication of user
    #   name and password. To store web proxy credentials, you use a secret
    #   in Secrets Manager.
    #
    #   It is recommended that you follow best security practices when
    #   configuring your web proxy. This includes setting up throttling,
    #   setting up logging and monitoring, and applying security patches on
    #   a regular basis. If you use your web proxy with multiple data
    #   sources, sync jobs that occur at the same time could strain the load
    #   on your proxy. It is recommended you prepare your proxy beforehand
    #   for any security and load requirements.
    #   @return [Types::ProxyConfiguration]
    #
    # @!attribute [rw] authentication_type
    #   Whether you want to connect to Confluence using basic authentication
    #   of user name and password, or a personal access token. You can use a
    #   personal access token for Confluence Server.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ConfluenceConfiguration AWS API Documentation
    #
    class ConfluenceConfiguration < Struct.new(
      :server_url,
      :secret_arn,
      :version,
      :space_configuration,
      :page_configuration,
      :blog_configuration,
      :attachment_configuration,
      :vpc_configuration,
      :inclusion_patterns,
      :exclusion_patterns,
      :proxy_configuration,
      :authentication_type)
      SENSITIVE = []
      include Aws::Structure
    end

    # Configuration of the page settings for the Confluence data source.
    #
    # @!attribute [rw] page_field_mappings
    #   Maps attributes or field names of Confluence pages to Amazon Kendra
    #   index field names. To create custom fields, use the `UpdateIndex`
    #   API before you map to Confluence fields. For more information, see
    #   [Mapping data source fields][1]. The Confluence data source field
    #   names must exist in your Confluence custom metadata.
    #
    #   If you specify the `PageFieldMappings` parameter, you must specify
    #   at least one field mapping.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
    #   @return [Array<Types::ConfluencePageToIndexFieldMapping>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ConfluencePageConfiguration AWS API Documentation
    #
    class ConfluencePageConfiguration < Struct.new(
      :page_field_mappings)
      SENSITIVE = []
      include Aws::Structure
    end

    # Maps attributes or field names of Confluence pages to Amazon Kendra
    # index field names. To create custom fields, use the `UpdateIndex` API
    # before you map to Confluence fields. For more information, see
    # [Mapping data source fields][1]. The Confluence data source field
    # names must exist in your Confluence custom metadata.
    #
    #
    #
    # [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
    #
    # @!attribute [rw] data_source_field_name
    #   The name of the field in the data source.
    #   @return [String]
    #
    # @!attribute [rw] date_field_format
    #   The format for date fields in the data source. If the field
    #   specified in `DataSourceFieldName` is a date field you must specify
    #   the date format. If the field is not a date field, an exception is
    #   thrown.
    #   @return [String]
    #
    # @!attribute [rw] index_field_name
    #   The name of the index field to map to the Confluence data source
    #   field. The index field type must match the Confluence field type.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ConfluencePageToIndexFieldMapping AWS API Documentation
    #
    class ConfluencePageToIndexFieldMapping < Struct.new(
      :data_source_field_name,
      :date_field_format,
      :index_field_name)
      SENSITIVE = []
      include Aws::Structure
    end

    # Configuration information for indexing Confluence spaces.
    #
    # @!attribute [rw] crawl_personal_spaces
    #   `TRUE` to index personal spaces. You can add restrictions to items
    #   in personal spaces. If personal spaces are indexed, queries without
    #   user context information may return restricted items from a personal
    #   space in their results. For more information, see [Filtering on user
    #   context][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html
    #   @return [Boolean]
    #
    # @!attribute [rw] crawl_archived_spaces
    #   `TRUE` to index archived spaces.
    #   @return [Boolean]
    #
    # @!attribute [rw] include_spaces
    #   A list of space keys for Confluence spaces. If you include a key,
    #   the blogs, documents, and attachments in the space are indexed.
    #   Spaces that aren't in the list aren't indexed. A space in the list
    #   must exist. Otherwise, Amazon Kendra logs an error when the data
    #   source is synchronized. If a space is in both the `IncludeSpaces`
    #   and the `ExcludeSpaces` list, the space is excluded.
    #   @return [Array<String>]
    #
    # @!attribute [rw] exclude_spaces
    #   A list of space keys of Confluence spaces. If you include a key, the
    #   blogs, documents, and attachments in the space are not indexed. If a
    #   space is in both the `ExcludeSpaces` and the `IncludeSpaces` list,
    #   the space is excluded.
    #   @return [Array<String>]
    #
    # @!attribute [rw] space_field_mappings
    #   Maps attributes or field names of Confluence spaces to Amazon Kendra
    #   index field names. To create custom fields, use the `UpdateIndex`
    #   API before you map to Confluence fields. For more information, see
    #   [Mapping data source fields][1]. The Confluence data source field
    #   names must exist in your Confluence custom metadata.
    #
    #   If you specify the `SpaceFieldMappings` parameter, you must specify
    #   at least one field mapping.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
    #   @return [Array<Types::ConfluenceSpaceToIndexFieldMapping>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ConfluenceSpaceConfiguration AWS API Documentation
    #
    class ConfluenceSpaceConfiguration < Struct.new(
      :crawl_personal_spaces,
      :crawl_archived_spaces,
      :include_spaces,
      :exclude_spaces,
      :space_field_mappings)
      SENSITIVE = []
      include Aws::Structure
    end

    # Maps attributes or field names of Confluence spaces to Amazon Kendra
    # index field names. To create custom fields, use the `UpdateIndex` API
    # before you map to Confluence fields. For more information, see
    # [Mapping data source fields][1]. The Confluence data source field
    # names must exist in your Confluence custom metadata.
    #
    #
    #
    # [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
    #
    # @!attribute [rw] data_source_field_name
    #   The name of the field in the data source.
    #   @return [String]
    #
    # @!attribute [rw] date_field_format
    #   The format for date fields in the data source. If the field
    #   specified in `DataSourceFieldName` is a date field you must specify
    #   the date format. If the field is not a date field, an exception is
    #   thrown.
    #   @return [String]
    #
    # @!attribute [rw] index_field_name
    #   The name of the index field to map to the Confluence data source
    #   field. The index field type must match the Confluence field type.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ConfluenceSpaceToIndexFieldMapping AWS API Documentation
    #
    class ConfluenceSpaceToIndexFieldMapping < Struct.new(
      :data_source_field_name,
      :date_field_format,
      :index_field_name)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides the configuration information that's required to connect to
    # a database.
    #
    # @!attribute [rw] database_host
    #   The name of the host for the database. Can be either a string
    #   (host.subdomain.domain.tld) or an IPv4 or IPv6 address.
    #   @return [String]
    #
    # @!attribute [rw] database_port
    #   The port that the database uses for connections.
    #   @return [Integer]
    #
    # @!attribute [rw] database_name
    #   The name of the database containing the document data.
    #   @return [String]
    #
    # @!attribute [rw] table_name
    #   The name of the table that contains the document data.
    #   @return [String]
    #
    # @!attribute [rw] secret_arn
    #   The Amazon Resource Name (ARN) of credentials stored in Secrets
    #   Manager. The credentials should be a user/password pair. For more
    #   information, see [Using a Database Data Source][1]. For more
    #   information about Secrets Manager, see [ What Is Secrets Manager][2]
    #   in the <i> Secrets Manager </i> user guide.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/data-source-database.html
    #   [2]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ConnectionConfiguration AWS API Documentation
    #
    class ConnectionConfiguration < Struct.new(
      :database_host,
      :database_port,
      :database_name,
      :table_name,
      :secret_arn)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides the configuration information for your content sources, such
    # as data sources, FAQs, and content indexed directly via
    # [BatchPutDocument][1].
    #
    #
    #
    # [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_BatchPutDocument.html
    #
    # @!attribute [rw] data_source_ids
    #   The identifier of the data sources you want to use for your Amazon
    #   Kendra experience.
    #   @return [Array<String>]
    #
    # @!attribute [rw] faq_ids
    #   The identifier of the FAQs that you want to use for your Amazon
    #   Kendra experience.
    #   @return [Array<String>]
    #
    # @!attribute [rw] direct_put_content
    #   `TRUE` to use documents you indexed directly using the
    #   `BatchPutDocument` API.
    #   @return [Boolean]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ContentSourceConfiguration AWS API Documentation
    #
    class ContentSourceConfiguration < Struct.new(
      :data_source_ids,
      :faq_ids,
      :direct_put_content)
      SENSITIVE = []
      include Aws::Structure
    end

    # A corrected misspelled word in a query.
    #
    # @!attribute [rw] begin_offset
    #   The zero-based location in the response string or text where the
    #   corrected word starts.
    #   @return [Integer]
    #
    # @!attribute [rw] end_offset
    #   The zero-based location in the response string or text where the
    #   corrected word ends.
    #   @return [Integer]
    #
    # @!attribute [rw] term
    #   The string or text of a misspelled word in a query.
    #   @return [String]
    #
    # @!attribute [rw] corrected_term
    #   The string or text of a corrected misspelled word in a query.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/Correction AWS API Documentation
    #
    class Correction < Struct.new(
      :begin_offset,
      :end_offset,
      :term,
      :corrected_term)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] index_id
    #   The identifier of the index to create an access control
    #   configuration for your documents.
    #   @return [String]
    #
    # @!attribute [rw] name
    #   A name for the access control configuration.
    #   @return [String]
    #
    # @!attribute [rw] description
    #   A description for the access control configuration.
    #   @return [String]
    #
    # @!attribute [rw] access_control_list
    #   Information on principals (users and/or groups) and which documents
    #   they should have access to. This is useful for user context
    #   filtering, where search results are filtered based on the user or
    #   their group access to documents.
    #   @return [Array<Types::Principal>]
    #
    # @!attribute [rw] hierarchical_access_control_list
    #   The list of [principal][1] lists that define the hierarchy for which
    #   documents users should have access to.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_Principal.html
    #   @return [Array<Types::HierarchicalPrincipal>]
    #
    # @!attribute [rw] client_token
    #   A token that you provide to identify the request to create an access
    #   control configuration. Multiple calls to the
    #   `CreateAccessControlConfiguration` API with the same client token
    #   will create only one access control configuration.
    #
    #   **A suitable default value is auto-generated.** You should normally
    #   not need to pass this option.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateAccessControlConfigurationRequest AWS API Documentation
    #
    class CreateAccessControlConfigurationRequest < Struct.new(
      :index_id,
      :name,
      :description,
      :access_control_list,
      :hierarchical_access_control_list,
      :client_token)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] id
    #   The identifier of the access control configuration for your
    #   documents in an index.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateAccessControlConfigurationResponse AWS API Documentation
    #
    class CreateAccessControlConfigurationResponse < Struct.new(
      :id)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] name
    #   A name for the data source connector.
    #   @return [String]
    #
    # @!attribute [rw] index_id
    #   The identifier of the index you want to use with the data source
    #   connector.
    #   @return [String]
    #
    # @!attribute [rw] type
    #   The type of data source repository. For example, `SHAREPOINT`.
    #   @return [String]
    #
    # @!attribute [rw] configuration
    #   Configuration information to connect to your data source repository.
    #
    #   You can't specify the `Configuration` parameter when the `Type`
    #   parameter is set to `CUSTOM`. If you do, you receive a
    #   `ValidationException` exception.
    #
    #   The `Configuration` parameter is required for all other data
    #   sources.
    #   @return [Types::DataSourceConfiguration]
    #
    # @!attribute [rw] vpc_configuration
    #   Configuration information for an Amazon Virtual Private Cloud to
    #   connect to your data source. For more information, see [Configuring
    #   a VPC][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html
    #   @return [Types::DataSourceVpcConfiguration]
    #
    # @!attribute [rw] description
    #   A description for the data source connector.
    #   @return [String]
    #
    # @!attribute [rw] schedule
    #   Sets the frequency for Amazon Kendra to check the documents in your
    #   data source repository and update the index. If you don't set a
    #   schedule Amazon Kendra will not periodically update the index. You
    #   can call the `StartDataSourceSyncJob` API to update the index.
    #
    #   Specify a `cron-` format schedule string or an empty string to
    #   indicate that the index is updated on demand.
    #
    #   You can't specify the `Schedule` parameter when the `Type`
    #   parameter is set to `CUSTOM`. If you do, you receive a
    #   `ValidationException` exception.
    #   @return [String]
    #
    # @!attribute [rw] role_arn
    #   The Amazon Resource Name (ARN) of an IAM role with permission to
    #   access the data source and required resources. For more information,
    #   see [IAM access roles for Amazon Kendra.][1].
    #
    #   You can't specify the `RoleArn` parameter when the `Type` parameter
    #   is set to `CUSTOM`. If you do, you receive a `ValidationException`
    #   exception.
    #
    #   The `RoleArn` parameter is required for all other data sources.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html
    #   @return [String]
    #
    # @!attribute [rw] tags
    #   A list of key-value pairs that identify or categorize the data
    #   source connector. You can also use tags to help control access to
    #   the data source connector. Tag keys and values can consist of
    #   Unicode letters, digits, white space, and any of the following
    #   symbols: \_ . : / = + - @.
    #   @return [Array<Types::Tag>]
    #
    # @!attribute [rw] client_token
    #   A token that you provide to identify the request to create a data
    #   source connector. Multiple calls to the `CreateDataSource` API with
    #   the same client token will create only one data source connector.
    #
    #   **A suitable default value is auto-generated.** You should normally
    #   not need to pass this option.
    #   @return [String]
    #
    # @!attribute [rw] language_code
    #   The code for a language. This allows you to support a language for
    #   all documents when creating the data source connector. English is
    #   supported by default. For more information on supported languages,
    #   including their codes, see [Adding documents in languages other than
    #   English][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html
    #   @return [String]
    #
    # @!attribute [rw] custom_document_enrichment_configuration
    #   Configuration information for altering document metadata and content
    #   during the document ingestion process.
    #
    #   For more information on how to create, modify and delete document
    #   metadata, or make other content alterations when you ingest
    #   documents into Amazon Kendra, see [Customizing document metadata
    #   during the ingestion process][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html
    #   @return [Types::CustomDocumentEnrichmentConfiguration]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateDataSourceRequest AWS API Documentation
    #
    class CreateDataSourceRequest < Struct.new(
      :name,
      :index_id,
      :type,
      :configuration,
      :vpc_configuration,
      :description,
      :schedule,
      :role_arn,
      :tags,
      :client_token,
      :language_code,
      :custom_document_enrichment_configuration)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] id
    #   The identifier of the data source connector.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateDataSourceResponse AWS API Documentation
    #
    class CreateDataSourceResponse < Struct.new(
      :id)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] name
    #   A name for your Amazon Kendra experience.
    #   @return [String]
    #
    # @!attribute [rw] index_id
    #   The identifier of the index for your Amazon Kendra experience.
    #   @return [String]
    #
    # @!attribute [rw] role_arn
    #   The Amazon Resource Name (ARN) of an IAM role with permission to
    #   access `Query` API, `GetQuerySuggestions` API, and other required
    #   APIs. The role also must include permission to access IAM Identity
    #   Center that stores your user and group information. For more
    #   information, see [IAM access roles for Amazon Kendra][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html
    #   @return [String]
    #
    # @!attribute [rw] configuration
    #   Configuration information for your Amazon Kendra experience. This
    #   includes `ContentSourceConfiguration`, which specifies the data
    #   source IDs and/or FAQ IDs, and `UserIdentityConfiguration`, which
    #   specifies the user or group information to grant access to your
    #   Amazon Kendra experience.
    #   @return [Types::ExperienceConfiguration]
    #
    # @!attribute [rw] description
    #   A description for your Amazon Kendra experience.
    #   @return [String]
    #
    # @!attribute [rw] client_token
    #   A token that you provide to identify the request to create your
    #   Amazon Kendra experience. Multiple calls to the `CreateExperience`
    #   API with the same client token creates only one Amazon Kendra
    #   experience.
    #
    #   **A suitable default value is auto-generated.** You should normally
    #   not need to pass this option.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateExperienceRequest AWS API Documentation
    #
    class CreateExperienceRequest < Struct.new(
      :name,
      :index_id,
      :role_arn,
      :configuration,
      :description,
      :client_token)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] id
    #   The identifier of your Amazon Kendra experience.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateExperienceResponse AWS API Documentation
    #
    class CreateExperienceResponse < Struct.new(
      :id)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] index_id
    #   The identifier of the index for the FAQ.
    #   @return [String]
    #
    # @!attribute [rw] name
    #   A name for the FAQ.
    #   @return [String]
    #
    # @!attribute [rw] description
    #   A description for the FAQ.
    #   @return [String]
    #
    # @!attribute [rw] s3_path
    #   The path to the FAQ file in S3.
    #   @return [Types::S3Path]
    #
    # @!attribute [rw] role_arn
    #   The Amazon Resource Name (ARN) of an IAM role with permission to
    #   access the S3 bucket that contains the FAQs. For more information,
    #   see [IAM access roles for Amazon Kendra][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html
    #   @return [String]
    #
    # @!attribute [rw] tags
    #   A list of key-value pairs that identify the FAQ. You can use the
    #   tags to identify and organize your resources and to control access
    #   to resources.
    #   @return [Array<Types::Tag>]
    #
    # @!attribute [rw] file_format
    #   The format of the FAQ input file. You can choose between a basic CSV
    #   format, a CSV format that includes customs attributes in a header,
    #   and a JSON format that includes custom attributes.
    #
    #   The default format is CSV.
    #
    #   The format must match the format of the file stored in the S3 bucket
    #   identified in the `S3Path` parameter.
    #
    #   For more information, see [Adding questions and answers][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/in-creating-faq.html
    #   @return [String]
    #
    # @!attribute [rw] client_token
    #   A token that you provide to identify the request to create a FAQ.
    #   Multiple calls to the `CreateFaqRequest` API with the same client
    #   token will create only one FAQ.
    #
    #   **A suitable default value is auto-generated.** You should normally
    #   not need to pass this option.
    #   @return [String]
    #
    # @!attribute [rw] language_code
    #   The code for a language. This allows you to support a language for
    #   the FAQ document. English is supported by default. For more
    #   information on supported languages, including their codes, see
    #   [Adding documents in languages other than English][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateFaqRequest AWS API Documentation
    #
    class CreateFaqRequest < Struct.new(
      :index_id,
      :name,
      :description,
      :s3_path,
      :role_arn,
      :tags,
      :file_format,
      :client_token,
      :language_code)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] id
    #   The identifier of the FAQ.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateFaqResponse AWS API Documentation
    #
    class CreateFaqResponse < Struct.new(
      :id)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] index_id
    #   The identifier of the index that you want to use for featuring
    #   results.
    #   @return [String]
    #
    # @!attribute [rw] featured_results_set_name
    #   A name for the set of featured results.
    #   @return [String]
    #
    # @!attribute [rw] description
    #   A description for the set of featured results.
    #   @return [String]
    #
    # @!attribute [rw] client_token
    #   A token that you provide to identify the request to create a set of
    #   featured results. Multiple calls to the `CreateFeaturedResultsSet`
    #   API with the same client token will create only one featured results
    #   set.
    #   @return [String]
    #
    # @!attribute [rw] status
    #   The current status of the set of featured results. When the value is
    #   `ACTIVE`, featured results are ready for use. You can still
    #   configure your settings before setting the status to `ACTIVE`. You
    #   can set the status to `ACTIVE` or `INACTIVE` using the
    #   [UpdateFeaturedResultsSet][1] API. The queries you specify for
    #   featured results must be unique per featured results set for each
    #   index, whether the status is `ACTIVE` or `INACTIVE`.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateFeaturedResultsSet.html
    #   @return [String]
    #
    # @!attribute [rw] query_texts
    #   A list of queries for featuring results. For more information on the
    #   list of queries, see [FeaturedResultsSet][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_FeaturedResultsSet.html
    #   @return [Array<String>]
    #
    # @!attribute [rw] featured_documents
    #   A list of document IDs for the documents you want to feature at the
    #   top of the search results page. For more information on the list of
    #   documents, see [FeaturedResultsSet][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_FeaturedResultsSet.html
    #   @return [Array<Types::FeaturedDocument>]
    #
    # @!attribute [rw] tags
    #   A list of key-value pairs that identify or categorize the featured
    #   results set. You can also use tags to help control access to the
    #   featured results set. Tag keys and values can consist of Unicode
    #   letters, digits, white space, and any of the following symbols:\_ .
    #   \: / = + - @.
    #   @return [Array<Types::Tag>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateFeaturedResultsSetRequest AWS API Documentation
    #
    class CreateFeaturedResultsSetRequest < Struct.new(
      :index_id,
      :featured_results_set_name,
      :description,
      :client_token,
      :status,
      :query_texts,
      :featured_documents,
      :tags)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] featured_results_set
    #   Information on the set of featured results. This includes the
    #   identifier of the featured results set, whether the featured results
    #   set is active or inactive, when the featured results set was
    #   created, and more.
    #   @return [Types::FeaturedResultsSet]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateFeaturedResultsSetResponse AWS API Documentation
    #
    class CreateFeaturedResultsSetResponse < Struct.new(
      :featured_results_set)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] name
    #   A name for the index.
    #   @return [String]
    #
    # @!attribute [rw] edition
    #   The Amazon Kendra edition to use for the index. Choose
    #   `DEVELOPER_EDITION` for indexes intended for development, testing,
    #   or proof of concept. Use `ENTERPRISE_EDITION` for production. Once
    #   you set the edition for an index, it can't be changed.
    #
    #   The `Edition` parameter is optional. If you don't supply a value,
    #   the default is `ENTERPRISE_EDITION`.
    #
    #   For more information on quota limits for Enterprise and Developer
    #   editions, see [Quotas][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
    #   @return [String]
    #
    # @!attribute [rw] role_arn
    #   The Amazon Resource Name (ARN) of an IAM role with permission to
    #   access your Amazon CloudWatch logs and metrics. For more
    #   information, see [IAM access roles for Amazon Kendra][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html
    #   @return [String]
    #
    # @!attribute [rw] server_side_encryption_configuration
    #   The identifier of the KMS customer managed key (CMK) that's used to
    #   encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't
    #   support asymmetric CMKs.
    #   @return [Types::ServerSideEncryptionConfiguration]
    #
    # @!attribute [rw] description
    #   A description for the index.
    #   @return [String]
    #
    # @!attribute [rw] client_token
    #   A token that you provide to identify the request to create an index.
    #   Multiple calls to the `CreateIndex` API with the same client token
    #   will create only one index.
    #
    #   **A suitable default value is auto-generated.** You should normally
    #   not need to pass this option.
    #   @return [String]
    #
    # @!attribute [rw] tags
    #   A list of key-value pairs that identify or categorize the index. You
    #   can also use tags to help control access to the index. Tag keys and
    #   values can consist of Unicode letters, digits, white space, and any
    #   of the following symbols: \_ . : / = + - @.
    #   @return [Array<Types::Tag>]
    #
    # @!attribute [rw] user_token_configurations
    #   The user token configuration.
    #   @return [Array<Types::UserTokenConfiguration>]
    #
    # @!attribute [rw] user_context_policy
    #   The user context policy.
    #
    #   ATTRIBUTE\_FILTER
    #
    #   : All indexed content is searchable and displayable for all users.
    #     If you want to filter search results on user context, you can use
    #     the attribute filters of `_user_id` and `_group_ids` or you can
    #     provide user and group information in `UserContext`.
    #
    #   USER\_TOKEN
    #
    #   : Enables token-based user access control to filter search results
    #     on user context. All documents with no access control and all
    #     documents accessible to the user will be searchable and
    #     displayable.
    #   @return [String]
    #
    # @!attribute [rw] user_group_resolution_configuration
    #   Gets users and groups from IAM Identity Center identity source. To
    #   configure this, see [UserGroupResolutionConfiguration][1]. This is
    #   useful for user context filtering, where search results are filtered
    #   based on the user or their group access to documents.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_UserGroupResolutionConfiguration.html
    #   @return [Types::UserGroupResolutionConfiguration]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateIndexRequest AWS API Documentation
    #
    class CreateIndexRequest < Struct.new(
      :name,
      :edition,
      :role_arn,
      :server_side_encryption_configuration,
      :description,
      :client_token,
      :tags,
      :user_token_configurations,
      :user_context_policy,
      :user_group_resolution_configuration)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] id
    #   The identifier of the index. Use this identifier when you query an
    #   index, set up a data source, or index a document.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateIndexResponse AWS API Documentation
    #
    class CreateIndexResponse < Struct.new(
      :id)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] index_id
    #   The identifier of the index you want to create a query suggestions
    #   block list for.
    #   @return [String]
    #
    # @!attribute [rw] name
    #   A name for the block list.
    #
    #   For example, the name 'offensive-words', which includes all
    #   offensive words that could appear in user queries and need to be
    #   blocked from suggestions.
    #   @return [String]
    #
    # @!attribute [rw] description
    #   A description for the block list.
    #
    #   For example, the description "List of all offensive words that can
    #   appear in user queries and need to be blocked from suggestions."
    #   @return [String]
    #
    # @!attribute [rw] source_s3_path
    #   The S3 path to your block list text file in your S3 bucket.
    #
    #   Each block word or phrase should be on a separate line in a text
    #   file.
    #
    #   For information on the current quota limits for block lists, see
    #   [Quotas for Amazon Kendra][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
    #   @return [Types::S3Path]
    #
    # @!attribute [rw] client_token
    #   A token that you provide to identify the request to create a query
    #   suggestions block list.
    #
    #   **A suitable default value is auto-generated.** You should normally
    #   not need to pass this option.
    #   @return [String]
    #
    # @!attribute [rw] role_arn
    #   The Amazon Resource Name (ARN) of an IAM role with permission to
    #   access your S3 bucket that contains the block list text file. For
    #   more information, see [IAM access roles for Amazon Kendra][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html
    #   @return [String]
    #
    # @!attribute [rw] tags
    #   A list of key-value pairs that identify or categorize the block
    #   list. Tag keys and values can consist of Unicode letters, digits,
    #   white space, and any of the following symbols: \_ . : / = + - @.
    #   @return [Array<Types::Tag>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateQuerySuggestionsBlockListRequest AWS API Documentation
    #
    class CreateQuerySuggestionsBlockListRequest < Struct.new(
      :index_id,
      :name,
      :description,
      :source_s3_path,
      :client_token,
      :role_arn,
      :tags)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] id
    #   The identifier of the block list.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateQuerySuggestionsBlockListResponse AWS API Documentation
    #
    class CreateQuerySuggestionsBlockListResponse < Struct.new(
      :id)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] index_id
    #   The identifier of the index for the thesaurus.
    #   @return [String]
    #
    # @!attribute [rw] name
    #   A name for the thesaurus.
    #   @return [String]
    #
    # @!attribute [rw] description
    #   A description for the thesaurus.
    #   @return [String]
    #
    # @!attribute [rw] role_arn
    #   The Amazon Resource Name (ARN) of an IAM role with permission to
    #   access your S3 bucket that contains the thesaurus file. For more
    #   information, see [IAM access roles for Amazon Kendra][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html
    #   @return [String]
    #
    # @!attribute [rw] tags
    #   A list of key-value pairs that identify or categorize the thesaurus.
    #   You can also use tags to help control access to the thesaurus. Tag
    #   keys and values can consist of Unicode letters, digits, white space,
    #   and any of the following symbols: \_ . : / = + - @.
    #   @return [Array<Types::Tag>]
    #
    # @!attribute [rw] source_s3_path
    #   The path to the thesaurus file in S3.
    #   @return [Types::S3Path]
    #
    # @!attribute [rw] client_token
    #   A token that you provide to identify the request to create a
    #   thesaurus. Multiple calls to the `CreateThesaurus` API with the same
    #   client token will create only one thesaurus.
    #
    #   **A suitable default value is auto-generated.** You should normally
    #   not need to pass this option.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateThesaurusRequest AWS API Documentation
    #
    class CreateThesaurusRequest < Struct.new(
      :index_id,
      :name,
      :description,
      :role_arn,
      :tags,
      :source_s3_path,
      :client_token)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] id
    #   The identifier of the thesaurus.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateThesaurusResponse AWS API Documentation
    #
    class CreateThesaurusResponse < Struct.new(
      :id)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides the configuration information for altering document metadata
    # and content during the document ingestion process.
    #
    # For more information, see [Customizing document metadata during the
    # ingestion process][1].
    #
    #
    #
    # [1]: https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html
    #
    # @!attribute [rw] inline_configurations
    #   Configuration information to alter document attributes or metadata
    #   fields and content when ingesting documents into Amazon Kendra.
    #   @return [Array<Types::InlineCustomDocumentEnrichmentConfiguration>]
    #
    # @!attribute [rw] pre_extraction_hook_configuration
    #   Configuration information for invoking a Lambda function in Lambda
    #   on the original or raw documents before extracting their metadata
    #   and text. You can use a Lambda function to apply advanced logic for
    #   creating, modifying, or deleting document metadata and content. For
    #   more information, see [Advanced data manipulation][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html#advanced-data-manipulation
    #   @return [Types::HookConfiguration]
    #
    # @!attribute [rw] post_extraction_hook_configuration
    #   Configuration information for invoking a Lambda function in Lambda
    #   on the structured documents with their metadata and text extracted.
    #   You can use a Lambda function to apply advanced logic for creating,
    #   modifying, or deleting document metadata and content. For more
    #   information, see [Advanced data manipulation][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html#advanced-data-manipulation
    #   @return [Types::HookConfiguration]
    #
    # @!attribute [rw] role_arn
    #   The Amazon Resource Name (ARN) of a role with permission to run
    #   `PreExtractionHookConfiguration` and
    #   `PostExtractionHookConfiguration` for altering document metadata and
    #   content during the document ingestion process. For more information,
    #   see [IAM roles for Amazon Kendra][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CustomDocumentEnrichmentConfiguration AWS API Documentation
    #
    class CustomDocumentEnrichmentConfiguration < Struct.new(
      :inline_configurations,
      :pre_extraction_hook_configuration,
      :post_extraction_hook_configuration,
      :role_arn)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides the configuration information for an Amazon Kendra data
    # source.
    #
    # @!attribute [rw] s3_configuration
    #   Provides the configuration information to connect to an Amazon S3
    #   bucket as your data source.
    #
    #   <note markdown="1"> Amazon Kendra now supports an upgraded Amazon S3 connector.
    #
    #    You must now use the [TemplateConfiguration][1] object instead of
    #   the `S3DataSourceConfiguration` object to configure your connector.
    #
    #    Connectors configured using the older console and API architecture
    #   will continue to function as configured. However, you won't be able
    #   to edit or update them. If you want to edit or update your connector
    #   configuration, you must create a new connector.
    #
    #    We recommended migrating your connector workflow to the upgraded
    #   version. Support for connectors configured using the older
    #   architecture is scheduled to end by June 2024.
    #
    #    </note>
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html
    #   @return [Types::S3DataSourceConfiguration]
    #
    # @!attribute [rw] share_point_configuration
    #   Provides the configuration information to connect to Microsoft
    #   SharePoint as your data source.
    #   @return [Types::SharePointConfiguration]
    #
    # @!attribute [rw] database_configuration
    #   Provides the configuration information to connect to a database as
    #   your data source.
    #   @return [Types::DatabaseConfiguration]
    #
    # @!attribute [rw] salesforce_configuration
    #   Provides the configuration information to connect to Salesforce as
    #   your data source.
    #   @return [Types::SalesforceConfiguration]
    #
    # @!attribute [rw] one_drive_configuration
    #   Provides the configuration information to connect to Microsoft
    #   OneDrive as your data source.
    #   @return [Types::OneDriveConfiguration]
    #
    # @!attribute [rw] service_now_configuration
    #   Provides the configuration information to connect to ServiceNow as
    #   your data source.
    #   @return [Types::ServiceNowConfiguration]
    #
    # @!attribute [rw] confluence_configuration
    #   Provides the configuration information to connect to Confluence as
    #   your data source.
    #   @return [Types::ConfluenceConfiguration]
    #
    # @!attribute [rw] google_drive_configuration
    #   Provides the configuration information to connect to Google Drive as
    #   your data source.
    #   @return [Types::GoogleDriveConfiguration]
    #
    # @!attribute [rw] web_crawler_configuration
    #   Provides the configuration information required for Amazon Kendra
    #   Web Crawler.
    #   @return [Types::WebCrawlerConfiguration]
    #
    # @!attribute [rw] work_docs_configuration
    #   Provides the configuration information to connect to Amazon WorkDocs
    #   as your data source.
    #   @return [Types::WorkDocsConfiguration]
    #
    # @!attribute [rw] fsx_configuration
    #   Provides the configuration information to connect to Amazon FSx as
    #   your data source.
    #
    #   <note markdown="1"> Amazon Kendra now supports an upgraded Amazon FSx Windows connector.
    #
    #    You must now use the [TemplateConfiguration][1] object instead of
    #   the `FsxConfiguration` object to configure your connector.
    #
    #    Connectors configured using the older console and API architecture
    #   will continue to function as configured. However, you won't be able
    #   to edit or update them. If you want to edit or update your connector
    #   configuration, you must create a new connector.
    #
    #    We recommended migrating your connector workflow to the upgraded
    #   version. Support for connectors configured using the older
    #   architecture is scheduled to end by June 2024.
    #
    #    </note>
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html
    #   @return [Types::FsxConfiguration]
    #
    # @!attribute [rw] slack_configuration
    #   Provides the configuration information to connect to Slack as your
    #   data source.
    #
    #   <note markdown="1"> Amazon Kendra now supports an upgraded Slack connector.
    #
    #    You must now use the [TemplateConfiguration][1] object instead of
    #   the `SlackConfiguration` object to configure your connector.
    #
    #    Connectors configured using the older console and API architecture
    #   will continue to function as configured. However, you won't be able
    #   to edit or update them. If you want to edit or update your connector
    #   configuration, you must create a new connector.
    #
    #    We recommended migrating your connector workflow to the upgraded
    #   version. Support for connectors configured using the older
    #   architecture is scheduled to end by June 2024.
    #
    #    </note>
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html
    #   @return [Types::SlackConfiguration]
    #
    # @!attribute [rw] box_configuration
    #   Provides the configuration information to connect to Box as your
    #   data source.
    #   @return [Types::BoxConfiguration]
    #
    # @!attribute [rw] quip_configuration
    #   Provides the configuration information to connect to Quip as your
    #   data source.
    #   @return [Types::QuipConfiguration]
    #
    # @!attribute [rw] jira_configuration
    #   Provides the configuration information to connect to Jira as your
    #   data source.
    #   @return [Types::JiraConfiguration]
    #
    # @!attribute [rw] git_hub_configuration
    #   Provides the configuration information to connect to GitHub as your
    #   data source.
    #
    #   <note markdown="1"> Amazon Kendra now supports an upgraded GitHub connector.
    #
    #    You must now use the [TemplateConfiguration][1] object instead of
    #   the `GitHubConfiguration` object to configure your connector.
    #
    #    Connectors configured using the older console and API architecture
    #   will continue to function as configured. However, you won’t be able
    #   to edit or update them. If you want to edit or update your connector
    #   configuration, you must create a new connector.
    #
    #    We recommended migrating your connector workflow to the upgraded
    #   version. Support for connectors configured using the older
    #   architecture is scheduled to end by June 2024.
    #
    #    </note>
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html
    #   @return [Types::GitHubConfiguration]
    #
    # @!attribute [rw] alfresco_configuration
    #   Provides the configuration information to connect to Alfresco as
    #   your data source.
    #
    #   <note markdown="1"> Support for `AlfrescoConfiguration` ended May 2023. We recommend
    #   migrating to or using the Alfresco data source template schema /
    #   [TemplateConfiguration][1] API.
    #
    #    </note>
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html
    #   @return [Types::AlfrescoConfiguration]
    #
    # @!attribute [rw] template_configuration
    #   Provides a template for the configuration information to connect to
    #   your data source.
    #   @return [Types::TemplateConfiguration]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DataSourceConfiguration AWS API Documentation
    #
    class DataSourceConfiguration < Struct.new(
      :s3_configuration,
      :share_point_configuration,
      :database_configuration,
      :salesforce_configuration,
      :one_drive_configuration,
      :service_now_configuration,
      :confluence_configuration,
      :google_drive_configuration,
      :web_crawler_configuration,
      :work_docs_configuration,
      :fsx_configuration,
      :slack_configuration,
      :box_configuration,
      :quip_configuration,
      :jira_configuration,
      :git_hub_configuration,
      :alfresco_configuration,
      :template_configuration)
      SENSITIVE = []
      include Aws::Structure
    end

    # Data source information for user context filtering.
    #
    # @!attribute [rw] group_id
    #   The identifier of the group you want to add to your list of groups.
    #   This is for filtering search results based on the groups' access to
    #   documents.
    #   @return [String]
    #
    # @!attribute [rw] data_source_id
    #   The identifier of the data source group you want to add to your list
    #   of data source groups. This is for filtering search results based on
    #   the groups' access to documents in that data source.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DataSourceGroup AWS API Documentation
    #
    class DataSourceGroup < Struct.new(
      :group_id,
      :data_source_id)
      SENSITIVE = []
      include Aws::Structure
    end

    # Summary information for a Amazon Kendra data source.
    #
    # @!attribute [rw] name
    #   The name of the data source.
    #   @return [String]
    #
    # @!attribute [rw] id
    #   The identifier for the data source.
    #   @return [String]
    #
    # @!attribute [rw] type
    #   The type of the data source.
    #   @return [String]
    #
    # @!attribute [rw] created_at
    #   The Unix timestamp when the data source connector was created.
    #   @return [Time]
    #
    # @!attribute [rw] updated_at
    #   The Unix timestamp when the data source connector was last updated.
    #   @return [Time]
    #
    # @!attribute [rw] status
    #   The status of the data source. When the status is `ACTIVE` the data
    #   source is ready to use.
    #   @return [String]
    #
    # @!attribute [rw] language_code
    #   The code for a language. This shows a supported language for all
    #   documents in the data source. English is supported by default. For
    #   more information on supported languages, including their codes, see
    #   [Adding documents in languages other than English][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DataSourceSummary AWS API Documentation
    #
    class DataSourceSummary < Struct.new(
      :name,
      :id,
      :type,
      :created_at,
      :updated_at,
      :status,
      :language_code)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides information about a data source synchronization job.
    #
    # @!attribute [rw] execution_id
    #   A identifier for the synchronization job.
    #   @return [String]
    #
    # @!attribute [rw] start_time
    #   The Unix timestamp when the synchronization job started.
    #   @return [Time]
    #
    # @!attribute [rw] end_time
    #   The Unix timestamp when the synchronization job completed.
    #   @return [Time]
    #
    # @!attribute [rw] status
    #   The execution status of the synchronization job. When the `Status`
    #   field is set to `SUCCEEDED`, the synchronization job is done. If the
    #   status code is set to `FAILED`, the `ErrorCode` and `ErrorMessage`
    #   fields give you the reason for the failure.
    #   @return [String]
    #
    # @!attribute [rw] error_message
    #   If the `Status` field is set to `ERROR`, the `ErrorMessage` field
    #   contains a description of the error that caused the synchronization
    #   to fail.
    #   @return [String]
    #
    # @!attribute [rw] error_code
    #   If the `Status` field is set to `FAILED`, the `ErrorCode` field
    #   indicates the reason the synchronization failed.
    #   @return [String]
    #
    # @!attribute [rw] data_source_error_code
    #   If the reason that the synchronization failed is due to an error
    #   with the underlying data source, this field contains a code that
    #   identifies the error.
    #   @return [String]
    #
    # @!attribute [rw] metrics
    #   Maps a batch delete document request to a specific data source sync
    #   job. This is optional and should only be supplied when documents are
    #   deleted by a data source connector.
    #   @return [Types::DataSourceSyncJobMetrics]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DataSourceSyncJob AWS API Documentation
    #
    class DataSourceSyncJob < Struct.new(
      :execution_id,
      :start_time,
      :end_time,
      :status,
      :error_message,
      :error_code,
      :data_source_error_code,
      :metrics)
      SENSITIVE = []
      include Aws::Structure
    end

    # Maps a particular data source sync job to a particular data source.
    #
    # @!attribute [rw] data_source_id
    #   The ID of the data source that is running the sync job.
    #   @return [String]
    #
    # @!attribute [rw] data_source_sync_job_id
    #   The ID of the sync job that is running on the data source.
    #
    #   If the ID of a sync job is not provided and there is a sync job
    #   running, then the ID of this sync job is used and metrics are
    #   generated for this sync job.
    #
    #   If the ID of a sync job is not provided and there is no sync job
    #   running, then no metrics are generated and documents are
    #   indexed/deleted at the index level without sync job metrics
    #   included.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DataSourceSyncJobMetricTarget AWS API Documentation
    #
    class DataSourceSyncJobMetricTarget < Struct.new(
      :data_source_id,
      :data_source_sync_job_id)
      SENSITIVE = []
      include Aws::Structure
    end

    # Maps a batch delete document request to a specific data source sync
    # job. This is optional and should only be supplied when documents are
    # deleted by a data source connector.
    #
    # @!attribute [rw] documents_added
    #   The number of documents added from the data source up to now in the
    #   data source sync.
    #   @return [String]
    #
    # @!attribute [rw] documents_modified
    #   The number of documents modified in the data source up to now in the
    #   data source sync run.
    #   @return [String]
    #
    # @!attribute [rw] documents_deleted
    #   The number of documents deleted from the data source up to now in
    #   the data source sync run.
    #   @return [String]
    #
    # @!attribute [rw] documents_failed
    #   The number of documents that failed to sync from the data source up
    #   to now in the data source sync run.
    #   @return [String]
    #
    # @!attribute [rw] documents_scanned
    #   The current number of documents crawled by the current sync job in
    #   the data source.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DataSourceSyncJobMetrics AWS API Documentation
    #
    class DataSourceSyncJobMetrics < Struct.new(
      :documents_added,
      :documents_modified,
      :documents_deleted,
      :documents_failed,
      :documents_scanned)
      SENSITIVE = []
      include Aws::Structure
    end

    # Maps attributes or field names of the documents synced from the data
    # source to Amazon Kendra index field names. You can set up field
    # mappings for each data source when calling [CreateDataSource][1] or
    # [UpdateDataSource][2] API. To create custom fields, use the
    # `UpdateIndex` API to first create an index field and then map to the
    # data source field. For more information, see [Mapping data source
    # fields][3].
    #
    #
    #
    # [1]: https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html
    # [2]: https://docs.aws.amazon.com/kendra/latest/APIReference/API_UpdateDataSource.html
    # [3]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
    #
    # @!attribute [rw] data_source_field_name
    #   The name of the field in the data source. You must first create the
    #   index field using the `UpdateIndex` API.
    #   @return [String]
    #
    # @!attribute [rw] date_field_format
    #   The format for date fields in the data source. If the field
    #   specified in `DataSourceFieldName` is a date field, you must specify
    #   the date format. If the field is not a date field, an exception is
    #   thrown.
    #   @return [String]
    #
    # @!attribute [rw] index_field_name
    #   The name of the index field to map to the data source field. The
    #   index field type must match the data source field type.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DataSourceToIndexFieldMapping AWS API Documentation
    #
    class DataSourceToIndexFieldMapping < Struct.new(
      :data_source_field_name,
      :date_field_format,
      :index_field_name)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides the configuration information to connect to an Amazon VPC.
    #
    # @!attribute [rw] subnet_ids
    #   A list of identifiers for subnets within your Amazon VPC. The
    #   subnets should be able to connect to each other in the VPC, and they
    #   should have outgoing access to the Internet through a NAT device.
    #   @return [Array<String>]
    #
    # @!attribute [rw] security_group_ids
    #   A list of identifiers of security groups within your Amazon VPC. The
    #   security groups should enable Amazon Kendra to connect to the data
    #   source.
    #   @return [Array<String>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DataSourceVpcConfiguration AWS API Documentation
    #
    class DataSourceVpcConfiguration < Struct.new(
      :subnet_ids,
      :security_group_ids)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides the configuration information to an [Amazon Kendra supported
    # database][1].
    #
    #
    #
    # [1]: https://docs.aws.amazon.com/kendra/latest/dg/data-source-database.html
    #
    # @!attribute [rw] database_engine_type
    #   The type of database engine that runs the database.
    #   @return [String]
    #
    # @!attribute [rw] connection_configuration
    #   Configuration information that's required to connect to a database.
    #   @return [Types::ConnectionConfiguration]
    #
    # @!attribute [rw] vpc_configuration
    #   Provides the configuration information to connect to an Amazon VPC.
    #   @return [Types::DataSourceVpcConfiguration]
    #
    # @!attribute [rw] column_configuration
    #   Information about where the index should get the document
    #   information from the database.
    #   @return [Types::ColumnConfiguration]
    #
    # @!attribute [rw] acl_configuration
    #   Information about the database column that provides information for
    #   user context filtering.
    #   @return [Types::AclConfiguration]
    #
    # @!attribute [rw] sql_configuration
    #   Provides information about how Amazon Kendra uses quote marks around
    #   SQL identifiers when querying a database data source.
    #   @return [Types::SqlConfiguration]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DatabaseConfiguration AWS API Documentation
    #
    class DatabaseConfiguration < Struct.new(
      :database_engine_type,
      :connection_configuration,
      :vpc_configuration,
      :column_configuration,
      :acl_configuration,
      :sql_configuration)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] index_id
    #   The identifier of the index for an access control configuration.
    #   @return [String]
    #
    # @!attribute [rw] id
    #   The identifier of the access control configuration you want to
    #   delete.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteAccessControlConfigurationRequest AWS API Documentation
    #
    class DeleteAccessControlConfigurationRequest < Struct.new(
      :index_id,
      :id)
      SENSITIVE = []
      include Aws::Structure
    end

    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteAccessControlConfigurationResponse AWS API Documentation
    #
    class DeleteAccessControlConfigurationResponse < Aws::EmptyStructure; end

    # @!attribute [rw] id
    #   The identifier of the data source connector you want to delete.
    #   @return [String]
    #
    # @!attribute [rw] index_id
    #   The identifier of the index used with the data source connector.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteDataSourceRequest AWS API Documentation
    #
    class DeleteDataSourceRequest < Struct.new(
      :id,
      :index_id)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] id
    #   The identifier of your Amazon Kendra experience you want to delete.
    #   @return [String]
    #
    # @!attribute [rw] index_id
    #   The identifier of the index for your Amazon Kendra experience.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteExperienceRequest AWS API Documentation
    #
    class DeleteExperienceRequest < Struct.new(
      :id,
      :index_id)
      SENSITIVE = []
      include Aws::Structure
    end

    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteExperienceResponse AWS API Documentation
    #
    class DeleteExperienceResponse < Aws::EmptyStructure; end

    # @!attribute [rw] id
    #   The identifier of the FAQ you want to remove.
    #   @return [String]
    #
    # @!attribute [rw] index_id
    #   The identifier of the index for the FAQ.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteFaqRequest AWS API Documentation
    #
    class DeleteFaqRequest < Struct.new(
      :id,
      :index_id)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] id
    #   The identifier of the index you want to delete.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteIndexRequest AWS API Documentation
    #
    class DeleteIndexRequest < Struct.new(
      :id)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] index_id
    #   The identifier of the index you want to delete a group from.
    #   @return [String]
    #
    # @!attribute [rw] data_source_id
    #   The identifier of the data source you want to delete a group from.
    #
    #   A group can be tied to multiple data sources. You can delete a group
    #   from accessing documents in a certain data source. For example, the
    #   groups "Research", "Engineering", and "Sales and Marketing"
    #   are all tied to the company's documents stored in the data sources
    #   Confluence and Salesforce. You want to delete "Research" and
    #   "Engineering" groups from Salesforce, so that these groups cannot
    #   access customer-related documents stored in Salesforce. Only "Sales
    #   and Marketing" should access documents in the Salesforce data
    #   source.
    #   @return [String]
    #
    # @!attribute [rw] group_id
    #   The identifier of the group you want to delete.
    #   @return [String]
    #
    # @!attribute [rw] ordering_id
    #   The timestamp identifier you specify to ensure Amazon Kendra does
    #   not override the latest `DELETE` action with previous actions. The
    #   highest number ID, which is the ordering ID, is the latest action
    #   you want to process and apply on top of other actions with lower
    #   number IDs. This prevents previous actions with lower number IDs
    #   from possibly overriding the latest action.
    #
    #   The ordering ID can be the Unix time of the last update you made to
    #   a group members list. You would then provide this list when calling
    #   `PutPrincipalMapping`. This ensures your `DELETE` action for that
    #   updated group with the latest members list doesn't get overwritten
    #   by earlier `DELETE` actions for the same group which are yet to be
    #   processed.
    #
    #   The default ordering ID is the current Unix time in milliseconds
    #   that the action was received by Amazon Kendra.
    #   @return [Integer]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeletePrincipalMappingRequest AWS API Documentation
    #
    class DeletePrincipalMappingRequest < Struct.new(
      :index_id,
      :data_source_id,
      :group_id,
      :ordering_id)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] index_id
    #   The identifier of the index for the block list.
    #   @return [String]
    #
    # @!attribute [rw] id
    #   The identifier of the block list you want to delete.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteQuerySuggestionsBlockListRequest AWS API Documentation
    #
    class DeleteQuerySuggestionsBlockListRequest < Struct.new(
      :index_id,
      :id)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] id
    #   The identifier of the thesaurus you want to delete.
    #   @return [String]
    #
    # @!attribute [rw] index_id
    #   The identifier of the index for the thesaurus.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteThesaurusRequest AWS API Documentation
    #
    class DeleteThesaurusRequest < Struct.new(
      :id,
      :index_id)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] index_id
    #   The identifier of the index for an access control configuration.
    #   @return [String]
    #
    # @!attribute [rw] id
    #   The identifier of the access control configuration you want to get
    #   information on.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeAccessControlConfigurationRequest AWS API Documentation
    #
    class DescribeAccessControlConfigurationRequest < Struct.new(
      :index_id,
      :id)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] name
    #   The name for the access control configuration.
    #   @return [String]
    #
    # @!attribute [rw] description
    #   The description for the access control configuration.
    #   @return [String]
    #
    # @!attribute [rw] error_message
    #   The error message containing details if there are issues processing
    #   the access control configuration.
    #   @return [String]
    #
    # @!attribute [rw] access_control_list
    #   Information on principals (users and/or groups) and which documents
    #   they should have access to. This is useful for user context
    #   filtering, where search results are filtered based on the user or
    #   their group access to documents.
    #   @return [Array<Types::Principal>]
    #
    # @!attribute [rw] hierarchical_access_control_list
    #   The list of [principal][1] lists that define the hierarchy for which
    #   documents users should have access to.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_Principal.html
    #   @return [Array<Types::HierarchicalPrincipal>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeAccessControlConfigurationResponse AWS API Documentation
    #
    class DescribeAccessControlConfigurationResponse < Struct.new(
      :name,
      :description,
      :error_message,
      :access_control_list,
      :hierarchical_access_control_list)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] id
    #   The identifier of the data source connector.
    #   @return [String]
    #
    # @!attribute [rw] index_id
    #   The identifier of the index used with the data source connector.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeDataSourceRequest AWS API Documentation
    #
    class DescribeDataSourceRequest < Struct.new(
      :id,
      :index_id)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] id
    #   The identifier of the data source connector.
    #   @return [String]
    #
    # @!attribute [rw] index_id
    #   The identifier of the index used with the data source connector.
    #   @return [String]
    #
    # @!attribute [rw] name
    #   The name for the data source connector.
    #   @return [String]
    #
    # @!attribute [rw] type
    #   The type of the data source. For example, `SHAREPOINT`.
    #   @return [String]
    #
    # @!attribute [rw] configuration
    #   Configuration details for the data source connector. This shows how
    #   the data source is configured. The configuration options for a data
    #   source depend on the data source provider.
    #   @return [Types::DataSourceConfiguration]
    #
    # @!attribute [rw] vpc_configuration
    #   Configuration information for an Amazon Virtual Private Cloud to
    #   connect to your data source. For more information, see [Configuring
    #   a VPC][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html
    #   @return [Types::DataSourceVpcConfiguration]
    #
    # @!attribute [rw] created_at
    #   The Unix timestamp when the data source connector was created.
    #   @return [Time]
    #
    # @!attribute [rw] updated_at
    #   The Unix timestamp when the data source connector was last updated.
    #   @return [Time]
    #
    # @!attribute [rw] description
    #   The description for the data source connector.
    #   @return [String]
    #
    # @!attribute [rw] status
    #   The current status of the data source connector. When the status is
    #   `ACTIVE` the data source is ready to use. When the status is
    #   `FAILED`, the `ErrorMessage` field contains the reason that the data
    #   source failed.
    #   @return [String]
    #
    # @!attribute [rw] schedule
    #   The schedule for Amazon Kendra to update the index.
    #   @return [String]
    #
    # @!attribute [rw] role_arn
    #   The Amazon Resource Name (ARN) of the role with permission to access
    #   the data source and required resources.
    #   @return [String]
    #
    # @!attribute [rw] error_message
    #   When the `Status` field value is `FAILED`, the `ErrorMessage` field
    #   contains a description of the error that caused the data source to
    #   fail.
    #   @return [String]
    #
    # @!attribute [rw] language_code
    #   The code for a language. This shows a supported language for all
    #   documents in the data source. English is supported by default. For
    #   more information on supported languages, including their codes, see
    #   [Adding documents in languages other than English][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html
    #   @return [String]
    #
    # @!attribute [rw] custom_document_enrichment_configuration
    #   Configuration information for altering document metadata and content
    #   during the document ingestion process when you describe a data
    #   source.
    #
    #   For more information on how to create, modify and delete document
    #   metadata, or make other content alterations when you ingest
    #   documents into Amazon Kendra, see [Customizing document metadata
    #   during the ingestion process][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html
    #   @return [Types::CustomDocumentEnrichmentConfiguration]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeDataSourceResponse AWS API Documentation
    #
    class DescribeDataSourceResponse < Struct.new(
      :id,
      :index_id,
      :name,
      :type,
      :configuration,
      :vpc_configuration,
      :created_at,
      :updated_at,
      :description,
      :status,
      :schedule,
      :role_arn,
      :error_message,
      :language_code,
      :custom_document_enrichment_configuration)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] id
    #   The identifier of your Amazon Kendra experience you want to get
    #   information on.
    #   @return [String]
    #
    # @!attribute [rw] index_id
    #   The identifier of the index for your Amazon Kendra experience.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeExperienceRequest AWS API Documentation
    #
    class DescribeExperienceRequest < Struct.new(
      :id,
      :index_id)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] id
    #   Shows the identifier of your Amazon Kendra experience.
    #   @return [String]
    #
    # @!attribute [rw] index_id
    #   Shows the identifier of the index for your Amazon Kendra experience.
    #   @return [String]
    #
    # @!attribute [rw] name
    #   Shows the name of your Amazon Kendra experience.
    #   @return [String]
    #
    # @!attribute [rw] endpoints
    #   Shows the endpoint URLs for your Amazon Kendra experiences. The URLs
    #   are unique and fully hosted by Amazon Web Services.
    #   @return [Array<Types::ExperienceEndpoint>]
    #
    # @!attribute [rw] configuration
    #   Shows the configuration information for your Amazon Kendra
    #   experience. This includes `ContentSourceConfiguration`, which
    #   specifies the data source IDs and/or FAQ IDs, and
    #   `UserIdentityConfiguration`, which specifies the user or group
    #   information to grant access to your Amazon Kendra experience.
    #   @return [Types::ExperienceConfiguration]
    #
    # @!attribute [rw] created_at
    #   The Unix timestamp when your Amazon Kendra experience was created.
    #   @return [Time]
    #
    # @!attribute [rw] updated_at
    #   The Unix timestamp when your Amazon Kendra experience was last
    #   updated.
    #   @return [Time]
    #
    # @!attribute [rw] description
    #   Shows the description for your Amazon Kendra experience.
    #   @return [String]
    #
    # @!attribute [rw] status
    #   The current processing status of your Amazon Kendra experience. When
    #   the status is `ACTIVE`, your Amazon Kendra experience is ready to
    #   use. When the status is `FAILED`, the `ErrorMessage` field contains
    #   the reason that this failed.
    #   @return [String]
    #
    # @!attribute [rw] role_arn
    #   Shows the Amazon Resource Name (ARN) of a role with permission to
    #   access `Query` API, `QuerySuggestions` API, `SubmitFeedback` API,
    #   and IAM Identity Center that stores your user and group information.
    #   @return [String]
    #
    # @!attribute [rw] error_message
    #   The reason your Amazon Kendra experience could not properly process.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeExperienceResponse AWS API Documentation
    #
    class DescribeExperienceResponse < Struct.new(
      :id,
      :index_id,
      :name,
      :endpoints,
      :configuration,
      :created_at,
      :updated_at,
      :description,
      :status,
      :role_arn,
      :error_message)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] id
    #   The identifier of the FAQ you want to get information on.
    #   @return [String]
    #
    # @!attribute [rw] index_id
    #   The identifier of the index for the FAQ.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeFaqRequest AWS API Documentation
    #
    class DescribeFaqRequest < Struct.new(
      :id,
      :index_id)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] id
    #   The identifier of the FAQ.
    #   @return [String]
    #
    # @!attribute [rw] index_id
    #   The identifier of the index for the FAQ.
    #   @return [String]
    #
    # @!attribute [rw] name
    #   The name that you gave the FAQ when it was created.
    #   @return [String]
    #
    # @!attribute [rw] description
    #   The description of the FAQ that you provided when it was created.
    #   @return [String]
    #
    # @!attribute [rw] created_at
    #   The Unix timestamp when the FAQ was created.
    #   @return [Time]
    #
    # @!attribute [rw] updated_at
    #   The Unix timestamp when the FAQ was last updated.
    #   @return [Time]
    #
    # @!attribute [rw] s3_path
    #   Information required to find a specific file in an Amazon S3 bucket.
    #   @return [Types::S3Path]
    #
    # @!attribute [rw] status
    #   The status of the FAQ. It is ready to use when the status is
    #   `ACTIVE`.
    #   @return [String]
    #
    # @!attribute [rw] role_arn
    #   The Amazon Resource Name (ARN) of the role that provides access to
    #   the S3 bucket containing the input files for the FAQ.
    #   @return [String]
    #
    # @!attribute [rw] error_message
    #   If the `Status` field is `FAILED`, the `ErrorMessage` field contains
    #   the reason why the FAQ failed.
    #   @return [String]
    #
    # @!attribute [rw] file_format
    #   The file format used by the input files for the FAQ.
    #   @return [String]
    #
    # @!attribute [rw] language_code
    #   The code for a language. This shows a supported language for the FAQ
    #   document. English is supported by default. For more information on
    #   supported languages, including their codes, see [Adding documents in
    #   languages other than English][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeFaqResponse AWS API Documentation
    #
    class DescribeFaqResponse < Struct.new(
      :id,
      :index_id,
      :name,
      :description,
      :created_at,
      :updated_at,
      :s3_path,
      :status,
      :role_arn,
      :error_message,
      :file_format,
      :language_code)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] index_id
    #   The identifier of the index used for featuring results.
    #   @return [String]
    #
    # @!attribute [rw] featured_results_set_id
    #   The identifier of the set of featured results that you want to get
    #   information on.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeFeaturedResultsSetRequest AWS API Documentation
    #
    class DescribeFeaturedResultsSetRequest < Struct.new(
      :index_id,
      :featured_results_set_id)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] featured_results_set_id
    #   The identifier of the set of featured results.
    #   @return [String]
    #
    # @!attribute [rw] featured_results_set_name
    #   The name for the set of featured results.
    #   @return [String]
    #
    # @!attribute [rw] description
    #   The description for the set of featured results.
    #   @return [String]
    #
    # @!attribute [rw] status
    #   The current status of the set of featured results. When the value is
    #   `ACTIVE`, featured results are ready for use. You can still
    #   configure your settings before setting the status to `ACTIVE`. You
    #   can set the status to `ACTIVE` or `INACTIVE` using the
    #   [UpdateFeaturedResultsSet][1] API. The queries you specify for
    #   featured results must be unique per featured results set for each
    #   index, whether the status is `ACTIVE` or `INACTIVE`.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateFeaturedResultsSet.html
    #   @return [String]
    #
    # @!attribute [rw] query_texts
    #   The list of queries for featuring results. For more information on
    #   the list of queries, see [FeaturedResultsSet][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_FeaturedResultsSet.html
    #   @return [Array<String>]
    #
    # @!attribute [rw] featured_documents_with_metadata
    #   The list of document IDs for the documents you want to feature with
    #   their metadata information. For more information on the list of
    #   featured documents, see [FeaturedResultsSet][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_FeaturedResultsSet.html
    #   @return [Array<Types::FeaturedDocumentWithMetadata>]
    #
    # @!attribute [rw] featured_documents_missing
    #   The list of document IDs that don't exist but you have specified as
    #   featured documents. Amazon Kendra cannot feature these documents if
    #   they don't exist in the index. You can check the status of a
    #   document and its ID or check for documents with status errors using
    #   the [BatchGetDocumentStatus][1] API.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_BatchGetDocumentStatus.html
    #   @return [Array<Types::FeaturedDocumentMissing>]
    #
    # @!attribute [rw] last_updated_timestamp
    #   The timestamp when the set of featured results was last updated.
    #   @return [Integer]
    #
    # @!attribute [rw] creation_timestamp
    #   The Unix timestamp when the set of the featured results was created.
    #   @return [Integer]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeFeaturedResultsSetResponse AWS API Documentation
    #
    class DescribeFeaturedResultsSetResponse < Struct.new(
      :featured_results_set_id,
      :featured_results_set_name,
      :description,
      :status,
      :query_texts,
      :featured_documents_with_metadata,
      :featured_documents_missing,
      :last_updated_timestamp,
      :creation_timestamp)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] id
    #   The identifier of the index you want to get information on.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeIndexRequest AWS API Documentation
    #
    class DescribeIndexRequest < Struct.new(
      :id)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] name
    #   The name of the index.
    #   @return [String]
    #
    # @!attribute [rw] id
    #   The identifier of the index.
    #   @return [String]
    #
    # @!attribute [rw] edition
    #   The Amazon Kendra edition used for the index. You decide the edition
    #   when you create the index.
    #   @return [String]
    #
    # @!attribute [rw] role_arn
    #   The Amazon Resource Name (ARN) of the IAM role that gives Amazon
    #   Kendra permission to write to your Amazon CloudWatch logs.
    #   @return [String]
    #
    # @!attribute [rw] server_side_encryption_configuration
    #   The identifier of the KMS customer master key (CMK) that is used to
    #   encrypt your data. Amazon Kendra doesn't support asymmetric CMKs.
    #   @return [Types::ServerSideEncryptionConfiguration]
    #
    # @!attribute [rw] status
    #   The current status of the index. When the value is `ACTIVE`, the
    #   index is ready for use. If the `Status` field value is `FAILED`, the
    #   `ErrorMessage` field contains a message that explains why.
    #   @return [String]
    #
    # @!attribute [rw] description
    #   The description for the index.
    #   @return [String]
    #
    # @!attribute [rw] created_at
    #   The Unix timestamp when the index was created.
    #   @return [Time]
    #
    # @!attribute [rw] updated_at
    #   The Unix timestamp when the index was last updated.
    #   @return [Time]
    #
    # @!attribute [rw] document_metadata_configurations
    #   Configuration information for document metadata or fields. Document
    #   metadata are fields or attributes associated with your documents.
    #   For example, the company department name associated with each
    #   document.
    #   @return [Array<Types::DocumentMetadataConfiguration>]
    #
    # @!attribute [rw] index_statistics
    #   Provides information about the number of FAQ questions and answers
    #   and the number of text documents indexed.
    #   @return [Types::IndexStatistics]
    #
    # @!attribute [rw] error_message
    #   When the `Status` field value is `FAILED`, the `ErrorMessage` field
    #   contains a message that explains why.
    #   @return [String]
    #
    # @!attribute [rw] capacity_units
    #   For Enterprise Edition indexes, you can choose to use additional
    #   capacity to meet the needs of your application. This contains the
    #   capacity units used for the index. A query or document storage
    #   capacity of zero indicates that the index is using the default
    #   capacity. For more information on the default capacity for an index
    #   and adjusting this, see [Adjusting capacity][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/adjusting-capacity.html
    #   @return [Types::CapacityUnitsConfiguration]
    #
    # @!attribute [rw] user_token_configurations
    #   The user token configuration for the Amazon Kendra index.
    #   @return [Array<Types::UserTokenConfiguration>]
    #
    # @!attribute [rw] user_context_policy
    #   The user context policy for the Amazon Kendra index.
    #   @return [String]
    #
    # @!attribute [rw] user_group_resolution_configuration
    #   Whether you have enabled IAM Identity Center identity source for
    #   your users and groups. This is useful for user context filtering,
    #   where search results are filtered based on the user or their group
    #   access to documents.
    #   @return [Types::UserGroupResolutionConfiguration]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeIndexResponse AWS API Documentation
    #
    class DescribeIndexResponse < Struct.new(
      :name,
      :id,
      :edition,
      :role_arn,
      :server_side_encryption_configuration,
      :status,
      :description,
      :created_at,
      :updated_at,
      :document_metadata_configurations,
      :index_statistics,
      :error_message,
      :capacity_units,
      :user_token_configurations,
      :user_context_policy,
      :user_group_resolution_configuration)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] index_id
    #   The identifier of the index required to check the processing of
    #   `PUT` and `DELETE` actions for mapping users to their groups.
    #   @return [String]
    #
    # @!attribute [rw] data_source_id
    #   The identifier of the data source to check the processing of `PUT`
    #   and `DELETE` actions for mapping users to their groups.
    #   @return [String]
    #
    # @!attribute [rw] group_id
    #   The identifier of the group required to check the processing of
    #   `PUT` and `DELETE` actions for mapping users to their groups.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribePrincipalMappingRequest AWS API Documentation
    #
    class DescribePrincipalMappingRequest < Struct.new(
      :index_id,
      :data_source_id,
      :group_id)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] index_id
    #   Shows the identifier of the index to see information on the
    #   processing of `PUT` and `DELETE` actions for mapping users to their
    #   groups.
    #   @return [String]
    #
    # @!attribute [rw] data_source_id
    #   Shows the identifier of the data source to see information on the
    #   processing of `PUT` and `DELETE` actions for mapping users to their
    #   groups.
    #   @return [String]
    #
    # @!attribute [rw] group_id
    #   Shows the identifier of the group to see information on the
    #   processing of `PUT` and `DELETE` actions for mapping users to their
    #   groups.
    #   @return [String]
    #
    # @!attribute [rw] group_ordering_id_summaries
    #   Shows the following information on the processing of `PUT` and
    #   `DELETE` actions for mapping users to their groups:
    #
    #   * Status—the status can be either `PROCESSING`, `SUCCEEDED`,
    #     `DELETING`, `DELETED`, or `FAILED`.
    #
    #   * Last updated—the last date-time an action was updated.
    #
    #   * Received—the last date-time an action was received or submitted.
    #
    #   * Ordering ID—the latest action that should process and apply after
    #     other actions.
    #
    #   * Failure reason—the reason an action could not be processed.
    #   @return [Array<Types::GroupOrderingIdSummary>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribePrincipalMappingResponse AWS API Documentation
    #
    class DescribePrincipalMappingResponse < Struct.new(
      :index_id,
      :data_source_id,
      :group_id,
      :group_ordering_id_summaries)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] index_id
    #   The identifier of the index for the block list.
    #   @return [String]
    #
    # @!attribute [rw] id
    #   The identifier of the block list you want to get information on.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeQuerySuggestionsBlockListRequest AWS API Documentation
    #
    class DescribeQuerySuggestionsBlockListRequest < Struct.new(
      :index_id,
      :id)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] index_id
    #   The identifier of the index for the block list.
    #   @return [String]
    #
    # @!attribute [rw] id
    #   The identifier of the block list.
    #   @return [String]
    #
    # @!attribute [rw] name
    #   The name of the block list.
    #   @return [String]
    #
    # @!attribute [rw] description
    #   The description for the block list.
    #   @return [String]
    #
    # @!attribute [rw] status
    #   The current status of the block list. When the value is `ACTIVE`,
    #   the block list is ready for use.
    #   @return [String]
    #
    # @!attribute [rw] error_message
    #   The error message containing details if there are issues processing
    #   the block list.
    #   @return [String]
    #
    # @!attribute [rw] created_at
    #   The Unix timestamp when a block list for query suggestions was
    #   created.
    #   @return [Time]
    #
    # @!attribute [rw] updated_at
    #   The Unix timestamp when a block list for query suggestions was last
    #   updated.
    #   @return [Time]
    #
    # @!attribute [rw] source_s3_path
    #   Shows the current S3 path to your block list text file in your S3
    #   bucket.
    #
    #   Each block word or phrase should be on a separate line in a text
    #   file.
    #
    #   For information on the current quota limits for block lists, see
    #   [Quotas for Amazon Kendra][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
    #   @return [Types::S3Path]
    #
    # @!attribute [rw] item_count
    #   The current number of valid, non-empty words or phrases in the block
    #   list text file.
    #   @return [Integer]
    #
    # @!attribute [rw] file_size_bytes
    #   The current size of the block list text file in S3.
    #   @return [Integer]
    #
    # @!attribute [rw] role_arn
    #   The IAM (Identity and Access Management) role used by Amazon Kendra
    #   to access the block list text file in S3.
    #
    #   The role needs S3 read permissions to your file in S3 and needs to
    #   give STS (Security Token Service) assume role permissions to Amazon
    #   Kendra.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeQuerySuggestionsBlockListResponse AWS API Documentation
    #
    class DescribeQuerySuggestionsBlockListResponse < Struct.new(
      :index_id,
      :id,
      :name,
      :description,
      :status,
      :error_message,
      :created_at,
      :updated_at,
      :source_s3_path,
      :item_count,
      :file_size_bytes,
      :role_arn)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] index_id
    #   The identifier of the index with query suggestions that you want to
    #   get information on.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeQuerySuggestionsConfigRequest AWS API Documentation
    #
    class DescribeQuerySuggestionsConfigRequest < Struct.new(
      :index_id)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] mode
    #   Whether query suggestions are currently in `ENABLED` mode or
    #   `LEARN_ONLY` mode.
    #
    #   By default, Amazon Kendra enables query suggestions.`LEARN_ONLY`
    #   turns off query suggestions for your users. You can change the mode
    #   using the [UpdateQuerySuggestionsConfig][1] API.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateQuerySuggestionsConfig.html
    #   @return [String]
    #
    # @!attribute [rw] status
    #   Whether the status of query suggestions settings is currently
    #   `ACTIVE` or `UPDATING`.
    #
    #   Active means the current settings apply and Updating means your
    #   changed settings are in the process of applying.
    #   @return [String]
    #
    # @!attribute [rw] query_log_look_back_window_in_days
    #   How recent your queries are in your query log time window (in days).
    #   @return [Integer]
    #
    # @!attribute [rw] include_queries_without_user_information
    #   `TRUE` to use all queries, otherwise use only queries that include
    #   user information to generate the query suggestions.
    #   @return [Boolean]
    #
    # @!attribute [rw] minimum_number_of_querying_users
    #   The minimum number of unique users who must search a query in order
    #   for the query to be eligible to suggest to your users.
    #   @return [Integer]
    #
    # @!attribute [rw] minimum_query_count
    #   The minimum number of times a query must be searched in order for
    #   the query to be eligible to suggest to your users.
    #   @return [Integer]
    #
    # @!attribute [rw] last_suggestions_build_time
    #   The Unix timestamp when query suggestions for an index was last
    #   updated.
    #
    #   Amazon Kendra automatically updates suggestions every 24 hours,
    #   after you change a setting or after you apply a [block list][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/query-suggestions.html#query-suggestions-blocklist
    #   @return [Time]
    #
    # @!attribute [rw] last_clear_time
    #   The Unix timestamp when query suggestions for an index was last
    #   cleared.
    #
    #   After you clear suggestions, Amazon Kendra learns new suggestions
    #   based on new queries added to the query log from the time you
    #   cleared suggestions. Amazon Kendra only considers re-occurences of a
    #   query from the time you cleared suggestions.
    #   @return [Time]
    #
    # @!attribute [rw] total_suggestions_count
    #   The current total count of query suggestions for an index.
    #
    #   This count can change when you update your query suggestions
    #   settings, if you filter out certain queries from suggestions using a
    #   block list, and as the query log accumulates more queries for Amazon
    #   Kendra to learn from.
    #
    #   If the count is much lower than you expected, it could be because
    #   Amazon Kendra needs more queries in the query history to learn from
    #   or your current query suggestions settings are too strict.
    #   @return [Integer]
    #
    # @!attribute [rw] attribute_suggestions_config
    #   Configuration information for the document fields/attributes that
    #   you want to base query suggestions on.
    #   @return [Types::AttributeSuggestionsDescribeConfig]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeQuerySuggestionsConfigResponse AWS API Documentation
    #
    class DescribeQuerySuggestionsConfigResponse < Struct.new(
      :mode,
      :status,
      :query_log_look_back_window_in_days,
      :include_queries_without_user_information,
      :minimum_number_of_querying_users,
      :minimum_query_count,
      :last_suggestions_build_time,
      :last_clear_time,
      :total_suggestions_count,
      :attribute_suggestions_config)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] id
    #   The identifier of the thesaurus you want to get information on.
    #   @return [String]
    #
    # @!attribute [rw] index_id
    #   The identifier of the index for the thesaurus.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeThesaurusRequest AWS API Documentation
    #
    class DescribeThesaurusRequest < Struct.new(
      :id,
      :index_id)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] id
    #   The identifier of the thesaurus.
    #   @return [String]
    #
    # @!attribute [rw] index_id
    #   The identifier of the index for the thesaurus.
    #   @return [String]
    #
    # @!attribute [rw] name
    #   The thesaurus name.
    #   @return [String]
    #
    # @!attribute [rw] description
    #   The thesaurus description.
    #   @return [String]
    #
    # @!attribute [rw] status
    #   The current status of the thesaurus. When the value is `ACTIVE`,
    #   queries are able to use the thesaurus. If the `Status` field value
    #   is `FAILED`, the `ErrorMessage` field provides more information.
    #
    #   If the status is `ACTIVE_BUT_UPDATE_FAILED`, it means that Amazon
    #   Kendra could not ingest the new thesaurus file. The old thesaurus
    #   file is still active.
    #   @return [String]
    #
    # @!attribute [rw] error_message
    #   When the `Status` field value is `FAILED`, the `ErrorMessage` field
    #   provides more information.
    #   @return [String]
    #
    # @!attribute [rw] created_at
    #   The Unix timestamp when the thesaurus was created.
    #   @return [Time]
    #
    # @!attribute [rw] updated_at
    #   The Unix timestamp when the thesaurus was last updated.
    #   @return [Time]
    #
    # @!attribute [rw] role_arn
    #   An IAM role that gives Amazon Kendra permissions to access thesaurus
    #   file specified in `SourceS3Path`.
    #   @return [String]
    #
    # @!attribute [rw] source_s3_path
    #   Information required to find a specific file in an Amazon S3 bucket.
    #   @return [Types::S3Path]
    #
    # @!attribute [rw] file_size_bytes
    #   The size of the thesaurus file in bytes.
    #   @return [Integer]
    #
    # @!attribute [rw] term_count
    #   The number of unique terms in the thesaurus file. For example, the
    #   synonyms `a,b,c` and `a=>d`, the term count would be 4.
    #   @return [Integer]
    #
    # @!attribute [rw] synonym_rule_count
    #   The number of synonym rules in the thesaurus file.
    #   @return [Integer]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeThesaurusResponse AWS API Documentation
    #
    class DescribeThesaurusResponse < Struct.new(
      :id,
      :index_id,
      :name,
      :description,
      :status,
      :error_message,
      :created_at,
      :updated_at,
      :role_arn,
      :source_s3_path,
      :file_size_bytes,
      :term_count,
      :synonym_rule_count)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] id
    #   The identifier of your Amazon Kendra experience.
    #   @return [String]
    #
    # @!attribute [rw] index_id
    #   The identifier of the index for your Amazon Kendra experience.
    #   @return [String]
    #
    # @!attribute [rw] entity_list
    #   Lists users or groups in your IAM Identity Center identity source.
    #   @return [Array<Types::EntityConfiguration>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DisassociateEntitiesFromExperienceRequest AWS API Documentation
    #
    class DisassociateEntitiesFromExperienceRequest < Struct.new(
      :id,
      :index_id,
      :entity_list)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] failed_entity_list
    #   Lists the users or groups in your IAM Identity Center identity
    #   source that failed to properly remove access to your Amazon Kendra
    #   experience.
    #   @return [Array<Types::FailedEntity>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DisassociateEntitiesFromExperienceResponse AWS API Documentation
    #
    class DisassociateEntitiesFromExperienceResponse < Struct.new(
      :failed_entity_list)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] id
    #   The identifier of your Amazon Kendra experience.
    #   @return [String]
    #
    # @!attribute [rw] index_id
    #   The identifier of the index for your Amazon Kendra experience.
    #   @return [String]
    #
    # @!attribute [rw] entity_ids
    #   The identifiers of users or groups in your IAM Identity Center
    #   identity source. For example, user IDs could be user emails.
    #   @return [Array<String>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DisassociatePersonasFromEntitiesRequest AWS API Documentation
    #
    class DisassociatePersonasFromEntitiesRequest < Struct.new(
      :id,
      :index_id,
      :entity_ids)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] failed_entity_list
    #   Lists the users or groups in your IAM Identity Center identity
    #   source that failed to properly remove access to your Amazon Kendra
    #   experience.
    #   @return [Array<Types::FailedEntity>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DisassociatePersonasFromEntitiesResponse AWS API Documentation
    #
    class DisassociatePersonasFromEntitiesResponse < Struct.new(
      :failed_entity_list)
      SENSITIVE = []
      include Aws::Structure
    end

    # A document in an index.
    #
    # @!attribute [rw] id
    #   A identifier of the document in the index.
    #
    #   Note, each document ID must be unique per index. You cannot create a
    #   data source to index your documents with their unique IDs and then
    #   use the `BatchPutDocument` API to index the same documents, or vice
    #   versa. You can delete a data source and then use the
    #   `BatchPutDocument` API to index the same documents, or vice versa.
    #   @return [String]
    #
    # @!attribute [rw] title
    #   The title of the document.
    #   @return [String]
    #
    # @!attribute [rw] blob
    #   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 Amazon Web Services SDK to call Amazon Kendra APIs.
    #   If you are calling the Amazon Kendra endpoint directly using REST,
    #   you must base64 encode the contents before sending.
    #   @return [String]
    #
    # @!attribute [rw] s3_path
    #   Information required to find a specific file in an Amazon S3 bucket.
    #   @return [Types::S3Path]
    #
    # @!attribute [rw] attributes
    #   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.
    #
    #   For example, 'DataSourceId' and 'DataSourceSyncJobId' are custom
    #   attributes that provide information on the synchronization of
    #   documents running on a data source. Note, 'DataSourceSyncJobId'
    #   could be an optional custom attribute as Amazon Kendra will use the
    #   ID of a running sync job.
    #   @return [Array<Types::DocumentAttribute>]
    #
    # @!attribute [rw] access_control_list
    #   Information on principals (users and/or groups) and which documents
    #   they should have access to. This is useful for user context
    #   filtering, where search results are filtered based on the user or
    #   their group access to documents.
    #   @return [Array<Types::Principal>]
    #
    # @!attribute [rw] hierarchical_access_control_list
    #   The list of [principal][1] lists that define the hierarchy for which
    #   documents users should have access to.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_Principal.html
    #   @return [Array<Types::HierarchicalPrincipal>]
    #
    # @!attribute [rw] content_type
    #   The file type of the document in the `Blob` field.
    #
    #   If you want to index snippets or subsets of HTML documents instead
    #   of the entirety of the HTML documents, you must add the `HTML` start
    #   and closing tags (`<HTML>content</HTML>`) around the content.
    #   @return [String]
    #
    # @!attribute [rw] access_control_configuration_id
    #   The identifier of the access control configuration that you want to
    #   apply to the document.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/Document AWS API Documentation
    #
    class Document < Struct.new(
      :id,
      :title,
      :blob,
      :s3_path,
      :attributes,
      :access_control_list,
      :hierarchical_access_control_list,
      :content_type,
      :access_control_configuration_id)
      SENSITIVE = []
      include Aws::Structure
    end

    # A document attribute or metadata field. To create custom document
    # attributes, see [Custom attributes][1].
    #
    #
    #
    # [1]: https://docs.aws.amazon.com/kendra/latest/dg/custom-attributes.html
    #
    # @!attribute [rw] key
    #   The identifier for the attribute.
    #   @return [String]
    #
    # @!attribute [rw] value
    #   The value of the attribute.
    #   @return [Types::DocumentAttributeValue]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DocumentAttribute AWS API Documentation
    #
    class DocumentAttribute < Struct.new(
      :key,
      :value)
      SENSITIVE = []
      include Aws::Structure
    end

    # The condition used for the target document attribute or metadata field
    # when ingesting documents into Amazon Kendra. You use this with
    # [DocumentAttributeTarget to apply the condition][1].
    #
    # For example, you can create the 'Department' target field and have
    # it prefill department names associated with the documents based on
    # information in the 'Source\_URI' field. Set the condition that if
    # the 'Source\_URI' field contains 'financial' in its URI value,
    # then prefill the target field 'Department' with the target value
    # 'Finance' for the document.
    #
    # Amazon Kendra cannot create a target field if it has not already been
    # created as an index field. After you create your index field, you can
    # create a document metadata field using `DocumentAttributeTarget`.
    # Amazon Kendra then will map your newly created metadata field to your
    # index field.
    #
    #
    #
    # [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_DocumentAttributeTarget.html
    #
    # @!attribute [rw] condition_document_attribute_key
    #   The identifier of the document attribute used for the condition.
    #
    #   For example, 'Source\_URI' could be an identifier for the
    #   attribute or metadata field that contains source URIs associated
    #   with the documents.
    #
    #   Amazon Kendra currently does not support `_document_body` as an
    #   attribute key used for the condition.
    #   @return [String]
    #
    # @!attribute [rw] operator
    #   The condition operator.
    #
    #   For example, you can use 'Contains' to partially match a string.
    #   @return [String]
    #
    # @!attribute [rw] condition_on_value
    #   The value used by the operator.
    #
    #   For example, you can specify the value 'financial' for strings in
    #   the 'Source\_URI' field that partially match or contain this
    #   value.
    #   @return [Types::DocumentAttributeValue]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DocumentAttributeCondition AWS API Documentation
    #
    class DocumentAttributeCondition < Struct.new(
      :condition_document_attribute_key,
      :operator,
      :condition_on_value)
      SENSITIVE = []
      include Aws::Structure
    end

    # The target document attribute or metadata field you want to alter when
    # ingesting documents into Amazon Kendra.
    #
    # For example, you can delete customer identification numbers associated
    # with the documents, stored in the document metadata field called
    # 'Customer\_ID'. You set the target key as 'Customer\_ID' and the
    # deletion flag to `TRUE`. This removes all customer ID values in the
    # field 'Customer\_ID'. This would scrub personally identifiable
    # information from each document's metadata.
    #
    # Amazon Kendra cannot create a target field if it has not already been
    # created as an index field. After you create your index field, you can
    # create a document metadata field using `DocumentAttributeTarget`.
    # Amazon Kendra then will map your newly created metadata field to your
    # index field.
    #
    # You can also use this with [DocumentAttributeCondition][1].
    #
    #
    #
    # [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_DocumentAttributeCondition.html
    #
    # @!attribute [rw] target_document_attribute_key
    #   The identifier of the target document attribute or metadata field.
    #
    #   For example, 'Department' could be an identifier for the target
    #   attribute or metadata field that includes the department names
    #   associated with the documents.
    #   @return [String]
    #
    # @!attribute [rw] target_document_attribute_value_deletion
    #   `TRUE` to delete the existing target value for your specified target
    #   attribute key. You cannot create a target value and set this to
    #   `TRUE`. To create a target value (`TargetDocumentAttributeValue`),
    #   set this to `FALSE`.
    #   @return [Boolean]
    #
    # @!attribute [rw] target_document_attribute_value
    #   The target value you want to create for the target attribute.
    #
    #   For example, 'Finance' could be the target value for the target
    #   attribute key 'Department'.
    #   @return [Types::DocumentAttributeValue]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DocumentAttributeTarget AWS API Documentation
    #
    class DocumentAttributeTarget < Struct.new(
      :target_document_attribute_key,
      :target_document_attribute_value_deletion,
      :target_document_attribute_value)
      SENSITIVE = []
      include Aws::Structure
    end

    # The value of a document attribute. You can only provide one value for
    # a document attribute.
    #
    # @!attribute [rw] string_value
    #   A string, such as "department".
    #   @return [String]
    #
    # @!attribute [rw] string_list_value
    #   A list of strings. The default maximum length or number of strings
    #   is 10.
    #   @return [Array<String>]
    #
    # @!attribute [rw] long_value
    #   A long integer value.
    #   @return [Integer]
    #
    # @!attribute [rw] date_value
    #   A date expressed as an ISO 8601 string.
    #
    #   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.
    #   @return [Time]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DocumentAttributeValue AWS API Documentation
    #
    class DocumentAttributeValue < Struct.new(
      :string_value,
      :string_list_value,
      :long_value,
      :date_value)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides the count of documents that match a particular document
    # attribute or field when doing a faceted search.
    #
    # @!attribute [rw] document_attribute_value
    #   The value of the attribute/field. For example, "HR".
    #   @return [Types::DocumentAttributeValue]
    #
    # @!attribute [rw] count
    #   The number of documents in the response that have the
    #   attribute/field value for the key.
    #   @return [Integer]
    #
    # @!attribute [rw] facet_results
    #   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.
    #   @return [Array<Types::FacetResult>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DocumentAttributeValueCountPair AWS API Documentation
    #
    class DocumentAttributeValueCountPair < Struct.new(
      :document_attribute_value,
      :count,
      :facet_results)
      SENSITIVE = []
      include Aws::Structure
    end

    # Identifies a document for which to retrieve status information
    #
    # @!attribute [rw] document_id
    #   The identifier of the document.
    #   @return [String]
    #
    # @!attribute [rw] attributes
    #   Attributes that identify a specific version of a document to check.
    #
    #   The only valid attributes are:
    #
    #   * version
    #
    #   * datasourceId
    #
    #   * jobExecutionId
    #
    #   The attributes follow these rules:
    #
    #   * `dataSourceId` and `jobExecutionId` must be used together.
    #
    #   * `version` is ignored if `dataSourceId` and `jobExecutionId` are
    #     not provided.
    #
    #   * If `dataSourceId` and `jobExecutionId` are provided, but `version`
    #     is not, the version defaults to "0".
    #   @return [Array<Types::DocumentAttribute>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DocumentInfo AWS API Documentation
    #
    class DocumentInfo < Struct.new(
      :document_id,
      :attributes)
      SENSITIVE = []
      include Aws::Structure
    end

    # Specifies the properties, such as relevance tuning and searchability,
    # of an index field.
    #
    # @!attribute [rw] name
    #   The name of the index field.
    #   @return [String]
    #
    # @!attribute [rw] type
    #   The data type of the index field.
    #   @return [String]
    #
    # @!attribute [rw] relevance
    #   Provides tuning parameters to determine how the field affects the
    #   search results.
    #   @return [Types::Relevance]
    #
    # @!attribute [rw] search
    #   Provides information about how the field is used during a search.
    #   @return [Types::Search]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DocumentMetadataConfiguration AWS API Documentation
    #
    class DocumentMetadataConfiguration < Struct.new(
      :name,
      :type,
      :relevance,
      :search)
      SENSITIVE = []
      include Aws::Structure
    end

    # Overrides the document relevance properties of a custom index field.
    #
    # @!attribute [rw] name
    #   The name of the index field.
    #   @return [String]
    #
    # @!attribute [rw] relevance
    #   Provides information for tuning the relevance of a field in a
    #   search. When a query includes terms that match the field, the
    #   results are given a boost in the response based on these tuning
    #   parameters.
    #   @return [Types::Relevance]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DocumentRelevanceConfiguration AWS API Documentation
    #
    class DocumentRelevanceConfiguration < Struct.new(
      :name,
      :relevance)
      SENSITIVE = []
      include Aws::Structure
    end

    # Document metadata files that contain information such as the document
    # access control information, source URI, document author, and custom
    # attributes. Each metadata file contains metadata about a single
    # document.
    #
    # @!attribute [rw] s3_prefix
    #   A prefix used to filter metadata configuration files in the Amazon
    #   Web Services S3 bucket. The S3 bucket might contain multiple
    #   metadata files. Use `S3Prefix` to include only the desired metadata
    #   files.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DocumentsMetadataConfiguration AWS API Documentation
    #
    class DocumentsMetadataConfiguration < Struct.new(
      :s3_prefix)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides the configuration information for users or groups in your IAM
    # Identity Center identity source to grant access your Amazon Kendra
    # experience.
    #
    # @!attribute [rw] entity_id
    #   The identifier of a user or group in your IAM Identity Center
    #   identity source. For example, a user ID could be an email.
    #   @return [String]
    #
    # @!attribute [rw] entity_type
    #   Specifies whether you are configuring a `User` or a `Group`.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/EntityConfiguration AWS API Documentation
    #
    class EntityConfiguration < Struct.new(
      :entity_id,
      :entity_type)
      SENSITIVE = []
      include Aws::Structure
    end

    # Information about the user entity.
    #
    # @!attribute [rw] user_name
    #   The name of the user.
    #   @return [String]
    #
    # @!attribute [rw] group_name
    #   The name of the group.
    #   @return [String]
    #
    # @!attribute [rw] identified_user_name
    #   The user name of the user.
    #   @return [String]
    #
    # @!attribute [rw] first_name
    #   The first name of the user.
    #   @return [String]
    #
    # @!attribute [rw] last_name
    #   The last name of the user.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/EntityDisplayData AWS API Documentation
    #
    class EntityDisplayData < Struct.new(
      :user_name,
      :group_name,
      :identified_user_name,
      :first_name,
      :last_name)
      SENSITIVE = [:user_name, :group_name, :identified_user_name, :first_name, :last_name]
      include Aws::Structure
    end

    # Provides the configuration information for users or groups in your IAM
    # Identity Center identity source for access to your Amazon Kendra
    # experience. Specific permissions are defined for each user or group
    # once they are granted access to your Amazon Kendra experience.
    #
    # @!attribute [rw] entity_id
    #   The identifier of a user or group in your IAM Identity Center
    #   identity source. For example, a user ID could be an email.
    #   @return [String]
    #
    # @!attribute [rw] persona
    #   The persona that defines the specific permissions of the user or
    #   group in your IAM Identity Center identity source. The available
    #   personas or access roles are `Owner` and `Viewer`. For more
    #   information on these personas, see [Providing access to your search
    #   page][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html#access-search-experience
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/EntityPersonaConfiguration AWS API Documentation
    #
    class EntityPersonaConfiguration < Struct.new(
      :entity_id,
      :persona)
      SENSITIVE = []
      include Aws::Structure
    end

    # Specifies the configuration information needed to customize how
    # collapsed search result groups expand.
    #
    # @!attribute [rw] max_result_items_to_expand
    #   The number of collapsed search result groups to expand. If you set
    #   this value to 10, for example, only the first 10 out of 100 result
    #   groups will have expand functionality.
    #   @return [Integer]
    #
    # @!attribute [rw] max_expanded_results_per_item
    #   The number of expanded results to show per collapsed primary
    #   document. For instance, if you set this value to 3, then at most 3
    #   results per collapsed group will be displayed.
    #   @return [Integer]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ExpandConfiguration AWS API Documentation
    #
    class ExpandConfiguration < Struct.new(
      :max_result_items_to_expand,
      :max_expanded_results_per_item)
      SENSITIVE = []
      include Aws::Structure
    end

    # A single expanded result in a collapsed group of search results.
    #
    # An expanded result item contains information about an expanded result
    # document within a collapsed group of search results. This includes the
    # original location of the document, a list of attributes assigned to
    # the document, and relevant text from the document that satisfies the
    # query.
    #
    # @!attribute [rw] id
    #   The identifier for the expanded result.
    #   @return [String]
    #
    # @!attribute [rw] document_id
    #   The idenitifier of the document.
    #   @return [String]
    #
    # @!attribute [rw] document_title
    #   Provides text and information about where to highlight the text.
    #   @return [Types::TextWithHighlights]
    #
    # @!attribute [rw] document_excerpt
    #   Provides text and information about where to highlight the text.
    #   @return [Types::TextWithHighlights]
    #
    # @!attribute [rw] document_uri
    #   The URI of the original location of the document.
    #   @return [String]
    #
    # @!attribute [rw] document_attributes
    #   An array of document attributes assigned to a document in the search
    #   results. For example, the document author ("\_author") or the
    #   source URI ("\_source\_uri") of the document.
    #   @return [Array<Types::DocumentAttribute>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ExpandedResultItem AWS API Documentation
    #
    class ExpandedResultItem < Struct.new(
      :id,
      :document_id,
      :document_title,
      :document_excerpt,
      :document_uri,
      :document_attributes)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides the configuration information for your Amazon Kendra
    # experience. This includes the data source IDs and/or FAQ IDs, and user
    # or group information to grant access to your Amazon Kendra experience.
    #
    # @!attribute [rw] content_source_configuration
    #   The identifiers of your data sources and FAQs. Or, you can specify
    #   that you want to use documents indexed via the `BatchPutDocument`
    #   API. This is the content you want to use for your Amazon Kendra
    #   experience.
    #   @return [Types::ContentSourceConfiguration]
    #
    # @!attribute [rw] user_identity_configuration
    #   The IAM Identity Center field name that contains the identifiers of
    #   your users, such as their emails.
    #   @return [Types::UserIdentityConfiguration]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ExperienceConfiguration AWS API Documentation
    #
    class ExperienceConfiguration < Struct.new(
      :content_source_configuration,
      :user_identity_configuration)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides the configuration information for the endpoint for your
    # Amazon Kendra experience.
    #
    # @!attribute [rw] endpoint_type
    #   The type of endpoint for your Amazon Kendra experience. The type
    #   currently available is `HOME`, which is a unique and fully hosted
    #   URL to the home page of your Amazon Kendra experience.
    #   @return [String]
    #
    # @!attribute [rw] endpoint
    #   The endpoint of your Amazon Kendra experience.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ExperienceEndpoint AWS API Documentation
    #
    class ExperienceEndpoint < Struct.new(
      :endpoint_type,
      :endpoint)
      SENSITIVE = []
      include Aws::Structure
    end

    # Summary information for users or groups in your IAM Identity Center
    # identity source with granted access to your Amazon Kendra experience.
    # You can create an Amazon Kendra experience such as a search
    # application. For more information on creating a search application
    # experience, see [Building a search experience with no code][1].
    #
    #
    #
    # [1]: https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html
    #
    # @!attribute [rw] entity_id
    #   The identifier of a user or group in your IAM Identity Center
    #   identity source. For example, a user ID could be an email.
    #   @return [String]
    #
    # @!attribute [rw] entity_type
    #   Shows the type as `User` or `Group`.
    #   @return [String]
    #
    # @!attribute [rw] display_data
    #   Information about the user entity.
    #   @return [Types::EntityDisplayData]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ExperienceEntitiesSummary AWS API Documentation
    #
    class ExperienceEntitiesSummary < Struct.new(
      :entity_id,
      :entity_type,
      :display_data)
      SENSITIVE = []
      include Aws::Structure
    end

    # Summary information for your Amazon Kendra experience. You can create
    # an Amazon Kendra experience such as a search application. For more
    # information on creating a search application experience, see [Building
    # a search experience with no code][1].
    #
    #
    #
    # [1]: https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html
    #
    # @!attribute [rw] name
    #   The name of your Amazon Kendra experience.
    #   @return [String]
    #
    # @!attribute [rw] id
    #   The identifier of your Amazon Kendra experience.
    #   @return [String]
    #
    # @!attribute [rw] created_at
    #   The Unix timestamp when your Amazon Kendra experience was created.
    #   @return [Time]
    #
    # @!attribute [rw] status
    #   The processing status of your Amazon Kendra experience.
    #   @return [String]
    #
    # @!attribute [rw] endpoints
    #   The endpoint URLs for your Amazon Kendra experiences. The URLs are
    #   unique and fully hosted by Amazon Web Services.
    #   @return [Array<Types::ExperienceEndpoint>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ExperiencesSummary AWS API Documentation
    #
    class ExperiencesSummary < Struct.new(
      :name,
      :id,
      :created_at,
      :status,
      :endpoints)
      SENSITIVE = []
      include Aws::Structure
    end

    # Information about a document attribute or field. You can use document
    # attributes as facets.
    #
    # 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.
    #
    # You can display up to 10 facet values per facet for a query. If you
    # want to increase this limit, contact [Support][1].
    #
    #
    #
    # [1]: http://aws.amazon.com/contact-us/
    #
    # @!attribute [rw] document_attribute_key
    #   The unique key for the document attribute.
    #   @return [String]
    #
    # @!attribute [rw] facets
    #   An array of document attributes that are nested facets 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. This helps your users further narrow their search.
    #
    #   You can only have one nested facet within a facet. If you want to
    #   increase this limit, contact [Support][1].
    #
    #
    #
    #   [1]: http://aws.amazon.com/contact-us/
    #   @return [Array<Types::Facet>]
    #
    # @!attribute [rw] max_results
    #   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 [Support][1].
    #
    #
    #
    #   [1]: http://aws.amazon.com/contact-us/
    #   @return [Integer]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/Facet AWS API Documentation
    #
    class Facet < Struct.new(
      :document_attribute_key,
      :facets,
      :max_results)
      SENSITIVE = []
      include Aws::Structure
    end

    # The facet values for the documents in the response.
    #
    # @!attribute [rw] document_attribute_key
    #   The key for the facet values. This is the same as the
    #   `DocumentAttributeKey` provided in the query.
    #   @return [String]
    #
    # @!attribute [rw] document_attribute_value_type
    #   The data type of the facet value. This is the same as the type
    #   defined for the index field when it was created.
    #   @return [String]
    #
    # @!attribute [rw] document_attribute_value_count_pairs
    #   An array of key/value pairs, where the key is the value of the
    #   attribute and the count is the number of documents that share the
    #   key value.
    #   @return [Array<Types::DocumentAttributeValueCountPair>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/FacetResult AWS API Documentation
    #
    class FacetResult < Struct.new(
      :document_attribute_key,
      :document_attribute_value_type,
      :document_attribute_value_count_pairs)
      SENSITIVE = []
      include Aws::Structure
    end

    # Information on the users or groups in your IAM Identity Center
    # identity source that failed to properly configure with your Amazon
    # Kendra experience.
    #
    # @!attribute [rw] entity_id
    #   The identifier of the user or group in your IAM Identity Center
    #   identity source. For example, a user ID could be an email.
    #   @return [String]
    #
    # @!attribute [rw] error_message
    #   The reason the user or group in your IAM Identity Center identity
    #   source failed to properly configure with your Amazon Kendra
    #   experience.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/FailedEntity AWS API Documentation
    #
    class FailedEntity < Struct.new(
      :entity_id,
      :error_message)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides statistical information about the FAQ questions and answers
    # contained in an index.
    #
    # @!attribute [rw] indexed_question_answers_count
    #   The total number of FAQ questions and answers contained in the
    #   index.
    #   @return [Integer]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/FaqStatistics AWS API Documentation
    #
    class FaqStatistics < Struct.new(
      :indexed_question_answers_count)
      SENSITIVE = []
      include Aws::Structure
    end

    # Summary information for frequently asked questions and answers
    # included in an index.
    #
    # @!attribute [rw] id
    #   The identifier of the FAQ.
    #   @return [String]
    #
    # @!attribute [rw] name
    #   The name that you assigned the FAQ when you created or updated the
    #   FAQ.
    #   @return [String]
    #
    # @!attribute [rw] status
    #   The current status of the FAQ. When the status is `ACTIVE` the FAQ
    #   is ready for use.
    #   @return [String]
    #
    # @!attribute [rw] created_at
    #   The Unix timestamp when the FAQ was created.
    #   @return [Time]
    #
    # @!attribute [rw] updated_at
    #   The Unix timestamp when the FAQ was last updated.
    #   @return [Time]
    #
    # @!attribute [rw] file_format
    #   The file type used to create the FAQ.
    #   @return [String]
    #
    # @!attribute [rw] language_code
    #   The code for a language. This shows a supported language for the FAQ
    #   document as part of the summary information for FAQs. English is
    #   supported by default. For more information on supported languages,
    #   including their codes, see [Adding documents in languages other than
    #   English][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/FaqSummary AWS API Documentation
    #
    class FaqSummary < Struct.new(
      :id,
      :name,
      :status,
      :created_at,
      :updated_at,
      :file_format,
      :language_code)
      SENSITIVE = []
      include Aws::Structure
    end

    # A featured document. This document is displayed at the top of the
    # search results page, placed above all other results for certain
    # queries. If there's an exact match of a query, then the document is
    # featured in the search results.
    #
    # @!attribute [rw] id
    #   The identifier of the document to feature in the search results. You
    #   can use the [Query][1] API to search for specific documents with
    #   their document IDs included in the result items, or you can use the
    #   console.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_Query.html
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/FeaturedDocument AWS API Documentation
    #
    class FeaturedDocument < Struct.new(
      :id)
      SENSITIVE = []
      include Aws::Structure
    end

    # A document ID doesn't exist but you have specified as a featured
    # document. Amazon Kendra cannot feature the document if it doesn't
    # exist in the index. You can check the status of a document and its ID
    # or check for documents with status errors using the
    # [BatchGetDocumentStatus][1] API.
    #
    #
    #
    # [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_BatchGetDocumentStatus.html
    #
    # @!attribute [rw] id
    #   The identifier of the document that doesn't exist but you have
    #   specified as a featured document.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/FeaturedDocumentMissing AWS API Documentation
    #
    class FeaturedDocumentMissing < Struct.new(
      :id)
      SENSITIVE = []
      include Aws::Structure
    end

    # A featured document with its metadata information. This document is
    # displayed at the top of the search results page, placed above all
    # other results for certain queries. If there's an exact match of a
    # query, then the document is featured in the search results.
    #
    # @!attribute [rw] id
    #   The identifier of the featured document with its metadata. You can
    #   use the [Query][1] API to search for specific documents with their
    #   document IDs included in the result items, or you can use the
    #   console.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_Query.html
    #   @return [String]
    #
    # @!attribute [rw] title
    #   The main title of the featured document.
    #   @return [String]
    #
    # @!attribute [rw] uri
    #   The source URI location of the featured document.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/FeaturedDocumentWithMetadata AWS API Documentation
    #
    class FeaturedDocumentWithMetadata < Struct.new(
      :id,
      :title,
      :uri)
      SENSITIVE = []
      include Aws::Structure
    end

    # An error message with a list of conflicting queries used across
    # different sets of featured results. This occurred with the request for
    # a new featured results set. Check that the queries you specified for
    # featured results are unique per featured results set for each index.
    #
    # @!attribute [rw] message
    #   An explanation for the conflicting queries.
    #   @return [String]
    #
    # @!attribute [rw] conflicting_items
    #   A list of the conflicting queries, including the query text, the
    #   name for the featured results set, and the identifier of the
    #   featured results set.
    #   @return [Array<Types::ConflictingItem>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/FeaturedResultsConflictException AWS API Documentation
    #
    class FeaturedResultsConflictException < Struct.new(
      :message,
      :conflicting_items)
      SENSITIVE = []
      include Aws::Structure
    end

    # A single featured result item. A featured result is displayed at the
    # top of the search results page, placed above all other results for
    # certain queries. If there's an exact match of a query, then certain
    # documents are featured in the search results.
    #
    # @!attribute [rw] id
    #   The identifier of the featured result.
    #   @return [String]
    #
    # @!attribute [rw] type
    #   The type of document within the featured result response. For
    #   example, a response could include a question-answer type that's
    #   relevant to the query.
    #   @return [String]
    #
    # @!attribute [rw] additional_attributes
    #   One or more additional attributes associated with the featured
    #   result.
    #   @return [Array<Types::AdditionalResultAttribute>]
    #
    # @!attribute [rw] document_id
    #   The identifier of the featured document.
    #   @return [String]
    #
    # @!attribute [rw] document_title
    #   Provides text and information about where to highlight the text.
    #   @return [Types::TextWithHighlights]
    #
    # @!attribute [rw] document_excerpt
    #   Provides text and information about where to highlight the text.
    #   @return [Types::TextWithHighlights]
    #
    # @!attribute [rw] document_uri
    #   The source URI location of the featured document.
    #   @return [String]
    #
    # @!attribute [rw] document_attributes
    #   An array of document attributes assigned to a featured document in
    #   the search results. For example, the document author (`_author`) or
    #   the source URI (`_source_uri`) of the document.
    #   @return [Array<Types::DocumentAttribute>]
    #
    # @!attribute [rw] feedback_token
    #   A token that identifies a particular featured result from a
    #   particular query. Use this token to provide click-through feedback
    #   for the result. For more information, see [Submitting feedback][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/submitting-feedback.html
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/FeaturedResultsItem AWS API Documentation
    #
    class FeaturedResultsItem < Struct.new(
      :id,
      :type,
      :additional_attributes,
      :document_id,
      :document_title,
      :document_excerpt,
      :document_uri,
      :document_attributes,
      :feedback_token)
      SENSITIVE = []
      include Aws::Structure
    end

    # A set of featured results that are displayed at the top of your search
    # results. Featured results are placed above all other results for
    # certain queries. If there's an exact match of a query, then one or
    # more specific documents are featured in the search results.
    #
    # @!attribute [rw] featured_results_set_id
    #   The identifier of the set of featured results.
    #   @return [String]
    #
    # @!attribute [rw] featured_results_set_name
    #   The name for the set of featured results.
    #   @return [String]
    #
    # @!attribute [rw] description
    #   The description for the set of featured results.
    #   @return [String]
    #
    # @!attribute [rw] status
    #   The current status of the set of featured results. When the value is
    #   `ACTIVE`, featured results are ready for use. You can still
    #   configure your settings before setting the status to `ACTIVE`. You
    #   can set the status to `ACTIVE` or `INACTIVE` using the
    #   [UpdateFeaturedResultsSet][1] API. The queries you specify for
    #   featured results must be unique per featured results set for each
    #   index, whether the status is `ACTIVE` or `INACTIVE`.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateFeaturedResultsSet.html
    #   @return [String]
    #
    # @!attribute [rw] query_texts
    #   The list of queries for featuring results.
    #
    #   Specific queries are mapped to specific documents for featuring in
    #   the results. If a query contains an exact match, then one or more
    #   specific documents are featured in the results. The exact match
    #   applies to the full query. For example, if you only specify
    #   'Kendra', queries such as 'How does kendra semantically rank
    #   results?' will not render the featured results. Featured results
    #   are designed for specific queries, rather than queries that are too
    #   broad in scope.
    #   @return [Array<String>]
    #
    # @!attribute [rw] featured_documents
    #   The list of document IDs for the documents you want to feature at
    #   the top of the search results page. You can use the [Query][1] API
    #   to search for specific documents with their document IDs included in
    #   the result items, or you can use the console.
    #
    #   You can add up to four featured documents. You can request to
    #   increase this limit by contacting [Support][2].
    #
    #   Specific queries are mapped to specific documents for featuring in
    #   the results. If a query contains an exact match, then one or more
    #   specific documents are featured in the results. The exact match
    #   applies to the full query. For example, if you only specify
    #   'Kendra', queries such as 'How does kendra semantically rank
    #   results?' will not render the featured results. Featured results
    #   are designed for specific queries, rather than queries that are too
    #   broad in scope.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_Query.html
    #   [2]: http://aws.amazon.com/contact-us/
    #   @return [Array<Types::FeaturedDocument>]
    #
    # @!attribute [rw] last_updated_timestamp
    #   The Unix timestamp when the set of featured results was last
    #   updated.
    #   @return [Integer]
    #
    # @!attribute [rw] creation_timestamp
    #   The Unix timestamp when the set of featured results was created.
    #   @return [Integer]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/FeaturedResultsSet AWS API Documentation
    #
    class FeaturedResultsSet < Struct.new(
      :featured_results_set_id,
      :featured_results_set_name,
      :description,
      :status,
      :query_texts,
      :featured_documents,
      :last_updated_timestamp,
      :creation_timestamp)
      SENSITIVE = []
      include Aws::Structure
    end

    # Summary information for a set of featured results. Featured results
    # are placed above all other results for certain queries. If there's an
    # exact match of a query, then one or more specific documents are
    # featured in the search results.
    #
    # @!attribute [rw] featured_results_set_id
    #   The identifier of the set of featured results.
    #   @return [String]
    #
    # @!attribute [rw] featured_results_set_name
    #   The name for the set of featured results.
    #   @return [String]
    #
    # @!attribute [rw] status
    #   The current status of the set of featured results. When the value is
    #   `ACTIVE`, featured results are ready for use. You can still
    #   configure your settings before setting the status to `ACTIVE`. You
    #   can set the status to `ACTIVE` or `INACTIVE` using the
    #   [UpdateFeaturedResultsSet][1] API. The queries you specify for
    #   featured results must be unique per featured results set for each
    #   index, whether the status is `ACTIVE` or `INACTIVE`.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateFeaturedResultsSet.html
    #   @return [String]
    #
    # @!attribute [rw] last_updated_timestamp
    #   The Unix timestamp when the set of featured results was last
    #   updated.
    #   @return [Integer]
    #
    # @!attribute [rw] creation_timestamp
    #   The Unix timestamp when the set of featured results was created.
    #   @return [Integer]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/FeaturedResultsSetSummary AWS API Documentation
    #
    class FeaturedResultsSetSummary < Struct.new(
      :featured_results_set_id,
      :featured_results_set_name,
      :status,
      :last_updated_timestamp,
      :creation_timestamp)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides the configuration information to connect to Amazon FSx as
    # your data source.
    #
    # <note markdown="1"> Amazon Kendra now supports an upgraded Amazon FSx Windows connector.
    #
    #  You must now use the [TemplateConfiguration][1] object instead of the
    # `FsxConfiguration` object to configure your connector.
    #
    #  Connectors configured using the older console and API architecture
    # will continue to function as configured. However, you won't be able
    # to edit or update them. If you want to edit or update your connector
    # configuration, you must create a new connector.
    #
    #  We recommended migrating your connector workflow to the upgraded
    # version. Support for connectors configured using the older
    # architecture is scheduled to end by June 2024.
    #
    #  </note>
    #
    #
    #
    # [1]: https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html
    #
    # @!attribute [rw] file_system_id
    #   The identifier of the Amazon FSx file system.
    #
    #   You can find your file system ID on the file system dashboard in the
    #   Amazon FSx console. For information on how to create a file system
    #   in Amazon FSx console, using Windows File Server as an example, see
    #   [Amazon FSx Getting started guide][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/getting-started-step1.html
    #   @return [String]
    #
    # @!attribute [rw] file_system_type
    #   The Amazon FSx file system type. Windows is currently the only
    #   supported type.
    #   @return [String]
    #
    # @!attribute [rw] vpc_configuration
    #   Configuration information for an Amazon Virtual Private Cloud to
    #   connect to your Amazon FSx. Your Amazon FSx instance must reside
    #   inside your VPC.
    #   @return [Types::DataSourceVpcConfiguration]
    #
    # @!attribute [rw] secret_arn
    #   The Amazon Resource Name (ARN) of an Secrets Manager secret that
    #   contains the key-value pairs required to connect to your Amazon FSx
    #   file system. Windows is currently the only supported type. The
    #   secret must contain a JSON structure with the following keys:
    #
    #   * username—The Active Directory user name, along with the Domain
    #     Name System (DNS) domain name. For example,
    #     *user@corp.example.com*. The Active Directory user account must
    #     have read and mounting access to the Amazon FSx file system for
    #     Windows.
    #
    #   * password—The password of the Active Directory user account with
    #     read and mounting access to the Amazon FSx Windows file system.
    #   @return [String]
    #
    # @!attribute [rw] inclusion_patterns
    #   A list of regular expression patterns to include certain files in
    #   your Amazon FSx file system. Files that match the patterns are
    #   included in the index. Files that don't match the patterns are
    #   excluded from the index. If a file matches both an inclusion and
    #   exclusion pattern, the exclusion pattern takes precedence and the
    #   file isn't included in the index.
    #   @return [Array<String>]
    #
    # @!attribute [rw] exclusion_patterns
    #   A list of regular expression patterns to exclude certain files in
    #   your Amazon FSx file system. Files that match the patterns are
    #   excluded from the index. Files that don't match the patterns are
    #   included in the index. If a file matches both an inclusion and
    #   exclusion pattern, the exclusion pattern takes precedence and the
    #   file isn't included in the index.
    #   @return [Array<String>]
    #
    # @!attribute [rw] field_mappings
    #   A list of `DataSourceToIndexFieldMapping` objects that map Amazon
    #   FSx data source attributes or field names to Amazon Kendra index
    #   field names. To create custom fields, use the `UpdateIndex` API
    #   before you map to Amazon FSx fields. For more information, see
    #   [Mapping data source fields][1]. The Amazon FSx data source field
    #   names must exist in your Amazon FSx custom metadata.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
    #   @return [Array<Types::DataSourceToIndexFieldMapping>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/FsxConfiguration AWS API Documentation
    #
    class FsxConfiguration < Struct.new(
      :file_system_id,
      :file_system_type,
      :vpc_configuration,
      :secret_arn,
      :inclusion_patterns,
      :exclusion_patterns,
      :field_mappings)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] index_id
    #   The identifier of the index you want to get query suggestions from.
    #   @return [String]
    #
    # @!attribute [rw] query_text
    #   The text of a user's query to generate query suggestions.
    #
    #   A query is suggested if the query prefix matches what a user starts
    #   to type as their query.
    #
    #   Amazon Kendra does not show any suggestions if a user types fewer
    #   than two characters or more than 60 characters. A query must also
    #   have at least one search result and contain at least one word of
    #   more than four characters.
    #   @return [String]
    #
    # @!attribute [rw] max_suggestions_count
    #   The maximum number of query suggestions you want to show to your
    #   users.
    #   @return [Integer]
    #
    # @!attribute [rw] suggestion_types
    #   The suggestions type to base query suggestions on. The suggestion
    #   types are query history or document fields/attributes. You can set
    #   one type or the other.
    #
    #   If you set query history as your suggestions type, Amazon Kendra
    #   suggests queries relevant to your users based on popular queries in
    #   the query history.
    #
    #   If you set document fields/attributes as your suggestions type,
    #   Amazon Kendra suggests queries relevant to your users based on the
    #   contents of document fields.
    #   @return [Array<String>]
    #
    # @!attribute [rw] attribute_suggestions_config
    #   Configuration information for the document fields/attributes that
    #   you want to base query suggestions on.
    #   @return [Types::AttributeSuggestionsGetConfig]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/GetQuerySuggestionsRequest AWS API Documentation
    #
    class GetQuerySuggestionsRequest < Struct.new(
      :index_id,
      :query_text,
      :max_suggestions_count,
      :suggestion_types,
      :attribute_suggestions_config)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] query_suggestions_id
    #   The identifier for a list of query suggestions for an index.
    #   @return [String]
    #
    # @!attribute [rw] suggestions
    #   A list of query suggestions for an index.
    #   @return [Array<Types::Suggestion>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/GetQuerySuggestionsResponse AWS API Documentation
    #
    class GetQuerySuggestionsResponse < Struct.new(
      :query_suggestions_id,
      :suggestions)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] index_id
    #   The identifier of the index to get search metrics data.
    #   @return [String]
    #
    # @!attribute [rw] interval
    #   The time interval or time window to get search metrics data. The
    #   time interval uses the time zone of your index. You can view data in
    #   the following time windows:
    #
    #   * `THIS_WEEK`: The current week, starting on the Sunday and ending
    #     on the day before the current date.
    #
    #   * `ONE_WEEK_AGO`: The previous week, starting on the Sunday and
    #     ending on the following Saturday.
    #
    #   * `TWO_WEEKS_AGO`: The week before the previous week, starting on
    #     the Sunday and ending on the following Saturday.
    #
    #   * `THIS_MONTH`: The current month, starting on the first day of the
    #     month and ending on the day before the current date.
    #
    #   * `ONE_MONTH_AGO`: The previous month, starting on the first day of
    #     the month and ending on the last day of the month.
    #
    #   * `TWO_MONTHS_AGO`: The month before the previous month, starting on
    #     the first day of the month and ending on last day of the month.
    #   @return [String]
    #
    # @!attribute [rw] metric_type
    #   The metric you want to retrieve. You can specify only one metric per
    #   call.
    #
    #   For more information about the metrics you can view, see [Gaining
    #   insights with search analytics][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/search-analytics.html
    #   @return [String]
    #
    # @!attribute [rw] next_token
    #   If the previous response was incomplete (because there is more data
    #   to retrieve), Amazon Kendra returns a pagination token in the
    #   response. You can use this pagination token to retrieve the next set
    #   of search metrics data.
    #   @return [String]
    #
    # @!attribute [rw] max_results
    #   The maximum number of returned data for the metric.
    #   @return [Integer]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/GetSnapshotsRequest AWS API Documentation
    #
    class GetSnapshotsRequest < Struct.new(
      :index_id,
      :interval,
      :metric_type,
      :next_token,
      :max_results)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] snap_shot_time_filter
    #   The Unix timestamp for the beginning and end of the time window for
    #   the search metrics data.
    #   @return [Types::TimeRange]
    #
    # @!attribute [rw] snapshots_data_header
    #   The column headers for the search metrics data.
    #   @return [Array<String>]
    #
    # @!attribute [rw] snapshots_data
    #   The search metrics data. The data returned depends on the metric
    #   type you requested.
    #   @return [Array<Array<String>>]
    #
    # @!attribute [rw] next_token
    #   If the response is truncated, Amazon Kendra returns this token,
    #   which you can use in a later request to retrieve the next set of
    #   search metrics data.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/GetSnapshotsResponse AWS API Documentation
    #
    class GetSnapshotsResponse < Struct.new(
      :snap_shot_time_filter,
      :snapshots_data_header,
      :snapshots_data,
      :next_token)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides the configuration information to connect to GitHub as your
    # data source.
    #
    # <note markdown="1"> Amazon Kendra now supports an upgraded GitHub connector.
    #
    #  You must now use the [TemplateConfiguration][1] object instead of the
    # `GitHubConfiguration` object to configure your connector.
    #
    #  Connectors configured using the older console and API architecture
    # will continue to function as configured. However, you won’t be able to
    # edit or update them. If you want to edit or update your connector
    # configuration, you must create a new connector.
    #
    #  We recommended migrating your connector workflow to the upgraded
    # version. Support for connectors configured using the older
    # architecture is scheduled to end by June 2024.
    #
    #  </note>
    #
    #
    #
    # [1]: https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html
    #
    # @!attribute [rw] saa_s_configuration
    #   Configuration information to connect to GitHub Enterprise Cloud
    #   (SaaS).
    #   @return [Types::SaaSConfiguration]
    #
    # @!attribute [rw] on_premise_configuration
    #   Configuration information to connect to GitHub Enterprise Server (on
    #   premises).
    #   @return [Types::OnPremiseConfiguration]
    #
    # @!attribute [rw] type
    #   The type of GitHub service you want to connect to—GitHub Enterprise
    #   Cloud (SaaS) or GitHub Enterprise Server (on premises).
    #   @return [String]
    #
    # @!attribute [rw] secret_arn
    #   The Amazon Resource Name (ARN) of an Secrets Manager secret that
    #   contains the key-value pairs required to connect to your GitHub. The
    #   secret must contain a JSON structure with the following keys:
    #
    #   * personalToken—The access token created in GitHub. For more
    #     information on creating a token in GitHub, see [Using a GitHub
    #     data source][1].
    #
    #   ^
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/data-source-github.html
    #   @return [String]
    #
    # @!attribute [rw] use_change_log
    #   `TRUE` to use the GitHub change log to determine which documents
    #   require updating in the index. Depending on the GitHub change log's
    #   size, it may take longer for Amazon Kendra to use the change log
    #   than to scan all of your documents in GitHub.
    #   @return [Boolean]
    #
    # @!attribute [rw] git_hub_document_crawl_properties
    #   Configuration information to include certain types of GitHub
    #   content. You can configure to index repository files only, or also
    #   include issues and pull requests, comments, and comment attachments.
    #   @return [Types::GitHubDocumentCrawlProperties]
    #
    # @!attribute [rw] repository_filter
    #   A list of names of the specific repositories you want to index.
    #   @return [Array<String>]
    #
    # @!attribute [rw] inclusion_folder_name_patterns
    #   A list of regular expression patterns to include certain folder
    #   names in your GitHub repository or repositories. Folder names that
    #   match the patterns are included in the index. Folder names that
    #   don't match the patterns are excluded from the index. If a folder
    #   matches both an inclusion and exclusion pattern, the exclusion
    #   pattern takes precedence and the folder isn't included in the
    #   index.
    #   @return [Array<String>]
    #
    # @!attribute [rw] inclusion_file_type_patterns
    #   A list of regular expression patterns to include certain file types
    #   in your GitHub repository or repositories. File types that match the
    #   patterns are included in the index. File types that don't match the
    #   patterns are excluded from the index. If a file matches both an
    #   inclusion and exclusion pattern, the exclusion pattern takes
    #   precedence and the file isn't included in the index.
    #   @return [Array<String>]
    #
    # @!attribute [rw] inclusion_file_name_patterns
    #   A list of regular expression patterns to include certain file names
    #   in your GitHub repository or repositories. File names that match the
    #   patterns are included in the index. File names that don't match the
    #   patterns are excluded from the index. If a file matches both an
    #   inclusion and exclusion pattern, the exclusion pattern takes
    #   precedence and the file isn't included in the index.
    #   @return [Array<String>]
    #
    # @!attribute [rw] exclusion_folder_name_patterns
    #   A list of regular expression patterns to exclude certain folder
    #   names in your GitHub repository or repositories. Folder names that
    #   match the patterns are excluded from the index. Folder names that
    #   don't match the patterns are included in the index. If a folder
    #   matches both an exclusion and inclusion pattern, the exclusion
    #   pattern takes precedence and the folder isn't included in the
    #   index.
    #   @return [Array<String>]
    #
    # @!attribute [rw] exclusion_file_type_patterns
    #   A list of regular expression patterns to exclude certain file types
    #   in your GitHub repository or repositories. File types that match the
    #   patterns are excluded from the index. File types that don't match
    #   the patterns are included in the index. If a file matches both an
    #   exclusion and inclusion pattern, the exclusion pattern takes
    #   precedence and the file isn't included in the index.
    #   @return [Array<String>]
    #
    # @!attribute [rw] exclusion_file_name_patterns
    #   A list of regular expression patterns to exclude certain file names
    #   in your GitHub repository or repositories. File names that match the
    #   patterns are excluded from the index. File names that don't match
    #   the patterns are included in the index. If a file matches both an
    #   exclusion and inclusion pattern, the exclusion pattern takes
    #   precedence and the file isn't included in the index.
    #   @return [Array<String>]
    #
    # @!attribute [rw] vpc_configuration
    #   Configuration information of an Amazon Virtual Private Cloud to
    #   connect to your GitHub. For more information, see [Configuring a
    #   VPC][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html
    #   @return [Types::DataSourceVpcConfiguration]
    #
    # @!attribute [rw] git_hub_repository_configuration_field_mappings
    #   A list of `DataSourceToIndexFieldMapping` objects that map GitHub
    #   repository attributes or field names to Amazon Kendra index field
    #   names. To create custom fields, use the `UpdateIndex` API before you
    #   map to GitHub fields. For more information, see [Mapping data source
    #   fields][1]. The GitHub data source field names must exist in your
    #   GitHub custom metadata.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
    #   @return [Array<Types::DataSourceToIndexFieldMapping>]
    #
    # @!attribute [rw] git_hub_commit_configuration_field_mappings
    #   A list of `DataSourceToIndexFieldMapping` objects that map
    #   attributes or field names of GitHub commits to Amazon Kendra index
    #   field names. To create custom fields, use the `UpdateIndex` API
    #   before you map to GitHub fields. For more information, see [Mapping
    #   data source fields][1]. The GitHub data source field names must
    #   exist in your GitHub custom metadata.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
    #   @return [Array<Types::DataSourceToIndexFieldMapping>]
    #
    # @!attribute [rw] git_hub_issue_document_configuration_field_mappings
    #   A list of `DataSourceToIndexFieldMapping` objects that map
    #   attributes or field names of GitHub issues to Amazon Kendra index
    #   field names. To create custom fields, use the `UpdateIndex` API
    #   before you map to GitHub fields. For more information, see [Mapping
    #   data source fields][1]. The GitHub data source field names must
    #   exist in your GitHub custom metadata.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
    #   @return [Array<Types::DataSourceToIndexFieldMapping>]
    #
    # @!attribute [rw] git_hub_issue_comment_configuration_field_mappings
    #   A list of `DataSourceToIndexFieldMapping` objects that map
    #   attributes or field names of GitHub issue comments to Amazon Kendra
    #   index field names. To create custom fields, use the `UpdateIndex`
    #   API before you map to GitHub fields. For more information, see
    #   [Mapping data source fields][1]. The GitHub data source field names
    #   must exist in your GitHub custom metadata.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
    #   @return [Array<Types::DataSourceToIndexFieldMapping>]
    #
    # @!attribute [rw] git_hub_issue_attachment_configuration_field_mappings
    #   A list of `DataSourceToIndexFieldMapping` objects that map
    #   attributes or field names of GitHub issue attachments to Amazon
    #   Kendra index field names. To create custom fields, use the
    #   `UpdateIndex` API before you map to GitHub fields. For more
    #   information, see [Mapping data source fields][1]. The GitHub data
    #   source field names must exist in your GitHub custom metadata.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
    #   @return [Array<Types::DataSourceToIndexFieldMapping>]
    #
    # @!attribute [rw] git_hub_pull_request_comment_configuration_field_mappings
    #   A list of `DataSourceToIndexFieldMapping` objects that map
    #   attributes or field names of GitHub pull request comments to Amazon
    #   Kendra index field names. To create custom fields, use the
    #   `UpdateIndex` API before you map to GitHub fields. For more
    #   information, see [Mapping data source fields][1]. The GitHub data
    #   source field names must exist in your GitHub custom metadata.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
    #   @return [Array<Types::DataSourceToIndexFieldMapping>]
    #
    # @!attribute [rw] git_hub_pull_request_document_configuration_field_mappings
    #   A list of `DataSourceToIndexFieldMapping` objects that map
    #   attributes or field names of GitHub pull requests to Amazon Kendra
    #   index field names. To create custom fields, use the `UpdateIndex`
    #   API before you map to GitHub fields. For more information, see
    #   [Mapping data source fields][1]. The GitHub data source field names
    #   must exist in your GitHub custom metadata.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
    #   @return [Array<Types::DataSourceToIndexFieldMapping>]
    #
    # @!attribute [rw] git_hub_pull_request_document_attachment_configuration_field_mappings
    #   A list of `DataSourceToIndexFieldMapping` objects that map
    #   attributes or field names of GitHub pull request attachments to
    #   Amazon Kendra index field names. To create custom fields, use the
    #   `UpdateIndex` API before you map to GitHub fields. For more
    #   information, see [Mapping data source fields][1]. The GitHub data
    #   source field names must exist in your GitHub custom metadata.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
    #   @return [Array<Types::DataSourceToIndexFieldMapping>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/GitHubConfiguration AWS API Documentation
    #
    class GitHubConfiguration < Struct.new(
      :saa_s_configuration,
      :on_premise_configuration,
      :type,
      :secret_arn,
      :use_change_log,
      :git_hub_document_crawl_properties,
      :repository_filter,
      :inclusion_folder_name_patterns,
      :inclusion_file_type_patterns,
      :inclusion_file_name_patterns,
      :exclusion_folder_name_patterns,
      :exclusion_file_type_patterns,
      :exclusion_file_name_patterns,
      :vpc_configuration,
      :git_hub_repository_configuration_field_mappings,
      :git_hub_commit_configuration_field_mappings,
      :git_hub_issue_document_configuration_field_mappings,
      :git_hub_issue_comment_configuration_field_mappings,
      :git_hub_issue_attachment_configuration_field_mappings,
      :git_hub_pull_request_comment_configuration_field_mappings,
      :git_hub_pull_request_document_configuration_field_mappings,
      :git_hub_pull_request_document_attachment_configuration_field_mappings)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides the configuration information to include certain types of
    # GitHub content. You can configure to index repository files only, or
    # also include issues and pull requests, comments, and comment
    # attachments.
    #
    # @!attribute [rw] crawl_repository_documents
    #   `TRUE` to index all files with a repository.
    #   @return [Boolean]
    #
    # @!attribute [rw] crawl_issue
    #   `TRUE` to index all issues within a repository.
    #   @return [Boolean]
    #
    # @!attribute [rw] crawl_issue_comment
    #   `TRUE` to index all comments on issues.
    #   @return [Boolean]
    #
    # @!attribute [rw] crawl_issue_comment_attachment
    #   `TRUE` to include all comment attachments for issues.
    #   @return [Boolean]
    #
    # @!attribute [rw] crawl_pull_request
    #   `TRUE` to index all pull requests within a repository.
    #   @return [Boolean]
    #
    # @!attribute [rw] crawl_pull_request_comment
    #   `TRUE` to index all comments on pull requests.
    #   @return [Boolean]
    #
    # @!attribute [rw] crawl_pull_request_comment_attachment
    #   `TRUE` to include all comment attachments for pull requests.
    #   @return [Boolean]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/GitHubDocumentCrawlProperties AWS API Documentation
    #
    class GitHubDocumentCrawlProperties < Struct.new(
      :crawl_repository_documents,
      :crawl_issue,
      :crawl_issue_comment,
      :crawl_issue_comment_attachment,
      :crawl_pull_request,
      :crawl_pull_request_comment,
      :crawl_pull_request_comment_attachment)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides the configuration information to connect to Google Drive as
    # your data source.
    #
    # @!attribute [rw] secret_arn
    #   The Amazon Resource Name (ARN) of a Secrets Managersecret that
    #   contains the credentials required to connect to Google Drive. For
    #   more information, see [Using a Google Workspace Drive data
    #   source][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/data-source-google-drive.html
    #   @return [String]
    #
    # @!attribute [rw] inclusion_patterns
    #   A list of regular expression patterns to include certain items in
    #   your Google Drive, including shared drives and users' My Drives.
    #   Items that match the patterns are included in the index. Items that
    #   don't match the patterns are excluded from the index. If an item
    #   matches both an inclusion and exclusion pattern, the exclusion
    #   pattern takes precedence and the item isn't included in the index.
    #   @return [Array<String>]
    #
    # @!attribute [rw] exclusion_patterns
    #   A list of regular expression patterns to exclude certain items in
    #   your Google Drive, including shared drives and users' My Drives.
    #   Items that match the patterns are excluded from the index. Items
    #   that don't match the patterns are included in the index. If an item
    #   matches both an inclusion and exclusion pattern, the exclusion
    #   pattern takes precedence and the item isn't included in the index.
    #   @return [Array<String>]
    #
    # @!attribute [rw] field_mappings
    #   Maps Google Drive data source attributes or field names to Amazon
    #   Kendra index field names. To create custom fields, use the
    #   `UpdateIndex` API before you map to Google Drive fields. For more
    #   information, see [Mapping data source fields][1]. The Google Drive
    #   data source field names must exist in your Google Drive custom
    #   metadata.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
    #   @return [Array<Types::DataSourceToIndexFieldMapping>]
    #
    # @!attribute [rw] exclude_mime_types
    #   A list of MIME types to exclude from the index. All documents
    #   matching the specified MIME type are excluded.
    #
    #   For a list of MIME types, see [Using a Google Workspace Drive data
    #   source][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/data-source-google-drive.html
    #   @return [Array<String>]
    #
    # @!attribute [rw] exclude_user_accounts
    #   A list of email addresses of the users. Documents owned by these
    #   users are excluded from the index. Documents shared with excluded
    #   users are indexed unless they are excluded in another way.
    #   @return [Array<String>]
    #
    # @!attribute [rw] exclude_shared_drives
    #   A list of identifiers or shared drives to exclude from the index.
    #   All files and folders stored on the shared drive are excluded.
    #   @return [Array<String>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/GoogleDriveConfiguration AWS API Documentation
    #
    class GoogleDriveConfiguration < Struct.new(
      :secret_arn,
      :inclusion_patterns,
      :exclusion_patterns,
      :field_mappings,
      :exclude_mime_types,
      :exclude_user_accounts,
      :exclude_shared_drives)
      SENSITIVE = []
      include Aws::Structure
    end

    # A list of users or sub groups that belong to a group. This is useful
    # for user context filtering, where search results are filtered based on
    # the user or their group access to documents.
    #
    # @!attribute [rw] member_groups
    #   A list of sub groups that belong to a group. For example, the sub
    #   groups "Research", "Engineering", and "Sales and Marketing"
    #   all belong to the group "Company".
    #   @return [Array<Types::MemberGroup>]
    #
    # @!attribute [rw] member_users
    #   A list of users that belong to a group. For example, a list of
    #   interns all belong to the "Interns" group.
    #   @return [Array<Types::MemberUser>]
    #
    # @!attribute [rw] s3_pathfor_group_members
    #   If you have more than 1000 users and/or sub groups for a single
    #   group, you need to provide the path to the S3 file that lists your
    #   users and sub groups for a group. Your sub groups can contain more
    #   than 1000 users, but the list of sub groups that belong to a group
    #   (and/or users) must be no more than 1000.
    #
    #   You can download this [example S3 file][1] that uses the correct
    #   format for listing group members. Note, `dataSourceId` is optional.
    #   The value of `type` for a group is always `GROUP` and for a user it
    #   is always `USER`.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/samples/group_members.zip
    #   @return [Types::S3Path]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/GroupMembers AWS API Documentation
    #
    class GroupMembers < Struct.new(
      :member_groups,
      :member_users,
      :s3_pathfor_group_members)
      SENSITIVE = []
      include Aws::Structure
    end

    # Summary information on the processing of `PUT` and `DELETE` actions
    # for mapping users to their groups.
    #
    # @!attribute [rw] status
    #   The current processing status of actions for mapping users to their
    #   groups. The status can be either `PROCESSING`, `SUCCEEDED`,
    #   `DELETING`, `DELETED`, or `FAILED`.
    #   @return [String]
    #
    # @!attribute [rw] last_updated_at
    #   The Unix timestamp when an action was last updated. An action can be
    #   a `PUT` or `DELETE` action for mapping users to their groups.
    #   @return [Time]
    #
    # @!attribute [rw] received_at
    #   The Unix timestamp when an action was received by Amazon Kendra. An
    #   action can be a `PUT` or `DELETE` action for mapping users to their
    #   groups.
    #   @return [Time]
    #
    # @!attribute [rw] ordering_id
    #   The order in which actions should complete processing. An action can
    #   be a `PUT` or `DELETE` action for mapping users to their groups.
    #   @return [Integer]
    #
    # @!attribute [rw] failure_reason
    #   The reason an action could not be processed. An action can be a
    #   `PUT` or `DELETE` action for mapping users to their groups.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/GroupOrderingIdSummary AWS API Documentation
    #
    class GroupOrderingIdSummary < Struct.new(
      :status,
      :last_updated_at,
      :received_at,
      :ordering_id,
      :failure_reason)
      SENSITIVE = []
      include Aws::Structure
    end

    # Summary information for groups.
    #
    # @!attribute [rw] group_id
    #   The identifier of the group you want group summary information on.
    #   @return [String]
    #
    # @!attribute [rw] ordering_id
    #   The timestamp identifier used for the latest `PUT` or `DELETE`
    #   action.
    #   @return [Integer]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/GroupSummary AWS API Documentation
    #
    class GroupSummary < Struct.new(
      :group_id,
      :ordering_id)
      SENSITIVE = []
      include Aws::Structure
    end

    # Information to define the hierarchy for which documents users should
    # have access to.
    #
    # @!attribute [rw] principal_list
    #   A list of [principal][1] lists that define the hierarchy for which
    #   documents users should have access to. Each hierarchical list
    #   specifies which user or group has allow or deny access for each
    #   document.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_Principal.html
    #   @return [Array<Types::Principal>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/HierarchicalPrincipal AWS API Documentation
    #
    class HierarchicalPrincipal < Struct.new(
      :principal_list)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides information that you can use to highlight a search result so
    # that your users can quickly identify terms in the response.
    #
    # @!attribute [rw] begin_offset
    #   The zero-based location in the response string where the highlight
    #   starts.
    #   @return [Integer]
    #
    # @!attribute [rw] end_offset
    #   The zero-based location in the response string where the highlight
    #   ends.
    #   @return [Integer]
    #
    # @!attribute [rw] top_answer
    #   Indicates whether the response is the best response. True if this is
    #   the best response; otherwise, false.
    #   @return [Boolean]
    #
    # @!attribute [rw] type
    #   The highlight type.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/Highlight AWS API Documentation
    #
    class Highlight < Struct.new(
      :begin_offset,
      :end_offset,
      :top_answer,
      :type)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides the configuration information for invoking a Lambda function
    # in Lambda to alter document metadata and content when ingesting
    # documents into Amazon Kendra. You can configure your Lambda function
    # using [PreExtractionHookConfiguration][1] if you want to apply
    # advanced alterations on the original or raw documents. If you want to
    # apply advanced alterations on the Amazon Kendra structured documents,
    # you must configure your Lambda function using
    # [PostExtractionHookConfiguration][1]. You can only invoke one Lambda
    # function. However, this function can invoke other functions it
    # requires.
    #
    # For more information, see [Customizing document metadata during the
    # ingestion process][2].
    #
    #
    #
    # [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_CustomDocumentEnrichmentConfiguration.html
    # [2]: https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html
    #
    # @!attribute [rw] invocation_condition
    #   The condition used for when a Lambda function should be invoked.
    #
    #   For example, you can specify a condition that if there are empty
    #   date-time values, then Amazon Kendra should invoke a function that
    #   inserts the current date-time.
    #   @return [Types::DocumentAttributeCondition]
    #
    # @!attribute [rw] lambda_arn
    #   The Amazon Resource Name (ARN) of a role with permission to run a
    #   Lambda function during ingestion. For more information, see [IAM
    #   roles for Amazon Kendra][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html
    #   @return [String]
    #
    # @!attribute [rw] s3_bucket
    #   Stores the original, raw documents or the structured, parsed
    #   documents before and after altering them. For more information, see
    #   [Data contracts for Lambda functions][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html#cde-data-contracts-lambda
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/HookConfiguration AWS API Documentation
    #
    class HookConfiguration < Struct.new(
      :invocation_condition,
      :lambda_arn,
      :s3_bucket)
      SENSITIVE = []
      include Aws::Structure
    end

    # Summary information on the configuration of an index.
    #
    # @!attribute [rw] name
    #   The name of the index.
    #   @return [String]
    #
    # @!attribute [rw] id
    #   A identifier for the index. Use this to identify the index when you
    #   are using APIs such as `Query`, `DescribeIndex`, `UpdateIndex`, and
    #   `DeleteIndex`.
    #   @return [String]
    #
    # @!attribute [rw] edition
    #   Indicates whether the index is a Enterprise Edition index or a
    #   Developer Edition index.
    #   @return [String]
    #
    # @!attribute [rw] created_at
    #   The Unix timestamp when the index was created.
    #   @return [Time]
    #
    # @!attribute [rw] updated_at
    #   The Unix timestamp when the index was last updated.
    #   @return [Time]
    #
    # @!attribute [rw] status
    #   The current status of the index. When the status is `ACTIVE`, the
    #   index is ready to search.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/IndexConfigurationSummary AWS API Documentation
    #
    class IndexConfigurationSummary < Struct.new(
      :name,
      :id,
      :edition,
      :created_at,
      :updated_at,
      :status)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides information about the number of documents and the number of
    # questions and answers in an index.
    #
    # @!attribute [rw] faq_statistics
    #   The number of question and answer topics in the index.
    #   @return [Types::FaqStatistics]
    #
    # @!attribute [rw] text_document_statistics
    #   The number of text documents indexed.
    #   @return [Types::TextDocumentStatistics]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/IndexStatistics AWS API Documentation
    #
    class IndexStatistics < Struct.new(
      :faq_statistics,
      :text_document_statistics)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides the configuration information for applying basic logic to
    # alter document metadata and content when ingesting documents into
    # Amazon Kendra. To apply advanced logic, to go beyond what you can do
    # with basic logic, see [HookConfiguration][1].
    #
    # For more information, see [Customizing document metadata during the
    # ingestion process][2].
    #
    #
    #
    # [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_HookConfiguration.html
    # [2]: https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html
    #
    # @!attribute [rw] condition
    #   Configuration of the condition used for the target document
    #   attribute or metadata field when ingesting documents into Amazon
    #   Kendra.
    #   @return [Types::DocumentAttributeCondition]
    #
    # @!attribute [rw] target
    #   Configuration of the target document attribute or metadata field
    #   when ingesting documents into Amazon Kendra. You can also include a
    #   value.
    #   @return [Types::DocumentAttributeTarget]
    #
    # @!attribute [rw] document_content_deletion
    #   `TRUE` to delete content if the condition used for the target
    #   attribute is met.
    #   @return [Boolean]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/InlineCustomDocumentEnrichmentConfiguration AWS API Documentation
    #
    class InlineCustomDocumentEnrichmentConfiguration < Struct.new(
      :condition,
      :target,
      :document_content_deletion)
      SENSITIVE = []
      include Aws::Structure
    end

    # An issue occurred with the internal server used for your Amazon Kendra
    # service. Please wait a few minutes and try again, or contact
    # [Support][1] for help.
    #
    #
    #
    # [1]: http://aws.amazon.com/contact-us/
    #
    # @!attribute [rw] message
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/InternalServerException AWS API Documentation
    #
    class InternalServerException < Struct.new(
      :message)
      SENSITIVE = []
      include Aws::Structure
    end

    # The input to the request is not valid. Please provide the correct
    # input and try again.
    #
    # @!attribute [rw] message
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/InvalidRequestException AWS API Documentation
    #
    class InvalidRequestException < Struct.new(
      :message)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides the configuration information to connect to Jira as your data
    # source.
    #
    # @!attribute [rw] jira_account_url
    #   The URL of the Jira account. For example, *company.atlassian.net*.
    #   @return [String]
    #
    # @!attribute [rw] secret_arn
    #   The Amazon Resource Name (ARN) of a secret in Secrets Manager
    #   contains the key-value pairs required to connect to your Jira data
    #   source. The secret must contain a JSON structure with the following
    #   keys:
    #
    #   * jiraId—The Jira user name or email.
    #
    #   * jiraCredentials—The Jira API token. For more information, see
    #     [Using a Jira data source][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/data-source-jira.html
    #   @return [String]
    #
    # @!attribute [rw] use_change_log
    #   `TRUE` to use the Jira change log to determine which documents
    #   require updating in the index. Depending on the change log's size,
    #   it may take longer for Amazon Kendra to use the change log than to
    #   scan all of your documents in Jira.
    #   @return [Boolean]
    #
    # @!attribute [rw] project
    #   Specify which projects to crawl in your Jira data source. You can
    #   specify one or more Jira project IDs.
    #   @return [Array<String>]
    #
    # @!attribute [rw] issue_type
    #   Specify which issue types to crawl in your Jira data source. You can
    #   specify one or more of these options to crawl.
    #   @return [Array<String>]
    #
    # @!attribute [rw] status
    #   Specify which statuses to crawl in your Jira data source. You can
    #   specify one or more of these options to crawl.
    #   @return [Array<String>]
    #
    # @!attribute [rw] issue_sub_entity_filter
    #   Specify whether to crawl comments, attachments, and work logs. You
    #   can specify one or more of these options.
    #   @return [Array<String>]
    #
    # @!attribute [rw] attachment_field_mappings
    #   A list of `DataSourceToIndexFieldMapping` objects that map
    #   attributes or field names of Jira attachments to Amazon Kendra index
    #   field names. To create custom fields, use the `UpdateIndex` API
    #   before you map to Jira fields. For more information, see [ Mapping
    #   data source fields][1]. The Jira data source field names must exist
    #   in your Jira custom metadata.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
    #   @return [Array<Types::DataSourceToIndexFieldMapping>]
    #
    # @!attribute [rw] comment_field_mappings
    #   A list of `DataSourceToIndexFieldMapping` objects that map
    #   attributes or field names of Jira comments to Amazon Kendra index
    #   field names. To create custom fields, use the `UpdateIndex` API
    #   before you map to Jira fields. For more information, see [ Mapping
    #   data source fields][1]. The Jira data source field names must exist
    #   in your Jira custom metadata.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
    #   @return [Array<Types::DataSourceToIndexFieldMapping>]
    #
    # @!attribute [rw] issue_field_mappings
    #   A list of `DataSourceToIndexFieldMapping` objects that map
    #   attributes or field names of Jira issues to Amazon Kendra index
    #   field names. To create custom fields, use the `UpdateIndex` API
    #   before you map to Jira fields. For more information, see [ Mapping
    #   data source fields][1]. The Jira data source field names must exist
    #   in your Jira custom metadata.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
    #   @return [Array<Types::DataSourceToIndexFieldMapping>]
    #
    # @!attribute [rw] project_field_mappings
    #   A list of `DataSourceToIndexFieldMapping` objects that map
    #   attributes or field names of Jira projects to Amazon Kendra index
    #   field names. To create custom fields, use the `UpdateIndex` API
    #   before you map to Jira fields. For more information, see [ Mapping
    #   data source fields][1]. The Jira data source field names must exist
    #   in your Jira custom metadata.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
    #   @return [Array<Types::DataSourceToIndexFieldMapping>]
    #
    # @!attribute [rw] work_log_field_mappings
    #   A list of `DataSourceToIndexFieldMapping` objects that map
    #   attributes or field names of Jira work logs to Amazon Kendra index
    #   field names. To create custom fields, use the `UpdateIndex` API
    #   before you map to Jira fields. For more information, see [ Mapping
    #   data source fields][1]. The Jira data source field names must exist
    #   in your Jira custom metadata.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
    #   @return [Array<Types::DataSourceToIndexFieldMapping>]
    #
    # @!attribute [rw] inclusion_patterns
    #   A list of regular expression patterns to include certain file paths,
    #   file names, and file types in your Jira data source. Files that
    #   match the patterns are included in the index. Files that don't
    #   match the patterns are excluded from the index. If a file matches
    #   both an inclusion pattern and an exclusion pattern, the exclusion
    #   pattern takes precedence and the file isn't included in the index.
    #   @return [Array<String>]
    #
    # @!attribute [rw] exclusion_patterns
    #   A list of regular expression patterns to exclude certain file paths,
    #   file names, and file types in your Jira data source. Files that
    #   match the patterns are excluded from the index. Files that don’t
    #   match the patterns are included in the index. If a file matches both
    #   an inclusion pattern and an exclusion pattern, the exclusion pattern
    #   takes precedence and the file isn't included in the index.
    #   @return [Array<String>]
    #
    # @!attribute [rw] vpc_configuration
    #   Configuration information for an Amazon Virtual Private Cloud to
    #   connect to your Jira. For more information, see [Configuring a
    #   VPC][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html
    #   @return [Types::DataSourceVpcConfiguration]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/JiraConfiguration AWS API Documentation
    #
    class JiraConfiguration < Struct.new(
      :jira_account_url,
      :secret_arn,
      :use_change_log,
      :project,
      :issue_type,
      :status,
      :issue_sub_entity_filter,
      :attachment_field_mappings,
      :comment_field_mappings,
      :issue_field_mappings,
      :project_field_mappings,
      :work_log_field_mappings,
      :inclusion_patterns,
      :exclusion_patterns,
      :vpc_configuration)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides the configuration information for the JSON token type.
    #
    # @!attribute [rw] user_name_attribute_field
    #   The user name attribute field.
    #   @return [String]
    #
    # @!attribute [rw] group_attribute_field
    #   The group attribute field.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/JsonTokenTypeConfiguration AWS API Documentation
    #
    class JsonTokenTypeConfiguration < Struct.new(
      :user_name_attribute_field,
      :group_attribute_field)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides the configuration information for the JWT token type.
    #
    # @!attribute [rw] key_location
    #   The location of the key.
    #   @return [String]
    #
    # @!attribute [rw] url
    #   The signing key URL.
    #   @return [String]
    #
    # @!attribute [rw] secret_manager_arn
    #   The Amazon Resource Name (arn) of the secret.
    #   @return [String]
    #
    # @!attribute [rw] user_name_attribute_field
    #   The user name attribute field.
    #   @return [String]
    #
    # @!attribute [rw] group_attribute_field
    #   The group attribute field.
    #   @return [String]
    #
    # @!attribute [rw] issuer
    #   The issuer of the token.
    #   @return [String]
    #
    # @!attribute [rw] claim_regex
    #   The regular expression that identifies the claim.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/JwtTokenTypeConfiguration AWS API Documentation
    #
    class JwtTokenTypeConfiguration < Struct.new(
      :key_location,
      :url,
      :secret_manager_arn,
      :user_name_attribute_field,
      :group_attribute_field,
      :issuer,
      :claim_regex)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] index_id
    #   The identifier of the index for the access control configuration.
    #   @return [String]
    #
    # @!attribute [rw] next_token
    #   If the previous response was incomplete (because there's more data
    #   to retrieve), Amazon Kendra returns a pagination token in the
    #   response. You can use this pagination token to retrieve the next set
    #   of access control configurations.
    #   @return [String]
    #
    # @!attribute [rw] max_results
    #   The maximum number of access control configurations to return.
    #   @return [Integer]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListAccessControlConfigurationsRequest AWS API Documentation
    #
    class ListAccessControlConfigurationsRequest < Struct.new(
      :index_id,
      :next_token,
      :max_results)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] next_token
    #   If the response is truncated, Amazon Kendra returns this token,
    #   which you can use in the subsequent request to retrieve the next set
    #   of access control configurations.
    #   @return [String]
    #
    # @!attribute [rw] access_control_configurations
    #   The details of your access control configurations.
    #   @return [Array<Types::AccessControlConfigurationSummary>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListAccessControlConfigurationsResponse AWS API Documentation
    #
    class ListAccessControlConfigurationsResponse < Struct.new(
      :next_token,
      :access_control_configurations)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] id
    #   The identifier of the data source connector.
    #   @return [String]
    #
    # @!attribute [rw] index_id
    #   The identifier of the index used with the data source connector.
    #   @return [String]
    #
    # @!attribute [rw] next_token
    #   If the previous response was incomplete (because there is more data
    #   to retrieve), Amazon Kendra returns a pagination token in the
    #   response. You can use this pagination token to retrieve the next set
    #   of jobs.
    #   @return [String]
    #
    # @!attribute [rw] max_results
    #   The maximum number of synchronization jobs to return in the
    #   response. If there are fewer results in the list, this response
    #   contains only the actual results.
    #   @return [Integer]
    #
    # @!attribute [rw] start_time_filter
    #   When specified, the synchronization jobs returned in the list are
    #   limited to jobs between the specified dates.
    #   @return [Types::TimeRange]
    #
    # @!attribute [rw] status_filter
    #   Only returns synchronization jobs with the `Status` field equal to
    #   the specified status.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListDataSourceSyncJobsRequest AWS API Documentation
    #
    class ListDataSourceSyncJobsRequest < Struct.new(
      :id,
      :index_id,
      :next_token,
      :max_results,
      :start_time_filter,
      :status_filter)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] history
    #   A history of synchronization jobs for the data source connector.
    #   @return [Array<Types::DataSourceSyncJob>]
    #
    # @!attribute [rw] next_token
    #   If the response is truncated, Amazon Kendra returns this token that
    #   you can use in the subsequent request to retrieve the next set of
    #   jobs.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListDataSourceSyncJobsResponse AWS API Documentation
    #
    class ListDataSourceSyncJobsResponse < Struct.new(
      :history,
      :next_token)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] index_id
    #   The identifier of the index used with one or more data source
    #   connectors.
    #   @return [String]
    #
    # @!attribute [rw] next_token
    #   If the previous response was incomplete (because there is more data
    #   to retrieve), Amazon Kendra returns a pagination token in the
    #   response. You can use this pagination token to retrieve the next set
    #   of data source connectors.
    #   @return [String]
    #
    # @!attribute [rw] max_results
    #   The maximum number of data source connectors to return.
    #   @return [Integer]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListDataSourcesRequest AWS API Documentation
    #
    class ListDataSourcesRequest < Struct.new(
      :index_id,
      :next_token,
      :max_results)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] summary_items
    #   An array of summary information for one or more data source
    #   connector.
    #   @return [Array<Types::DataSourceSummary>]
    #
    # @!attribute [rw] next_token
    #   If the response is truncated, Amazon Kendra returns this token that
    #   you can use in the subsequent request to retrieve the next set of
    #   data source connectors.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListDataSourcesResponse AWS API Documentation
    #
    class ListDataSourcesResponse < Struct.new(
      :summary_items,
      :next_token)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] id
    #   The identifier of your Amazon Kendra experience.
    #   @return [String]
    #
    # @!attribute [rw] index_id
    #   The identifier of the index for your Amazon Kendra experience.
    #   @return [String]
    #
    # @!attribute [rw] next_token
    #   If the previous response was incomplete (because there is more data
    #   to retrieve), Amazon Kendra returns a pagination token in the
    #   response. You can use this pagination token to retrieve the next set
    #   of users or groups.
    #   @return [String]
    #
    # @!attribute [rw] max_results
    #   The maximum number of returned users or groups.
    #   @return [Integer]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListEntityPersonasRequest AWS API Documentation
    #
    class ListEntityPersonasRequest < Struct.new(
      :id,
      :index_id,
      :next_token,
      :max_results)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] summary_items
    #   An array of summary information for one or more users or groups.
    #   @return [Array<Types::PersonasSummary>]
    #
    # @!attribute [rw] next_token
    #   If the response is truncated, Amazon Kendra returns this token,
    #   which you can use in a later request to retrieve the next set of
    #   users or groups.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListEntityPersonasResponse AWS API Documentation
    #
    class ListEntityPersonasResponse < Struct.new(
      :summary_items,
      :next_token)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] id
    #   The identifier of your Amazon Kendra experience.
    #   @return [String]
    #
    # @!attribute [rw] index_id
    #   The identifier of the index for your Amazon Kendra experience.
    #   @return [String]
    #
    # @!attribute [rw] next_token
    #   If the previous response was incomplete (because there is more data
    #   to retrieve), Amazon Kendra returns a pagination token in the
    #   response. You can use this pagination token to retrieve the next set
    #   of users or groups.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListExperienceEntitiesRequest AWS API Documentation
    #
    class ListExperienceEntitiesRequest < Struct.new(
      :id,
      :index_id,
      :next_token)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] summary_items
    #   An array of summary information for one or more users or groups.
    #   @return [Array<Types::ExperienceEntitiesSummary>]
    #
    # @!attribute [rw] next_token
    #   If the response is truncated, Amazon Kendra returns this token,
    #   which you can use in a later request to retrieve the next set of
    #   users or groups.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListExperienceEntitiesResponse AWS API Documentation
    #
    class ListExperienceEntitiesResponse < Struct.new(
      :summary_items,
      :next_token)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] index_id
    #   The identifier of the index for your Amazon Kendra experience.
    #   @return [String]
    #
    # @!attribute [rw] next_token
    #   If the previous response was incomplete (because there is more data
    #   to retrieve), Amazon Kendra returns a pagination token in the
    #   response. You can use this pagination token to retrieve the next set
    #   of Amazon Kendra experiences.
    #   @return [String]
    #
    # @!attribute [rw] max_results
    #   The maximum number of returned Amazon Kendra experiences.
    #   @return [Integer]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListExperiencesRequest AWS API Documentation
    #
    class ListExperiencesRequest < Struct.new(
      :index_id,
      :next_token,
      :max_results)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] summary_items
    #   An array of summary information for one or more Amazon Kendra
    #   experiences.
    #   @return [Array<Types::ExperiencesSummary>]
    #
    # @!attribute [rw] next_token
    #   If the response is truncated, Amazon Kendra returns this token,
    #   which you can use in a later request to retrieve the next set of
    #   Amazon Kendra experiences.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListExperiencesResponse AWS API Documentation
    #
    class ListExperiencesResponse < Struct.new(
      :summary_items,
      :next_token)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] index_id
    #   The index that contains the FAQ lists.
    #   @return [String]
    #
    # @!attribute [rw] next_token
    #   If the previous response was incomplete (because there is more data
    #   to retrieve), Amazon Kendra returns a pagination token in the
    #   response. You can use this pagination token to retrieve the next set
    #   of FAQs.
    #   @return [String]
    #
    # @!attribute [rw] max_results
    #   The maximum number of FAQs to return in the response. If there are
    #   fewer results in the list, this response contains only the actual
    #   results.
    #   @return [Integer]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListFaqsRequest AWS API Documentation
    #
    class ListFaqsRequest < Struct.new(
      :index_id,
      :next_token,
      :max_results)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] next_token
    #   If the response is truncated, Amazon Kendra returns this token that
    #   you can use in the subsequent request to retrieve the next set of
    #   FAQs.
    #   @return [String]
    #
    # @!attribute [rw] faq_summary_items
    #   information about the FAQs associated with the specified index.
    #   @return [Array<Types::FaqSummary>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListFaqsResponse AWS API Documentation
    #
    class ListFaqsResponse < Struct.new(
      :next_token,
      :faq_summary_items)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] index_id
    #   The identifier of the index used for featuring results.
    #   @return [String]
    #
    # @!attribute [rw] next_token
    #   If the response is truncated, Amazon Kendra returns a pagination
    #   token in the response. You can use this pagination token to retrieve
    #   the next set of featured results sets.
    #   @return [String]
    #
    # @!attribute [rw] max_results
    #   The maximum number of featured results sets to return.
    #   @return [Integer]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListFeaturedResultsSetsRequest AWS API Documentation
    #
    class ListFeaturedResultsSetsRequest < Struct.new(
      :index_id,
      :next_token,
      :max_results)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] featured_results_set_summary_items
    #   An array of summary information for one or more featured results
    #   sets.
    #   @return [Array<Types::FeaturedResultsSetSummary>]
    #
    # @!attribute [rw] next_token
    #   If the response is truncated, Amazon Kendra returns a pagination
    #   token in the response.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListFeaturedResultsSetsResponse AWS API Documentation
    #
    class ListFeaturedResultsSetsResponse < Struct.new(
      :featured_results_set_summary_items,
      :next_token)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] index_id
    #   The identifier of the index for getting a list of groups mapped to
    #   users before a given ordering or timestamp identifier.
    #   @return [String]
    #
    # @!attribute [rw] data_source_id
    #   The identifier of the data source for getting a list of groups
    #   mapped to users before a given ordering timestamp identifier.
    #   @return [String]
    #
    # @!attribute [rw] ordering_id
    #   The timestamp identifier used for the latest `PUT` or `DELETE`
    #   action for mapping users to their groups.
    #   @return [Integer]
    #
    # @!attribute [rw] next_token
    #   If the previous response was incomplete (because there is more data
    #   to retrieve), Amazon Kendra returns a pagination token in the
    #   response. You can use this pagination token to retrieve the next set
    #   of groups that are mapped to users before a given ordering or
    #   timestamp identifier.
    #   @return [String]
    #
    # @!attribute [rw] max_results
    #   The maximum number of returned groups that are mapped to users
    #   before a given ordering or timestamp identifier.
    #   @return [Integer]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListGroupsOlderThanOrderingIdRequest AWS API Documentation
    #
    class ListGroupsOlderThanOrderingIdRequest < Struct.new(
      :index_id,
      :data_source_id,
      :ordering_id,
      :next_token,
      :max_results)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] groups_summaries
    #   Summary information for list of groups that are mapped to users
    #   before a given ordering or timestamp identifier.
    #   @return [Array<Types::GroupSummary>]
    #
    # @!attribute [rw] next_token
    #   If the response is truncated, Amazon Kendra returns this token that
    #   you can use in the subsequent request to retrieve the next set of
    #   groups that are mapped to users before a given ordering or timestamp
    #   identifier.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListGroupsOlderThanOrderingIdResponse AWS API Documentation
    #
    class ListGroupsOlderThanOrderingIdResponse < Struct.new(
      :groups_summaries,
      :next_token)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] next_token
    #   If the previous response was incomplete (because there is more data
    #   to retrieve), Amazon Kendra returns a pagination token in the
    #   response. You can use this pagination token to retrieve the next set
    #   of indexes.
    #   @return [String]
    #
    # @!attribute [rw] max_results
    #   The maximum number of indices to return.
    #   @return [Integer]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListIndicesRequest AWS API Documentation
    #
    class ListIndicesRequest < Struct.new(
      :next_token,
      :max_results)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] index_configuration_summary_items
    #   An array of summary information on the configuration of one or more
    #   indexes.
    #   @return [Array<Types::IndexConfigurationSummary>]
    #
    # @!attribute [rw] next_token
    #   If the response is truncated, Amazon Kendra returns this token that
    #   you can use in the subsequent request to retrieve the next set of
    #   indexes.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListIndicesResponse AWS API Documentation
    #
    class ListIndicesResponse < Struct.new(
      :index_configuration_summary_items,
      :next_token)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] index_id
    #   The identifier of the index for a list of all block lists that exist
    #   for that index.
    #
    #   For information on the current quota limits for block lists, see
    #   [Quotas for Amazon Kendra][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
    #   @return [String]
    #
    # @!attribute [rw] next_token
    #   If the previous response was incomplete (because there is more data
    #   to retrieve), Amazon Kendra returns a pagination token in the
    #   response. You can use this pagination token to retrieve the next set
    #   of block lists (`BlockListSummaryItems`).
    #   @return [String]
    #
    # @!attribute [rw] max_results
    #   The maximum number of block lists to return.
    #   @return [Integer]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListQuerySuggestionsBlockListsRequest AWS API Documentation
    #
    class ListQuerySuggestionsBlockListsRequest < Struct.new(
      :index_id,
      :next_token,
      :max_results)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] block_list_summary_items
    #   Summary items for a block list.
    #
    #   This includes summary items on the block list ID, block list name,
    #   when the block list was created, when the block list was last
    #   updated, and the count of block words/phrases in the block list.
    #
    #   For information on the current quota limits for block lists, see
    #   [Quotas for Amazon Kendra][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
    #   @return [Array<Types::QuerySuggestionsBlockListSummary>]
    #
    # @!attribute [rw] next_token
    #   If the response is truncated, Amazon Kendra returns this token that
    #   you can use in the subsequent request to retrieve the next set of
    #   block lists.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListQuerySuggestionsBlockListsResponse AWS API Documentation
    #
    class ListQuerySuggestionsBlockListsResponse < Struct.new(
      :block_list_summary_items,
      :next_token)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] resource_arn
    #   The Amazon Resource Name (ARN) of the index, FAQ, or data source to
    #   get a list of tags for.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListTagsForResourceRequest AWS API Documentation
    #
    class ListTagsForResourceRequest < Struct.new(
      :resource_arn)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] tags
    #   A list of tags associated with the index, FAQ, or data source.
    #   @return [Array<Types::Tag>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListTagsForResourceResponse AWS API Documentation
    #
    class ListTagsForResourceResponse < Struct.new(
      :tags)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] index_id
    #   The identifier of the index with one or more thesauri.
    #   @return [String]
    #
    # @!attribute [rw] next_token
    #   If the previous response was incomplete (because there is more data
    #   to retrieve), Amazon Kendra returns a pagination token in the
    #   response. You can use this pagination token to retrieve the next set
    #   of thesauri (`ThesaurusSummaryItems`).
    #   @return [String]
    #
    # @!attribute [rw] max_results
    #   The maximum number of thesauri to return.
    #   @return [Integer]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListThesauriRequest AWS API Documentation
    #
    class ListThesauriRequest < Struct.new(
      :index_id,
      :next_token,
      :max_results)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] next_token
    #   If the response is truncated, Amazon Kendra returns this token that
    #   you can use in the subsequent request to retrieve the next set of
    #   thesauri.
    #   @return [String]
    #
    # @!attribute [rw] thesaurus_summary_items
    #   An array of summary information for a thesaurus or multiple
    #   thesauri.
    #   @return [Array<Types::ThesaurusSummary>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListThesauriResponse AWS API Documentation
    #
    class ListThesauriResponse < Struct.new(
      :next_token,
      :thesaurus_summary_items)
      SENSITIVE = []
      include Aws::Structure
    end

    # The sub groups that belong to a group.
    #
    # @!attribute [rw] group_id
    #   The identifier of the sub group you want to map to a group.
    #   @return [String]
    #
    # @!attribute [rw] data_source_id
    #   The identifier of the data source for the sub group you want to map
    #   to a group.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/MemberGroup AWS API Documentation
    #
    class MemberGroup < Struct.new(
      :group_id,
      :data_source_id)
      SENSITIVE = []
      include Aws::Structure
    end

    # The users that belong to a group.
    #
    # @!attribute [rw] user_id
    #   The identifier of the user you want to map to a group.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/MemberUser AWS API Documentation
    #
    class MemberUser < Struct.new(
      :user_id)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides the configuration information to connect to GitHub Enterprise
    # Server (on premises).
    #
    # @!attribute [rw] host_url
    #   The GitHub host URL or API endpoint URL. For example,
    #   *https://on-prem-host-url/api/v3/*
    #   @return [String]
    #
    # @!attribute [rw] organization_name
    #   The name of the organization of the GitHub Enterprise Server
    #   (on-premises) account you want to connect to. You can find your
    #   organization name by logging into GitHub desktop and selecting
    #   **Your organizations** under your profile picture dropdown.
    #   @return [String]
    #
    # @!attribute [rw] ssl_certificate_s3_path
    #   The path to the SSL certificate stored in an Amazon S3 bucket. You
    #   use this to connect to GitHub if you require a secure SSL
    #   connection.
    #
    #   You can simply generate a self-signed X509 certificate on any
    #   computer using OpenSSL. For an example of using OpenSSL to create an
    #   X509 certificate, see [Create and sign an X509 certificate][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/configuring-https-ssl.html
    #   @return [Types::S3Path]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/OnPremiseConfiguration AWS API Documentation
    #
    class OnPremiseConfiguration < Struct.new(
      :host_url,
      :organization_name,
      :ssl_certificate_s3_path)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides the configuration information to connect to OneDrive as your
    # data source.
    #
    # @!attribute [rw] tenant_domain
    #   The Azure Active Directory domain of the organization.
    #   @return [String]
    #
    # @!attribute [rw] secret_arn
    #   The Amazon Resource Name (ARN) of an Secrets Managersecret that
    #   contains the user name and password to connect to OneDrive. The user
    #   name should be the application ID for the OneDrive application, and
    #   the password is the application key for the OneDrive application.
    #   @return [String]
    #
    # @!attribute [rw] one_drive_users
    #   A list of user accounts whose documents should be indexed.
    #   @return [Types::OneDriveUsers]
    #
    # @!attribute [rw] inclusion_patterns
    #   A list of regular expression patterns to include certain documents
    #   in your OneDrive. Documents that match the patterns are included in
    #   the index. Documents that don't match the patterns are excluded
    #   from the index. If a document matches both an inclusion and
    #   exclusion pattern, the exclusion pattern takes precedence and the
    #   document isn't included in the index.
    #
    #   The pattern is applied to the file name.
    #   @return [Array<String>]
    #
    # @!attribute [rw] exclusion_patterns
    #   A list of regular expression patterns to exclude certain documents
    #   in your OneDrive. Documents that match the patterns are excluded
    #   from the index. Documents that don't match the patterns are
    #   included in the index. If a document matches both an inclusion and
    #   exclusion pattern, the exclusion pattern takes precedence and the
    #   document isn't included in the index.
    #
    #   The pattern is applied to the file name.
    #   @return [Array<String>]
    #
    # @!attribute [rw] field_mappings
    #   A list of `DataSourceToIndexFieldMapping` objects that map OneDrive
    #   data source attributes or field names to Amazon Kendra index field
    #   names. To create custom fields, use the `UpdateIndex` API before you
    #   map to OneDrive fields. For more information, see [Mapping data
    #   source fields][1]. The OneDrive data source field names must exist
    #   in your OneDrive custom metadata.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
    #   @return [Array<Types::DataSourceToIndexFieldMapping>]
    #
    # @!attribute [rw] disable_local_groups
    #   `TRUE` to disable local groups information.
    #   @return [Boolean]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/OneDriveConfiguration AWS API Documentation
    #
    class OneDriveConfiguration < Struct.new(
      :tenant_domain,
      :secret_arn,
      :one_drive_users,
      :inclusion_patterns,
      :exclusion_patterns,
      :field_mappings,
      :disable_local_groups)
      SENSITIVE = []
      include Aws::Structure
    end

    # User accounts whose documents should be indexed.
    #
    # @!attribute [rw] one_drive_user_list
    #   A list of users whose documents should be indexed. Specify the user
    #   names in email format, for example, `username@tenantdomain`. If you
    #   need to index the documents of more than 100 users, use the
    #   `OneDriveUserS3Path` field to specify the location of a file
    #   containing a list of users.
    #   @return [Array<String>]
    #
    # @!attribute [rw] one_drive_user_s3_path
    #   The S3 bucket location of a file containing a list of users whose
    #   documents should be indexed.
    #   @return [Types::S3Path]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/OneDriveUsers AWS API Documentation
    #
    class OneDriveUsers < Struct.new(
      :one_drive_user_list,
      :one_drive_user_s3_path)
      SENSITIVE = []
      include Aws::Structure
    end

    # Summary information for users or groups in your IAM Identity Center
    # identity source. This applies to users and groups with specific
    # permissions that define their level of access to your Amazon Kendra
    # experience. You can create an Amazon Kendra experience such as a
    # search application. For more information on creating a search
    # application experience, see [Building a search experience with no
    # code][1].
    #
    #
    #
    # [1]: https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html
    #
    # @!attribute [rw] entity_id
    #   The identifier of a user or group in your IAM Identity Center
    #   identity source. For example, a user ID could be an email.
    #   @return [String]
    #
    # @!attribute [rw] persona
    #   The persona that defines the specific permissions of the user or
    #   group in your IAM Identity Center identity source. The available
    #   personas or access roles are `Owner` and `Viewer`. For more
    #   information on these personas, see [Providing access to your search
    #   page][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html#access-search-experience
    #   @return [String]
    #
    # @!attribute [rw] created_at
    #   The Unix timestamp when the summary information was created.
    #   @return [Time]
    #
    # @!attribute [rw] updated_at
    #   The Unix timestamp when the summary information was last updated.
    #   @return [Time]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/PersonasSummary AWS API Documentation
    #
    class PersonasSummary < Struct.new(
      :entity_id,
      :persona,
      :created_at,
      :updated_at)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides user and group information for [user context filtering][1].
    #
    #
    #
    # [1]: https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html
    #
    # @!attribute [rw] name
    #   The name of the user or group.
    #   @return [String]
    #
    # @!attribute [rw] type
    #   The type of principal.
    #   @return [String]
    #
    # @!attribute [rw] access
    #   Whether to allow or deny document access to the principal.
    #   @return [String]
    #
    # @!attribute [rw] data_source_id
    #   The identifier of the data source the principal should access
    #   documents from.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/Principal AWS API Documentation
    #
    class Principal < Struct.new(
      :name,
      :type,
      :access,
      :data_source_id)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides the configuration information for a web proxy to connect to
    # website hosts.
    #
    # @!attribute [rw] host
    #   The name of the website host you want to connect to via a web proxy
    #   server.
    #
    #   For example, the host name of https://a.example.com/page1.html is
    #   "a.example.com".
    #   @return [String]
    #
    # @!attribute [rw] port
    #   The port number of the website host you want to connect to via a web
    #   proxy server.
    #
    #   For example, the port for https://a.example.com/page1.html is 443,
    #   the standard port for HTTPS.
    #   @return [Integer]
    #
    # @!attribute [rw] credentials
    #   Your secret ARN, which you can create in [Secrets Manager][1]
    #
    #   The credentials are optional. You use a secret if web proxy
    #   credentials are required to connect to a website host. Amazon Kendra
    #   currently support basic authentication to connect to a web proxy
    #   server. The secret stores your credentials.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ProxyConfiguration AWS API Documentation
    #
    class ProxyConfiguration < Struct.new(
      :host,
      :port,
      :credentials)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] index_id
    #   The identifier of the index you want to map users to their groups.
    #   @return [String]
    #
    # @!attribute [rw] data_source_id
    #   The identifier of the data source you want to map users to their
    #   groups.
    #
    #   This is useful if a group is tied to multiple data sources, but you
    #   only want the group to access documents of a certain data source.
    #   For example, the groups "Research", "Engineering", and "Sales
    #   and Marketing" are all tied to the company's documents stored in
    #   the data sources Confluence and Salesforce. However, "Sales and
    #   Marketing" team only needs access to customer-related documents
    #   stored in Salesforce.
    #   @return [String]
    #
    # @!attribute [rw] group_id
    #   The identifier of the group you want to map its users to.
    #   @return [String]
    #
    # @!attribute [rw] group_members
    #   The list that contains your users or sub groups that belong the same
    #   group.
    #
    #   For example, the group "Company" includes the user "CEO" and the
    #   sub groups "Research", "Engineering", and "Sales and
    #   Marketing".
    #
    #   If you have more than 1000 users and/or sub groups for a single
    #   group, you need to provide the path to the S3 file that lists your
    #   users and sub groups for a group. Your sub groups can contain more
    #   than 1000 users, but the list of sub groups that belong to a group
    #   (and/or users) must be no more than 1000.
    #   @return [Types::GroupMembers]
    #
    # @!attribute [rw] ordering_id
    #   The timestamp identifier you specify to ensure Amazon Kendra does
    #   not override the latest `PUT` action with previous actions. The
    #   highest number ID, which is the ordering ID, is the latest action
    #   you want to process and apply on top of other actions with lower
    #   number IDs. This prevents previous actions with lower number IDs
    #   from possibly overriding the latest action.
    #
    #   The ordering ID can be the Unix time of the last update you made to
    #   a group members list. You would then provide this list when calling
    #   `PutPrincipalMapping`. This ensures your `PUT` action for that
    #   updated group with the latest members list doesn't get overwritten
    #   by earlier `PUT` actions for the same group which are yet to be
    #   processed.
    #
    #   The default ordering ID is the current Unix time in milliseconds
    #   that the action was received by Amazon Kendra.
    #   @return [Integer]
    #
    # @!attribute [rw] role_arn
    #   The Amazon Resource Name (ARN) of a role that has access to the S3
    #   file that contains your list of users or sub groups that belong to a
    #   group.
    #
    #   For more information, see [IAM roles for Amazon Kendra][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/PutPrincipalMappingRequest AWS API Documentation
    #
    class PutPrincipalMappingRequest < Struct.new(
      :index_id,
      :data_source_id,
      :group_id,
      :group_members,
      :ordering_id,
      :role_arn)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] index_id
    #   The identifier of the index for the search.
    #   @return [String]
    #
    # @!attribute [rw] query_text
    #   The input query text for the search. Amazon Kendra truncates queries
    #   at 30 token words, which excludes punctuation and stop words.
    #   Truncation still applies if you use Boolean or more advanced,
    #   complex queries. For example, `Timeoff AND October AND Category:HR`
    #   is counted as 3 tokens: `timeoff`, `october`, `hr`. For more
    #   information, see [Searching with advanced query syntax][1] in the
    #   Amazon Kendra Developer Guide.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/searching-example.html#searching-index-query-syntax
    #   @return [String]
    #
    # @!attribute [rw] attribute_filter
    #   Filters search results by document fields/attributes. You can only
    #   provide one attribute filter; however, the `AndAllFilters`,
    #   `NotFilter`, and `OrAllFilters` parameters contain a list of other
    #   filters.
    #
    #   The `AttributeFilter` parameter means you can create a set of
    #   filtering rules that a document must satisfy to be included in the
    #   query results.
    #   @return [Types::AttributeFilter]
    #
    # @!attribute [rw] facets
    #   An array of documents fields/attributes for faceted search. Amazon
    #   Kendra returns a count for each field key specified. This helps your
    #   users narrow their search.
    #   @return [Array<Types::Facet>]
    #
    # @!attribute [rw] requested_document_attributes
    #   An array of document fields/attributes to include in the response.
    #   You can limit the response to include certain document fields. By
    #   default, all document attributes are included in the response.
    #   @return [Array<String>]
    #
    # @!attribute [rw] query_result_type_filter
    #   Sets the type of query result or response. Only results for the
    #   specified type are returned.
    #   @return [String]
    #
    # @!attribute [rw] document_relevance_override_configurations
    #   Overrides relevance tuning configurations of fields/attributes set
    #   at the index level.
    #
    #   If you use this API to override the relevance tuning configured at
    #   the index level, but there is no relevance tuning configured at the
    #   index level, then Amazon Kendra does not apply any relevance tuning.
    #
    #   If there is relevance tuning configured for fields at the index
    #   level, and you use this API to override only some of these fields,
    #   then for the fields you did not override, the importance is set to
    #   1.
    #   @return [Array<Types::DocumentRelevanceConfiguration>]
    #
    # @!attribute [rw] page_number
    #   Query results are returned in pages the size of the `PageSize`
    #   parameter. By default, Amazon Kendra returns the first page of
    #   results. Use this parameter to get result pages after the first one.
    #   @return [Integer]
    #
    # @!attribute [rw] page_size
    #   Sets the number of results that are returned in each page of
    #   results. The default page size is 10. The maximum number of results
    #   returned is 100. If you ask for more than 100 results, only 100 are
    #   returned.
    #   @return [Integer]
    #
    # @!attribute [rw] sorting_configuration
    #   Provides information that determines how the results of the query
    #   are sorted. You can set the field that Amazon Kendra should sort the
    #   results on, and specify whether the results should be sorted in
    #   ascending or descending order. In the case of ties in sorting the
    #   results, the results are sorted by relevance.
    #
    #   If you don't provide sorting configuration, the results are sorted
    #   by the relevance that Amazon Kendra determines for the result.
    #   @return [Types::SortingConfiguration]
    #
    # @!attribute [rw] sorting_configurations
    #   Provides configuration information to determine how the results of a
    #   query are sorted.
    #
    #   You can set upto 3 fields that Amazon Kendra should sort the results
    #   on, and specify whether the results should be sorted in ascending or
    #   descending order. The sort field quota can be increased.
    #
    #   If you don't provide a sorting configuration, the results are
    #   sorted by the relevance that Amazon Kendra determines for the
    #   result. In the case of ties in sorting the results, the results are
    #   sorted by relevance.
    #   @return [Array<Types::SortingConfiguration>]
    #
    # @!attribute [rw] user_context
    #   The user context token or user and group information.
    #   @return [Types::UserContext]
    #
    # @!attribute [rw] visitor_id
    #   Provides an identifier for a specific user. The `VisitorId` should
    #   be a unique identifier, such as a GUID. Don't use personally
    #   identifiable information, such as the user's email address, as the
    #   `VisitorId`.
    #   @return [String]
    #
    # @!attribute [rw] spell_correction_configuration
    #   Enables suggested spell corrections for queries.
    #   @return [Types::SpellCorrectionConfiguration]
    #
    # @!attribute [rw] collapse_configuration
    #   Provides configuration to determine how to group results by document
    #   attribute value, and how to display them (collapsed or expanded)
    #   under a designated primary document for each group.
    #   @return [Types::CollapseConfiguration]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/QueryRequest AWS API Documentation
    #
    class QueryRequest < Struct.new(
      :index_id,
      :query_text,
      :attribute_filter,
      :facets,
      :requested_document_attributes,
      :query_result_type_filter,
      :document_relevance_override_configurations,
      :page_number,
      :page_size,
      :sorting_configuration,
      :sorting_configurations,
      :user_context,
      :visitor_id,
      :spell_correction_configuration,
      :collapse_configuration)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] query_id
    #   The identifier for the search. You also use `QueryId` to identify
    #   the search when using the [SubmitFeedback][1] API.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/APIReference/API_SubmitFeedback.html
    #   @return [String]
    #
    # @!attribute [rw] result_items
    #   The results of the search.
    #   @return [Array<Types::QueryResultItem>]
    #
    # @!attribute [rw] facet_results
    #   Contains the facet results. A `FacetResult` contains the counts for
    #   each field/attribute key that was specified in the `Facets` input
    #   parameter.
    #   @return [Array<Types::FacetResult>]
    #
    # @!attribute [rw] total_number_of_results
    #   The total number of items found by the search. However, you can only
    #   retrieve up to 100 items. For example, if the search found 192
    #   items, you can only retrieve the first 100 of the items.
    #   @return [Integer]
    #
    # @!attribute [rw] warnings
    #   A list of warning codes and their messages on problems with your
    #   query.
    #
    #   Amazon Kendra currently only supports one type of warning, which is
    #   a warning on invalid syntax used in the query. For examples of
    #   invalid query syntax, see [Searching with advanced query syntax][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/searching-example.html#searching-index-query-syntax
    #   @return [Array<Types::Warning>]
    #
    # @!attribute [rw] spell_corrected_queries
    #   A list of information related to suggested spell corrections for a
    #   query.
    #   @return [Array<Types::SpellCorrectedQuery>]
    #
    # @!attribute [rw] featured_results_items
    #   The list of featured result items. Featured results are displayed at
    #   the top of the search results page, placed above all other results
    #   for certain queries. If there's an exact match of a query, then
    #   certain documents are featured in the search results.
    #   @return [Array<Types::FeaturedResultsItem>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/QueryResult AWS API Documentation
    #
    class QueryResult < Struct.new(
      :query_id,
      :result_items,
      :facet_results,
      :total_number_of_results,
      :warnings,
      :spell_corrected_queries,
      :featured_results_items)
      SENSITIVE = []
      include Aws::Structure
    end

    # A single query result.
    #
    # A query result contains information about a document returned by the
    # query. This includes the original location of the document, a list of
    # attributes assigned to the document, and relevant text from the
    # document that satisfies the query.
    #
    # @!attribute [rw] id
    #   The unique identifier for the query result item id (`Id`) and the
    #   query result item document id (`DocumentId`) combined. The value of
    #   this field changes with every request, even when you have the same
    #   documents.
    #   @return [String]
    #
    # @!attribute [rw] type
    #   The type of document within the response. For example, a response
    #   could include a question-answer that's relevant to the query.
    #   @return [String]
    #
    # @!attribute [rw] format
    #   If the `Type` of document within the response is `ANSWER`, then it
    #   is either a `TABLE` answer or `TEXT` answer. If it's a table
    #   answer, a table excerpt is returned in `TableExcerpt`. If it's a
    #   text answer, a text excerpt is returned in `DocumentExcerpt`.
    #   @return [String]
    #
    # @!attribute [rw] additional_attributes
    #   One or more additional fields/attributes associated with the query
    #   result.
    #   @return [Array<Types::AdditionalResultAttribute>]
    #
    # @!attribute [rw] document_id
    #   The identifier for the document.
    #   @return [String]
    #
    # @!attribute [rw] document_title
    #   The title of the document. Contains the text of the title and
    #   information for highlighting the relevant terms in the title.
    #   @return [Types::TextWithHighlights]
    #
    # @!attribute [rw] document_excerpt
    #   An extract of the text in the document. Contains information about
    #   highlighting the relevant terms in the excerpt.
    #   @return [Types::TextWithHighlights]
    #
    # @!attribute [rw] document_uri
    #   The URI of the original location of the document.
    #   @return [String]
    #
    # @!attribute [rw] document_attributes
    #   An array of document fields/attributes assigned to a document in the
    #   search results. For example, the document author (`_author`) or the
    #   source URI (`_source_uri`) of the document.
    #   @return [Array<Types::DocumentAttribute>]
    #
    # @!attribute [rw] score_attributes
    #   Indicates the confidence level of Amazon Kendra providing a relevant
    #   result for the query. Each result is placed into a bin that
    #   indicates the confidence, `VERY_HIGH`, `HIGH`, `MEDIUM` and `LOW`.
    #   You can use the score to determine if a response meets the
    #   confidence needed for your application.
    #
    #   The field is only set to `LOW` when the `Type` field is set to
    #   `DOCUMENT` and Amazon Kendra is not confident that the result is
    #   relevant to the query.
    #   @return [Types::ScoreAttributes]
    #
    # @!attribute [rw] feedback_token
    #   A token that identifies a particular result from a particular query.
    #   Use this token to provide click-through feedback for the result. For
    #   more information, see [Submitting feedback][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/submitting-feedback.html
    #   @return [String]
    #
    # @!attribute [rw] table_excerpt
    #   An excerpt from a table within a document.
    #   @return [Types::TableExcerpt]
    #
    # @!attribute [rw] collapsed_result_detail
    #   Provides details about a collapsed group of search results.
    #   @return [Types::CollapsedResultDetail]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/QueryResultItem AWS API Documentation
    #
    class QueryResultItem < Struct.new(
      :id,
      :type,
      :format,
      :additional_attributes,
      :document_id,
      :document_title,
      :document_excerpt,
      :document_uri,
      :document_attributes,
      :score_attributes,
      :feedback_token,
      :table_excerpt,
      :collapsed_result_detail)
      SENSITIVE = []
      include Aws::Structure
    end

    # Summary information on a query suggestions block list.
    #
    # This includes information on the block list ID, block list name, when
    # the block list was created, when the block list was last updated, and
    # the count of block words/phrases in the block list.
    #
    # For information on the current quota limits for block lists, see
    # [Quotas for Amazon Kendra][1].
    #
    #
    #
    # [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
    #
    # @!attribute [rw] id
    #   The identifier of a block list.
    #   @return [String]
    #
    # @!attribute [rw] name
    #   The name of the block list.
    #   @return [String]
    #
    # @!attribute [rw] status
    #   The status of the block list.
    #   @return [String]
    #
    # @!attribute [rw] created_at
    #   The Unix timestamp when the block list was created.
    #   @return [Time]
    #
    # @!attribute [rw] updated_at
    #   The Unix timestamp when the block list was last updated.
    #   @return [Time]
    #
    # @!attribute [rw] item_count
    #   The number of items in the block list file.
    #   @return [Integer]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/QuerySuggestionsBlockListSummary AWS API Documentation
    #
    class QuerySuggestionsBlockListSummary < Struct.new(
      :id,
      :name,
      :status,
      :created_at,
      :updated_at,
      :item_count)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides the configuration information to connect to Quip as your data
    # source.
    #
    # @!attribute [rw] domain
    #   The Quip site domain. For example,
    #   *https://quip-company.quipdomain.com/browse*. The domain in this
    #   example is "quipdomain".
    #   @return [String]
    #
    # @!attribute [rw] secret_arn
    #   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:
    #
    #   * accessToken—The token created in Quip. For more information, see
    #     [Using a Quip data source][1].
    #
    #   ^
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/data-source-slack.html
    #   @return [String]
    #
    # @!attribute [rw] crawl_file_comments
    #   `TRUE` to index file comments.
    #   @return [Boolean]
    #
    # @!attribute [rw] crawl_chat_rooms
    #   `TRUE` to index the contents of chat rooms.
    #   @return [Boolean]
    #
    # @!attribute [rw] crawl_attachments
    #   `TRUE` to index attachments.
    #   @return [Boolean]
    #
    # @!attribute [rw] folder_ids
    #   The identifiers of the Quip folders you want to index. You can find
    #   the folder ID in your browser URL when you access your folder in
    #   Quip. For example,
    #   *https://quip-company.quipdomain.com/zlLuOVNSarTL/folder-name*. The
    #   folder ID in this example is "zlLuOVNSarTL".
    #   @return [Array<String>]
    #
    # @!attribute [rw] thread_field_mappings
    #   A list of `DataSourceToIndexFieldMapping` objects that map
    #   attributes or field names of Quip threads to Amazon Kendra index
    #   field names. To create custom fields, use the `UpdateIndex` API
    #   before you map to Quip fields. For more information, see [Mapping
    #   data source fields][1]. The Quip field names must exist in your Quip
    #   custom metadata.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
    #   @return [Array<Types::DataSourceToIndexFieldMapping>]
    #
    # @!attribute [rw] message_field_mappings
    #   A list of `DataSourceToIndexFieldMapping` objects that map
    #   attributes or field names of Quip messages to Amazon Kendra index
    #   field names. To create custom fields, use the `UpdateIndex` API
    #   before you map to Quip fields. For more information, see [Mapping
    #   data source fields][1]. The Quip field names must exist in your Quip
    #   custom metadata.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
    #   @return [Array<Types::DataSourceToIndexFieldMapping>]
    #
    # @!attribute [rw] attachment_field_mappings
    #   A list of `DataSourceToIndexFieldMapping` objects that map
    #   attributes or field names of Quip attachments to Amazon Kendra index
    #   field names. To create custom fields, use the `UpdateIndex` API
    #   before you map to Quip fields. For more information, see [Mapping
    #   data source fields][1]. The Quip field names must exist in your Quip
    #   custom metadata.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
    #   @return [Array<Types::DataSourceToIndexFieldMapping>]
    #
    # @!attribute [rw] inclusion_patterns
    #   A list of regular expression patterns to include certain files in
    #   your Quip file system. Files that match the patterns are included in
    #   the index. Files that don't match the patterns are excluded from
    #   the index. If a file matches both an inclusion pattern and an
    #   exclusion pattern, the exclusion pattern takes precedence, and the
    #   file isn't included in the index.
    #   @return [Array<String>]
    #
    # @!attribute [rw] exclusion_patterns
    #   A list of regular expression patterns to exclude certain files in
    #   your Quip file system. Files that match the patterns are excluded
    #   from the index. Files that don’t match the patterns are included in
    #   the index. If a file matches both an inclusion pattern and an
    #   exclusion pattern, the exclusion pattern takes precedence, and the
    #   file isn't included in the index.
    #   @return [Array<String>]
    #
    # @!attribute [rw] vpc_configuration
    #   Configuration information for an Amazon Virtual Private Cloud (VPC)
    #   to connect to your Quip. For more information, see [Configuring a
    #   VPC][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html
    #   @return [Types::DataSourceVpcConfiguration]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/QuipConfiguration AWS API Documentation
    #
    class QuipConfiguration < Struct.new(
      :domain,
      :secret_arn,
      :crawl_file_comments,
      :crawl_chat_rooms,
      :crawl_attachments,
      :folder_ids,
      :thread_field_mappings,
      :message_field_mappings,
      :attachment_field_mappings,
      :inclusion_patterns,
      :exclusion_patterns,
      :vpc_configuration)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides information for tuning the relevance of a field in a search.
    # When a query includes terms that match the field, the results are
    # given a boost in the response based on these tuning parameters.
    #
    # @!attribute [rw] freshness
    #   Indicates that this field determines how "fresh" a document is.
    #   For example, if document 1 was created on November 5, and document 2
    #   was created on October 31, document 1 is "fresher" than document
    #   2. Only applies to `DATE` fields.
    #   @return [Boolean]
    #
    # @!attribute [rw] importance
    #   The relative importance of the field in the search. Larger numbers
    #   provide more of a boost than smaller numbers.
    #   @return [Integer]
    #
    # @!attribute [rw] duration
    #   Specifies the time period that the boost applies to. For example, to
    #   make the boost apply to documents with the field value within the
    #   last month, you would use "2628000s". Once the field value is
    #   beyond the specified range, the effect of the boost drops off. The
    #   higher the importance, the faster the effect drops off. If you
    #   don't specify a value, the default is 3 months. The value of the
    #   field is a numeric string followed by the character "s", for
    #   example "86400s" for one day, or "604800s" for one week.
    #
    #   Only applies to `DATE` fields.
    #   @return [String]
    #
    # @!attribute [rw] rank_order
    #   Determines how values should be interpreted.
    #
    #   When the `RankOrder` field is `ASCENDING`, higher numbers are
    #   better. For example, a document with a rating score of 10 is higher
    #   ranking than a document with a rating score of 1.
    #
    #   When the `RankOrder` field is `DESCENDING`, lower numbers are
    #   better. For example, in a task tracking application, a priority 1
    #   task is more important than a priority 5 task.
    #
    #   Only applies to `LONG` fields.
    #   @return [String]
    #
    # @!attribute [rw] value_importance_map
    #   A list of values that should be given a different boost when they
    #   appear in the result list. For example, if you are boosting a field
    #   called "department", query terms that match the department field
    #   are boosted in the result. However, you can add entries from the
    #   department field to boost documents with those values higher.
    #
    #   For example, you can add entries to the map with names of
    #   departments. If you add "HR",5 and "Legal",3 those departments
    #   are given special attention when they appear in the metadata of a
    #   document. When those terms appear they are given the specified
    #   importance instead of the regular importance for the boost.
    #   @return [Hash<String,Integer>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/Relevance AWS API Documentation
    #
    class Relevance < Struct.new(
      :freshness,
      :importance,
      :duration,
      :rank_order,
      :value_importance_map)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides feedback on how relevant a document is to a search. Your
    # application uses the `SubmitFeedback` API to provide relevance
    # information.
    #
    # @!attribute [rw] result_id
    #   The identifier of the search result that the user provided relevance
    #   feedback for.
    #   @return [String]
    #
    # @!attribute [rw] relevance_value
    #   Whether the document was relevant or not relevant to the search.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/RelevanceFeedback AWS API Documentation
    #
    class RelevanceFeedback < Struct.new(
      :result_id,
      :relevance_value)
      SENSITIVE = []
      include Aws::Structure
    end

    # The resource you want to use already exists. Please check you have
    # provided the correct resource and try again.
    #
    # @!attribute [rw] message
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ResourceAlreadyExistException AWS API Documentation
    #
    class ResourceAlreadyExistException < Struct.new(
      :message)
      SENSITIVE = []
      include Aws::Structure
    end

    # The resource you want to use is currently in use. Please check you
    # have provided the correct resource and try again.
    #
    # @!attribute [rw] message
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ResourceInUseException AWS API Documentation
    #
    class ResourceInUseException < Struct.new(
      :message)
      SENSITIVE = []
      include Aws::Structure
    end

    # The resource you want to use doesn’t exist. Please check you have
    # provided the correct resource and try again.
    #
    # @!attribute [rw] message
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ResourceNotFoundException AWS API Documentation
    #
    class ResourceNotFoundException < Struct.new(
      :message)
      SENSITIVE = []
      include Aws::Structure
    end

    # The resource you want to use isn't available. Please check you have
    # provided the correct resource and try again.
    #
    # @!attribute [rw] message
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ResourceUnavailableException AWS API Documentation
    #
    class ResourceUnavailableException < Struct.new(
      :message)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] index_id
    #   The identifier of the index to retrieve relevant passages for the
    #   search.
    #   @return [String]
    #
    # @!attribute [rw] query_text
    #   The input query text to retrieve relevant passages for the search.
    #   Amazon Kendra truncates queries at 30 token words, which excludes
    #   punctuation and stop words. Truncation still applies if you use
    #   Boolean or more advanced, complex queries. For example, `Timeoff AND
    #   October AND Category:HR` is counted as 3 tokens: `timeoff`,
    #   `october`, `hr`. For more information, see [Searching with advanced
    #   query syntax][1] in the Amazon Kendra Developer Guide.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/searching-example.html#searching-index-query-syntax
    #   @return [String]
    #
    # @!attribute [rw] attribute_filter
    #   Filters search results by document fields/attributes. You can only
    #   provide one attribute filter; however, the `AndAllFilters`,
    #   `NotFilter`, and `OrAllFilters` parameters contain a list of other
    #   filters.
    #
    #   The `AttributeFilter` parameter means you can create a set of
    #   filtering rules that a document must satisfy to be included in the
    #   query results.
    #   @return [Types::AttributeFilter]
    #
    # @!attribute [rw] requested_document_attributes
    #   A list of document fields/attributes to include in the response. You
    #   can limit the response to include certain document fields. By
    #   default, all document fields are included in the response.
    #   @return [Array<String>]
    #
    # @!attribute [rw] document_relevance_override_configurations
    #   Overrides relevance tuning configurations of fields/attributes set
    #   at the index level.
    #
    #   If you use this API to override the relevance tuning configured at
    #   the index level, but there is no relevance tuning configured at the
    #   index level, then Amazon Kendra does not apply any relevance tuning.
    #
    #   If there is relevance tuning configured for fields at the index
    #   level, and you use this API to override only some of these fields,
    #   then for the fields you did not override, the importance is set to
    #   1.
    #   @return [Array<Types::DocumentRelevanceConfiguration>]
    #
    # @!attribute [rw] page_number
    #   Retrieved relevant passages are returned in pages the size of the
    #   `PageSize` parameter. By default, Amazon Kendra returns the first
    #   page of results. Use this parameter to get result pages after the
    #   first one.
    #   @return [Integer]
    #
    # @!attribute [rw] page_size
    #   Sets the number of retrieved relevant passages that are returned in
    #   each page of results. The default page size is 10. The maximum
    #   number of results returned is 100. If you ask for more than 100
    #   results, only 100 are returned.
    #   @return [Integer]
    #
    # @!attribute [rw] user_context
    #   The user context token or user and group information.
    #   @return [Types::UserContext]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/RetrieveRequest AWS API Documentation
    #
    class RetrieveRequest < Struct.new(
      :index_id,
      :query_text,
      :attribute_filter,
      :requested_document_attributes,
      :document_relevance_override_configurations,
      :page_number,
      :page_size,
      :user_context)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] query_id
    #   The identifier of query used for the search. You also use `QueryId`
    #   to identify the search when using the [Submitfeedback][1] API.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/APIReference/API_SubmitFeedback.html
    #   @return [String]
    #
    # @!attribute [rw] result_items
    #   The results of the retrieved relevant passages for the search.
    #   @return [Array<Types::RetrieveResultItem>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/RetrieveResult AWS API Documentation
    #
    class RetrieveResult < Struct.new(
      :query_id,
      :result_items)
      SENSITIVE = []
      include Aws::Structure
    end

    # A single retrieved relevant passage result.
    #
    # @!attribute [rw] id
    #   The identifier of the relevant passage result.
    #   @return [String]
    #
    # @!attribute [rw] document_id
    #   The identifier of the document.
    #   @return [String]
    #
    # @!attribute [rw] document_title
    #   The title of the document.
    #   @return [String]
    #
    # @!attribute [rw] content
    #   The contents of the relevant passage.
    #   @return [String]
    #
    # @!attribute [rw] document_uri
    #   The URI of the original location of the document.
    #   @return [String]
    #
    # @!attribute [rw] document_attributes
    #   An array of document fields/attributes assigned to a document in the
    #   search results. For example, the document author (`_author`) or the
    #   source URI (`_source_uri`) of the document.
    #   @return [Array<Types::DocumentAttribute>]
    #
    # @!attribute [rw] score_attributes
    #   The confidence score bucket for a retrieved passage result. The
    #   confidence bucket provides a relative ranking that indicates how
    #   confident Amazon Kendra is that the response is relevant to the
    #   query.
    #   @return [Types::ScoreAttributes]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/RetrieveResultItem AWS API Documentation
    #
    class RetrieveResultItem < Struct.new(
      :id,
      :document_id,
      :document_title,
      :content,
      :document_uri,
      :document_attributes,
      :score_attributes)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides the configuration information to connect to an Amazon S3
    # bucket.
    #
    # <note markdown="1"> Amazon Kendra now supports an upgraded Amazon S3 connector.
    #
    #  You must now use the [TemplateConfiguration][1] object instead of the
    # `S3DataSourceConfiguration` object to configure your connector.
    #
    #  Connectors configured using the older console and API architecture
    # will continue to function as configured. However, you won't be able
    # to edit or update them. If you want to edit or update your connector
    # configuration, you must create a new connector.
    #
    #  We recommended migrating your connector workflow to the upgraded
    # version. Support for connectors configured using the older
    # architecture is scheduled to end by June 2024.
    #
    #  </note>
    #
    #
    #
    # [1]: https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html
    #
    # @!attribute [rw] bucket_name
    #   The name of the bucket that contains the documents.
    #   @return [String]
    #
    # @!attribute [rw] inclusion_prefixes
    #   A list of S3 prefixes for the documents that should be included in
    #   the index.
    #   @return [Array<String>]
    #
    # @!attribute [rw] inclusion_patterns
    #   A list of glob patterns (patterns that can expand a wildcard pattern
    #   into a list of path names that match the given pattern) for certain
    #   file names and file types to include in your index. If a document
    #   matches both an inclusion and exclusion prefix or pattern, the
    #   exclusion prefix takes precendence and the document is not indexed.
    #   Examples of glob patterns include:
    #
    #   * */myapp/config/**—All files inside config directory.
    #
    #   * ***/*.png*—All .png files in all directories.
    #
    #   * ***/*.\\\{png, ico, md\\}*—All .png, .ico or .md files in all
    #     directories.
    #
    #   * */myapp/src/**/*.ts*—All .ts files inside src directory (and
    #     all its subdirectories).
    #
    #   * ***/!(*.module).ts*—All .ts files but not .module.ts
    #
    #   * **.png , *.jpg*—All PNG and JPEG image files in a directory
    #     (files with the extensions .png and .jpg).
    #
    #   * **internal**—All files in a directory that contain 'internal'
    #     in the file name, such as 'internal', 'internal\_only',
    #     'company\_internal'.
    #
    #   * ***/*internal**—All internal-related files in a directory and
    #     its subdirectories.
    #
    #   For more examples, see [Use of Exclude and Include Filters][1] in
    #   the Amazon Web Services CLI Command Reference.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/cli/latest/reference/s3/#use-of-exclude-and-include-filters
    #   @return [Array<String>]
    #
    # @!attribute [rw] exclusion_patterns
    #   A list of glob patterns (patterns that can expand a wildcard pattern
    #   into a list of path names that match the given pattern) for certain
    #   file names and file types to exclude from your index. If a document
    #   matches both an inclusion and exclusion prefix or pattern, the
    #   exclusion prefix takes precendence and the document is not indexed.
    #   Examples of glob patterns include:
    #
    #   * */myapp/config/**—All files inside config directory.
    #
    #   * ***/*.png*—All .png files in all directories.
    #
    #   * ***/*.\\\{png, ico, md\\}*—All .png, .ico or .md files in all
    #     directories.
    #
    #   * */myapp/src/**/*.ts*—All .ts files inside src directory (and
    #     all its subdirectories).
    #
    #   * ***/!(*.module).ts*—All .ts files but not .module.ts
    #
    #   * **.png , *.jpg*—All PNG and JPEG image files in a directory
    #     (files with the extensions .png and .jpg).
    #
    #   * **internal**—All files in a directory that contain 'internal'
    #     in the file name, such as 'internal', 'internal\_only',
    #     'company\_internal'.
    #
    #   * ***/*internal**—All internal-related files in a directory and
    #     its subdirectories.
    #
    #   For more examples, see [Use of Exclude and Include Filters][1] in
    #   the Amazon Web Services CLI Command Reference.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/cli/latest/reference/s3/#use-of-exclude-and-include-filters
    #   @return [Array<String>]
    #
    # @!attribute [rw] documents_metadata_configuration
    #   Document metadata files that contain information such as the
    #   document access control information, source URI, document author,
    #   and custom attributes. Each metadata file contains metadata about a
    #   single document.
    #   @return [Types::DocumentsMetadataConfiguration]
    #
    # @!attribute [rw] access_control_list_configuration
    #   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][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/s3-acl.html
    #   @return [Types::AccessControlListConfiguration]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/S3DataSourceConfiguration AWS API Documentation
    #
    class S3DataSourceConfiguration < Struct.new(
      :bucket_name,
      :inclusion_prefixes,
      :inclusion_patterns,
      :exclusion_patterns,
      :documents_metadata_configuration,
      :access_control_list_configuration)
      SENSITIVE = []
      include Aws::Structure
    end

    # Information required to find a specific file in an Amazon S3 bucket.
    #
    # @!attribute [rw] bucket
    #   The name of the S3 bucket that contains the file.
    #   @return [String]
    #
    # @!attribute [rw] key
    #   The name of the file.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/S3Path AWS API Documentation
    #
    class S3Path < Struct.new(
      :bucket,
      :key)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides the configuration information to connect to GitHub Enterprise
    # Cloud (SaaS).
    #
    # @!attribute [rw] organization_name
    #   The name of the organization of the GitHub Enterprise Cloud (SaaS)
    #   account you want to connect to. You can find your organization name
    #   by logging into GitHub desktop and selecting **Your organizations**
    #   under your profile picture dropdown.
    #   @return [String]
    #
    # @!attribute [rw] host_url
    #   The GitHub host URL or API endpoint URL. For example,
    #   *https://api.github.com*.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SaaSConfiguration AWS API Documentation
    #
    class SaaSConfiguration < Struct.new(
      :organization_name,
      :host_url)
      SENSITIVE = []
      include Aws::Structure
    end

    # The configuration information for syncing a Salesforce chatter feed.
    # The contents of the object comes from the Salesforce FeedItem table.
    #
    # @!attribute [rw] document_data_field_name
    #   The name of the column in the Salesforce FeedItem table that
    #   contains the content to index. Typically this is the `Body` column.
    #   @return [String]
    #
    # @!attribute [rw] document_title_field_name
    #   The name of the column in the Salesforce FeedItem table that
    #   contains the title of the document. This is typically the `Title`
    #   column.
    #   @return [String]
    #
    # @!attribute [rw] field_mappings
    #   Maps fields from a Salesforce chatter feed into Amazon Kendra index
    #   fields.
    #   @return [Array<Types::DataSourceToIndexFieldMapping>]
    #
    # @!attribute [rw] include_filter_types
    #   Filters the documents in the feed based on status of the user. When
    #   you specify `ACTIVE_USERS` only documents from users who have an
    #   active account are indexed. When you specify `STANDARD_USER` only
    #   documents for Salesforce standard users are documented. You can
    #   specify both.
    #   @return [Array<String>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SalesforceChatterFeedConfiguration AWS API Documentation
    #
    class SalesforceChatterFeedConfiguration < Struct.new(
      :document_data_field_name,
      :document_title_field_name,
      :field_mappings,
      :include_filter_types)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides the configuration information to connect to Salesforce as
    # your data source.
    #
    # @!attribute [rw] server_url
    #   The instance URL for the Salesforce site that you want to index.
    #   @return [String]
    #
    # @!attribute [rw] secret_arn
    #   The Amazon Resource Name (ARN) of an Secrets Managersecret that
    #   contains the key/value pairs required to connect to your Salesforce
    #   instance. The secret must contain a JSON structure with the
    #   following keys:
    #
    #   * authenticationUrl - The OAUTH endpoint that Amazon Kendra connects
    #     to get an OAUTH token.
    #
    #   * consumerKey - The application public key generated when you
    #     created your Salesforce application.
    #
    #   * consumerSecret - The application private key generated when you
    #     created your Salesforce application.
    #
    #   * password - The password associated with the user logging in to the
    #     Salesforce instance.
    #
    #   * securityToken - The token associated with the user logging in to
    #     the Salesforce instance.
    #
    #   * username - The user name of the user logging in to the Salesforce
    #     instance.
    #   @return [String]
    #
    # @!attribute [rw] standard_object_configurations
    #   Configuration of the Salesforce standard objects that Amazon Kendra
    #   indexes.
    #   @return [Array<Types::SalesforceStandardObjectConfiguration>]
    #
    # @!attribute [rw] knowledge_article_configuration
    #   Configuration information for the knowledge article types that
    #   Amazon Kendra indexes. Amazon Kendra indexes standard knowledge
    #   articles and the standard fields of knowledge articles, or the
    #   custom fields of custom knowledge articles, but not both.
    #   @return [Types::SalesforceKnowledgeArticleConfiguration]
    #
    # @!attribute [rw] chatter_feed_configuration
    #   Configuration information for Salesforce chatter feeds.
    #   @return [Types::SalesforceChatterFeedConfiguration]
    #
    # @!attribute [rw] crawl_attachments
    #   Indicates whether Amazon Kendra should index attachments to
    #   Salesforce objects.
    #   @return [Boolean]
    #
    # @!attribute [rw] standard_object_attachment_configuration
    #   Configuration information for processing attachments to Salesforce
    #   standard objects.
    #   @return [Types::SalesforceStandardObjectAttachmentConfiguration]
    #
    # @!attribute [rw] include_attachment_file_patterns
    #   A list of regular expression patterns to include certain documents
    #   in your Salesforce. Documents that match the patterns are included
    #   in the index. Documents that don't match the patterns are excluded
    #   from the index. If a document matches both an inclusion and
    #   exclusion pattern, the exclusion pattern takes precedence and the
    #   document isn't included in the index.
    #
    #   The pattern is applied to the name of the attached file.
    #   @return [Array<String>]
    #
    # @!attribute [rw] exclude_attachment_file_patterns
    #   A list of regular expression patterns to exclude certain documents
    #   in your Salesforce. Documents that match the patterns are excluded
    #   from the index. Documents that don't match the patterns are
    #   included in the index. If a document matches both an inclusion and
    #   exclusion pattern, the exclusion pattern takes precedence and the
    #   document isn't included in the index.
    #
    #   The pattern is applied to the name of the attached file.
    #   @return [Array<String>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SalesforceConfiguration AWS API Documentation
    #
    class SalesforceConfiguration < Struct.new(
      :server_url,
      :secret_arn,
      :standard_object_configurations,
      :knowledge_article_configuration,
      :chatter_feed_configuration,
      :crawl_attachments,
      :standard_object_attachment_configuration,
      :include_attachment_file_patterns,
      :exclude_attachment_file_patterns)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides the configuration information for indexing Salesforce custom
    # articles.
    #
    # @!attribute [rw] name
    #   The name of the configuration.
    #   @return [String]
    #
    # @!attribute [rw] document_data_field_name
    #   The name of the field in the custom knowledge article that contains
    #   the document data to index.
    #   @return [String]
    #
    # @!attribute [rw] document_title_field_name
    #   The name of the field in the custom knowledge article that contains
    #   the document title.
    #   @return [String]
    #
    # @!attribute [rw] field_mappings
    #   Maps attributes or field names of the custom knowledge article to
    #   Amazon Kendra index field names. To create custom fields, use the
    #   `UpdateIndex` API before you map to Salesforce fields. For more
    #   information, see [Mapping data source fields][1]. The Salesforce
    #   data source field names must exist in your Salesforce custom
    #   metadata.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
    #   @return [Array<Types::DataSourceToIndexFieldMapping>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SalesforceCustomKnowledgeArticleTypeConfiguration AWS API Documentation
    #
    class SalesforceCustomKnowledgeArticleTypeConfiguration < Struct.new(
      :name,
      :document_data_field_name,
      :document_title_field_name,
      :field_mappings)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides the configuration information for the knowledge article types
    # that Amazon Kendra indexes. Amazon Kendra indexes standard knowledge
    # articles and the standard fields of knowledge articles, or the custom
    # fields of custom knowledge articles, but not both
    #
    # @!attribute [rw] included_states
    #   Specifies the document states that should be included when Amazon
    #   Kendra indexes knowledge articles. You must specify at least one
    #   state.
    #   @return [Array<String>]
    #
    # @!attribute [rw] standard_knowledge_article_type_configuration
    #   Configuration information for standard Salesforce knowledge
    #   articles.
    #   @return [Types::SalesforceStandardKnowledgeArticleTypeConfiguration]
    #
    # @!attribute [rw] custom_knowledge_article_type_configurations
    #   Configuration information for custom Salesforce knowledge articles.
    #   @return [Array<Types::SalesforceCustomKnowledgeArticleTypeConfiguration>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SalesforceKnowledgeArticleConfiguration AWS API Documentation
    #
    class SalesforceKnowledgeArticleConfiguration < Struct.new(
      :included_states,
      :standard_knowledge_article_type_configuration,
      :custom_knowledge_article_type_configurations)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides the configuration information for standard Salesforce
    # knowledge articles.
    #
    # @!attribute [rw] document_data_field_name
    #   The name of the field that contains the document data to index.
    #   @return [String]
    #
    # @!attribute [rw] document_title_field_name
    #   The name of the field that contains the document title.
    #   @return [String]
    #
    # @!attribute [rw] field_mappings
    #   Maps attributes or field names of the knowledge article to Amazon
    #   Kendra index field names. To create custom fields, use the
    #   `UpdateIndex` API before you map to Salesforce fields. For more
    #   information, see [Mapping data source fields][1]. The Salesforce
    #   data source field names must exist in your Salesforce custom
    #   metadata.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
    #   @return [Array<Types::DataSourceToIndexFieldMapping>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SalesforceStandardKnowledgeArticleTypeConfiguration AWS API Documentation
    #
    class SalesforceStandardKnowledgeArticleTypeConfiguration < Struct.new(
      :document_data_field_name,
      :document_title_field_name,
      :field_mappings)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides the configuration information for processing attachments to
    # Salesforce standard objects.
    #
    # @!attribute [rw] document_title_field_name
    #   The name of the field used for the document title.
    #   @return [String]
    #
    # @!attribute [rw] field_mappings
    #   One or more objects that map fields in attachments to Amazon Kendra
    #   index fields.
    #   @return [Array<Types::DataSourceToIndexFieldMapping>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SalesforceStandardObjectAttachmentConfiguration AWS API Documentation
    #
    class SalesforceStandardObjectAttachmentConfiguration < Struct.new(
      :document_title_field_name,
      :field_mappings)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides the configuration information for indexing a single standard
    # object.
    #
    # @!attribute [rw] name
    #   The name of the standard object.
    #   @return [String]
    #
    # @!attribute [rw] document_data_field_name
    #   The name of the field in the standard object table that contains the
    #   document contents.
    #   @return [String]
    #
    # @!attribute [rw] document_title_field_name
    #   The name of the field in the standard object table that contains the
    #   document title.
    #   @return [String]
    #
    # @!attribute [rw] field_mappings
    #   Maps attributes or field names of the standard object to Amazon
    #   Kendra index field names. To create custom fields, use the
    #   `UpdateIndex` API before you map to Salesforce fields. For more
    #   information, see [Mapping data source fields][1]. The Salesforce
    #   data source field names must exist in your Salesforce custom
    #   metadata.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
    #   @return [Array<Types::DataSourceToIndexFieldMapping>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SalesforceStandardObjectConfiguration AWS API Documentation
    #
    class SalesforceStandardObjectConfiguration < Struct.new(
      :name,
      :document_data_field_name,
      :document_title_field_name,
      :field_mappings)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides a relative ranking that indicates how confident Amazon Kendra
    # is that the response is relevant to the query.
    #
    # @!attribute [rw] score_confidence
    #   A relative ranking for how relevant the response is to the query.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ScoreAttributes AWS API Documentation
    #
    class ScoreAttributes < Struct.new(
      :score_confidence)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides information about how a custom index field is used during a
    # search.
    #
    # @!attribute [rw] facetable
    #   Indicates that the field can be used to create search facets, a
    #   count of results for each value in the field. The default is `false`
    #   .
    #   @return [Boolean]
    #
    # @!attribute [rw] searchable
    #   Determines whether the field is used in the search. If the
    #   `Searchable` field is `true`, you can use relevance tuning to
    #   manually tune how Amazon Kendra weights the field in the search. The
    #   default is `true` for string fields and `false` for number and date
    #   fields.
    #   @return [Boolean]
    #
    # @!attribute [rw] displayable
    #   Determines whether the field is returned in the query response. The
    #   default is `true`.
    #   @return [Boolean]
    #
    # @!attribute [rw] sortable
    #   Determines whether the field can be used to sort the results of a
    #   query. If you specify sorting on a field that does not have
    #   `Sortable` set to `true`, Amazon Kendra returns an exception. The
    #   default is `false`.
    #   @return [Boolean]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/Search AWS API Documentation
    #
    class Search < Struct.new(
      :facetable,
      :searchable,
      :displayable,
      :sortable)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides the configuration information for the seed or starting point
    # URLs to crawl.
    #
    # *When selecting websites to index, you must adhere to the [Amazon
    # Acceptable Use Policy][1] and all other Amazon terms. Remember that
    # you must only use Amazon Kendra Web Crawler to index your own web
    # pages, or web pages that you have authorization to index.*
    #
    #
    #
    # [1]: https://aws.amazon.com/aup/
    #
    # @!attribute [rw] seed_urls
    #   The list of seed or starting point URLs of the websites you want to
    #   crawl.
    #
    #   The list can include a maximum of 100 seed URLs.
    #   @return [Array<String>]
    #
    # @!attribute [rw] web_crawler_mode
    #   You can choose one of the following modes:
    #
    #   * `HOST_ONLY`—crawl only the website host names. For example, if the
    #     seed URL is "abc.example.com", then only URLs with host name
    #     "abc.example.com" are crawled.
    #
    #   * `SUBDOMAINS`—crawl the website host names with subdomains. For
    #     example, if the seed URL is "abc.example.com", then
    #     "a.abc.example.com" and "b.abc.example.com" are also crawled.
    #
    #   * `EVERYTHING`—crawl the website host names with subdomains and
    #     other domains that the web pages link to.
    #
    #   The default mode is set to `HOST_ONLY`.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SeedUrlConfiguration AWS API Documentation
    #
    class SeedUrlConfiguration < Struct.new(
      :seed_urls,
      :web_crawler_mode)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides the identifier of the KMS key used to encrypt data indexed by
    # Amazon Kendra. Amazon Kendra doesn't support asymmetric keys.
    #
    # @!attribute [rw] kms_key_id
    #   The identifier of the KMS key. Amazon Kendra doesn't support
    #   asymmetric keys.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ServerSideEncryptionConfiguration AWS API Documentation
    #
    class ServerSideEncryptionConfiguration < Struct.new(
      :kms_key_id)
      SENSITIVE = [:kms_key_id]
      include Aws::Structure
    end

    # Provides the configuration information to connect to ServiceNow as
    # your data source.
    #
    # @!attribute [rw] host_url
    #   The ServiceNow instance that the data source connects to. The host
    #   endpoint should look like the following:
    #   *\\\{instance\\}.service-now.com.*
    #   @return [String]
    #
    # @!attribute [rw] secret_arn
    #   The Amazon Resource Name (ARN) of the Secrets Manager secret that
    #   contains the user name and password required to connect to the
    #   ServiceNow instance. You can also provide OAuth authentication
    #   credentials of user name, password, client ID, and client secret.
    #   For more information, see [Using a ServiceNow data source][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/data-source-servicenow.html
    #   @return [String]
    #
    # @!attribute [rw] service_now_build_version
    #   The identifier of the release that the ServiceNow host is running.
    #   If the host is not running the `LONDON` release, use `OTHERS`.
    #   @return [String]
    #
    # @!attribute [rw] knowledge_article_configuration
    #   Configuration information for crawling knowledge articles in the
    #   ServiceNow site.
    #   @return [Types::ServiceNowKnowledgeArticleConfiguration]
    #
    # @!attribute [rw] service_catalog_configuration
    #   Configuration information for crawling service catalogs in the
    #   ServiceNow site.
    #   @return [Types::ServiceNowServiceCatalogConfiguration]
    #
    # @!attribute [rw] authentication_type
    #   The type of authentication used to connect to the ServiceNow
    #   instance. If you choose `HTTP_BASIC`, Amazon Kendra is authenticated
    #   using the user name and password provided in the Secrets Manager
    #   secret in the `SecretArn` field. If you choose `OAUTH2`, Amazon
    #   Kendra is authenticated using the credentials of client ID, client
    #   secret, user name and password.
    #
    #   When you use `OAUTH2` authentication, you must generate a token and
    #   a client secret using the ServiceNow console. For more information,
    #   see [Using a ServiceNow data source][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/data-source-servicenow.html
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ServiceNowConfiguration AWS API Documentation
    #
    class ServiceNowConfiguration < Struct.new(
      :host_url,
      :secret_arn,
      :service_now_build_version,
      :knowledge_article_configuration,
      :service_catalog_configuration,
      :authentication_type)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides the configuration information for crawling knowledge articles
    # in the ServiceNow site.
    #
    # @!attribute [rw] crawl_attachments
    #   `TRUE` to index attachments to knowledge articles.
    #   @return [Boolean]
    #
    # @!attribute [rw] include_attachment_file_patterns
    #   A list of regular expression patterns applied to include knowledge
    #   article attachments. Attachments that match the patterns are
    #   included in the index. Items that don't match the patterns are
    #   excluded from the index. If an item matches both an inclusion and
    #   exclusion pattern, the exclusion pattern takes precedence and the
    #   item isn't included in the index.
    #   @return [Array<String>]
    #
    # @!attribute [rw] exclude_attachment_file_patterns
    #   A list of regular expression patterns applied to exclude certain
    #   knowledge article attachments. Attachments that match the patterns
    #   are excluded from the index. Items that don't match the patterns
    #   are included in the index. If an item matches both an inclusion and
    #   exclusion pattern, the exclusion pattern takes precedence and the
    #   item isn't included in the index.
    #   @return [Array<String>]
    #
    # @!attribute [rw] document_data_field_name
    #   The name of the ServiceNow field that is mapped to the index
    #   document contents field in the Amazon Kendra index.
    #   @return [String]
    #
    # @!attribute [rw] document_title_field_name
    #   The name of the ServiceNow field that is mapped to the index
    #   document title field.
    #   @return [String]
    #
    # @!attribute [rw] field_mappings
    #   Maps attributes or field names of knoweldge articles to Amazon
    #   Kendra index field names. To create custom fields, use the
    #   `UpdateIndex` API before you map to ServiceNow fields. For more
    #   information, see [Mapping data source fields][1]. The ServiceNow
    #   data source field names must exist in your ServiceNow custom
    #   metadata.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
    #   @return [Array<Types::DataSourceToIndexFieldMapping>]
    #
    # @!attribute [rw] filter_query
    #   A query that selects the knowledge articles to index. The query can
    #   return articles from multiple knowledge bases, and the knowledge
    #   bases can be public or private.
    #
    #   The query string must be one generated by the ServiceNow console.
    #   For more information, see [Specifying documents to index with a
    #   query][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/servicenow-query.html
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ServiceNowKnowledgeArticleConfiguration AWS API Documentation
    #
    class ServiceNowKnowledgeArticleConfiguration < Struct.new(
      :crawl_attachments,
      :include_attachment_file_patterns,
      :exclude_attachment_file_patterns,
      :document_data_field_name,
      :document_title_field_name,
      :field_mappings,
      :filter_query)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides the configuration information for crawling service catalog
    # items in the ServiceNow site
    #
    # @!attribute [rw] crawl_attachments
    #   `TRUE` to index attachments to service catalog items.
    #   @return [Boolean]
    #
    # @!attribute [rw] include_attachment_file_patterns
    #   A list of regular expression patterns to include certain attachments
    #   of catalogs in your ServiceNow. Item that match the patterns are
    #   included in the index. Items that don't match the patterns are
    #   excluded from the index. If an item matches both an inclusion and
    #   exclusion pattern, the exclusion pattern takes precedence and the
    #   item isn't included in the index.
    #
    #   The regex is applied to the file name of the attachment.
    #   @return [Array<String>]
    #
    # @!attribute [rw] exclude_attachment_file_patterns
    #   A list of regular expression patterns to exclude certain attachments
    #   of catalogs in your ServiceNow. Item that match the patterns are
    #   excluded from the index. Items that don't match the patterns are
    #   included in the index. If an item matches both an inclusion and
    #   exclusion pattern, the exclusion pattern takes precedence and the
    #   item isn't included in the index.
    #
    #   The regex is applied to the file name of the attachment.
    #   @return [Array<String>]
    #
    # @!attribute [rw] document_data_field_name
    #   The name of the ServiceNow field that is mapped to the index
    #   document contents field in the Amazon Kendra index.
    #   @return [String]
    #
    # @!attribute [rw] document_title_field_name
    #   The name of the ServiceNow field that is mapped to the index
    #   document title field.
    #   @return [String]
    #
    # @!attribute [rw] field_mappings
    #   Maps attributes or field names of catalogs to Amazon Kendra index
    #   field names. To create custom fields, use the `UpdateIndex` API
    #   before you map to ServiceNow fields. For more information, see
    #   [Mapping data source fields][1]. The ServiceNow data source field
    #   names must exist in your ServiceNow custom metadata.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
    #   @return [Array<Types::DataSourceToIndexFieldMapping>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ServiceNowServiceCatalogConfiguration AWS API Documentation
    #
    class ServiceNowServiceCatalogConfiguration < Struct.new(
      :crawl_attachments,
      :include_attachment_file_patterns,
      :exclude_attachment_file_patterns,
      :document_data_field_name,
      :document_title_field_name,
      :field_mappings)
      SENSITIVE = []
      include Aws::Structure
    end

    # You have exceeded the set limits for your Amazon Kendra service.
    # Please see [Quotas][1] for more information, or contact [Support][2]
    # to inquire about an increase of limits.
    #
    #
    #
    # [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
    # [2]: http://aws.amazon.com/contact-us/
    #
    # @!attribute [rw] message
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ServiceQuotaExceededException AWS API Documentation
    #
    class ServiceQuotaExceededException < Struct.new(
      :message)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides the configuration information to connect to Microsoft
    # SharePoint as your data source.
    #
    # @!attribute [rw] share_point_version
    #   The version of Microsoft SharePoint that you use.
    #   @return [String]
    #
    # @!attribute [rw] urls
    #   The Microsoft SharePoint site URLs for the documents you want to
    #   index.
    #   @return [Array<String>]
    #
    # @!attribute [rw] secret_arn
    #   The Amazon Resource Name (ARN) of an Secrets Manager secret that
    #   contains the user name and password required to connect to the
    #   SharePoint instance. For more information, see [Microsoft
    #   SharePoint][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/data-source-sharepoint.html
    #   @return [String]
    #
    # @!attribute [rw] crawl_attachments
    #   `TRUE` to index document attachments.
    #   @return [Boolean]
    #
    # @!attribute [rw] use_change_log
    #   `TRUE` to use the SharePoint change log to determine which documents
    #   require updating in the index. Depending on the change log's size,
    #   it may take longer for Amazon Kendra to use the change log than to
    #   scan all of your documents in SharePoint.
    #   @return [Boolean]
    #
    # @!attribute [rw] inclusion_patterns
    #   A list of regular expression patterns to include certain documents
    #   in your SharePoint. Documents that match the patterns are included
    #   in the index. Documents that don't match the patterns are excluded
    #   from the index. If a document matches both an inclusion and
    #   exclusion pattern, the exclusion pattern takes precedence and the
    #   document isn't included in the index.
    #
    #   The regex applies to the display URL of the SharePoint document.
    #   @return [Array<String>]
    #
    # @!attribute [rw] exclusion_patterns
    #   A list of regular expression patterns to exclude certain documents
    #   in your SharePoint. Documents that match the patterns are excluded
    #   from the index. Documents that don't match the patterns are
    #   included in the index. If a document matches both an inclusion and
    #   exclusion pattern, the exclusion pattern takes precedence and the
    #   document isn't included in the index.
    #
    #   The regex applies to the display URL of the SharePoint document.
    #   @return [Array<String>]
    #
    # @!attribute [rw] vpc_configuration
    #   Configuration information for an Amazon Virtual Private Cloud to
    #   connect to your Microsoft SharePoint. For more information, see
    #   [Configuring a VPC][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html
    #   @return [Types::DataSourceVpcConfiguration]
    #
    # @!attribute [rw] field_mappings
    #   A list of `DataSourceToIndexFieldMapping` objects that map
    #   SharePoint data source attributes or field names to Amazon Kendra
    #   index field names. To create custom fields, use the `UpdateIndex`
    #   API before you map to SharePoint fields. For more information, see
    #   [Mapping data source fields][1]. The SharePoint data source field
    #   names must exist in your SharePoint custom metadata.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
    #   @return [Array<Types::DataSourceToIndexFieldMapping>]
    #
    # @!attribute [rw] document_title_field_name
    #   The Microsoft SharePoint attribute field that contains the title of
    #   the document.
    #   @return [String]
    #
    # @!attribute [rw] disable_local_groups
    #   `TRUE` to disable local groups information.
    #   @return [Boolean]
    #
    # @!attribute [rw] ssl_certificate_s3_path
    #   The path to the SSL certificate stored in an Amazon S3 bucket. You
    #   use this to connect to SharePoint Server if you require a secure SSL
    #   connection.
    #
    #   You can generate a self-signed X509 certificate on any computer
    #   using OpenSSL. For an example of using OpenSSL to create an X509
    #   certificate, see [Create and sign an X509 certificate][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/configuring-https-ssl.html
    #   @return [Types::S3Path]
    #
    # @!attribute [rw] authentication_type
    #   Whether you want to connect to SharePoint Online using basic
    #   authentication of user name and password, or OAuth authentication of
    #   user name, password, client ID, and client secret, or AD App-only
    #   authentication of client secret.
    #   @return [String]
    #
    # @!attribute [rw] proxy_configuration
    #   Configuration information to connect to your Microsoft SharePoint
    #   site URLs via instance via a web proxy. You can use this option for
    #   SharePoint Server.
    #
    #   You must provide the website host name and port number. For example,
    #   the host name of *https://a.example.com/page1.html* is
    #   "a.example.com" and the port is 443, the standard port for HTTPS.
    #
    #   Web proxy credentials are optional and you can use them to connect
    #   to a web proxy server that requires basic authentication of user
    #   name and password. To store web proxy credentials, you use a secret
    #   in Secrets Manager.
    #
    #   It is recommended that you follow best security practices when
    #   configuring your web proxy. This includes setting up throttling,
    #   setting up logging and monitoring, and applying security patches on
    #   a regular basis. If you use your web proxy with multiple data
    #   sources, sync jobs that occur at the same time could strain the load
    #   on your proxy. It is recommended you prepare your proxy beforehand
    #   for any security and load requirements.
    #   @return [Types::ProxyConfiguration]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SharePointConfiguration AWS API Documentation
    #
    class SharePointConfiguration < Struct.new(
      :share_point_version,
      :urls,
      :secret_arn,
      :crawl_attachments,
      :use_change_log,
      :inclusion_patterns,
      :exclusion_patterns,
      :vpc_configuration,
      :field_mappings,
      :document_title_field_name,
      :disable_local_groups,
      :ssl_certificate_s3_path,
      :authentication_type,
      :proxy_configuration)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides the configuration information for the sitemap URLs to crawl.
    #
    # *When selecting websites to index, you must adhere to the [Amazon
    # Acceptable Use Policy][1] and all other Amazon terms. Remember that
    # you must only use Amazon Kendra Web Crawler to index your own web
    # pages, or web pages that you have authorization to index.*
    #
    #
    #
    # [1]: https://aws.amazon.com/aup/
    #
    # @!attribute [rw] site_maps
    #   The list of sitemap URLs of the websites you want to crawl.
    #
    #   The list can include a maximum of three sitemap URLs.
    #   @return [Array<String>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SiteMapsConfiguration AWS API Documentation
    #
    class SiteMapsConfiguration < Struct.new(
      :site_maps)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides the configuration information to connect to Slack as your
    # data source.
    #
    # <note markdown="1"> Amazon Kendra now supports an upgraded Slack connector.
    #
    #  You must now use the [TemplateConfiguration][1] object instead of the
    # `SlackConfiguration` object to configure your connector.
    #
    #  Connectors configured using the older console and API architecture
    # will continue to function as configured. However, you won’t be able to
    # edit or update them. If you want to edit or update your connector
    # configuration, you must create a new connector.
    #
    #  We recommended migrating your connector workflow to the upgraded
    # version. Support for connectors configured using the older
    # architecture is scheduled to end by June 2024.
    #
    #  </note>
    #
    #
    #
    # [1]: https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html
    #
    # @!attribute [rw] team_id
    #   The identifier of the team in the Slack workspace. For example,
    #   *T0123456789*.
    #
    #   You can find your team ID in the URL of the main page of your Slack
    #   workspace. When you log in to Slack via a browser, you are directed
    #   to the URL of the main page. For example,
    #   *https://app.slack.com/client/**T0123456789**/...*.
    #   @return [String]
    #
    # @!attribute [rw] secret_arn
    #   The Amazon Resource Name (ARN) of an Secrets Manager secret that
    #   contains the key-value pairs required to connect to your Slack
    #   workspace team. The secret must contain a JSON structure with the
    #   following keys:
    #
    #   * slackToken—The user or bot token created in Slack. For more
    #     information on creating a token in Slack, see [Authentication for
    #     a Slack data source][1].
    #
    #   ^
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/data-source-slack.html#slack-authentication
    #   @return [String]
    #
    # @!attribute [rw] vpc_configuration
    #   Configuration information for an Amazon Virtual Private Cloud to
    #   connect to your Slack. For more information, see [Configuring a
    #   VPC][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html
    #   @return [Types::DataSourceVpcConfiguration]
    #
    # @!attribute [rw] slack_entity_list
    #   Specify whether to index public channels, private channels, group
    #   messages, and direct messages. You can specify one or more of these
    #   options.
    #   @return [Array<String>]
    #
    # @!attribute [rw] use_change_log
    #   `TRUE` to use the Slack change log to determine which documents
    #   require updating in the index. Depending on the Slack change log's
    #   size, it may take longer for Amazon Kendra to use the change log
    #   than to scan all of your documents in Slack.
    #   @return [Boolean]
    #
    # @!attribute [rw] crawl_bot_message
    #   `TRUE` to index bot messages from your Slack workspace team.
    #   @return [Boolean]
    #
    # @!attribute [rw] exclude_archived
    #   `TRUE` to exclude archived messages to index from your Slack
    #   workspace team.
    #   @return [Boolean]
    #
    # @!attribute [rw] since_crawl_date
    #   The date to start crawling your data from your Slack workspace team.
    #   The date must follow this format: `yyyy-mm-dd`.
    #   @return [String]
    #
    # @!attribute [rw] look_back_period
    #   The number of hours for change log to look back from when you last
    #   synchronized your data. You can look back up to 7 days or 168 hours.
    #
    #   Change log updates your index only if new content was added since
    #   you last synced your data. Updated or deleted content from before
    #   you last synced does not get updated in your index. To capture
    #   updated or deleted content before you last synced, set the
    #   `LookBackPeriod` to the number of hours you want change log to look
    #   back.
    #   @return [Integer]
    #
    # @!attribute [rw] private_channel_filter
    #   The list of private channel names from your Slack workspace team.
    #   You use this if you want to index specific private channels, not all
    #   private channels. You can also use regular expression patterns to
    #   filter private channels.
    #   @return [Array<String>]
    #
    # @!attribute [rw] public_channel_filter
    #   The list of public channel names to index from your Slack workspace
    #   team. You use this if you want to index specific public channels,
    #   not all public channels. You can also use regular expression
    #   patterns to filter public channels.
    #   @return [Array<String>]
    #
    # @!attribute [rw] inclusion_patterns
    #   A list of regular expression patterns to include certain attached
    #   files in your Slack workspace team. Files that match the patterns
    #   are included in the index. Files that don't match the patterns are
    #   excluded from the index. If a file matches both an inclusion and
    #   exclusion pattern, the exclusion pattern takes precedence and the
    #   file isn't included in the index.
    #   @return [Array<String>]
    #
    # @!attribute [rw] exclusion_patterns
    #   A list of regular expression patterns to exclude certain attached
    #   files in your Slack workspace team. Files that match the patterns
    #   are excluded from the index. Files that don’t match the patterns are
    #   included in the index. If a file matches both an inclusion and
    #   exclusion pattern, the exclusion pattern takes precedence and the
    #   file isn't included in the index.
    #   @return [Array<String>]
    #
    # @!attribute [rw] field_mappings
    #   A list of `DataSourceToIndexFieldMapping` objects that map Slack
    #   data source attributes or field names to Amazon Kendra index field
    #   names. To create custom fields, use the `UpdateIndex` API before you
    #   map to Slack fields. For more information, see [Mapping data source
    #   fields][1]. The Slack data source field names must exist in your
    #   Slack custom metadata.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
    #   @return [Array<Types::DataSourceToIndexFieldMapping>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SlackConfiguration AWS API Documentation
    #
    class SlackConfiguration < Struct.new(
      :team_id,
      :secret_arn,
      :vpc_configuration,
      :slack_entity_list,
      :use_change_log,
      :crawl_bot_message,
      :exclude_archived,
      :since_crawl_date,
      :look_back_period,
      :private_channel_filter,
      :public_channel_filter,
      :inclusion_patterns,
      :exclusion_patterns,
      :field_mappings)
      SENSITIVE = []
      include Aws::Structure
    end

    # 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
    #
    # ^
    #
    # @!attribute [rw] document_attribute_key
    #   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
    #   @return [String]
    #
    # @!attribute [rw] sort_order
    #   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.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SortingConfiguration AWS API Documentation
    #
    class SortingConfiguration < Struct.new(
      :document_attribute_key,
      :sort_order)
      SENSITIVE = []
      include Aws::Structure
    end

    # The document ID and its fields/attributes that are used for a query
    # suggestion, if document fields set to use for query suggestions.
    #
    # @!attribute [rw] document_id
    #   The identifier of the document used for a query suggestion.
    #   @return [String]
    #
    # @!attribute [rw] suggestion_attributes
    #   The document fields/attributes used for a query suggestion.
    #   @return [Array<String>]
    #
    # @!attribute [rw] additional_attributes
    #   The additional fields/attributes to include in the response. You can
    #   use additional fields to provide extra information in the response.
    #   Additional fields are not used to based suggestions on.
    #   @return [Array<Types::DocumentAttribute>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SourceDocument AWS API Documentation
    #
    class SourceDocument < Struct.new(
      :document_id,
      :suggestion_attributes,
      :additional_attributes)
      SENSITIVE = []
      include Aws::Structure
    end

    # A query with suggested spell corrections.
    #
    # @!attribute [rw] suggested_query_text
    #   The query with the suggested spell corrections.
    #   @return [String]
    #
    # @!attribute [rw] corrections
    #   The corrected misspelled word or words in a query.
    #   @return [Array<Types::Correction>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SpellCorrectedQuery AWS API Documentation
    #
    class SpellCorrectedQuery < Struct.new(
      :suggested_query_text,
      :corrections)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides the configuration information for suggested query spell
    # corrections.
    #
    # Suggested spell corrections are based on words that appear in your
    # indexed documents and how closely a corrected word matches a
    # misspelled word.
    #
    # This feature is designed with certain defaults or limits. For
    # information on the current limits and how to request more support for
    # some limits, see the [Spell Checker documentation][1].
    #
    #
    #
    # [1]: https://docs.aws.amazon.com/kendra/latest/dg/query-spell-check.html
    #
    # @!attribute [rw] include_query_spell_check_suggestions
    #   `TRUE` to suggest spell corrections for queries.
    #   @return [Boolean]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SpellCorrectionConfiguration AWS API Documentation
    #
    class SpellCorrectionConfiguration < Struct.new(
      :include_query_spell_check_suggestions)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides the configuration information to use a SQL database.
    #
    # @!attribute [rw] query_identifiers_enclosing_option
    #   Determines whether Amazon Kendra encloses SQL identifiers for tables
    #   and column names in double quotes (") when making a database query.
    #
    #   By default, Amazon Kendra passes SQL identifiers the way that they
    #   are entered into the data source configuration. It does not change
    #   the case of identifiers or enclose them in quotes.
    #
    #   PostgreSQL internally converts uppercase characters to lower case
    #   characters in identifiers unless they are quoted. Choosing this
    #   option encloses identifiers in quotes so that PostgreSQL does not
    #   convert the character's case.
    #
    #   For MySQL databases, you must enable the `ansi_quotes` option when
    #   you set this field to `DOUBLE_QUOTES`.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SqlConfiguration AWS API Documentation
    #
    class SqlConfiguration < Struct.new(
      :query_identifiers_enclosing_option)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] id
    #   The identifier of the data source connector to synchronize.
    #   @return [String]
    #
    # @!attribute [rw] index_id
    #   The identifier of the index used with the data source connector.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/StartDataSourceSyncJobRequest AWS API Documentation
    #
    class StartDataSourceSyncJobRequest < Struct.new(
      :id,
      :index_id)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] execution_id
    #   Identifies a particular synchronization job.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/StartDataSourceSyncJobResponse AWS API Documentation
    #
    class StartDataSourceSyncJobResponse < Struct.new(
      :execution_id)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides information about the status of documents submitted for
    # indexing.
    #
    # @!attribute [rw] document_id
    #   The identifier of the document.
    #   @return [String]
    #
    # @!attribute [rw] document_status
    #   The current status of a document.
    #
    #   If the document was submitted for deletion, the status is
    #   `NOT_FOUND` after the document is deleted.
    #   @return [String]
    #
    # @!attribute [rw] failure_code
    #   Indicates the source of the error.
    #   @return [String]
    #
    # @!attribute [rw] failure_reason
    #   Provides detailed information about why the document couldn't be
    #   indexed. Use this information to correct the error before you
    #   resubmit the document for indexing.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/Status AWS API Documentation
    #
    class Status < Struct.new(
      :document_id,
      :document_status,
      :failure_code,
      :failure_reason)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] id
    #   The identifier of the data source connector for which to stop the
    #   synchronization jobs.
    #   @return [String]
    #
    # @!attribute [rw] index_id
    #   The identifier of the index used with the data source connector.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/StopDataSourceSyncJobRequest AWS API Documentation
    #
    class StopDataSourceSyncJobRequest < Struct.new(
      :id,
      :index_id)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] index_id
    #   The identifier of the index that was queried.
    #   @return [String]
    #
    # @!attribute [rw] query_id
    #   The identifier of the specific query for which you are submitting
    #   feedback. The query ID is returned in the response to the `Query`
    #   API.
    #   @return [String]
    #
    # @!attribute [rw] click_feedback_items
    #   Tells Amazon Kendra that a particular search result link was chosen
    #   by the user.
    #   @return [Array<Types::ClickFeedback>]
    #
    # @!attribute [rw] relevance_feedback_items
    #   Provides Amazon Kendra with relevant or not relevant feedback for
    #   whether a particular item was relevant to the search.
    #   @return [Array<Types::RelevanceFeedback>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SubmitFeedbackRequest AWS API Documentation
    #
    class SubmitFeedbackRequest < Struct.new(
      :index_id,
      :query_id,
      :click_feedback_items,
      :relevance_feedback_items)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides the configuration information for a document field/attribute
    # that you want to base query suggestions on.
    #
    # @!attribute [rw] attribute_name
    #   The name of the document field/attribute.
    #   @return [String]
    #
    # @!attribute [rw] suggestable
    #   `TRUE` means the document field/attribute is suggestible, so the
    #   contents within the field can be used for query suggestions.
    #   @return [Boolean]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SuggestableConfig AWS API Documentation
    #
    class SuggestableConfig < Struct.new(
      :attribute_name,
      :suggestable)
      SENSITIVE = []
      include Aws::Structure
    end

    # A single query suggestion.
    #
    # @!attribute [rw] id
    #   The UUID (universally unique identifier) of a single query
    #   suggestion.
    #   @return [String]
    #
    # @!attribute [rw] value
    #   The value for the UUID (universally unique identifier) of a single
    #   query suggestion.
    #
    #   The value is the text string of a suggestion.
    #   @return [Types::SuggestionValue]
    #
    # @!attribute [rw] source_documents
    #   The list of document IDs and their fields/attributes that are used
    #   for a single query suggestion, if document fields set to use for
    #   query suggestions.
    #   @return [Array<Types::SourceDocument>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/Suggestion AWS API Documentation
    #
    class Suggestion < Struct.new(
      :id,
      :value,
      :source_documents)
      SENSITIVE = []
      include Aws::Structure
    end

    # The text highlights for a single query suggestion.
    #
    # @!attribute [rw] begin_offset
    #   The zero-based location in the response string where the highlight
    #   starts.
    #   @return [Integer]
    #
    # @!attribute [rw] end_offset
    #   The zero-based location in the response string where the highlight
    #   ends.
    #   @return [Integer]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SuggestionHighlight AWS API Documentation
    #
    class SuggestionHighlight < Struct.new(
      :begin_offset,
      :end_offset)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides text and information about where to highlight the query
    # suggestion text.
    #
    # @!attribute [rw] text
    #   The query suggestion text to display to the user.
    #   @return [String]
    #
    # @!attribute [rw] highlights
    #   The beginning and end of the query suggestion text that should be
    #   highlighted.
    #   @return [Array<Types::SuggestionHighlight>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SuggestionTextWithHighlights AWS API Documentation
    #
    class SuggestionTextWithHighlights < Struct.new(
      :text,
      :highlights)
      SENSITIVE = []
      include Aws::Structure
    end

    # The `SuggestionTextWithHighlights` structure information.
    #
    # @!attribute [rw] text
    #   The `SuggestionTextWithHighlights` structure that contains the query
    #   suggestion text and highlights.
    #   @return [Types::SuggestionTextWithHighlights]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SuggestionValue AWS API Documentation
    #
    class SuggestionValue < Struct.new(
      :text)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides information about a table cell in a table excerpt.
    #
    # @!attribute [rw] value
    #   The actual value or content within a table cell. A table cell could
    #   contain a date value of a year, or a string value of text, for
    #   example.
    #   @return [String]
    #
    # @!attribute [rw] top_answer
    #   `TRUE` if the response of the table cell is the top answer. This is
    #   the cell value or content with the highest confidence score or is
    #   the most relevant to the query.
    #   @return [Boolean]
    #
    # @!attribute [rw] highlighted
    #   `TRUE` means that the table cell has a high enough confidence and is
    #   relevant to the query, so the value or content should be
    #   highlighted.
    #   @return [Boolean]
    #
    # @!attribute [rw] header
    #   `TRUE` means that the table cell should be treated as a header.
    #   @return [Boolean]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/TableCell AWS API Documentation
    #
    class TableCell < Struct.new(
      :value,
      :top_answer,
      :highlighted,
      :header)
      SENSITIVE = []
      include Aws::Structure
    end

    # An excerpt from a table within a document. The table excerpt displays
    # up to five columns and three rows, depending on how many table cells
    # are relevant to the query and how many columns are available in the
    # original table. The top most relevant cell is displayed in the table
    # excerpt, along with the next most relevant cells.
    #
    # @!attribute [rw] rows
    #   A list of rows in the table excerpt.
    #   @return [Array<Types::TableRow>]
    #
    # @!attribute [rw] total_number_of_rows
    #   A count of the number of rows in the original table within the
    #   document.
    #   @return [Integer]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/TableExcerpt AWS API Documentation
    #
    class TableExcerpt < Struct.new(
      :rows,
      :total_number_of_rows)
      SENSITIVE = []
      include Aws::Structure
    end

    # Information about a row in a table excerpt.
    #
    # @!attribute [rw] cells
    #   A list of table cells in a row.
    #   @return [Array<Types::TableCell>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/TableRow AWS API Documentation
    #
    class TableRow < Struct.new(
      :cells)
      SENSITIVE = []
      include Aws::Structure
    end

    # A list of key/value pairs that identify an index, FAQ, or data source.
    # Tag keys and values can consist of Unicode letters, digits, white
    # space, and any of the following symbols: \_ . : / = + - @.
    #
    # @!attribute [rw] key
    #   The key for the tag. Keys are not case sensitive and must be unique
    #   for the index, FAQ, or data source.
    #   @return [String]
    #
    # @!attribute [rw] value
    #   The value associated with the tag. The value may be an empty string
    #   but it can't be null.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/Tag AWS API Documentation
    #
    class Tag < Struct.new(
      :key,
      :value)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] resource_arn
    #   The Amazon Resource Name (ARN) of the index, FAQ, or data source to
    #   tag.
    #   @return [String]
    #
    # @!attribute [rw] tags
    #   A list of tag keys to add to the index, FAQ, or data source. If a
    #   tag already exists, the existing value is replaced with the new
    #   value.
    #   @return [Array<Types::Tag>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/TagResourceRequest AWS API Documentation
    #
    class TagResourceRequest < Struct.new(
      :resource_arn,
      :tags)
      SENSITIVE = []
      include Aws::Structure
    end

    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/TagResourceResponse AWS API Documentation
    #
    class TagResourceResponse < Aws::EmptyStructure; end

    # Provides a template for the configuration information to connect to
    # your data source.
    #
    # @!attribute [rw] template
    #   The template schema used for the data source, where templates
    #   schemas are supported.
    #
    #   See [Data source template schemas][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html
    #   @return [Hash,Array,String,Numeric,Boolean]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/TemplateConfiguration AWS API Documentation
    #
    class TemplateConfiguration < Struct.new(
      :template)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides information about text documents indexed in an index.
    #
    # @!attribute [rw] indexed_text_documents_count
    #   The number of text documents indexed.
    #   @return [Integer]
    #
    # @!attribute [rw] indexed_text_bytes
    #   The total size, in bytes, of the indexed documents.
    #   @return [Integer]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/TextDocumentStatistics AWS API Documentation
    #
    class TextDocumentStatistics < Struct.new(
      :indexed_text_documents_count,
      :indexed_text_bytes)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides text and information about where to highlight the text.
    #
    # @!attribute [rw] text
    #   The text to display to the user.
    #   @return [String]
    #
    # @!attribute [rw] highlights
    #   The beginning and end of the text that should be highlighted.
    #   @return [Array<Types::Highlight>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/TextWithHighlights AWS API Documentation
    #
    class TextWithHighlights < Struct.new(
      :text,
      :highlights)
      SENSITIVE = []
      include Aws::Structure
    end

    # An array of summary information for a thesaurus or multiple thesauri.
    #
    # @!attribute [rw] id
    #   The identifier of the thesaurus.
    #   @return [String]
    #
    # @!attribute [rw] name
    #   The name of the thesaurus.
    #   @return [String]
    #
    # @!attribute [rw] status
    #   The status of the thesaurus.
    #   @return [String]
    #
    # @!attribute [rw] created_at
    #   The Unix timestamp when the thesaurus was created.
    #   @return [Time]
    #
    # @!attribute [rw] updated_at
    #   The Unix timestamp when the thesaurus was last updated.
    #   @return [Time]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ThesaurusSummary AWS API Documentation
    #
    class ThesaurusSummary < Struct.new(
      :id,
      :name,
      :status,
      :created_at,
      :updated_at)
      SENSITIVE = []
      include Aws::Structure
    end

    # The request was denied due to request throttling. Please reduce the
    # number of requests and try again.
    #
    # @!attribute [rw] message
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ThrottlingException AWS API Documentation
    #
    class ThrottlingException < Struct.new(
      :message)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides a range of time.
    #
    # @!attribute [rw] start_time
    #   The Unix timestamp for the beginning of the time range.
    #   @return [Time]
    #
    # @!attribute [rw] end_time
    #   The Unix timestamp for the end of the time range.
    #   @return [Time]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/TimeRange AWS API Documentation
    #
    class TimeRange < Struct.new(
      :start_time,
      :end_time)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] resource_arn
    #   The Amazon Resource Name (ARN) of the index, FAQ, or data source to
    #   remove the tag from.
    #   @return [String]
    #
    # @!attribute [rw] tag_keys
    #   A list of tag keys to remove from the index, FAQ, or data source. If
    #   a tag key does not exist on the resource, it is ignored.
    #   @return [Array<String>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UntagResourceRequest AWS API Documentation
    #
    class UntagResourceRequest < Struct.new(
      :resource_arn,
      :tag_keys)
      SENSITIVE = []
      include Aws::Structure
    end

    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UntagResourceResponse AWS API Documentation
    #
    class UntagResourceResponse < Aws::EmptyStructure; end

    # @!attribute [rw] index_id
    #   The identifier of the index for an access control configuration.
    #   @return [String]
    #
    # @!attribute [rw] id
    #   The identifier of the access control configuration you want to
    #   update.
    #   @return [String]
    #
    # @!attribute [rw] name
    #   A new name for the access control configuration.
    #   @return [String]
    #
    # @!attribute [rw] description
    #   A new description for the access control configuration.
    #   @return [String]
    #
    # @!attribute [rw] access_control_list
    #   Information you want to update on principals (users and/or groups)
    #   and which documents they should have access to. This is useful for
    #   user context filtering, where search results are filtered based on
    #   the user or their group access to documents.
    #   @return [Array<Types::Principal>]
    #
    # @!attribute [rw] hierarchical_access_control_list
    #   The updated list of [principal][1] lists that define the hierarchy
    #   for which documents users should have access to.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_Principal.html
    #   @return [Array<Types::HierarchicalPrincipal>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateAccessControlConfigurationRequest AWS API Documentation
    #
    class UpdateAccessControlConfigurationRequest < Struct.new(
      :index_id,
      :id,
      :name,
      :description,
      :access_control_list,
      :hierarchical_access_control_list)
      SENSITIVE = []
      include Aws::Structure
    end

    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateAccessControlConfigurationResponse AWS API Documentation
    #
    class UpdateAccessControlConfigurationResponse < Aws::EmptyStructure; end

    # @!attribute [rw] id
    #   The identifier of the data source connector you want to update.
    #   @return [String]
    #
    # @!attribute [rw] name
    #   A new name for the data source connector.
    #   @return [String]
    #
    # @!attribute [rw] index_id
    #   The identifier of the index used with the data source connector.
    #   @return [String]
    #
    # @!attribute [rw] configuration
    #   Configuration information you want to update for the data source
    #   connector.
    #   @return [Types::DataSourceConfiguration]
    #
    # @!attribute [rw] vpc_configuration
    #   Configuration information for an Amazon Virtual Private Cloud to
    #   connect to your data source. For more information, see [Configuring
    #   a VPC][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html
    #   @return [Types::DataSourceVpcConfiguration]
    #
    # @!attribute [rw] description
    #   A new description for the data source connector.
    #   @return [String]
    #
    # @!attribute [rw] schedule
    #   The sync schedule you want to update for the data source connector.
    #   @return [String]
    #
    # @!attribute [rw] role_arn
    #   The Amazon Resource Name (ARN) of a role with permission to access
    #   the data source and required resources. For more information, see
    #   [IAM roles for Amazon Kendra][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html
    #   @return [String]
    #
    # @!attribute [rw] language_code
    #   The code for a language you want to update for the data source
    #   connector. This allows you to support a language for all documents
    #   when updating the data source. English is supported by default. For
    #   more information on supported languages, including their codes, see
    #   [Adding documents in languages other than English][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html
    #   @return [String]
    #
    # @!attribute [rw] custom_document_enrichment_configuration
    #   Configuration information you want to update for altering document
    #   metadata and content during the document ingestion process.
    #
    #   For more information on how to create, modify and delete document
    #   metadata, or make other content alterations when you ingest
    #   documents into Amazon Kendra, see [Customizing document metadata
    #   during the ingestion process][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html
    #   @return [Types::CustomDocumentEnrichmentConfiguration]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateDataSourceRequest AWS API Documentation
    #
    class UpdateDataSourceRequest < Struct.new(
      :id,
      :name,
      :index_id,
      :configuration,
      :vpc_configuration,
      :description,
      :schedule,
      :role_arn,
      :language_code,
      :custom_document_enrichment_configuration)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] id
    #   The identifier of your Amazon Kendra experience you want to update.
    #   @return [String]
    #
    # @!attribute [rw] name
    #   A new name for your Amazon Kendra experience.
    #   @return [String]
    #
    # @!attribute [rw] index_id
    #   The identifier of the index for your Amazon Kendra experience.
    #   @return [String]
    #
    # @!attribute [rw] role_arn
    #   The Amazon Resource Name (ARN) of a role with permission to access
    #   `Query` API, `QuerySuggestions` API, `SubmitFeedback` API, and IAM
    #   Identity Center that stores your user and group information. For
    #   more information, see [IAM roles for Amazon Kendra][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html
    #   @return [String]
    #
    # @!attribute [rw] configuration
    #   Configuration information you want to update for your Amazon Kendra
    #   experience.
    #   @return [Types::ExperienceConfiguration]
    #
    # @!attribute [rw] description
    #   A new description for your Amazon Kendra experience.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateExperienceRequest AWS API Documentation
    #
    class UpdateExperienceRequest < Struct.new(
      :id,
      :name,
      :index_id,
      :role_arn,
      :configuration,
      :description)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] index_id
    #   The identifier of the index used for featuring results.
    #   @return [String]
    #
    # @!attribute [rw] featured_results_set_id
    #   The identifier of the set of featured results that you want to
    #   update.
    #   @return [String]
    #
    # @!attribute [rw] featured_results_set_name
    #   A new name for the set of featured results.
    #   @return [String]
    #
    # @!attribute [rw] description
    #   A new description for the set of featured results.
    #   @return [String]
    #
    # @!attribute [rw] status
    #   You can set the status to `ACTIVE` or `INACTIVE`. When the value is
    #   `ACTIVE`, featured results are ready for use. You can still
    #   configure your settings before setting the status to `ACTIVE`. The
    #   queries you specify for featured results must be unique per featured
    #   results set for each index, whether the status is `ACTIVE` or
    #   `INACTIVE`.
    #   @return [String]
    #
    # @!attribute [rw] query_texts
    #   A list of queries for featuring results. For more information on the
    #   list of queries, see [FeaturedResultsSet][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_FeaturedResultsSet.html
    #   @return [Array<String>]
    #
    # @!attribute [rw] featured_documents
    #   A list of document IDs for the documents you want to feature at the
    #   top of the search results page. For more information on the list of
    #   featured documents, see [FeaturedResultsSet][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_FeaturedResultsSet.html
    #   @return [Array<Types::FeaturedDocument>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateFeaturedResultsSetRequest AWS API Documentation
    #
    class UpdateFeaturedResultsSetRequest < Struct.new(
      :index_id,
      :featured_results_set_id,
      :featured_results_set_name,
      :description,
      :status,
      :query_texts,
      :featured_documents)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] featured_results_set
    #   Information on the set of featured results. This includes the
    #   identifier of the featured results set, whether the featured results
    #   set is active or inactive, when the featured results set was last
    #   updated, and more.
    #   @return [Types::FeaturedResultsSet]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateFeaturedResultsSetResponse AWS API Documentation
    #
    class UpdateFeaturedResultsSetResponse < Struct.new(
      :featured_results_set)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] id
    #   The identifier of the index you want to update.
    #   @return [String]
    #
    # @!attribute [rw] name
    #   A new name for the index.
    #   @return [String]
    #
    # @!attribute [rw] role_arn
    #   An Identity and Access Management (IAM) role that gives Amazon
    #   Kendra permission to access Amazon CloudWatch logs and metrics.
    #   @return [String]
    #
    # @!attribute [rw] description
    #   A new description for the index.
    #   @return [String]
    #
    # @!attribute [rw] document_metadata_configuration_updates
    #   The document metadata configuration you want to update for the
    #   index. Document metadata are fields or attributes associated with
    #   your documents. For example, the company department name associated
    #   with each document.
    #   @return [Array<Types::DocumentMetadataConfiguration>]
    #
    # @!attribute [rw] capacity_units
    #   Sets the number of additional document storage and query capacity
    #   units that should be used by the index. You can change the capacity
    #   of the index up to 5 times per day, or make 5 API calls.
    #
    #   If you are using extra storage units, you can't reduce the storage
    #   capacity below what is required to meet the storage needs for your
    #   index.
    #   @return [Types::CapacityUnitsConfiguration]
    #
    # @!attribute [rw] user_token_configurations
    #   The user token configuration.
    #   @return [Array<Types::UserTokenConfiguration>]
    #
    # @!attribute [rw] user_context_policy
    #   The user context policy.
    #   @return [String]
    #
    # @!attribute [rw] user_group_resolution_configuration
    #   Gets users and groups from IAM Identity Center identity source. To
    #   configure this, see [UserGroupResolutionConfiguration][1]. This is
    #   useful for user context filtering, where search results are filtered
    #   based on the user or their group access to documents.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_UserGroupResolutionConfiguration.html
    #   @return [Types::UserGroupResolutionConfiguration]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateIndexRequest AWS API Documentation
    #
    class UpdateIndexRequest < Struct.new(
      :id,
      :name,
      :role_arn,
      :description,
      :document_metadata_configuration_updates,
      :capacity_units,
      :user_token_configurations,
      :user_context_policy,
      :user_group_resolution_configuration)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] index_id
    #   The identifier of the index for the block list.
    #   @return [String]
    #
    # @!attribute [rw] id
    #   The identifier of the block list you want to update.
    #   @return [String]
    #
    # @!attribute [rw] name
    #   A new name for the block list.
    #   @return [String]
    #
    # @!attribute [rw] description
    #   A new description for the block list.
    #   @return [String]
    #
    # @!attribute [rw] source_s3_path
    #   The S3 path where your block list text file sits in S3.
    #
    #   If you update your block list and provide the same path to the block
    #   list text file in S3, then Amazon Kendra reloads the file to refresh
    #   the block list. Amazon Kendra does not automatically refresh your
    #   block list. You need to call the `UpdateQuerySuggestionsBlockList`
    #   API to refresh you block list.
    #
    #   If you update your block list, then Amazon Kendra asynchronously
    #   refreshes all query suggestions with the latest content in the S3
    #   file. This means changes might not take effect immediately.
    #   @return [Types::S3Path]
    #
    # @!attribute [rw] role_arn
    #   The IAM (Identity and Access Management) role used to access the
    #   block list text file in S3.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateQuerySuggestionsBlockListRequest AWS API Documentation
    #
    class UpdateQuerySuggestionsBlockListRequest < Struct.new(
      :index_id,
      :id,
      :name,
      :description,
      :source_s3_path,
      :role_arn)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] index_id
    #   The identifier of the index with query suggestions you want to
    #   update.
    #   @return [String]
    #
    # @!attribute [rw] mode
    #   Set the mode to `ENABLED` or `LEARN_ONLY`.
    #
    #   By default, Amazon Kendra enables query suggestions. `LEARN_ONLY`
    #   mode allows you to turn off query suggestions. You can to update
    #   this at any time.
    #
    #   In `LEARN_ONLY` mode, Amazon Kendra continues to learn from new
    #   queries to keep suggestions up to date for when you are ready to
    #   switch to ENABLED mode again.
    #   @return [String]
    #
    # @!attribute [rw] query_log_look_back_window_in_days
    #   How recent your queries are in your query log time window.
    #
    #   The time window is the number of days from current day to past days.
    #
    #   By default, Amazon Kendra sets this to 180.
    #   @return [Integer]
    #
    # @!attribute [rw] include_queries_without_user_information
    #   `TRUE` to include queries without user information (i.e. all
    #   queries, irrespective of the user), otherwise `FALSE` to only
    #   include queries with user information.
    #
    #   If you pass user information to Amazon Kendra along with the
    #   queries, you can set this flag to `FALSE` and instruct Amazon Kendra
    #   to only consider queries with user information.
    #
    #   If you set to `FALSE`, Amazon Kendra only considers queries searched
    #   at least `MinimumQueryCount` times across
    #   `MinimumNumberOfQueryingUsers` unique users for suggestions.
    #
    #   If you set to `TRUE`, Amazon Kendra ignores all user information and
    #   learns from all queries.
    #   @return [Boolean]
    #
    # @!attribute [rw] minimum_number_of_querying_users
    #   The minimum number of unique users who must search a query in order
    #   for the query to be eligible to suggest to your users.
    #
    #   Increasing this number might decrease the number of suggestions.
    #   However, this ensures a query is searched by many users and is truly
    #   popular to suggest to users.
    #
    #   How you tune this setting depends on your specific needs.
    #   @return [Integer]
    #
    # @!attribute [rw] minimum_query_count
    #   The the minimum number of times a query must be searched in order to
    #   be eligible to suggest to your users.
    #
    #   Decreasing this number increases the number of suggestions. However,
    #   this affects the quality of suggestions as it sets a low bar for a
    #   query to be considered popular to suggest to users.
    #
    #   How you tune this setting depends on your specific needs.
    #   @return [Integer]
    #
    # @!attribute [rw] attribute_suggestions_config
    #   Configuration information for the document fields/attributes that
    #   you want to base query suggestions on.
    #   @return [Types::AttributeSuggestionsUpdateConfig]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateQuerySuggestionsConfigRequest AWS API Documentation
    #
    class UpdateQuerySuggestionsConfigRequest < Struct.new(
      :index_id,
      :mode,
      :query_log_look_back_window_in_days,
      :include_queries_without_user_information,
      :minimum_number_of_querying_users,
      :minimum_query_count,
      :attribute_suggestions_config)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] id
    #   The identifier of the thesaurus you want to update.
    #   @return [String]
    #
    # @!attribute [rw] name
    #   A new name for the thesaurus.
    #   @return [String]
    #
    # @!attribute [rw] index_id
    #   The identifier of the index for the thesaurus.
    #   @return [String]
    #
    # @!attribute [rw] description
    #   A new description for the thesaurus.
    #   @return [String]
    #
    # @!attribute [rw] role_arn
    #   An IAM role that gives Amazon Kendra permissions to access thesaurus
    #   file specified in `SourceS3Path`.
    #   @return [String]
    #
    # @!attribute [rw] source_s3_path
    #   Information required to find a specific file in an Amazon S3 bucket.
    #   @return [Types::S3Path]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateThesaurusRequest AWS API Documentation
    #
    class UpdateThesaurusRequest < Struct.new(
      :id,
      :name,
      :index_id,
      :description,
      :role_arn,
      :source_s3_path)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides the configuration information of the URLs to crawl.
    #
    # You can only crawl websites that use the secure communication
    # protocol, Hypertext Transfer Protocol Secure (HTTPS). If you receive
    # an error when crawling a website, it could be that the website is
    # blocked from crawling.
    #
    # *When selecting websites to index, you must adhere to the [Amazon
    # Acceptable Use Policy][1] and all other Amazon terms. Remember that
    # you must only use Amazon Kendra Web Crawler to index your own web
    # pages, or web pages that you have authorization to index.*
    #
    #
    #
    # [1]: https://aws.amazon.com/aup/
    #
    # @!attribute [rw] seed_url_configuration
    #   Configuration of the seed or starting point URLs of the websites you
    #   want to crawl.
    #
    #   You can choose to crawl only the website host names, or the website
    #   host names with subdomains, or the website host names with
    #   subdomains and other domains that the web pages link to.
    #
    #   You can list up to 100 seed URLs.
    #   @return [Types::SeedUrlConfiguration]
    #
    # @!attribute [rw] site_maps_configuration
    #   Configuration of the sitemap URLs of the websites you want to crawl.
    #
    #   Only URLs belonging to the same website host names are crawled. You
    #   can list up to three sitemap URLs.
    #   @return [Types::SiteMapsConfiguration]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/Urls AWS API Documentation
    #
    class Urls < Struct.new(
      :seed_url_configuration,
      :site_maps_configuration)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides information about the user context for an Amazon Kendra
    # index.
    #
    # User context filtering is a kind of personalized search with the
    # benefit of controlling access to documents. For example, not all teams
    # that search the company portal for information should access
    # top-secret company documents, nor are these documents relevant to all
    # users. Only specific users or groups of teams given access to
    # top-secret documents should see these documents in their search
    # results.
    #
    # You provide one of the following:
    #
    # * User token
    #
    # * User ID, the groups the user belongs to, and any data sources the
    #   groups can access.
    #
    # If you provide both, an exception is thrown.
    #
    # @!attribute [rw] token
    #   The user context token for filtering search results for a user. It
    #   must be a JWT or a JSON token.
    #   @return [String]
    #
    # @!attribute [rw] user_id
    #   The identifier of the user you want to filter search results based
    #   on their access to documents.
    #   @return [String]
    #
    # @!attribute [rw] groups
    #   The list of groups you want to filter search results based on the
    #   groups' access to documents.
    #   @return [Array<String>]
    #
    # @!attribute [rw] data_source_groups
    #   The list of data source groups you want to filter search results
    #   based on groups' access to documents in that data source.
    #   @return [Array<Types::DataSourceGroup>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UserContext AWS API Documentation
    #
    class UserContext < Struct.new(
      :token,
      :user_id,
      :groups,
      :data_source_groups)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides the configuration information to get users and groups from an
    # IAM Identity Center identity source. This is useful for user context
    # filtering, where search results are filtered based on the user or
    # their group access to documents. You can also use the
    # [PutPrincipalMapping][1] API to map users to their groups so that you
    # only need to provide the user ID when you issue the query.
    #
    # To set up an IAM Identity Center identity source in the console to use
    # with Amazon Kendra, see [Getting started with an IAM Identity Center
    # identity source][2]. You must also grant the required permissions to
    # use IAM Identity Center with Amazon Kendra. For more information, see
    # [IAM roles for IAM Identity Center][3].
    #
    # Amazon Kendra currently does not support using
    # `UserGroupResolutionConfiguration` with an Amazon Web Services
    # organization member account for your IAM Identity Center identify
    # source. You must create your index in the management account for the
    # organization in order to use `UserGroupResolutionConfiguration`.
    #
    #
    #
    # [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html
    # [2]: https://docs.aws.amazon.com/kendra/latest/dg/getting-started-aws-sso.html
    # [3]: https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-aws-sso
    #
    # @!attribute [rw] user_group_resolution_mode
    #   The identity store provider (mode) you want to use to get users and
    #   groups. IAM Identity Center is currently the only available mode.
    #   Your users and groups must exist in an IAM Identity Center identity
    #   source in order to use this mode.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UserGroupResolutionConfiguration AWS API Documentation
    #
    class UserGroupResolutionConfiguration < Struct.new(
      :user_group_resolution_mode)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides the configuration information for the identifiers of your
    # users.
    #
    # @!attribute [rw] identity_attribute_name
    #   The IAM Identity Center field name that contains the identifiers of
    #   your users, such as their emails. This is used for [user context
    #   filtering][1] and for granting access to your Amazon Kendra
    #   experience. You must set up IAM Identity Center with Amazon Kendra.
    #   You must include your users and groups in your Access Control List
    #   when you ingest documents into your index. For more information, see
    #   [Getting started with an IAM Identity Center identity source][2].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html
    #   [2]: https://docs.aws.amazon.com/kendra/latest/dg/getting-started-aws-sso.html
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UserIdentityConfiguration AWS API Documentation
    #
    class UserIdentityConfiguration < Struct.new(
      :identity_attribute_name)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides the configuration information for a token.
    #
    # @!attribute [rw] jwt_token_type_configuration
    #   Information about the JWT token type configuration.
    #   @return [Types::JwtTokenTypeConfiguration]
    #
    # @!attribute [rw] json_token_type_configuration
    #   Information about the JSON token type configuration.
    #   @return [Types::JsonTokenTypeConfiguration]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UserTokenConfiguration AWS API Documentation
    #
    class UserTokenConfiguration < Struct.new(
      :jwt_token_type_configuration,
      :json_token_type_configuration)
      SENSITIVE = []
      include Aws::Structure
    end

    # The input fails to satisfy the constraints set by the Amazon Kendra
    # service. Please provide the correct input and try again.
    #
    # @!attribute [rw] message
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ValidationException AWS API Documentation
    #
    class ValidationException < Struct.new(
      :message)
      SENSITIVE = []
      include Aws::Structure
    end

    # The warning code and message that explains a problem with a query.
    #
    # @!attribute [rw] message
    #   The message that explains the problem with the query.
    #   @return [String]
    #
    # @!attribute [rw] code
    #   The code used to show the type of warning for the query.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/Warning AWS API Documentation
    #
    class Warning < Struct.new(
      :message,
      :code)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides the configuration information required for Amazon Kendra Web
    # Crawler.
    #
    # @!attribute [rw] urls
    #   Specifies the seed or starting point URLs of the websites or the
    #   sitemap URLs of the websites you want to crawl.
    #
    #   You can include website subdomains. You can list up to 100 seed URLs
    #   and up to three sitemap URLs.
    #
    #   You can only crawl websites that use the secure communication
    #   protocol, Hypertext Transfer Protocol Secure (HTTPS). If you receive
    #   an error when crawling a website, it could be that the website is
    #   blocked from crawling.
    #
    #   *When selecting websites to index, you must adhere to the [Amazon
    #   Acceptable Use Policy][1] and all other Amazon terms. Remember that
    #   you must only use Amazon Kendra Web Crawler to index your own web
    #   pages, or web pages that you have authorization to index.*
    #
    #
    #
    #   [1]: https://aws.amazon.com/aup/
    #   @return [Types::Urls]
    #
    # @!attribute [rw] crawl_depth
    #   The 'depth' or number of levels from the seed level to crawl. For
    #   example, the seed URL page is depth 1 and any hyperlinks on this
    #   page that are also crawled are depth 2.
    #   @return [Integer]
    #
    # @!attribute [rw] max_links_per_page
    #   The maximum number of URLs on a web page to include when crawling a
    #   website. This number is per web page.
    #
    #   As a website’s web pages are crawled, any URLs the web pages link to
    #   are also crawled. URLs on a web page are crawled in order of
    #   appearance.
    #
    #   The default maximum links per page is 100.
    #   @return [Integer]
    #
    # @!attribute [rw] max_content_size_per_page_in_mega_bytes
    #   The maximum size (in MB) of a web page or attachment to crawl.
    #
    #   Files larger than this size (in MB) are skipped/not crawled.
    #
    #   The default maximum size of a web page or attachment is set to 50
    #   MB.
    #   @return [Float]
    #
    # @!attribute [rw] max_urls_per_minute_crawl_rate
    #   The maximum number of URLs crawled per website host per minute.
    #
    #   A minimum of one URL is required.
    #
    #   The default maximum number of URLs crawled per website host per
    #   minute is 300.
    #   @return [Integer]
    #
    # @!attribute [rw] url_inclusion_patterns
    #   A list of regular expression patterns to include certain URLs to
    #   crawl. URLs that match the patterns are included in the index. URLs
    #   that don't match the patterns are excluded from the index. If a URL
    #   matches both an inclusion and exclusion pattern, the exclusion
    #   pattern takes precedence and the URL file isn't included in the
    #   index.
    #   @return [Array<String>]
    #
    # @!attribute [rw] url_exclusion_patterns
    #   A list of regular expression patterns to exclude certain URLs to
    #   crawl. URLs that match the patterns are excluded from the index.
    #   URLs that don't match the patterns are included in the index. If a
    #   URL matches both an inclusion and exclusion pattern, the exclusion
    #   pattern takes precedence and the URL file isn't included in the
    #   index.
    #   @return [Array<String>]
    #
    # @!attribute [rw] proxy_configuration
    #   Configuration information required to connect to your internal
    #   websites via a web proxy.
    #
    #   You must provide the website host name and port number. For example,
    #   the host name of https://a.example.com/page1.html is
    #   "a.example.com" and the port is 443, the standard port for HTTPS.
    #
    #   Web proxy credentials are optional and you can use them to connect
    #   to a web proxy server that requires basic authentication. To store
    #   web proxy credentials, you use a secret in [Secrets Manager][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html
    #   @return [Types::ProxyConfiguration]
    #
    # @!attribute [rw] authentication_configuration
    #   Configuration information required to connect to websites using
    #   authentication.
    #
    #   You can connect to websites using basic authentication of user name
    #   and password. You use a secret in [Secrets Manager][1] to store your
    #   authentication credentials.
    #
    #   You must provide the website host name and port number. For example,
    #   the host name of https://a.example.com/page1.html is
    #   "a.example.com" and the port is 443, the standard port for HTTPS.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html
    #   @return [Types::AuthenticationConfiguration]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/WebCrawlerConfiguration AWS API Documentation
    #
    class WebCrawlerConfiguration < Struct.new(
      :urls,
      :crawl_depth,
      :max_links_per_page,
      :max_content_size_per_page_in_mega_bytes,
      :max_urls_per_minute_crawl_rate,
      :url_inclusion_patterns,
      :url_exclusion_patterns,
      :proxy_configuration,
      :authentication_configuration)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides the configuration information to connect to Amazon WorkDocs
    # as your data source.
    #
    # Amazon WorkDocs connector is available in Oregon, North Virginia,
    # Sydney, Singapore and Ireland regions.
    #
    # @!attribute [rw] organization_id
    #   The identifier of the directory corresponding to your Amazon
    #   WorkDocs site repository.
    #
    #   You can find the organization ID in the [Directory Service][1] by
    #   going to **Active Directory**, then **Directories**. Your Amazon
    #   WorkDocs site directory has an ID, which is the organization ID. You
    #   can also set up a new Amazon WorkDocs directory in the Directory
    #   Service console and enable a Amazon WorkDocs site for the directory
    #   in the Amazon WorkDocs console.
    #
    #
    #
    #   [1]: https://console.aws.amazon.com/directoryservicev2/
    #   @return [String]
    #
    # @!attribute [rw] crawl_comments
    #   `TRUE` to include comments on documents in your index. Including
    #   comments in your index means each comment is a document that can be
    #   searched on.
    #
    #   The default is set to `FALSE`.
    #   @return [Boolean]
    #
    # @!attribute [rw] use_change_log
    #   `TRUE` to use the Amazon WorkDocs change log to determine which
    #   documents require updating in the index. Depending on the change
    #   log's size, it may take longer for Amazon Kendra to use the change
    #   log than to scan all of your documents in Amazon WorkDocs.
    #   @return [Boolean]
    #
    # @!attribute [rw] inclusion_patterns
    #   A list of regular expression patterns to include certain files in
    #   your Amazon WorkDocs site repository. Files that match the patterns
    #   are included in the index. Files that don't match the patterns are
    #   excluded from the index. If a file matches both an inclusion and
    #   exclusion pattern, the exclusion pattern takes precedence and the
    #   file isn't included in the index.
    #   @return [Array<String>]
    #
    # @!attribute [rw] exclusion_patterns
    #   A list of regular expression patterns to exclude certain files in
    #   your Amazon WorkDocs site repository. Files that match the patterns
    #   are excluded from the index. Files that don’t match the patterns are
    #   included in the index. If a file matches both an inclusion and
    #   exclusion pattern, the exclusion pattern takes precedence and the
    #   file isn't included in the index.
    #   @return [Array<String>]
    #
    # @!attribute [rw] field_mappings
    #   A list of `DataSourceToIndexFieldMapping` objects that map Amazon
    #   WorkDocs data source attributes or field names to Amazon Kendra
    #   index field names. To create custom fields, use the `UpdateIndex`
    #   API before you map to Amazon WorkDocs fields. For more information,
    #   see [Mapping data source fields][1]. The Amazon WorkDocs data source
    #   field names must exist in your Amazon WorkDocs custom metadata.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
    #   @return [Array<Types::DataSourceToIndexFieldMapping>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/WorkDocsConfiguration AWS API Documentation
    #
    class WorkDocsConfiguration < Struct.new(
      :organization_id,
      :crawl_comments,
      :use_change_log,
      :inclusion_patterns,
      :exclusion_patterns,
      :field_mappings)
      SENSITIVE = []
      include Aws::Structure
    end

  end
end