EC2 / Client / describe_elastic_gpus

describe_elastic_gpus

EC2.Client.describe_elastic_gpus(**kwargs)

Note

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

Describes the Elastic Graphics accelerator associated with your instances.

See also: AWS API Documentation

Request Syntax

response = client.describe_elastic_gpus(
    ElasticGpuIds=[
        'string',
    ],
    DryRun=True|False,
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    NextToken='string'
)

Parameters:

• ElasticGpuIds (list) –

  The Elastic Graphics accelerator IDs.

  • (string) –

• DryRun (boolean) – 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.

• Filters (list) –

  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.

  • (dict) –

    A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

    If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.

    For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.

    • Name (string) –

      The name of the filter. Filter names are case-sensitive.

    • Values (list) –

      The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

      • (string) –

• MaxResults (integer) – 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.

• NextToken (string) – The token to request the next page of results.

Return type:

dict

Returns:

Response Syntax

{
    'ElasticGpuSet': [
        {
            'ElasticGpuId': 'string',
            'AvailabilityZone': 'string',
            'ElasticGpuType': 'string',
            'ElasticGpuHealth': {
                'Status': 'OK'|'IMPAIRED'
            },
            'ElasticGpuState': 'ATTACHED',
            'InstanceId': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    'MaxResults': 123,
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • ElasticGpuSet (list) –

    Information about the Elastic Graphics accelerators.

    • (dict) –

      Note

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

      Describes an Elastic Graphics accelerator.

      • ElasticGpuId (string) –

        The ID of the Elastic Graphics accelerator.

      • AvailabilityZone (string) –

        The Availability Zone in the which the Elastic Graphics accelerator resides.

      • ElasticGpuType (string) –

        The type of Elastic Graphics accelerator.

      • ElasticGpuHealth (dict) –

        The status of the Elastic Graphics accelerator.

        • Status (string) –

          The health status.

      • ElasticGpuState (string) –

        The state of the Elastic Graphics accelerator.

      • InstanceId (string) –

        The ID of the instance to which the Elastic Graphics accelerator is attached.

      • Tags (list) –

        The tags assigned to the Elastic Graphics accelerator.

        • (dict) –

          Describes a tag.

          • Key (string) –

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.

          • Value (string) –

            The value of the tag.

            Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

  • MaxResults (integer) –

    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.

  • NextToken (string) –

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