Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetDataSource

Gets information about an existing Amazon Q Business data source connector.

Request Syntax


GET /applications/applicationId/indices/indexId/datasources/dataSourceId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

applicationId

The identifier of the Amazon Q Business application.

Length Constraints: Fixed length of 36.

Pattern: [a-zA-Z0-9][a-zA-Z0-9-]{35}

Required: Yes

dataSourceId

The identifier of the data source connector.

Length Constraints: Fixed length of 36.

Pattern: [a-zA-Z0-9][a-zA-Z0-9-]{35}

Required: Yes

indexId

The identfier of the index used with the data source connector.

Length Constraints: Fixed length of 36.

Pattern: [a-zA-Z0-9][a-zA-Z0-9-]{35}

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "applicationId": "string",
   "configuration": JSON value,
   "createdAt": number,
   "dataSourceArn": "string",
   "dataSourceId": "string",
   "description": "string",
   "displayName": "string",
   "documentEnrichmentConfiguration": { 
      "inlineConfigurations": [ 
         { 
            "condition": { 
               "key": "string",
               "operator": "string",
               "value": { ... }
            },
            "documentContentOperator": "string",
            "target": { 
               "attributeValueOperator": "string",
               "key": "string",
               "value": { ... }
            }
         }
      ],
      "postExtractionHookConfiguration": { 
         "invocationCondition": { 
            "key": "string",
            "operator": "string",
            "value": { ... }
         },
         "lambdaArn": "string",
         "roleArn": "string",
         "s3BucketName": "string"
      },
      "preExtractionHookConfiguration": { 
         "invocationCondition": { 
            "key": "string",
            "operator": "string",
            "value": { ... }
         },
         "lambdaArn": "string",
         "roleArn": "string",
         "s3BucketName": "string"
      }
   },
   "error": { 
      "errorCode": "string",
      "errorMessage": "string"
   },
   "indexId": "string",
   "roleArn": "string",
   "status": "string",
   "syncSchedule": "string",
   "type": "string",
   "updatedAt": number,
   "vpcConfiguration": { 
      "securityGroupIds": [ "string" ],
      "subnetIds": [ "string" ]
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

applicationId

The identifier of the Amazon Q Business application.

Type: String

Length Constraints: Fixed length of 36.

Pattern: [a-zA-Z0-9][a-zA-Z0-9-]{35}

configuration

The details of how the data source connector is configured.

Type: JSON value

createdAt

The Unix timestamp when the data source connector was created.

Type: Timestamp

dataSourceArn

The Amazon Resource Name (ARN) of the data source.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1284.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

dataSourceId

The identifier of the data source connector.

Type: String

Length Constraints: Fixed length of 36.

Pattern: [a-zA-Z0-9][a-zA-Z0-9-]{35}

description

The description for the data source connector.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1000.

Pattern: \P{C}*

displayName

The name for the data source connector.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1000.

Pattern: [a-zA-Z0-9][a-zA-Z0-9_-]*

documentEnrichmentConfiguration

Provides the configuration information for altering document metadata and content during the document ingestion process.

For more information, see Custom document enrichment.

Type: DocumentEnrichmentConfiguration object

error

When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source connector to fail.

Type: ErrorDetail object

indexId

The identifier of the index linked to the data source connector.

Type: String

Length Constraints: Fixed length of 36.

Pattern: [a-zA-Z0-9][a-zA-Z0-9-]{35}

roleArn

The Amazon Resource Name (ARN) of the role with permission to access the data source and required resources.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1284.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

status

The current status of the data source connector. When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source connector to fail.

Type: String

syncSchedule

The schedule for Amazon Q Business to update the index.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 998.

Pattern: \P{C}*

type

The type of the data source connector. For example, S3.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

updatedAt

The Unix timestamp when the data source connector was last updated.

Type: Timestamp

vpcConfiguration

Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source.

Type: DataSourceVpcConfiguration object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

HTTP Status Code: 403

InternalServerException

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.

HTTP Status Code: 500

ResourceNotFoundException

The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

HTTP Status Code: 404

ThrottlingException

The request was denied due to throttling. Reduce the number of requests and try again.

HTTP Status Code: 429

ValidationException

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

HTTP Status Code: 400