Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListAliases

Lists the aliases of a specified image or image version.

Request Syntax


{
   "Alias": "string",
   "ImageName": "string",
   "MaxResults": number,
   "NextToken": "string",
   "Version": number
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Alias

The alias of the image version.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: (?!^[.-])^([a-zA-Z0-9-_.]+)$

Required: No

ImageName

The name of the image.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

Pattern: ^[a-zA-Z0-9]([-.]?[a-zA-Z0-9]){0,62}$

Required: Yes

MaxResults

The maximum number of aliases to return.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NextToken

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.

Type: String

Length Constraints: Maximum length of 8192.

Pattern: .*

Required: No

Version

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

Type: Integer

Valid Range: Minimum value of 0.

Required: No

Response Syntax


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

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken

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

Type: String

Length Constraints: Maximum length of 8192.

Pattern: .*

SageMakerImageVersionAliases

A list of SageMaker image version aliases.

Type: Array of strings

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: (?!^[.-])^([a-zA-Z0-9-_.]+)$

Errors

For information about the errors that are common to all actions, see Common Errors.

ResourceNotFound

Resource being access is not found.

HTTP Status Code: 400