Skip to content

EC2  >  Operations  >  describe_capacity_reservation_fleets

describe_capacity_reservation_fleets

Operation

describe_capacity_reservation_fleets async

describe_capacity_reservation_fleets(request: DescribeCapacityReservationFleetsInput | DescribeCapacityReservationFleetsInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeCapacityReservationFleetsOutput
describe_capacity_reservation_fleets(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeCapacityReservationFleetsInputDict]) -> DescribeCapacityReservationFleetsOutput

Describes one or more Capacity Reservation Fleets.

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
DescribeCapacityReservationFleetsOutput

An instance of DescribeCapacityReservationFleetsOutput.

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

DescribeCapacityReservationFleetsInput dataclass

Bases: _SerdeShape

Dataclass for DescribeCapacityReservationFleetsInput structure.

Attributes
capacity_reservation_fleet_ids class-attribute instance-attribute
capacity_reservation_fleet_ids: list[str] | None = ...

The IDs of the Capacity Reservation Fleets to describe.

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
filters: list[Filter] | None = ...

One or more filters.

  • state - The state of the Fleet (submitted | modifying | active | partially_fulfilled | expiring | expired | cancelling | cancelled | failed).

  • instance-match-criteria - The instance matching criteria for the Fleet. Only open is supported.

  • tenancy - The tenancy of the Fleet (default | dedicated).

  • allocation-strategy - The allocation strategy used by the Fleet. Only prioritized is supported.

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.

next_token class-attribute instance-attribute
next_token: str | None = ...

The token to use to retrieve the next page of results.

Dictionaries

DescribeCapacityReservationFleetsInputDict

Bases: TypedDict

Dictionary form of DescribeCapacityReservationFleetsInput.

Attributes
capacity_reservation_fleet_ids instance-attribute
capacity_reservation_fleet_ids: Sequence[str] | None

The IDs of the Capacity Reservation Fleets to describe.

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

One or more filters.

  • state - The state of the Fleet (submitted | modifying | active | partially_fulfilled | expiring | expired | cancelling | cancelled | failed).

  • instance-match-criteria - The instance matching criteria for the Fleet. Only open is supported.

  • tenancy - The tenancy of the Fleet (default | dedicated).

  • allocation-strategy - The allocation strategy used by the Fleet. Only prioritized is supported.

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.

next_token instance-attribute
next_token: str | None

The token to use to retrieve the next page of results.

Output

DescribeCapacityReservationFleetsOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeCapacityReservationFleetsOutput structure.

Attributes

capacity_reservation_fleets class-attribute instance-attribute
capacity_reservation_fleets: list[CapacityReservationFleet] | None = ...

Information about the Capacity Reservation Fleets.

next_token class-attribute instance-attribute
next_token: str | None = ...

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

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.