DataZone / Paginator / ListRules

ListRules

class DataZone.Paginator.ListRules

paginator = client.get_paginator('list_rules')

paginate(**kwargs)

Creates an iterator that will paginate through responses from DataZone.Client.list_rules().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    action='CREATE_SUBSCRIPTION_REQUEST',
    assetTypes=[
        'string',
    ],
    dataProduct=True|False,
    domainIdentifier='string',
    includeCascaded=True|False,
    projectIds=[
        'string',
    ],
    ruleType='METADATA_FORM_ENFORCEMENT',
    targetIdentifier='string',
    targetType='DOMAIN_UNIT',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• action (string) – The action of the rule.

• assetTypes (list) –

  The asset types of the rule.

  • (string) –

• dataProduct (boolean) – The data product of the rule.

• domainIdentifier (string) –

  [REQUIRED]

  The ID of the domain in which the rules are to be listed.

• includeCascaded (boolean) – Specifies whether to include cascading rules in the results.

• projectIds (list) –

  The IDs of projects in which rules are to be listed.

  • (string) –

• ruleType (string) – The type of the rule.

• targetIdentifier (string) –

  [REQUIRED]

  The target ID of the rule.

• targetType (string) –

  [REQUIRED]

  The target type of the rule.

• 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

{
    'items': [
        {
            'action': 'CREATE_SUBSCRIPTION_REQUEST',
            'identifier': 'string',
            'lastUpdatedBy': 'string',
            'name': 'string',
            'revision': 'string',
            'ruleType': 'METADATA_FORM_ENFORCEMENT',
            'scope': {
                'assetType': {
                    'selectionMode': 'ALL'|'SPECIFIC',
                    'specificAssetTypes': [
                        'string',
                    ]
                },
                'dataProduct': True|False,
                'project': {
                    'selectionMode': 'ALL'|'SPECIFIC',
                    'specificProjects': [
                        'string',
                    ]
                }
            },
            'target': {
                'domainUnitTarget': {
                    'domainUnitId': 'string',
                    'includeChildDomainUnits': True|False
                }
            },
            'targetType': 'DOMAIN_UNIT',
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • items (list) –

    The results of the ListRules action.

    • (dict) –

      The summary of the rule.

      • action (string) –

        The action of the rule.

      • identifier (string) –

        The ID of the rule.

      • lastUpdatedBy (string) –

        The timestamp at which the rule was last updated.

      • name (string) –

        The name of the rule.

      • revision (string) –

        The revision of the rule.

      • ruleType (string) –

        The type of the rule.

      • scope (dict) –

        The scope of the rule.

        • assetType (dict) –

          The asset type included in the rule scope.

          • selectionMode (string) –

            The selection mode for the rule.

          • specificAssetTypes (list) –

            The specific asset types that are included in the rule.

            • (string) –

        • dataProduct (boolean) –

          The data product included in the rule scope.

        • project (dict) –

          The project included in the rule scope.

          • selectionMode (string) –

            The selection mode of the rule.

          • specificProjects (list) –

            The specific projects in which the rule is created.

            • (string) –

      • target (dict) –

        The target of the rule.

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: domainUnitTarget. 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'}
        

        • domainUnitTarget (dict) –

          The ID of the domain unit.

          • domainUnitId (string) –

            The ID of the domain unit.

          • includeChildDomainUnits (boolean) –

            Specifies whether to apply a rule to the child domain units.

      • targetType (string) –

        The target type of the rule.

      • updatedAt (datetime) –

        The timestamp at which the rule was last updated.

  • NextToken (string) –

    A token to resume pagination.