DataZone / Client / get_asset_filter

get_asset_filter

DataZone.Client.get_asset_filter(**kwargs)

Gets an asset filter.

See also: AWS API Documentation

Request Syntax

response = client.get_asset_filter(
    assetIdentifier='string',
    domainIdentifier='string',
    identifier='string'
)

Parameters:

• assetIdentifier (string) –

  [REQUIRED]

  The ID of the data asset.

• domainIdentifier (string) –

  [REQUIRED]

  The ID of the domain where you want to get an asset filter.

• identifier (string) –

  [REQUIRED]

  The ID of the asset filter.

Return type:

dict

Returns:

Response Syntax

{
    'assetId': 'string',
    'configuration': {
        'columnConfiguration': {
            'includedColumnNames': [
                'string',
            ]
        },
        'rowConfiguration': {
            'rowFilter': {
                'and': [
                    {'... recursive ...'},
                ],
                'expression': {
                    'equalTo': {
                        'columnName': 'string',
                        'value': 'string'
                    },
                    'greaterThan': {
                        'columnName': 'string',
                        'value': 'string'
                    },
                    'greaterThanOrEqualTo': {
                        'columnName': 'string',
                        'value': 'string'
                    },
                    'in': {
                        'columnName': 'string',
                        'values': [
                            'string',
                        ]
                    },
                    'isNotNull': {
                        'columnName': 'string'
                    },
                    'isNull': {
                        'columnName': 'string'
                    },
                    'lessThan': {
                        'columnName': 'string',
                        'value': 'string'
                    },
                    'lessThanOrEqualTo': {
                        'columnName': 'string',
                        'value': 'string'
                    },
                    'like': {
                        'columnName': 'string',
                        'value': 'string'
                    },
                    'notEqualTo': {
                        'columnName': 'string',
                        'value': 'string'
                    },
                    'notIn': {
                        'columnName': 'string',
                        'values': [
                            'string',
                        ]
                    },
                    'notLike': {
                        'columnName': 'string',
                        'value': 'string'
                    }
                },
                'or': [
                    {'... recursive ...'},
                ]
            },
            'sensitive': True|False
        }
    },
    'createdAt': datetime(2015, 1, 1),
    'description': 'string',
    'domainId': 'string',
    'effectiveColumnNames': [
        'string',
    ],
    'effectiveRowFilter': 'string',
    'errorMessage': 'string',
    'id': 'string',
    'name': 'string',
    'status': 'VALID'|'INVALID'
}

Response Structure

• (dict) –

  • assetId (string) –

    The ID of the data asset.

  • configuration (dict) –

    The configuration of the asset filter.

    Note

    This is a Tagged Union structure. Only one of the following top level keys will be set: columnConfiguration, rowConfiguration. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

    'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
    

    • columnConfiguration (dict) –

      The column configuration of the asset filter.

      • includedColumnNames (list) –

        Specifies whether to include column names.

        • (string) –

    • rowConfiguration (dict) –

      The row configuration of the asset filter.

      • rowFilter (dict) –

        The row filter.

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: and, expression, or. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        

        • and (list) –

          The ‘and’ clause of the row filter.

          • (dict) –

            The row filter.

            Note

            This is a Tagged Union structure. Only one of the following top level keys will be set: and, expression, or. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

            'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
            

        • expression (dict) –

          The expression of the row filter.

          Note

          This is a Tagged Union structure. Only one of the following top level keys will be set: equalTo, greaterThan, greaterThanOrEqualTo, in, isNotNull, isNull, lessThan, lessThanOrEqualTo, like, notEqualTo, notIn, notLike. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

          'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
          

          • equalTo (dict) –

            The ‘equal to’ clause of the row filter expression.

            • columnName (string) –

              The name of the column.

            • value (string) –

              The value that might be equal to an expression.

          • greaterThan (dict) –

            The ‘greater than’ clause of the row filter expression.

            • columnName (string) –

              The name of the column.

            • value (string) –

              The value that might be greater than an expression.

          • greaterThanOrEqualTo (dict) –

            The ‘greater than or equal to’ clause of the filter expression.

            • columnName (string) –

              The name of the column.

            • value (string) –

              The value that might be greater than or equal to an expression.

          • in (dict) –

            The ‘in’ clause of the row filter expression.

            • columnName (string) –

              The name of the column.

            • values (list) –

              The values that might be in the expression.

              • (string) –

          • isNotNull (dict) –

            The ‘is not null’ clause of the row filter expression.

            • columnName (string) –

              The name of the column.

          • isNull (dict) –

            The ‘is null’ clause of the row filter expression.

            • columnName (string) –

              The name of the column.

          • lessThan (dict) –

            The ‘less than’ clause of the row filter expression.

            • columnName (string) –

              The name of the column.

            • value (string) –

              The value that might be less than the expression.

          • lessThanOrEqualTo (dict) –

            The ‘less than or equal to’ clause of the row filter expression.

            • columnName (string) –

              The name of the column.

            • value (string) –

              The value that might be less than or equal to an expression.

          • like (dict) –

            The ‘like’ clause of the row filter expression.

            • columnName (string) –

              The name of the column.

            • value (string) –

              The value that might be like the expression.

          • notEqualTo (dict) –

            The ‘no equal to’ clause of the row filter expression.

            • columnName (string) –

              The name of the column.

            • value (string) –

              The value that might not be equal to the expression.

          • notIn (dict) –

            The ‘not in’ clause of the row filter expression.

            • columnName (string) –

              The name of the column.

            • values (list) –

              The value that might not be in the expression.

              • (string) –

          • notLike (dict) –

            The ‘not like’ clause of the row filter expression.

            • columnName (string) –

              The name of the column.

            • value (string) –

              The value that might not be like the expression.

        • or (list) –

          The ‘or’ clause of the row filter.

          • (dict) –

            The row filter.

            Note

            This is a Tagged Union structure. Only one of the following top level keys will be set: and, expression, or. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

            'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
            

      • sensitive (boolean) –

        Specifies whether the row filter is sensitive.

  • 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 you want to get an asset filter.

  • effectiveColumnNames (list) –

    The column names of the asset filter.

    • (string) –

  • effectiveRowFilter (string) –

    The row filter of the asset filter.

  • errorMessage (string) –

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

  • id (string) –

    The ID of the asset filter.

  • name (string) –

    The name of the asset filter.

  • status (string) –

    The status of the asset filter.

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