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 |
Provides information for all active EC2 instances and EC2 instances terminated in the last 30 days, up to a maximum of 2,000. EC2 instances in any of the following states are considered active: AWAITING_FULFILLMENT, PROVISIONING, BOOTSTRAPPING, RUNNING.
This operation returns paginated results.
Synopsis
- data ListInstances = ListInstances' {}
- newListInstances :: Text -> ListInstances
- listInstances_instanceGroupTypes :: Lens' ListInstances (Maybe [InstanceGroupType])
- listInstances_instanceFleetType :: Lens' ListInstances (Maybe InstanceFleetType)
- listInstances_marker :: Lens' ListInstances (Maybe Text)
- listInstances_instanceFleetId :: Lens' ListInstances (Maybe Text)
- listInstances_instanceStates :: Lens' ListInstances (Maybe [InstanceState])
- listInstances_instanceGroupId :: Lens' ListInstances (Maybe Text)
- listInstances_clusterId :: Lens' ListInstances Text
- data ListInstancesResponse = ListInstancesResponse' {}
- newListInstancesResponse :: Int -> ListInstancesResponse
- listInstancesResponse_marker :: Lens' ListInstancesResponse (Maybe Text)
- listInstancesResponse_instances :: Lens' ListInstancesResponse (Maybe [Instance])
- listInstancesResponse_httpStatus :: Lens' ListInstancesResponse Int
Creating a Request
data ListInstances Source #
This input determines which instances to list.
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:instanceGroupTypes:ListInstances'
, listInstances_instanceGroupTypes
- The type of instance group for which to list the instances.
$sel:instanceFleetType:ListInstances'
, listInstances_instanceFleetType
- The node type of the instance fleet. For example MASTER, CORE, or TASK.
$sel:marker:ListInstances'
, listInstances_marker
- The pagination token that indicates the next set of results to retrieve.
$sel:instanceFleetId:ListInstances'
, listInstances_instanceFleetId
- The unique identifier of the instance fleet.
$sel:instanceStates:ListInstances'
, listInstances_instanceStates
- A list of instance states that will filter the instances returned with
this request.
$sel:instanceGroupId:ListInstances'
, listInstances_instanceGroupId
- The identifier of the instance group for which to list the instances.
$sel:clusterId:ListInstances'
, listInstances_clusterId
- The identifier of the cluster for which to list the instances.
Request Lenses
listInstances_instanceGroupTypes :: Lens' ListInstances (Maybe [InstanceGroupType]) Source #
The type of instance group for which to list the instances.
listInstances_instanceFleetType :: Lens' ListInstances (Maybe InstanceFleetType) Source #
The node type of the instance fleet. For example MASTER, CORE, or TASK.
listInstances_marker :: Lens' ListInstances (Maybe Text) Source #
The pagination token that indicates the next set of results to retrieve.
listInstances_instanceFleetId :: Lens' ListInstances (Maybe Text) Source #
The unique identifier of the instance fleet.
listInstances_instanceStates :: Lens' ListInstances (Maybe [InstanceState]) Source #
A list of instance states that will filter the instances returned with this request.
listInstances_instanceGroupId :: Lens' ListInstances (Maybe Text) Source #
The identifier of the instance group for which to list the instances.
listInstances_clusterId :: Lens' ListInstances Text Source #
The identifier of the cluster for which to list the instances.
Destructuring the Response
data ListInstancesResponse Source #
This output contains the list of instances.
See: newListInstancesResponse
smart constructor.
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:marker:ListInstances'
, listInstancesResponse_marker
- The pagination token that indicates the next set of results to retrieve.
$sel:instances:ListInstancesResponse'
, listInstancesResponse_instances
- The list of instances for the cluster and given filters.
$sel:httpStatus:ListInstancesResponse'
, listInstancesResponse_httpStatus
- The response's http status code.
Response Lenses
listInstancesResponse_marker :: Lens' ListInstancesResponse (Maybe Text) Source #
The pagination token that indicates the next set of results to retrieve.
listInstancesResponse_instances :: Lens' ListInstancesResponse (Maybe [Instance]) Source #
The list of instances for the cluster and given filters.
listInstancesResponse_httpStatus :: Lens' ListInstancesResponse Int Source #
The response's http status code.