Request Parameters Response Elements Errors Examples See Also

DescribePlacementGroups

Describes the specified placement groups or all of your placement groups. For more information, see Placement groups in the Amazon EC2 User Guide.

Request Parameters

The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.

DryRun

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.

Type: Boolean

Required: No

Filter.N

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).
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.

Type: Array of Filter objects

Required: No

GroupId.N

The IDs of the placement groups.

Type: Array of strings

Required: No

GroupName.N

The names of the placement groups.

Default: Describes all your placement groups, or only those otherwise specified.

Type: Array of strings

Required: No

Response Elements

The following elements are returned by the service.

placementGroupSet

Information about the placement groups.

Type: Array of PlacementGroup objects

requestId

The ID of the request.

Type: String

Errors

For information about the errors that are common to all actions, see Common client error codes.

Examples

Example 1

This example describes the placement group named ABC-spread.

Sample Request


https://ec2.amazonaws.com/?Action=DescribePlacementGroups
&GroupName.1=ABC-spread
&AUTHPARAMS

Sample Response


<DescribePlacementGroupsResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/">
   <requestID>d4904fd9-82c2-4ea5-adfe-a9cc3EXAMPLE</requestID>
   <placementGroupSet>
      <item>
         <groupName>ABC-spread</groupName>
         <spreadLevel>rack</spreadLevel>
         <strategy>spread</strategy>
         <state>available</state>
      </item>
   </placementGroupSet>
</DescribePlacementGroupsResponse>

Example 2

This example filters the response to include only placement groups that include the string Project in the name.

Sample Request


https://ec2.amazonaws.com/?Action=DescribePlacementGroups
&Filter.1.Name=group-name
&Filter.1.Value=*Project*
&AUTHPARAMS

Sample Response


<DescribePlacementGroupsResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/">
   <requestID>d4904fd9-82c2-4ea5-adfe-a9cc3EXAMPLE</requestID>
   <placementGroupSet>
      <item>
         <groupName>Project-cluster</groupName>
         <strategy>cluster</strategy>
         <state>available</state>
      </item>
   </placementGroupSet>
</DescribePlacementGroupsResponse>

Example 3

This example describes the partition placement group named HDSF-Group-A with three partitions.

Sample Request


https://ec2.amazonaws.com/?Action=DescribePlacementGroups
&GroupName.1=HDSF-Group-A
&AUTHPARAMS

Sample Response


<DescribePlacementGroupsResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/">
   <requestID>d4904fd9-82c2-4ea5-adfe-a9cc3EXAMPLE</requestID>
   <placementGroupSet>
      <item>
         <groupName>HDSF-Group-A</groupName>
         <strategy>partition</strategy>
         <partitionCount>3</partitionCount>
         <state>available</state>
      </item>
   </placementGroupSet>
</DescribePlacementGroupsResponse>