Skip to content

list_compute_quotas

list_compute_quotas(
    *,
    config_overrides: Optional[SageMakerClientConfig] = None,
    created_after: Optional[Timestamp] = None,
    created_before: Optional[Timestamp] = None,
    name_contains: Optional[EntityName] = None,
    status: Optional[SchedulerResourceStatus] = None,
    cluster_arn: Optional[ClusterArn] = None,
    sort_by: Optional[SortQuotaBy] = None,
    sort_order: Optional[SortOrder] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[MaxResults] = None,
) -> ListComputeQuotasResponse

List the resource allocation definitions.

Parameters:

  • created_after (Optional[Timestamp], default: None ) –

    Filter for after this creation time. The input for this parameter is a Unix timestamp. To convert a date and time into a Unix timestamp, see EpochConverter.

  • created_before (Optional[Timestamp], default: None ) –

    Filter for before this creation time. The input for this parameter is a Unix timestamp. To convert a date and time into a Unix timestamp, see EpochConverter.

  • name_contains (Optional[EntityName], default: None ) –

    Filter for name containing this string.

  • status (Optional[SchedulerResourceStatus], default: None ) –

    Filter for status.

  • cluster_arn (Optional[ClusterArn], default: None ) –

    Filter for ARN of the cluster.

  • sort_by (Optional[SortQuotaBy], default: None ) –

    Filter for sorting the list by a given value. For example, sort by name, creation time, or status.

  • sort_order (Optional[SortOrder], default: None ) –

    The order of the list. By default, listed in Descending order according to by SortBy. To change the list order, you can specify SortOrder to be Ascending.

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

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

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

    The maximum number of compute allocation definitions to list.

Raises:

Source code in docs_src/capo_sagemaker/_services/sage_maker.py
def list_compute_quotas(
    self,
    *,
    config_overrides: Optional[SageMakerClientConfig] = None,
    created_after: Optional["capo_sagemaker.types.timestamp.Timestamp"] = None,
    created_before: Optional["capo_sagemaker.types.timestamp.Timestamp"] = None,
    name_contains: Optional["capo_sagemaker.types.entity_name.EntityName"] = None,
    status: Optional[
        "capo_sagemaker.types.scheduler_resource_status.SchedulerResourceStatus"
    ] = None,
    cluster_arn: Optional["capo_sagemaker.types.cluster_arn.ClusterArn"] = None,
    sort_by: Optional["capo_sagemaker.types.sort_quota_by.SortQuotaBy"] = None,
    sort_order: Optional["capo_sagemaker.types.sort_order.SortOrder"] = None,
    next_token: Optional["capo_sagemaker.types.next_token.NextToken"] = None,
    max_results: Optional["capo_sagemaker.types.max_results.MaxResults"] = None,
) -> "capo_sagemaker.types.list_compute_quotas_response.ListComputeQuotasResponse":
    """<p>List the resource allocation definitions.</p>

    Args:
        created_after: <p>Filter for after this creation time. The input for this parameter is a Unix timestamp. To convert a date and time into a Unix timestamp, see <a href="https://www.epochconverter.com/">EpochConverter</a>.</p>
        created_before: <p>Filter for before this creation time. The input for this parameter is a Unix timestamp. To convert a date and time into a Unix timestamp, see <a href="https://www.epochconverter.com/">EpochConverter</a>.</p>
        name_contains: <p>Filter for name containing this string.</p>
        status: <p>Filter for status.</p>
        cluster_arn: <p>Filter for ARN of the cluster.</p>
        sort_by: <p>Filter for sorting the list by a given value. For example, sort by name, creation time, or status.</p>
        sort_order: <p>The order of the list. By default, listed in <code>Descending</code> order according to by <code>SortBy</code>. To change the list order, you can specify <code>SortOrder</code> to be <code>Ascending</code>.</p>
        next_token: <p>If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.</p>
        max_results: <p>The maximum number of compute allocation definitions to list.</p>

    Raises:
        capo_sagemaker.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_sagemaker.types.list_compute_quotas_request.ListComputeQuotasRequest]",
    ) -> OperationResponse[
        "capo_sagemaker.types.list_compute_quotas_response.ListComputeQuotasResponse"
    ]:
        import capo_sagemaker._operations.sage_maker.list_compute_quotas

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListComputeQuotas")
    )
    input_: capo_sagemaker.types.list_compute_quotas_request.ListComputeQuotasRequest = {}
    if created_after is not None:
        input_["created_after"] = created_after
    if created_before is not None:
        input_["created_before"] = created_before
    if name_contains is not None:
        input_["name_contains"] = name_contains
    if status is not None:
        input_["status"] = status
    if cluster_arn is not None:
        input_["cluster_arn"] = cluster_arn
    if sort_by is not None:
        input_["sort_by"] = sort_by
    if sort_order is not None:
        input_["sort_order"] = sort_order
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

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