SDK for PHP 3.x

Amazon Elastic Inference 2017-07-25

Client: Aws\ElasticInference\ElasticInferenceClient
Service ID: elastic-inference
Version: 2017-07-25

This page describes the parameters and results for the operations of the Amazon Elastic Inference (2017-07-25), and shows how to use the Aws\ElasticInference\ElasticInferenceClient object to call the described operations. This documentation is specific to the 2017-07-25 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

DescribeAcceleratorOfferings ( array $params = [] )
Describes the locations in which a given accelerator type or set of types is present in a given region.
DescribeAcceleratorTypes ( array $params = [] )
Describes the accelerator types available in a given region, as well as their characteristics, such as memory and throughput.
DescribeAccelerators ( array $params = [] )
Describes information over a provided set of accelerators belonging to an account.
ListTagsForResource ( array $params = [] )
Returns all tags of an Elastic Inference Accelerator.
TagResource ( array $params = [] )
Adds the specified tags to an Elastic Inference Accelerator.
UntagResource ( array $params = [] )
Removes the specified tags from an Elastic Inference Accelerator.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

DescribeAccelerators

Operations

DescribeAcceleratorOfferings 

$result = $client->describeAcceleratorOfferings([/* ... */]);
$promise = $client->describeAcceleratorOfferingsAsync([/* ... */]);

Describes the locations in which a given accelerator type or set of types is present in a given region.

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.

Parameter Syntax

$result = $client->describeAcceleratorOfferings([
    'acceleratorTypes' => ['<string>', ...],
    'locationType' => 'region|availability-zone|availability-zone-id', // REQUIRED
]);

Parameter Details

Members
acceleratorTypes
Type: Array of strings

The list of accelerator types to describe.

locationType
Required: Yes
Type: string

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.

Result Syntax

[
    'acceleratorTypeOfferings' => [
        [
            'acceleratorType' => '<string>',
            'location' => '<string>',
            'locationType' => 'region|availability-zone|availability-zone-id',
        ],
        // ...
    ],
]

Result Details

Members
acceleratorTypeOfferings
Type: Array of AcceleratorTypeOffering structures

The list of accelerator type offerings for a specific location.

Errors

BadRequestException:

Raised when a malformed input has been provided to the API.

ResourceNotFoundException:

Raised when the requested resource cannot be found.

InternalServerException:

Raised when an unexpected error occurred during request processing.

DescribeAcceleratorTypes 

$result = $client->describeAcceleratorTypes([/* ... */]);
$promise = $client->describeAcceleratorTypesAsync([/* ... */]);

Describes the accelerator types available in a given region, as well as their characteristics, such as memory and throughput.

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.

Parameter Syntax

$result = $client->describeAcceleratorTypes([
]);

Parameter Details

Members

Result Syntax

[
    'acceleratorTypes' => [
        [
            'acceleratorTypeName' => '<string>',
            'memoryInfo' => [
                'sizeInMiB' => <integer>,
            ],
            'throughputInfo' => [
                [
                    'key' => '<string>',
                    'value' => <integer>,
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Members
acceleratorTypes
Type: Array of AcceleratorType structures

The available accelerator types.

Errors

InternalServerException:

Raised when an unexpected error occurred during request processing.

DescribeAccelerators 

$result = $client->describeAccelerators([/* ... */]);
$promise = $client->describeAcceleratorsAsync([/* ... */]);

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

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.

Parameter Syntax

$result = $client->describeAccelerators([
    'acceleratorIds' => ['<string>', ...],
    'filters' => [
        [
            'name' => '<string>',
            'values' => ['<string>', ...],
        ],
        // ...
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
acceleratorIds
Type: Array of strings

The IDs of the accelerators to describe.

filters
Type: Array of Filter structures

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.

maxResults
Type: int

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.

nextToken
Type: string

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

Result Syntax

[
    'acceleratorSet' => [
        [
            'acceleratorHealth' => [
                'status' => '<string>',
            ],
            'acceleratorId' => '<string>',
            'acceleratorType' => '<string>',
            'attachedResource' => '<string>',
            'availabilityZone' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
acceleratorSet
Type: Array of ElasticInferenceAccelerator structures

The details of the Elastic Inference Accelerators.

nextToken
Type: string

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

Errors

BadRequestException:

Raised when a malformed input has been provided to the API.

ResourceNotFoundException:

Raised when the requested resource cannot be found.

InternalServerException:

Raised when an unexpected error occurred during request processing.

ListTagsForResource 

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Returns all tags of 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.

Parameter Syntax

$result = $client->listTagsForResource([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
resourceArn
Required: Yes
Type: string

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

Result Syntax

[
    'tags' => ['<string>', ...],
]

Result Details

Members
tags
Type: Associative array of custom strings keys (TagKey) to strings

The tags of the Elastic Inference Accelerator.

Errors

BadRequestException:

Raised when a malformed input has been provided to the API.

ResourceNotFoundException:

Raised when the requested resource cannot be found.

InternalServerException:

Raised when an unexpected error occurred during request processing.

TagResource 

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
resourceArn
Required: Yes
Type: string

The ARN of the Elastic Inference Accelerator to tag.

tags
Required: Yes
Type: Associative array of custom strings keys (TagKey) to strings

The tags to add to the Elastic Inference Accelerator.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

BadRequestException:

Raised when a malformed input has been provided to the API.

ResourceNotFoundException:

Raised when the requested resource cannot be found.

InternalServerException:

Raised when an unexpected error occurred during request processing.

UntagResource 

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes the specified tags from 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.

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
resourceArn
Required: Yes
Type: string

The ARN of the Elastic Inference Accelerator to untag.

tagKeys
Required: Yes
Type: Array of strings

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

BadRequestException:

Raised when a malformed input has been provided to the API.

ResourceNotFoundException:

Raised when the requested resource cannot be found.

InternalServerException:

Raised when an unexpected error occurred during request processing.

Shapes

AcceleratorType

Description

The details of an Elastic Inference Accelerator type.

Members
acceleratorTypeName
Type: string

The name of the Elastic Inference Accelerator type.

memoryInfo
Type: MemoryInfo structure

The memory information of the Elastic Inference Accelerator type.

throughputInfo
Type: Array of KeyValuePair structures

The throughput information of the Elastic Inference Accelerator type.

AcceleratorTypeOffering

Description

The offering for an Elastic Inference Accelerator type.

Members
acceleratorType
Type: string

The name of the Elastic Inference Accelerator type.

location
Type: 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.

locationType
Type: 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.

BadRequestException

Description

Raised when a malformed input has been provided to the API.

Members
message
Type: string

ElasticInferenceAccelerator

Description

The details of an Elastic Inference Accelerator.

Members
acceleratorHealth
Type: ElasticInferenceAcceleratorHealth structure

The health of the Elastic Inference Accelerator.

acceleratorId
Type: string

The ID of the Elastic Inference Accelerator.

acceleratorType
Type: string

The type of the Elastic Inference Accelerator.

attachedResource
Type: string

The ARN of the resource that the Elastic Inference Accelerator is attached to.

availabilityZone
Type: string

The availability zone where the Elastic Inference Accelerator is present.

ElasticInferenceAcceleratorHealth

Description

The health details of an Elastic Inference Accelerator.

Members
status
Type: string

The health status of the Elastic Inference Accelerator.

Filter

Description

A filter expression for the Elastic Inference Accelerator list.

Members
name
Type: 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
Type: Array of strings

The values for the filter of the Elastic Inference Accelerator list.

InternalServerException

Description

Raised when an unexpected error occurred during request processing.

Members
message
Type: string

KeyValuePair

Description

A throughput entry for an Elastic Inference Accelerator type.

Members
key
Type: 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
Type: int

The throughput value of the Elastic Inference Accelerator type.

MemoryInfo

Description

The memory information of an Elastic Inference Accelerator type.

Members
sizeInMiB
Type: int

The size in mebibytes of the Elastic Inference Accelerator type.

ResourceNotFoundException

Description

Raised when the requested resource cannot be found.

Members
message
Type: string