Class: Aws::EC2::Types::DescribePlacementGroupsRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-ec2/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#dry_runBoolean

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

Returns:

  • (Boolean)


23481
23482
23483
23484
23485
23486
23487
23488
# File 'lib/aws-sdk-ec2/types.rb', line 23481

class DescribePlacementGroupsRequest < Struct.new(
  :filters,
  :dry_run,
  :group_names,
  :group_ids)
  SENSITIVE = []
  include Aws::Structure
end

#filtersArray<Types::Filter>

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.

Returns:



23481
23482
23483
23484
23485
23486
23487
23488
# File 'lib/aws-sdk-ec2/types.rb', line 23481

class DescribePlacementGroupsRequest < Struct.new(
  :filters,
  :dry_run,
  :group_names,
  :group_ids)
  SENSITIVE = []
  include Aws::Structure
end

#group_idsArray<String>

The IDs of the placement groups.

Returns:

  • (Array<String>)


23481
23482
23483
23484
23485
23486
23487
23488
# File 'lib/aws-sdk-ec2/types.rb', line 23481

class DescribePlacementGroupsRequest < Struct.new(
  :filters,
  :dry_run,
  :group_names,
  :group_ids)
  SENSITIVE = []
  include Aws::Structure
end

#group_namesArray<String>

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.

Returns:

  • (Array<String>)


23481
23482
23483
23484
23485
23486
23487
23488
# File 'lib/aws-sdk-ec2/types.rb', line 23481

class DescribePlacementGroupsRequest < Struct.new(
  :filters,
  :dry_run,
  :group_names,
  :group_ids)
  SENSITIVE = []
  include Aws::Structure
end