DescribeAIWorkloadConfig
Returns details of an AI workload configuration, including the dataset configuration, benchmark tool settings, tags, and creation time.
Request Syntax
{
"AIWorkloadConfigName": "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.
- AIWorkloadConfigName
-
The name of the AI workload configuration 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
{
"AIWorkloadConfigArn": "string",
"AIWorkloadConfigName": "string",
"AIWorkloadConfigs": {
"WorkloadSpec": { ... }
},
"CreationTime": number,
"DatasetConfig": { ... },
"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.
- AIWorkloadConfigArn
-
The Amazon Resource Name (ARN) of the AI workload configuration.
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-workload-config/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62} - AIWorkloadConfigName
-
The name of the AI workload configuration.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern:
[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62} - AIWorkloadConfigs
-
The benchmark tool configuration and workload specification.
Type: AIWorkloadConfigs object
- CreationTime
-
A timestamp that indicates when the AI workload configuration was created.
Type: Timestamp
- DatasetConfig
-
The dataset configuration for the workload.
Type: AIDatasetConfig object
Note: This object is a Union. Only one member of this object can be specified or returned.
- Tags
-
The tags associated with the AI workload configuration.
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:
