Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.EC2.DescribeTransitGateways

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes one or more transit gateways. By default, all transit gateways are described. Alternatively, you can filter the results.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeTransitGateways Source #

See: newDescribeTransitGateways smart constructor.

Constructors

DescribeTransitGateways'

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. The possible values are:
- options.propagation-default-route-table-id - The ID of the default propagation route table.
- options.amazon-side-asn - The private ASN for the Amazon side of a BGP session.
- options.association-default-route-table-id - The ID of the default association route table.
- options.auto-accept-shared-attachments - Indicates whether there is automatic acceptance of attachment requests (enable | disable).
- options.default-route-table-association - Indicates whether resource attachments are automatically associated with the default association route table (enable | disable).
- options.default-route-table-propagation - Indicates whether resource attachments automatically propagate routes to the default propagation route table (enable | disable).
- options.dns-support - Indicates whether DNS support is enabled (enable | disable).
- options.vpn-ecmp-support - Indicates whether Equal Cost Multipath Protocol support is enabled (enable | disable).
- owner-id - The ID of the Amazon Web Services account that owns the transit gateway.
- state - The state of the transit gateway (available | deleted | deleting | modifying | pending).
- transit-gateway-id - The ID of the transit gateway.
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.
nextToken :: Maybe Text
The token for the next page of results.
transitGatewayIds :: Maybe [Text]
The IDs of the transit gateways.

Instances

Instances details

ToHeaders DescribeTransitGateways Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGateways Methods toHeaders :: DescribeTransitGateways -> [Header] #
ToPath DescribeTransitGateways Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGateways Methods toPath :: DescribeTransitGateways -> ByteString #
ToQuery DescribeTransitGateways Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGateways Methods toQuery :: DescribeTransitGateways -> QueryString #
AWSPager DescribeTransitGateways Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGateways Methods page :: DescribeTransitGateways -> AWSResponse DescribeTransitGateways -> Maybe DescribeTransitGateways #
AWSRequest DescribeTransitGateways Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGateways Associated Types type AWSResponse DescribeTransitGateways # Methods request :: (Service -> Service) -> DescribeTransitGateways -> Request DescribeTransitGateways # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeTransitGateways -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeTransitGateways))) #
Generic DescribeTransitGateways Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGateways Associated Types type Rep DescribeTransitGateways :: Type -> Type # Methods from :: DescribeTransitGateways -> Rep DescribeTransitGateways x # to :: Rep DescribeTransitGateways x -> DescribeTransitGateways #
Read DescribeTransitGateways Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGateways Methods readsPrec :: Int -> ReadS DescribeTransitGateways # readList :: ReadS [DescribeTransitGateways] # readPrec :: ReadPrec DescribeTransitGateways # readListPrec :: ReadPrec [DescribeTransitGateways] #
Show DescribeTransitGateways Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGateways Methods showsPrec :: Int -> DescribeTransitGateways -> ShowS # show :: DescribeTransitGateways -> String # showList :: [DescribeTransitGateways] -> ShowS #
NFData DescribeTransitGateways Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGateways Methods rnf :: DescribeTransitGateways -> () #
Eq DescribeTransitGateways Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGateways Methods (==) :: DescribeTransitGateways -> DescribeTransitGateways -> Bool # (/=) :: DescribeTransitGateways -> DescribeTransitGateways -> Bool #
Hashable DescribeTransitGateways Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGateways Methods hashWithSalt :: Int -> DescribeTransitGateways -> Int # hash :: DescribeTransitGateways -> Int #
type AWSResponse DescribeTransitGateways Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGateways type AWSResponse DescribeTransitGateways = DescribeTransitGatewaysResponse
type Rep DescribeTransitGateways Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGateways type Rep DescribeTransitGateways = D1 ('MetaData "DescribeTransitGateways" "Amazonka.EC2.DescribeTransitGateways" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeTransitGateways'" '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 "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "transitGatewayIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))))

newDescribeTransitGateways :: DescribeTransitGateways Source #

Create a value of DescribeTransitGateways 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:DescribeTransitGateways', describeTransitGateways_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:DescribeTransitGateways', describeTransitGateways_filters - One or more filters. The possible values are:

options.propagation-default-route-table-id - The ID of the default propagation route table.
options.amazon-side-asn - The private ASN for the Amazon side of a BGP session.
options.association-default-route-table-id - The ID of the default association route table.
options.auto-accept-shared-attachments - Indicates whether there is automatic acceptance of attachment requests (enable | disable).
options.default-route-table-association - Indicates whether resource attachments are automatically associated with the default association route table (enable | disable).
options.default-route-table-propagation - Indicates whether resource attachments automatically propagate routes to the default propagation route table (enable | disable).
options.dns-support - Indicates whether DNS support is enabled (enable | disable).
options.vpn-ecmp-support - Indicates whether Equal Cost Multipath Protocol support is enabled (enable | disable).
owner-id - The ID of the Amazon Web Services account that owns the transit gateway.
state - The state of the transit gateway (available | deleted | deleting | modifying | pending).
transit-gateway-id - The ID of the transit gateway.

$sel:maxResults:DescribeTransitGateways', describeTransitGateways_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.

DescribeTransitGateways, describeTransitGateways_nextToken - The token for the next page of results.

$sel:transitGatewayIds:DescribeTransitGateways', describeTransitGateways_transitGatewayIds - The IDs of the transit gateways.

Request Lenses

describeTransitGateways_dryRun :: Lens' DescribeTransitGateways (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.

describeTransitGateways_filters :: Lens' DescribeTransitGateways (Maybe [Filter]) Source #

One or more filters. The possible values are:

options.propagation-default-route-table-id - The ID of the default propagation route table.
options.amazon-side-asn - The private ASN for the Amazon side of a BGP session.
options.association-default-route-table-id - The ID of the default association route table.
options.auto-accept-shared-attachments - Indicates whether there is automatic acceptance of attachment requests (enable | disable).
options.default-route-table-association - Indicates whether resource attachments are automatically associated with the default association route table (enable | disable).
options.default-route-table-propagation - Indicates whether resource attachments automatically propagate routes to the default propagation route table (enable | disable).
options.dns-support - Indicates whether DNS support is enabled (enable | disable).
options.vpn-ecmp-support - Indicates whether Equal Cost Multipath Protocol support is enabled (enable | disable).
owner-id - The ID of the Amazon Web Services account that owns the transit gateway.
state - The state of the transit gateway (available | deleted | deleting | modifying | pending).
transit-gateway-id - The ID of the transit gateway.

describeTransitGateways_maxResults :: Lens' DescribeTransitGateways (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.

describeTransitGateways_nextToken :: Lens' DescribeTransitGateways (Maybe Text) Source #

The token for the next page of results.

describeTransitGateways_transitGatewayIds :: Lens' DescribeTransitGateways (Maybe [Text]) Source #

The IDs of the transit gateways.

Destructuring the Response

data DescribeTransitGatewaysResponse Source #

See: newDescribeTransitGatewaysResponse smart constructor.

Constructors

DescribeTransitGatewaysResponse'
Fields nextToken :: 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. transitGateways :: Maybe [TransitGateway] Information about the transit gateways. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DescribeTransitGatewaysResponse Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGateways Associated Types type Rep DescribeTransitGatewaysResponse :: Type -> Type # Methods from :: DescribeTransitGatewaysResponse -> Rep DescribeTransitGatewaysResponse x # to :: Rep DescribeTransitGatewaysResponse x -> DescribeTransitGatewaysResponse #
Read DescribeTransitGatewaysResponse Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGateways Methods readsPrec :: Int -> ReadS DescribeTransitGatewaysResponse # readList :: ReadS [DescribeTransitGatewaysResponse] # readPrec :: ReadPrec DescribeTransitGatewaysResponse # readListPrec :: ReadPrec [DescribeTransitGatewaysResponse] #
Show DescribeTransitGatewaysResponse Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGateways Methods showsPrec :: Int -> DescribeTransitGatewaysResponse -> ShowS # show :: DescribeTransitGatewaysResponse -> String # showList :: [DescribeTransitGatewaysResponse] -> ShowS #
NFData DescribeTransitGatewaysResponse Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGateways Methods rnf :: DescribeTransitGatewaysResponse -> () #
Eq DescribeTransitGatewaysResponse Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGateways Methods (==) :: DescribeTransitGatewaysResponse -> DescribeTransitGatewaysResponse -> Bool # (/=) :: DescribeTransitGatewaysResponse -> DescribeTransitGatewaysResponse -> Bool #
type Rep DescribeTransitGatewaysResponse Source #
Instance details Defined in Amazonka.EC2.DescribeTransitGateways type Rep DescribeTransitGatewaysResponse = D1 ('MetaData "DescribeTransitGatewaysResponse" "Amazonka.EC2.DescribeTransitGateways" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeTransitGatewaysResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "transitGateways") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TransitGateway])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeTransitGatewaysResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeTransitGatewaysResponse'`
-> DescribeTransitGatewaysResponse

Create a value of DescribeTransitGatewaysResponse 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:

DescribeTransitGateways, describeTransitGatewaysResponse_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:transitGateways:DescribeTransitGatewaysResponse', describeTransitGatewaysResponse_transitGateways - Information about the transit gateways.

$sel:httpStatus:DescribeTransitGatewaysResponse', describeTransitGatewaysResponse_httpStatus - The response's http status code.

Response Lenses

describeTransitGatewaysResponse_nextToken :: Lens' DescribeTransitGatewaysResponse (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.

describeTransitGatewaysResponse_transitGateways :: Lens' DescribeTransitGatewaysResponse (Maybe [TransitGateway]) Source #

Information about the transit gateways.

describeTransitGatewaysResponse_httpStatus :: Lens' DescribeTransitGatewaysResponse Int Source #

The response's http status code.