Skip to content

Describe Placement Groups

ec2_describe_placement_groups R Documentation

Describes the specified placement groups or all of your placement groups

Description

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

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.

Usage

ec2_describe_placement_groups(Filters, DryRun, GroupNames, GroupIds)

Arguments

Filters

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.

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.

GroupNames

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.

GroupIds

The IDs of the placement groups.

Value

A list with the following syntax: 

list(
  PlacementGroups = list(
    list(
      GroupName = "string",
      State = "pending"|"available"|"deleting"|"deleted",
      Strategy = "cluster"|"spread"|"partition",
      PartitionCount = 123,
      GroupId = "string",
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      ),
      GroupArn = "string",
      SpreadLevel = "host"|"rack"
    )
  )
)

Request syntax

svc$describe_placement_groups(
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  DryRun = TRUE|FALSE,
  GroupNames = list(
    "string"
  ),
  GroupIds = list(
    "string"
  )
)