QuickSight / Paginator / SearchDataSources

SearchDataSources

class QuickSight.Paginator.SearchDataSources

paginator = client.get_paginator('search_data_sources')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    AwsAccountId='string',
    Filters=[
        {
            'Operator': 'StringEquals'|'StringLike',
            'Name': 'DIRECT_QUICKSIGHT_VIEWER_OR_OWNER'|'DIRECT_QUICKSIGHT_OWNER'|'DIRECT_QUICKSIGHT_SOLE_OWNER'|'DATASOURCE_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 data sources.

    • 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 data sources you want to search in the "Value" field. For example, "Name":"DIRECT_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 data sources you are searching for. For example, "Name":"DATASOURCE_NAME", "Operator": "StringLike", "Value": "Test". The "StringLike" operator only supports the NAME value DATASOURCE_NAME.

    • Name (string) – [REQUIRED]

      The name of the value that you want to use as a filter, for example, "Name": "DIRECT_QUICKSIGHT_OWNER".

      Valid values are defined as follows:

      • DIRECT_QUICKSIGHT_VIEWER_OR_OWNER: Provide an ARN of a user or group, and any data sources with that ARN listed as one of the owners or viewers of the data sources are returned. Implicit permissions from folders or groups are not considered.

      • DIRECT_QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any data sources with that ARN listed as one of the owners if the data source are returned. Implicit permissions from folders or groups are not considered.

      • DIRECT_QUICKSIGHT_SOLE_OWNER: Provide an ARN of a user or group, and any data sources with that ARN listed as the only owner of the data source are returned. Implicit permissions from folders or groups are not considered.

      • DATASOURCE_NAME: Any data sources whose names have a substring match to the provided value are returned.

    • Value (string) – [REQUIRED]

      The value of the named item, for example DIRECT_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

{
    'DataSourceSummaries': [
        {
            'Arn': 'string',
            'DataSourceId': 'string',
            'Name': 'string',
            'Type': 'ADOBE_ANALYTICS'|'AMAZON_ELASTICSEARCH'|'ATHENA'|'AURORA'|'AURORA_POSTGRESQL'|'AWS_IOT_ANALYTICS'|'GITHUB'|'JIRA'|'MARIADB'|'MYSQL'|'ORACLE'|'POSTGRESQL'|'PRESTO'|'REDSHIFT'|'S3'|'SALESFORCE'|'SERVICENOW'|'SNOWFLAKE'|'SPARK'|'SQLSERVER'|'TERADATA'|'TWITTER'|'TIMESTREAM'|'AMAZON_OPENSEARCH'|'EXASOL'|'DATABRICKS'|'STARBURST'|'TRINO'|'BIGQUERY',
            'CreatedTime': datetime(2015, 1, 1),
            'LastUpdatedTime': datetime(2015, 1, 1)
        },
    ],
    'Status': 123,
    'RequestId': 'string'
}

Response Structure

• (dict) –

  • DataSourceSummaries (list) –

    A DataSourceSummaries object that returns a summary of a data source.

    • (dict) –

      A DataSourceSummary object that returns a summary of a data source.

      • Arn (string) –

        The arn of the datasource.

      • DataSourceId (string) –

        The unique ID of the data source.

      • Name (string) –

        The name of the data source.

      • Type (string) –

        The type of the data source.

      • CreatedTime (datetime) –

        The date and time that the data source was created. This value is expressed in MM-DD-YYYY HH:MM:SS format.

      • LastUpdatedTime (datetime) –

        The date and time the data source was last updated. This value is expressed in MM-DD-YYYY HH:MM:SS format.

  • Status (integer) –

    The HTTP status of the request.

  • RequestId (string) –

    The Amazon Web Services request ID for this operation.