Skip to content

SalesforceStandardObjectConfiguration

Source code in docs_src/capo_kendra/types/salesforce_standard_object_configuration.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
class SalesforceStandardObjectConfiguration(TypedDict, closed=True):
    name: (
        "capo_kendra.types.salesforce_standard_object_name.SalesforceStandardObjectName"
    )
    """<p>The name of the standard object.</p>"""
    document_data_field_name: (
        "capo_kendra.types.data_source_field_name.DataSourceFieldName"
    )
    """<p>The name of the field in the standard object table that contains the document contents.</p>"""
    document_title_field_name: NotRequired[
        "capo_kendra.types.data_source_field_name.DataSourceFieldName"
    ]
    """<p>The name of the field in the standard object table that contains the document title.</p>"""
    field_mappings: NotRequired[
        "capo_kendra.types.data_source_to_index_field_mapping_list.DataSourceToIndexFieldMappingList"
    ]
    """<p>Maps attributes or field names of the standard object to Amazon Kendra index field names. To create custom fields, use the <code>UpdateIndex</code> API before you map to Salesforce fields. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping data source fields</a>. The Salesforce data source field names must exist in your Salesforce custom metadata.</p>"""

document_data_field_name instance-attribute 

document_data_field_name: DataSourceFieldName

The name of the field in the standard object table that contains the document contents.

document_title_field_name instance-attribute 

document_title_field_name: NotRequired[DataSourceFieldName]

The name of the field in the standard object table that contains the document title.

field_mappings instance-attribute 

field_mappings: NotRequired[DataSourceToIndexFieldMappingList]

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. The Salesforce data source field names must exist in your Salesforce custom metadata.

name instance-attribute 

name: SalesforceStandardObjectName

The name of the standard object.