Skip to content

list_metadata_generation_runs async

list_metadata_generation_runs(
    domain_identifier: DomainId,
    *,
    config_overrides: Optional[AsyncDataZoneClientConfig] = None,
    status: Optional[MetadataGenerationRunStatus] = None,
    type: Optional[MetadataGenerationRunType] = None,
    next_token: Optional[PaginationToken] = None,
    max_results: Optional[MaxResults] = None,
    target_identifier: Optional[EntityId] = None,
) -> ListMetadataGenerationRunsOutput

Lists all metadata generation runs.

Metadata generation runs represent automated processes that leverage AI/ML capabilities to create or enhance asset metadata at scale. This feature helps organizations maintain comprehensive and consistent metadata across large numbers of assets without manual intervention. It can automatically generate business descriptions, tags, and other metadata elements, significantly reducing the time and effort required for metadata management while improving consistency and completeness.

Prerequisites:

  • Valid domain identifier.

  • User must have access to metadata generation runs in the domain.

Parameters:

  • domain_identifier (DomainId) –

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

  • status (Optional[MetadataGenerationRunStatus], default: None ) –

    The status of the metadata generation runs.

  • type (Optional[MetadataGenerationRunType], default: None ) –

    The type of the metadata generation runs.

  • next_token (Optional[PaginationToken], default: None ) –

    When the number of metadata generation runs is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of metadata generation runs, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListMetadataGenerationRuns to list the next set of revisions.

  • max_results (Optional[MaxResults], default: None ) –

    The maximum number of metadata generation runs to return in a single call to ListMetadataGenerationRuns. When the number of metadata generation runs to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListMetadataGenerationRuns to list the next set of revisions.

  • target_identifier (Optional[EntityId], default: None ) –

    The target ID for which you want to list metadata generation runs.

Raises:

Source code in docs_src/capo_datazone/_services/async_data_zone.py
async def list_metadata_generation_runs(
    self,
    domain_identifier: "capo_datazone.types.domain_id.DomainId",
    *,
    config_overrides: Optional[AsyncDataZoneClientConfig] = None,
    status: Optional[
        "capo_datazone.types.metadata_generation_run_status.MetadataGenerationRunStatus"
    ] = None,
    type: Optional[
        "capo_datazone.types.metadata_generation_run_type.MetadataGenerationRunType"
    ] = None,
    next_token: Optional[
        "capo_datazone.types.pagination_token.PaginationToken"
    ] = None,
    max_results: Optional["capo_datazone.types.max_results.MaxResults"] = None,
    target_identifier: Optional["capo_datazone.types.entity_id.EntityId"] = None,
) -> "capo_datazone.types.list_metadata_generation_runs_output.ListMetadataGenerationRunsOutput":
    """<p>Lists all metadata generation runs.</p> <p>Metadata generation runs represent automated processes that leverage AI/ML capabilities to create or enhance asset metadata at scale. This feature helps organizations maintain comprehensive and consistent metadata across large numbers of assets without manual intervention. It can automatically generate business descriptions, tags, and other metadata elements, significantly reducing the time and effort required for metadata management while improving consistency and completeness.</p> <p>Prerequisites:</p> <ul> <li> <p>Valid domain identifier. </p> </li> <li> <p>User must have access to metadata generation runs in the domain.</p> </li> </ul>

    Args:
        domain_identifier: <p>The ID of the Amazon DataZone domain where you want to list metadata generation runs.</p>
        status: <p>The status of the metadata generation runs.</p>
        type: <p>The type of the metadata generation runs.</p>
        next_token: <p>When the number of metadata generation runs is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of metadata generation runs, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListMetadataGenerationRuns to list the next set of revisions.</p>
        max_results: <p>The maximum number of metadata generation runs to return in a single call to ListMetadataGenerationRuns. When the number of metadata generation runs to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListMetadataGenerationRuns to list the next set of revisions.</p>
        target_identifier: <p>The target ID for which you want to list metadata generation runs.</p>

    Raises:
        capo_datazone.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_datazone.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_datazone.errors.unauthorized_exception.UnauthorizedException: <p>You do not have permission to perform this action.</p>
        capo_datazone.errors.internal_server_exception.InternalServerException: <p>The request has failed because of an unknown error, exception or failure.</p>
        capo_datazone.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource cannot be found.</p>
        capo_datazone.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by the Amazon Web Services service.</p>
        capo_datazone.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_datazone.types.list_metadata_generation_runs_input.ListMetadataGenerationRunsInput]",
    ) -> AsyncOperationResponse[
        "capo_datazone.types.list_metadata_generation_runs_output.ListMetadataGenerationRunsOutput"
    ]:
        import capo_datazone._operations.data_zone.list_metadata_generation_runs

        (
            output,
            http_response,
        ) = await capo_datazone._operations.data_zone.list_metadata_generation_runs.async_list_metadata_generation_runs(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListMetadataGenerationRuns")
    )
    input_: capo_datazone.types.list_metadata_generation_runs_input.ListMetadataGenerationRunsInput = {
        "domain_identifier": domain_identifier
    }
    if status is not None:
        input_["status"] = status
    if type is not None:
        input_["type"] = type
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results
    if target_identifier is not None:
        input_["target_identifier"] = target_identifier

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output