describe_fleet_instances¶
Operation¶
describe_fleet_instances
async
¶
describe_fleet_instances(request: DescribeFleetInstancesInput | DescribeFleetInstancesInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeFleetInstancesOutput
describe_fleet_instances(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeFleetInstancesInputDict]) -> DescribeFleetInstancesOutput
Describes the running instances for the specified EC2 Fleet.
Note
Currently, DescribeFleetInstances does not support fleets of type
instant. Instead, use DescribeFleets, specifying the instant fleet
ID in the request.
For more information, see Describe your EC2 Fleet in the Amazon EC2 User Guide.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
DescribeFleetInstancesOutput
|
An instance of |
Input¶
Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.
Model¶
DescribeFleetInstancesInput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeFleetInstancesInput structure.
Attributes¶
dry_run
class-attribute
instance-attribute
¶
dry_run: bool | None = ...
Checks whether you have the required permissions for the action, without
actually making the request, and provides an error response. If you have
the required permissions, the error response is DryRunOperation.
Otherwise, it is UnauthorizedOperation.
filters
class-attribute
instance-attribute
¶
The filters.
instance-type- The instance type.
max_results
class-attribute
instance-attribute
¶
max_results: int | None = ...
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
Dictionaries¶
DescribeFleetInstancesInputDict
¶
Bases: TypedDict
Dictionary form of DescribeFleetInstancesInput.
Attributes¶
dry_run
instance-attribute
¶
dry_run: bool | None
Checks whether you have the required permissions for the action, without
actually making the request, and provides an error response. If you have
the required permissions, the error response is DryRunOperation.
Otherwise, it is UnauthorizedOperation.
filters
instance-attribute
¶
filters: Sequence[Filter | FilterDict] | None
The filters.
instance-type- The instance type.
max_results
instance-attribute
¶
max_results: int | None
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
Output¶
DescribeFleetInstancesOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeFleetInstancesOutput structure.
Attributes¶
active_instances
class-attribute
instance-attribute
¶
active_instances: list[ActiveInstance] | None = ...
The running instances. This list is refreshed periodically and might be out of date.
next_token
class-attribute
instance-attribute
¶
next_token: str | None = ...
The token to include in another request to get the next page of items.
This value is null when there are no more items to return.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.