QuickSight / Client / list_data_sets

list_data_sets

QuickSight.Client.list_data_sets(**kwargs)

Lists all of the datasets belonging to the current Amazon Web Services account in an Amazon Web Services Region.

The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/*.

See also: AWS API Documentation

Request Syntax

response = client.list_data_sets(
    AwsAccountId='string',
    NextToken='string',
    MaxResults=123
)

Parameters:

• AwsAccountId (string) –

  [REQUIRED]

  The Amazon Web Services account ID.

• NextToken (string) – The token for the next set of results, or null if there are no more results.

• MaxResults (integer) – The maximum number of results to be returned per request.

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,
            'UseAs': 'RLS_RULES'
        },
    ],
    'NextToken': 'string',
    '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.

      • UseAs (string) –

        The usage of the dataset.

  • NextToken (string) –

    The token for the next set of results, or null if there are no more results.

  • RequestId (string) –

    The Amazon Web Services request ID for this operation.

  • Status (integer) –

    The HTTP status of the request.

Exceptions

• QuickSight.Client.exceptions.AccessDeniedException

• QuickSight.Client.exceptions.InvalidParameterValueException

• QuickSight.Client.exceptions.ThrottlingException

• QuickSight.Client.exceptions.InvalidNextTokenException

• QuickSight.Client.exceptions.InternalFailureException