DataZone / Paginator / ListMetadataGenerationRuns

ListMetadataGenerationRuns

class DataZone.Paginator.ListMetadataGenerationRuns

paginator = client.get_paginator('list_metadata_generation_runs')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    domainIdentifier='string',
    status='SUBMITTED'|'IN_PROGRESS'|'CANCELED'|'SUCCEEDED'|'FAILED'|'PARTIALLY_SUCCEEDED',
    type='BUSINESS_DESCRIPTIONS'|'BUSINESS_NAMES'|'BUSINESS_GLOSSARY_ASSOCIATIONS',
    targetIdentifier='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• domainIdentifier (string) –

  [REQUIRED]

  The ID of the Amazon DataZone domain where you want to list metadata generation runs.

• status (string) – The status of the metadata generation runs.

• type (string) – The type of the metadata generation runs.

• targetIdentifier (string) – The target ID for which you want to list metadata generation runs.

• 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': [
        {
            'domainId': 'string',
            'id': 'string',
            'target': {
                'type': 'ASSET',
                'identifier': 'string',
                'revision': 'string'
            },
            'status': 'SUBMITTED'|'IN_PROGRESS'|'CANCELED'|'SUCCEEDED'|'FAILED'|'PARTIALLY_SUCCEEDED',
            'type': 'BUSINESS_DESCRIPTIONS'|'BUSINESS_NAMES'|'BUSINESS_GLOSSARY_ASSOCIATIONS',
            'types': [
                'BUSINESS_DESCRIPTIONS'|'BUSINESS_NAMES'|'BUSINESS_GLOSSARY_ASSOCIATIONS',
            ],
            'createdAt': datetime(2015, 1, 1),
            'createdBy': 'string',
            'owningProjectId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • items (list) –

    The results of the ListMetadataGenerationRuns action.

    • (dict) –

      The metadata generation run.

      • domainId (string) –

        The ID of the Amazon DataZone domain in which the metadata generation run was created.

      • id (string) –

        The ID of the metadata generation run.

      • target (dict) –

        The asset for which metadata was generated.

        • type (string) –

          The type of the asset for which metadata was generated.

        • identifier (string) –

          The ID of the metadata generation run’s target.

        • revision (string) –

          The revision of the asset for which metadata was generated.

      • status (string) –

        The status of the metadata generation run.

      • type (string) –

        The type of the metadata generation run.

      • types (list) –

        The types of the metadata generation run.

        • (string) –

      • createdAt (datetime) –

        The timestamp at which the metadata generation run was created.

      • createdBy (string) –

        The user who created the metadata generation run.

      • owningProjectId (string) –

        The ID of the project that owns the asset for which the metadata generation was ran.

  • NextToken (string) –

    A token to resume pagination.