Menu
Amazon Elastic Compute Cloud
API Reference (API Version 2016-11-15)

DescribePlacementGroups

Describes one or more of your placement groups. For more information about placement groups and cluster instances, see Cluster Instances in the Amazon Elastic Compute Cloud 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

One or more filters.

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

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

  • strategy - The strategy of the placement group (cluster).

Type: array of Filter objects

Required: No

GroupName.N

One or more placement group names.

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

One or more 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 Errors.

Examples

Example

This example describes the placement group named XYZ-cluster.

Sample Request

Copy
https://ec2.amazonaws.com/?Action=DescribePlacementGroups &GroupName.1=XYZ-cluster &AUTHPARAMS

Sample Response

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

Example

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

Sample Request

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

Sample Response

Copy
<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>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: