/** * 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 namespace Aws { namespace EC2 { namespace Model { /** *

Contains the parameters for DescribeScheduledInstances.

See * Also:

AWS * API Reference

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

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 DescribeScheduledInstancesRequest& WithDryRun(bool value) { SetDryRun(value); return *this;} /** *

The filters.

  • availability-zone - The * Availability Zone (for example, us-west-2a).

  • * instance-type - The instance type (for example, * c4.large).

  • platform - The platform * (Linux/UNIX or Windows).

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

The filters.

  • availability-zone - The * Availability Zone (for example, us-west-2a).

  • * instance-type - The instance type (for example, * c4.large).

  • platform - The platform * (Linux/UNIX or Windows).

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

The filters.

  • availability-zone - The * Availability Zone (for example, us-west-2a).

  • * instance-type - The instance type (for example, * c4.large).

  • platform - The platform * (Linux/UNIX or Windows).

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

The filters.

  • availability-zone - The * Availability Zone (for example, us-west-2a).

  • * instance-type - The instance type (for example, * c4.large).

  • platform - The platform * (Linux/UNIX or Windows).

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

The filters.

  • availability-zone - The * Availability Zone (for example, us-west-2a).

  • * instance-type - The instance type (for example, * c4.large).

  • platform - The platform * (Linux/UNIX or Windows).

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

The filters.

  • availability-zone - The * Availability Zone (for example, us-west-2a).

  • * instance-type - The instance type (for example, * c4.large).

  • platform - The platform * (Linux/UNIX or Windows).

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

The filters.

  • availability-zone - The * Availability Zone (for example, us-west-2a).

  • * instance-type - The instance type (for example, * c4.large).

  • platform - The platform * (Linux/UNIX or Windows).

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

The filters.

  • availability-zone - The * Availability Zone (for example, us-west-2a).

  • * instance-type - The instance type (for example, * c4.large).

  • platform - The platform * (Linux/UNIX or Windows).

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

The maximum number of results to return in a single call. This value can be * between 5 and 300. The default value is 100. To retrieve the remaining results, * make another call with the returned NextToken value.

*/ inline int GetMaxResults() const{ return m_maxResults; } /** *

The maximum number of results to return in a single call. This value can be * between 5 and 300. The default value is 100. To retrieve the remaining results, * make another call with the returned NextToken value.

*/ inline bool MaxResultsHasBeenSet() const { return m_maxResultsHasBeenSet; } /** *

The maximum number of results to return in a single call. This value can be * between 5 and 300. The default value is 100. To retrieve the remaining results, * make another call with the returned NextToken value.

*/ inline void SetMaxResults(int value) { m_maxResultsHasBeenSet = true; m_maxResults = value; } /** *

The maximum number of results to return in a single call. This value can be * between 5 and 300. The default value is 100. To retrieve the remaining results, * make another call with the returned NextToken value.

*/ inline DescribeScheduledInstancesRequest& WithMaxResults(int value) { SetMaxResults(value); return *this;} /** *

The token for the next set of results.

*/ inline const Aws::String& GetNextToken() const{ return m_nextToken; } /** *

The token for the next set of results.

*/ inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; } /** *

The token for the next set of results.

*/ inline void SetNextToken(const Aws::String& value) { m_nextTokenHasBeenSet = true; m_nextToken = value; } /** *

The token for the next set of results.

*/ inline void SetNextToken(Aws::String&& value) { m_nextTokenHasBeenSet = true; m_nextToken = std::move(value); } /** *

The token for the next set of results.

*/ inline void SetNextToken(const char* value) { m_nextTokenHasBeenSet = true; m_nextToken.assign(value); } /** *

The token for the next set of results.

*/ inline DescribeScheduledInstancesRequest& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;} /** *

The token for the next set of results.

*/ inline DescribeScheduledInstancesRequest& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;} /** *

The token for the next set of results.

*/ inline DescribeScheduledInstancesRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;} /** *

The Scheduled Instance IDs.

*/ inline const Aws::Vector& GetScheduledInstanceIds() const{ return m_scheduledInstanceIds; } /** *

The Scheduled Instance IDs.

*/ inline bool ScheduledInstanceIdsHasBeenSet() const { return m_scheduledInstanceIdsHasBeenSet; } /** *

The Scheduled Instance IDs.

*/ inline void SetScheduledInstanceIds(const Aws::Vector& value) { m_scheduledInstanceIdsHasBeenSet = true; m_scheduledInstanceIds = value; } /** *

The Scheduled Instance IDs.

*/ inline void SetScheduledInstanceIds(Aws::Vector&& value) { m_scheduledInstanceIdsHasBeenSet = true; m_scheduledInstanceIds = std::move(value); } /** *

The Scheduled Instance IDs.

*/ inline DescribeScheduledInstancesRequest& WithScheduledInstanceIds(const Aws::Vector& value) { SetScheduledInstanceIds(value); return *this;} /** *

The Scheduled Instance IDs.

*/ inline DescribeScheduledInstancesRequest& WithScheduledInstanceIds(Aws::Vector&& value) { SetScheduledInstanceIds(std::move(value)); return *this;} /** *

The Scheduled Instance IDs.

*/ inline DescribeScheduledInstancesRequest& AddScheduledInstanceIds(const Aws::String& value) { m_scheduledInstanceIdsHasBeenSet = true; m_scheduledInstanceIds.push_back(value); return *this; } /** *

The Scheduled Instance IDs.

*/ inline DescribeScheduledInstancesRequest& AddScheduledInstanceIds(Aws::String&& value) { m_scheduledInstanceIdsHasBeenSet = true; m_scheduledInstanceIds.push_back(std::move(value)); return *this; } /** *

The Scheduled Instance IDs.

*/ inline DescribeScheduledInstancesRequest& AddScheduledInstanceIds(const char* value) { m_scheduledInstanceIdsHasBeenSet = true; m_scheduledInstanceIds.push_back(value); return *this; } /** *

The time period for the first schedule to start.

*/ inline const SlotStartTimeRangeRequest& GetSlotStartTimeRange() const{ return m_slotStartTimeRange; } /** *

The time period for the first schedule to start.

*/ inline bool SlotStartTimeRangeHasBeenSet() const { return m_slotStartTimeRangeHasBeenSet; } /** *

The time period for the first schedule to start.

*/ inline void SetSlotStartTimeRange(const SlotStartTimeRangeRequest& value) { m_slotStartTimeRangeHasBeenSet = true; m_slotStartTimeRange = value; } /** *

The time period for the first schedule to start.

*/ inline void SetSlotStartTimeRange(SlotStartTimeRangeRequest&& value) { m_slotStartTimeRangeHasBeenSet = true; m_slotStartTimeRange = std::move(value); } /** *

The time period for the first schedule to start.

*/ inline DescribeScheduledInstancesRequest& WithSlotStartTimeRange(const SlotStartTimeRangeRequest& value) { SetSlotStartTimeRange(value); return *this;} /** *

The time period for the first schedule to start.

*/ inline DescribeScheduledInstancesRequest& WithSlotStartTimeRange(SlotStartTimeRangeRequest&& value) { SetSlotStartTimeRange(std::move(value)); return *this;} private: bool m_dryRun; bool m_dryRunHasBeenSet = false; Aws::Vector m_filters; bool m_filtersHasBeenSet = false; int m_maxResults; bool m_maxResultsHasBeenSet = false; Aws::String m_nextToken; bool m_nextTokenHasBeenSet = false; Aws::Vector m_scheduledInstanceIds; bool m_scheduledInstanceIdsHasBeenSet = false; SlotStartTimeRangeRequest m_slotStartTimeRange; bool m_slotStartTimeRangeHasBeenSet = false; }; } // namespace Model } // namespace EC2 } // namespace Aws