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

The filters.

  • action.code - The action code for * the event (for example, enable-volume-io).

  • * action.description - A description of the action.

  • *

    action.event-id - The event ID associated with the action.

    *
  • availability-zone - The Availability Zone of the * instance.

  • event.description - A description of * the event.

  • event.event-id - The event ID.

    *
  • event.event-type - The event type (for * io-enabled: passed | failed; for * io-performance: io-performance:degraded | * io-performance:severely-degraded | * io-performance:stalled).

  • * event.not-after - The latest end time for the event.

  • *

    event.not-before - The earliest start time for the event.

    *
  • volume-status.details-name - The cause for * volume-status.status (io-enabled | * io-performance).

  • * volume-status.details-status - The status of * volume-status.details-name (for io-enabled: * passed | failed; for io-performance: * normal | degraded | severely-degraded | * stalled).

  • volume-status.status - * The status of the volume (ok | impaired | * warning | insufficient-data).

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

The filters.

  • action.code - The action code for * the event (for example, enable-volume-io).

  • * action.description - A description of the action.

  • *

    action.event-id - The event ID associated with the action.

    *
  • availability-zone - The Availability Zone of the * instance.

  • event.description - A description of * the event.

  • event.event-id - The event ID.

    *
  • event.event-type - The event type (for * io-enabled: passed | failed; for * io-performance: io-performance:degraded | * io-performance:severely-degraded | * io-performance:stalled).

  • * event.not-after - The latest end time for the event.

  • *

    event.not-before - The earliest start time for the event.

    *
  • volume-status.details-name - The cause for * volume-status.status (io-enabled | * io-performance).

  • * volume-status.details-status - The status of * volume-status.details-name (for io-enabled: * passed | failed; for io-performance: * normal | degraded | severely-degraded | * stalled).

  • volume-status.status - * The status of the volume (ok | impaired | * warning | insufficient-data).

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

The filters.

  • action.code - The action code for * the event (for example, enable-volume-io).

  • * action.description - A description of the action.

  • *

    action.event-id - The event ID associated with the action.

    *
  • availability-zone - The Availability Zone of the * instance.

  • event.description - A description of * the event.

  • event.event-id - The event ID.

    *
  • event.event-type - The event type (for * io-enabled: passed | failed; for * io-performance: io-performance:degraded | * io-performance:severely-degraded | * io-performance:stalled).

  • * event.not-after - The latest end time for the event.

  • *

    event.not-before - The earliest start time for the event.

    *
  • volume-status.details-name - The cause for * volume-status.status (io-enabled | * io-performance).

  • * volume-status.details-status - The status of * volume-status.details-name (for io-enabled: * passed | failed; for io-performance: * normal | degraded | severely-degraded | * stalled).

  • volume-status.status - * The status of the volume (ok | impaired | * warning | insufficient-data).

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

The filters.

  • action.code - The action code for * the event (for example, enable-volume-io).

  • * action.description - A description of the action.

  • *

    action.event-id - The event ID associated with the action.

    *
  • availability-zone - The Availability Zone of the * instance.

  • event.description - A description of * the event.

  • event.event-id - The event ID.

    *
  • event.event-type - The event type (for * io-enabled: passed | failed; for * io-performance: io-performance:degraded | * io-performance:severely-degraded | * io-performance:stalled).

  • * event.not-after - The latest end time for the event.

  • *

    event.not-before - The earliest start time for the event.

    *
  • volume-status.details-name - The cause for * volume-status.status (io-enabled | * io-performance).

  • * volume-status.details-status - The status of * volume-status.details-name (for io-enabled: * passed | failed; for io-performance: * normal | degraded | severely-degraded | * stalled).

  • volume-status.status - * The status of the volume (ok | impaired | * warning | insufficient-data).

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

The filters.

  • action.code - The action code for * the event (for example, enable-volume-io).

  • * action.description - A description of the action.

  • *

    action.event-id - The event ID associated with the action.

    *
  • availability-zone - The Availability Zone of the * instance.

  • event.description - A description of * the event.

  • event.event-id - The event ID.

    *
  • event.event-type - The event type (for * io-enabled: passed | failed; for * io-performance: io-performance:degraded | * io-performance:severely-degraded | * io-performance:stalled).

  • * event.not-after - The latest end time for the event.

  • *

    event.not-before - The earliest start time for the event.

    *
  • volume-status.details-name - The cause for * volume-status.status (io-enabled | * io-performance).

  • * volume-status.details-status - The status of * volume-status.details-name (for io-enabled: * passed | failed; for io-performance: * normal | degraded | severely-degraded | * stalled).

  • volume-status.status - * The status of the volume (ok | impaired | * warning | insufficient-data).

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

The filters.

  • action.code - The action code for * the event (for example, enable-volume-io).

  • * action.description - A description of the action.

  • *

    action.event-id - The event ID associated with the action.

    *
  • availability-zone - The Availability Zone of the * instance.

  • event.description - A description of * the event.

  • event.event-id - The event ID.

    *
  • event.event-type - The event type (for * io-enabled: passed | failed; for * io-performance: io-performance:degraded | * io-performance:severely-degraded | * io-performance:stalled).

  • * event.not-after - The latest end time for the event.

  • *

    event.not-before - The earliest start time for the event.

    *
  • volume-status.details-name - The cause for * volume-status.status (io-enabled | * io-performance).

  • * volume-status.details-status - The status of * volume-status.details-name (for io-enabled: * passed | failed; for io-performance: * normal | degraded | severely-degraded | * stalled).

  • volume-status.status - * The status of the volume (ok | impaired | * warning | insufficient-data).

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

The filters.

  • action.code - The action code for * the event (for example, enable-volume-io).

  • * action.description - A description of the action.

  • *

    action.event-id - The event ID associated with the action.

    *
  • availability-zone - The Availability Zone of the * instance.

  • event.description - A description of * the event.

  • event.event-id - The event ID.

    *
  • event.event-type - The event type (for * io-enabled: passed | failed; for * io-performance: io-performance:degraded | * io-performance:severely-degraded | * io-performance:stalled).

  • * event.not-after - The latest end time for the event.

  • *

    event.not-before - The earliest start time for the event.

    *
  • volume-status.details-name - The cause for * volume-status.status (io-enabled | * io-performance).

  • * volume-status.details-status - The status of * volume-status.details-name (for io-enabled: * passed | failed; for io-performance: * normal | degraded | severely-degraded | * stalled).

  • volume-status.status - * The status of the volume (ok | impaired | * warning | insufficient-data).

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

The filters.

  • action.code - The action code for * the event (for example, enable-volume-io).

  • * action.description - A description of the action.

  • *

    action.event-id - The event ID associated with the action.

    *
  • availability-zone - The Availability Zone of the * instance.

  • event.description - A description of * the event.

  • event.event-id - The event ID.

    *
  • event.event-type - The event type (for * io-enabled: passed | failed; for * io-performance: io-performance:degraded | * io-performance:severely-degraded | * io-performance:stalled).

  • * event.not-after - The latest end time for the event.

  • *

    event.not-before - The earliest start time for the event.

    *
  • volume-status.details-name - The cause for * volume-status.status (io-enabled | * io-performance).

  • * volume-status.details-status - The status of * volume-status.details-name (for io-enabled: * passed | failed; for io-performance: * normal | degraded | severely-degraded | * stalled).

  • volume-status.status - * The status of the volume (ok | impaired | * warning | insufficient-data).

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

The maximum number of volume results returned by * DescribeVolumeStatus in paginated output. When this parameter is * used, the request only returns MaxResults results in a single page * along with a NextToken response element. The remaining results of * the initial request can be seen by sending another request with the returned * NextToken value. This value can be between 5 and 1000; if * MaxResults is given a value larger than 1000, only 1000 results are * returned. If this parameter is not used, then DescribeVolumeStatus * returns all results. You cannot specify this parameter and the volume IDs * parameter in the same request.

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

The maximum number of volume results returned by * DescribeVolumeStatus in paginated output. When this parameter is * used, the request only returns MaxResults results in a single page * along with a NextToken response element. The remaining results of * the initial request can be seen by sending another request with the returned * NextToken value. This value can be between 5 and 1000; if * MaxResults is given a value larger than 1000, only 1000 results are * returned. If this parameter is not used, then DescribeVolumeStatus * returns all results. You cannot specify this parameter and the volume IDs * parameter in the same request.

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

The maximum number of volume results returned by * DescribeVolumeStatus in paginated output. When this parameter is * used, the request only returns MaxResults results in a single page * along with a NextToken response element. The remaining results of * the initial request can be seen by sending another request with the returned * NextToken value. This value can be between 5 and 1000; if * MaxResults is given a value larger than 1000, only 1000 results are * returned. If this parameter is not used, then DescribeVolumeStatus * returns all results. You cannot specify this parameter and the volume IDs * parameter in the same request.

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

The maximum number of volume results returned by * DescribeVolumeStatus in paginated output. When this parameter is * used, the request only returns MaxResults results in a single page * along with a NextToken response element. The remaining results of * the initial request can be seen by sending another request with the returned * NextToken value. This value can be between 5 and 1000; if * MaxResults is given a value larger than 1000, only 1000 results are * returned. If this parameter is not used, then DescribeVolumeStatus * returns all results. You cannot specify this parameter and the volume IDs * parameter in the same request.

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

The NextToken value to include in a future * DescribeVolumeStatus request. When the results of the request * exceed MaxResults, this value can be used to retrieve the next page * of results. This value is null when there are no more results to * return.

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

The NextToken value to include in a future * DescribeVolumeStatus request. When the results of the request * exceed MaxResults, this value can be used to retrieve the next page * of results. This value is null when there are no more results to * return.

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

The NextToken value to include in a future * DescribeVolumeStatus request. When the results of the request * exceed MaxResults, this value can be used to retrieve the next page * of results. This value is null when there are no more results to * return.

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

The NextToken value to include in a future * DescribeVolumeStatus request. When the results of the request * exceed MaxResults, this value can be used to retrieve the next page * of results. This value is null when there are no more results to * return.

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

The NextToken value to include in a future * DescribeVolumeStatus request. When the results of the request * exceed MaxResults, this value can be used to retrieve the next page * of results. This value is null when there are no more results to * return.

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

The NextToken value to include in a future * DescribeVolumeStatus request. When the results of the request * exceed MaxResults, this value can be used to retrieve the next page * of results. This value is null when there are no more results to * return.

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

The NextToken value to include in a future * DescribeVolumeStatus request. When the results of the request * exceed MaxResults, this value can be used to retrieve the next page * of results. This value is null when there are no more results to * return.

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

The NextToken value to include in a future * DescribeVolumeStatus request. When the results of the request * exceed MaxResults, this value can be used to retrieve the next page * of results. This value is null when there are no more results to * return.

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

The IDs of the volumes.

Default: Describes all your volumes.

*/ inline const Aws::Vector& GetVolumeIds() const{ return m_volumeIds; } /** *

The IDs of the volumes.

Default: Describes all your volumes.

*/ inline bool VolumeIdsHasBeenSet() const { return m_volumeIdsHasBeenSet; } /** *

The IDs of the volumes.

Default: Describes all your volumes.

*/ inline void SetVolumeIds(const Aws::Vector& value) { m_volumeIdsHasBeenSet = true; m_volumeIds = value; } /** *

The IDs of the volumes.

Default: Describes all your volumes.

*/ inline void SetVolumeIds(Aws::Vector&& value) { m_volumeIdsHasBeenSet = true; m_volumeIds = std::move(value); } /** *

The IDs of the volumes.

Default: Describes all your volumes.

*/ inline DescribeVolumeStatusRequest& WithVolumeIds(const Aws::Vector& value) { SetVolumeIds(value); return *this;} /** *

The IDs of the volumes.

Default: Describes all your volumes.

*/ inline DescribeVolumeStatusRequest& WithVolumeIds(Aws::Vector&& value) { SetVolumeIds(std::move(value)); return *this;} /** *

The IDs of the volumes.

Default: Describes all your volumes.

*/ inline DescribeVolumeStatusRequest& AddVolumeIds(const Aws::String& value) { m_volumeIdsHasBeenSet = true; m_volumeIds.push_back(value); return *this; } /** *

The IDs of the volumes.

Default: Describes all your volumes.

*/ inline DescribeVolumeStatusRequest& AddVolumeIds(Aws::String&& value) { m_volumeIdsHasBeenSet = true; m_volumeIds.push_back(std::move(value)); return *this; } /** *

The IDs of the volumes.

Default: Describes all your volumes.

*/ inline DescribeVolumeStatusRequest& AddVolumeIds(const char* value) { m_volumeIdsHasBeenSet = true; m_volumeIds.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 DescribeVolumeStatusRequest& WithDryRun(bool value) { SetDryRun(value); return *this;} private: Aws::Vector m_filters; bool m_filtersHasBeenSet; int m_maxResults; bool m_maxResultsHasBeenSet; Aws::String m_nextToken; bool m_nextTokenHasBeenSet; Aws::Vector m_volumeIds; bool m_volumeIdsHasBeenSet; bool m_dryRun; bool m_dryRunHasBeenSet; }; } // namespace Model } // namespace EC2 } // namespace Aws