SageMaker / Paginator / ListAliases

ListAliases

class SageMaker.Paginator.ListAliases

paginator = client.get_paginator('list_aliases')

paginate(**kwargs)

Creates an iterator that will paginate through responses from SageMaker.Client.list_aliases().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ImageName='string',
    Alias='string',
    Version=123,
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': '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.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

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

}

Response Structure

• (dict) –

  • SageMakerImageVersionAliases (list) –

    A list of SageMaker AI image version aliases.

    • (string) –