SageMaker / Client / list_inference_components
list_inference_components#
- SageMaker.Client.list_inference_components(**kwargs)#
Lists the inference components in your account and their properties.
See also: AWS API Documentation
Request Syntax
response = client.list_inference_components( SortBy='Name'|'CreationTime'|'Status', SortOrder='Ascending'|'Descending', NextToken='string', MaxResults=123, NameContains='string', CreationTimeBefore=datetime(2015, 1, 1), CreationTimeAfter=datetime(2015, 1, 1), LastModifiedTimeBefore=datetime(2015, 1, 1), LastModifiedTimeAfter=datetime(2015, 1, 1), StatusEquals='InService'|'Creating'|'Updating'|'Failed'|'Deleting', EndpointNameEquals='string', VariantNameEquals='string' )
- Parameters:
SortBy (string) – The field by which to sort the inference components in the response. The default is
CreationTime
.SortOrder (string) – The sort order for results. The default is
Descending
.NextToken (string) – 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.
MaxResults (integer) – The maximum number of inference components to return in the response. This value defaults to 10.
NameContains (string) – Filters the results to only those inference components with a name that contains the specified string.
CreationTimeBefore (datetime) – Filters the results to only those inference components that were created before the specified time.
CreationTimeAfter (datetime) – Filters the results to only those inference components that were created after the specified time.
LastModifiedTimeBefore (datetime) – Filters the results to only those inference components that were updated before the specified time.
LastModifiedTimeAfter (datetime) – Filters the results to only those inference components that were updated after the specified time.
StatusEquals (string) – Filters the results to only those inference components with the specified status.
EndpointNameEquals (string) – An endpoint name to filter the listed inference components. The response includes only those inference components that are hosted at the specified endpoint.
VariantNameEquals (string) – A production variant name to filter the listed inference components. The response includes only those inference components that are hosted at the specified variant.
- Return type:
dict
- Returns:
Response Syntax
{ 'InferenceComponents': [ { 'CreationTime': datetime(2015, 1, 1), 'InferenceComponentArn': 'string', 'InferenceComponentName': 'string', 'EndpointArn': 'string', 'EndpointName': 'string', 'VariantName': 'string', 'InferenceComponentStatus': 'InService'|'Creating'|'Updating'|'Failed'|'Deleting', 'LastModifiedTime': datetime(2015, 1, 1) }, ], 'NextToken': 'string' }
Response Structure
(dict) –
InferenceComponents (list) –
A list of inference components and their properties that matches any of the filters you specified in the request.
(dict) –
A summary of the properties of an inference component.
CreationTime (datetime) –
The time when the inference component was created.
InferenceComponentArn (string) –
The Amazon Resource Name (ARN) of the inference component.
InferenceComponentName (string) –
The name of the inference component.
EndpointArn (string) –
The Amazon Resource Name (ARN) of the endpoint that hosts the inference component.
EndpointName (string) –
The name of the endpoint that hosts the inference component.
VariantName (string) –
The name of the production variant that hosts the inference component.
InferenceComponentStatus (string) –
The status of the inference component.
LastModifiedTime (datetime) –
The time when the inference component was last updated.
NextToken (string) –
The token to use in a subsequent request to get the next set of results following a truncated response.