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

#include <DescribeSnapshotsRequest.h>

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

Public Member Functions

 DescribeSnapshotsRequest ()
 
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)
 
DescribeSnapshotsRequestWithFilters (const Aws::Vector< Filter > &value)
 
DescribeSnapshotsRequestWithFilters (Aws::Vector< Filter > &&value)
 
DescribeSnapshotsRequestAddFilters (const Filter &value)
 
DescribeSnapshotsRequestAddFilters (Filter &&value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
DescribeSnapshotsRequestWithMaxResults (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)
 
DescribeSnapshotsRequestWithNextToken (const Aws::String &value)
 
DescribeSnapshotsRequestWithNextToken (Aws::String &&value)
 
DescribeSnapshotsRequestWithNextToken (const char *value)
 
const Aws::Vector< Aws::String > & GetOwnerIds () const
 
bool OwnerIdsHasBeenSet () const
 
void SetOwnerIds (const Aws::Vector< Aws::String > &value)
 
void SetOwnerIds (Aws::Vector< Aws::String > &&value)
 
DescribeSnapshotsRequestWithOwnerIds (const Aws::Vector< Aws::String > &value)
 
DescribeSnapshotsRequestWithOwnerIds (Aws::Vector< Aws::String > &&value)
 
DescribeSnapshotsRequestAddOwnerIds (const Aws::String &value)
 
DescribeSnapshotsRequestAddOwnerIds (Aws::String &&value)
 
DescribeSnapshotsRequestAddOwnerIds (const char *value)
 
const Aws::Vector< Aws::String > & GetRestorableByUserIds () const
 
bool RestorableByUserIdsHasBeenSet () const
 
void SetRestorableByUserIds (const Aws::Vector< Aws::String > &value)
 
void SetRestorableByUserIds (Aws::Vector< Aws::String > &&value)
 
DescribeSnapshotsRequestWithRestorableByUserIds (const Aws::Vector< Aws::String > &value)
 
DescribeSnapshotsRequestWithRestorableByUserIds (Aws::Vector< Aws::String > &&value)
 
DescribeSnapshotsRequestAddRestorableByUserIds (const Aws::String &value)
 
DescribeSnapshotsRequestAddRestorableByUserIds (Aws::String &&value)
 
DescribeSnapshotsRequestAddRestorableByUserIds (const char *value)
 
const Aws::Vector< Aws::String > & GetSnapshotIds () const
 
bool SnapshotIdsHasBeenSet () const
 
void SetSnapshotIds (const Aws::Vector< Aws::String > &value)
 
void SetSnapshotIds (Aws::Vector< Aws::String > &&value)
 
DescribeSnapshotsRequestWithSnapshotIds (const Aws::Vector< Aws::String > &value)
 
DescribeSnapshotsRequestWithSnapshotIds (Aws::Vector< Aws::String > &&value)
 
DescribeSnapshotsRequestAddSnapshotIds (const Aws::String &value)
 
DescribeSnapshotsRequestAddSnapshotIds (Aws::String &&value)
 
DescribeSnapshotsRequestAddSnapshotIds (const char *value)
 
bool GetDryRun () const
 
bool DryRunHasBeenSet () const
 
void SetDryRun (bool value)
 
DescribeSnapshotsRequestWithDryRun (bool 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 23 of file DescribeSnapshotsRequest.h.

Constructor & Destructor Documentation

◆ DescribeSnapshotsRequest()

Aws::EC2::Model::DescribeSnapshotsRequest::DescribeSnapshotsRequest ( )

Member Function Documentation

◆ AddFilters() [1/2]

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

The filters.

  • description - A description of the snapshot.

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

  • owner-alias - The owner alias, from an Amazon-maintained list (amazon). This is not the user-configured AWS account alias set using the IAM console. We recommend that you use the related parameter instead of this filter.

  • owner-id - The AWS account ID of the owner. We recommend that you use the related parameter instead of this filter.

  • progress - The progress of the snapshot, as a percentage (for example, 80%).

  • snapshot-id

    • The snapshot ID.

  • start-time - The time stamp when the snapshot was initiated.

  • status - The status of the snapshot (pending | completed | 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 ID of the volume the snapshot is for.

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

Definition at line 235 of file DescribeSnapshotsRequest.h.

◆ AddFilters() [2/2]

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

The filters.

  • description - A description of the snapshot.

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

  • owner-alias - The owner alias, from an Amazon-maintained list (amazon). This is not the user-configured AWS account alias set using the IAM console. We recommend that you use the related parameter instead of this filter.

  • owner-id - The AWS account ID of the owner. We recommend that you use the related parameter instead of this filter.

  • progress - The progress of the snapshot, as a percentage (for example, 80%).

  • snapshot-id

    • The snapshot ID.

  • start-time - The time stamp when the snapshot was initiated.

  • status - The status of the snapshot (pending | completed | 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 ID of the volume the snapshot is for.

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

Definition at line 263 of file DescribeSnapshotsRequest.h.

◆ AddOwnerIds() [1/3]

DescribeSnapshotsRequest& Aws::EC2::Model::DescribeSnapshotsRequest::AddOwnerIds ( const Aws::String value)
inline

Scopes the results to snapshots with the specified owners. You can specify a combination of AWS account IDs, self, and amazon.

Definition at line 436 of file DescribeSnapshotsRequest.h.

◆ AddOwnerIds() [2/3]

DescribeSnapshotsRequest& Aws::EC2::Model::DescribeSnapshotsRequest::AddOwnerIds ( Aws::String &&  value)
inline

Scopes the results to snapshots with the specified owners. You can specify a combination of AWS account IDs, self, and amazon.

Definition at line 442 of file DescribeSnapshotsRequest.h.

◆ AddOwnerIds() [3/3]

DescribeSnapshotsRequest& Aws::EC2::Model::DescribeSnapshotsRequest::AddOwnerIds ( const char *  value)
inline

Scopes the results to snapshots with the specified owners. You can specify a combination of AWS account IDs, self, and amazon.

Definition at line 448 of file DescribeSnapshotsRequest.h.

◆ AddRestorableByUserIds() [1/3]

DescribeSnapshotsRequest& Aws::EC2::Model::DescribeSnapshotsRequest::AddRestorableByUserIds ( const Aws::String value)
inline

The IDs of the AWS accounts that can create volumes from the snapshot.

Definition at line 484 of file DescribeSnapshotsRequest.h.

◆ AddRestorableByUserIds() [2/3]

DescribeSnapshotsRequest& Aws::EC2::Model::DescribeSnapshotsRequest::AddRestorableByUserIds ( Aws::String &&  value)
inline

The IDs of the AWS accounts that can create volumes from the snapshot.

Definition at line 489 of file DescribeSnapshotsRequest.h.

◆ AddRestorableByUserIds() [3/3]

DescribeSnapshotsRequest& Aws::EC2::Model::DescribeSnapshotsRequest::AddRestorableByUserIds ( const char *  value)
inline

The IDs of the AWS accounts that can create volumes from the snapshot.

Definition at line 494 of file DescribeSnapshotsRequest.h.

◆ AddSnapshotIds() [1/3]

DescribeSnapshotsRequest& Aws::EC2::Model::DescribeSnapshotsRequest::AddSnapshotIds ( const Aws::String value)
inline

The snapshot IDs.

Default: Describes the snapshots for which you have create volume permissions.

Definition at line 537 of file DescribeSnapshotsRequest.h.

◆ AddSnapshotIds() [2/3]

DescribeSnapshotsRequest& Aws::EC2::Model::DescribeSnapshotsRequest::AddSnapshotIds ( Aws::String &&  value)
inline

The snapshot IDs.

Default: Describes the snapshots for which you have create volume permissions.

Definition at line 543 of file DescribeSnapshotsRequest.h.

◆ AddSnapshotIds() [3/3]

DescribeSnapshotsRequest& Aws::EC2::Model::DescribeSnapshotsRequest::AddSnapshotIds ( const char *  value)
inline

The snapshot IDs.

Default: Describes the snapshots for which you have create volume permissions.

Definition at line 549 of file DescribeSnapshotsRequest.h.

◆ DryRunHasBeenSet()

bool Aws::EC2::Model::DescribeSnapshotsRequest::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 566 of file DescribeSnapshotsRequest.h.

◆ DumpBodyToUrl()

void Aws::EC2::Model::DescribeSnapshotsRequest::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::DescribeSnapshotsRequest::FiltersHasBeenSet ( ) const
inline

The filters.

  • description - A description of the snapshot.

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

  • owner-alias - The owner alias, from an Amazon-maintained list (amazon). This is not the user-configured AWS account alias set using the IAM console. We recommend that you use the related parameter instead of this filter.

  • owner-id - The AWS account ID of the owner. We recommend that you use the related parameter instead of this filter.

  • progress - The progress of the snapshot, as a percentage (for example, 80%).

  • snapshot-id

    • The snapshot ID.

  • start-time - The time stamp when the snapshot was initiated.

  • status - The status of the snapshot (pending | completed | 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 ID of the volume the snapshot is for.

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

Definition at line 95 of file DescribeSnapshotsRequest.h.

◆ GetDryRun()

bool Aws::EC2::Model::DescribeSnapshotsRequest::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 558 of file DescribeSnapshotsRequest.h.

◆ GetFilters()

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

The filters.

  • description - A description of the snapshot.

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

  • owner-alias - The owner alias, from an Amazon-maintained list (amazon). This is not the user-configured AWS account alias set using the IAM console. We recommend that you use the related parameter instead of this filter.

  • owner-id - The AWS account ID of the owner. We recommend that you use the related parameter instead of this filter.

  • progress - The progress of the snapshot, as a percentage (for example, 80%).

  • snapshot-id

    • The snapshot ID.

  • start-time - The time stamp when the snapshot was initiated.

  • status - The status of the snapshot (pending | completed | 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 ID of the volume the snapshot is for.

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

Definition at line 67 of file DescribeSnapshotsRequest.h.

◆ GetMaxResults()

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

The maximum number of snapshot results returned by DescribeSnapshots in paginated output. When this parameter is used, DescribeSnapshots 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 DescribeSnapshots 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 DescribeSnapshots returns all results. You cannot specify this parameter and the snapshot IDs parameter in the same request.

Definition at line 278 of file DescribeSnapshotsRequest.h.

◆ GetNextToken()

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

The NextToken value returned from a previous paginated DescribeSnapshots 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 330 of file DescribeSnapshotsRequest.h.

◆ GetOwnerIds()

const Aws::Vector<Aws::String>& Aws::EC2::Model::DescribeSnapshotsRequest::GetOwnerIds ( ) const
inline

Scopes the results to snapshots with the specified owners. You can specify a combination of AWS account IDs, self, and amazon.

Definition at line 400 of file DescribeSnapshotsRequest.h.

◆ GetRestorableByUserIds()

const Aws::Vector<Aws::String>& Aws::EC2::Model::DescribeSnapshotsRequest::GetRestorableByUserIds ( ) const
inline

The IDs of the AWS accounts that can create volumes from the snapshot.

Definition at line 454 of file DescribeSnapshotsRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 32 of file DescribeSnapshotsRequest.h.

◆ GetSnapshotIds()

const Aws::Vector<Aws::String>& Aws::EC2::Model::DescribeSnapshotsRequest::GetSnapshotIds ( ) const
inline

The snapshot IDs.

Default: Describes the snapshots for which you have create volume permissions.

Definition at line 501 of file DescribeSnapshotsRequest.h.

◆ MaxResultsHasBeenSet()

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

The maximum number of snapshot results returned by DescribeSnapshots in paginated output. When this parameter is used, DescribeSnapshots 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 DescribeSnapshots 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 DescribeSnapshots returns all results. You cannot specify this parameter and the snapshot IDs parameter in the same request.

Definition at line 292 of file DescribeSnapshotsRequest.h.

◆ NextTokenHasBeenSet()

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

The NextToken value returned from a previous paginated DescribeSnapshots 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 339 of file DescribeSnapshotsRequest.h.

◆ OwnerIdsHasBeenSet()

bool Aws::EC2::Model::DescribeSnapshotsRequest::OwnerIdsHasBeenSet ( ) const
inline

Scopes the results to snapshots with the specified owners. You can specify a combination of AWS account IDs, self, and amazon.

Definition at line 406 of file DescribeSnapshotsRequest.h.

◆ RestorableByUserIdsHasBeenSet()

bool Aws::EC2::Model::DescribeSnapshotsRequest::RestorableByUserIdsHasBeenSet ( ) const
inline

The IDs of the AWS accounts that can create volumes from the snapshot.

Definition at line 459 of file DescribeSnapshotsRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDryRun()

void Aws::EC2::Model::DescribeSnapshotsRequest::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 574 of file DescribeSnapshotsRequest.h.

◆ SetFilters() [1/2]

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

The filters.

  • description - A description of the snapshot.

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

  • owner-alias - The owner alias, from an Amazon-maintained list (amazon). This is not the user-configured AWS account alias set using the IAM console. We recommend that you use the related parameter instead of this filter.

  • owner-id - The AWS account ID of the owner. We recommend that you use the related parameter instead of this filter.

  • progress - The progress of the snapshot, as a percentage (for example, 80%).

  • snapshot-id

    • The snapshot ID.

  • start-time - The time stamp when the snapshot was initiated.

  • status - The status of the snapshot (pending | completed | 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 ID of the volume the snapshot is for.

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

Definition at line 123 of file DescribeSnapshotsRequest.h.

◆ SetFilters() [2/2]

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

The filters.

  • description - A description of the snapshot.

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

  • owner-alias - The owner alias, from an Amazon-maintained list (amazon). This is not the user-configured AWS account alias set using the IAM console. We recommend that you use the related parameter instead of this filter.

  • owner-id - The AWS account ID of the owner. We recommend that you use the related parameter instead of this filter.

  • progress - The progress of the snapshot, as a percentage (for example, 80%).

  • snapshot-id

    • The snapshot ID.

  • start-time - The time stamp when the snapshot was initiated.

  • status - The status of the snapshot (pending | completed | 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 ID of the volume the snapshot is for.

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

Definition at line 151 of file DescribeSnapshotsRequest.h.

◆ SetMaxResults()

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

The maximum number of snapshot results returned by DescribeSnapshots in paginated output. When this parameter is used, DescribeSnapshots 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 DescribeSnapshots 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 DescribeSnapshots returns all results. You cannot specify this parameter and the snapshot IDs parameter in the same request.

Definition at line 306 of file DescribeSnapshotsRequest.h.

◆ SetNextToken() [1/3]

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

The NextToken value returned from a previous paginated DescribeSnapshots 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 348 of file DescribeSnapshotsRequest.h.

◆ SetNextToken() [2/3]

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

The NextToken value returned from a previous paginated DescribeSnapshots 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 357 of file DescribeSnapshotsRequest.h.

◆ SetNextToken() [3/3]

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

The NextToken value returned from a previous paginated DescribeSnapshots 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 366 of file DescribeSnapshotsRequest.h.

◆ SetOwnerIds() [1/2]

void Aws::EC2::Model::DescribeSnapshotsRequest::SetOwnerIds ( const Aws::Vector< Aws::String > &  value)
inline

Scopes the results to snapshots with the specified owners. You can specify a combination of AWS account IDs, self, and amazon.

Definition at line 412 of file DescribeSnapshotsRequest.h.

◆ SetOwnerIds() [2/2]

void Aws::EC2::Model::DescribeSnapshotsRequest::SetOwnerIds ( Aws::Vector< Aws::String > &&  value)
inline

Scopes the results to snapshots with the specified owners. You can specify a combination of AWS account IDs, self, and amazon.

Definition at line 418 of file DescribeSnapshotsRequest.h.

◆ SetRestorableByUserIds() [1/2]

void Aws::EC2::Model::DescribeSnapshotsRequest::SetRestorableByUserIds ( const Aws::Vector< Aws::String > &  value)
inline

The IDs of the AWS accounts that can create volumes from the snapshot.

Definition at line 464 of file DescribeSnapshotsRequest.h.

◆ SetRestorableByUserIds() [2/2]

void Aws::EC2::Model::DescribeSnapshotsRequest::SetRestorableByUserIds ( Aws::Vector< Aws::String > &&  value)
inline

The IDs of the AWS accounts that can create volumes from the snapshot.

Definition at line 469 of file DescribeSnapshotsRequest.h.

◆ SetSnapshotIds() [1/2]

void Aws::EC2::Model::DescribeSnapshotsRequest::SetSnapshotIds ( const Aws::Vector< Aws::String > &  value)
inline

The snapshot IDs.

Default: Describes the snapshots for which you have create volume permissions.

Definition at line 513 of file DescribeSnapshotsRequest.h.

◆ SetSnapshotIds() [2/2]

void Aws::EC2::Model::DescribeSnapshotsRequest::SetSnapshotIds ( Aws::Vector< Aws::String > &&  value)
inline

The snapshot IDs.

Default: Describes the snapshots for which you have create volume permissions.

Definition at line 519 of file DescribeSnapshotsRequest.h.

◆ SnapshotIdsHasBeenSet()

bool Aws::EC2::Model::DescribeSnapshotsRequest::SnapshotIdsHasBeenSet ( ) const
inline

The snapshot IDs.

Default: Describes the snapshots for which you have create volume permissions.

Definition at line 507 of file DescribeSnapshotsRequest.h.

◆ WithDryRun()

DescribeSnapshotsRequest& Aws::EC2::Model::DescribeSnapshotsRequest::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 582 of file DescribeSnapshotsRequest.h.

◆ WithFilters() [1/2]

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

The filters.

  • description - A description of the snapshot.

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

  • owner-alias - The owner alias, from an Amazon-maintained list (amazon). This is not the user-configured AWS account alias set using the IAM console. We recommend that you use the related parameter instead of this filter.

  • owner-id - The AWS account ID of the owner. We recommend that you use the related parameter instead of this filter.

  • progress - The progress of the snapshot, as a percentage (for example, 80%).

  • snapshot-id

    • The snapshot ID.

  • start-time - The time stamp when the snapshot was initiated.

  • status - The status of the snapshot (pending | completed | 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 ID of the volume the snapshot is for.

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

Definition at line 179 of file DescribeSnapshotsRequest.h.

◆ WithFilters() [2/2]

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

The filters.

  • description - A description of the snapshot.

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

  • owner-alias - The owner alias, from an Amazon-maintained list (amazon). This is not the user-configured AWS account alias set using the IAM console. We recommend that you use the related parameter instead of this filter.

  • owner-id - The AWS account ID of the owner. We recommend that you use the related parameter instead of this filter.

  • progress - The progress of the snapshot, as a percentage (for example, 80%).

  • snapshot-id

    • The snapshot ID.

  • start-time - The time stamp when the snapshot was initiated.

  • status - The status of the snapshot (pending | completed | 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 ID of the volume the snapshot is for.

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

Definition at line 207 of file DescribeSnapshotsRequest.h.

◆ WithMaxResults()

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

The maximum number of snapshot results returned by DescribeSnapshots in paginated output. When this parameter is used, DescribeSnapshots 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 DescribeSnapshots 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 DescribeSnapshots returns all results. You cannot specify this parameter and the snapshot IDs parameter in the same request.

Definition at line 320 of file DescribeSnapshotsRequest.h.

◆ WithNextToken() [1/3]

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

The NextToken value returned from a previous paginated DescribeSnapshots 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 375 of file DescribeSnapshotsRequest.h.

◆ WithNextToken() [2/3]

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

The NextToken value returned from a previous paginated DescribeSnapshots 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 384 of file DescribeSnapshotsRequest.h.

◆ WithNextToken() [3/3]

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

The NextToken value returned from a previous paginated DescribeSnapshots 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 393 of file DescribeSnapshotsRequest.h.

◆ WithOwnerIds() [1/2]

DescribeSnapshotsRequest& Aws::EC2::Model::DescribeSnapshotsRequest::WithOwnerIds ( const Aws::Vector< Aws::String > &  value)
inline

Scopes the results to snapshots with the specified owners. You can specify a combination of AWS account IDs, self, and amazon.

Definition at line 424 of file DescribeSnapshotsRequest.h.

◆ WithOwnerIds() [2/2]

DescribeSnapshotsRequest& Aws::EC2::Model::DescribeSnapshotsRequest::WithOwnerIds ( Aws::Vector< Aws::String > &&  value)
inline

Scopes the results to snapshots with the specified owners. You can specify a combination of AWS account IDs, self, and amazon.

Definition at line 430 of file DescribeSnapshotsRequest.h.

◆ WithRestorableByUserIds() [1/2]

DescribeSnapshotsRequest& Aws::EC2::Model::DescribeSnapshotsRequest::WithRestorableByUserIds ( const Aws::Vector< Aws::String > &  value)
inline

The IDs of the AWS accounts that can create volumes from the snapshot.

Definition at line 474 of file DescribeSnapshotsRequest.h.

◆ WithRestorableByUserIds() [2/2]

DescribeSnapshotsRequest& Aws::EC2::Model::DescribeSnapshotsRequest::WithRestorableByUserIds ( Aws::Vector< Aws::String > &&  value)
inline

The IDs of the AWS accounts that can create volumes from the snapshot.

Definition at line 479 of file DescribeSnapshotsRequest.h.

◆ WithSnapshotIds() [1/2]

DescribeSnapshotsRequest& Aws::EC2::Model::DescribeSnapshotsRequest::WithSnapshotIds ( const Aws::Vector< Aws::String > &  value)
inline

The snapshot IDs.

Default: Describes the snapshots for which you have create volume permissions.

Definition at line 525 of file DescribeSnapshotsRequest.h.

◆ WithSnapshotIds() [2/2]

DescribeSnapshotsRequest& Aws::EC2::Model::DescribeSnapshotsRequest::WithSnapshotIds ( Aws::Vector< Aws::String > &&  value)
inline

The snapshot IDs.

Default: Describes the snapshots for which you have create volume permissions.

Definition at line 531 of file DescribeSnapshotsRequest.h.


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