RetrievalResultLocation

Contains information about the data source location.

This data type is used in the following API operations:

• Retrieve response – in the location field

• RetrieveAndGenerate response – in the location field

• InvokeAgent response – in the location field

Contents

type

The type of data source location.

Type: String

Valid Values: S3 | WEB | CONFLUENCE | SALESFORCE | SHAREPOINT | CUSTOM | KENDRA | SQL

Required: Yes

confluenceLocation

The Confluence data source location.

Type: RetrievalResultConfluenceLocation object

Required: No

customDocumentLocation

Specifies the location of a document in a custom data source.

Type: RetrievalResultCustomDocumentLocation object

Required: No

kendraDocumentLocation

The location of a document in Amazon Kendra.

Type: RetrievalResultKendraDocumentLocation object

Required: No

s3Location

The S3 data source location.

Type: RetrievalResultS3Location object

Required: No

salesforceLocation

The Salesforce data source location.

Type: RetrievalResultSalesforceLocation object

Required: No

sharePointLocation

The SharePoint data source location.

Type: RetrievalResultSharePointLocation object

Required: No

sqlLocation

Specifies information about the SQL query used to retrieve the result.

Type: RetrievalResultSqlLocation object

Required: No

webLocation

The web URL/URLs data source location.

Type: RetrievalResultWebLocation object

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Java V2

• AWS SDK for Ruby V3