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.DescribeInternetGateways

Description

Describes one or more of your internet gateways.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeInternetGateways Source #

See: newDescribeInternetGateways smart constructor.

Constructors

DescribeInternetGateways' 

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.

  • filters :: Maybe [Filter]

    One or more filters.

    • attachment.state - The current state of the attachment between the gateway and the VPC (available). Present only if a VPC is attached.
    • attachment.vpc-id - The ID of an attached VPC.
    • internet-gateway-id - The ID of the Internet gateway.
    • owner-id - The ID of the Amazon Web Services account that owns the internet gateway.
    • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
    • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
  • internetGatewayIds :: Maybe [Text]

    One or more internet gateway IDs.

    Default: Describes all your internet gateways.

  • maxResults :: Maybe Natural

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

  • nextToken :: Maybe Text

    The token for the next page of results.

Instances

Instances details
ToHeaders DescribeInternetGateways Source # 
Instance details

Defined in Amazonka.EC2.DescribeInternetGateways

Methods

toHeaders :: DescribeInternetGateways -> [Header] #

ToPath DescribeInternetGateways Source # 
Instance details

Defined in Amazonka.EC2.DescribeInternetGateways

Methods

toPath :: DescribeInternetGateways -> ByteString #

ToQuery DescribeInternetGateways Source # 
Instance details

Defined in Amazonka.EC2.DescribeInternetGateways

Methods

toQuery :: DescribeInternetGateways -> QueryString #

AWSPager DescribeInternetGateways Source # 
Instance details

Defined in Amazonka.EC2.DescribeInternetGateways

Methods

page :: DescribeInternetGateways -> AWSResponse DescribeInternetGateways -> Maybe DescribeInternetGateways #

AWSRequest DescribeInternetGateways Source # 
Instance details

Defined in Amazonka.EC2.DescribeInternetGateways

Associated Types

type AWSResponse DescribeInternetGateways #

Methods

request :: (Service -> Service) -> DescribeInternetGateways -> Request DescribeInternetGateways #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeInternetGateways -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeInternetGateways))) #

Generic DescribeInternetGateways Source # 
Instance details

Defined in Amazonka.EC2.DescribeInternetGateways

Associated Types

type Rep DescribeInternetGateways :: Type -> Type #

Methods

from :: DescribeInternetGateways -> Rep DescribeInternetGateways x #

to :: Rep DescribeInternetGateways x -> DescribeInternetGateways #

Read DescribeInternetGateways Source # 
Instance details

Defined in Amazonka.EC2.DescribeInternetGateways

Methods

readsPrec :: Int -> ReadS DescribeInternetGateways #

readList :: ReadS [DescribeInternetGateways] #

readPrec :: ReadPrec DescribeInternetGateways #

readListPrec :: ReadPrec [DescribeInternetGateways] #

Show DescribeInternetGateways Source # 
Instance details

Defined in Amazonka.EC2.DescribeInternetGateways

Methods

showsPrec :: Int -> DescribeInternetGateways -> ShowS #

show :: DescribeInternetGateways -> String #

showList :: [DescribeInternetGateways] -> ShowS #

NFData DescribeInternetGateways Source # 
Instance details

Defined in Amazonka.EC2.DescribeInternetGateways

Methods

rnf :: DescribeInternetGateways -> () #

Eq DescribeInternetGateways Source # 
Instance details

Defined in Amazonka.EC2.DescribeInternetGateways

Methods

(==) :: DescribeInternetGateways -> DescribeInternetGateways -> Bool #

(/=) :: DescribeInternetGateways -> DescribeInternetGateways -> Bool #

Hashable DescribeInternetGateways Source # 
Instance details

Defined in Amazonka.EC2.DescribeInternetGateways

Methods

hashWithSalt :: Int -> DescribeInternetGateways -> Int #

hash :: DescribeInternetGateways -> Int #

type AWSResponse DescribeInternetGateways Source # 
Instance details

Defined in Amazonka.EC2.DescribeInternetGateways

type AWSResponse DescribeInternetGateways = DescribeInternetGatewaysResponse
type Rep DescribeInternetGateways Source # 
Instance details

Defined in Amazonka.EC2.DescribeInternetGateways

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

newDescribeInternetGateways :: DescribeInternetGateways Source #

Create a value of DescribeInternetGateways 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:DescribeInternetGateways', describeInternetGateways_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:filters:DescribeInternetGateways', describeInternetGateways_filters - One or more filters.

  • attachment.state - The current state of the attachment between the gateway and the VPC (available). Present only if a VPC is attached.
  • attachment.vpc-id - The ID of an attached VPC.
  • internet-gateway-id - The ID of the Internet gateway.
  • owner-id - The ID of the Amazon Web Services account that owns the internet gateway.
  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

$sel:internetGatewayIds:DescribeInternetGateways', describeInternetGateways_internetGatewayIds - One or more internet gateway IDs.

Default: Describes all your internet gateways.

$sel:maxResults:DescribeInternetGateways', describeInternetGateways_maxResults - The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

DescribeInternetGateways, describeInternetGateways_nextToken - The token for the next page of results.

Request Lenses

describeInternetGateways_dryRun :: Lens' DescribeInternetGateways (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.

describeInternetGateways_filters :: Lens' DescribeInternetGateways (Maybe [Filter]) Source #

One or more filters.

  • attachment.state - The current state of the attachment between the gateway and the VPC (available). Present only if a VPC is attached.
  • attachment.vpc-id - The ID of an attached VPC.
  • internet-gateway-id - The ID of the Internet gateway.
  • owner-id - The ID of the Amazon Web Services account that owns the internet gateway.
  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

describeInternetGateways_internetGatewayIds :: Lens' DescribeInternetGateways (Maybe [Text]) Source #

One or more internet gateway IDs.

Default: Describes all your internet gateways.

describeInternetGateways_maxResults :: Lens' DescribeInternetGateways (Maybe Natural) Source #

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

describeInternetGateways_nextToken :: Lens' DescribeInternetGateways (Maybe Text) Source #

The token for the next page of results.

Destructuring the Response

data DescribeInternetGatewaysResponse Source #

See: newDescribeInternetGatewaysResponse smart constructor.

Constructors

DescribeInternetGatewaysResponse' 

Fields

Instances

Instances details
Generic DescribeInternetGatewaysResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeInternetGateways

Associated Types

type Rep DescribeInternetGatewaysResponse :: Type -> Type #

Methods

from :: DescribeInternetGatewaysResponse -> Rep DescribeInternetGatewaysResponse x #

to :: Rep DescribeInternetGatewaysResponse x -> DescribeInternetGatewaysResponse #

Read DescribeInternetGatewaysResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeInternetGateways

Methods

readsPrec :: Int -> ReadS DescribeInternetGatewaysResponse #

readList :: ReadS [DescribeInternetGatewaysResponse] #

readPrec :: ReadPrec DescribeInternetGatewaysResponse #

readListPrec :: ReadPrec [DescribeInternetGatewaysResponse] #

Show DescribeInternetGatewaysResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeInternetGateways

Methods

showsPrec :: Int -> DescribeInternetGatewaysResponse -> ShowS #

show :: DescribeInternetGatewaysResponse -> String #

showList :: [DescribeInternetGatewaysResponse] -> ShowS #

NFData DescribeInternetGatewaysResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeInternetGateways

Methods

rnf :: DescribeInternetGatewaysResponse -> () #

Eq DescribeInternetGatewaysResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeInternetGateways

Methods

(==) :: DescribeInternetGatewaysResponse -> DescribeInternetGatewaysResponse -> Bool #

(/=) :: DescribeInternetGatewaysResponse -> DescribeInternetGatewaysResponse -> Bool #

type Rep DescribeInternetGatewaysResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeInternetGateways

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

newDescribeInternetGatewaysResponse Source #

Arguments

:: Int

$sel:httpStatus:DescribeInternetGatewaysResponse'

-> DescribeInternetGatewaysResponse 

Create a value of DescribeInternetGatewaysResponse 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:internetGateways:DescribeInternetGatewaysResponse', describeInternetGatewaysResponse_internetGateways - Information about one or more internet gateways.

DescribeInternetGateways, describeInternetGatewaysResponse_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:DescribeInternetGatewaysResponse', describeInternetGatewaysResponse_httpStatus - The response's http status code.

Response Lenses

describeInternetGatewaysResponse_internetGateways :: Lens' DescribeInternetGatewaysResponse (Maybe [InternetGateway]) Source #

Information about one or more internet gateways.

describeInternetGatewaysResponse_nextToken :: Lens' DescribeInternetGatewaysResponse (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.

describeInternetGatewaysResponse_httpStatus :: Lens' DescribeInternetGatewaysResponse Int Source #

The response's http status code.