DataZone / Paginator / ListAssetFilters

ListAssetFilters

class DataZone.Paginator.ListAssetFilters

paginator = client.get_paginator('list_asset_filters')

paginate(**kwargs)

Creates an iterator that will paginate through responses from DataZone.Client.list_asset_filters().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    assetIdentifier='string',
    domainIdentifier='string',
    status='VALID'|'INVALID',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• assetIdentifier (string) –

  [REQUIRED]

  The ID of the data asset.

• domainIdentifier (string) –

  [REQUIRED]

  The ID of the domain where you want to list asset filters.

• status (string) – The status of the asset filter.

• 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

{
    'items': [
        {
            'assetId': 'string',
            'createdAt': datetime(2015, 1, 1),
            'description': 'string',
            'domainId': 'string',
            'effectiveColumnNames': [
                'string',
            ],
            'effectiveRowFilter': 'string',
            'errorMessage': 'string',
            'id': 'string',
            'name': 'string',
            'status': 'VALID'|'INVALID'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • items (list) –

    The results of the ListAssetFilters action.

    • (dict) –

      The summary of the asset filter.

      • assetId (string) –

        The ID of the data asset.

      • createdAt (datetime) –

        The timestamp at which the asset filter was created.

      • description (string) –

        The description of the asset filter.

      • domainId (string) –

        The ID of the domain where the asset filter lives.

      • effectiveColumnNames (list) –

        The effective column names of the asset filter.

        • (string) –

      • effectiveRowFilter (string) –

        The effective row filter of the asset filter.

      • errorMessage (string) –

        The error message that is displayed if the action does not succeed.

      • id (string) –

        The ID of the asset filter.

      • name (string) –

        The name of the asset filter.

      • status (string) –

        The status of the asset filter.

  • NextToken (string) –

    A token to resume pagination.