ListInferenceExperiments
Returns the list of all inference experiments.
Request Syntax
{
"CreationTimeAfter": number
,
"CreationTimeBefore": number
,
"LastModifiedTimeAfter": number
,
"LastModifiedTimeBefore": number
,
"MaxResults": number
,
"NameContains": "string
",
"NextToken": "string
",
"SortBy": "string
",
"SortOrder": "string
",
"StatusEquals": "string
",
"Type": "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
-
Selects inference experiments which were created after this timestamp.
Type: Timestamp
Required: No
- CreationTimeBefore
-
Selects inference experiments which were created before this timestamp.
Type: Timestamp
Required: No
- LastModifiedTimeAfter
-
Selects inference experiments which were last modified after this timestamp.
Type: Timestamp
Required: No
- LastModifiedTimeBefore
-
Selects inference experiments which were last modified before this timestamp.
Type: Timestamp
Required: No
- MaxResults
-
The maximum number of results to select.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- NameContains
-
Selects inference experiments whose names contain this name.
Type: String
Length Constraints: Maximum length of 63.
Pattern:
[a-zA-Z0-9\-]+
Required: No
- NextToken
-
The response from the last list when returning a list large enough to need tokening.
Type: String
Length Constraints: Maximum length of 8192.
Pattern:
.*
Required: No
- SortBy
-
The column by which to sort the listed inference experiments.
Type: String
Valid Values:
Name | CreationTime | Status
Required: No
- SortOrder
-
The direction of sorting (ascending or descending).
Type: String
Valid Values:
Ascending | Descending
Required: No
- StatusEquals
-
Selects inference experiments which are in this status. For the possible statuses, see DescribeInferenceExperiment.
Type: String
Valid Values:
Creating | Created | Updating | Running | Starting | Stopping | Completed | Cancelled
Required: No
- Type
-
Selects inference experiments of this type. For the possible types of inference experiments, see CreateInferenceExperiment.
Type: String
Valid Values:
ShadowMode
Required: No
Response Syntax
{
"InferenceExperiments": [
{
"CompletionTime": number,
"CreationTime": number,
"Description": "string",
"LastModifiedTime": number,
"Name": "string",
"RoleArn": "string",
"Schedule": {
"EndTime": number,
"StartTime": number
},
"Status": "string",
"StatusReason": "string",
"Type": "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.
- InferenceExperiments
-
List of inference experiments.
Type: Array of InferenceExperimentSummary objects
- NextToken
-
The token to use when calling the next page of results.
Type: String
Length Constraints: Maximum length of 8192.
Pattern:
.*
Errors
For information about the errors that are common to all actions, see Common Errors.
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: