QuickSight / Paginator / ListDataSets

ListDataSets

class QuickSight.Paginator.ListDataSets

paginator = client.get_paginator('list_data_sets')

paginate(**kwargs)

Creates an iterator that will paginate through responses from QuickSight.Client.list_data_sets().

See also: AWS API Documentation

Request Syntax

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

Parameters:

• AwsAccountId (string) –

  [REQUIRED]

  The Amazon Web Services account ID.

• 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

{
    'DataSetSummaries': [
        {
            'Arn': 'string',
            'DataSetId': 'string',
            'Name': 'string',
            'CreatedTime': datetime(2015, 1, 1),
            'LastUpdatedTime': datetime(2015, 1, 1),
            'ImportMode': 'SPICE'|'DIRECT_QUERY',
            'RowLevelPermissionDataSet': {
                'Namespace': 'string',
                'Arn': 'string',
                'PermissionPolicy': 'GRANT_ACCESS'|'DENY_ACCESS',
                'FormatVersion': 'VERSION_1'|'VERSION_2',
                'Status': 'ENABLED'|'DISABLED'
            },
            'RowLevelPermissionTagConfigurationApplied': True|False,
            'ColumnLevelPermissionRulesApplied': True|False
        },
    ],
    'RequestId': 'string',
    'Status': 123
}

Response Structure

• (dict) –

  • DataSetSummaries (list) –

    The list of dataset summaries.

    • (dict) –

      Dataset summary.

      • Arn (string) –

        The Amazon Resource Name (ARN) of the dataset.

      • DataSetId (string) –

        The ID of the dataset.

      • Name (string) –

        A display name for the dataset.

      • CreatedTime (datetime) –

        The time that this dataset was created.

      • LastUpdatedTime (datetime) –

        The last time that this dataset was updated.

      • ImportMode (string) –

        A value that indicates whether you want to import the data into SPICE.

      • RowLevelPermissionDataSet (dict) –

        The row-level security configuration for the dataset.

        • Namespace (string) –

          The namespace associated with the dataset that contains permissions for RLS.

        • Arn (string) –

          The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.

        • PermissionPolicy (string) –

          The type of permissions to use when interpreting the permissions for RLS. DENY_ACCESS is included for backward compatibility only.

        • FormatVersion (string) –

          The user or group rules associated with the dataset that contains permissions for RLS.

          By default, FormatVersion is VERSION_1 . When FormatVersion is VERSION_1 , UserName and GroupName are required. When FormatVersion is VERSION_2 , UserARN and GroupARN are required, and Namespace must not exist.

        • Status (string) –

          The status of the row-level security permission dataset. If enabled, the status is ENABLED . If disabled, the status is DISABLED .

      • RowLevelPermissionTagConfigurationApplied (boolean) –

        Whether or not the row level permission tags are applied.

      • ColumnLevelPermissionRulesApplied (boolean) –

        A value that indicates if the dataset has column level permission configured.

  • RequestId (string) –

    The Amazon Web Services request ID for this operation.

  • Status (integer) –

    The HTTP status of the request.