AWS API Changes

2024/07/12 - Amazon Elastic Inference - 6 new api methods

TagResource (new)

Adds the specified tags to an Elastic Inference Accelerator.

February 15, 2023: Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.

See also: AWS API Documentation

Request Syntax

client.tag_resource(
    resourceArn='string',
    tags={
        'string': 'string'
    }
)

type resourceArn:

string

param resourceArn:

[REQUIRED]

The ARN of the Elastic Inference Accelerator to tag.

type tags:

dict

param tags:

[REQUIRED]

The tags to add to the Elastic Inference Accelerator.

(string) --
- (string) --

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --

UntagResource (new)

Link ¶

Removes the specified tags from an Elastic Inference Accelerator.

See also: AWS API Documentation

Request Syntax

client.untag_resource(
    resourceArn='string',
    tagKeys=[
        'string',
    ]
)

type resourceArn:

string

param resourceArn:

[REQUIRED]

The ARN of the Elastic Inference Accelerator to untag.

type tagKeys:

list

param tagKeys:

[REQUIRED]

The list of tags to remove from the Elastic Inference Accelerator.

(string) --

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --

DescribeAcceleratorOfferings (new)

Link ¶

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

client.describe_accelerator_offerings(
    locationType='region'|'availability-zone'|'availability-zone-id',
    acceleratorTypes=[
        'string',
    ]
)

type locationType:

string

param locationType:

[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.

type acceleratorTypes:

list

param acceleratorTypes:

The list of accelerator types to describe.

(string) --

rtype:

dict

returns:

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.

ListTagsForResource (new)

Link ¶

Returns all tags of an Elastic Inference Accelerator.

See also: AWS API Documentation

Request Syntax

client.list_tags_for_resource(
    resourceArn='string'
)

type resourceArn:

string

param resourceArn:

[REQUIRED]

The ARN of the Elastic Inference Accelerator to list the tags for.

rtype:

dict

returns:

Response Syntax

{
    'tags': {
        'string': 'string'
    }
}

Response Structure

(dict) --
- tags (dict) --
  
  The tags of the Elastic Inference Accelerator.
  - (string) --
    - (string) --

DescribeAcceleratorTypes (new)

Link ¶

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

client.describe_accelerator_types()

rtype:

dict

returns:

Response Syntax

{
    'acceleratorTypes': [
        {
            'acceleratorTypeName': 'string',
            'memoryInfo': {
                'sizeInMiB': 123
            },
            'throughputInfo': [
                {
                    'key': 'string',
                    'value': 123
                },
            ]
        },
    ]
}

Response Structure

(dict) --
- acceleratorTypes (list) --
  
  The available accelerator types.
  - (dict) --
    
    The details of an Elastic Inference Accelerator type.
    - acceleratorTypeName (string) --
      
      The name of the Elastic Inference Accelerator type.
    - memoryInfo (dict) --
      
      The memory information of the Elastic Inference Accelerator type.
      - sizeInMiB (integer) --
        
        The size in mebibytes of the Elastic Inference Accelerator type.
    - throughputInfo (list) --
      
      The throughput information of the Elastic Inference Accelerator type.
      - (dict) --
        
        A throughput entry for an Elastic Inference Accelerator type.
        
        key (string) --
        
        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.
        
        value (integer) --
        
        The throughput value of the Elastic Inference Accelerator type.

DescribeAccelerators (new)

Link ¶

Describes information over a provided set of accelerators belonging to an account.

See also: AWS API Documentation

Request Syntax

client.describe_accelerators(
    acceleratorIds=[
        'string',
    ],
    filters=[
        {
            'name': 'string',
            'values': [
                'string',
            ]
        },
    ],
    maxResults=123,
    nextToken='string'
)

type acceleratorIds:

list

param acceleratorIds:

The IDs of the accelerators to describe.

(string) --

type filters:

list

param filters:

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) --

type maxResults:

integer

param maxResults:

The total number of items to return in the command's output. If the total number of items available is more than the value specified, a NextToken is provided in the command's output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

type nextToken:

string

param nextToken:

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

rtype:

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 specify where to start paginating. This is the NextToken from a previously truncated response.