AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . sagemaker ]

describe-ai-recommendation-job

Description

Returns details of an AI recommendation job, including its status, model source, performance targets, optimization recommendations, and deployment configurations.

See also: AWS API Documentation

Synopsis

  describe-ai-recommendation-job
--ai-recommendation-job-name <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>]
[--v2-debug]

Options

--ai-recommendation-job-name (string)

The name of the AI recommendation job to describe.

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

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

AIRecommendationJobName -> (string)

The name of the AI recommendation job.

AIRecommendationJobArn -> (string)

The Amazon Resource Name (ARN) of the AI recommendation job.

AIRecommendationJobStatus -> (string)

The status of the AI recommendation job.

FailureReason -> (string)

If the recommendation job failed, the reason it failed.

ModelSource -> (tagged union structure)

The source of the model that was analyzed.

Note

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

S3 -> (structure)

The Amazon S3 location of the model artifacts.

S3Uri -> (string)

The Amazon S3 URI of the model artifacts.

OutputConfig -> (structure)

The output configuration for the recommendation job.

S3OutputLocation -> (string)

The Amazon S3 URI where the recommendation job writes its output results.

ModelPackageGroupIdentifier -> (string)

The name or Amazon Resource Name (ARN) of the model package group where deployment-ready model packages are registered.

InferenceSpecification -> (structure)

The inference framework configuration.

Framework -> (string)

The inference framework. Valid values are LMI and VLLM .

AIWorkloadConfigIdentifier -> (string)

The name or Amazon Resource Name (ARN) of the AI workload configuration used for this recommendation job.

OptimizeModel -> (boolean)

Whether model optimization techniques were allowed.

PerformanceTarget -> (structure)

The performance targets specified for the recommendation job.

Constraints -> (list)

An array of performance constraints that define the optimization objectives.

(structure)

A performance constraint for an AI recommendation job.

Metric -> (string)

The performance metric. Valid values are ttft-ms (time to first token in milliseconds), throughput , and cost .

Recommendations -> (list)

The list of optimization recommendations generated by the job. Each recommendation includes optimization details, deployment configuration, expected performance metrics, and the associated benchmark job ARN.

(structure)

An optimization recommendation generated by an AI recommendation job.

RecommendationDescription -> (string)

A description of the recommendation.

OptimizationDetails -> (list)

The optimization techniques applied in this recommendation.

(structure)

Details about an optimization technique applied in a recommendation.

OptimizationType -> (string)

The type of optimization. Valid values are SpeculativeDecoding and KernelTuning .

OptimizationConfig -> (map)

A map of configuration parameters for the optimization technique.

key -> (string)

value -> (string)

ModelDetails -> (structure)

Details about the model package associated with this recommendation.

ModelPackageArn -> (string)

The Amazon Resource Name (ARN) of the model package.

InferenceSpecificationName -> (string)

The name of the inference specification within the model package.

InstanceDetails -> (list)

The instance details for this recommendation, including instance type, count, and model copies per instance.

(structure)

Instance details for a recommendation.

InstanceType -> (string)

The recommended instance type.

InstanceCount -> (integer)

The recommended number of instances.

CopyCountPerInstance -> (integer)

The number of model copies per instance.

DeploymentConfiguration -> (structure)

The deployment configuration for this recommendation, including the container image, instance type, instance count, and environment variables.

S3 -> (list)

The Amazon S3 data channels for the deployment.

(structure)

An Amazon S3 data channel for a recommended deployment configuration, containing model artifacts or optimized model outputs.

ChannelName -> (string)

A custom name for this Amazon S3 data channel.

Uri -> (string)

The Amazon S3 URI of the data for this channel.

ImageUri -> (string)

The URI of the container image for the deployment.

InstanceType -> (string)

The recommended instance type for the deployment.

InstanceCount -> (integer)

The recommended number of instances for the deployment.

CopyCountPerInstance -> (integer)

The number of model copies per instance.

EnvironmentVariables -> (map)

The environment variables for the deployment.

key -> (string)

value -> (string)

AIBenchmarkJobArn -> (string)

The Amazon Resource Name (ARN) of the benchmark job associated with this recommendation.

ExpectedPerformance -> (list)

The expected performance metrics for this recommendation.

(structure)

An expected performance metric for a recommendation.

Metric -> (string)

The name of the performance metric.

Stat -> (string)

The statistical measure for the metric.

Value -> (string)

The value of the metric.

Unit -> (string)

The unit of the metric value.

RoleArn -> (string)

The Amazon Resource Name (ARN) of the IAM role used by the recommendation job.

ComputeSpec -> (structure)

The compute resource specification for the recommendation job.

InstanceTypes -> (list)

The list of instance types to consider for recommendations. You can specify up to 3 instance types.

(string)

CapacityReservationConfig -> (structure)

The capacity reservation configuration.

CapacityReservationPreference -> (string)

The capacity reservation preference. The only valid value is capacity-reservations-only .

MlReservationArns -> (list)

The list of ML reservation ARNs to use.

(string)

CreationTime -> (timestamp)

A timestamp that indicates when the recommendation job was created.

StartTime -> (timestamp)

A timestamp that indicates when the recommendation job started running.

EndTime -> (timestamp)

A timestamp that indicates when the recommendation job completed.

Tags -> (list)

The tags associated with the recommendation job.

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