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

Description

Describes one or more of your NAT gateways.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeNatGateways Source #

See: newDescribeNatGateways smart constructor.

Constructors

DescribeNatGateways' 

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.

  • filter' :: Maybe [Filter]

    One or more filters.

    • nat-gateway-id - The ID of the NAT gateway.
    • state - The state of the NAT gateway (pending | failed | available | deleting | deleted).
    • subnet-id - The ID of the subnet in which the NAT gateway resides.
    • 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.
    • vpc-id - The ID of the VPC in which the NAT gateway resides.
  • 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.

  • natGatewayIds :: Maybe [Text]

    One or more NAT gateway IDs.

  • nextToken :: Maybe Text

    The token for the next page of results.

Instances

Instances details
ToHeaders DescribeNatGateways Source # 
Instance details

Defined in Amazonka.EC2.DescribeNatGateways

Methods

toHeaders :: DescribeNatGateways -> [Header] #

ToPath DescribeNatGateways Source # 
Instance details

Defined in Amazonka.EC2.DescribeNatGateways

Methods

toPath :: DescribeNatGateways -> ByteString #

ToQuery DescribeNatGateways Source # 
Instance details

Defined in Amazonka.EC2.DescribeNatGateways

Methods

toQuery :: DescribeNatGateways -> QueryString #

AWSPager DescribeNatGateways Source # 
Instance details

Defined in Amazonka.EC2.DescribeNatGateways

Methods

page :: DescribeNatGateways -> AWSResponse DescribeNatGateways -> Maybe DescribeNatGateways #

AWSRequest DescribeNatGateways Source # 
Instance details

Defined in Amazonka.EC2.DescribeNatGateways

Associated Types

type AWSResponse DescribeNatGateways #

Methods

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

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

Generic DescribeNatGateways Source # 
Instance details

Defined in Amazonka.EC2.DescribeNatGateways

Associated Types

type Rep DescribeNatGateways :: Type -> Type #

Methods

from :: DescribeNatGateways -> Rep DescribeNatGateways x #

to :: Rep DescribeNatGateways x -> DescribeNatGateways #

Read DescribeNatGateways Source # 
Instance details

Defined in Amazonka.EC2.DescribeNatGateways

Methods

readsPrec :: Int -> ReadS DescribeNatGateways #

readList :: ReadS [DescribeNatGateways] #

readPrec :: ReadPrec DescribeNatGateways #

readListPrec :: ReadPrec [DescribeNatGateways] #

Show DescribeNatGateways Source # 
Instance details

Defined in Amazonka.EC2.DescribeNatGateways

Methods

showsPrec :: Int -> DescribeNatGateways -> ShowS #

show :: DescribeNatGateways -> String #

showList :: [DescribeNatGateways] -> ShowS #

NFData DescribeNatGateways Source # 
Instance details

Defined in Amazonka.EC2.DescribeNatGateways

Methods

rnf :: DescribeNatGateways -> () #

Eq DescribeNatGateways Source # 
Instance details

Defined in Amazonka.EC2.DescribeNatGateways

Methods

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

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

Hashable DescribeNatGateways Source # 
Instance details

Defined in Amazonka.EC2.DescribeNatGateways

Methods

hashWithSalt :: Int -> DescribeNatGateways -> Int #

hash :: DescribeNatGateways -> Int #

type AWSResponse DescribeNatGateways Source # 
Instance details

Defined in Amazonka.EC2.DescribeNatGateways

type AWSResponse DescribeNatGateways = DescribeNatGatewaysResponse
type Rep DescribeNatGateways Source # 
Instance details

Defined in Amazonka.EC2.DescribeNatGateways

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

newDescribeNatGateways :: DescribeNatGateways Source #

Create a value of DescribeNatGateways 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:DescribeNatGateways', describeNatGateways_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:filter':DescribeNatGateways', describeNatGateways_filter - One or more filters.

  • nat-gateway-id - The ID of the NAT gateway.
  • state - The state of the NAT gateway (pending | failed | available | deleting | deleted).
  • subnet-id - The ID of the subnet in which the NAT gateway resides.
  • 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.
  • vpc-id - The ID of the VPC in which the NAT gateway resides.

$sel:maxResults:DescribeNatGateways', describeNatGateways_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.

$sel:natGatewayIds:DescribeNatGateways', describeNatGateways_natGatewayIds - One or more NAT gateway IDs.

DescribeNatGateways, describeNatGateways_nextToken - The token for the next page of results.

Request Lenses

describeNatGateways_dryRun :: Lens' DescribeNatGateways (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.

describeNatGateways_filter :: Lens' DescribeNatGateways (Maybe [Filter]) Source #

One or more filters.

  • nat-gateway-id - The ID of the NAT gateway.
  • state - The state of the NAT gateway (pending | failed | available | deleting | deleted).
  • subnet-id - The ID of the subnet in which the NAT gateway resides.
  • 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.
  • vpc-id - The ID of the VPC in which the NAT gateway resides.

describeNatGateways_maxResults :: Lens' DescribeNatGateways (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.

describeNatGateways_natGatewayIds :: Lens' DescribeNatGateways (Maybe [Text]) Source #

One or more NAT gateway IDs.

describeNatGateways_nextToken :: Lens' DescribeNatGateways (Maybe Text) Source #

The token for the next page of results.

Destructuring the Response

data DescribeNatGatewaysResponse Source #

See: newDescribeNatGatewaysResponse smart constructor.

Constructors

DescribeNatGatewaysResponse' 

Fields

Instances

Instances details
Generic DescribeNatGatewaysResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeNatGateways

Associated Types

type Rep DescribeNatGatewaysResponse :: Type -> Type #

Methods

from :: DescribeNatGatewaysResponse -> Rep DescribeNatGatewaysResponse x #

to :: Rep DescribeNatGatewaysResponse x -> DescribeNatGatewaysResponse #

Read DescribeNatGatewaysResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeNatGateways

Methods

readsPrec :: Int -> ReadS DescribeNatGatewaysResponse #

readList :: ReadS [DescribeNatGatewaysResponse] #

readPrec :: ReadPrec DescribeNatGatewaysResponse #

readListPrec :: ReadPrec [DescribeNatGatewaysResponse] #

Show DescribeNatGatewaysResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeNatGateways

Methods

showsPrec :: Int -> DescribeNatGatewaysResponse -> ShowS #

show :: DescribeNatGatewaysResponse -> String #

showList :: [DescribeNatGatewaysResponse] -> ShowS #

NFData DescribeNatGatewaysResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeNatGateways

Methods

rnf :: DescribeNatGatewaysResponse -> () #

Eq DescribeNatGatewaysResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeNatGateways

Methods

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

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

type Rep DescribeNatGatewaysResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeNatGateways

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

newDescribeNatGatewaysResponse Source #

Arguments

:: Int

$sel:httpStatus:DescribeNatGatewaysResponse'

-> DescribeNatGatewaysResponse 

Create a value of DescribeNatGatewaysResponse 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:natGateways:DescribeNatGatewaysResponse', describeNatGatewaysResponse_natGateways - Information about the NAT gateways.

DescribeNatGateways, describeNatGatewaysResponse_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:DescribeNatGatewaysResponse', describeNatGatewaysResponse_httpStatus - The response's http status code.

Response Lenses

describeNatGatewaysResponse_natGateways :: Lens' DescribeNatGatewaysResponse (Maybe [NatGateway]) Source #

Information about the NAT gateways.

describeNatGatewaysResponse_nextToken :: Lens' DescribeNatGatewaysResponse (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.

describeNatGatewaysResponse_httpStatus :: Lens' DescribeNatGatewaysResponse Int Source #

The response's http status code.