The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.

NAME

Paws::Kendra::SalesforceConfiguration

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::SalesforceConfiguration object:

$service_obj->Method(Att1 => { ChatterFeedConfiguration => $value, ..., StandardObjectConfigurations => $value  });

Results returned from an API call

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

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

DESCRIPTION

Provides configuration information for connecting to a Salesforce data source.

ATTRIBUTES

ChatterFeedConfiguration => Paws::Kendra::SalesforceChatterFeedConfiguration

Specifies configuration information for Salesforce chatter feeds.

CrawlAttachments => Bool

Indicates whether Amazon Kendra should index attachments to Salesforce objects.

ExcludeAttachmentFilePatterns => ArrayRef[Str|Undef]

A list of regular expression patterns. 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 exclusion pattern and an inclusion pattern, the document is not included in the index.

The regex is applied to the name of the attached file.

IncludeAttachmentFilePatterns => ArrayRef[Str|Undef]

A list of regular expression patterns. 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 pattern and an exclusion pattern, the document is not included in the index.

The regex is applied to the name of the attached file.

KnowledgeArticleConfiguration => Paws::Kendra::SalesforceKnowledgeArticleConfiguration

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

REQUIRED SecretArn => Str

The Amazon Resource Name (ARN) of an AWS Secrets Manager secret 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 account logging in to the Salesforce instance.

  • username - The user name of the user logging in to the Salesforce instance.

REQUIRED ServerUrl => Str

The instance URL for the Salesforce site that you want to index.

StandardObjectAttachmentConfiguration => Paws::Kendra::SalesforceStandardObjectAttachmentConfiguration

Provides configuration information for processing attachments to Salesforce standard objects.

StandardObjectConfigurations => ArrayRef[Paws::Kendra::SalesforceStandardObjectConfiguration]

Specifies the Salesforce standard objects that Amazon Kendra indexes.

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