Network.AWS.EC2.DescribeNatGateways

Describes one or more of the your NAT gateways.

This operation returns paginated results.

Creating a Request

describeNatGateways :: DescribeNatGateways

Creates a value of DescribeNatGateways with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dngNatGatewayIds - One or more NAT gateway IDs.
• dngNextToken - The token to retrieve the next page of results.
• dngFilter - 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 =value - The keyvalue combination of a tag assigned to the resource. Specify the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag Purpose=X, specify tag:Purpose for the filter name and X for the filter value. * tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag :key =value/ filter. * tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter. * vpc-id - The ID of the VPC in which the NAT gateway resides.
• dngMaxResults - The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results. Constraint: If the value specified is greater than 1000, we return only 1000 items.

data DescribeNatGateways

Contains the parameters for DescribeNatGateways.

See: describeNatGateways smart constructor.

Instances

Eq DescribeNatGateways

Methods

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

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

Data DescribeNatGateways

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeNatGateways -> c DescribeNatGateways

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeNatGateways

toConstr :: DescribeNatGateways -> Constr

dataTypeOf :: DescribeNatGateways -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeNatGateways)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeNatGateways)

gmapT :: (forall b. Data b => b -> b) -> DescribeNatGateways -> DescribeNatGateways

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeNatGateways -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeNatGateways -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeNatGateways -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeNatGateways -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeNatGateways -> m DescribeNatGateways

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeNatGateways -> m DescribeNatGateways

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeNatGateways -> m DescribeNatGateways

Read DescribeNatGateways

Methods

readsPrec :: Int -> ReadS DescribeNatGateways

readList :: ReadS [DescribeNatGateways]

readPrec :: ReadPrec DescribeNatGateways

readListPrec :: ReadPrec [DescribeNatGateways]

Show DescribeNatGateways

Methods

showsPrec :: Int -> DescribeNatGateways -> ShowS

show :: DescribeNatGateways -> String

showList :: [DescribeNatGateways] -> ShowS

Generic DescribeNatGateways

Associated Types

type Rep DescribeNatGateways :: * -> *

Methods

from :: DescribeNatGateways -> Rep DescribeNatGateways x

to :: Rep DescribeNatGateways x -> DescribeNatGateways

Hashable DescribeNatGateways

Methods

hashWithSalt :: Int -> DescribeNatGateways -> Int

hash :: DescribeNatGateways -> Int

NFData DescribeNatGateways

Methods

rnf :: DescribeNatGateways -> ()

AWSPager DescribeNatGateways

Methods

page :: DescribeNatGateways -> Rs DescribeNatGateways -> Maybe DescribeNatGateways

AWSRequest DescribeNatGateways

Associated Types

type Rs DescribeNatGateways :: *

Methods

request :: DescribeNatGateways -> Request DescribeNatGateways

response :: MonadResource m => Logger -> Service -> Proxy * DescribeNatGateways -> ClientResponse -> m (Response DescribeNatGateways)

ToQuery DescribeNatGateways

Methods

toQuery :: DescribeNatGateways -> QueryString

ToPath DescribeNatGateways

Methods

toPath :: DescribeNatGateways -> ByteString

ToHeaders DescribeNatGateways

Methods

toHeaders :: DescribeNatGateways -> [Header]

type Rep DescribeNatGateways

type Rep DescribeNatGateways = D1 (MetaData "DescribeNatGateways" "Network.AWS.EC2.DescribeNatGateways" "amazonka-ec2-1.5.0-8IdXK3SzsETDMW2aFpANS9" False) (C1 (MetaCons "DescribeNatGateways'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_dngNatGatewayIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) (S1 (MetaSel (Just Symbol "_dngNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_dngFilter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Filter]))) (S1 (MetaSel (Just Symbol "_dngMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int))))))

type Rs DescribeNatGateways

type Rs DescribeNatGateways = DescribeNatGatewaysResponse

Request Lenses

dngNatGatewayIds :: Lens' DescribeNatGateways [Text]

One or more NAT gateway IDs.

dngNextToken :: Lens' DescribeNatGateways (Maybe Text)

The token to retrieve the next page of results.

dngFilter :: Lens' 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 =value - The keyvalue combination of a tag assigned to the resource. Specify the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag Purpose=X, specify tag:Purpose for the filter name and X for the filter value. * tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag :key =value/ filter. * tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter. * vpc-id - The ID of the VPC in which the NAT gateway resides.

dngMaxResults :: Lens' DescribeNatGateways (Maybe Int)

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results. Constraint: If the value specified is greater than 1000, we return only 1000 items.

Destructuring the Response

describeNatGatewaysResponse

Arguments

:: Int

dngrsResponseStatus

-> DescribeNatGatewaysResponse

Creates a value of DescribeNatGatewaysResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dngrsNatGateways - Information about the NAT gateways.
• dngrsNextToken - The token to use to retrieve the next page of results. This value is null when there are no more results to return.
• dngrsResponseStatus - -- | The response status code.

data DescribeNatGatewaysResponse

Contains the output of DescribeNatGateways.

See: describeNatGatewaysResponse smart constructor.

Instances

Eq DescribeNatGatewaysResponse

Methods

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

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

Data DescribeNatGatewaysResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeNatGatewaysResponse -> c DescribeNatGatewaysResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeNatGatewaysResponse

toConstr :: DescribeNatGatewaysResponse -> Constr

dataTypeOf :: DescribeNatGatewaysResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeNatGatewaysResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeNatGatewaysResponse)

gmapT :: (forall b. Data b => b -> b) -> DescribeNatGatewaysResponse -> DescribeNatGatewaysResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeNatGatewaysResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeNatGatewaysResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeNatGatewaysResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeNatGatewaysResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeNatGatewaysResponse -> m DescribeNatGatewaysResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeNatGatewaysResponse -> m DescribeNatGatewaysResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeNatGatewaysResponse -> m DescribeNatGatewaysResponse

Read DescribeNatGatewaysResponse

Methods

readsPrec :: Int -> ReadS DescribeNatGatewaysResponse

readList :: ReadS [DescribeNatGatewaysResponse]

readPrec :: ReadPrec DescribeNatGatewaysResponse

readListPrec :: ReadPrec [DescribeNatGatewaysResponse]

Show DescribeNatGatewaysResponse

Methods

showsPrec :: Int -> DescribeNatGatewaysResponse -> ShowS

show :: DescribeNatGatewaysResponse -> String

showList :: [DescribeNatGatewaysResponse] -> ShowS

Generic DescribeNatGatewaysResponse

Associated Types

type Rep DescribeNatGatewaysResponse :: * -> *

Methods

from :: DescribeNatGatewaysResponse -> Rep DescribeNatGatewaysResponse x

to :: Rep DescribeNatGatewaysResponse x -> DescribeNatGatewaysResponse

NFData DescribeNatGatewaysResponse

Methods

rnf :: DescribeNatGatewaysResponse -> ()

type Rep DescribeNatGatewaysResponse

type Rep DescribeNatGatewaysResponse = D1 (MetaData "DescribeNatGatewaysResponse" "Network.AWS.EC2.DescribeNatGateways" "amazonka-ec2-1.5.0-8IdXK3SzsETDMW2aFpANS9" False) (C1 (MetaCons "DescribeNatGatewaysResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_dngrsNatGateways") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [NatGateway]))) ((:*:) (S1 (MetaSel (Just Symbol "_dngrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dngrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))))

Response Lenses

dngrsNatGateways :: Lens' DescribeNatGatewaysResponse [NatGateway]

Information about the NAT gateways.

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

dngrsResponseStatus :: Lens' DescribeNatGatewaysResponse Int

• - | The response status code.