InferenceRecommendationsJob - Amazon SageMaker

InferenceRecommendationsJob

A structure that contains a list of recommendation jobs.

Contents

CreationTime

A timestamp that shows when the job was created.

Type: Timestamp

Required: Yes

JobArn

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

Type: String

Length Constraints: Maximum length of 256.

Pattern: arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:inference-recommendations-job/.*

Required: Yes

JobDescription

The job description.

Type: String

Length Constraints: Maximum length of 128.

Required: Yes

JobName

The name of the job.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63}

Required: Yes

JobType

The recommendation job type.

Type: String

Valid Values: Default | Advanced

Required: Yes

LastModifiedTime

A timestamp that shows when the job was last modified.

Type: Timestamp

Required: Yes

RoleArn

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

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$

Required: Yes

Status

The status of the job.

Type: String

Valid Values: PENDING | IN_PROGRESS | COMPLETED | FAILED | STOPPING | STOPPED | DELETING | DELETED

Required: Yes

CompletionTime

A timestamp that shows when the job completed.

Type: Timestamp

Required: No

FailureReason

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

Type: String

Length Constraints: Maximum length of 1024.

Required: No

ModelName

The name of the created model.

Type: String

Length Constraints: Maximum length of 63.

Pattern: ^[a-zA-Z0-9]([\-a-zA-Z0-9]*[a-zA-Z0-9])?

Required: No

ModelPackageVersionArn

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: ^arn:aws(-cn|-us-gov)?:sagemaker:[a-z0-9\-]{9,16}:[0-9]{12}:model-package/[\S]{1,2048}$

Required: No

SamplePayloadUrl

The Amazon Simple Storage Service (Amazon S3) path where the sample payload is stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

Type: String

Length Constraints: Maximum length of 1024.

Pattern: ^(https|s3)://([^/]+)/?(.*)$

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: