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

UpdateDataSource

Updates an existing Amazon Q Business data source connector.

Request Syntax


PUT /applications/applicationId/indices/indexId/datasources/dataSourceId HTTP/1.1
Content-type: application/json

{
   "configuration": JSON value,
   "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"
      }
   },
   "roleArn": "string",
   "syncSchedule": "string",
   "vpcConfiguration": { 
      "securityGroupIds": [ "string" ],
      "subnetIds": [ "string" ]
   }
}

URI Request Parameters

The request uses the following URI parameters.

applicationId

The identifier of the Amazon Q Business application the data source is attached to.

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 identifier of the index attached to 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 accepts the following data in JSON format.

configuration

Provides the configuration information for an Amazon Q Business data source.

Type: JSON value

Required: No

description

The description of the data source connector.

Type: String

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

Pattern: \P{C}*

Required: No

displayName

A name of 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_-]*

Required: No

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

Required: No

roleArn

The Amazon Resource Name (ARN) of an IAM 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}

Required: No

syncSchedule

The chosen update frequency for your data source.

Type: String

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

Pattern: \P{C}*

Required: No

vpcConfiguration

Provides configuration information needed to connect to an Amazon VPC (Virtual Private Cloud).

Type: DataSourceVpcConfiguration object

Required: No

Response Syntax


HTTP/1.1 200

Response Elements

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

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

ConflictException

You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.

HTTP Status Code: 409

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