| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.AppMesh.ListGatewayRoutes
Description
Returns a list of existing gateway routes that are associated to a virtual gateway.
This operation returns paginated results.
Synopsis
- data ListGatewayRoutes = ListGatewayRoutes' {}
- newListGatewayRoutes :: Text -> Text -> ListGatewayRoutes
- listGatewayRoutes_meshOwner :: Lens' ListGatewayRoutes (Maybe Text)
- listGatewayRoutes_nextToken :: Lens' ListGatewayRoutes (Maybe Text)
- listGatewayRoutes_limit :: Lens' ListGatewayRoutes (Maybe Natural)
- listGatewayRoutes_meshName :: Lens' ListGatewayRoutes Text
- listGatewayRoutes_virtualGatewayName :: Lens' ListGatewayRoutes Text
- data ListGatewayRoutesResponse = ListGatewayRoutesResponse' {
- nextToken :: Maybe Text
- httpStatus :: Int
- gatewayRoutes :: [GatewayRouteRef]
- newListGatewayRoutesResponse :: Int -> ListGatewayRoutesResponse
- listGatewayRoutesResponse_nextToken :: Lens' ListGatewayRoutesResponse (Maybe Text)
- listGatewayRoutesResponse_httpStatus :: Lens' ListGatewayRoutesResponse Int
- listGatewayRoutesResponse_gatewayRoutes :: Lens' ListGatewayRoutesResponse [GatewayRouteRef]
Creating a Request
data ListGatewayRoutes Source #
See: newListGatewayRoutes smart constructor.
Constructors
| ListGatewayRoutes' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> ListGatewayRoutes |
Create a value of ListGatewayRoutes 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:meshOwner:ListGatewayRoutes', listGatewayRoutes_meshOwner - The AWS IAM account ID of the service mesh owner. If the account ID is
not your own, then it's the ID of the account that shared the mesh with
your account. For more information about mesh sharing, see
Working with shared meshes.
$sel:nextToken:ListGatewayRoutes', listGatewayRoutes_nextToken - The nextToken value returned from a previous paginated
ListGatewayRoutes request where limit was used and the results
exceeded the value of that parameter. Pagination continues from the end
of the previous results that returned the nextToken value.
$sel:limit:ListGatewayRoutes', listGatewayRoutes_limit - The maximum number of results returned by ListGatewayRoutes in
paginated output. When you use this parameter, ListGatewayRoutes
returns only limit results in a single page along with a nextToken
response element. You can see the remaining results of the initial
request by sending another ListGatewayRoutes request with the returned
nextToken value. This value can be between 1 and 100. If you don't
use this parameter, ListGatewayRoutes returns up to 100 results and a
nextToken value if applicable.
$sel:meshName:ListGatewayRoutes', listGatewayRoutes_meshName - The name of the service mesh to list gateway routes in.
$sel:virtualGatewayName:ListGatewayRoutes', listGatewayRoutes_virtualGatewayName - The name of the virtual gateway to list gateway routes in.
Request Lenses
listGatewayRoutes_meshOwner :: Lens' ListGatewayRoutes (Maybe Text) Source #
The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
listGatewayRoutes_nextToken :: Lens' ListGatewayRoutes (Maybe Text) Source #
The nextToken value returned from a previous paginated
ListGatewayRoutes request where limit was used and the results
exceeded the value of that parameter. Pagination continues from the end
of the previous results that returned the nextToken value.
listGatewayRoutes_limit :: Lens' ListGatewayRoutes (Maybe Natural) Source #
The maximum number of results returned by ListGatewayRoutes in
paginated output. When you use this parameter, ListGatewayRoutes
returns only limit results in a single page along with a nextToken
response element. You can see the remaining results of the initial
request by sending another ListGatewayRoutes request with the returned
nextToken value. This value can be between 1 and 100. If you don't
use this parameter, ListGatewayRoutes returns up to 100 results and a
nextToken value if applicable.
listGatewayRoutes_meshName :: Lens' ListGatewayRoutes Text Source #
The name of the service mesh to list gateway routes in.
listGatewayRoutes_virtualGatewayName :: Lens' ListGatewayRoutes Text Source #
The name of the virtual gateway to list gateway routes in.
Destructuring the Response
data ListGatewayRoutesResponse Source #
See: newListGatewayRoutesResponse smart constructor.
Constructors
| ListGatewayRoutesResponse' | |
Fields
| |
Instances
newListGatewayRoutesResponse Source #
Create a value of ListGatewayRoutesResponse 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:nextToken:ListGatewayRoutes', listGatewayRoutesResponse_nextToken - The nextToken value to include in a future ListGatewayRoutes
request. When the results of a ListGatewayRoutes request exceed
limit, you can use this value to retrieve the next page of results.
This value is null when there are no more results to return.
$sel:httpStatus:ListGatewayRoutesResponse', listGatewayRoutesResponse_httpStatus - The response's http status code.
$sel:gatewayRoutes:ListGatewayRoutesResponse', listGatewayRoutesResponse_gatewayRoutes - The list of existing gateway routes for the specified service mesh and
virtual gateway.
Response Lenses
listGatewayRoutesResponse_nextToken :: Lens' ListGatewayRoutesResponse (Maybe Text) Source #
The nextToken value to include in a future ListGatewayRoutes
request. When the results of a ListGatewayRoutes request exceed
limit, you can use this value to retrieve the next page of results.
This value is null when there are no more results to return.
listGatewayRoutesResponse_httpStatus :: Lens' ListGatewayRoutesResponse Int Source #
The response's http status code.
listGatewayRoutesResponse_gatewayRoutes :: Lens' ListGatewayRoutesResponse [GatewayRouteRef] Source #
The list of existing gateway routes for the specified service mesh and virtual gateway.