amazonka-ec2-1.4.5: Amazon Elastic Compute Cloud SDK.

Copyright(c) 2013-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.EC2.DescribeCustomerGateways

Contents

Description

Describes one or more of your VPN customer gateways.

For more information about VPN customer gateways, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide .

Synopsis

Creating a Request

describeCustomerGateways :: DescribeCustomerGateways #

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

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

  • dcgCustomerGatewayIds - One or more customer gateway IDs. Default: Describes all your customer gateways.
  • dcgFilters - One or more filters. * bgp-asn - The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN). * customer-gateway-id - The ID of the customer gateway. * ip-address - The IP address of the customer gateway's Internet-routable external interface. * state - The state of the customer gateway (pending | available | deleting | deleted ). * type - The type of customer gateway. Currently, the only supported type is ipsec.1 . * tag :key =value - The keyvalue combination of a tag assigned to the resource. * 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.
  • dcgDryRun - 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 .

data DescribeCustomerGateways #

Contains the parameters for DescribeCustomerGateways.

See: describeCustomerGateways smart constructor.

Instances

Eq DescribeCustomerGateways # 
Data DescribeCustomerGateways # 

Methods

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

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

toConstr :: DescribeCustomerGateways -> Constr #

dataTypeOf :: DescribeCustomerGateways -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> DescribeCustomerGateways -> DescribeCustomerGateways #

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

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

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

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

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

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

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

Read DescribeCustomerGateways # 
Show DescribeCustomerGateways # 
Generic DescribeCustomerGateways # 
Hashable DescribeCustomerGateways # 
NFData DescribeCustomerGateways # 
AWSRequest DescribeCustomerGateways # 
ToQuery DescribeCustomerGateways # 
ToPath DescribeCustomerGateways # 
ToHeaders DescribeCustomerGateways # 
type Rep DescribeCustomerGateways # 
type Rep DescribeCustomerGateways = D1 (MetaData "DescribeCustomerGateways" "Network.AWS.EC2.DescribeCustomerGateways" "amazonka-ec2-1.4.5-C4CR35JggG2GhWFrIiKGhu" False) (C1 (MetaCons "DescribeCustomerGateways'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_dcgCustomerGatewayIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) ((:*:) (S1 (MetaSel (Just Symbol "_dcgFilters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Filter]))) (S1 (MetaSel (Just Symbol "_dcgDryRun") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))))))
type Rs DescribeCustomerGateways # 

Request Lenses

dcgCustomerGatewayIds :: Lens' DescribeCustomerGateways [Text] #

One or more customer gateway IDs. Default: Describes all your customer gateways.

dcgFilters :: Lens' DescribeCustomerGateways [Filter] #

One or more filters. * bgp-asn - The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN). * customer-gateway-id - The ID of the customer gateway. * ip-address - The IP address of the customer gateway's Internet-routable external interface. * state - The state of the customer gateway (pending | available | deleting | deleted ). * type - The type of customer gateway. Currently, the only supported type is ipsec.1 . * tag :key =value - The keyvalue combination of a tag assigned to the resource. * 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.

dcgDryRun :: Lens' DescribeCustomerGateways (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 .

Destructuring the Response

describeCustomerGatewaysResponse #

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

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

data DescribeCustomerGatewaysResponse #

Contains the output of DescribeCustomerGateways.

See: describeCustomerGatewaysResponse smart constructor.

Instances

Eq DescribeCustomerGatewaysResponse # 
Data DescribeCustomerGatewaysResponse # 

Methods

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

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

toConstr :: DescribeCustomerGatewaysResponse -> Constr #

dataTypeOf :: DescribeCustomerGatewaysResponse -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> DescribeCustomerGatewaysResponse -> DescribeCustomerGatewaysResponse #

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

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

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

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

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

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

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

Read DescribeCustomerGatewaysResponse # 
Show DescribeCustomerGatewaysResponse # 
Generic DescribeCustomerGatewaysResponse # 
NFData DescribeCustomerGatewaysResponse # 
type Rep DescribeCustomerGatewaysResponse # 
type Rep DescribeCustomerGatewaysResponse = D1 (MetaData "DescribeCustomerGatewaysResponse" "Network.AWS.EC2.DescribeCustomerGateways" "amazonka-ec2-1.4.5-C4CR35JggG2GhWFrIiKGhu" False) (C1 (MetaCons "DescribeCustomerGatewaysResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_dcgrsCustomerGateways") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [CustomerGateway]))) (S1 (MetaSel (Just Symbol "_dcgrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int))))

Response Lenses

dcgrsCustomerGateways :: Lens' DescribeCustomerGatewaysResponse [CustomerGateway] #

Information about one or more customer gateways.