[ aws . sagemaker ]

describe-inference-recommendations-job

Description

Provides the results of the Inference Recommender job. One or more recommendation jobs are returned.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-inference-recommendations-job
--job-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--job-name (string)

The name of the job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

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

See ‘aws help’ for descriptions of global parameters.

Output

JobName -> (string)

The name of the job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

JobDescription -> (string)

The job description that you provided when you initiated the job.

JobType -> (string)

The job type that you provided when you initiated the job.

JobArn -> (string)

The Amazon Resource Name (ARN) of the job.

RoleArn -> (string)

The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role you provided when you initiated the job.

Status -> (string)

The status of the job.

CreationTime -> (timestamp)

A timestamp that shows when the job was created.

CompletionTime -> (timestamp)

A timestamp that shows when the job completed.

LastModifiedTime -> (timestamp)

A timestamp that shows when the job was last modified.

FailureReason -> (string)

If the job fails, provides information why the job failed.

InputConfig -> (structure)

Returns information about the versioned model package Amazon Resource Name (ARN), the traffic pattern, and endpoint configurations you provided when you initiated the job.

ModelPackageVersionArn -> (string)

The Amazon Resource Name (ARN) of a versioned model package.

JobDurationInSeconds -> (integer)

Specifies the maximum duration of the job, in seconds.>

TrafficPattern -> (structure)

Specifies the traffic pattern of the job.

TrafficType -> (string)

Defines the traffic patterns.

Phases -> (list)

Defines the phases traffic specification.

(structure)

Defines the traffic pattern.

InitialNumberOfUsers -> (integer)

Specifies how many concurrent users to start with.

SpawnRate -> (integer)

Specified how many new users to spawn in a minute.

DurationInSeconds -> (integer)

Specifies how long traffic phase should be.

ResourceLimit -> (structure)

Defines the resource limit of the job.

MaxNumberOfTests -> (integer)

Defines the maximum number of load tests.

MaxParallelOfTests -> (integer)

Defines the maximum number of parallel load tests.

EndpointConfigurations -> (list)

Specifies the endpoint configuration to use for a job.

(structure)

The endpoint configuration for the load test.

InstanceType -> (string)

The instance types to use for the load test.

InferenceSpecificationName -> (string)

The inference specification name in the model package version.

EnvironmentParameterRanges -> (structure)

The parameter you want to benchmark against.

CategoricalParameterRanges -> (list)

Specified a list of parameters for each category.

(structure)

Environment parameters you want to benchmark your load test against.

Name -> (string)

The Name of the environment variable.

Value -> (list)

The list of values you can pass.

(string)

VolumeKmsKeyId -> (string)

The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. This key will be passed to SageMaker Hosting for endpoint creation.

The SageMaker execution role must have kms:CreateGrant permission in order to encrypt data on the storage volume of the endpoints created for inference recommendation. The inference recommendation job will fail asynchronously during endpoint configuration creation if the role passed does not have kms:CreateGrant permission.

The KmsKeyId can be any of the following formats:

• // KMS Key ID "1234abcd-12ab-34cd-56ef-1234567890ab"

• // Amazon Resource Name (ARN) of a KMS Key "arn:aws:kms:<region>:<account>:key/<key-id-12ab-34cd-56ef-1234567890ab>"

• // KMS Key Alias "alias/ExampleAlias"

• // Amazon Resource Name (ARN) of a KMS Key Alias "arn:aws:kms:<region>:<account>:alias/<ExampleAlias>"

For more information about key identifiers, see Key identifiers (KeyID) in the Amazon Web Services Key Management Service (Amazon Web Services KMS) documentation.

StoppingConditions -> (structure)

The stopping conditions that you provided when you initiated the job.

MaxInvocations -> (integer)

The maximum number of requests per minute expected for the endpoint.

ModelLatencyThresholds -> (list)

The interval of time taken by a model to respond as viewed from SageMaker. The interval includes the local communication time taken to send the request and to fetch the response from the container of a model and the time taken to complete the inference in the container.

(structure)

The model latency threshold.

Percentile -> (string)

The model latency percentile threshold.

ValueInMilliseconds -> (integer)

The model latency percentile value in milliseconds.

InferenceRecommendations -> (list)

The recommendations made by Inference Recommender.

(structure)

A list of recommendations made by Amazon SageMaker Inference Recommender.

Metrics -> (structure)

The metrics used to decide what recommendation to make.

CostPerHour -> (float)

Defines the cost per hour for the instance.

CostPerInference -> (float)

Defines the cost per inference for the instance .

MaxInvocations -> (integer)

The expected maximum number of requests per minute for the instance.

ModelLatency -> (integer)

The expected model latency at maximum invocation per minute for the instance.

EndpointConfiguration -> (structure)

Defines the endpoint configuration parameters.

EndpointName -> (string)

The name of the endpoint made during a recommendation job.

VariantName -> (string)

The name of the production variant (deployed model) made during a recommendation job.

InstanceType -> (string)

The instance type recommended by Amazon SageMaker Inference Recommender.

InitialInstanceCount -> (integer)

The number of instances recommended to launch initially.

ModelConfiguration -> (structure)

Defines the model configuration.

InferenceSpecificationName -> (string)

The inference specification name in the model package version.

EnvironmentParameters -> (list)

Defines the environment parameters that includes key, value types, and values.

(structure)

A list of environment parameters suggested by the Amazon SageMaker Inference Recommender.

Key -> (string)

The environment key suggested by the Amazon SageMaker Inference Recommender.

ValueType -> (string)

The value type suggested by the Amazon SageMaker Inference Recommender.

Value -> (string)

The value suggested by the Amazon SageMaker Inference Recommender.