ec2_describe_elastic_gpus {aws.ecx}

Describe Elastic Gpus

Description

Describes the Elastic Graphics accelerator associated with your instances. For more information about Elastic Graphics, see Amazon Elastic Graphics.

Usage

ec2_describe_elastic_gpus(
  ElasticGpuId = NULL,
  DryRun = NULL,
  Filter = NULL,
  MaxResults = NULL,
  NextToken = NULL,
  simplify = TRUE,
  others = list(),
  print_on_error = aws_get_print_on_error(),
  retry_time = aws_get_retry_time(),
  network_timeout = aws_get_network_timeout(),
  region = aws_get_region()
)

Arguments

ElasticGpuId

List. The Elastic Graphics accelerator IDs.[optional]

DryRun

Logical. Checks whether you have the required permissions for the action, without actually making the request,...[optional]

Filter

Named list where the name is the filter name and the value is the filter's value. The value can be a vector or a list object (see below)[optional]

MaxResults

Integer. The maximum number of results to return in a single call.[optional]

NextToken

Characters. The token for the next page of results[optional]

simplify

Logical. Whether to simplify the result and handle nextToken in the response[optional]

others

Named list. The parameters that are not included in the function parameters and need to be added into the request[optional]

print_on_error

Logical. Whether to show an error message when a network error occurs.

retry_time

Integer. Number of retries for a REST request when encounter the network issue. If the request has been sent retry_time times but still not be able to get the response, an error will be thrown.

network_timeout

Numeric. Number of seconds to wait for a REST response until giving up. Can not be less than 1 ms.

region

Character. The region of the AWS service.

Value

A list object or a character vector

ElasticGpuId

The Elastic Graphics accelerator IDs.

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.

Filter

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.

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.