Skip to content

list_model_card_versions

list_model_card_versions(
    *,
    config_overrides: Optional[SageMakerClientConfig] = None,
    creation_time_after: Optional[Timestamp] = None,
    creation_time_before: Optional[Timestamp] = None,
    max_results: Optional[MaxResults] = None,
    model_card_name: Optional[ModelCardNameOrArn] = None,
    model_card_status: Optional[ModelCardStatus] = None,
    next_token: Optional[NextToken] = None,
    sort_by: Optional[ModelCardVersionSortBy] = None,
    sort_order: Optional[ModelCardSortOrder] = None,
) -> ListModelCardVersionsResponse

List existing versions of an Amazon SageMaker Model Card.

Parameters:

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

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

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

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

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

    The maximum number of model card versions to list.

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

    List model card versions for the model card with the specified name or Amazon Resource Name (ARN).

  • model_card_status (Optional[ModelCardStatus], default: None ) –

    Only list model card versions with the specified approval status.

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

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

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

    Sort listed model card versions by version. Sorts by version by default.

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

    Sort model card versions by ascending or descending order.

Raises:

Source code in docs_src/capo_sagemaker/_services/sage_maker.py
def list_model_card_versions(
    self,
    *,
    config_overrides: Optional[SageMakerClientConfig] = None,
    creation_time_after: Optional[
        "capo_sagemaker.types.timestamp.Timestamp"
    ] = None,
    creation_time_before: Optional[
        "capo_sagemaker.types.timestamp.Timestamp"
    ] = None,
    max_results: Optional["capo_sagemaker.types.max_results.MaxResults"] = None,
    model_card_name: Optional[
        "capo_sagemaker.types.model_card_name_or_arn.ModelCardNameOrArn"
    ] = None,
    model_card_status: Optional[
        "capo_sagemaker.types.model_card_status.ModelCardStatus"
    ] = None,
    next_token: Optional["capo_sagemaker.types.next_token.NextToken"] = None,
    sort_by: Optional[
        "capo_sagemaker.types.model_card_version_sort_by.ModelCardVersionSortBy"
    ] = None,
    sort_order: Optional[
        "capo_sagemaker.types.model_card_sort_order.ModelCardSortOrder"
    ] = None,
) -> "capo_sagemaker.types.list_model_card_versions_response.ListModelCardVersionsResponse":
    """<p>List existing versions of an Amazon SageMaker Model Card.</p>

    Args:
        creation_time_after: <p>Only list model card versions that were created after the time specified.</p>
        creation_time_before: <p>Only list model card versions that were created before the time specified.</p>
        max_results: <p>The maximum number of model card versions to list.</p>
        model_card_name: <p>List model card versions for the model card with the specified name or Amazon Resource Name (ARN).</p>
        model_card_status: <p>Only list model card versions with the specified approval status.</p>
        next_token: <p>If the response to a previous <code>ListModelCardVersions</code> request was truncated, the response includes a <code>NextToken</code>. To retrieve the next set of model card versions, use the token in the next request.</p>
        sort_by: <p>Sort listed model card versions by version. Sorts by version by default.</p>
        sort_order: <p>Sort model card versions by ascending or descending order.</p>

    Raises:
        capo_sagemaker.errors.resource_not_found.ResourceNotFound: <p>Resource being access is not found.</p>
        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_versions_request.ListModelCardVersionsRequest]",
    ) -> OperationResponse[
        "capo_sagemaker.types.list_model_card_versions_response.ListModelCardVersionsResponse"
    ]:
        import capo_sagemaker._operations.sage_maker.list_model_card_versions

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListModelCardVersions")
    )
    input_: capo_sagemaker.types.list_model_card_versions_request.ListModelCardVersionsRequest = {}
    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 max_results is not None:
        input_["max_results"] = max_results
    if model_card_name is not None:
        input_["model_card_name"] = model_card_name
    if model_card_status is not None:
        input_["model_card_status"] = model_card_status
    if next_token is not None:
        input_["next_token"] = next_token
    if sort_by is not None:
        input_["sort_by"] = sort_by
    if sort_order is not None:
        input_["sort_order"] = sort_order

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