:doc:`DataZone <../../datazone>` / Client / get_asset_filter

****************
get_asset_filter
****************



.. py:method:: DataZone.Client.get_asset_filter(**kwargs)

  

  Gets an asset filter.

   

  Prerequisites:

   

  
  * Domain ( ``--domain-identifier``), asset ( ``--asset-identifier``), and filter ( ``--identifier``) must all exist.
   
  * The asset filter should not have been deleted.
   
  * The asset must still exist (since the filter is linked to it).
  

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/GetAssetFilter>`_  


  **Request Syntax**
  ::

    response = client.get_asset_filter(
        domainIdentifier='string',
        assetIdentifier='string',
        identifier='string'
    )
    
  :type domainIdentifier: string
  :param domainIdentifier: **[REQUIRED]** 

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

    

  
  :type assetIdentifier: string
  :param assetIdentifier: **[REQUIRED]** 

    The ID of the data asset.

    

  
  :type identifier: string
  :param identifier: **[REQUIRED]** 

    The ID of the asset filter.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

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

    

    - *(dict) --* 
      

      - **id** *(string) --* 

        The ID of the asset filter.

        
      

      - **domainId** *(string) --* 

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

        
      

      - **assetId** *(string) --* 

        The ID of the data asset.

        
      

      - **name** *(string) --* 

        The name of the asset filter.

        
      

      - **description** *(string) --* 

        The description of the asset filter.

        
      

      - **status** *(string) --* 

        The status of the asset filter.

        
      

      - **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: ``expression``, ``and``, ``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``, ``notEqualTo``, ``greaterThan``, ``lessThan``, ``greaterThanOrEqualTo``, ``lessThanOrEqualTo``, ``isNull``, ``isNotNull``, ``in``, ``notIn``, ``like``, ``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.

                  
            
              

              - **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.

                  
            
              

              - **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.

                  
            
              

              - **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.

                  
            
              

              - **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.

                  
            
              

              - **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.

                  
            
              

              - **isNull** *(dict) --* 

                The 'is null' clause of the row filter expression.

                
                

                - **columnName** *(string) --* 

                  The name of the column.

                  
            
              

              - **isNotNull** *(dict) --* 

                The 'is not null' clause of the row filter expression.

                
                

                - **columnName** *(string) --* 

                  The name of the column.

                  
            
              

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

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

              - **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.

                  
            
              

              - **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.

                  
            
          
            

            - **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: ``expression``, ``and``, ``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'}


              
          
            

            - **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: ``expression``, ``and``, ``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.

        
      

      - **errorMessage** *(string) --* 

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

        
      

      - **effectiveColumnNames** *(list) --* 

        The column names of the asset filter.

        
        

        - *(string) --* 
    
      

      - **effectiveRowFilter** *(string) --* 

        The row filter of the asset filter.

        
  
  **Exceptions**
  
  *   :py:class:`DataZone.Client.exceptions.InternalServerException`

  
  *   :py:class:`DataZone.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`DataZone.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`DataZone.Client.exceptions.ThrottlingException`

  
  *   :py:class:`DataZone.Client.exceptions.ValidationException`

  
  *   :py:class:`DataZone.Client.exceptions.UnauthorizedException`

  