DataZone / Client / get_metadata_generation_run

get_metadata_generation_run

DataZone.Client.get_metadata_generation_run(**kwargs)

Gets a metadata generation run in Amazon DataZone.

Prerequisites:

  • Valid domain and run identifier.

  • The metadata generation run must exist.

  • User must have read access to the metadata run.

See also: AWS API Documentation

Request Syntax

response = client.get_metadata_generation_run(
    domainIdentifier='string',
    identifier='string',
    type='BUSINESS_DESCRIPTIONS'|'BUSINESS_NAMES'|'BUSINESS_GLOSSARY_ASSOCIATIONS'
)
Parameters:

  • domainIdentifier (string) –

    [REQUIRED]

    The ID of the Amazon DataZone domain the metadata generation run of which you want to get.

  • identifier (string) –

    [REQUIRED]

    The identifier of the metadata generation run.

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

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • createdAt (datetime) –

      The timestamp of when the metadata generation run was start.

    • createdBy (string) –

      The Amazon DataZone user who started the metadata generation run.

    • domainId (string) –

      The ID of the Amazon DataZone domain the metadata generation run of which you want to get.

    • id (string) –

      The ID of the metadata generation run.

    • owningProjectId (string) –

      The ID of the project that owns the assets for which you’re running metadata generation.

    • status (string) –

      The status of the metadata generation run.

    • target (dict) –

      The asset for which you’re generating metadata.

      • identifier (string) –

        The ID of the metadata generation run’s target.

      • revision (string) –

        The revision of the asset for which metadata was generated.

      • type (string) –

        The type of the asset for which metadata was generated.

    • type (string) –

      The type of metadata generation run.

    • typeStats (list) –

      The type stats included in the metadata generation run output details.

      • (dict) –

        The statistics of the metadata generation run type.

        • errorMessage (string) –

          The error message displayed if the action fails to run.

        • status (string) –

          The status of the metadata generation run type statistics.

        • type (string) –

          The type of the metadata generation run type statistics.

    • types (list) –

      The types of the metadata generation run.

      • (string) –

Exceptions