DescribeComputeQuota
Description of the compute allocation definition.
Request Syntax
{
"ComputeQuotaId": "string",
"ComputeQuotaVersion": number
}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.
- ComputeQuotaId
-
ID of the compute allocation definition.
Type: String
Pattern:
^[a-z0-9]{12}$Required: Yes
- ComputeQuotaVersion
-
Version of the compute allocation definition.
Type: Integer
Required: No
Response Syntax
{
"ActivationState": "string",
"ClusterArn": "string",
"ComputeQuotaArn": "string",
"ComputeQuotaConfig": {
"ComputeQuotaResources": [
{
"Count": number,
"InstanceType": "string"
}
],
"PreemptTeamTasks": "string",
"ResourceSharingConfig": {
"BorrowLimit": number,
"Strategy": "string"
}
},
"ComputeQuotaId": "string",
"ComputeQuotaTarget": {
"FairShareWeight": number,
"TeamName": "string"
},
"ComputeQuotaVersion": number,
"CreatedBy": {
"DomainId": "string",
"IamIdentity": {
"Arn": "string",
"PrincipalId": "string",
"SourceIdentity": "string"
},
"UserProfileArn": "string",
"UserProfileName": "string"
},
"CreationTime": number,
"Description": "string",
"FailureReason": "string",
"LastModifiedBy": {
"DomainId": "string",
"IamIdentity": {
"Arn": "string",
"PrincipalId": "string",
"SourceIdentity": "string"
},
"UserProfileArn": "string",
"UserProfileName": "string"
},
"LastModifiedTime": number,
"Name": "string",
"Status": "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.
- ActivationState
-
The state of the compute allocation being described. Use to enable or disable compute allocation.
Default is
Enabled.Type: String
Valid Values:
Enabled | Disabled - ClusterArn
-
ARN of the cluster.
Type: String
Length Constraints: Maximum length of 256.
Pattern:
^arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:cluster/[a-z0-9]{12}$ - ComputeQuotaArn
-
ARN of the compute allocation definition.
Type: String
Length Constraints: Maximum length of 2048.
Pattern:
arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:compute-quota/[a-z0-9]{12}$ - ComputeQuotaConfig
-
Configuration of the compute allocation definition. This includes the resource sharing option, and the setting to preempt low priority tasks.
Type: ComputeQuotaConfig object
- ComputeQuotaId
-
ID of the compute allocation definition.
Type: String
Pattern:
^[a-z0-9]{12}$ - ComputeQuotaTarget
-
The target entity to allocate compute resources to.
Type: ComputeQuotaTarget object
- ComputeQuotaVersion
-
Version of the compute allocation definition.
Type: Integer
- CreatedBy
-
Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.
Type: UserContext object
- CreationTime
-
Creation time of the compute allocation configuration.
Type: Timestamp
- Description
-
Description of the compute allocation definition.
Type: String
Length Constraints: Maximum length of 1024.
Pattern:
[\p{L}\p{M}\p{Z}\p{S}\p{N}\p{P}]* - FailureReason
-
Failure reason of the compute allocation definition.
Type: String
Length Constraints: Maximum length of 1024.
- LastModifiedBy
-
Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.
Type: UserContext object
- LastModifiedTime
-
Last modified time of the compute allocation configuration.
Type: Timestamp
- Name
-
Name of the compute allocation definition.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern:
^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$ - Status
-
Status of the compute allocation definition.
Type: String
Valid Values:
Creating | CreateFailed | CreateRollbackFailed | Created | Updating | UpdateFailed | UpdateRollbackFailed | Updated | Deleting | DeleteFailed | DeleteRollbackFailed | Deleted
Errors
For information about the errors that are common to all actions, see Common Errors.
- 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:
