Skip to content

EC2  >  Operations  >  describe_elastic_gpus

describe_elastic_gpus

Operation

describe_elastic_gpus async

describe_elastic_gpus(request: DescribeElasticGpusInput | DescribeElasticGpusInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeElasticGpusOutput
describe_elastic_gpus(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeElasticGpusInputDict]) -> DescribeElasticGpusOutput
Note

Amazon Elastic Graphics reached end of life on January 8, 2024.

Describes the Elastic Graphics accelerator associated with your instances.

Parameters:

Name Type Description Default
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
DescribeElasticGpusOutput

An instance of DescribeElasticGpusOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

DescribeElasticGpusInput dataclass

Bases: _SerdeShape

Dataclass for DescribeElasticGpusInput structure.

Attributes
dry_run class-attribute instance-attribute
dry_run: bool | None = ...

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.

elastic_gpu_ids class-attribute instance-attribute
elastic_gpu_ids: list[str] | None = ...

The Elastic Graphics accelerator IDs.

filters class-attribute instance-attribute
filters: list[Filter] | None = ...

The filters.

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

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

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

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

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

max_results class-attribute instance-attribute
max_results: int | None = ...

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.

next_token class-attribute instance-attribute
next_token: str | None = ...

The token to request the next page of results.

Dictionaries

DescribeElasticGpusInputDict

Bases: TypedDict

Dictionary form of DescribeElasticGpusInput.

Attributes
dry_run instance-attribute
dry_run: bool | None

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.

elastic_gpu_ids instance-attribute
elastic_gpu_ids: Sequence[str] | None

The Elastic Graphics accelerator IDs.

filters instance-attribute
filters: Sequence[Filter | FilterDict] | None

The filters.

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

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

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

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

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

max_results instance-attribute
max_results: int | None

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.

next_token instance-attribute
next_token: str | None

The token to request the next page of results.

Output

DescribeElasticGpusOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeElasticGpusOutput structure.

Attributes

elastic_gpu_set class-attribute instance-attribute
elastic_gpu_set: list[ElasticGpus] | None = ...

Information about the Elastic Graphics accelerators.

max_results class-attribute instance-attribute
max_results: int | None = ...

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.

next_token class-attribute instance-attribute
next_token: str | None = ...

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

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.