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

ListDataAccessors

Note

Amazon Q Business will no longer be open to new customers starting on July 31, 2026. If you would like to use the service, please sign up prior to July 30. For capabilities similar to Q Business, explore Amazon Quick. Learn more.

Lists the data accessors for a Amazon Q Business application. This operation returns a paginated list of data accessor summaries, including the friendly name, unique identifier, ARN, associated IAM role, and creation/update timestamps for each data accessor.

Request Syntax


GET /applications/applicationId/dataaccessors?maxResults=maxResults&nextToken=nextToken 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

maxResults

The maximum number of results to return in a single call.

Valid Range: Minimum value of 1. Maximum value of 10.

nextToken

The token for the next set of results. (You received this token from a previous call.)

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

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "dataAccessors": [ 
      { 
         "authenticationDetail": { 
            "authenticationConfiguration": { ... },
            "authenticationType": "string",
            "externalIds": [ "string" ]
         },
         "createdAt": number,
         "dataAccessorArn": "string",
         "dataAccessorId": "string",
         "displayName": "string",
         "idcApplicationArn": "string",
         "principal": "string",
         "updatedAt": number
      }
   ],
   "nextToken": "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.

dataAccessors

The list of data accessors.

Type: Array of DataAccessor objects

nextToken

The token to use to retrieve the next set of results, if there are any.

Type: String

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

Errors

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

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.

message: The message describing a ResourceNotFoundException.
resourceId: The identifier of the resource affected.
resourceType: The type of the resource affected.

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.

fields: The input field(s) that failed validation.
message: The message describing the ValidationException.
reason: The reason for the ValidationException.

HTTP Status Code: 400