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

***************************************
list_ultra_servers_by_reserved_capacity
***************************************



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

  

  Lists all UltraServers that are part of a specified reserved capacity.

  

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


  **Request Syntax**
  ::

    response = client.list_ultra_servers_by_reserved_capacity(
        ReservedCapacityArn='string',
        MaxResults=123,
        NextToken='string'
    )
    
  :type ReservedCapacityArn: string
  :param ReservedCapacityArn: **[REQUIRED]** 

    The ARN of the reserved capacity to list UltraServers for.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of UltraServers to return in the response. The default value is 10.

    

  
  :type NextToken: string
  :param NextToken: 

    If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

    

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

    
    ::

      {
          'NextToken': 'string',
          'UltraServers': [
              {
                  'UltraServerId': 'string',
                  'UltraServerType': 'string',
                  'AvailabilityZone': 'string',
                  'InstanceType': 'ml.p4d.24xlarge'|'ml.p5.48xlarge'|'ml.p5e.48xlarge'|'ml.p5en.48xlarge'|'ml.trn1.32xlarge'|'ml.trn2.48xlarge'|'ml.p6-b200.48xlarge'|'ml.p4de.24xlarge'|'ml.p6e-gb200.36xlarge'|'ml.p5.4xlarge'|'ml.p6-b300.48xlarge',
                  'TotalInstanceCount': 123,
                  'ConfiguredSpareInstanceCount': 123,
                  'AvailableInstanceCount': 123,
                  'InUseInstanceCount': 123,
                  'AvailableSpareInstanceCount': 123,
                  'UnhealthyInstanceCount': 123,
                  'HealthStatus': 'OK'|'Impaired'|'Insufficient-Data'
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        If the response is truncated, SageMaker returns this token. Use it in the next request to retrieve the next set of UltraServers.

        
      

      - **UltraServers** *(list) --* 

        A list of UltraServers that are part of the specified reserved capacity.

        
        

        - *(dict) --* 

          Represents a high-performance compute server used for distributed training in SageMaker AI. An UltraServer consists of multiple instances within a shared NVLink interconnect domain.

          
          

          - **UltraServerId** *(string) --* 

            The unique identifier for the UltraServer.

            
          

          - **UltraServerType** *(string) --* 

            The type of UltraServer, such as ml.u-p6e-gb200x72.

            
          

          - **AvailabilityZone** *(string) --* 

            The name of the Availability Zone where the UltraServer is provisioned.

            
          

          - **InstanceType** *(string) --* 

            The Amazon EC2 instance type used in the UltraServer.

            
          

          - **TotalInstanceCount** *(integer) --* 

            The total number of instances in this UltraServer.

            
          

          - **ConfiguredSpareInstanceCount** *(integer) --* 

            The number of spare instances configured for this UltraServer to provide enhanced resiliency.

            
          

          - **AvailableInstanceCount** *(integer) --* 

            The number of instances currently available for use in this UltraServer.

            
          

          - **InUseInstanceCount** *(integer) --* 

            The number of instances currently in use in this UltraServer.

            
          

          - **AvailableSpareInstanceCount** *(integer) --* 

            The number of available spare instances in the UltraServer.

            
          

          - **UnhealthyInstanceCount** *(integer) --* 

            The number of instances in this UltraServer that are currently in an unhealthy state.

            
          

          - **HealthStatus** *(string) --* 

            The overall health status of the UltraServer.

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

  