Table of Contents
A low-level client representing Amazon Elastic Inference (Elastic Inference)
Elastic Inference public APIs.
import boto3
client = boto3.client('elastic-inference')
These are the available methods:
Check if an operation can be paginated.
Describes the locations in which a given accelerator type or set of types is present in a given region.
See also: AWS API Documentation
Request Syntax
response = client.describe_accelerator_offerings(
locationType='region'|'availability-zone'|'availability-zone-id',
acceleratorTypes=[
'string',
]
)
[REQUIRED]
The location type that you want to describe accelerator type offerings for. It can assume the following values: region: will return the accelerator type offering at the regional level. availability-zone: will return the accelerator type offering at the availability zone level. availability-zone-id: will return the accelerator type offering at the availability zone level returning the availability zone id.
The list of accelerator types to describe.
dict
Response Syntax
{
'acceleratorTypeOfferings': [
{
'acceleratorType': 'string',
'locationType': 'region'|'availability-zone'|'availability-zone-id',
'location': 'string'
},
]
}
Response Structure
(dict) --
acceleratorTypeOfferings (list) --
The list of accelerator type offerings for a specific location.
(dict) --
The offering for an Elastic Inference Accelerator type.
acceleratorType (string) --
The name of the Elastic Inference Accelerator type.
locationType (string) --
The location type for the offering. It can assume the following values: region: defines that the offering is at the regional level. availability-zone: defines that the offering is at the availability zone level. availability-zone-id: defines that the offering is at the availability zone level, defined by the availability zone id.
location (string) --
The location for the offering. It will return either the region, availability zone or availability zone id for the offering depending on the locationType value.
Exceptions
Describes the accelerator types available in a given region, as well as their characteristics, such as memory and throughput.
See also: AWS API Documentation
Request Syntax
response = client.describe_accelerator_types()
{
'acceleratorTypes': [
{
'acceleratorTypeName': 'string',
'memoryInfo': {
'sizeInMiB': 123
},
'throughputInfo': [
{
'key': 'string',
'value': 123
},
]
},
]
}
Response Structure
The available accelerator types.
The details of an Elastic Inference Accelerator type.
The name of the Elastic Inference Accelerator type.
The memory information of the Elastic Inference Accelerator type.
The size in mebibytes of the Elastic Inference Accelerator type.
The throughput information of the Elastic Inference Accelerator type.
A throughput entry for an Elastic Inference Accelerator type.
The throughput value of the Elastic Inference Accelerator type. It can assume the following values: TFLOPS16bit: the throughput expressed in 16bit TeraFLOPS. TFLOPS32bit: the throughput expressed in 32bit TeraFLOPS.
The throughput value of the Elastic Inference Accelerator type.
Exceptions
Describes information over a provided set of accelerators belonging to an account.
See also: AWS API Documentation
Request Syntax
response = client.describe_accelerators(
acceleratorIds=[
'string',
],
filters=[
{
'name': 'string',
'values': [
'string',
]
},
],
maxResults=123,
nextToken='string'
)
The IDs of the accelerators to describe.
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.
A filter expression for the Elastic Inference Accelerator list.
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.
The values for the filter of the Elastic Inference Accelerator list.
dict
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 specify where to start paginating. This is the NextToken from a previously truncated response.
Exceptions
Create a paginator for an operation.
Returns an object that can wait for some condition.
Returns all tags of an Elastic Inference Accelerator.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
resourceArn='string'
)
[REQUIRED]
The ARN of the Elastic Inference Accelerator to list the tags for.
{
'tags': {
'string': 'string'
}
}
Response Structure
The tags of the Elastic Inference Accelerator.
Exceptions
Adds the specified tags to an Elastic Inference Accelerator.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
resourceArn='string',
tags={
'string': 'string'
}
)
[REQUIRED]
The ARN of the Elastic Inference Accelerator to tag.
[REQUIRED]
The tags to add to the Elastic Inference Accelerator.
dict
Response Syntax
{}
Response Structure
Exceptions
Removes the specified tags from an Elastic Inference Accelerator.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
resourceArn='string',
tagKeys=[
'string',
]
)
[REQUIRED]
The ARN of the Elastic Inference Accelerator to untag.
[REQUIRED]
The list of tags to remove from the Elastic Inference Accelerator.
dict
Response Syntax
{}
Response Structure
Exceptions
The available paginators are:
paginator = client.get_paginator('describe_accelerators')
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'
}
)
The IDs of the accelerators to describe.
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.
A filter expression for the Elastic Inference Accelerator list.
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.
The values for the filter of the Elastic Inference Accelerator list.
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
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.