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-optimization-job

Description

Creates a job that optimizes a model for inference performance. To create the job, you provide the location of a source model, and you provide the settings for the optimization techniques that you want the job to apply. When the job completes successfully, SageMaker uploads the new optimized model to the output destination that you specify.

For more information about how to use this action, and about the supported optimization techniques, see Optimize model inference with Amazon SageMaker .

See also: AWS API Documentation

Synopsis

  create-optimization-job
--optimization-job-name <value>
--role-arn <value>
--model-source <value>
--deployment-instance-type <value>
[--optimization-environment <value>]
--optimization-configs <value>
--output-config <value>
--stopping-condition <value>
[--tags <value>]
[--vpc-config <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

--optimization-job-name (string)

A custom name for the new optimization job.

--role-arn (string)

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

During model optimization, Amazon SageMaker needs your permission to:

  • Read input data from an S3 bucket
  • Write model artifacts to an S3 bucket
  • Write logs to Amazon CloudWatch Logs
  • Publish metrics to Amazon CloudWatch

You grant permissions for all of these tasks to an IAM role. To pass this role to Amazon SageMaker, the caller of this API must have the iam:PassRole permission. For more information, see Amazon SageMaker Roles.

--model-source (structure)

The location of the source model to optimize with an optimization job.

S3 -> (structure)

The Amazon S3 location of a source model to optimize with an optimization job.

S3Uri -> (string)

An Amazon S3 URI that locates a source model to optimize with an optimization job.

ModelAccessConfig -> (structure)

The access configuration settings for the source ML model for an optimization job, where you can accept the model end-user license agreement (EULA).

AcceptEula -> (boolean)

Specifies agreement to the model end-user license agreement (EULA). The AcceptEula value must be explicitly defined as True in order to accept the EULA that this model requires. You are responsible for reviewing and complying with any applicable license terms and making sure they are acceptable for your use case before downloading or using a model.

Shorthand Syntax:

S3={S3Uri=string,ModelAccessConfig={AcceptEula=boolean}}

JSON Syntax:

{
  "S3": {
    "S3Uri": "string",
    "ModelAccessConfig": {
      "AcceptEula": true|false
    }
  }
}

--deployment-instance-type (string)

The type of instance that hosts the optimized model that you create with the optimization job.

Possible values:

  • ml.p4d.24xlarge
  • ml.p4de.24xlarge
  • ml.p5.48xlarge
  • 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.g6.xlarge
  • ml.g6.2xlarge
  • ml.g6.4xlarge
  • ml.g6.8xlarge
  • ml.g6.12xlarge
  • ml.g6.16xlarge
  • ml.g6.24xlarge
  • ml.g6.48xlarge
  • ml.inf2.xlarge
  • ml.inf2.8xlarge
  • ml.inf2.24xlarge
  • ml.inf2.48xlarge
  • ml.trn1.2xlarge
  • ml.trn1.32xlarge
  • ml.trn1n.32xlarge

--optimization-environment (map)

The environment variables to set in the model container.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--optimization-configs (list)

Settings for each of the optimization techniques that the job applies.

(tagged union structure)

Settings for an optimization technique that you apply with a model optimization job.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: ModelQuantizationConfig, ModelCompilationConfig.

ModelQuantizationConfig -> (structure)

Settings for the model quantization technique that's applied by a model optimization job.

Image -> (string)

The URI of an LMI DLC in Amazon ECR. SageMaker uses this image to run the optimization.

OverrideEnvironment -> (map)

Environment variables that override the default ones in the model container.

key -> (string)

value -> (string)

ModelCompilationConfig -> (structure)

Settings for the model compilation technique that's applied by a model optimization job.

Image -> (string)

The URI of an LMI DLC in Amazon ECR. SageMaker uses this image to run the optimization.

OverrideEnvironment -> (map)

Environment variables that override the default ones in the model container.

key -> (string)

value -> (string)

Shorthand Syntax:

ModelQuantizationConfig={Image=string,OverrideEnvironment={KeyName1=string,KeyName2=string}},ModelCompilationConfig={Image=string,OverrideEnvironment={KeyName1=string,KeyName2=string}} ...

JSON Syntax:

[
  {
    "ModelQuantizationConfig": {
      "Image": "string",
      "OverrideEnvironment": {"string": "string"
        ...}
    },
    "ModelCompilationConfig": {
      "Image": "string",
      "OverrideEnvironment": {"string": "string"
        ...}
    }
  }
  ...
]

--output-config (structure)

Details for where to store the optimized model that you create with the optimization job.

KmsKeyId -> (string)

The Amazon Resource Name (ARN) of a key in Amazon Web Services KMS. SageMaker uses they key to encrypt the artifacts of the optimized model when SageMaker uploads the model to Amazon S3.

S3OutputLocation -> (string)

The Amazon S3 URI for where to store the optimized model that you create with an optimization job.

Shorthand Syntax:

KmsKeyId=string,S3OutputLocation=string

JSON Syntax:

{
  "KmsKeyId": "string",
  "S3OutputLocation": "string"
}

--stopping-condition (structure)

Specifies a limit to how long a job can run. When the job reaches the time limit, SageMaker ends the job. Use this API to cap costs.

To stop a training job, SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.

The training algorithms provided by SageMaker automatically save the intermediate results of a model training job when possible. This attempt to save artifacts is only a best effort case as model might not be in a state from which it can be saved. For example, if training has just started, the model might not be ready to save. When saved, this intermediate data is a valid model artifact. You can use it to create a model with CreateModel .

Note

The Neural Topic Model (NTM) currently does not support saving intermediate model artifacts. When training NTMs, make sure that the maximum runtime is sufficient for the training job to complete.

MaxRuntimeInSeconds -> (integer)

The maximum length of time, in seconds, that a training or compilation job can run before it is stopped.

For compilation jobs, if the job does not complete during this time, a TimeOut error is generated. We recommend starting with 900 seconds and increasing as necessary based on your model.

For all other jobs, if the job does not complete during this time, SageMaker ends the job. When RetryStrategy is specified in the job request, MaxRuntimeInSeconds specifies the maximum time for all of the attempts in total, not each individual attempt. The default value is 1 day. The maximum value is 28 days.

The maximum time that a TrainingJob can run in total, including any time spent publishing metrics or archiving and uploading models after it has been stopped, is 30 days.

MaxWaitTimeInSeconds -> (integer)

The maximum length of time, in seconds, that a managed Spot training job has to complete. It is the amount of time spent waiting for Spot capacity plus the amount of time the job can run. It must be equal to or greater than MaxRuntimeInSeconds . If the job does not complete during this time, SageMaker ends the job.

When RetryStrategy is specified in the job request, MaxWaitTimeInSeconds specifies the maximum time for all of the attempts in total, not each individual attempt.

MaxPendingTimeInSeconds -> (integer)

The maximum length of time, in seconds, that a training or compilation job can be pending before it is stopped.

Shorthand Syntax:

MaxRuntimeInSeconds=integer,MaxWaitTimeInSeconds=integer,MaxPendingTimeInSeconds=integer

JSON Syntax:

{
  "MaxRuntimeInSeconds": integer,
  "MaxWaitTimeInSeconds": integer,
  "MaxPendingTimeInSeconds": integer
}

--tags (list)

A list of key-value pairs associated with the optimization job. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide .

(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"
  }
  ...
]

--vpc-config (structure)

A VPC in Amazon VPC that your optimized model has access to.

SecurityGroupIds -> (list)

The VPC security group IDs, in the form sg-xxxxxxxx . Specify the security groups for the VPC that is specified in the Subnets field.

(string)

Subnets -> (list)

The ID of the subnets in the VPC to which you want to connect your optimized model.

(string)

Shorthand Syntax:

SecurityGroupIds=string,string,Subnets=string,string

JSON Syntax:

{
  "SecurityGroupIds": ["string", ...],
  "Subnets": ["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.

--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

OptimizationJobArn -> (string)

The Amazon Resource Name (ARN) of the optimization job.