DataZone / Client / start_metadata_generation_run

start_metadata_generation_run

DataZone.Client.start_metadata_generation_run(**kwargs)

Starts the metadata generation run.

Prerequisites:

  • Asset must be created and belong to the specified domain and project.

  • Asset type must be supported for metadata generation (e.g., Amazon Web Services Glue table).

  • Asset must have a structured schema with valid rows and columns.

  • Valid values for –type: BUSINESS_DESCRIPTIONS, BUSINESS_NAMES, BUSINESS_GLOSSARY_ASSOCIATIONS.

  • The user must have permission to run metadata generation in the domain/project.

See also: AWS API Documentation

Request Syntax

response = client.start_metadata_generation_run(
    clientToken='string',
    domainIdentifier='string',
    owningProjectIdentifier='string',
    target={
        'identifier': 'string',
        'revision': 'string',
        'type': 'ASSET'
    },
    type='BUSINESS_DESCRIPTIONS'|'BUSINESS_NAMES'|'BUSINESS_GLOSSARY_ASSOCIATIONS',
    types=[
        'BUSINESS_DESCRIPTIONS'|'BUSINESS_NAMES'|'BUSINESS_GLOSSARY_ASSOCIATIONS',
    ]
)
Parameters:

  • clientToken (string) –

    A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.

    This field is autopopulated if not provided.

  • domainIdentifier (string) –

    [REQUIRED]

    The ID of the Amazon DataZone domain where you want to start a metadata generation run.

  • owningProjectIdentifier (string) –

    [REQUIRED]

    The ID of the project that owns the asset for which you want to start a metadata generation run.

  • target (dict) –

    [REQUIRED]

    The asset for which you want to start a metadata generation run.

    • identifier (string) – [REQUIRED]

      The ID of the metadata generation run’s target.

    • revision (string) –

      The revision of the asset for which metadata was generated.

    • type (string) – [REQUIRED]

      The type of the asset for which metadata was generated.

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

  • types (list) –

    The types of the metadata generation run.

    • (string) –

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',
    'type': 'BUSINESS_DESCRIPTIONS'|'BUSINESS_NAMES'|'BUSINESS_GLOSSARY_ASSOCIATIONS',
    'types': [
        'BUSINESS_DESCRIPTIONS'|'BUSINESS_NAMES'|'BUSINESS_GLOSSARY_ASSOCIATIONS',
    ]
}

Response Structure

  • (dict) –

    • createdAt (datetime) –

      The timestamp at which the metadata generation run was started.

    • createdBy (string) –

      The ID of the user who started the metadata generation run.

    • domainId (string) –

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

    • id (string) –

      The ID of the metadata generation run.

    • owningProjectId (string) –

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

    • 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) –

Exceptions