Skip to content

EC2  >  Operations  >  describe_placement_groups

describe_placement_groups

Operation

describe_placement_groups async 

describe_placement_groups(input: DescribePlacementGroupsInput, plugins: list[Plugin] | None = None) -> DescribePlacementGroupsOutput

Describes the specified placement groups or all of your placement groups.

Note

To describe a specific placement group that is shared with your account, you must specify the ID of the placement group using the GroupId parameter. Specifying the name of a shared placement group using the GroupNames parameter will result in an error.

For more information, see Placement groups in the Amazon EC2 User Guide.

Parameters:

Name Type Description Default
input DescribePlacementGroupsInput

An instance of DescribePlacementGroupsInput.

 required
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
DescribePlacementGroupsOutput

An instance of DescribePlacementGroupsOutput.

Input

DescribePlacementGroupsInput dataclass

Bases: _SerdeShape

Dataclass for DescribePlacementGroupsInput structure.

Attributes

dry_run class-attribute instance-attribute 
dry_run: bool | None = ...

Checks whether you have the required permissions for the operation, 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 = ...

The filters.

  • group-name - The name of the placement group.

  • group-arn - The Amazon Resource Name (ARN) of the placement group.

  • spread-level - The spread level for the placement group (host | rack).

  • state - The state of the placement group (pending | available | deleting | deleted).

  • strategy - The strategy of the placement group (cluster | spread | partition | precision-time).

  • tag:``<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.

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

The IDs of the placement groups.

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

The names of the placement groups.

Constraints:

  • You can specify a name only if the placement group is owned by your account.

  • If a placement group is shared with your account, specifying the name results in an error. You must use the GroupId parameter instead.

Output

DescribePlacementGroupsOutput dataclass

Bases: _SerdeShape

Dataclass for DescribePlacementGroupsOutput structure.

Attributes

placement_groups class-attribute instance-attribute 
placement_groups: list[PlacementGroup] | None = ...

Information about the placement groups.

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.