Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListOptimizationJobs

Lists the optimization jobs in your account and their properties.

Request Syntax


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

Filters the results to only those optimization jobs that were created after the specified time.

Type: Timestamp

Required: No

CreationTimeBefore

Filters the results to only those optimization jobs that were created before the specified time.

Type: Timestamp

Required: No

LastModifiedTimeAfter

Filters the results to only those optimization jobs that were updated after the specified time.

Type: Timestamp

Required: No

LastModifiedTimeBefore

Filters the results to only those optimization jobs that were updated before the specified time.

Type: Timestamp

Required: No

MaxResults

The maximum number of optimization jobs to return in the response. The default is 50.

Type: Integer

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

Required: No

NameContains

Filters the results to only those optimization jobs with a name that contains the specified string.

Type: String

Length Constraints: Maximum length of 63.

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

Required: No

NextToken

A token that you use to get the next set of results following a truncated response. If the response to the previous request was truncated, that response provides the value for this token.

Type: String

Length Constraints: Maximum length of 8192.

Pattern: .*

Required: No

OptimizationContains

Filters the results to only those optimization jobs that apply the specified optimization techniques. You can specify either Quantization or Compilation.

Type: String

Length Constraints: Maximum length of 63.

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

Required: No

SortBy

The field by which to sort the optimization jobs in the response. The default is CreationTime

Type: String

Valid Values: Name | CreationTime | Status

Required: No

SortOrder

The sort order for results. The default is Ascending

Type: String

Valid Values: Ascending | Descending

Required: No

StatusEquals

Filters the results to only those optimization jobs with the specified status.

Type: String

Required: No

Response Syntax


{
   "NextToken": "string",
   "OptimizationJobSummaries": [ 
      { 
         "CreationTime": number,
         "DeploymentInstanceType": "string",
         "LastModifiedTime": number,
         "OptimizationEndTime": number,
         "OptimizationJobArn": "string",
         "OptimizationJobName": "string",
         "OptimizationJobStatus": "string",
         "OptimizationStartTime": number,
         "OptimizationTypes": [ "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.

NextToken

The token to use in a subsequent request to get the next set of results following a truncated response.

Type: String

Length Constraints: Maximum length of 8192.

Pattern: .*

OptimizationJobSummaries

A list of optimization jobs and their properties that matches any of the filters you specified in the request.

Type: Array of OptimizationJobSummary objects

Errors

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