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.”

GetDataAccessor - Amazon Q Business

GetDataAccessor

Retrieves information about a specified data accessor. This operation returns details about the data accessor, including its display name, unique identifier, Amazon Resource Name (ARN), the associated Amazon Q Business application and IAM Identity Center application, the IAM role for the ISV, the action configurations, and the timestamps for when the data accessor was created and last updated.

Request Syntax

GET /applications/applicationId/dataaccessors/dataAccessorId HTTP/1.1

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

dataAccessorId

The unique identifier of the data accessor to retrieve.

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 { "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" ] } } } ], "applicationId": "string", "createdAt": number, "dataAccessorArn": "string", "dataAccessorId": "string", "displayName": "string", "idcApplicationArn": "string", "principal": "string", "updatedAt": number }

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.

actionConfigurations

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

applicationId

The unique identifier of the Amazon Q Business application associated with this data accessor.

Type: String

Length Constraints: Fixed length of 36.

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

createdAt

The timestamp when the data accessor was created.

Type: Timestamp

dataAccessorArn

The Amazon Resource Name (ARN) of the 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 data accessor.

Type: String

Length Constraints: Fixed length of 36.

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

displayName

The friendly name of the data accessor.

Type: String

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

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

idcApplicationArn

The Amazon Resource Name (ARN) of the IAM Identity Center application associated with 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}

principal

The Amazon Resource Name (ARN) of the IAM role for the ISV associated with this data accessor.

Type: String

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

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

updatedAt

The timestamp when the data accessor was last updated.

Type: Timestamp

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

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.