DataZone / Client / list_asset_filters

list_asset_filters

DataZone.Client.list_asset_filters(**kwargs)

Lists asset filters.

See also: AWS API Documentation

Request Syntax

response = client.list_asset_filters(
    assetIdentifier='string',
    domainIdentifier='string',
    maxResults=123,
    nextToken='string',
    status='VALID'|'INVALID'
)

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.

• maxResults (integer) – The maximum number of asset filters to return in a single call to ListAssetFilters. When the number of asset filters to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListAssetFilters to list the next set of asset filters.

• nextToken (string) – When the number of asset filters is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of asset filters, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListAssetFilters to list the next set of asset filters.

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

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) –

    When the number of asset filters is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of asset filters, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListAssetFilters to list the next set of asset filters.

Exceptions

• DataZone.Client.exceptions.InternalServerException

• DataZone.Client.exceptions.ResourceNotFoundException

• DataZone.Client.exceptions.AccessDeniedException

• DataZone.Client.exceptions.ThrottlingException

• DataZone.Client.exceptions.ValidationException

• DataZone.Client.exceptions.UnauthorizedException