Amazonka.EC2.DescribeCustomerGateways

Describes one or more of your VPN customer gateways.

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

Creating a Request

data DescribeCustomerGateways

Contains the parameters for DescribeCustomerGateways.

See: newDescribeCustomerGateways smart constructor.

Constructors

DescribeCustomerGateways'

Fields

• customerGatewayIds :: Maybe [Text]

  One or more customer gateway IDs.

  Default: Describes all your customer gateways.

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

  • 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 device's 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> - 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.

Instances

ToHeaders DescribeCustomerGateways

Defined in Amazonka.EC2.DescribeCustomerGateways

Methods

toHeaders :: DescribeCustomerGateways -> [Header]

ToPath DescribeCustomerGateways

Defined in Amazonka.EC2.DescribeCustomerGateways

Methods

toPath :: DescribeCustomerGateways -> ByteString

ToQuery DescribeCustomerGateways

Defined in Amazonka.EC2.DescribeCustomerGateways

Methods

toQuery :: DescribeCustomerGateways -> QueryString

AWSRequest DescribeCustomerGateways

Defined in Amazonka.EC2.DescribeCustomerGateways

Associated Types

type AWSResponse DescribeCustomerGateways

Methods

request :: (Service -> Service) -> DescribeCustomerGateways -> Request DescribeCustomerGateways

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

Generic DescribeCustomerGateways

Defined in Amazonka.EC2.DescribeCustomerGateways

Associated Types

type Rep DescribeCustomerGateways :: Type -> Type

Methods

from :: DescribeCustomerGateways -> Rep DescribeCustomerGateways x

to :: Rep DescribeCustomerGateways x -> DescribeCustomerGateways

Read DescribeCustomerGateways

Defined in Amazonka.EC2.DescribeCustomerGateways

Methods

readsPrec :: Int -> ReadS DescribeCustomerGateways

readList :: ReadS [DescribeCustomerGateways]

readPrec :: ReadPrec DescribeCustomerGateways

readListPrec :: ReadPrec [DescribeCustomerGateways]

Show DescribeCustomerGateways

Defined in Amazonka.EC2.DescribeCustomerGateways

Methods

showsPrec :: Int -> DescribeCustomerGateways -> ShowS

show :: DescribeCustomerGateways -> String

showList :: [DescribeCustomerGateways] -> ShowS

NFData DescribeCustomerGateways

Defined in Amazonka.EC2.DescribeCustomerGateways

Methods

rnf :: DescribeCustomerGateways -> ()

Eq DescribeCustomerGateways

Defined in Amazonka.EC2.DescribeCustomerGateways

Methods

(==) :: DescribeCustomerGateways -> DescribeCustomerGateways -> Bool

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

Hashable DescribeCustomerGateways

Defined in Amazonka.EC2.DescribeCustomerGateways

Methods

hashWithSalt :: Int -> DescribeCustomerGateways -> Int

hash :: DescribeCustomerGateways -> Int

type AWSResponse DescribeCustomerGateways

Defined in Amazonka.EC2.DescribeCustomerGateways

type AWSResponse DescribeCustomerGateways = DescribeCustomerGatewaysResponse

type Rep DescribeCustomerGateways

Defined in Amazonka.EC2.DescribeCustomerGateways

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

newDescribeCustomerGateways :: DescribeCustomerGateways

Create a value of DescribeCustomerGateways 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:customerGatewayIds:DescribeCustomerGateways', describeCustomerGateways_customerGatewayIds - One or more customer gateway IDs.

Default: Describes all your customer gateways.

$sel:dryRun:DescribeCustomerGateways', describeCustomerGateways_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:DescribeCustomerGateways', describeCustomerGateways_filters - 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 device's 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> - 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.

Request Lenses

describeCustomerGateways_customerGatewayIds :: Lens' DescribeCustomerGateways (Maybe [Text])

One or more customer gateway IDs.

Default: Describes all your customer gateways.

describeCustomerGateways_dryRun :: 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.

describeCustomerGateways_filters :: Lens' DescribeCustomerGateways (Maybe [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 device's 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> - 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.

Destructuring the Response

data DescribeCustomerGatewaysResponse

Contains the output of DescribeCustomerGateways.

See: newDescribeCustomerGatewaysResponse smart constructor.

Constructors

DescribeCustomerGatewaysResponse'

Fields

• customerGateways :: Maybe [CustomerGateway]

  Information about one or more customer gateways.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeCustomerGatewaysResponse

Defined in Amazonka.EC2.DescribeCustomerGateways

Associated Types

type Rep DescribeCustomerGatewaysResponse :: Type -> Type

Methods

from :: DescribeCustomerGatewaysResponse -> Rep DescribeCustomerGatewaysResponse x

to :: Rep DescribeCustomerGatewaysResponse x -> DescribeCustomerGatewaysResponse

Read DescribeCustomerGatewaysResponse

Defined in Amazonka.EC2.DescribeCustomerGateways

Methods

readsPrec :: Int -> ReadS DescribeCustomerGatewaysResponse

readList :: ReadS [DescribeCustomerGatewaysResponse]

readPrec :: ReadPrec DescribeCustomerGatewaysResponse

readListPrec :: ReadPrec [DescribeCustomerGatewaysResponse]

Show DescribeCustomerGatewaysResponse

Defined in Amazonka.EC2.DescribeCustomerGateways

Methods

showsPrec :: Int -> DescribeCustomerGatewaysResponse -> ShowS

show :: DescribeCustomerGatewaysResponse -> String

showList :: [DescribeCustomerGatewaysResponse] -> ShowS

NFData DescribeCustomerGatewaysResponse

Defined in Amazonka.EC2.DescribeCustomerGateways

Methods

rnf :: DescribeCustomerGatewaysResponse -> ()

Eq DescribeCustomerGatewaysResponse

Defined in Amazonka.EC2.DescribeCustomerGateways

Methods

(==) :: DescribeCustomerGatewaysResponse -> DescribeCustomerGatewaysResponse -> Bool

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

type Rep DescribeCustomerGatewaysResponse

Defined in Amazonka.EC2.DescribeCustomerGateways

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

newDescribeCustomerGatewaysResponse

Arguments

:: Int

$sel:httpStatus:DescribeCustomerGatewaysResponse'

-> DescribeCustomerGatewaysResponse

Create a value of DescribeCustomerGatewaysResponse 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:customerGateways:DescribeCustomerGatewaysResponse', describeCustomerGatewaysResponse_customerGateways - Information about one or more customer gateways.

$sel:httpStatus:DescribeCustomerGatewaysResponse', describeCustomerGatewaysResponse_httpStatus - The response's http status code.

Response Lenses

describeCustomerGatewaysResponse_customerGateways :: Lens' DescribeCustomerGatewaysResponse (Maybe [CustomerGateway])

Information about one or more customer gateways.

describeCustomerGatewaysResponse_httpStatus :: Lens' DescribeCustomerGatewaysResponse Int

The response's http status code.