Menu
Amazon Elastic Compute Cloud
API Reference (API Version 2016-11-15)

DescribeElasticGpus

Describes the Elastic GPUs associated with your instances. For more information about Elastic GPUs, see Amazon EC2 Elastic GPUs.

Request Parameters

The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.

DryRun

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Type: Boolean

Required: No

ElasticGpuId.N

One or more Elastic GPU IDs.

Type: Array of strings

Required: No

Filter.N

One or more filters.

  • availability-zone - The Availability Zone in which the Elastic GPU resides.

  • elastic-gpu-health - The status of the Elastic GPU (OK | IMPAIRED).

  • elastic-gpu-state - The state of the Elastic GPU (ATTACHED).

  • elastic-gpu-type - The type of Elastic GPU; for example, eg1.medium.

  • instance-id - The ID of the instance to which the Elastic GPU is associated.

Type: Array of Filter objects

Required: No

MaxResults

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 5 and 1000.

Type: Integer

Required: No

NextToken

The token to request the next page of results.

Type: String

Required: No

Response Elements

The following elements are returned by the service.

elasticGpuSet

Information about the Elastic GPUs.

Type: Array of ElasticGpus objects

maxResults

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 Next-Token will be provided in the output that you can use to resume pagination.

Type: Integer

nextToken

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Type: String

requestId

The ID of the request.

Type: String

Errors

For information about the errors that are common to all actions, see Common Client Errors.

Example

Example

This example describes all of the Elastic GPUs associated with your instances.

Sample Request

Copy
https://ec2.amazonaws.com/?Action=DescribeElasticGpus &AUTHPARAMS

Sample Response

Copy
<DescribeElasticGpusResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/"> <requestId>450268ba-0e1d-4401-958e-9a3example</requestId> <elasticGpuSet> <item> <elasticGpuId>egpu-0833fd743e7227123</elasticGpuId> <availabilityZone>us-east-1a</availabilityZone> <elasticGpuType>eg1.small</elasticGpuType> <elasticGpuHealth>OK</elasticGpuHealth> <elasticGpuState>ATTACHED</elasticGpuState> <instanceId>i-1234567890abc1234</instanceId> </item> </elasticGpuSet> </DescribeElasticGpusResponse>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: