Amazonka.Kendra.Types.ConfluenceSpaceConfiguration

Documentation

data ConfluenceSpaceConfiguration

Configuration information for indexing Confluence spaces.

See: newConfluenceSpaceConfiguration smart constructor.

Constructors

ConfluenceSpaceConfiguration'

Fields

• crawlArchivedSpaces :: Maybe Bool

  TRUE to index archived spaces.

• crawlPersonalSpaces :: Maybe Bool

  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.

• excludeSpaces :: Maybe (NonEmpty Text)

  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.

• includeSpaces :: Maybe (NonEmpty Text)

  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.

• spaceFieldMappings :: Maybe (NonEmpty ConfluenceSpaceToIndexFieldMapping)

  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. 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.

Instances

FromJSON ConfluenceSpaceConfiguration

Defined in Amazonka.Kendra.Types.ConfluenceSpaceConfiguration

Methods

parseJSON :: Value -> Parser ConfluenceSpaceConfiguration

parseJSONList :: Value -> Parser [ConfluenceSpaceConfiguration]

ToJSON ConfluenceSpaceConfiguration

Defined in Amazonka.Kendra.Types.ConfluenceSpaceConfiguration

Methods

toJSON :: ConfluenceSpaceConfiguration -> Value

toEncoding :: ConfluenceSpaceConfiguration -> Encoding

toJSONList :: [ConfluenceSpaceConfiguration] -> Value

toEncodingList :: [ConfluenceSpaceConfiguration] -> Encoding

Generic ConfluenceSpaceConfiguration

Defined in Amazonka.Kendra.Types.ConfluenceSpaceConfiguration

Associated Types

type Rep ConfluenceSpaceConfiguration :: Type -> Type

Methods

from :: ConfluenceSpaceConfiguration -> Rep ConfluenceSpaceConfiguration x

to :: Rep ConfluenceSpaceConfiguration x -> ConfluenceSpaceConfiguration

Read ConfluenceSpaceConfiguration

Defined in Amazonka.Kendra.Types.ConfluenceSpaceConfiguration

Methods

readsPrec :: Int -> ReadS ConfluenceSpaceConfiguration

readList :: ReadS [ConfluenceSpaceConfiguration]

readPrec :: ReadPrec ConfluenceSpaceConfiguration

readListPrec :: ReadPrec [ConfluenceSpaceConfiguration]

Show ConfluenceSpaceConfiguration

Defined in Amazonka.Kendra.Types.ConfluenceSpaceConfiguration

Methods

showsPrec :: Int -> ConfluenceSpaceConfiguration -> ShowS

show :: ConfluenceSpaceConfiguration -> String

showList :: [ConfluenceSpaceConfiguration] -> ShowS

NFData ConfluenceSpaceConfiguration

Defined in Amazonka.Kendra.Types.ConfluenceSpaceConfiguration

Methods

rnf :: ConfluenceSpaceConfiguration -> ()

Eq ConfluenceSpaceConfiguration

Defined in Amazonka.Kendra.Types.ConfluenceSpaceConfiguration

Methods

(==) :: ConfluenceSpaceConfiguration -> ConfluenceSpaceConfiguration -> Bool

(/=) :: ConfluenceSpaceConfiguration -> ConfluenceSpaceConfiguration -> Bool

Hashable ConfluenceSpaceConfiguration

Defined in Amazonka.Kendra.Types.ConfluenceSpaceConfiguration

Methods

hashWithSalt :: Int -> ConfluenceSpaceConfiguration -> Int

hash :: ConfluenceSpaceConfiguration -> Int

type Rep ConfluenceSpaceConfiguration

Defined in Amazonka.Kendra.Types.ConfluenceSpaceConfiguration

type Rep ConfluenceSpaceConfiguration = D1 ('MetaData "ConfluenceSpaceConfiguration" "Amazonka.Kendra.Types.ConfluenceSpaceConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ConfluenceSpaceConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "crawlArchivedSpaces") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "crawlPersonalSpaces") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "excludeSpaces") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :*: (S1 ('MetaSel ('Just "includeSpaces") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :*: S1 ('MetaSel ('Just "spaceFieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty ConfluenceSpaceToIndexFieldMapping)))))))

newConfluenceSpaceConfiguration :: ConfluenceSpaceConfiguration

Create a value of ConfluenceSpaceConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:crawlArchivedSpaces:ConfluenceSpaceConfiguration', confluenceSpaceConfiguration_crawlArchivedSpaces - TRUE to index archived spaces.

$sel:crawlPersonalSpaces:ConfluenceSpaceConfiguration', confluenceSpaceConfiguration_crawlPersonalSpaces - 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.

$sel:excludeSpaces:ConfluenceSpaceConfiguration', confluenceSpaceConfiguration_excludeSpaces - 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.

$sel:includeSpaces:ConfluenceSpaceConfiguration', confluenceSpaceConfiguration_includeSpaces - 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.

$sel:spaceFieldMappings:ConfluenceSpaceConfiguration', confluenceSpaceConfiguration_spaceFieldMappings - 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. 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.

confluenceSpaceConfiguration_crawlArchivedSpaces :: Lens' ConfluenceSpaceConfiguration (Maybe Bool)

TRUE to index archived spaces.

confluenceSpaceConfiguration_crawlPersonalSpaces :: Lens' ConfluenceSpaceConfiguration (Maybe Bool)

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.

confluenceSpaceConfiguration_excludeSpaces :: Lens' ConfluenceSpaceConfiguration (Maybe (NonEmpty Text))

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.

confluenceSpaceConfiguration_includeSpaces :: Lens' ConfluenceSpaceConfiguration (Maybe (NonEmpty Text))

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.

confluenceSpaceConfiguration_spaceFieldMappings :: Lens' ConfluenceSpaceConfiguration (Maybe (NonEmpty ConfluenceSpaceToIndexFieldMapping))

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. 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.