GlueDataBrew / Paginator / ListRulesets

ListRulesets

class GlueDataBrew.Paginator.ListRulesets

paginator = client.get_paginator('list_rulesets')

paginate(**kwargs)

Creates an iterator that will paginate through responses from GlueDataBrew.Client.list_rulesets().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    TargetArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• TargetArn (string) – 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.

• 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

{
    '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'
        },
    ],

}

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.