AWS API Changes

2025/08/13 - Amazon SageMaker Service - 4 updated api methods

Changes This release introduces compute quota for GPU, Trainium accelerators, vCPU, and vCPU memory utilization across teams in HyperPod clusters

CreateComputeQuota (updated)

Link ¶
Changes (request)

{'ComputeQuotaConfig': {'ComputeQuotaResources': {'Accelerators': 'integer',
                                                  'MemoryInGiB': 'float',
                                                  'VCpu': 'float'}}}

Create compute allocation definition. This defines how compute is allocated, shared, and borrowed for specified entities. Specifically, how to lend and borrow idle compute and assign a fair-share weight to the specified entities.

See also: AWS API Documentation

Request Syntax

client.create_compute_quota(
    Name='string',
    Description='string',
    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.p6-b200.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'|'ml.i3en.large'|'ml.i3en.xlarge'|'ml.i3en.2xlarge'|'ml.i3en.3xlarge'|'ml.i3en.6xlarge'|'ml.i3en.12xlarge'|'ml.i3en.24xlarge'|'ml.m7i.large'|'ml.m7i.xlarge'|'ml.m7i.2xlarge'|'ml.m7i.4xlarge'|'ml.m7i.8xlarge'|'ml.m7i.12xlarge'|'ml.m7i.16xlarge'|'ml.m7i.24xlarge'|'ml.m7i.48xlarge'|'ml.r7i.large'|'ml.r7i.xlarge'|'ml.r7i.2xlarge'|'ml.r7i.4xlarge'|'ml.r7i.8xlarge'|'ml.r7i.12xlarge'|'ml.r7i.16xlarge'|'ml.r7i.24xlarge'|'ml.r7i.48xlarge',
                'Count': 123,
                'Accelerators': 123,
                'VCpu': ...,
                'MemoryInGiB': ...
            },
        ],
        'ResourceSharingConfig': {
            'Strategy': 'Lend'|'DontLend'|'LendAndBorrow',
            'BorrowLimit': 123
        },
        'PreemptTeamTasks': 'Never'|'LowerPriority'
    },
    ComputeQuotaTarget={
        'TeamName': 'string',
        'FairShareWeight': 123
    },
    ActivationState='Enabled'|'Disabled',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

type Name:

string

param Name:

[REQUIRED]

Name to the compute allocation definition.

type Description:

string

param Description:

Description of the compute allocation definition.

type ClusterArn:

string

param ClusterArn:

[REQUIRED]

ARN of the cluster.

type ComputeQuotaConfig:

dict

param ComputeQuotaConfig:

[REQUIRED]

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) -- [REQUIRED]
    
    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.
  - Accelerators (integer) --
    
    The number of accelerators to allocate. If you don't specify a value for vCPU and MemoryInGiB, SageMaker AI automatically allocates ratio-based values for those parameters based on the number of accelerators you provide. For example, if you allocate 16 out of 32 total accelerators, SageMaker AI uses the ratio of 0.5 and allocates values to vCPU and MemoryInGiB.
  - VCpu (float) --
    
    The number of vCPU to allocate. If you specify a value only for vCPU, SageMaker AI automatically allocates ratio-based values for MemoryInGiB based on this vCPU parameter. For example, if you allocate 20 out of 40 total vCPU, SageMaker AI uses the ratio of 0.5 and allocates values to MemoryInGiB. Accelerators are set to 0.
  - MemoryInGiB (float) --
    
    The amount of memory in GiB to allocate. If you specify a value only for this parameter, SageMaker AI automatically allocates a ratio-based value for vCPU based on this memory that you provide. For example, if you allocate 200 out of 400 total memory in GiB, SageMaker AI uses the ratio of 0.5 and allocates values to vCPU. Accelerators are set to 0.
ResourceSharingConfig (dict) --

Resource sharing configuration. This defines how an entity can lend and borrow idle compute with other entities within the cluster.
- Strategy (string) -- [REQUIRED]
  
  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.

type ComputeQuotaTarget:

dict

param ComputeQuotaTarget:

[REQUIRED]

The target entity to allocate compute resources to.

TeamName (string) -- [REQUIRED]

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.

type ActivationState:

string

param ActivationState:

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

Default is Enabled.

type Tags:

list

param Tags:

Tags of the compute allocation definition.

(dict) --

A tag object that consists of a key and an optional value, used to manage metadata for SageMaker Amazon Web Services resources.

You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. For more information on adding tags to SageMaker resources, see AddTags.

For more information on adding metadata to your Amazon Web Services resources with tagging, see Tagging Amazon Web Services resources. For advice on best practices for managing Amazon Web Services resources with tagging, see Tagging Best Practices: Implement an Effective Amazon Web Services Resource Tagging Strategy.
- Key (string) -- [REQUIRED]
  
  The tag key. Tag keys must be unique per resource.
- Value (string) -- [REQUIRED]
  
  The tag value.

rtype:

dict

returns:

Response Syntax

{
    'ComputeQuotaArn': 'string',
    'ComputeQuotaId': 'string'
}

Response Structure

(dict) --
- ComputeQuotaArn (string) --
  
  ARN of the compute allocation definition.
- ComputeQuotaId (string) --
  
  ID of the compute allocation definition.

DescribeComputeQuota (updated)

Link ¶
Changes (response)

{'ComputeQuotaConfig': {'ComputeQuotaResources': {'Accelerators': 'integer',
                                                  'MemoryInGiB': 'float',
                                                  'VCpu': 'float'}}}

Description of the compute allocation definition.

See also: AWS API Documentation

Request Syntax

client.describe_compute_quota(
    ComputeQuotaId='string',
    ComputeQuotaVersion=123
)

type ComputeQuotaId:

string

param ComputeQuotaId:

[REQUIRED]

ID of the compute allocation definition.

type ComputeQuotaVersion:

integer

param ComputeQuotaVersion:

Version of the compute allocation definition.

rtype:

dict

returns:

Response Syntax

{
    'ComputeQuotaArn': 'string',
    'ComputeQuotaId': 'string',
    'Name': 'string',
    'Description': 'string',
    'ComputeQuotaVersion': 123,
    'Status': 'Creating'|'CreateFailed'|'CreateRollbackFailed'|'Created'|'Updating'|'UpdateFailed'|'UpdateRollbackFailed'|'Updated'|'Deleting'|'DeleteFailed'|'DeleteRollbackFailed'|'Deleted',
    'FailureReason': 'string',
    '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.p6-b200.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'|'ml.i3en.large'|'ml.i3en.xlarge'|'ml.i3en.2xlarge'|'ml.i3en.3xlarge'|'ml.i3en.6xlarge'|'ml.i3en.12xlarge'|'ml.i3en.24xlarge'|'ml.m7i.large'|'ml.m7i.xlarge'|'ml.m7i.2xlarge'|'ml.m7i.4xlarge'|'ml.m7i.8xlarge'|'ml.m7i.12xlarge'|'ml.m7i.16xlarge'|'ml.m7i.24xlarge'|'ml.m7i.48xlarge'|'ml.r7i.large'|'ml.r7i.xlarge'|'ml.r7i.2xlarge'|'ml.r7i.4xlarge'|'ml.r7i.8xlarge'|'ml.r7i.12xlarge'|'ml.r7i.16xlarge'|'ml.r7i.24xlarge'|'ml.r7i.48xlarge',
                'Count': 123,
                'Accelerators': 123,
                'VCpu': ...,
                'MemoryInGiB': ...
            },
        ],
        'ResourceSharingConfig': {
            'Strategy': 'Lend'|'DontLend'|'LendAndBorrow',
            'BorrowLimit': 123
        },
        'PreemptTeamTasks': 'Never'|'LowerPriority'
    },
    'ComputeQuotaTarget': {
        'TeamName': 'string',
        'FairShareWeight': 123
    },
    'ActivationState': 'Enabled'|'Disabled',
    'CreationTime': datetime(2015, 1, 1),
    'CreatedBy': {
        'UserProfileArn': 'string',
        'UserProfileName': 'string',
        'DomainId': 'string',
        'IamIdentity': {
            'Arn': 'string',
            'PrincipalId': 'string',
            'SourceIdentity': 'string'
        }
    },
    'LastModifiedTime': datetime(2015, 1, 1),
    'LastModifiedBy': {
        'UserProfileArn': 'string',
        'UserProfileName': 'string',
        'DomainId': 'string',
        'IamIdentity': {
            'Arn': 'string',
            'PrincipalId': 'string',
            'SourceIdentity': 'string'
        }
    }
}

Response Structure

(dict) --
- ComputeQuotaArn (string) --
  
  ARN of the compute allocation definition.
- ComputeQuotaId (string) --
  
  ID of the compute allocation definition.
- Name (string) --
  
  Name of the compute allocation definition.
- Description (string) --
  
  Description of the compute allocation definition.
- ComputeQuotaVersion (integer) --
  
  Version of the compute allocation definition.
- Status (string) --
  
  Status of the compute allocation definition.
- FailureReason (string) --
  
  Failure reason 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.
      - Accelerators (integer) --
        
        The number of accelerators to allocate. If you don't specify a value for vCPU and MemoryInGiB, SageMaker AI automatically allocates ratio-based values for those parameters based on the number of accelerators you provide. For example, if you allocate 16 out of 32 total accelerators, SageMaker AI uses the ratio of 0.5 and allocates values to vCPU and MemoryInGiB.
      - VCpu (float) --
        
        The number of vCPU to allocate. If you specify a value only for vCPU, SageMaker AI automatically allocates ratio-based values for MemoryInGiB based on this vCPU parameter. For example, if you allocate 20 out of 40 total vCPU, SageMaker AI uses the ratio of 0.5 and allocates values to MemoryInGiB. Accelerators are set to 0.
      - MemoryInGiB (float) --
        
        The amount of memory in GiB to allocate. If you specify a value only for this parameter, SageMaker AI automatically allocates a ratio-based value for vCPU based on this memory that you provide. For example, if you allocate 200 out of 400 total memory in GiB, SageMaker AI uses the ratio of 0.5 and allocates values to vCPU. Accelerators are set to 0.
  - 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 configuration.
- CreatedBy (dict) --
  
  Information about the user who created or modified a SageMaker resource.
  - UserProfileArn (string) --
    
    The Amazon Resource Name (ARN) of the user's profile.
  - UserProfileName (string) --
    
    The name of the user's profile.
  - DomainId (string) --
    
    The domain associated with the user.
  - IamIdentity (dict) --
    
    The IAM Identity details associated with the user. These details are associated with model package groups, model packages, and project entities only.
    - Arn (string) --
      
      The Amazon Resource Name (ARN) of the IAM identity.
    - PrincipalId (string) --
      
      The ID of the principal that assumes the IAM identity.
    - SourceIdentity (string) --
      
      The person or application which assumes the IAM identity.
- LastModifiedTime (datetime) --
  
  Last modified time of the compute allocation configuration.
- LastModifiedBy (dict) --
  
  Information about the user who created or modified a SageMaker resource.
  - UserProfileArn (string) --
    
    The Amazon Resource Name (ARN) of the user's profile.
  - UserProfileName (string) --
    
    The name of the user's profile.
  - DomainId (string) --
    
    The domain associated with the user.
  - IamIdentity (dict) --
    
    The IAM Identity details associated with the user. These details are associated with model package groups, model packages, and project entities only.
    - Arn (string) --
      
      The Amazon Resource Name (ARN) of the IAM identity.
    - PrincipalId (string) --
      
      The ID of the principal that assumes the IAM identity.
    - SourceIdentity (string) --
      
      The person or application which assumes the IAM identity.

ListComputeQuotas (updated)

Link ¶
Changes (response)

{'ComputeQuotaSummaries': {'ComputeQuotaConfig': {'ComputeQuotaResources': {'Accelerators': 'integer',
                                                                            'MemoryInGiB': 'float',
                                                                            'VCpu': 'float'}}}}

List the resource allocation definitions.

See also: AWS API Documentation

Request Syntax

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
)

type CreatedAfter:

datetime

param CreatedAfter:

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.

type CreatedBefore:

datetime

param CreatedBefore:

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.

type NameContains:

string

param NameContains:

Filter for name containing this string.

type Status:

string

param Status:

Filter for status.

type ClusterArn:

string

param ClusterArn:

Filter for ARN of the cluster.

type SortBy:

string

param SortBy:

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

type SortOrder:

string

param SortOrder:

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.

type NextToken:

string

param NextToken:

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

type MaxResults:

integer

param MaxResults:

The maximum number of compute allocation definitions to list.

rtype:

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.p6-b200.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'|'ml.i3en.large'|'ml.i3en.xlarge'|'ml.i3en.2xlarge'|'ml.i3en.3xlarge'|'ml.i3en.6xlarge'|'ml.i3en.12xlarge'|'ml.i3en.24xlarge'|'ml.m7i.large'|'ml.m7i.xlarge'|'ml.m7i.2xlarge'|'ml.m7i.4xlarge'|'ml.m7i.8xlarge'|'ml.m7i.12xlarge'|'ml.m7i.16xlarge'|'ml.m7i.24xlarge'|'ml.m7i.48xlarge'|'ml.r7i.large'|'ml.r7i.xlarge'|'ml.r7i.2xlarge'|'ml.r7i.4xlarge'|'ml.r7i.8xlarge'|'ml.r7i.12xlarge'|'ml.r7i.16xlarge'|'ml.r7i.24xlarge'|'ml.r7i.48xlarge',
                        'Count': 123,
                        'Accelerators': 123,
                        'VCpu': ...,
                        'MemoryInGiB': ...
                    },
                ],
                '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.
        
        Accelerators (integer) --
        
        The number of accelerators to allocate. If you don't specify a value for vCPU and MemoryInGiB, SageMaker AI automatically allocates ratio-based values for those parameters based on the number of accelerators you provide. For example, if you allocate 16 out of 32 total accelerators, SageMaker AI uses the ratio of 0.5 and allocates values to vCPU and MemoryInGiB.
        
        VCpu (float) --
        
        The number of vCPU to allocate. If you specify a value only for vCPU, SageMaker AI automatically allocates ratio-based values for MemoryInGiB based on this vCPU parameter. For example, if you allocate 20 out of 40 total vCPU, SageMaker AI uses the ratio of 0.5 and allocates values to MemoryInGiB. Accelerators are set to 0.
        
        MemoryInGiB (float) --
        
        The amount of memory in GiB to allocate. If you specify a value only for this parameter, SageMaker AI automatically allocates a ratio-based value for vCPU based on this memory that you provide. For example, if you allocate 200 out of 400 total memory in GiB, SageMaker AI uses the ratio of 0.5 and allocates values to vCPU. Accelerators are set to 0.
      - 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.

UpdateComputeQuota (updated)

Link ¶
Changes (request)

{'ComputeQuotaConfig': {'ComputeQuotaResources': {'Accelerators': 'integer',
                                                  'MemoryInGiB': 'float',
                                                  'VCpu': 'float'}}}

Update the compute allocation definition.

See also: AWS API Documentation

Request Syntax

client.update_compute_quota(
    ComputeQuotaId='string',
    TargetVersion=123,
    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.p6-b200.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'|'ml.i3en.large'|'ml.i3en.xlarge'|'ml.i3en.2xlarge'|'ml.i3en.3xlarge'|'ml.i3en.6xlarge'|'ml.i3en.12xlarge'|'ml.i3en.24xlarge'|'ml.m7i.large'|'ml.m7i.xlarge'|'ml.m7i.2xlarge'|'ml.m7i.4xlarge'|'ml.m7i.8xlarge'|'ml.m7i.12xlarge'|'ml.m7i.16xlarge'|'ml.m7i.24xlarge'|'ml.m7i.48xlarge'|'ml.r7i.large'|'ml.r7i.xlarge'|'ml.r7i.2xlarge'|'ml.r7i.4xlarge'|'ml.r7i.8xlarge'|'ml.r7i.12xlarge'|'ml.r7i.16xlarge'|'ml.r7i.24xlarge'|'ml.r7i.48xlarge',
                'Count': 123,
                'Accelerators': 123,
                'VCpu': ...,
                'MemoryInGiB': ...
            },
        ],
        'ResourceSharingConfig': {
            'Strategy': 'Lend'|'DontLend'|'LendAndBorrow',
            'BorrowLimit': 123
        },
        'PreemptTeamTasks': 'Never'|'LowerPriority'
    },
    ComputeQuotaTarget={
        'TeamName': 'string',
        'FairShareWeight': 123
    },
    ActivationState='Enabled'|'Disabled',
    Description='string'
)

type ComputeQuotaId:

string

param ComputeQuotaId:

[REQUIRED]

ID of the compute allocation definition.

type TargetVersion:

integer

param TargetVersion:

[REQUIRED]

Target version.

type ComputeQuotaConfig:

dict

param ComputeQuotaConfig:

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) -- [REQUIRED]
    
    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.
  - Accelerators (integer) --
    
    The number of accelerators to allocate. If you don't specify a value for vCPU and MemoryInGiB, SageMaker AI automatically allocates ratio-based values for those parameters based on the number of accelerators you provide. For example, if you allocate 16 out of 32 total accelerators, SageMaker AI uses the ratio of 0.5 and allocates values to vCPU and MemoryInGiB.
  - VCpu (float) --
    
    The number of vCPU to allocate. If you specify a value only for vCPU, SageMaker AI automatically allocates ratio-based values for MemoryInGiB based on this vCPU parameter. For example, if you allocate 20 out of 40 total vCPU, SageMaker AI uses the ratio of 0.5 and allocates values to MemoryInGiB. Accelerators are set to 0.
  - MemoryInGiB (float) --
    
    The amount of memory in GiB to allocate. If you specify a value only for this parameter, SageMaker AI automatically allocates a ratio-based value for vCPU based on this memory that you provide. For example, if you allocate 200 out of 400 total memory in GiB, SageMaker AI uses the ratio of 0.5 and allocates values to vCPU. Accelerators are set to 0.
ResourceSharingConfig (dict) --

Resource sharing configuration. This defines how an entity can lend and borrow idle compute with other entities within the cluster.
- Strategy (string) -- [REQUIRED]
  
  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.

type ComputeQuotaTarget:

dict

param ComputeQuotaTarget:

The target entity to allocate compute resources to.

TeamName (string) -- [REQUIRED]

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.

type ActivationState:

string

param ActivationState:

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

Default is Enabled.

type Description:

string

param Description:

Description of the compute allocation definition.

rtype:

dict

returns:

Response Syntax

{
    'ComputeQuotaArn': 'string',
    'ComputeQuotaVersion': 123
}

Response Structure

(dict) --
- ComputeQuotaArn (string) --
  
  ARN of the compute allocation definition.
- ComputeQuotaVersion (integer) --
  
  Version of the compute allocation definition.