[ aws . ec2 ]

describe-placement-groups

Description

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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-placement-groups
[--filters <value>]
[--dry-run | --no-dry-run]
[--group-names <value>]
[--group-ids <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--filters (list)

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

(structure)

A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. The filters supported by a describe operation are documented with the describe operation. For example:

  • DescribeAvailabilityZones

  • DescribeImages

  • DescribeInstances

  • DescribeKeyPairs

  • DescribeSecurityGroups

  • DescribeSnapshots

  • DescribeSubnets

  • DescribeTags

  • DescribeVolumes

  • DescribeVpcs

Name -> (string)

The name of the filter. Filter names are case-sensitive.

Values -> (list)

The filter values. Filter values are case-sensitive.

(string)

Shorthand Syntax:

Name=string,Values=string,string ...

JSON Syntax:

[
  {
    "Name": "string",
    "Values": ["string", ...]
  }
  ...
]

--dry-run | --no-dry-run (boolean)

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 .

--group-names (list)

The names of the placement groups.

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

(string)

Syntax:

"string" "string" ...

--group-ids (list)

The IDs of the placement groups.

(string)

Syntax:

"string" "string" ...

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples

To describe your placement groups

This example command describes all of your placement groups.

Command:

aws ec2 describe-placement-groups

Output:

{
    "PlacementGroups": [
        {
            "GroupName": "my-cluster",
            "State": "available",
            "Strategy": "cluster"
        },
        ...
    ]
}

Output

PlacementGroups -> (list)

Information about the placement groups.

(structure)

Describes a placement group.

GroupName -> (string)

The name of the placement group.

State -> (string)

The state of the placement group.

Strategy -> (string)

The placement strategy.

PartitionCount -> (integer)

The number of partitions. Valid only if strategy is set to partition .

GroupId -> (string)

The ID of the placement group.

Tags -> (list)

Any tags applied to the placement group.

(structure)

Describes a tag.

Key -> (string)

The key of the tag.

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .

Value -> (string)

The value of the tag.

Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.