AWS CLI Command Reference

[ aws . sagemaker ]

create-ai-benchmark-job

Description

Creates a benchmark job that runs performance benchmarks against inference infrastructure using a predefined AI workload configuration. The benchmark job measures metrics such as latency, throughput, and cost for your generative AI inference endpoints.

See also: AWS API Documentation

Synopsis

  create-ai-benchmark-job
--ai-benchmark-job-name <value>
--benchmark-target <value>
--output-config <value>
--ai-workload-config-identifier <value>
--role-arn <value>
[--network-config <value>]
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options

--ai-benchmark-job-name (string) [required]

The name of the AI benchmark job. The name must be unique within your Amazon Web Services account in the current Amazon Web Services Region.

Constraints:

  • min: 1
  • max: 63
  • pattern: [a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}

--benchmark-target (tagged union structure) [required]

The target endpoint to benchmark. Specify a SageMaker endpoint by providing its name or Amazon Resource Name (ARN).

Note

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

Endpoint -> (structure)

The SageMaker endpoint to benchmark.

Identifier -> (string) [required]

The name or Amazon Resource Name (ARN) of the SageMaker endpoint to benchmark.

Constraints:

  • min: 1
  • max: 256
  • pattern: (arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:[a-z\-]*/)?([a-zA-Z0-9]([a-zA-Z0-9\-]){0,62})(?<!-)

TargetContainerHostname -> (string)

The hostname of the specific container to target within a multi-container endpoint.

InferenceComponents -> (list)

The list of inference components to benchmark on the endpoint.

(structure)

An inference component to benchmark.

Identifier -> (string) [required]

The name or Amazon Resource Name (ARN) of the inference component.

Constraints:

  • min: 1
  • max: 256
  • pattern: (arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:[a-z\-]*/)?([a-zA-Z0-9]([a-zA-Z0-9\-]){0,62})(?<!-)

JSON Syntax:

{
  "Endpoint": {
    "Identifier": "string",
    "TargetContainerHostname": "string",
    "InferenceComponents": [
      {
        "Identifier": "string"
      }
      ...
    ]
  }
}

--output-config (structure) [required]

The output configuration for the benchmark job, including the Amazon S3 location where benchmark results are stored.

S3OutputLocation -> (string) [required]

The Amazon S3 URI where benchmark results are stored.

Constraints:

  • min: 0
  • max: 1024
  • pattern: (https|s3)://([^/]+)/?(.*)

Shorthand Syntax:

S3OutputLocation=string

JSON Syntax:

{
  "S3OutputLocation": "string"
}

--ai-workload-config-identifier (string) [required]

The name or Amazon Resource Name (ARN) of the AI workload configuration to use for this benchmark job.

Constraints:

  • min: 1
  • max: 256
  • pattern: (arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:[a-z\-]*/)?([a-zA-Z0-9]([a-zA-Z0-9\-]){0,62})(?<!-)

--role-arn (string) [required]

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

Constraints:

  • min: 20
  • max: 2048
  • pattern: arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+

--network-config (structure)

The network configuration for the benchmark job, including VPC settings.

VpcConfig -> (structure)

The VPC configuration, including security group IDs and subnet IDs.

SecurityGroupIds -> (list) [required]

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

Constraints:

  • min: 1
  • max: 5

(string)

Constraints:

  • min: 0
  • max: 32
  • pattern: [-0-9a-zA-Z]+

Subnets -> (list) [required]

The ID of the subnets in the VPC to which you want to connect your training job or model. For information about the availability of specific instance types, see Supported Instance Types and Availability Zones .

Constraints:

  • min: 1
  • max: 16

(string)

Constraints:

  • min: 0
  • max: 32
  • pattern: [-0-9a-zA-Z]+

Shorthand Syntax:

VpcConfig={SecurityGroupIds=[string,string],Subnets=[string,string]}

JSON Syntax:

{
  "VpcConfig": {
    "SecurityGroupIds": ["string", ...],
    "Subnets": ["string", ...]
  }
}

--tags (list)

The metadata that you apply to Amazon Web Services resources to help you categorize and organize them. Each tag consists of a key and a value, both of which you define.

Constraints:

  • min: 0
  • max: 50

(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) [required]

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

Constraints:

  • min: 1
  • max: 128
  • pattern: ([\p{L}\p{Z}\p{N}_.:/=+\-@]*)

Value -> (string) [required]

The tag value.

Constraints:

  • min: 0
  • max: 256
  • pattern: ([\p{L}\p{Z}\p{N}_.:/=+\-@]*)

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

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
  • yaml
  • yaml-stream
  • off

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

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

  • legacy
  • json
  • yaml
  • text
  • table
  • enhanced

Output

AIBenchmarkJobArn -> (string)

The Amazon Resource Name (ARN) of the created benchmark job.

Constraints:

  • min: 0
  • max: 256
  • pattern: arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:ai-benchmark-job/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}
© Copyright 2026, Amazon Web Services. Created using Sphinx.