/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include namespace Aws { namespace EC2 { namespace Model { /** */ class DescribePlacementGroupsRequest : public EC2Request { public: AWS_EC2_API DescribePlacementGroupsRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "DescribePlacementGroups"; } AWS_EC2_API Aws::String SerializePayload() const override; protected: AWS_EC2_API void DumpBodyToUrl(Aws::Http::URI& uri ) const override; public: /** *

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.

*/ inline const Aws::Vector& GetFilters() const{ return m_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.

*/ inline bool FiltersHasBeenSet() const { return m_filtersHasBeenSet; } /** *

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.

*/ inline void SetFilters(const Aws::Vector& value) { m_filtersHasBeenSet = true; m_filters = value; } /** *

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.

*/ inline void SetFilters(Aws::Vector&& value) { m_filtersHasBeenSet = true; m_filters = std::move(value); } /** *

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.

*/ inline DescribePlacementGroupsRequest& WithFilters(const Aws::Vector& value) { SetFilters(value); return *this;} /** *

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.

*/ inline DescribePlacementGroupsRequest& WithFilters(Aws::Vector&& value) { SetFilters(std::move(value)); return *this;} /** *

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.

*/ inline DescribePlacementGroupsRequest& AddFilters(const Filter& value) { m_filtersHasBeenSet = true; m_filters.push_back(value); return *this; } /** *

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.

*/ inline DescribePlacementGroupsRequest& AddFilters(Filter&& value) { m_filtersHasBeenSet = true; m_filters.push_back(std::move(value)); return *this; } /** *

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.

*/ inline bool GetDryRun() const{ return m_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.

*/ inline bool DryRunHasBeenSet() const { return m_dryRunHasBeenSet; } /** *

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.

*/ inline void SetDryRun(bool value) { m_dryRunHasBeenSet = true; m_dryRun = value; } /** *

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.

*/ inline DescribePlacementGroupsRequest& WithDryRun(bool value) { SetDryRun(value); return *this;} /** *

The names of the placement groups.

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

*/ inline const Aws::Vector& GetGroupNames() const{ return m_groupNames; } /** *

The names of the placement groups.

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

*/ inline bool GroupNamesHasBeenSet() const { return m_groupNamesHasBeenSet; } /** *

The names of the placement groups.

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

*/ inline void SetGroupNames(const Aws::Vector& value) { m_groupNamesHasBeenSet = true; m_groupNames = value; } /** *

The names of the placement groups.

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

*/ inline void SetGroupNames(Aws::Vector&& value) { m_groupNamesHasBeenSet = true; m_groupNames = std::move(value); } /** *

The names of the placement groups.

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

*/ inline DescribePlacementGroupsRequest& WithGroupNames(const Aws::Vector& value) { SetGroupNames(value); return *this;} /** *

The names of the placement groups.

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

*/ inline DescribePlacementGroupsRequest& WithGroupNames(Aws::Vector&& value) { SetGroupNames(std::move(value)); return *this;} /** *

The names of the placement groups.

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

*/ inline DescribePlacementGroupsRequest& AddGroupNames(const Aws::String& value) { m_groupNamesHasBeenSet = true; m_groupNames.push_back(value); return *this; } /** *

The names of the placement groups.

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

*/ inline DescribePlacementGroupsRequest& AddGroupNames(Aws::String&& value) { m_groupNamesHasBeenSet = true; m_groupNames.push_back(std::move(value)); return *this; } /** *

The names of the placement groups.

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

*/ inline DescribePlacementGroupsRequest& AddGroupNames(const char* value) { m_groupNamesHasBeenSet = true; m_groupNames.push_back(value); return *this; } /** *

The IDs of the placement groups.

*/ inline const Aws::Vector& GetGroupIds() const{ return m_groupIds; } /** *

The IDs of the placement groups.

*/ inline bool GroupIdsHasBeenSet() const { return m_groupIdsHasBeenSet; } /** *

The IDs of the placement groups.

*/ inline void SetGroupIds(const Aws::Vector& value) { m_groupIdsHasBeenSet = true; m_groupIds = value; } /** *

The IDs of the placement groups.

*/ inline void SetGroupIds(Aws::Vector&& value) { m_groupIdsHasBeenSet = true; m_groupIds = std::move(value); } /** *

The IDs of the placement groups.

*/ inline DescribePlacementGroupsRequest& WithGroupIds(const Aws::Vector& value) { SetGroupIds(value); return *this;} /** *

The IDs of the placement groups.

*/ inline DescribePlacementGroupsRequest& WithGroupIds(Aws::Vector&& value) { SetGroupIds(std::move(value)); return *this;} /** *

The IDs of the placement groups.

*/ inline DescribePlacementGroupsRequest& AddGroupIds(const Aws::String& value) { m_groupIdsHasBeenSet = true; m_groupIds.push_back(value); return *this; } /** *

The IDs of the placement groups.

*/ inline DescribePlacementGroupsRequest& AddGroupIds(Aws::String&& value) { m_groupIdsHasBeenSet = true; m_groupIds.push_back(std::move(value)); return *this; } /** *

The IDs of the placement groups.

*/ inline DescribePlacementGroupsRequest& AddGroupIds(const char* value) { m_groupIdsHasBeenSet = true; m_groupIds.push_back(value); return *this; } private: Aws::Vector m_filters; bool m_filtersHasBeenSet = false; bool m_dryRun; bool m_dryRunHasBeenSet = false; Aws::Vector m_groupNames; bool m_groupNamesHasBeenSet = false; Aws::Vector m_groupIds; bool m_groupIdsHasBeenSet = false; }; } // namespace Model } // namespace EC2 } // namespace Aws