AWS SDK for C++  1.7.224
AWS SDK for C++
Public Member Functions | Protected Member Functions | List of all members
Aws::EC2::Model::DescribeVolumesRequest Class Reference

#include <DescribeVolumesRequest.h>

+ Inheritance diagram for Aws::EC2::Model::DescribeVolumesRequest:

Public Member Functions

 DescribeVolumesRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::Vector< Filter > & GetFilters () const
 
bool FiltersHasBeenSet () const
 
void SetFilters (const Aws::Vector< Filter > &value)
 
void SetFilters (Aws::Vector< Filter > &&value)
 
DescribeVolumesRequestWithFilters (const Aws::Vector< Filter > &value)
 
DescribeVolumesRequestWithFilters (Aws::Vector< Filter > &&value)
 
DescribeVolumesRequestAddFilters (const Filter &value)
 
DescribeVolumesRequestAddFilters (Filter &&value)
 
const Aws::Vector< Aws::String > & GetVolumeIds () const
 
bool VolumeIdsHasBeenSet () const
 
void SetVolumeIds (const Aws::Vector< Aws::String > &value)
 
void SetVolumeIds (Aws::Vector< Aws::String > &&value)
 
DescribeVolumesRequestWithVolumeIds (const Aws::Vector< Aws::String > &value)
 
DescribeVolumesRequestWithVolumeIds (Aws::Vector< Aws::String > &&value)
 
DescribeVolumesRequestAddVolumeIds (const Aws::String &value)
 
DescribeVolumesRequestAddVolumeIds (Aws::String &&value)
 
DescribeVolumesRequestAddVolumeIds (const char *value)
 
bool GetDryRun () const
 
bool DryRunHasBeenSet () const
 
void SetDryRun (bool value)
 
DescribeVolumesRequestWithDryRun (bool value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
DescribeVolumesRequestWithMaxResults (int value)
 
const Aws::StringGetNextToken () const
 
bool NextTokenHasBeenSet () const
 
void SetNextToken (const Aws::String &value)
 
void SetNextToken (Aws::String &&value)
 
void SetNextToken (const char *value)
 
DescribeVolumesRequestWithNextToken (const Aws::String &value)
 
DescribeVolumesRequestWithNextToken (Aws::String &&value)
 
DescribeVolumesRequestWithNextToken (const char *value)
 
- Public Member Functions inherited from Aws::EC2::EC2Request
virtual ~EC2Request ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Protected Member Functions

void DumpBodyToUrl (Aws::Http::URI &uri) const override
 
- Protected Member Functions inherited from Aws::EC2::EC2Request
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 

Detailed Description

Definition at line 33 of file DescribeVolumesRequest.h.

Constructor & Destructor Documentation

◆ DescribeVolumesRequest()

Aws::EC2::Model::DescribeVolumesRequest::DescribeVolumesRequest ( )

Member Function Documentation

◆ AddFilters() [1/2]

DescribeVolumesRequest& Aws::EC2::Model::DescribeVolumesRequest::AddFilters ( const Filter value)
inline

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)

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

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

  • status - The status 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. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.

Definition at line 294 of file DescribeVolumesRequest.h.

◆ AddFilters() [2/2]

DescribeVolumesRequest& Aws::EC2::Model::DescribeVolumesRequest::AddFilters ( Filter &&  value)
inline

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)

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

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

  • status - The status 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. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.

Definition at line 329 of file DescribeVolumesRequest.h.

◆ AddVolumeIds() [1/3]

DescribeVolumesRequest& Aws::EC2::Model::DescribeVolumesRequest::AddVolumeIds ( const Aws::String value)
inline

The volume IDs.

Definition at line 365 of file DescribeVolumesRequest.h.

◆ AddVolumeIds() [2/3]

DescribeVolumesRequest& Aws::EC2::Model::DescribeVolumesRequest::AddVolumeIds ( Aws::String &&  value)
inline

The volume IDs.

Definition at line 370 of file DescribeVolumesRequest.h.

◆ AddVolumeIds() [3/3]

DescribeVolumesRequest& Aws::EC2::Model::DescribeVolumesRequest::AddVolumeIds ( const char *  value)
inline

The volume IDs.

Definition at line 375 of file DescribeVolumesRequest.h.

◆ DryRunHasBeenSet()

bool Aws::EC2::Model::DescribeVolumesRequest::DryRunHasBeenSet ( ) const
inline

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.

Definition at line 392 of file DescribeVolumesRequest.h.

◆ DumpBodyToUrl()

void Aws::EC2::Model::DescribeVolumesRequest::DumpBodyToUrl ( Aws::Http::URI uri) const
overrideprotectedvirtual

Default does nothing. Override this to convert what would otherwise be the payload of the request to a query string format.

Reimplemented from Aws::AmazonWebServiceRequest.

◆ FiltersHasBeenSet()

bool Aws::EC2::Model::DescribeVolumesRequest::FiltersHasBeenSet ( ) const
inline

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)

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

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

  • status - The status 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. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.

Definition at line 119 of file DescribeVolumesRequest.h.

◆ GetDryRun()

bool Aws::EC2::Model::DescribeVolumesRequest::GetDryRun ( ) const
inline

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.

Definition at line 384 of file DescribeVolumesRequest.h.

◆ GetFilters()

const Aws::Vector<Filter>& Aws::EC2::Model::DescribeVolumesRequest::GetFilters ( ) const
inline

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)

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

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

  • status - The status 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. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.

Definition at line 84 of file DescribeVolumesRequest.h.

◆ GetMaxResults()

int Aws::EC2::Model::DescribeVolumesRequest::GetMaxResults ( ) const
inline

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.

Definition at line 423 of file DescribeVolumesRequest.h.

◆ GetNextToken()

const Aws::String& Aws::EC2::Model::DescribeVolumesRequest::GetNextToken ( ) const
inline

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.

Definition at line 475 of file DescribeVolumesRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::EC2::Model::DescribeVolumesRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 42 of file DescribeVolumesRequest.h.

◆ GetVolumeIds()

const Aws::Vector<Aws::String>& Aws::EC2::Model::DescribeVolumesRequest::GetVolumeIds ( ) const
inline

The volume IDs.

Definition at line 335 of file DescribeVolumesRequest.h.

◆ MaxResultsHasBeenSet()

bool Aws::EC2::Model::DescribeVolumesRequest::MaxResultsHasBeenSet ( ) const
inline

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.

Definition at line 437 of file DescribeVolumesRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::EC2::Model::DescribeVolumesRequest::NextTokenHasBeenSet ( ) const
inline

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.

Definition at line 484 of file DescribeVolumesRequest.h.

◆ SerializePayload()

Aws::String Aws::EC2::Model::DescribeVolumesRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDryRun()

void Aws::EC2::Model::DescribeVolumesRequest::SetDryRun ( bool  value)
inline

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.

Definition at line 400 of file DescribeVolumesRequest.h.

◆ SetFilters() [1/2]

void Aws::EC2::Model::DescribeVolumesRequest::SetFilters ( const Aws::Vector< Filter > &  value)
inline

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)

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

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

  • status - The status 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. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.

Definition at line 154 of file DescribeVolumesRequest.h.

◆ SetFilters() [2/2]

void Aws::EC2::Model::DescribeVolumesRequest::SetFilters ( Aws::Vector< Filter > &&  value)
inline

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)

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

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

  • status - The status 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. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.

Definition at line 189 of file DescribeVolumesRequest.h.

◆ SetMaxResults()

void Aws::EC2::Model::DescribeVolumesRequest::SetMaxResults ( int  value)
inline

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.

Definition at line 451 of file DescribeVolumesRequest.h.

◆ SetNextToken() [1/3]

void Aws::EC2::Model::DescribeVolumesRequest::SetNextToken ( const Aws::String value)
inline

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.

Definition at line 493 of file DescribeVolumesRequest.h.

◆ SetNextToken() [2/3]

void Aws::EC2::Model::DescribeVolumesRequest::SetNextToken ( Aws::String &&  value)
inline

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.

Definition at line 502 of file DescribeVolumesRequest.h.

◆ SetNextToken() [3/3]

void Aws::EC2::Model::DescribeVolumesRequest::SetNextToken ( const char *  value)
inline

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.

Definition at line 511 of file DescribeVolumesRequest.h.

◆ SetVolumeIds() [1/2]

void Aws::EC2::Model::DescribeVolumesRequest::SetVolumeIds ( const Aws::Vector< Aws::String > &  value)
inline

The volume IDs.

Definition at line 345 of file DescribeVolumesRequest.h.

◆ SetVolumeIds() [2/2]

void Aws::EC2::Model::DescribeVolumesRequest::SetVolumeIds ( Aws::Vector< Aws::String > &&  value)
inline

The volume IDs.

Definition at line 350 of file DescribeVolumesRequest.h.

◆ VolumeIdsHasBeenSet()

bool Aws::EC2::Model::DescribeVolumesRequest::VolumeIdsHasBeenSet ( ) const
inline

The volume IDs.

Definition at line 340 of file DescribeVolumesRequest.h.

◆ WithDryRun()

DescribeVolumesRequest& Aws::EC2::Model::DescribeVolumesRequest::WithDryRun ( bool  value)
inline

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.

Definition at line 408 of file DescribeVolumesRequest.h.

◆ WithFilters() [1/2]

DescribeVolumesRequest& Aws::EC2::Model::DescribeVolumesRequest::WithFilters ( const Aws::Vector< Filter > &  value)
inline

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)

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

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

  • status - The status 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. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.

Definition at line 224 of file DescribeVolumesRequest.h.

◆ WithFilters() [2/2]

DescribeVolumesRequest& Aws::EC2::Model::DescribeVolumesRequest::WithFilters ( Aws::Vector< Filter > &&  value)
inline

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)

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

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

  • status - The status 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. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.

Definition at line 259 of file DescribeVolumesRequest.h.

◆ WithMaxResults()

DescribeVolumesRequest& Aws::EC2::Model::DescribeVolumesRequest::WithMaxResults ( int  value)
inline

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.

Definition at line 465 of file DescribeVolumesRequest.h.

◆ WithNextToken() [1/3]

DescribeVolumesRequest& Aws::EC2::Model::DescribeVolumesRequest::WithNextToken ( const Aws::String value)
inline

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.

Definition at line 520 of file DescribeVolumesRequest.h.

◆ WithNextToken() [2/3]

DescribeVolumesRequest& Aws::EC2::Model::DescribeVolumesRequest::WithNextToken ( Aws::String &&  value)
inline

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.

Definition at line 529 of file DescribeVolumesRequest.h.

◆ WithNextToken() [3/3]

DescribeVolumesRequest& Aws::EC2::Model::DescribeVolumesRequest::WithNextToken ( const char *  value)
inline

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.

Definition at line 538 of file DescribeVolumesRequest.h.

◆ WithVolumeIds() [1/2]

DescribeVolumesRequest& Aws::EC2::Model::DescribeVolumesRequest::WithVolumeIds ( const Aws::Vector< Aws::String > &  value)
inline

The volume IDs.

Definition at line 355 of file DescribeVolumesRequest.h.

◆ WithVolumeIds() [2/2]

DescribeVolumesRequest& Aws::EC2::Model::DescribeVolumesRequest::WithVolumeIds ( Aws::Vector< Aws::String > &&  value)
inline

The volume IDs.

Definition at line 360 of file DescribeVolumesRequest.h.


The documentation for this class was generated from the following file: