amazonka-ec2-2.0: Amazon Elastic Compute Cloud SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.EC2.DescribeElasticGpus

Description

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

Synopsis

Creating a Request

data DescribeElasticGpus Source #

See: newDescribeElasticGpus smart constructor.

Constructors

DescribeElasticGpus' 

Fields

  • dryRun :: Maybe Bool

    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.

  • elasticGpuIds :: Maybe [Text]

    The Elastic Graphics accelerator IDs.

  • filters :: Maybe [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 :: Maybe Natural

    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 :: Maybe Text

    The token to request the next page of results.

Instances

Instances details
ToHeaders DescribeElasticGpus Source # 
Instance details

Defined in Amazonka.EC2.DescribeElasticGpus

ToPath DescribeElasticGpus Source # 
Instance details

Defined in Amazonka.EC2.DescribeElasticGpus

ToQuery DescribeElasticGpus Source # 
Instance details

Defined in Amazonka.EC2.DescribeElasticGpus

AWSRequest DescribeElasticGpus Source # 
Instance details

Defined in Amazonka.EC2.DescribeElasticGpus

Associated Types

type AWSResponse DescribeElasticGpus #

Generic DescribeElasticGpus Source # 
Instance details

Defined in Amazonka.EC2.DescribeElasticGpus

Associated Types

type Rep DescribeElasticGpus :: Type -> Type #

Read DescribeElasticGpus Source # 
Instance details

Defined in Amazonka.EC2.DescribeElasticGpus

Show DescribeElasticGpus Source # 
Instance details

Defined in Amazonka.EC2.DescribeElasticGpus

NFData DescribeElasticGpus Source # 
Instance details

Defined in Amazonka.EC2.DescribeElasticGpus

Methods

rnf :: DescribeElasticGpus -> () #

Eq DescribeElasticGpus Source # 
Instance details

Defined in Amazonka.EC2.DescribeElasticGpus

Hashable DescribeElasticGpus Source # 
Instance details

Defined in Amazonka.EC2.DescribeElasticGpus

type AWSResponse DescribeElasticGpus Source # 
Instance details

Defined in Amazonka.EC2.DescribeElasticGpus

type Rep DescribeElasticGpus Source # 
Instance details

Defined in Amazonka.EC2.DescribeElasticGpus

type Rep DescribeElasticGpus = D1 ('MetaData "DescribeElasticGpus" "Amazonka.EC2.DescribeElasticGpus" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeElasticGpus'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "elasticGpuIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter])) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newDescribeElasticGpus :: DescribeElasticGpus Source #

Create a value of DescribeElasticGpus with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dryRun:DescribeElasticGpus', describeElasticGpus_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.

$sel:elasticGpuIds:DescribeElasticGpus', describeElasticGpus_elasticGpuIds - The Elastic Graphics accelerator IDs.

$sel:filters:DescribeElasticGpus', describeElasticGpus_filters - 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.

DescribeElasticGpus, describeElasticGpus_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.

DescribeElasticGpus, describeElasticGpus_nextToken - The token to request the next page of results.

Request Lenses

describeElasticGpus_dryRun :: Lens' DescribeElasticGpus (Maybe Bool) Source #

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.

describeElasticGpus_elasticGpuIds :: Lens' DescribeElasticGpus (Maybe [Text]) Source #

The Elastic Graphics accelerator IDs.

describeElasticGpus_filters :: Lens' DescribeElasticGpus (Maybe [Filter]) Source #

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.

describeElasticGpus_maxResults :: Lens' DescribeElasticGpus (Maybe Natural) Source #

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.

describeElasticGpus_nextToken :: Lens' DescribeElasticGpus (Maybe Text) Source #

The token to request the next page of results.

Destructuring the Response

data DescribeElasticGpusResponse Source #

See: newDescribeElasticGpusResponse smart constructor.

Constructors

DescribeElasticGpusResponse' 

Fields

  • elasticGpuSet :: Maybe [ElasticGpus]

    Information about the Elastic Graphics accelerators.

  • maxResults :: Maybe Int

    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 :: Maybe Text

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

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic DescribeElasticGpusResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeElasticGpus

Associated Types

type Rep DescribeElasticGpusResponse :: Type -> Type #

Read DescribeElasticGpusResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeElasticGpus

Show DescribeElasticGpusResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeElasticGpus

NFData DescribeElasticGpusResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeElasticGpus

Eq DescribeElasticGpusResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeElasticGpus

type Rep DescribeElasticGpusResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeElasticGpus

type Rep DescribeElasticGpusResponse = D1 ('MetaData "DescribeElasticGpusResponse" "Amazonka.EC2.DescribeElasticGpus" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeElasticGpusResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "elasticGpuSet") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ElasticGpus])) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeElasticGpusResponse Source #

Create a value of DescribeElasticGpusResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:elasticGpuSet:DescribeElasticGpusResponse', describeElasticGpusResponse_elasticGpuSet - Information about the Elastic Graphics accelerators.

DescribeElasticGpus, describeElasticGpusResponse_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.

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

$sel:httpStatus:DescribeElasticGpusResponse', describeElasticGpusResponse_httpStatus - The response's http status code.

Response Lenses

describeElasticGpusResponse_elasticGpuSet :: Lens' DescribeElasticGpusResponse (Maybe [ElasticGpus]) Source #

Information about the Elastic Graphics accelerators.

describeElasticGpusResponse_maxResults :: Lens' DescribeElasticGpusResponse (Maybe Int) Source #

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.

describeElasticGpusResponse_nextToken :: Lens' DescribeElasticGpusResponse (Maybe Text) Source #

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