NAME

Paws::Kendra::ConfluenceSpaceConfiguration

USAGE

This class represents one of two things:

Arguments in a call to a service

Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.

As an example, if Att1 is expected to be a Paws::Kendra::ConfluenceSpaceConfiguration object:

$service_obj->Method(Att1 => { CrawlArchivedSpaces => $value, ..., SpaceFieldMappings => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::Kendra::ConfluenceSpaceConfiguration object:

$result = $service_obj->Method(...);
$result->Att1->CrawlArchivedSpaces

DESCRIPTION

Specifies the configuration for indexing Confluence spaces.

ATTRIBUTES

CrawlArchivedSpaces => Bool

Specifies whether Amazon Kendra should index archived spaces.

CrawlPersonalSpaces => Bool

Specifies whether Amazon Kendra should index personal spaces. Users 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 (https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html).

ExcludeSpaces => ArrayRef[Str|Undef]

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 => ArrayRef[Str|Undef]

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 => ArrayRef[Paws::Kendra::ConfluenceSpaceToIndexFieldMapping]

Defines how space metadata fields should be mapped to index fields. Before you can map a field, you must first create an index field with a matching type using the console or the UpdateIndex operation.

If you specify the SpaceFieldMappings parameter, you must specify at least one field mapping.

SEE ALSO

This class forms part of Paws, describing an object used in Paws::Kendra

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues