| « PreviousNext » | |
  | Did this page help you? Yes | No | Tell us about it... |
ec2-describe-placement-groups
Description
Describes one or more of your placement groups. For more information about placement groups and cluster instances, see Using Cluster Instances in the Amazon Elastic Compute Cloud User Guide.
The short version of this command is ec2dpgrp.
ec2-describe-placement-groups
[
group_name]
[[--filter "name=value"] ...]
Options
| Name | Description |
|---|---|
|
|
One or more placement group names. Type: String Default: Describes all placement groups you own. Required: No Example: XYZ-cluster |
|
|
A filter for limiting the results. See the Supported Filters section for a list of supported filters. Use quotation marks if the value string has a space ("name=value example"). On a Windows system, use quotation marks even without a space in the value string ("name=value"). Type: String Default: Describes all your placement groups, or only those you specified by name. Required: No Example: --filter "group-name=*Project*" |
Supported Filters
You can specify filter so that the response includes information for only certain placement groups. For example, you can use a filter to specify that you're interested in groups in the deleted state. You can specify multiple values for a filter. The response includes information for a placement group only if it matches at least one of the filter values that you specified.
You can specify multiple filters; for example, specify group's that are in the deleted state and have a name that includes the string Project. The response includes information for a group only if it matches all your filters. If there's no match, no special message is returned, the response is simply empty.
You can use wildcards in a filter value. An asterisk (*) matches zero or more characters, and a question mark (?) matches exactly one character. You can escape special characters using a backslash (\) before the character. For example, a value of \*amazon\?\\ searches for the literal string *amazon?\.
The following are the available filters.
group-nameThe name of the placement group.
Type: String
stateThe state of the placement group.
Type: String
Valid values:
pending|available|deleting|deletedstrategyThe strategy of the placement group.
Type: String
Valid value:
cluster
Common Options
| Option | Description |
|---|---|
|
|
Overrides the region specified by the Default: The value of the Example: |
|
|
The uniform resource locator (URL) of the Amazon EC2 web service entry point. Default: The value of the Example: |
|
|
The access key ID associated with your AWS account. For more information, see Tell the Tools Who You Are. Default: The value of the Example: Note For more information, see the following section, Deprecated Options. |
|
|
The secret access key associated with your AWS account. Default: The value of the Example: Note For more information, see the following section, Deprecated Options. |
|
|
The AWS delegation token. Default: The value of the environment variable (if set). |
|
|
The connection timeout, in seconds. Example: |
|
|
The request timeout, in seconds. Example: |
|
|
Displays verbose output, including the API request and response on the command line. This is useful if you are building tools to talk directly to our Query API. |
|
|
Includes column headers in the command output. |
|
|
Shows empty columns as |
|
|
Omits tags for tagged resources. |
|
|
Displays internal debugging information. This can assist us when helping you troubleshooting problems. |
|
|
Displays usage information for the command. |
|
|
Reads arguments from standard input. This is useful when piping the output from one command to the input of another. Example: |
Deprecated Options
For a limited time, you can still use the private key and X.509 certificate instead of your access key ID and secret access key. However, we recommend that you start using your access key ID (-O, --aws-access-key) and secret access key (-W, --aws-secret-key) now, as the private key (-K, --private-key) and X.509 certificate (-C, --cert) won't be supported after the transition period elapses. For more information, see Tell the Tools Who You Are.
| Option | Description |
|---|---|
|
|
The private key to use when constructing requests to Amazon EC2. Default: The value of the Example: |
|
|
The X.509 certificate to use when constructing requests to Amazon EC2. Default: The value of the Example: |
Output
This command returns the following information:
The PLACEMENTGROUP identifier
The placement group name
The placement group strategy
The state of the placement group
Examples
Example Request
This example describes all your placement groups.
PROMPT> ec2-describe-placement-groups
PLACEMENTGROUP XYZ-cluster cluster available
PLACEMENTGROUP ABC-cluster cluster availableExample Request
This example filters the response to include only placement groups that include the string Project in the name.
PROMPT> ec2-describe-placement-groups --filter "group-name=*Project*"
PLACEMENTGROUP Project-cluster cluster available
