AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . sagemaker ]

create-compute-quota

Description

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

Synopsis

  create-compute-quota
--name <value>
[--description <value>]
--cluster-arn <value>
--compute-quota-config <value>
--compute-quota-target <value>
[--activation-state <value>]
[--tags <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--name (string)

Name to the compute allocation definition.

--description (string)

Description of the compute allocation definition.

--cluster-arn (string)

ARN of the cluster.

--compute-quota-config (structure)

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.

(structure)

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 -> (structure)

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 .

Shorthand Syntax:

ComputeQuotaResources=[{InstanceType=string,Count=integer},{InstanceType=string,Count=integer}],ResourceSharingConfig={Strategy=string,BorrowLimit=integer},PreemptTeamTasks=string

JSON Syntax:

{
  "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",
      "Count": integer
    }
    ...
  ],
  "ResourceSharingConfig": {
    "Strategy": "Lend"|"DontLend"|"LendAndBorrow",
    "BorrowLimit": integer
  },
  "PreemptTeamTasks": "Never"|"LowerPriority"
}

--compute-quota-target (structure)

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.

Shorthand Syntax:

TeamName=string,FairShareWeight=integer

JSON Syntax:

{
  "TeamName": "string",
  "FairShareWeight": integer
}

--activation-state (string)

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

Default is Enabled .

Possible values:

  • Enabled
  • Disabled

--tags (list)

Tags of the compute allocation definition.

(structure)

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)

The tag key. Tag keys must be unique per resource.

Value -> (string)

The tag value.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

ComputeQuotaArn -> (string)

ARN of the compute allocation definition.

ComputeQuotaId -> (string)

ID of the compute allocation definition.