Skip to content

list_image_versions async

list_image_versions(
    *,
    config_overrides: Optional[AsyncSageMakerClientConfig] = None,
    creation_time_after: Optional[Timestamp] = None,
    creation_time_before: Optional[Timestamp] = None,
    image_name: Optional[ImageName] = None,
    last_modified_time_after: Optional[Timestamp] = None,
    last_modified_time_before: Optional[Timestamp] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[NextToken] = None,
    sort_by: Optional[ImageVersionSortBy] = None,
    sort_order: Optional[ImageVersionSortOrder] = None,
) -> ListImageVersionsResponse

Lists the versions of a specified image and their properties. The list can be filtered by creation time or modified time.

Parameters:

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

    A filter that returns only versions created on or after the specified time.

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

    A filter that returns only versions created on or before the specified time.

  • image_name (Optional[ImageName], default: None ) –

    The name of the image to list the versions of.

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

    A filter that returns only versions modified on or after the specified time.

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

    A filter that returns only versions modified on or before the specified time.

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

    The maximum number of versions to return in the response. The default value is 10.

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

    If the previous call to ListImageVersions didn't return the full set of versions, the call returns a token for getting the next set of versions.

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

    The property used to sort results. The default value is CREATION_TIME.

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

    The sort order. The default value is DESCENDING.

Raises:

Source code in docs_src/capo_sagemaker/_services/async_sage_maker.py
async def list_image_versions(
    self,
    *,
    config_overrides: Optional[AsyncSageMakerClientConfig] = None,
    creation_time_after: Optional[
        "capo_sagemaker.types.timestamp.Timestamp"
    ] = None,
    creation_time_before: Optional[
        "capo_sagemaker.types.timestamp.Timestamp"
    ] = None,
    image_name: Optional["capo_sagemaker.types.image_name.ImageName"] = None,
    last_modified_time_after: Optional[
        "capo_sagemaker.types.timestamp.Timestamp"
    ] = None,
    last_modified_time_before: Optional[
        "capo_sagemaker.types.timestamp.Timestamp"
    ] = None,
    max_results: Optional["capo_sagemaker.types.max_results.MaxResults"] = None,
    next_token: Optional["capo_sagemaker.types.next_token.NextToken"] = None,
    sort_by: Optional[
        "capo_sagemaker.types.image_version_sort_by.ImageVersionSortBy"
    ] = None,
    sort_order: Optional[
        "capo_sagemaker.types.image_version_sort_order.ImageVersionSortOrder"
    ] = None,
) -> "capo_sagemaker.types.list_image_versions_response.ListImageVersionsResponse":
    """<p>Lists the versions of a specified image and their properties. The list can be filtered by creation time or modified time.</p>

    Args:
        creation_time_after: <p>A filter that returns only versions created on or after the specified time.</p>
        creation_time_before: <p>A filter that returns only versions created on or before the specified time.</p>
        image_name: <p>The name of the image to list the versions of.</p>
        last_modified_time_after: <p>A filter that returns only versions modified on or after the specified time.</p>
        last_modified_time_before: <p>A filter that returns only versions modified on or before the specified time.</p>
        max_results: <p>The maximum number of versions to return in the response. The default value is 10. </p>
        next_token: <p>If the previous call to <code>ListImageVersions</code> didn't return the full set of versions, the call returns a token for getting the next set of versions.</p>
        sort_by: <p>The property used to sort results. The default value is <code>CREATION_TIME</code>.</p>
        sort_order: <p>The sort order. The default value is <code>DESCENDING</code>.</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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_sagemaker.types.list_image_versions_request.ListImageVersionsRequest]",
    ) -> AsyncOperationResponse[
        "capo_sagemaker.types.list_image_versions_response.ListImageVersionsResponse"
    ]:
        import capo_sagemaker._operations.sage_maker.list_image_versions

        (
            output,
            http_response,
        ) = await capo_sagemaker._operations.sage_maker.list_image_versions.async_list_image_versions(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListImageVersions")
    )
    input_: capo_sagemaker.types.list_image_versions_request.ListImageVersionsRequest = {}
    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 image_name is not None:
        input_["image_name"] = image_name
    if last_modified_time_after is not None:
        input_["last_modified_time_after"] = last_modified_time_after
    if last_modified_time_before is not None:
        input_["last_modified_time_before"] = last_modified_time_before
    if max_results is not None:
        input_["max_results"] = max_results
    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 = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output