:doc:`SageMaker <../../sagemaker>` / Client / list_aliases

************
list_aliases
************



.. py:method:: SageMaker.Client.list_aliases(**kwargs)

  

  Lists the aliases of a specified image or image version.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/ListAliases>`_  


  **Request Syntax**
  ::

    response = client.list_aliases(
        ImageName='string',
        Alias='string',
        Version=123,
        MaxResults=123,
        NextToken='string'
    )
    
  :type ImageName: string
  :param ImageName: **[REQUIRED]** 

    The name of the image.

    

  
  :type Alias: string
  :param Alias: 

    The alias of the image version.

    

  
  :type Version: integer
  :param Version: 

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

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of aliases to return.

    

  
  :type NextToken: string
  :param 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.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'SageMakerImageVersionAliases': [
              'string',
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **SageMakerImageVersionAliases** *(list) --* 

        A list of SageMaker AI image version aliases.

        
        

        - *(string) --* 
    
      

      - **NextToken** *(string) --* 

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

        
  
  **Exceptions**
  
  *   :py:class:`SageMaker.Client.exceptions.ResourceNotFound`

  