Skip to content

list_model_card_export_jobs

list_model_card_export_jobs(
    *,
    config_overrides: Optional[SageMakerClientConfig] = None,
    model_card_name: Optional[EntityName] = None,
    model_card_version: Optional[Integer] = None,
    creation_time_after: Optional[Timestamp] = None,
    creation_time_before: Optional[Timestamp] = None,
    model_card_export_job_name_contains: Optional[EntityName] = None,
    status_equals: Optional[ModelCardExportJobStatus] = None,
    sort_by: Optional[ModelCardExportJobSortBy] = None,
    sort_order: Optional[ModelCardExportJobSortOrder] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[MaxResults] = None,
) -> ListModelCardExportJobsResponse

List the export jobs for the Amazon SageMaker Model Card.

Parameters:

  • model_card_name (Optional[EntityName], default: None ) –

    List export jobs for the model card with the specified name.

  • model_card_version (Optional[Integer], default: None ) –

    List export jobs for the model card with the specified version.

  • creation_time_after (Optional[Timestamp], default: None ) –

    Only list model card export jobs that were created after the time specified.

  • creation_time_before (Optional[Timestamp], default: None ) –

    Only list model card export jobs that were created before the time specified.

  • model_card_export_job_name_contains (Optional[EntityName], default: None ) –

    Only list model card export jobs with names that contain the specified string.

  • status_equals (Optional[ModelCardExportJobStatus], default: None ) –

    Only list model card export jobs with the specified status.

  • sort_by (Optional[ModelCardExportJobSortBy], default: None ) –

    Sort model card export jobs by either name or creation time. Sorts by creation time by default.

  • sort_order (Optional[ModelCardExportJobSortOrder], default: None ) –

    Sort model card export jobs by ascending or descending order.

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

    If the response to a previous ListModelCardExportJobs request was truncated, the response includes a NextToken. To retrieve the next set of model card export jobs, use the token in the next request.

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

    The maximum number of model card export jobs to list.

Raises:

Source code in docs_src/capo_sagemaker/_services/sage_maker.py
def list_model_card_export_jobs(
    self,
    *,
    config_overrides: Optional[SageMakerClientConfig] = None,
    model_card_name: Optional["capo_sagemaker.types.entity_name.EntityName"] = None,
    model_card_version: Optional["capo_sagemaker.types.integer.Integer"] = None,
    creation_time_after: Optional[
        "capo_sagemaker.types.timestamp.Timestamp"
    ] = None,
    creation_time_before: Optional[
        "capo_sagemaker.types.timestamp.Timestamp"
    ] = None,
    model_card_export_job_name_contains: Optional[
        "capo_sagemaker.types.entity_name.EntityName"
    ] = None,
    status_equals: Optional[
        "capo_sagemaker.types.model_card_export_job_status.ModelCardExportJobStatus"
    ] = None,
    sort_by: Optional[
        "capo_sagemaker.types.model_card_export_job_sort_by.ModelCardExportJobSortBy"
    ] = None,
    sort_order: Optional[
        "capo_sagemaker.types.model_card_export_job_sort_order.ModelCardExportJobSortOrder"
    ] = None,
    next_token: Optional["capo_sagemaker.types.next_token.NextToken"] = None,
    max_results: Optional["capo_sagemaker.types.max_results.MaxResults"] = None,
) -> "capo_sagemaker.types.list_model_card_export_jobs_response.ListModelCardExportJobsResponse":
    """<p>List the export jobs for the Amazon SageMaker Model Card.</p>

    Args:
        model_card_name: <p>List export jobs for the model card with the specified name.</p>
        model_card_version: <p>List export jobs for the model card with the specified version.</p>
        creation_time_after: <p>Only list model card export jobs that were created after the time specified.</p>
        creation_time_before: <p>Only list model card export jobs that were created before the time specified.</p>
        model_card_export_job_name_contains: <p>Only list model card export jobs with names that contain the specified string.</p>
        status_equals: <p>Only list model card export jobs with the specified status.</p>
        sort_by: <p>Sort model card export jobs by either name or creation time. Sorts by creation time by default.</p>
        sort_order: <p>Sort model card export jobs by ascending or descending order.</p>
        next_token: <p>If the response to a previous <code>ListModelCardExportJobs</code> request was truncated, the response includes a <code>NextToken</code>. To retrieve the next set of model card export jobs, use the token in the next request.</p>
        max_results: <p>The maximum number of model card export jobs to list.</p>

    Raises:
        capo_sagemaker.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_sagemaker.types.list_model_card_export_jobs_request.ListModelCardExportJobsRequest]",
    ) -> OperationResponse[
        "capo_sagemaker.types.list_model_card_export_jobs_response.ListModelCardExportJobsResponse"
    ]:
        import capo_sagemaker._operations.sage_maker.list_model_card_export_jobs

        output, http_response = (
            capo_sagemaker._operations.sage_maker.list_model_card_export_jobs.list_model_card_export_jobs(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListModelCardExportJobs")
    )
    input_: capo_sagemaker.types.list_model_card_export_jobs_request.ListModelCardExportJobsRequest = {}
    if model_card_name is not None:
        input_["model_card_name"] = model_card_name
    if model_card_version is not None:
        input_["model_card_version"] = model_card_version
    if creation_time_after is not None:
        input_["creation_time_after"] = creation_time_after
    if creation_time_before is not None:
        input_["creation_time_before"] = creation_time_before
    if model_card_export_job_name_contains is not None:
        input_["model_card_export_job_name_contains"] = (
            model_card_export_job_name_contains
        )
    if status_equals is not None:
        input_["status_equals"] = status_equals
    if sort_by is not None:
        input_["sort_by"] = sort_by
    if sort_order is not None:
        input_["sort_order"] = sort_order
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output