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

Description

Searches for routes in the specified transit gateway route table.

Synopsis

Creating a Request

data SearchTransitGatewayRoutes Source #

See: newSearchTransitGatewayRoutes smart constructor.

Constructors

SearchTransitGatewayRoutes' 

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.

  • maxResults :: Maybe Natural

    The maximum number of routes to return.

  • transitGatewayRouteTableId :: Text

    The ID of the transit gateway route table.

  • filters :: [Filter]

    One or more filters. The possible values are:

    • attachment.transit-gateway-attachment-id- The id of the transit gateway attachment.
    • attachment.resource-id - The resource id of the transit gateway attachment.
    • attachment.resource-type - The attachment resource type. Valid values are vpc | vpn | direct-connect-gateway | peering | connect.
    • prefix-list-id - The ID of the prefix list.
    • route-search.exact-match - The exact match of the specified filter.
    • route-search.longest-prefix-match - The longest prefix that matches the route.
    • route-search.subnet-of-match - The routes with a subnet that match the specified CIDR filter.
    • route-search.supernet-of-match - The routes with a CIDR that encompass the CIDR filter. For example, if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and you specify supernet-of-match as 10.0.1.0/30, then the result returns 10.0.1.0/29.
    • state - The state of the route (active | blackhole).
    • type - The type of route (propagated | static).

Instances

Instances details
ToHeaders SearchTransitGatewayRoutes Source # 
Instance details

Defined in Amazonka.EC2.SearchTransitGatewayRoutes

Methods

toHeaders :: SearchTransitGatewayRoutes -> [Header] #

ToPath SearchTransitGatewayRoutes Source # 
Instance details

Defined in Amazonka.EC2.SearchTransitGatewayRoutes

Methods

toPath :: SearchTransitGatewayRoutes -> ByteString #

ToQuery SearchTransitGatewayRoutes Source # 
Instance details

Defined in Amazonka.EC2.SearchTransitGatewayRoutes

Methods

toQuery :: SearchTransitGatewayRoutes -> QueryString #

AWSRequest SearchTransitGatewayRoutes Source # 
Instance details

Defined in Amazonka.EC2.SearchTransitGatewayRoutes

Associated Types

type AWSResponse SearchTransitGatewayRoutes #

Methods

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

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

Generic SearchTransitGatewayRoutes Source # 
Instance details

Defined in Amazonka.EC2.SearchTransitGatewayRoutes

Associated Types

type Rep SearchTransitGatewayRoutes :: Type -> Type #

Methods

from :: SearchTransitGatewayRoutes -> Rep SearchTransitGatewayRoutes x #

to :: Rep SearchTransitGatewayRoutes x -> SearchTransitGatewayRoutes #

Read SearchTransitGatewayRoutes Source # 
Instance details

Defined in Amazonka.EC2.SearchTransitGatewayRoutes

Methods

readsPrec :: Int -> ReadS SearchTransitGatewayRoutes #

readList :: ReadS [SearchTransitGatewayRoutes] #

readPrec :: ReadPrec SearchTransitGatewayRoutes #

readListPrec :: ReadPrec [SearchTransitGatewayRoutes] #

Show SearchTransitGatewayRoutes Source # 
Instance details

Defined in Amazonka.EC2.SearchTransitGatewayRoutes

Methods

showsPrec :: Int -> SearchTransitGatewayRoutes -> ShowS #

show :: SearchTransitGatewayRoutes -> String #

showList :: [SearchTransitGatewayRoutes] -> ShowS #

NFData SearchTransitGatewayRoutes Source # 
Instance details

Defined in Amazonka.EC2.SearchTransitGatewayRoutes

Methods

rnf :: SearchTransitGatewayRoutes -> () #

Eq SearchTransitGatewayRoutes Source # 
Instance details

Defined in Amazonka.EC2.SearchTransitGatewayRoutes

Methods

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

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

Hashable SearchTransitGatewayRoutes Source # 
Instance details

Defined in Amazonka.EC2.SearchTransitGatewayRoutes

Methods

hashWithSalt :: Int -> SearchTransitGatewayRoutes -> Int #

hash :: SearchTransitGatewayRoutes -> Int #

type AWSResponse SearchTransitGatewayRoutes Source # 
Instance details

Defined in Amazonka.EC2.SearchTransitGatewayRoutes

type AWSResponse SearchTransitGatewayRoutes = SearchTransitGatewayRoutesResponse
type Rep SearchTransitGatewayRoutes Source # 
Instance details

Defined in Amazonka.EC2.SearchTransitGatewayRoutes

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

newSearchTransitGatewayRoutes Source #

Arguments

:: Text

SearchTransitGatewayRoutes

-> SearchTransitGatewayRoutes 

Create a value of SearchTransitGatewayRoutes 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:SearchTransitGatewayRoutes', searchTransitGatewayRoutes_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:maxResults:SearchTransitGatewayRoutes', searchTransitGatewayRoutes_maxResults - The maximum number of routes to return.

SearchTransitGatewayRoutes, searchTransitGatewayRoutes_transitGatewayRouteTableId - The ID of the transit gateway route table.

$sel:filters:SearchTransitGatewayRoutes', searchTransitGatewayRoutes_filters - One or more filters. The possible values are:

  • attachment.transit-gateway-attachment-id- The id of the transit gateway attachment.
  • attachment.resource-id - The resource id of the transit gateway attachment.
  • attachment.resource-type - The attachment resource type. Valid values are vpc | vpn | direct-connect-gateway | peering | connect.
  • prefix-list-id - The ID of the prefix list.
  • route-search.exact-match - The exact match of the specified filter.
  • route-search.longest-prefix-match - The longest prefix that matches the route.
  • route-search.subnet-of-match - The routes with a subnet that match the specified CIDR filter.
  • route-search.supernet-of-match - The routes with a CIDR that encompass the CIDR filter. For example, if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and you specify supernet-of-match as 10.0.1.0/30, then the result returns 10.0.1.0/29.
  • state - The state of the route (active | blackhole).
  • type - The type of route (propagated | static).

Request Lenses

searchTransitGatewayRoutes_dryRun :: Lens' SearchTransitGatewayRoutes (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.

searchTransitGatewayRoutes_maxResults :: Lens' SearchTransitGatewayRoutes (Maybe Natural) Source #

The maximum number of routes to return.

searchTransitGatewayRoutes_transitGatewayRouteTableId :: Lens' SearchTransitGatewayRoutes Text Source #

The ID of the transit gateway route table.

searchTransitGatewayRoutes_filters :: Lens' SearchTransitGatewayRoutes [Filter] Source #

One or more filters. The possible values are:

  • attachment.transit-gateway-attachment-id- The id of the transit gateway attachment.
  • attachment.resource-id - The resource id of the transit gateway attachment.
  • attachment.resource-type - The attachment resource type. Valid values are vpc | vpn | direct-connect-gateway | peering | connect.
  • prefix-list-id - The ID of the prefix list.
  • route-search.exact-match - The exact match of the specified filter.
  • route-search.longest-prefix-match - The longest prefix that matches the route.
  • route-search.subnet-of-match - The routes with a subnet that match the specified CIDR filter.
  • route-search.supernet-of-match - The routes with a CIDR that encompass the CIDR filter. For example, if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and you specify supernet-of-match as 10.0.1.0/30, then the result returns 10.0.1.0/29.
  • state - The state of the route (active | blackhole).
  • type - The type of route (propagated | static).

Destructuring the Response

data SearchTransitGatewayRoutesResponse Source #

See: newSearchTransitGatewayRoutesResponse smart constructor.

Constructors

SearchTransitGatewayRoutesResponse' 

Fields

Instances

Instances details
Generic SearchTransitGatewayRoutesResponse Source # 
Instance details

Defined in Amazonka.EC2.SearchTransitGatewayRoutes

Associated Types

type Rep SearchTransitGatewayRoutesResponse :: Type -> Type #

Methods

from :: SearchTransitGatewayRoutesResponse -> Rep SearchTransitGatewayRoutesResponse x #

to :: Rep SearchTransitGatewayRoutesResponse x -> SearchTransitGatewayRoutesResponse #

Read SearchTransitGatewayRoutesResponse Source # 
Instance details

Defined in Amazonka.EC2.SearchTransitGatewayRoutes

Methods

readsPrec :: Int -> ReadS SearchTransitGatewayRoutesResponse #

readList :: ReadS [SearchTransitGatewayRoutesResponse] #

readPrec :: ReadPrec SearchTransitGatewayRoutesResponse #

readListPrec :: ReadPrec [SearchTransitGatewayRoutesResponse] #

Show SearchTransitGatewayRoutesResponse Source # 
Instance details

Defined in Amazonka.EC2.SearchTransitGatewayRoutes

Methods

showsPrec :: Int -> SearchTransitGatewayRoutesResponse -> ShowS #

show :: SearchTransitGatewayRoutesResponse -> String #

showList :: [SearchTransitGatewayRoutesResponse] -> ShowS #

NFData SearchTransitGatewayRoutesResponse Source # 
Instance details

Defined in Amazonka.EC2.SearchTransitGatewayRoutes

Methods

rnf :: SearchTransitGatewayRoutesResponse -> () #

Eq SearchTransitGatewayRoutesResponse Source # 
Instance details

Defined in Amazonka.EC2.SearchTransitGatewayRoutes

Methods

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

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

type Rep SearchTransitGatewayRoutesResponse Source # 
Instance details

Defined in Amazonka.EC2.SearchTransitGatewayRoutes

type Rep SearchTransitGatewayRoutesResponse = D1 ('MetaData "SearchTransitGatewayRoutesResponse" "Amazonka.EC2.SearchTransitGatewayRoutes" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "SearchTransitGatewayRoutesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "additionalRoutesAvailable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "routes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TransitGatewayRoute])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newSearchTransitGatewayRoutesResponse Source #

Arguments

:: Int

$sel:httpStatus:SearchTransitGatewayRoutesResponse'

-> SearchTransitGatewayRoutesResponse 

Create a value of SearchTransitGatewayRoutesResponse 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:additionalRoutesAvailable:SearchTransitGatewayRoutesResponse', searchTransitGatewayRoutesResponse_additionalRoutesAvailable - Indicates whether there are additional routes available.

SearchTransitGatewayRoutesResponse, searchTransitGatewayRoutesResponse_routes - Information about the routes.

$sel:httpStatus:SearchTransitGatewayRoutesResponse', searchTransitGatewayRoutesResponse_httpStatus - The response's http status code.

Response Lenses

searchTransitGatewayRoutesResponse_additionalRoutesAvailable :: Lens' SearchTransitGatewayRoutesResponse (Maybe Bool) Source #

Indicates whether there are additional routes available.

searchTransitGatewayRoutesResponse_routes :: Lens' SearchTransitGatewayRoutesResponse (Maybe [TransitGatewayRoute]) Source #

Information about the routes.

searchTransitGatewayRoutesResponse_httpStatus :: Lens' SearchTransitGatewayRoutesResponse Int Source #

The response's http status code.