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

Description

Searches for routes in the specified local gateway route table.

This operation returns paginated results.

Synopsis

Creating a Request

data SearchLocalGatewayRoutes Source #

See: newSearchLocalGatewayRoutes smart constructor.

Constructors

SearchLocalGatewayRoutes' 

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.

    • 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.
    • type - The route type.
  • maxResults :: Maybe Int

    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.

  • localGatewayRouteTableId :: Text

    The ID of the local gateway route table.

Instances

Instances details
ToHeaders SearchLocalGatewayRoutes Source # 
Instance details

Defined in Amazonka.EC2.SearchLocalGatewayRoutes

ToPath SearchLocalGatewayRoutes Source # 
Instance details

Defined in Amazonka.EC2.SearchLocalGatewayRoutes

ToQuery SearchLocalGatewayRoutes Source # 
Instance details

Defined in Amazonka.EC2.SearchLocalGatewayRoutes

AWSPager SearchLocalGatewayRoutes Source # 
Instance details

Defined in Amazonka.EC2.SearchLocalGatewayRoutes

AWSRequest SearchLocalGatewayRoutes Source # 
Instance details

Defined in Amazonka.EC2.SearchLocalGatewayRoutes

Generic SearchLocalGatewayRoutes Source # 
Instance details

Defined in Amazonka.EC2.SearchLocalGatewayRoutes

Associated Types

type Rep SearchLocalGatewayRoutes :: Type -> Type #

Read SearchLocalGatewayRoutes Source # 
Instance details

Defined in Amazonka.EC2.SearchLocalGatewayRoutes

Show SearchLocalGatewayRoutes Source # 
Instance details

Defined in Amazonka.EC2.SearchLocalGatewayRoutes

NFData SearchLocalGatewayRoutes Source # 
Instance details

Defined in Amazonka.EC2.SearchLocalGatewayRoutes

Eq SearchLocalGatewayRoutes Source # 
Instance details

Defined in Amazonka.EC2.SearchLocalGatewayRoutes

Hashable SearchLocalGatewayRoutes Source # 
Instance details

Defined in Amazonka.EC2.SearchLocalGatewayRoutes

type AWSResponse SearchLocalGatewayRoutes Source # 
Instance details

Defined in Amazonka.EC2.SearchLocalGatewayRoutes

type Rep SearchLocalGatewayRoutes Source # 
Instance details

Defined in Amazonka.EC2.SearchLocalGatewayRoutes

type Rep SearchLocalGatewayRoutes = D1 ('MetaData "SearchLocalGatewayRoutes" "Amazonka.EC2.SearchLocalGatewayRoutes" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "SearchLocalGatewayRoutes'" '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 Int)) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "localGatewayRouteTableId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newSearchLocalGatewayRoutes Source #

Create a value of SearchLocalGatewayRoutes 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:SearchLocalGatewayRoutes', searchLocalGatewayRoutes_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:SearchLocalGatewayRoutes', searchLocalGatewayRoutes_filters - One or more filters.

  • 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.
  • type - The route type.

$sel:maxResults:SearchLocalGatewayRoutes', searchLocalGatewayRoutes_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.

SearchLocalGatewayRoutes, searchLocalGatewayRoutes_nextToken - The token for the next page of results.

SearchLocalGatewayRoutes, searchLocalGatewayRoutes_localGatewayRouteTableId - The ID of the local gateway route table.

Request Lenses

searchLocalGatewayRoutes_dryRun :: Lens' SearchLocalGatewayRoutes (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.

searchLocalGatewayRoutes_filters :: Lens' SearchLocalGatewayRoutes (Maybe [Filter]) Source #

One or more filters.

  • 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.
  • type - The route type.

searchLocalGatewayRoutes_maxResults :: Lens' SearchLocalGatewayRoutes (Maybe Int) 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.

Destructuring the Response

data SearchLocalGatewayRoutesResponse Source #

See: newSearchLocalGatewayRoutesResponse smart constructor.

Constructors

SearchLocalGatewayRoutesResponse' 

Fields

Instances

Instances details
Generic SearchLocalGatewayRoutesResponse Source # 
Instance details

Defined in Amazonka.EC2.SearchLocalGatewayRoutes

Associated Types

type Rep SearchLocalGatewayRoutesResponse :: Type -> Type #

Read SearchLocalGatewayRoutesResponse Source # 
Instance details

Defined in Amazonka.EC2.SearchLocalGatewayRoutes

Show SearchLocalGatewayRoutesResponse Source # 
Instance details

Defined in Amazonka.EC2.SearchLocalGatewayRoutes

NFData SearchLocalGatewayRoutesResponse Source # 
Instance details

Defined in Amazonka.EC2.SearchLocalGatewayRoutes

Eq SearchLocalGatewayRoutesResponse Source # 
Instance details

Defined in Amazonka.EC2.SearchLocalGatewayRoutes

type Rep SearchLocalGatewayRoutesResponse Source # 
Instance details

Defined in Amazonka.EC2.SearchLocalGatewayRoutes

type Rep SearchLocalGatewayRoutesResponse = D1 ('MetaData "SearchLocalGatewayRoutesResponse" "Amazonka.EC2.SearchLocalGatewayRoutes" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "SearchLocalGatewayRoutesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "routes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [LocalGatewayRoute])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newSearchLocalGatewayRoutesResponse Source #

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

SearchLocalGatewayRoutes, searchLocalGatewayRoutesResponse_nextToken - The token to use to retrieve the next page of results. This value is null when there are no more results to return.

SearchLocalGatewayRoutesResponse, searchLocalGatewayRoutesResponse_routes - Information about the routes.

$sel:httpStatus:SearchLocalGatewayRoutesResponse', searchLocalGatewayRoutesResponse_httpStatus - The response's http status code.

Response Lenses

searchLocalGatewayRoutesResponse_nextToken :: Lens' SearchLocalGatewayRoutesResponse (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.