Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

CreateDataAccessor - Amazon Q Business

CreateDataAccessor

Creates a new data accessor for an ISV to access data from a Amazon Q Business application. The data accessor is an entity that represents the ISV's access to the Amazon Q Business application's data. It includes the IAM role ARN for the ISV, a friendly name, and a set of action configurations that define the specific actions the ISV is allowed to perform and any associated data filters. When the data accessor is created, an IAM Identity Center application is also created to manage the ISV's identity and authentication for accessing the Amazon Q Business application.

Request Syntax

POST /applications/applicationId/dataaccessors HTTP/1.1 Content-type: application/json { "actionConfigurations": [ { "action": "string", "filterConfiguration": { "documentAttributeFilter": { "andAllFilters": [ "AttributeFilter" ], "containsAll": { "name": "string", "value": { ... } }, "containsAny": { "name": "string", "value": { ... } }, "equalsTo": { "name": "string", "value": { ... } }, "greaterThan": { "name": "string", "value": { ... } }, "greaterThanOrEquals": { "name": "string", "value": { ... } }, "lessThan": { "name": "string", "value": { ... } }, "lessThanOrEquals": { "name": "string", "value": { ... } }, "notFilter": "AttributeFilter", "orAllFilters": [ "AttributeFilter" ] } } } ], "clientToken": "string", "displayName": "string", "principal": "string", "tags": [ { "key": "string", "value": "string" } ] }

URI Request Parameters

The request uses the following URI parameters.

applicationId

The unique 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

Request Body

The request accepts the following data in JSON format.

actionConfigurations

A list of action configurations specifying the allowed actions and any associated filters.

Type: Array of ActionConfiguration objects

Array Members: Minimum number of 1 item. Maximum number of 10 items.

Required: Yes

clientToken

A unique, case-sensitive identifier you provide to ensure idempotency of the request.

Type: String

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

Required: No

displayName

A friendly name for the data accessor.

Type: String

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

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

Required: Yes

principal

The Amazon Resource Name (ARN) of the IAM role for the ISV that will be accessing the data.

Type: String

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

Pattern: arn:aws:iam::[0-9]{12}:role/[a-zA-Z0-9_/+=,.@-]+

Required: Yes

tags

The tags to associate with the data accessor.

Type: Array of Tag objects

Array Members: Minimum number of 0 items. Maximum number of 200 items.

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "dataAccessorArn": "string", "dataAccessorId": "string", "idcApplicationArn": "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.

dataAccessorArn

The Amazon Resource Name (ARN) of the created data accessor.

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}

dataAccessorId

The unique identifier of the created data accessor.

Type: String

Length Constraints: Fixed length of 36.

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

idcApplicationArn

The Amazon Resource Name (ARN) of the IAM Identity Center application created for this data accessor.

Type: String

Length Constraints: Minimum length of 10. Maximum length of 1224.

Pattern: arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}

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 inconsistencies 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 application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

HTTP Status Code: 404

ServiceQuotaExceededException

You have exceeded the set limits for your Amazon Q Business service.

HTTP Status Code: 402

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

See Also

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

PrivacySite termsCookie preferences
© 2025, Amazon Web Services, Inc. or its affiliates. All rights reserved.