Skip to content

EC2  >  Operations  >  get_groups_for_capacity_reservation

get_groups_for_capacity_reservation

Operation

get_groups_for_capacity_reservation async

get_groups_for_capacity_reservation(request: GetGroupsForCapacityReservationInput | GetGroupsForCapacityReservationInputDict, /, *, plugins: list[Plugin] | None = None) -> GetGroupsForCapacityReservationOutput
get_groups_for_capacity_reservation(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetGroupsForCapacityReservationInputDict]) -> GetGroupsForCapacityReservationOutput

Lists the resource groups to which a Capacity Reservation has been added.

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
GetGroupsForCapacityReservationOutput

An instance of GetGroupsForCapacityReservationOutput.

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

GetGroupsForCapacityReservationInput dataclass

Bases: _SerdeShape

Dataclass for GetGroupsForCapacityReservationInput structure.

Attributes
capacity_reservation_id class-attribute instance-attribute
capacity_reservation_id: str | None = ...

The ID of the Capacity Reservation. If you specify a Capacity Reservation that is shared with you, the operation returns only Capacity Reservation groups that you own.

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.

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

GetGroupsForCapacityReservationInputDict

Bases: TypedDict

Dictionary form of GetGroupsForCapacityReservationInput.

Attributes
capacity_reservation_id instance-attribute
capacity_reservation_id: Required[str]

The ID of the Capacity Reservation. If you specify a Capacity Reservation that is shared with you, the operation returns only Capacity Reservation groups that you own.

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.

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

GetGroupsForCapacityReservationOutput dataclass

Bases: _SerdeShape

Dataclass for GetGroupsForCapacityReservationOutput structure.

Attributes

capacity_reservation_groups class-attribute instance-attribute
capacity_reservation_groups: list[CapacityReservationGroup] | None = ...

Information about the resource groups to which the Capacity Reservation has been added.

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.