Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListAIWorkloadConfigs

Returns a list of AI workload configurations in your account. You can filter the results by name and creation time, and sort the results. The response is paginated.

Request Syntax


{
   "CreationTimeAfter": number,
   "CreationTimeBefore": number,
   "MaxResults": number,
   "NameContains": "string",
   "NextToken": "string",
   "SortBy": "string",
   "SortOrder": "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.

CreationTimeAfter

A filter that returns only configurations created after the specified time.

Type: Timestamp

Required: No

CreationTimeBefore

A filter that returns only configurations created before the specified time.

Type: Timestamp

Required: No

MaxResults

The maximum number of AI workload configurations to return in the response.

Type: Integer

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

Required: No

NameContains

A string in the configuration name. This filter returns only configurations whose name contains the specified string.

Type: String

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

Pattern: [a-zA-Z0-9\-]+

Required: No

NextToken

If the previous call to ListAIWorkloadConfigs didn't return the full set of configurations, the call returns a token for getting the next set of configurations.

Type: String

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

Pattern: .*

Required: No

SortBy

The field to sort results by. The default is CreationTime.

Type: String

Valid Values: Name | CreationTime

Required: No

SortOrder

The sort order for results. The default is Descending.

Type: String

Valid Values: Ascending | Descending

Required: No

Response Syntax


{
   "AIWorkloadConfigs": [ 
      { 
         "AIWorkloadConfigArn": "string",
         "AIWorkloadConfigName": "string",
         "CreationTime": number
      }
   ],
   "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.

AIWorkloadConfigs

An array of AIWorkloadConfigSummary objects, one for each AI workload configuration that matches the specified filters.

Type: Array of AIWorkloadConfigSummary objects

NextToken

If the response is truncated, Amazon SageMaker AI returns this token. To retrieve the next set of configurations, use it in the subsequent request.

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 Error Types.