Skip to content

list_ultra_servers_by_reserved_capacity

list_ultra_servers_by_reserved_capacity(
    *,
    config_overrides: Optional[SageMakerClientConfig] = None,
    reserved_capacity_arn: Optional[ReservedCapacityArn] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[NextToken] = None,
) -> ListUltraServersByReservedCapacityResponse

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

Parameters:

  • reserved_capacity_arn (Optional[ReservedCapacityArn], default: None ) –

    The ARN of the reserved capacity to list UltraServers for.

  • max_results (Optional[MaxResults], default: None ) –

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

  • next_token (Optional[NextToken], default: None ) –

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

Raises:

Source code in docs_src/capo_sagemaker/_services/sage_maker.py
def list_ultra_servers_by_reserved_capacity(
    self,
    *,
    config_overrides: Optional[SageMakerClientConfig] = None,
    reserved_capacity_arn: Optional[
        "capo_sagemaker.types.reserved_capacity_arn.ReservedCapacityArn"
    ] = None,
    max_results: Optional["capo_sagemaker.types.max_results.MaxResults"] = None,
    next_token: Optional["capo_sagemaker.types.next_token.NextToken"] = None,
) -> "capo_sagemaker.types.list_ultra_servers_by_reserved_capacity_response.ListUltraServersByReservedCapacityResponse":
    """<p>Lists all UltraServers that are part of a specified reserved capacity.</p>

    Args:
        reserved_capacity_arn: <p>The ARN of the reserved capacity to list UltraServers for.</p>
        max_results: <p>The maximum number of UltraServers to return in the response. The default value is 10.</p>
        next_token: <p>If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.</p>

    Raises:
        capo_sagemaker.errors.resource_not_found.ResourceNotFound: <p>Resource being access is not found.</p>
        capo_sagemaker.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_sagemaker.types.list_ultra_servers_by_reserved_capacity_request.ListUltraServersByReservedCapacityRequest]",
    ) -> OperationResponse[
        "capo_sagemaker.types.list_ultra_servers_by_reserved_capacity_response.ListUltraServersByReservedCapacityResponse"
    ]:
        import capo_sagemaker._operations.sage_maker.list_ultra_servers_by_reserved_capacity

        output, http_response = (
            capo_sagemaker._operations.sage_maker.list_ultra_servers_by_reserved_capacity.list_ultra_servers_by_reserved_capacity(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListUltraServersByReservedCapacity")
    )
    input_: capo_sagemaker.types.list_ultra_servers_by_reserved_capacity_request.ListUltraServersByReservedCapacityRequest = {}
    if reserved_capacity_arn is not None:
        input_["reserved_capacity_arn"] = reserved_capacity_arn
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output