QuickSight / Paginator / SearchDataSets

SearchDataSets#

class QuickSight.Paginator.SearchDataSets#

paginator = client.get_paginator('search_data_sets')

paginate(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    AwsAccountId='string',
    Filters=[
        {
            'Operator': 'StringEquals'|'StringLike',
            'Name': 'QUICKSIGHT_VIEWER_OR_OWNER'|'QUICKSIGHT_OWNER'|'DIRECT_QUICKSIGHT_VIEWER_OR_OWNER'|'DIRECT_QUICKSIGHT_OWNER'|'DIRECT_QUICKSIGHT_SOLE_OWNER'|'DATASET_NAME',
            'Value': 'string'
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

AwsAccountId (string) –
[REQUIRED]

The Amazon Web Services account ID.
Filters (list) –
[REQUIRED]

The filters to apply to the search.
- (dict) –
  
  A filter that you apply when searching for datasets.
  - Operator (string) – [REQUIRED]
    
    The comparison operator that you want to use as a filter, for example "Operator": "StringEquals" . Valid values are "StringEquals" and "StringLike" .
    
    If you set the operator value to "StringEquals" , you need to provide an ownership related filter in the "NAME" field and the arn of the user or group whose datasets you want to search in the "Value" field. For example, "Name":"QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east- 1:1:user/default/UserName1" .
    
    If you set the value to "StringLike" , you need to provide the name of the datasets you are searching for. For example, "Name":"DATASET_NAME", "Operator": "StringLike", "Value": "Test" . The "StringLike" operator only supports the NAME value DATASET_NAME .
  - Name (string) – [REQUIRED]
    
    The name of the value that you want to use as a filter, for example, "Name": "QUICKSIGHT_OWNER" .
    
    Valid values are defined as follows:
    - QUICKSIGHT_VIEWER_OR_OWNER : Provide an ARN of a user or group, and any datasets with that ARN listed as one of the dataset owners or viewers are returned. Implicit permissions from folders or groups are considered.
    - QUICKSIGHT_OWNER : Provide an ARN of a user or group, and any datasets with that ARN listed as one of the owners of the dataset are returned. Implicit permissions from folders or groups are considered.
    - DIRECT_QUICKSIGHT_SOLE_OWNER : Provide an ARN of a user or group, and any datasets with that ARN listed as the only owner of the dataset are returned. Implicit permissions from folders or groups are not considered.
    - DIRECT_QUICKSIGHT_OWNER : Provide an ARN of a user or group, and any datasets with that ARN listed as one of the owners if the dataset are returned. Implicit permissions from folders or groups are not considered.
    - DIRECT_QUICKSIGHT_VIEWER_OR_OWNER : Provide an ARN of a user or group, and any datasets with that ARN listed as one of the owners or viewers of the dataset are returned. Implicit permissions from folders or groups are not considered.
    - DATASET_NAME : Any datasets whose names have a substring match to this value will be returned.
  - Value (string) – [REQUIRED]
    
    The value of the named item, in this case QUICKSIGHT_OWNER , that you want to use as a filter, for example, "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1" .
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
        },
    ],
    'Status': 123,
    'RequestId': 'string'
}

Response Structure

(dict) –
- DataSetSummaries (list) –
  
  A DataSetSummaries object that returns a summary of a dataset.
  - (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.
- Status (integer) –
  
  The HTTP status of the request.
- RequestId (string) –
  
  The Amazon Web Services request ID for this operation.