You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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: ["String"],
}

Contains the parameters for DescribePlacementGroups.

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)


10368
10369
10370
10371
10372
10373
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 10368

class DescribePlacementGroupsRequest < Struct.new(
  :filters,
  :dry_run,
  :group_names)
  include Aws::Structure
end

#filtersArray<Types::Filter>

One or more 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).

Returns:



10368
10369
10370
10371
10372
10373
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 10368

class DescribePlacementGroupsRequest < Struct.new(
  :filters,
  :dry_run,
  :group_names)
  include Aws::Structure
end

#group_namesArray<String>

One or more placement group names.

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

Returns:

  • (Array<String>)


10368
10369
10370
10371
10372
10373
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 10368

class DescribePlacementGroupsRequest < Struct.new(
  :filters,
  :dry_run,
  :group_names)
  include Aws::Structure
end