Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Lists summary information about the instances that you registered by using a specified service.
This operation returns paginated results.
Synopsis
- data ListInstances = ListInstances' {}
- newListInstances :: Text -> ListInstances
- listInstances_maxResults :: Lens' ListInstances (Maybe Natural)
- listInstances_nextToken :: Lens' ListInstances (Maybe Text)
- listInstances_serviceId :: Lens' ListInstances Text
- data ListInstancesResponse = ListInstancesResponse' {
- instances :: Maybe [InstanceSummary]
- nextToken :: Maybe Text
- httpStatus :: Int
- newListInstancesResponse :: Int -> ListInstancesResponse
- listInstancesResponse_instances :: Lens' ListInstancesResponse (Maybe [InstanceSummary])
- listInstancesResponse_nextToken :: Lens' ListInstancesResponse (Maybe Text)
- listInstancesResponse_httpStatus :: Lens' ListInstancesResponse Int
Creating a Request
data ListInstances Source #
See: newListInstances
smart constructor.
ListInstances' | |
|
Instances
Create a value of ListInstances
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:maxResults:ListInstances'
, listInstances_maxResults
- The maximum number of instances that you want Cloud Map to return in the
response to a ListInstances
request. If you don't specify a value for
MaxResults
, Cloud Map returns up to 100 instances.
ListInstances
, listInstances_nextToken
- For the first ListInstances
request, omit this value.
If more than MaxResults
instances match the specified criteria, you
can submit another ListInstances
request to get the next group of
results. Specify the value of NextToken
from the previous response in
the next request.
$sel:serviceId:ListInstances'
, listInstances_serviceId
- The ID of the service that you want to list instances for.
Request Lenses
listInstances_maxResults :: Lens' ListInstances (Maybe Natural) Source #
The maximum number of instances that you want Cloud Map to return in the
response to a ListInstances
request. If you don't specify a value for
MaxResults
, Cloud Map returns up to 100 instances.
listInstances_nextToken :: Lens' ListInstances (Maybe Text) Source #
For the first ListInstances
request, omit this value.
If more than MaxResults
instances match the specified criteria, you
can submit another ListInstances
request to get the next group of
results. Specify the value of NextToken
from the previous response in
the next request.
listInstances_serviceId :: Lens' ListInstances Text Source #
The ID of the service that you want to list instances for.
Destructuring the Response
data ListInstancesResponse Source #
See: newListInstancesResponse
smart constructor.
ListInstancesResponse' | |
|
Instances
newListInstancesResponse Source #
Create a value of ListInstancesResponse
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:instances:ListInstancesResponse'
, listInstancesResponse_instances
- Summary information about the instances that are associated with the
specified service.
ListInstances
, listInstancesResponse_nextToken
- If more than MaxResults
instances match the specified criteria, you
can submit another ListInstances
request to get the next group of
results. Specify the value of NextToken
from the previous response in
the next request.
$sel:httpStatus:ListInstancesResponse'
, listInstancesResponse_httpStatus
- The response's http status code.
Response Lenses
listInstancesResponse_instances :: Lens' ListInstancesResponse (Maybe [InstanceSummary]) Source #
Summary information about the instances that are associated with the specified service.
listInstancesResponse_nextToken :: Lens' ListInstancesResponse (Maybe Text) Source #
If more than MaxResults
instances match the specified criteria, you
can submit another ListInstances
request to get the next group of
results. Specify the value of NextToken
from the previous response in
the next request.
listInstancesResponse_httpStatus :: Lens' ListInstancesResponse Int Source #
The response's http status code.