Skip to content

list_aliases async

list_aliases(
    *,
    config_overrides: Optional[AsyncSageMakerClientConfig] = None,
    image_name: Optional[ImageName] = None,
    alias: Optional[SageMakerImageVersionAlias] = None,
    version: Optional[ImageVersionNumber] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[NextToken] = None,
) -> ListAliasesResponse

Lists the aliases of a specified image or image version.

Parameters:

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

    The name of the image.

  • alias (Optional[SageMakerImageVersionAlias], default: None ) –

    The alias of the image version.

  • version (Optional[ImageVersionNumber], default: None ) –

    The version of the image. If image version is not specified, the aliases of all versions of the image are listed.

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

    The maximum number of aliases to return.

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

    If the previous call to ListAliases didn't return the full set of aliases, the call returns a token for retrieving the next set of aliases.

Raises:

Source code in docs_src/capo_sagemaker/_services/async_sage_maker.py
async def list_aliases(
    self,
    *,
    config_overrides: Optional[AsyncSageMakerClientConfig] = None,
    image_name: Optional["capo_sagemaker.types.image_name.ImageName"] = None,
    alias: Optional[
        "capo_sagemaker.types.sage_maker_image_version_alias.SageMakerImageVersionAlias"
    ] = None,
    version: Optional[
        "capo_sagemaker.types.image_version_number.ImageVersionNumber"
    ] = None,
    max_results: Optional["capo_sagemaker.types.max_results.MaxResults"] = None,
    next_token: Optional["capo_sagemaker.types.next_token.NextToken"] = None,
) -> "capo_sagemaker.types.list_aliases_response.ListAliasesResponse":
    """<p>Lists the aliases of a specified image or image version.</p>

    Args:
        image_name: <p>The name of the image.</p>
        alias: <p>The alias of the image version.</p>
        version: <p>The version of the image. If image version is not specified, the aliases of all versions of the image are listed.</p>
        max_results: <p>The maximum number of aliases to return.</p>
        next_token: <p>If the previous call to <code>ListAliases</code> didn't return the full set of aliases, the call returns a token for retrieving the next set of aliases.</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_aliases_request.ListAliasesRequest]",
    ) -> AsyncOperationResponse[
        "capo_sagemaker.types.list_aliases_response.ListAliasesResponse"
    ]:
        import capo_sagemaker._operations.sage_maker.list_aliases

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListAliases")
    )
    input_: capo_sagemaker.types.list_aliases_request.ListAliasesRequest = {}
    if image_name is not None:
        input_["image_name"] = image_name
    if alias is not None:
        input_["alias"] = alias
    if version is not None:
        input_["version"] = version
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

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