Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListComputeQuotas

List the resource allocation definitions.

Request Syntax


{
   "ClusterArn": "string",
   "CreatedAfter": number,
   "CreatedBefore": number,
   "MaxResults": number,
   "NameContains": "string",
   "NextToken": "string",
   "SortBy": "string",
   "SortOrder": "string",
   "Status": "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.

ClusterArn

Filter for ARN of the cluster.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

Pattern: arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:cluster/[a-z0-9]{12}

Required: No

CreatedAfter

Filter for after this creation time. The input for this parameter is a Unix timestamp. To convert a date and time into a Unix timestamp, see EpochConverter.

Type: Timestamp

Required: No

CreatedBefore

Filter for before this creation time. The input for this parameter is a Unix timestamp. To convert a date and time into a Unix timestamp, see EpochConverter.

Type: Timestamp

Required: No

MaxResults

The maximum number of compute allocation definitions to list.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NameContains

Filter for name containing this string.

Type: String

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

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

Required: No

NextToken

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 8192.

Pattern: .*

Required: No

SortBy

Filter for sorting the list by a given value. For example, sort by name, creation time, or status.

Type: String

Valid Values: Name | CreationTime | Status | ClusterArn

Required: No

SortOrder

The order of the list. By default, listed in Descending order according to by SortBy. To change the list order, you can specify SortOrder to be Ascending.

Type: String

Valid Values: Ascending | Descending

Required: No

Status

Filter for status.

Type: String

Required: No

Response Syntax


{
   "ComputeQuotaSummaries": [ 
      { 
         "ActivationState": "string",
         "ClusterArn": "string",
         "ComputeQuotaArn": "string",
         "ComputeQuotaConfig": { 
            "ComputeQuotaResources": [ 
               { 
                  "Accelerators": number,
                  "Count": number,
                  "InstanceType": "string",
                  "MemoryInGiB": number,
                  "VCpu": number
               }
            ],
            "PreemptTeamTasks": "string",
            "ResourceSharingConfig": { 
               "BorrowLimit": number,
               "Strategy": "string"
            }
         },
         "ComputeQuotaId": "string",
         "ComputeQuotaTarget": { 
            "FairShareWeight": number,
            "TeamName": "string"
         },
         "ComputeQuotaVersion": number,
         "CreationTime": number,
         "LastModifiedTime": number,
         "Name": "string",
         "Status": "string"
      }
   ],
   "NextToken": "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.

ComputeQuotaSummaries

Summaries of the compute allocation definitions.

Type: Array of ComputeQuotaSummary objects

Array Members: Minimum number of 0 items. Maximum number of 100 items.

NextToken

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 8192.

Pattern: .*

Errors

For information about the errors that are common to all actions, see Common Errors.