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

Description

Describes one or more of your virtual private gateways.

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.

Synopsis

Creating a Request

data DescribeVpnGateways Source #

Contains the parameters for DescribeVpnGateways.

See: newDescribeVpnGateways smart constructor.

Constructors

DescribeVpnGateways' 

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.

    • amazon-side-asn - The Autonomous System Number (ASN) for the Amazon side of the gateway.
    • attachment.state - The current state of the attachment between the gateway and the VPC (attaching | attached | detaching | detached).
    • attachment.vpc-id - The ID of an attached VPC.
    • availability-zone - The Availability Zone for the virtual private gateway (if applicable).
    • state - The state of the virtual private gateway (pending | available | deleting | deleted).
    • 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.
    • type - The type of virtual private gateway. Currently the only supported type is ipsec.1.
    • vpn-gateway-id - The ID of the virtual private gateway.
  • vpnGatewayIds :: Maybe [Text]

    One or more virtual private gateway IDs.

    Default: Describes all your virtual private gateways.

Instances

Instances details
ToHeaders DescribeVpnGateways Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpnGateways

Methods

toHeaders :: DescribeVpnGateways -> [Header] #

ToPath DescribeVpnGateways Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpnGateways

Methods

toPath :: DescribeVpnGateways -> ByteString #

ToQuery DescribeVpnGateways Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpnGateways

Methods

toQuery :: DescribeVpnGateways -> QueryString #

AWSRequest DescribeVpnGateways Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpnGateways

Associated Types

type AWSResponse DescribeVpnGateways #

Methods

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

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

Generic DescribeVpnGateways Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpnGateways

Associated Types

type Rep DescribeVpnGateways :: Type -> Type #

Methods

from :: DescribeVpnGateways -> Rep DescribeVpnGateways x #

to :: Rep DescribeVpnGateways x -> DescribeVpnGateways #

Read DescribeVpnGateways Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpnGateways

Methods

readsPrec :: Int -> ReadS DescribeVpnGateways #

readList :: ReadS [DescribeVpnGateways] #

readPrec :: ReadPrec DescribeVpnGateways #

readListPrec :: ReadPrec [DescribeVpnGateways] #

Show DescribeVpnGateways Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpnGateways

Methods

showsPrec :: Int -> DescribeVpnGateways -> ShowS #

show :: DescribeVpnGateways -> String #

showList :: [DescribeVpnGateways] -> ShowS #

NFData DescribeVpnGateways Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpnGateways

Methods

rnf :: DescribeVpnGateways -> () #

Eq DescribeVpnGateways Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpnGateways

Methods

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

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

Hashable DescribeVpnGateways Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpnGateways

Methods

hashWithSalt :: Int -> DescribeVpnGateways -> Int #

hash :: DescribeVpnGateways -> Int #

type AWSResponse DescribeVpnGateways Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpnGateways

type AWSResponse DescribeVpnGateways = DescribeVpnGatewaysResponse
type Rep DescribeVpnGateways Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpnGateways

type Rep DescribeVpnGateways = D1 ('MetaData "DescribeVpnGateways" "Amazonka.EC2.DescribeVpnGateways" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeVpnGateways'" '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 "vpnGatewayIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))))

newDescribeVpnGateways :: DescribeVpnGateways Source #

Create a value of DescribeVpnGateways 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:DescribeVpnGateways', describeVpnGateways_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:DescribeVpnGateways', describeVpnGateways_filters - One or more filters.

  • amazon-side-asn - The Autonomous System Number (ASN) for the Amazon side of the gateway.
  • attachment.state - The current state of the attachment between the gateway and the VPC (attaching | attached | detaching | detached).
  • attachment.vpc-id - The ID of an attached VPC.
  • availability-zone - The Availability Zone for the virtual private gateway (if applicable).
  • state - The state of the virtual private gateway (pending | available | deleting | deleted).
  • 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.
  • type - The type of virtual private gateway. Currently the only supported type is ipsec.1.
  • vpn-gateway-id - The ID of the virtual private gateway.

$sel:vpnGatewayIds:DescribeVpnGateways', describeVpnGateways_vpnGatewayIds - One or more virtual private gateway IDs.

Default: Describes all your virtual private gateways.

Request Lenses

describeVpnGateways_dryRun :: Lens' DescribeVpnGateways (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.

describeVpnGateways_filters :: Lens' DescribeVpnGateways (Maybe [Filter]) Source #

One or more filters.

  • amazon-side-asn - The Autonomous System Number (ASN) for the Amazon side of the gateway.
  • attachment.state - The current state of the attachment between the gateway and the VPC (attaching | attached | detaching | detached).
  • attachment.vpc-id - The ID of an attached VPC.
  • availability-zone - The Availability Zone for the virtual private gateway (if applicable).
  • state - The state of the virtual private gateway (pending | available | deleting | deleted).
  • 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.
  • type - The type of virtual private gateway. Currently the only supported type is ipsec.1.
  • vpn-gateway-id - The ID of the virtual private gateway.

describeVpnGateways_vpnGatewayIds :: Lens' DescribeVpnGateways (Maybe [Text]) Source #

One or more virtual private gateway IDs.

Default: Describes all your virtual private gateways.

Destructuring the Response

data DescribeVpnGatewaysResponse Source #

Contains the output of DescribeVpnGateways.

See: newDescribeVpnGatewaysResponse smart constructor.

Constructors

DescribeVpnGatewaysResponse' 

Fields

Instances

Instances details
Generic DescribeVpnGatewaysResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpnGateways

Associated Types

type Rep DescribeVpnGatewaysResponse :: Type -> Type #

Methods

from :: DescribeVpnGatewaysResponse -> Rep DescribeVpnGatewaysResponse x #

to :: Rep DescribeVpnGatewaysResponse x -> DescribeVpnGatewaysResponse #

Read DescribeVpnGatewaysResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpnGateways

Methods

readsPrec :: Int -> ReadS DescribeVpnGatewaysResponse #

readList :: ReadS [DescribeVpnGatewaysResponse] #

readPrec :: ReadPrec DescribeVpnGatewaysResponse #

readListPrec :: ReadPrec [DescribeVpnGatewaysResponse] #

Show DescribeVpnGatewaysResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpnGateways

Methods

showsPrec :: Int -> DescribeVpnGatewaysResponse -> ShowS #

show :: DescribeVpnGatewaysResponse -> String #

showList :: [DescribeVpnGatewaysResponse] -> ShowS #

NFData DescribeVpnGatewaysResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpnGateways

Methods

rnf :: DescribeVpnGatewaysResponse -> () #

Eq DescribeVpnGatewaysResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpnGateways

Methods

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

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

type Rep DescribeVpnGatewaysResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpnGateways

type Rep DescribeVpnGatewaysResponse = D1 ('MetaData "DescribeVpnGatewaysResponse" "Amazonka.EC2.DescribeVpnGateways" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeVpnGatewaysResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "vpnGateways") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [VpnGateway])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDescribeVpnGatewaysResponse Source #

Arguments

:: Int

$sel:httpStatus:DescribeVpnGatewaysResponse'

-> DescribeVpnGatewaysResponse 

Create a value of DescribeVpnGatewaysResponse 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:vpnGateways:DescribeVpnGatewaysResponse', describeVpnGatewaysResponse_vpnGateways - Information about one or more virtual private gateways.

$sel:httpStatus:DescribeVpnGatewaysResponse', describeVpnGatewaysResponse_httpStatus - The response's http status code.

Response Lenses

describeVpnGatewaysResponse_vpnGateways :: Lens' DescribeVpnGatewaysResponse (Maybe [VpnGateway]) Source #

Information about one or more virtual private gateways.

describeVpnGatewaysResponse_httpStatus :: Lens' DescribeVpnGatewaysResponse Int Source #

The response's http status code.