QBusiness / Paginator / ListDataAccessors

ListDataAccessors

class QBusiness.Paginator.ListDataAccessors

paginator = client.get_paginator('list_data_accessors')

paginate(**kwargs)

Creates an iterator that will paginate through responses from QBusiness.Client.list_data_accessors().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    applicationId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• applicationId (string) –

  [REQUIRED]

  The unique identifier of the Q Business application.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

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

    A token to resume pagination.