QBusiness / Client / list_data_accessors

list_data_accessors#

QBusiness.Client.list_data_accessors(**kwargs)#

Lists the data accessors for a 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.

See also: AWS API Documentation

Request Syntax

response = client.list_data_accessors(
    applicationId='string',
    nextToken='string',
    maxResults=123
)
Parameters:

  • applicationId (string) –

    [REQUIRED]

    The unique identifier of the Q Business application.

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

  • maxResults (integer) – The maximum number of results to return in a single call.

Return type:

dict

Returns:

Response Syntax

{
    'dataAccessors': [
        {
            'displayName': 'string',
            'dataAccessorId': 'string',
            'dataAccessorArn': 'string',
            'idcApplicationArn': 'string',
            'principal': 'string',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • dataAccessors (list) –

      The list of data accessors.

      • (dict) –

        Provides summary information about a data accessor.

        • displayName (string) –

          The friendly name of the data accessor.

        • dataAccessorId (string) –

          The unique identifier of the data accessor.

        • dataAccessorArn (string) –

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

        • idcApplicationArn (string) –

          The Amazon Resource Name (ARN) of the associated AWS IAM Identity Center application.

        • principal (string) –

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

        • createdAt (datetime) –

          The timestamp when the data accessor was created.

        • updatedAt (datetime) –

          The timestamp when the data accessor was last updated.

    • nextToken (string) –

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

Exceptions

  • QBusiness.Client.exceptions.ResourceNotFoundException

  • QBusiness.Client.exceptions.InternalServerException

  • QBusiness.Client.exceptions.ThrottlingException

  • QBusiness.Client.exceptions.ValidationException

  • QBusiness.Client.exceptions.AccessDeniedException