DescribeAIRecommendationJob
Returns details of an AI recommendation job, including its status, model source, performance targets, optimization recommendations, and deployment configurations.
Request Syntax
{
"AIRecommendationJobName": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- AIRecommendationJobName
-
The name of the AI recommendation job to describe.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern:
[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}Required: Yes
Response Syntax
{
"AIRecommendationJobArn": "string",
"AIRecommendationJobName": "string",
"AIRecommendationJobStatus": "string",
"AIWorkloadConfigIdentifier": "string",
"ComputeSpec": {
"CapacityReservationConfig": {
"CapacityReservationPreference": "string",
"MlReservationArns": [ "string" ]
},
"InstanceTypes": [ "string" ]
},
"CreationTime": number,
"EndTime": number,
"FailureReason": "string",
"InferenceSpecification": {
"Framework": "string"
},
"ModelSource": { ... },
"OptimizeModel": boolean,
"OutputConfig": {
"ModelPackageGroupIdentifier": "string",
"S3OutputLocation": "string"
},
"PerformanceTarget": {
"Constraints": [
{
"Metric": "string"
}
]
},
"Recommendations": [
{
"AIBenchmarkJobArn": "string",
"DeploymentConfiguration": {
"CopyCountPerInstance": number,
"EnvironmentVariables": {
"string" : "string"
},
"ImageUri": "string",
"InstanceCount": number,
"InstanceType": "string",
"S3": [
{
"ChannelName": "string",
"Uri": "string"
}
]
},
"ExpectedPerformance": [
{
"Metric": "string",
"Stat": "string",
"Unit": "string",
"Value": "string"
}
],
"ModelDetails": {
"InferenceSpecificationName": "string",
"InstanceDetails": [
{
"CopyCountPerInstance": number,
"InstanceCount": number,
"InstanceType": "string"
}
],
"ModelPackageArn": "string"
},
"OptimizationDetails": [
{
"OptimizationConfig": {
"string" : "string"
},
"OptimizationType": "string"
}
],
"RecommendationDescription": "string"
}
],
"RoleArn": "string",
"StartTime": number,
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- AIRecommendationJobArn
-
The Amazon Resource Name (ARN) of the AI recommendation job.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Pattern:
arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:ai-recommendation-job/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62} - AIRecommendationJobName
-
The name of the AI recommendation job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern:
[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62} - AIRecommendationJobStatus
-
The status of the AI recommendation job.
Type: String
Valid Values:
InProgress | Completed | Failed | Stopping | Stopped - AIWorkloadConfigIdentifier
-
The name or Amazon Resource Name (ARN) of the AI workload configuration used for this recommendation job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 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})(?<!-) - ComputeSpec
-
The compute resource specification for the recommendation job.
Type: AIRecommendationComputeSpec object
- CreationTime
-
A timestamp that indicates when the recommendation job was created.
Type: Timestamp
- EndTime
-
A timestamp that indicates when the recommendation job completed.
Type: Timestamp
- FailureReason
-
If the recommendation job failed, the reason it failed.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
- InferenceSpecification
-
The inference framework configuration.
Type: AIRecommendationInferenceSpecification object
- ModelSource
-
The source of the model that was analyzed.
Type: AIModelSource object
Note: This object is a Union. Only one member of this object can be specified or returned.
- OptimizeModel
-
Whether model optimization techniques were allowed.
Type: Boolean
- OutputConfig
-
The output configuration for the recommendation job.
Type: AIRecommendationOutputResult object
- PerformanceTarget
-
The performance targets specified for the recommendation job.
Type: AIRecommendationPerformanceTarget object
- Recommendations
-
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.
Type: Array of AIRecommendation objects
- RoleArn
-
The Amazon Resource Name (ARN) of the IAM role used by the recommendation job.
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+=,.@\-_/]+ - StartTime
-
A timestamp that indicates when the recommendation job started running.
Type: Timestamp
- Tags
-
The tags associated with the recommendation job.
Type: Array of Tag objects
Array Members: Minimum number of 0 items. Maximum number of 50 items.
Errors
For information about the errors that are common to all actions, see Common Error Types.
- ResourceNotFound
-
Resource being access is not found.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
