SageMaker / Client / list_compute_quotas

list_compute_quotas#

SageMaker.Client.list_compute_quotas(**kwargs)#

List the resource allocation definitions.

See also: AWS API Documentation

Request Syntax

response = client.list_compute_quotas(
    CreatedAfter=datetime(2015, 1, 1),
    CreatedBefore=datetime(2015, 1, 1),
    NameContains='string',
    Status='Creating'|'CreateFailed'|'CreateRollbackFailed'|'Created'|'Updating'|'UpdateFailed'|'UpdateRollbackFailed'|'Updated'|'Deleting'|'DeleteFailed'|'DeleteRollbackFailed'|'Deleted',
    ClusterArn='string',
    SortBy='Name'|'CreationTime'|'Status'|'ClusterArn',
    SortOrder='Ascending'|'Descending',
    NextToken='string',
    MaxResults=123
)
Parameters:

  • CreatedAfter (datetime) – 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.

  • CreatedBefore (datetime) – 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.

  • NameContains (string) – Filter for name containing this string.

  • Status (string) – Filter for status.

  • ClusterArn (string) – Filter for ARN of the cluster.

  • SortBy (string) – Filter for sorting the list by a given value. For example, sort by name, creation time, or status.

  • SortOrder (string) – 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.

  • NextToken (string) – If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

  • MaxResults (integer) – The maximum number of compute allocation definitions to list.

Return type:

dict

Returns:

Response Syntax

{
    'ComputeQuotaSummaries': [
        {
            'ComputeQuotaArn': 'string',
            'ComputeQuotaId': 'string',
            'Name': 'string',
            'ComputeQuotaVersion': 123,
            'Status': 'Creating'|'CreateFailed'|'CreateRollbackFailed'|'Created'|'Updating'|'UpdateFailed'|'UpdateRollbackFailed'|'Updated'|'Deleting'|'DeleteFailed'|'DeleteRollbackFailed'|'Deleted',
            'ClusterArn': 'string',
            'ComputeQuotaConfig': {
                'ComputeQuotaResources': [
                    {
                        'InstanceType': 'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.p5.48xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.12xlarge'|'ml.g5.16xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.c5n.large'|'ml.c5n.2xlarge'|'ml.c5n.4xlarge'|'ml.c5n.9xlarge'|'ml.c5n.18xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.g6.xlarge'|'ml.g6.2xlarge'|'ml.g6.4xlarge'|'ml.g6.8xlarge'|'ml.g6.16xlarge'|'ml.g6.12xlarge'|'ml.g6.24xlarge'|'ml.g6.48xlarge'|'ml.gr6.4xlarge'|'ml.gr6.8xlarge'|'ml.g6e.xlarge'|'ml.g6e.2xlarge'|'ml.g6e.4xlarge'|'ml.g6e.8xlarge'|'ml.g6e.16xlarge'|'ml.g6e.12xlarge'|'ml.g6e.24xlarge'|'ml.g6e.48xlarge'|'ml.p5e.48xlarge'|'ml.p5en.48xlarge'|'ml.trn2.48xlarge'|'ml.c6i.large'|'ml.c6i.xlarge'|'ml.c6i.2xlarge'|'ml.c6i.4xlarge'|'ml.c6i.8xlarge'|'ml.c6i.12xlarge'|'ml.c6i.16xlarge'|'ml.c6i.24xlarge'|'ml.c6i.32xlarge'|'ml.m6i.large'|'ml.m6i.xlarge'|'ml.m6i.2xlarge'|'ml.m6i.4xlarge'|'ml.m6i.8xlarge'|'ml.m6i.12xlarge'|'ml.m6i.16xlarge'|'ml.m6i.24xlarge'|'ml.m6i.32xlarge'|'ml.r6i.large'|'ml.r6i.xlarge'|'ml.r6i.2xlarge'|'ml.r6i.4xlarge'|'ml.r6i.8xlarge'|'ml.r6i.12xlarge'|'ml.r6i.16xlarge'|'ml.r6i.24xlarge'|'ml.r6i.32xlarge',
                        'Count': 123
                    },
                ],
                'ResourceSharingConfig': {
                    'Strategy': 'Lend'|'DontLend'|'LendAndBorrow',
                    'BorrowLimit': 123
                },
                'PreemptTeamTasks': 'Never'|'LowerPriority'
            },
            'ComputeQuotaTarget': {
                'TeamName': 'string',
                'FairShareWeight': 123
            },
            'ActivationState': 'Enabled'|'Disabled',
            'CreationTime': datetime(2015, 1, 1),
            'LastModifiedTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • ComputeQuotaSummaries (list) –

      Summaries of the compute allocation definitions.

      • (dict) –

        Summary of the compute allocation definition.

        • ComputeQuotaArn (string) –

          ARN of the compute allocation definition.

        • ComputeQuotaId (string) –

          ID of the compute allocation definition.

        • Name (string) –

          Name of the compute allocation definition.

        • ComputeQuotaVersion (integer) –

          Version of the compute allocation definition.

        • Status (string) –

          Status of the compute allocation definition.

        • ClusterArn (string) –

          ARN of the cluster.

        • ComputeQuotaConfig (dict) –

          Configuration of the compute allocation definition. This includes the resource sharing option, and the setting to preempt low priority tasks.

          • ComputeQuotaResources (list) –

            Allocate compute resources by instance types.

            • (dict) –

              Configuration of the resources used for the compute allocation definition.

              • InstanceType (string) –

                The instance type of the instance group for the cluster.

              • Count (integer) –

                The number of instances to add to the instance group of a SageMaker HyperPod cluster.

          • ResourceSharingConfig (dict) –

            Resource sharing configuration. This defines how an entity can lend and borrow idle compute with other entities within the cluster.

            • Strategy (string) –

              The strategy of how idle compute is shared within the cluster. The following are the options of strategies.

              • DontLend: entities do not lend idle compute.

              • Lend: entities can lend idle compute to entities that can borrow.

              • LendandBorrow: entities can lend idle compute and borrow idle compute from other entities.

              Default is LendandBorrow.

            • BorrowLimit (integer) –

              The limit on how much idle compute can be borrowed.The values can be 1 - 500 percent of idle compute that the team is allowed to borrow.

              Default is 50.

          • PreemptTeamTasks (string) –

            Allows workloads from within an entity to preempt same-team workloads. When set to LowerPriority, the entity’s lower priority tasks are preempted by their own higher priority tasks.

            Default is LowerPriority.

        • ComputeQuotaTarget (dict) –

          The target entity to allocate compute resources to.

          • TeamName (string) –

            Name of the team to allocate compute resources to.

          • FairShareWeight (integer) –

            Assigned entity fair-share weight. Idle compute will be shared across entities based on these assigned weights. This weight is only used when FairShare is enabled.

            A weight of 0 is the lowest priority and 100 is the highest. Weight 0 is the default.

        • ActivationState (string) –

          The state of the compute allocation being described. Use to enable or disable compute allocation.

          Default is Enabled.

        • CreationTime (datetime) –

          Creation time of the compute allocation definition.

        • LastModifiedTime (datetime) –

          Last modified time of the compute allocation definition.

    • NextToken (string) –

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