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 nodes.
This operation returns paginated results.
Synopsis
- data ListVirtualNodes = ListVirtualNodes' {}
- newListVirtualNodes :: Text -> ListVirtualNodes
- listVirtualNodes_meshOwner :: Lens' ListVirtualNodes (Maybe Text)
- listVirtualNodes_nextToken :: Lens' ListVirtualNodes (Maybe Text)
- listVirtualNodes_limit :: Lens' ListVirtualNodes (Maybe Natural)
- listVirtualNodes_meshName :: Lens' ListVirtualNodes Text
- data ListVirtualNodesResponse = ListVirtualNodesResponse' {
- nextToken :: Maybe Text
- httpStatus :: Int
- virtualNodes :: [VirtualNodeRef]
- newListVirtualNodesResponse :: Int -> ListVirtualNodesResponse
- listVirtualNodesResponse_nextToken :: Lens' ListVirtualNodesResponse (Maybe Text)
- listVirtualNodesResponse_httpStatus :: Lens' ListVirtualNodesResponse Int
- listVirtualNodesResponse_virtualNodes :: Lens' ListVirtualNodesResponse [VirtualNodeRef]
Creating a Request
data ListVirtualNodes Source #
See: newListVirtualNodes
smart constructor.
ListVirtualNodes' | |
|
Instances
Create a value of ListVirtualNodes
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:ListVirtualNodes'
, listVirtualNodes_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:ListVirtualNodes'
, listVirtualNodes_nextToken
- The nextToken
value returned from a previous paginated
ListVirtualNodes
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:ListVirtualNodes'
, listVirtualNodes_limit
- The maximum number of results returned by ListVirtualNodes
in
paginated output. When you use this parameter, ListVirtualNodes
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 ListVirtualNodes
request with the returned
nextToken
value. This value can be between 1 and 100. If you don't
use this parameter, ListVirtualNodes
returns up to 100 results and a
nextToken
value if applicable.
$sel:meshName:ListVirtualNodes'
, listVirtualNodes_meshName
- The name of the service mesh to list virtual nodes in.
Request Lenses
listVirtualNodes_meshOwner :: Lens' ListVirtualNodes (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.
listVirtualNodes_nextToken :: Lens' ListVirtualNodes (Maybe Text) Source #
The nextToken
value returned from a previous paginated
ListVirtualNodes
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.
listVirtualNodes_limit :: Lens' ListVirtualNodes (Maybe Natural) Source #
The maximum number of results returned by ListVirtualNodes
in
paginated output. When you use this parameter, ListVirtualNodes
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 ListVirtualNodes
request with the returned
nextToken
value. This value can be between 1 and 100. If you don't
use this parameter, ListVirtualNodes
returns up to 100 results and a
nextToken
value if applicable.
listVirtualNodes_meshName :: Lens' ListVirtualNodes Text Source #
The name of the service mesh to list virtual nodes in.
Destructuring the Response
data ListVirtualNodesResponse Source #
See: newListVirtualNodesResponse
smart constructor.
ListVirtualNodesResponse' | |
|
Instances
newListVirtualNodesResponse Source #
Create a value of ListVirtualNodesResponse
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:ListVirtualNodes'
, listVirtualNodesResponse_nextToken
- The nextToken
value to include in a future ListVirtualNodes
request.
When the results of a ListVirtualNodes
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:ListVirtualNodesResponse'
, listVirtualNodesResponse_httpStatus
- The response's http status code.
$sel:virtualNodes:ListVirtualNodesResponse'
, listVirtualNodesResponse_virtualNodes
- The list of existing virtual nodes for the specified service mesh.
Response Lenses
listVirtualNodesResponse_nextToken :: Lens' ListVirtualNodesResponse (Maybe Text) Source #
The nextToken
value to include in a future ListVirtualNodes
request.
When the results of a ListVirtualNodes
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.
listVirtualNodesResponse_httpStatus :: Lens' ListVirtualNodesResponse Int Source #
The response's http status code.
listVirtualNodesResponse_virtualNodes :: Lens' ListVirtualNodesResponse [VirtualNodeRef] Source #
The list of existing virtual nodes for the specified service mesh.