Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListInferenceComponents

Lists the inference components in your account and their properties.

Request Syntax


{
   "CreationTimeAfter": number,
   "CreationTimeBefore": number,
   "EndpointNameEquals": "string",
   "LastModifiedTimeAfter": number,
   "LastModifiedTimeBefore": number,
   "MaxResults": number,
   "NameContains": "string",
   "NextToken": "string",
   "SortBy": "string",
   "SortOrder": "string",
   "StatusEquals": "string",
   "VariantNameEquals": "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 inference components that were created after the specified time.

Type: Timestamp

Required: No

CreationTimeBefore

Filters the results to only those inference components that were created before the specified time.

Type: Timestamp

Required: No

EndpointNameEquals

An endpoint name to filter the listed inference components. The response includes only those inference components that are hosted at the specified endpoint.

Type: String

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

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

Required: No

LastModifiedTimeAfter

Filters the results to only those inference components that were updated after the specified time.

Type: Timestamp

Required: No

LastModifiedTimeBefore

Filters the results to only those inference components that were updated before the specified time.

Type: Timestamp

Required: No

MaxResults

The maximum number of inference components to return in the response. This value defaults to 10.

Type: Integer

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

Required: No

NameContains

Filters the results to only those inference components with a name that contains the specified string.

Type: String

Length Constraints: Minimum length of 0. 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: Minimum length of 0. Maximum length of 8192.

Pattern: .*

Required: No

SortBy

The field by which to sort the inference components 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 Descending.

Type: String

Valid Values: Ascending | Descending

Required: No

StatusEquals

Filters the results to only those inference components with the specified status.

Type: String

Valid Values: InService | Creating | Updating | Failed | Deleting

Required: No

VariantNameEquals

A production variant name to filter the listed inference components. The response includes only those inference components that are hosted at the specified variant.

Type: String

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

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

Required: No

Response Syntax


{
   "InferenceComponents": [ 
      { 
         "CreationTime": number,
         "EndpointArn": "string",
         "EndpointName": "string",
         "InferenceComponentArn": "string",
         "InferenceComponentName": "string",
         "InferenceComponentStatus": "string",
         "LastModifiedTime": number,
         "VariantName": "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.

InferenceComponents

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

Type: Array of InferenceComponentSummary objects

NextToken

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

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.