327 lines
17 KiB
C++
327 lines
17 KiB
C++
/**
|
|
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
|
* SPDX-License-Identifier: Apache-2.0.
|
|
*/
|
|
|
|
#pragma once
|
|
#include <aws/ec2/EC2_EXPORTS.h>
|
|
#include <aws/ec2/EC2Request.h>
|
|
#include <aws/core/utils/memory/stl/AWSVector.h>
|
|
#include <aws/core/utils/memory/stl/AWSString.h>
|
|
#include <aws/ec2/model/Filter.h>
|
|
#include <utility>
|
|
|
|
namespace Aws
|
|
{
|
|
namespace EC2
|
|
{
|
|
namespace Model
|
|
{
|
|
|
|
/**
|
|
*/
|
|
class AWS_EC2_API DescribeHostReservationsRequest : public EC2Request
|
|
{
|
|
public:
|
|
DescribeHostReservationsRequest();
|
|
|
|
// 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 "DescribeHostReservations"; }
|
|
|
|
Aws::String SerializePayload() const override;
|
|
|
|
protected:
|
|
void DumpBodyToUrl(Aws::Http::URI& uri ) const override;
|
|
|
|
public:
|
|
|
|
/**
|
|
* <p>The filters.</p> <ul> <li> <p> <code>instance-family</code> - The instance
|
|
* family (for example, <code>m4</code>).</p> </li> <li> <p>
|
|
* <code>payment-option</code> - The payment option (<code>NoUpfront</code> |
|
|
* <code>PartialUpfront</code> | <code>AllUpfront</code>).</p> </li> <li> <p>
|
|
* <code>state</code> - The state of the reservation (<code>payment-pending</code>
|
|
* | <code>payment-failed</code> | <code>active</code> | <code>retired</code>).</p>
|
|
* </li> <li> <p> <code>tag</code>:<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 <code>Owner</code> and the value <code>TeamA</code>, specify
|
|
* <code>tag:Owner</code> for the filter name and <code>TeamA</code> for the filter
|
|
* value.</p> </li> <li> <p> <code>tag-key</code> - 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.</p> </li> </ul>
|
|
*/
|
|
inline const Aws::Vector<Filter>& GetFilter() const{ return m_filter; }
|
|
|
|
/**
|
|
* <p>The filters.</p> <ul> <li> <p> <code>instance-family</code> - The instance
|
|
* family (for example, <code>m4</code>).</p> </li> <li> <p>
|
|
* <code>payment-option</code> - The payment option (<code>NoUpfront</code> |
|
|
* <code>PartialUpfront</code> | <code>AllUpfront</code>).</p> </li> <li> <p>
|
|
* <code>state</code> - The state of the reservation (<code>payment-pending</code>
|
|
* | <code>payment-failed</code> | <code>active</code> | <code>retired</code>).</p>
|
|
* </li> <li> <p> <code>tag</code>:<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 <code>Owner</code> and the value <code>TeamA</code>, specify
|
|
* <code>tag:Owner</code> for the filter name and <code>TeamA</code> for the filter
|
|
* value.</p> </li> <li> <p> <code>tag-key</code> - 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.</p> </li> </ul>
|
|
*/
|
|
inline bool FilterHasBeenSet() const { return m_filterHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The filters.</p> <ul> <li> <p> <code>instance-family</code> - The instance
|
|
* family (for example, <code>m4</code>).</p> </li> <li> <p>
|
|
* <code>payment-option</code> - The payment option (<code>NoUpfront</code> |
|
|
* <code>PartialUpfront</code> | <code>AllUpfront</code>).</p> </li> <li> <p>
|
|
* <code>state</code> - The state of the reservation (<code>payment-pending</code>
|
|
* | <code>payment-failed</code> | <code>active</code> | <code>retired</code>).</p>
|
|
* </li> <li> <p> <code>tag</code>:<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 <code>Owner</code> and the value <code>TeamA</code>, specify
|
|
* <code>tag:Owner</code> for the filter name and <code>TeamA</code> for the filter
|
|
* value.</p> </li> <li> <p> <code>tag-key</code> - 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.</p> </li> </ul>
|
|
*/
|
|
inline void SetFilter(const Aws::Vector<Filter>& value) { m_filterHasBeenSet = true; m_filter = value; }
|
|
|
|
/**
|
|
* <p>The filters.</p> <ul> <li> <p> <code>instance-family</code> - The instance
|
|
* family (for example, <code>m4</code>).</p> </li> <li> <p>
|
|
* <code>payment-option</code> - The payment option (<code>NoUpfront</code> |
|
|
* <code>PartialUpfront</code> | <code>AllUpfront</code>).</p> </li> <li> <p>
|
|
* <code>state</code> - The state of the reservation (<code>payment-pending</code>
|
|
* | <code>payment-failed</code> | <code>active</code> | <code>retired</code>).</p>
|
|
* </li> <li> <p> <code>tag</code>:<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 <code>Owner</code> and the value <code>TeamA</code>, specify
|
|
* <code>tag:Owner</code> for the filter name and <code>TeamA</code> for the filter
|
|
* value.</p> </li> <li> <p> <code>tag-key</code> - 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.</p> </li> </ul>
|
|
*/
|
|
inline void SetFilter(Aws::Vector<Filter>&& value) { m_filterHasBeenSet = true; m_filter = std::move(value); }
|
|
|
|
/**
|
|
* <p>The filters.</p> <ul> <li> <p> <code>instance-family</code> - The instance
|
|
* family (for example, <code>m4</code>).</p> </li> <li> <p>
|
|
* <code>payment-option</code> - The payment option (<code>NoUpfront</code> |
|
|
* <code>PartialUpfront</code> | <code>AllUpfront</code>).</p> </li> <li> <p>
|
|
* <code>state</code> - The state of the reservation (<code>payment-pending</code>
|
|
* | <code>payment-failed</code> | <code>active</code> | <code>retired</code>).</p>
|
|
* </li> <li> <p> <code>tag</code>:<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 <code>Owner</code> and the value <code>TeamA</code>, specify
|
|
* <code>tag:Owner</code> for the filter name and <code>TeamA</code> for the filter
|
|
* value.</p> </li> <li> <p> <code>tag-key</code> - 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.</p> </li> </ul>
|
|
*/
|
|
inline DescribeHostReservationsRequest& WithFilter(const Aws::Vector<Filter>& value) { SetFilter(value); return *this;}
|
|
|
|
/**
|
|
* <p>The filters.</p> <ul> <li> <p> <code>instance-family</code> - The instance
|
|
* family (for example, <code>m4</code>).</p> </li> <li> <p>
|
|
* <code>payment-option</code> - The payment option (<code>NoUpfront</code> |
|
|
* <code>PartialUpfront</code> | <code>AllUpfront</code>).</p> </li> <li> <p>
|
|
* <code>state</code> - The state of the reservation (<code>payment-pending</code>
|
|
* | <code>payment-failed</code> | <code>active</code> | <code>retired</code>).</p>
|
|
* </li> <li> <p> <code>tag</code>:<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 <code>Owner</code> and the value <code>TeamA</code>, specify
|
|
* <code>tag:Owner</code> for the filter name and <code>TeamA</code> for the filter
|
|
* value.</p> </li> <li> <p> <code>tag-key</code> - 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.</p> </li> </ul>
|
|
*/
|
|
inline DescribeHostReservationsRequest& WithFilter(Aws::Vector<Filter>&& value) { SetFilter(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>The filters.</p> <ul> <li> <p> <code>instance-family</code> - The instance
|
|
* family (for example, <code>m4</code>).</p> </li> <li> <p>
|
|
* <code>payment-option</code> - The payment option (<code>NoUpfront</code> |
|
|
* <code>PartialUpfront</code> | <code>AllUpfront</code>).</p> </li> <li> <p>
|
|
* <code>state</code> - The state of the reservation (<code>payment-pending</code>
|
|
* | <code>payment-failed</code> | <code>active</code> | <code>retired</code>).</p>
|
|
* </li> <li> <p> <code>tag</code>:<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 <code>Owner</code> and the value <code>TeamA</code>, specify
|
|
* <code>tag:Owner</code> for the filter name and <code>TeamA</code> for the filter
|
|
* value.</p> </li> <li> <p> <code>tag-key</code> - 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.</p> </li> </ul>
|
|
*/
|
|
inline DescribeHostReservationsRequest& AddFilter(const Filter& value) { m_filterHasBeenSet = true; m_filter.push_back(value); return *this; }
|
|
|
|
/**
|
|
* <p>The filters.</p> <ul> <li> <p> <code>instance-family</code> - The instance
|
|
* family (for example, <code>m4</code>).</p> </li> <li> <p>
|
|
* <code>payment-option</code> - The payment option (<code>NoUpfront</code> |
|
|
* <code>PartialUpfront</code> | <code>AllUpfront</code>).</p> </li> <li> <p>
|
|
* <code>state</code> - The state of the reservation (<code>payment-pending</code>
|
|
* | <code>payment-failed</code> | <code>active</code> | <code>retired</code>).</p>
|
|
* </li> <li> <p> <code>tag</code>:<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 <code>Owner</code> and the value <code>TeamA</code>, specify
|
|
* <code>tag:Owner</code> for the filter name and <code>TeamA</code> for the filter
|
|
* value.</p> </li> <li> <p> <code>tag-key</code> - 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.</p> </li> </ul>
|
|
*/
|
|
inline DescribeHostReservationsRequest& AddFilter(Filter&& value) { m_filterHasBeenSet = true; m_filter.push_back(std::move(value)); return *this; }
|
|
|
|
|
|
/**
|
|
* <p>The host reservation IDs.</p>
|
|
*/
|
|
inline const Aws::Vector<Aws::String>& GetHostReservationIdSet() const{ return m_hostReservationIdSet; }
|
|
|
|
/**
|
|
* <p>The host reservation IDs.</p>
|
|
*/
|
|
inline bool HostReservationIdSetHasBeenSet() const { return m_hostReservationIdSetHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The host reservation IDs.</p>
|
|
*/
|
|
inline void SetHostReservationIdSet(const Aws::Vector<Aws::String>& value) { m_hostReservationIdSetHasBeenSet = true; m_hostReservationIdSet = value; }
|
|
|
|
/**
|
|
* <p>The host reservation IDs.</p>
|
|
*/
|
|
inline void SetHostReservationIdSet(Aws::Vector<Aws::String>&& value) { m_hostReservationIdSetHasBeenSet = true; m_hostReservationIdSet = std::move(value); }
|
|
|
|
/**
|
|
* <p>The host reservation IDs.</p>
|
|
*/
|
|
inline DescribeHostReservationsRequest& WithHostReservationIdSet(const Aws::Vector<Aws::String>& value) { SetHostReservationIdSet(value); return *this;}
|
|
|
|
/**
|
|
* <p>The host reservation IDs.</p>
|
|
*/
|
|
inline DescribeHostReservationsRequest& WithHostReservationIdSet(Aws::Vector<Aws::String>&& value) { SetHostReservationIdSet(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>The host reservation IDs.</p>
|
|
*/
|
|
inline DescribeHostReservationsRequest& AddHostReservationIdSet(const Aws::String& value) { m_hostReservationIdSetHasBeenSet = true; m_hostReservationIdSet.push_back(value); return *this; }
|
|
|
|
/**
|
|
* <p>The host reservation IDs.</p>
|
|
*/
|
|
inline DescribeHostReservationsRequest& AddHostReservationIdSet(Aws::String&& value) { m_hostReservationIdSetHasBeenSet = true; m_hostReservationIdSet.push_back(std::move(value)); return *this; }
|
|
|
|
/**
|
|
* <p>The host reservation IDs.</p>
|
|
*/
|
|
inline DescribeHostReservationsRequest& AddHostReservationIdSet(const char* value) { m_hostReservationIdSetHasBeenSet = true; m_hostReservationIdSet.push_back(value); return *this; }
|
|
|
|
|
|
/**
|
|
* <p>The maximum number of results to return for the request in a single page. The
|
|
* remaining results can be seen by sending another request with the returned
|
|
* <code>nextToken</code> value. This value can be between 5 and 500. If
|
|
* <code>maxResults</code> is given a larger value than 500, you receive an
|
|
* error.</p>
|
|
*/
|
|
inline int GetMaxResults() const{ return m_maxResults; }
|
|
|
|
/**
|
|
* <p>The maximum number of results to return for the request in a single page. The
|
|
* remaining results can be seen by sending another request with the returned
|
|
* <code>nextToken</code> value. This value can be between 5 and 500. If
|
|
* <code>maxResults</code> is given a larger value than 500, you receive an
|
|
* error.</p>
|
|
*/
|
|
inline bool MaxResultsHasBeenSet() const { return m_maxResultsHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The maximum number of results to return for the request in a single page. The
|
|
* remaining results can be seen by sending another request with the returned
|
|
* <code>nextToken</code> value. This value can be between 5 and 500. If
|
|
* <code>maxResults</code> is given a larger value than 500, you receive an
|
|
* error.</p>
|
|
*/
|
|
inline void SetMaxResults(int value) { m_maxResultsHasBeenSet = true; m_maxResults = value; }
|
|
|
|
/**
|
|
* <p>The maximum number of results to return for the request in a single page. The
|
|
* remaining results can be seen by sending another request with the returned
|
|
* <code>nextToken</code> value. This value can be between 5 and 500. If
|
|
* <code>maxResults</code> is given a larger value than 500, you receive an
|
|
* error.</p>
|
|
*/
|
|
inline DescribeHostReservationsRequest& WithMaxResults(int value) { SetMaxResults(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>The token to use to retrieve the next page of results.</p>
|
|
*/
|
|
inline const Aws::String& GetNextToken() const{ return m_nextToken; }
|
|
|
|
/**
|
|
* <p>The token to use to retrieve the next page of results.</p>
|
|
*/
|
|
inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The token to use to retrieve the next page of results.</p>
|
|
*/
|
|
inline void SetNextToken(const Aws::String& value) { m_nextTokenHasBeenSet = true; m_nextToken = value; }
|
|
|
|
/**
|
|
* <p>The token to use to retrieve the next page of results.</p>
|
|
*/
|
|
inline void SetNextToken(Aws::String&& value) { m_nextTokenHasBeenSet = true; m_nextToken = std::move(value); }
|
|
|
|
/**
|
|
* <p>The token to use to retrieve the next page of results.</p>
|
|
*/
|
|
inline void SetNextToken(const char* value) { m_nextTokenHasBeenSet = true; m_nextToken.assign(value); }
|
|
|
|
/**
|
|
* <p>The token to use to retrieve the next page of results.</p>
|
|
*/
|
|
inline DescribeHostReservationsRequest& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;}
|
|
|
|
/**
|
|
* <p>The token to use to retrieve the next page of results.</p>
|
|
*/
|
|
inline DescribeHostReservationsRequest& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>The token to use to retrieve the next page of results.</p>
|
|
*/
|
|
inline DescribeHostReservationsRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;}
|
|
|
|
private:
|
|
|
|
Aws::Vector<Filter> m_filter;
|
|
bool m_filterHasBeenSet;
|
|
|
|
Aws::Vector<Aws::String> m_hostReservationIdSet;
|
|
bool m_hostReservationIdSetHasBeenSet;
|
|
|
|
int m_maxResults;
|
|
bool m_maxResultsHasBeenSet;
|
|
|
|
Aws::String m_nextToken;
|
|
bool m_nextTokenHasBeenSet;
|
|
};
|
|
|
|
} // namespace Model
|
|
} // namespace EC2
|
|
} // namespace Aws
|