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 |
Retrieves information about a fleet's instances, including instance IDs, connection data, and status.
This operation can be used in the following ways:
- To get information on all instances that are deployed to a fleet's home Region, provide the fleet ID.
- To get information on all instances that are deployed to a fleet's remote location, provide the fleet ID and location name.
- To get information on a specific instance in a fleet, provide the fleet ID and instance ID.
Use the pagination parameters to retrieve results as a set of sequential pages.
If successful, an Instance
object is returned for each requested
instance. Instances are not returned in any particular order.
Learn more
Remotely Access Fleet Instances
Related actions
This operation returns paginated results.
Synopsis
- data DescribeInstances = DescribeInstances' {}
- newDescribeInstances :: Text -> DescribeInstances
- describeInstances_instanceId :: Lens' DescribeInstances (Maybe Text)
- describeInstances_limit :: Lens' DescribeInstances (Maybe Natural)
- describeInstances_location :: Lens' DescribeInstances (Maybe Text)
- describeInstances_nextToken :: Lens' DescribeInstances (Maybe Text)
- describeInstances_fleetId :: Lens' DescribeInstances Text
- data DescribeInstancesResponse = DescribeInstancesResponse' {}
- newDescribeInstancesResponse :: Int -> DescribeInstancesResponse
- describeInstancesResponse_instances :: Lens' DescribeInstancesResponse (Maybe [Instance])
- describeInstancesResponse_nextToken :: Lens' DescribeInstancesResponse (Maybe Text)
- describeInstancesResponse_httpStatus :: Lens' DescribeInstancesResponse Int
Creating a Request
data DescribeInstances Source #
See: newDescribeInstances
smart constructor.
DescribeInstances' | |
|
Instances
Create a value of DescribeInstances
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:
DescribeInstances
, describeInstances_instanceId
- A unique identifier for an instance to retrieve. Specify an instance ID
or leave blank to retrieve all instances in the fleet.
$sel:limit:DescribeInstances'
, describeInstances_limit
- The maximum number of results to return. Use this parameter with
NextToken
to get results as a set of sequential pages.
DescribeInstances
, describeInstances_location
- The name of a location to retrieve instance information for, in the form
of an Amazon Web Services Region code such as us-west-2
.
DescribeInstances
, describeInstances_nextToken
- A token that indicates the start of the next sequential page of results.
Use the token that is returned with a previous call to this operation.
To start at the beginning of the result set, do not specify a value.
DescribeInstances
, describeInstances_fleetId
- A unique identifier for the fleet to retrieve instance information for.
You can use either the fleet ID or ARN value.
Request Lenses
describeInstances_instanceId :: Lens' DescribeInstances (Maybe Text) Source #
A unique identifier for an instance to retrieve. Specify an instance ID or leave blank to retrieve all instances in the fleet.
describeInstances_limit :: Lens' DescribeInstances (Maybe Natural) Source #
The maximum number of results to return. Use this parameter with
NextToken
to get results as a set of sequential pages.
describeInstances_location :: Lens' DescribeInstances (Maybe Text) Source #
The name of a location to retrieve instance information for, in the form
of an Amazon Web Services Region code such as us-west-2
.
describeInstances_nextToken :: Lens' DescribeInstances (Maybe Text) Source #
A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.
describeInstances_fleetId :: Lens' DescribeInstances Text Source #
A unique identifier for the fleet to retrieve instance information for. You can use either the fleet ID or ARN value.
Destructuring the Response
data DescribeInstancesResponse Source #
See: newDescribeInstancesResponse
smart constructor.
DescribeInstancesResponse' | |
|
Instances
newDescribeInstancesResponse Source #
Create a value of DescribeInstancesResponse
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:DescribeInstancesResponse'
, describeInstancesResponse_instances
- A collection of objects containing properties for each instance
returned.
DescribeInstances
, describeInstancesResponse_nextToken
- A token that indicates where to resume retrieving results on the next
call to this operation. If no token is returned, these results represent
the end of the list.
$sel:httpStatus:DescribeInstancesResponse'
, describeInstancesResponse_httpStatus
- The response's http status code.
Response Lenses
describeInstancesResponse_instances :: Lens' DescribeInstancesResponse (Maybe [Instance]) Source #
A collection of objects containing properties for each instance returned.
describeInstancesResponse_nextToken :: Lens' DescribeInstancesResponse (Maybe Text) Source #
A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.
describeInstancesResponse_httpStatus :: Lens' DescribeInstancesResponse Int Source #
The response's http status code.