:doc:`GlueDataBrew <../../databrew>` / Client / list_rulesets

*************
list_rulesets
*************



.. py:method:: GlueDataBrew.Client.list_rulesets(**kwargs)

  

  List all rulesets available in the current account or rulesets associated with a specific resource (dataset).

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/ListRulesets>`_  


  **Request Syntax**
  ::

    response = client.list_rulesets(
        TargetArn='string',
        MaxResults=123,
        NextToken='string'
    )
    
  :type TargetArn: string
  :param TargetArn: 

    The Amazon Resource Name (ARN) of a resource (dataset). Using this parameter indicates to return only those rulesets that are associated with the specified resource.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of results to return in this request.

    

  
  :type NextToken: string
  :param NextToken: 

    A token generated by DataBrew that specifies where to continue pagination if a previous request was truncated. To get the next set of pages, pass in the NextToken value from the response object of the previous page call.

    

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

    
    ::

      {
          'Rulesets': [
              {
                  'AccountId': 'string',
                  'CreatedBy': 'string',
                  'CreateDate': datetime(2015, 1, 1),
                  'Description': 'string',
                  'LastModifiedBy': 'string',
                  'LastModifiedDate': datetime(2015, 1, 1),
                  'Name': 'string',
                  'ResourceArn': 'string',
                  'RuleCount': 123,
                  'Tags': {
                      'string': 'string'
                  },
                  'TargetArn': 'string'
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **Rulesets** *(list) --* 

        A list of RulesetItem. RulesetItem contains meta data of a ruleset.

        
        

        - *(dict) --* 

          Contains metadata about the ruleset.

          
          

          - **AccountId** *(string) --* 

            The ID of the Amazon Web Services account that owns the ruleset.

            
          

          - **CreatedBy** *(string) --* 

            The Amazon Resource Name (ARN) of the user who created the ruleset.

            
          

          - **CreateDate** *(datetime) --* 

            The date and time that the ruleset was created.

            
          

          - **Description** *(string) --* 

            The description of the ruleset.

            
          

          - **LastModifiedBy** *(string) --* 

            The Amazon Resource Name (ARN) of the user who last modified the ruleset.

            
          

          - **LastModifiedDate** *(datetime) --* 

            The modification date and time of the ruleset.

            
          

          - **Name** *(string) --* 

            The name of the ruleset.

            
          

          - **ResourceArn** *(string) --* 

            The Amazon Resource Name (ARN) for the ruleset.

            
          

          - **RuleCount** *(integer) --* 

            The number of rules that are defined in the ruleset.

            
          

          - **Tags** *(dict) --* 

            Metadata tags that have been applied to the ruleset.

            
            

            - *(string) --* 
              

              - *(string) --* 
        
      
          

          - **TargetArn** *(string) --* 

            The Amazon Resource Name (ARN) of a resource (dataset) that the ruleset is associated with.

            
      
    
      

      - **NextToken** *(string) --* 

        A token that you can use in a subsequent call to retrieve the next set of results.

        
  
  **Exceptions**
  
  *   :py:class:`GlueDataBrew.Client.exceptions.ResourceNotFoundException`

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

  