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

The filters.

  • attachment.attach-time - The time * stamp when the attachment initiated.

  • * attachment.delete-on-termination - Whether the volume is deleted on * instance termination.

  • attachment.device - The * device name specified in the block device mapping (for example, * /dev/sda1).

  • attachment.instance-id * - The ID of the instance the volume is attached to.

  • * attachment.status - The attachment state (attaching | * attached | detaching).

  • * availability-zone - The Availability Zone in which the volume was * created.

  • create-time - The time stamp when the * volume was created.

  • encrypted - Indicates * whether the volume is encrypted (true | false)

    *
  • multi-attach-enabled - Indicates whether the volume * is enabled for Multi-Attach (true | false)

  • *
  • fast-restored - Indicates whether the volume was created * from a snapshot that is enabled for fast snapshot restore (true | * false).

  • size - The size of the * volume, in GiB.

  • snapshot-id - The snapshot from * which the volume was created.

  • status - The state * of the volume (creating | available | * in-use | deleting | deleted | * error).

  • 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.

    *
  • volume-id - The volume ID.

  • * volume-type - The Amazon EBS volume type (gp2 | * gp3 | io1 | io2 | st1 | * sc1| standard)

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

The filters.

  • attachment.attach-time - The time * stamp when the attachment initiated.

  • * attachment.delete-on-termination - Whether the volume is deleted on * instance termination.

  • attachment.device - The * device name specified in the block device mapping (for example, * /dev/sda1).

  • attachment.instance-id * - The ID of the instance the volume is attached to.

  • * attachment.status - The attachment state (attaching | * attached | detaching).

  • * availability-zone - The Availability Zone in which the volume was * created.

  • create-time - The time stamp when the * volume was created.

  • encrypted - Indicates * whether the volume is encrypted (true | false)

    *
  • multi-attach-enabled - Indicates whether the volume * is enabled for Multi-Attach (true | false)

  • *
  • fast-restored - Indicates whether the volume was created * from a snapshot that is enabled for fast snapshot restore (true | * false).

  • size - The size of the * volume, in GiB.

  • snapshot-id - The snapshot from * which the volume was created.

  • status - The state * of the volume (creating | available | * in-use | deleting | deleted | * error).

  • 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.

    *
  • volume-id - The volume ID.

  • * volume-type - The Amazon EBS volume type (gp2 | * gp3 | io1 | io2 | st1 | * sc1| standard)

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

The filters.

  • attachment.attach-time - The time * stamp when the attachment initiated.

  • * attachment.delete-on-termination - Whether the volume is deleted on * instance termination.

  • attachment.device - The * device name specified in the block device mapping (for example, * /dev/sda1).

  • attachment.instance-id * - The ID of the instance the volume is attached to.

  • * attachment.status - The attachment state (attaching | * attached | detaching).

  • * availability-zone - The Availability Zone in which the volume was * created.

  • create-time - The time stamp when the * volume was created.

  • encrypted - Indicates * whether the volume is encrypted (true | false)

    *
  • multi-attach-enabled - Indicates whether the volume * is enabled for Multi-Attach (true | false)

  • *
  • fast-restored - Indicates whether the volume was created * from a snapshot that is enabled for fast snapshot restore (true | * false).

  • size - The size of the * volume, in GiB.

  • snapshot-id - The snapshot from * which the volume was created.

  • status - The state * of the volume (creating | available | * in-use | deleting | deleted | * error).

  • 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.

    *
  • volume-id - The volume ID.

  • * volume-type - The Amazon EBS volume type (gp2 | * gp3 | io1 | io2 | st1 | * sc1| standard)

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

The filters.

  • attachment.attach-time - The time * stamp when the attachment initiated.

  • * attachment.delete-on-termination - Whether the volume is deleted on * instance termination.

  • attachment.device - The * device name specified in the block device mapping (for example, * /dev/sda1).

  • attachment.instance-id * - The ID of the instance the volume is attached to.

  • * attachment.status - The attachment state (attaching | * attached | detaching).

  • * availability-zone - The Availability Zone in which the volume was * created.

  • create-time - The time stamp when the * volume was created.

  • encrypted - Indicates * whether the volume is encrypted (true | false)

    *
  • multi-attach-enabled - Indicates whether the volume * is enabled for Multi-Attach (true | false)

  • *
  • fast-restored - Indicates whether the volume was created * from a snapshot that is enabled for fast snapshot restore (true | * false).

  • size - The size of the * volume, in GiB.

  • snapshot-id - The snapshot from * which the volume was created.

  • status - The state * of the volume (creating | available | * in-use | deleting | deleted | * error).

  • 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.

    *
  • volume-id - The volume ID.

  • * volume-type - The Amazon EBS volume type (gp2 | * gp3 | io1 | io2 | st1 | * sc1| standard)

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

The filters.

  • attachment.attach-time - The time * stamp when the attachment initiated.

  • * attachment.delete-on-termination - Whether the volume is deleted on * instance termination.

  • attachment.device - The * device name specified in the block device mapping (for example, * /dev/sda1).

  • attachment.instance-id * - The ID of the instance the volume is attached to.

  • * attachment.status - The attachment state (attaching | * attached | detaching).

  • * availability-zone - The Availability Zone in which the volume was * created.

  • create-time - The time stamp when the * volume was created.

  • encrypted - Indicates * whether the volume is encrypted (true | false)

    *
  • multi-attach-enabled - Indicates whether the volume * is enabled for Multi-Attach (true | false)

  • *
  • fast-restored - Indicates whether the volume was created * from a snapshot that is enabled for fast snapshot restore (true | * false).

  • size - The size of the * volume, in GiB.

  • snapshot-id - The snapshot from * which the volume was created.

  • status - The state * of the volume (creating | available | * in-use | deleting | deleted | * error).

  • 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.

    *
  • volume-id - The volume ID.

  • * volume-type - The Amazon EBS volume type (gp2 | * gp3 | io1 | io2 | st1 | * sc1| standard)

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

The filters.

  • attachment.attach-time - The time * stamp when the attachment initiated.

  • * attachment.delete-on-termination - Whether the volume is deleted on * instance termination.

  • attachment.device - The * device name specified in the block device mapping (for example, * /dev/sda1).

  • attachment.instance-id * - The ID of the instance the volume is attached to.

  • * attachment.status - The attachment state (attaching | * attached | detaching).

  • * availability-zone - The Availability Zone in which the volume was * created.

  • create-time - The time stamp when the * volume was created.

  • encrypted - Indicates * whether the volume is encrypted (true | false)

    *
  • multi-attach-enabled - Indicates whether the volume * is enabled for Multi-Attach (true | false)

  • *
  • fast-restored - Indicates whether the volume was created * from a snapshot that is enabled for fast snapshot restore (true | * false).

  • size - The size of the * volume, in GiB.

  • snapshot-id - The snapshot from * which the volume was created.

  • status - The state * of the volume (creating | available | * in-use | deleting | deleted | * error).

  • 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.

    *
  • volume-id - The volume ID.

  • * volume-type - The Amazon EBS volume type (gp2 | * gp3 | io1 | io2 | st1 | * sc1| standard)

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

The filters.

  • attachment.attach-time - The time * stamp when the attachment initiated.

  • * attachment.delete-on-termination - Whether the volume is deleted on * instance termination.

  • attachment.device - The * device name specified in the block device mapping (for example, * /dev/sda1).

  • attachment.instance-id * - The ID of the instance the volume is attached to.

  • * attachment.status - The attachment state (attaching | * attached | detaching).

  • * availability-zone - The Availability Zone in which the volume was * created.

  • create-time - The time stamp when the * volume was created.

  • encrypted - Indicates * whether the volume is encrypted (true | false)

    *
  • multi-attach-enabled - Indicates whether the volume * is enabled for Multi-Attach (true | false)

  • *
  • fast-restored - Indicates whether the volume was created * from a snapshot that is enabled for fast snapshot restore (true | * false).

  • size - The size of the * volume, in GiB.

  • snapshot-id - The snapshot from * which the volume was created.

  • status - The state * of the volume (creating | available | * in-use | deleting | deleted | * error).

  • 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.

    *
  • volume-id - The volume ID.

  • * volume-type - The Amazon EBS volume type (gp2 | * gp3 | io1 | io2 | st1 | * sc1| standard)

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

The filters.

  • attachment.attach-time - The time * stamp when the attachment initiated.

  • * attachment.delete-on-termination - Whether the volume is deleted on * instance termination.

  • attachment.device - The * device name specified in the block device mapping (for example, * /dev/sda1).

  • attachment.instance-id * - The ID of the instance the volume is attached to.

  • * attachment.status - The attachment state (attaching | * attached | detaching).

  • * availability-zone - The Availability Zone in which the volume was * created.

  • create-time - The time stamp when the * volume was created.

  • encrypted - Indicates * whether the volume is encrypted (true | false)

    *
  • multi-attach-enabled - Indicates whether the volume * is enabled for Multi-Attach (true | false)

  • *
  • fast-restored - Indicates whether the volume was created * from a snapshot that is enabled for fast snapshot restore (true | * false).

  • size - The size of the * volume, in GiB.

  • snapshot-id - The snapshot from * which the volume was created.

  • status - The state * of the volume (creating | available | * in-use | deleting | deleted | * error).

  • 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.

    *
  • volume-id - The volume ID.

  • * volume-type - The Amazon EBS volume type (gp2 | * gp3 | io1 | io2 | st1 | * sc1| standard)

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

The volume IDs.

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

The volume IDs.

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

The volume IDs.

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

The volume IDs.

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

The volume IDs.

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

The volume IDs.

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

The volume IDs.

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

The volume IDs.

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

The volume IDs.

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

The maximum number of volume results returned by DescribeVolumes * in paginated output. When this parameter is used, DescribeVolumes * 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 DescribeVolumes request with * the returned NextToken value. This value can be between 5 and 500; * if MaxResults is given a value larger than 500, only 500 results * are returned. If this parameter is not used, then DescribeVolumes * 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 DescribeVolumes * in paginated output. When this parameter is used, DescribeVolumes * 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 DescribeVolumes request with * the returned NextToken value. This value can be between 5 and 500; * if MaxResults is given a value larger than 500, only 500 results * are returned. If this parameter is not used, then DescribeVolumes * 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 DescribeVolumes * in paginated output. When this parameter is used, DescribeVolumes * 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 DescribeVolumes request with * the returned NextToken value. This value can be between 5 and 500; * if MaxResults is given a value larger than 500, only 500 results * are returned. If this parameter is not used, then DescribeVolumes * 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 DescribeVolumes * in paginated output. When this parameter is used, DescribeVolumes * 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 DescribeVolumes request with * the returned NextToken value. This value can be between 5 and 500; * if MaxResults is given a value larger than 500, only 500 results * are returned. If this parameter is not used, then DescribeVolumes * returns all results. You cannot specify this parameter and the volume IDs * parameter in the same request.

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

The NextToken value returned from a previous paginated * DescribeVolumes request where MaxResults was used and * the results exceeded the value of that parameter. Pagination continues from the * end of the previous results that returned the NextToken value. This * value is null when there are no more results to return.

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

The NextToken value returned from a previous paginated * DescribeVolumes request where MaxResults was used and * the results exceeded the value of that parameter. Pagination continues from the * end of the previous results that returned the NextToken value. This * value is null when there are no more results to return.

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

The NextToken value returned from a previous paginated * DescribeVolumes request where MaxResults was used and * the results exceeded the value of that parameter. Pagination continues from the * end of the previous results that returned the NextToken value. 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 returned from a previous paginated * DescribeVolumes request where MaxResults was used and * the results exceeded the value of that parameter. Pagination continues from the * end of the previous results that returned the NextToken value. 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 returned from a previous paginated * DescribeVolumes request where MaxResults was used and * the results exceeded the value of that parameter. Pagination continues from the * end of the previous results that returned the NextToken value. 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 returned from a previous paginated * DescribeVolumes request where MaxResults was used and * the results exceeded the value of that parameter. Pagination continues from the * end of the previous results that returned the NextToken value. This * value is null when there are no more results to return.

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

The NextToken value returned from a previous paginated * DescribeVolumes request where MaxResults was used and * the results exceeded the value of that parameter. Pagination continues from the * end of the previous results that returned the NextToken value. This * value is null when there are no more results to return.

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

The NextToken value returned from a previous paginated * DescribeVolumes request where MaxResults was used and * the results exceeded the value of that parameter. Pagination continues from the * end of the previous results that returned the NextToken value. This * value is null when there are no more results to return.

*/ inline DescribeVolumesRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;} private: Aws::Vector m_filters; bool m_filtersHasBeenSet; Aws::Vector m_volumeIds; bool m_volumeIdsHasBeenSet; bool m_dryRun; bool m_dryRunHasBeenSet; int m_maxResults; bool m_maxResultsHasBeenSet; Aws::String m_nextToken; bool m_nextTokenHasBeenSet; }; } // namespace Model } // namespace EC2 } // namespace Aws