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 |
Returns a list of existing virtual gateways in a service mesh.
This operation returns paginated results.
Synopsis
- data ListVirtualGateways = ListVirtualGateways' {}
- newListVirtualGateways :: Text -> ListVirtualGateways
- listVirtualGateways_meshOwner :: Lens' ListVirtualGateways (Maybe Text)
- listVirtualGateways_nextToken :: Lens' ListVirtualGateways (Maybe Text)
- listVirtualGateways_limit :: Lens' ListVirtualGateways (Maybe Natural)
- listVirtualGateways_meshName :: Lens' ListVirtualGateways Text
- data ListVirtualGatewaysResponse = ListVirtualGatewaysResponse' {}
- newListVirtualGatewaysResponse :: Int -> ListVirtualGatewaysResponse
- listVirtualGatewaysResponse_nextToken :: Lens' ListVirtualGatewaysResponse (Maybe Text)
- listVirtualGatewaysResponse_httpStatus :: Lens' ListVirtualGatewaysResponse Int
- listVirtualGatewaysResponse_virtualGateways :: Lens' ListVirtualGatewaysResponse [VirtualGatewayRef]
Creating a Request
data ListVirtualGateways Source #
See: newListVirtualGateways
smart constructor.
ListVirtualGateways' | |
|
Instances
newListVirtualGateways Source #
Create a value of ListVirtualGateways
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:ListVirtualGateways'
, listVirtualGateways_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:ListVirtualGateways'
, listVirtualGateways_nextToken
- The nextToken
value returned from a previous paginated
ListVirtualGateways
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:ListVirtualGateways'
, listVirtualGateways_limit
- The maximum number of results returned by ListVirtualGateways
in
paginated output. When you use this parameter, ListVirtualGateways
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 ListVirtualGateways
request with the
returned nextToken
value. This value can be between 1 and 100. If you
don't use this parameter, ListVirtualGateways
returns up to 100
results and a nextToken
value if applicable.
$sel:meshName:ListVirtualGateways'
, listVirtualGateways_meshName
- The name of the service mesh to list virtual gateways in.
Request Lenses
listVirtualGateways_meshOwner :: Lens' ListVirtualGateways (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.
listVirtualGateways_nextToken :: Lens' ListVirtualGateways (Maybe Text) Source #
The nextToken
value returned from a previous paginated
ListVirtualGateways
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.
listVirtualGateways_limit :: Lens' ListVirtualGateways (Maybe Natural) Source #
The maximum number of results returned by ListVirtualGateways
in
paginated output. When you use this parameter, ListVirtualGateways
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 ListVirtualGateways
request with the
returned nextToken
value. This value can be between 1 and 100. If you
don't use this parameter, ListVirtualGateways
returns up to 100
results and a nextToken
value if applicable.
listVirtualGateways_meshName :: Lens' ListVirtualGateways Text Source #
The name of the service mesh to list virtual gateways in.
Destructuring the Response
data ListVirtualGatewaysResponse Source #
See: newListVirtualGatewaysResponse
smart constructor.
ListVirtualGatewaysResponse' | |
|
Instances
newListVirtualGatewaysResponse Source #
Create a value of ListVirtualGatewaysResponse
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:ListVirtualGateways'
, listVirtualGatewaysResponse_nextToken
- The nextToken
value to include in a future ListVirtualGateways
request. When the results of a ListVirtualGateways
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:ListVirtualGatewaysResponse'
, listVirtualGatewaysResponse_httpStatus
- The response's http status code.
$sel:virtualGateways:ListVirtualGatewaysResponse'
, listVirtualGatewaysResponse_virtualGateways
- The list of existing virtual gateways for the specified service mesh.
Response Lenses
listVirtualGatewaysResponse_nextToken :: Lens' ListVirtualGatewaysResponse (Maybe Text) Source #
The nextToken
value to include in a future ListVirtualGateways
request. When the results of a ListVirtualGateways
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.
listVirtualGatewaysResponse_httpStatus :: Lens' ListVirtualGatewaysResponse Int Source #
The response's http status code.
listVirtualGatewaysResponse_virtualGateways :: Lens' ListVirtualGatewaysResponse [VirtualGatewayRef] Source #
The list of existing virtual gateways for the specified service mesh.