ElasticInference / Paginator / DescribeAccelerators
DescribeAccelerators#
- class ElasticInference.Paginator.DescribeAccelerators#
paginator = client.get_paginator('describe_accelerators')
- paginate(**kwargs)#
Creates an iterator that will paginate through responses from
ElasticInference.Client.describe_accelerators()
.See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate( acceleratorIds=[ 'string', ], filters=[ { 'name': 'string', 'values': [ 'string', ] }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } )
- Parameters:
acceleratorIds (list) –
The IDs of the accelerators to describe.
(string) –
filters (list) –
One or more filters. Filter names and values are case-sensitive. Valid filter names are: accelerator-types: can provide a list of accelerator type names to filter for. instance-id: can provide a list of EC2 instance ids to filter for.
(dict) –
A filter expression for the Elastic Inference Accelerator list.
name (string) –
The filter name for the Elastic Inference Accelerator list. It can assume the following values: accelerator-type: the type of Elastic Inference Accelerator to filter for. instance-id: an EC2 instance id to filter for.
values (list) –
The values for the filter of the Elastic Inference Accelerator list.
(string) –
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a
NextToken
will be provided in the output that you can use to resume pagination.PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the
NextToken
from a previous response.
- Return type:
dict
- Returns:
Response Syntax
{ 'acceleratorSet': [ { 'acceleratorHealth': { 'status': 'string' }, 'acceleratorType': 'string', 'acceleratorId': 'string', 'availabilityZone': 'string', 'attachedResource': 'string' }, ], 'NextToken': 'string' }
Response Structure
(dict) –
acceleratorSet (list) –
The details of the Elastic Inference Accelerators.
(dict) –
The details of an Elastic Inference Accelerator.
acceleratorHealth (dict) –
The health of the Elastic Inference Accelerator.
status (string) –
The health status of the Elastic Inference Accelerator.
acceleratorType (string) –
The type of the Elastic Inference Accelerator.
acceleratorId (string) –
The ID of the Elastic Inference Accelerator.
availabilityZone (string) –
The availability zone where the Elastic Inference Accelerator is present.
attachedResource (string) –
The ARN of the resource that the Elastic Inference Accelerator is attached to.
NextToken (string) –
A token to resume pagination.