/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include #include namespace Aws { namespace EC2 { namespace Model { /** *

Contains the parameters for DescribeReservedInstances.

See * Also:

AWS * API Reference

*/ class DescribeReservedInstancesRequest : public EC2Request { public: AWS_EC2_API DescribeReservedInstancesRequest(); // 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 "DescribeReservedInstances"; } AWS_EC2_API Aws::String SerializePayload() const override; protected: AWS_EC2_API void DumpBodyToUrl(Aws::Http::URI& uri ) const override; public: /** *

One or more filters.

  • availability-zone - The * Availability Zone where the Reserved Instance can be used.

  • * duration - The duration of the Reserved Instance (one year or three * years), in seconds (31536000 | 94608000).

  • *
  • end - The time when the Reserved Instance expires (for * example, 2015-08-07T11:54:42.000Z).

  • fixed-price * - The purchase price of the Reserved Instance (for example, 9800.0).

  • *
  • instance-type - The instance type that is covered by the * reservation.

  • scope - The scope of the Reserved * Instance (Region or Availability Zone).

  • *

    product-description - The Reserved Instance product platform * description (Linux/UNIX | Linux with SQL Server * Standard | Linux with SQL Server Web | Linux with SQL * Server Enterprise | SUSE Linux | Red Hat Enterprise * Linux | Red Hat Enterprise Linux with HA | * Windows | Windows with SQL Server Standard | * Windows with SQL Server Web | Windows with SQL Server * Enterprise).

  • reserved-instances-id - The * ID of the Reserved Instance.

  • start - The time at * which the Reserved Instance purchase request was placed (for example, * 2014-08-07T11:54:42.000Z).

  • state - The state of * the Reserved Instance (payment-pending | active | * payment-failed | retired).

  • * 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 assigned a tag with a * specific key, regardless of the tag value.

  • * usage-price - The usage price of the Reserved Instance, per hour * (for example, 0.84).

*/ inline const Aws::Vector& GetFilters() const{ return m_filters; } /** *

One or more filters.

  • availability-zone - The * Availability Zone where the Reserved Instance can be used.

  • * duration - The duration of the Reserved Instance (one year or three * years), in seconds (31536000 | 94608000).

  • *
  • end - The time when the Reserved Instance expires (for * example, 2015-08-07T11:54:42.000Z).

  • fixed-price * - The purchase price of the Reserved Instance (for example, 9800.0).

  • *
  • instance-type - The instance type that is covered by the * reservation.

  • scope - The scope of the Reserved * Instance (Region or Availability Zone).

  • *

    product-description - The Reserved Instance product platform * description (Linux/UNIX | Linux with SQL Server * Standard | Linux with SQL Server Web | Linux with SQL * Server Enterprise | SUSE Linux | Red Hat Enterprise * Linux | Red Hat Enterprise Linux with HA | * Windows | Windows with SQL Server Standard | * Windows with SQL Server Web | Windows with SQL Server * Enterprise).

  • reserved-instances-id - The * ID of the Reserved Instance.

  • start - The time at * which the Reserved Instance purchase request was placed (for example, * 2014-08-07T11:54:42.000Z).

  • state - The state of * the Reserved Instance (payment-pending | active | * payment-failed | retired).

  • * 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 assigned a tag with a * specific key, regardless of the tag value.

  • * usage-price - The usage price of the Reserved Instance, per hour * (for example, 0.84).

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

One or more filters.

  • availability-zone - The * Availability Zone where the Reserved Instance can be used.

  • * duration - The duration of the Reserved Instance (one year or three * years), in seconds (31536000 | 94608000).

  • *
  • end - The time when the Reserved Instance expires (for * example, 2015-08-07T11:54:42.000Z).

  • fixed-price * - The purchase price of the Reserved Instance (for example, 9800.0).

  • *
  • instance-type - The instance type that is covered by the * reservation.

  • scope - The scope of the Reserved * Instance (Region or Availability Zone).

  • *

    product-description - The Reserved Instance product platform * description (Linux/UNIX | Linux with SQL Server * Standard | Linux with SQL Server Web | Linux with SQL * Server Enterprise | SUSE Linux | Red Hat Enterprise * Linux | Red Hat Enterprise Linux with HA | * Windows | Windows with SQL Server Standard | * Windows with SQL Server Web | Windows with SQL Server * Enterprise).

  • reserved-instances-id - The * ID of the Reserved Instance.

  • start - The time at * which the Reserved Instance purchase request was placed (for example, * 2014-08-07T11:54:42.000Z).

  • state - The state of * the Reserved Instance (payment-pending | active | * payment-failed | retired).

  • * 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 assigned a tag with a * specific key, regardless of the tag value.

  • * usage-price - The usage price of the Reserved Instance, per hour * (for example, 0.84).

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

One or more filters.

  • availability-zone - The * Availability Zone where the Reserved Instance can be used.

  • * duration - The duration of the Reserved Instance (one year or three * years), in seconds (31536000 | 94608000).

  • *
  • end - The time when the Reserved Instance expires (for * example, 2015-08-07T11:54:42.000Z).

  • fixed-price * - The purchase price of the Reserved Instance (for example, 9800.0).

  • *
  • instance-type - The instance type that is covered by the * reservation.

  • scope - The scope of the Reserved * Instance (Region or Availability Zone).

  • *

    product-description - The Reserved Instance product platform * description (Linux/UNIX | Linux with SQL Server * Standard | Linux with SQL Server Web | Linux with SQL * Server Enterprise | SUSE Linux | Red Hat Enterprise * Linux | Red Hat Enterprise Linux with HA | * Windows | Windows with SQL Server Standard | * Windows with SQL Server Web | Windows with SQL Server * Enterprise).

  • reserved-instances-id - The * ID of the Reserved Instance.

  • start - The time at * which the Reserved Instance purchase request was placed (for example, * 2014-08-07T11:54:42.000Z).

  • state - The state of * the Reserved Instance (payment-pending | active | * payment-failed | retired).

  • * 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 assigned a tag with a * specific key, regardless of the tag value.

  • * usage-price - The usage price of the Reserved Instance, per hour * (for example, 0.84).

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

One or more filters.

  • availability-zone - The * Availability Zone where the Reserved Instance can be used.

  • * duration - The duration of the Reserved Instance (one year or three * years), in seconds (31536000 | 94608000).

  • *
  • end - The time when the Reserved Instance expires (for * example, 2015-08-07T11:54:42.000Z).

  • fixed-price * - The purchase price of the Reserved Instance (for example, 9800.0).

  • *
  • instance-type - The instance type that is covered by the * reservation.

  • scope - The scope of the Reserved * Instance (Region or Availability Zone).

  • *

    product-description - The Reserved Instance product platform * description (Linux/UNIX | Linux with SQL Server * Standard | Linux with SQL Server Web | Linux with SQL * Server Enterprise | SUSE Linux | Red Hat Enterprise * Linux | Red Hat Enterprise Linux with HA | * Windows | Windows with SQL Server Standard | * Windows with SQL Server Web | Windows with SQL Server * Enterprise).

  • reserved-instances-id - The * ID of the Reserved Instance.

  • start - The time at * which the Reserved Instance purchase request was placed (for example, * 2014-08-07T11:54:42.000Z).

  • state - The state of * the Reserved Instance (payment-pending | active | * payment-failed | retired).

  • * 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 assigned a tag with a * specific key, regardless of the tag value.

  • * usage-price - The usage price of the Reserved Instance, per hour * (for example, 0.84).

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

One or more filters.

  • availability-zone - The * Availability Zone where the Reserved Instance can be used.

  • * duration - The duration of the Reserved Instance (one year or three * years), in seconds (31536000 | 94608000).

  • *
  • end - The time when the Reserved Instance expires (for * example, 2015-08-07T11:54:42.000Z).

  • fixed-price * - The purchase price of the Reserved Instance (for example, 9800.0).

  • *
  • instance-type - The instance type that is covered by the * reservation.

  • scope - The scope of the Reserved * Instance (Region or Availability Zone).

  • *

    product-description - The Reserved Instance product platform * description (Linux/UNIX | Linux with SQL Server * Standard | Linux with SQL Server Web | Linux with SQL * Server Enterprise | SUSE Linux | Red Hat Enterprise * Linux | Red Hat Enterprise Linux with HA | * Windows | Windows with SQL Server Standard | * Windows with SQL Server Web | Windows with SQL Server * Enterprise).

  • reserved-instances-id - The * ID of the Reserved Instance.

  • start - The time at * which the Reserved Instance purchase request was placed (for example, * 2014-08-07T11:54:42.000Z).

  • state - The state of * the Reserved Instance (payment-pending | active | * payment-failed | retired).

  • * 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 assigned a tag with a * specific key, regardless of the tag value.

  • * usage-price - The usage price of the Reserved Instance, per hour * (for example, 0.84).

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

One or more filters.

  • availability-zone - The * Availability Zone where the Reserved Instance can be used.

  • * duration - The duration of the Reserved Instance (one year or three * years), in seconds (31536000 | 94608000).

  • *
  • end - The time when the Reserved Instance expires (for * example, 2015-08-07T11:54:42.000Z).

  • fixed-price * - The purchase price of the Reserved Instance (for example, 9800.0).

  • *
  • instance-type - The instance type that is covered by the * reservation.

  • scope - The scope of the Reserved * Instance (Region or Availability Zone).

  • *

    product-description - The Reserved Instance product platform * description (Linux/UNIX | Linux with SQL Server * Standard | Linux with SQL Server Web | Linux with SQL * Server Enterprise | SUSE Linux | Red Hat Enterprise * Linux | Red Hat Enterprise Linux with HA | * Windows | Windows with SQL Server Standard | * Windows with SQL Server Web | Windows with SQL Server * Enterprise).

  • reserved-instances-id - The * ID of the Reserved Instance.

  • start - The time at * which the Reserved Instance purchase request was placed (for example, * 2014-08-07T11:54:42.000Z).

  • state - The state of * the Reserved Instance (payment-pending | active | * payment-failed | retired).

  • * 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 assigned a tag with a * specific key, regardless of the tag value.

  • * usage-price - The usage price of the Reserved Instance, per hour * (for example, 0.84).

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

One or more filters.

  • availability-zone - The * Availability Zone where the Reserved Instance can be used.

  • * duration - The duration of the Reserved Instance (one year or three * years), in seconds (31536000 | 94608000).

  • *
  • end - The time when the Reserved Instance expires (for * example, 2015-08-07T11:54:42.000Z).

  • fixed-price * - The purchase price of the Reserved Instance (for example, 9800.0).

  • *
  • instance-type - The instance type that is covered by the * reservation.

  • scope - The scope of the Reserved * Instance (Region or Availability Zone).

  • *

    product-description - The Reserved Instance product platform * description (Linux/UNIX | Linux with SQL Server * Standard | Linux with SQL Server Web | Linux with SQL * Server Enterprise | SUSE Linux | Red Hat Enterprise * Linux | Red Hat Enterprise Linux with HA | * Windows | Windows with SQL Server Standard | * Windows with SQL Server Web | Windows with SQL Server * Enterprise).

  • reserved-instances-id - The * ID of the Reserved Instance.

  • start - The time at * which the Reserved Instance purchase request was placed (for example, * 2014-08-07T11:54:42.000Z).

  • state - The state of * the Reserved Instance (payment-pending | active | * payment-failed | retired).

  • * 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 assigned a tag with a * specific key, regardless of the tag value.

  • * usage-price - The usage price of the Reserved Instance, per hour * (for example, 0.84).

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

Describes whether the Reserved Instance is Standard or Convertible.

*/ inline const OfferingClassType& GetOfferingClass() const{ return m_offeringClass; } /** *

Describes whether the Reserved Instance is Standard or Convertible.

*/ inline bool OfferingClassHasBeenSet() const { return m_offeringClassHasBeenSet; } /** *

Describes whether the Reserved Instance is Standard or Convertible.

*/ inline void SetOfferingClass(const OfferingClassType& value) { m_offeringClassHasBeenSet = true; m_offeringClass = value; } /** *

Describes whether the Reserved Instance is Standard or Convertible.

*/ inline void SetOfferingClass(OfferingClassType&& value) { m_offeringClassHasBeenSet = true; m_offeringClass = std::move(value); } /** *

Describes whether the Reserved Instance is Standard or Convertible.

*/ inline DescribeReservedInstancesRequest& WithOfferingClass(const OfferingClassType& value) { SetOfferingClass(value); return *this;} /** *

Describes whether the Reserved Instance is Standard or Convertible.

*/ inline DescribeReservedInstancesRequest& WithOfferingClass(OfferingClassType&& value) { SetOfferingClass(std::move(value)); return *this;} /** *

One or more Reserved Instance IDs.

Default: Describes all your * Reserved Instances, or only those otherwise specified.

*/ inline const Aws::Vector& GetReservedInstancesIds() const{ return m_reservedInstancesIds; } /** *

One or more Reserved Instance IDs.

Default: Describes all your * Reserved Instances, or only those otherwise specified.

*/ inline bool ReservedInstancesIdsHasBeenSet() const { return m_reservedInstancesIdsHasBeenSet; } /** *

One or more Reserved Instance IDs.

Default: Describes all your * Reserved Instances, or only those otherwise specified.

*/ inline void SetReservedInstancesIds(const Aws::Vector& value) { m_reservedInstancesIdsHasBeenSet = true; m_reservedInstancesIds = value; } /** *

One or more Reserved Instance IDs.

Default: Describes all your * Reserved Instances, or only those otherwise specified.

*/ inline void SetReservedInstancesIds(Aws::Vector&& value) { m_reservedInstancesIdsHasBeenSet = true; m_reservedInstancesIds = std::move(value); } /** *

One or more Reserved Instance IDs.

Default: Describes all your * Reserved Instances, or only those otherwise specified.

*/ inline DescribeReservedInstancesRequest& WithReservedInstancesIds(const Aws::Vector& value) { SetReservedInstancesIds(value); return *this;} /** *

One or more Reserved Instance IDs.

Default: Describes all your * Reserved Instances, or only those otherwise specified.

*/ inline DescribeReservedInstancesRequest& WithReservedInstancesIds(Aws::Vector&& value) { SetReservedInstancesIds(std::move(value)); return *this;} /** *

One or more Reserved Instance IDs.

Default: Describes all your * Reserved Instances, or only those otherwise specified.

*/ inline DescribeReservedInstancesRequest& AddReservedInstancesIds(const Aws::String& value) { m_reservedInstancesIdsHasBeenSet = true; m_reservedInstancesIds.push_back(value); return *this; } /** *

One or more Reserved Instance IDs.

Default: Describes all your * Reserved Instances, or only those otherwise specified.

*/ inline DescribeReservedInstancesRequest& AddReservedInstancesIds(Aws::String&& value) { m_reservedInstancesIdsHasBeenSet = true; m_reservedInstancesIds.push_back(std::move(value)); return *this; } /** *

One or more Reserved Instance IDs.

Default: Describes all your * Reserved Instances, or only those otherwise specified.

*/ inline DescribeReservedInstancesRequest& AddReservedInstancesIds(const char* value) { m_reservedInstancesIdsHasBeenSet = true; m_reservedInstancesIds.push_back(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 DescribeReservedInstancesRequest& WithDryRun(bool value) { SetDryRun(value); return *this;} /** *

The Reserved Instance offering type. If you are using tools that predate the * 2011-11-01 API version, you only have access to the Medium * Utilization Reserved Instance offering type.

*/ inline const OfferingTypeValues& GetOfferingType() const{ return m_offeringType; } /** *

The Reserved Instance offering type. If you are using tools that predate the * 2011-11-01 API version, you only have access to the Medium * Utilization Reserved Instance offering type.

*/ inline bool OfferingTypeHasBeenSet() const { return m_offeringTypeHasBeenSet; } /** *

The Reserved Instance offering type. If you are using tools that predate the * 2011-11-01 API version, you only have access to the Medium * Utilization Reserved Instance offering type.

*/ inline void SetOfferingType(const OfferingTypeValues& value) { m_offeringTypeHasBeenSet = true; m_offeringType = value; } /** *

The Reserved Instance offering type. If you are using tools that predate the * 2011-11-01 API version, you only have access to the Medium * Utilization Reserved Instance offering type.

*/ inline void SetOfferingType(OfferingTypeValues&& value) { m_offeringTypeHasBeenSet = true; m_offeringType = std::move(value); } /** *

The Reserved Instance offering type. If you are using tools that predate the * 2011-11-01 API version, you only have access to the Medium * Utilization Reserved Instance offering type.

*/ inline DescribeReservedInstancesRequest& WithOfferingType(const OfferingTypeValues& value) { SetOfferingType(value); return *this;} /** *

The Reserved Instance offering type. If you are using tools that predate the * 2011-11-01 API version, you only have access to the Medium * Utilization Reserved Instance offering type.

*/ inline DescribeReservedInstancesRequest& WithOfferingType(OfferingTypeValues&& value) { SetOfferingType(std::move(value)); return *this;} private: Aws::Vector m_filters; bool m_filtersHasBeenSet = false; OfferingClassType m_offeringClass; bool m_offeringClassHasBeenSet = false; Aws::Vector m_reservedInstancesIds; bool m_reservedInstancesIdsHasBeenSet = false; bool m_dryRun; bool m_dryRunHasBeenSet = false; OfferingTypeValues m_offeringType; bool m_offeringTypeHasBeenSet = false; }; } // namespace Model } // namespace EC2 } // namespace Aws