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

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

Overview

Note:

When making an API call, you may pass DescribePlacementGroupsRequest data as a hash:

{
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  dry_run: false,
  group_names: ["PlacementGroupName"],
  group_ids: ["PlacementGroupId"],
}

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)


17883
17884
17885
17886
17887
17888
17889
17890
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 17883

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.

  • 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:



17883
17884
17885
17886
17887
17888
17889
17890
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 17883

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


17883
17884
17885
17886
17887
17888
17889
17890
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 17883

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.

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

Returns:

  • (Array<String>)


17883
17884
17885
17886
17887
17888
17889
17890
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 17883

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