DescribeAIBenchmarkJob
Returns details of an AI benchmark job, including its status, configuration, target endpoint, and timing information.
Request Syntax
{
"AIBenchmarkJobName": "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.
- AIBenchmarkJobName
-
The name of the AI benchmark 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
{
"AIBenchmarkJobArn": "string",
"AIBenchmarkJobName": "string",
"AIBenchmarkJobStatus": "string",
"AIWorkloadConfigIdentifier": "string",
"BenchmarkTarget": { ... },
"CreationTime": number,
"EndTime": number,
"FailureReason": "string",
"NetworkConfig": {
"VpcConfig": {
"SecurityGroupIds": [ "string" ],
"Subnets": [ "string" ]
}
},
"OutputConfig": {
"CloudWatchLogs": [
{
"LogGroupArn": "string",
"LogStreamName": "string"
}
],
"S3OutputLocation": "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.
- AIBenchmarkJobArn
-
The Amazon Resource Name (ARN) of the AI benchmark 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-benchmark-job/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62} - AIBenchmarkJobName
-
The name of the AI benchmark job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern:
[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62} - AIBenchmarkJobStatus
-
The status of the AI benchmark 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 benchmark 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})(?<!-) - BenchmarkTarget
-
The target endpoint that was benchmarked.
Type: AIBenchmarkTarget object
Note: This object is a Union. Only one member of this object can be specified or returned.
- CreationTime
-
A timestamp that indicates when the benchmark job was created.
Type: Timestamp
- EndTime
-
A timestamp that indicates when the benchmark job completed.
Type: Timestamp
- FailureReason
-
If the benchmark job failed, the reason it failed.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
- NetworkConfig
-
The network configuration for the benchmark job.
Type: AIBenchmarkNetworkConfig object
- OutputConfig
-
The output configuration for the benchmark job, including the Amazon S3 output location and CloudWatch log information.
Type: AIBenchmarkOutputResult object
- RoleArn
-
The Amazon Resource Name (ARN) of the IAM role used by the benchmark 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 benchmark job started running.
Type: Timestamp
- Tags
-
The tags associated with the benchmark 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:
