list_aliases

SageMaker.Client.list_aliases(**kwargs)

Lists the aliases of a specified image or image version.

See also: AWS API Documentation

Request Syntax

response = client.list_aliases(
    ImageName='string',
    Alias='string',
    Version=123,
    MaxResults=123,
    NextToken='string'
)

Parameters

• ImageName (string) --

  [REQUIRED]

  The name of the image.

• Alias (string) -- The alias of the image version.
• Version (integer) -- The version of the image. If image version is not specified, the aliases of all versions of the image are listed.
• MaxResults (integer) -- The maximum number of aliases to return.
• NextToken (string) -- 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.

Return type

dict

Returns

Response Syntax

{
    'SageMakerImageVersionAliases': [
        'string',
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • SageMakerImageVersionAliases (list) --

    A list of SageMaker image version aliases.

    • (string) --

  • NextToken (string) --

    A token for getting the next set of aliases, if more aliases exist.

Exceptions

• SageMaker.Client.exceptions.ResourceNotFound