AWS SDK for C++  1.9.108
AWS SDK for C++
DescribeSnapshotsRequest.h
Go to the documentation of this file.
1 
6 #pragma once
7 #include <aws/ec2/EC2_EXPORTS.h>
8 #include <aws/ec2/EC2Request.h>
11 #include <aws/ec2/model/Filter.h>
12 #include <utility>
13 
14 namespace Aws
15 {
16 namespace EC2
17 {
18 namespace Model
19 {
20 
24  {
25  public:
27 
28  // Service request name is the Operation name which will send this request out,
29  // each operation should has unique request name, so that we can get operation's name from this request.
30  // Note: this is not true for response, multiple operations may have the same response name,
31  // so we can not get operation's name from response.
32  inline virtual const char* GetServiceRequestName() const override { return "DescribeSnapshots"; }
33 
34  Aws::String SerializePayload() const override;
35 
36  protected:
37  void DumpBodyToUrl(Aws::Http::URI& uri ) const override;
38 
39  public:
40 
68  inline const Aws::Vector<Filter>& GetFilters() const{ return m_filters; }
69 
97  inline bool FiltersHasBeenSet() const { return m_filtersHasBeenSet; }
98 
126  inline void SetFilters(const Aws::Vector<Filter>& value) { m_filtersHasBeenSet = true; m_filters = value; }
127 
155  inline void SetFilters(Aws::Vector<Filter>&& value) { m_filtersHasBeenSet = true; m_filters = std::move(value); }
156 
184  inline DescribeSnapshotsRequest& WithFilters(const Aws::Vector<Filter>& value) { SetFilters(value); return *this;}
185 
213  inline DescribeSnapshotsRequest& WithFilters(Aws::Vector<Filter>&& value) { SetFilters(std::move(value)); return *this;}
214 
242  inline DescribeSnapshotsRequest& AddFilters(const Filter& value) { m_filtersHasBeenSet = true; m_filters.push_back(value); return *this; }
243 
271  inline DescribeSnapshotsRequest& AddFilters(Filter&& value) { m_filtersHasBeenSet = true; m_filters.push_back(std::move(value)); return *this; }
272 
273 
287  inline int GetMaxResults() const{ return m_maxResults; }
288 
302  inline bool MaxResultsHasBeenSet() const { return m_maxResultsHasBeenSet; }
303 
317  inline void SetMaxResults(int value) { m_maxResultsHasBeenSet = true; m_maxResults = value; }
318 
332  inline DescribeSnapshotsRequest& WithMaxResults(int value) { SetMaxResults(value); return *this;}
333 
334 
342  inline const Aws::String& GetNextToken() const{ return m_nextToken; }
343 
351  inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; }
352 
360  inline void SetNextToken(const Aws::String& value) { m_nextTokenHasBeenSet = true; m_nextToken = value; }
361 
369  inline void SetNextToken(Aws::String&& value) { m_nextTokenHasBeenSet = true; m_nextToken = std::move(value); }
370 
378  inline void SetNextToken(const char* value) { m_nextTokenHasBeenSet = true; m_nextToken.assign(value); }
379 
387  inline DescribeSnapshotsRequest& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;}
388 
396  inline DescribeSnapshotsRequest& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;}
397 
405  inline DescribeSnapshotsRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;}
406 
407 
413  inline const Aws::Vector<Aws::String>& GetOwnerIds() const{ return m_ownerIds; }
414 
420  inline bool OwnerIdsHasBeenSet() const { return m_ownerIdsHasBeenSet; }
421 
427  inline void SetOwnerIds(const Aws::Vector<Aws::String>& value) { m_ownerIdsHasBeenSet = true; m_ownerIds = value; }
428 
434  inline void SetOwnerIds(Aws::Vector<Aws::String>&& value) { m_ownerIdsHasBeenSet = true; m_ownerIds = std::move(value); }
435 
441  inline DescribeSnapshotsRequest& WithOwnerIds(const Aws::Vector<Aws::String>& value) { SetOwnerIds(value); return *this;}
442 
448  inline DescribeSnapshotsRequest& WithOwnerIds(Aws::Vector<Aws::String>&& value) { SetOwnerIds(std::move(value)); return *this;}
449 
455  inline DescribeSnapshotsRequest& AddOwnerIds(const Aws::String& value) { m_ownerIdsHasBeenSet = true; m_ownerIds.push_back(value); return *this; }
456 
462  inline DescribeSnapshotsRequest& AddOwnerIds(Aws::String&& value) { m_ownerIdsHasBeenSet = true; m_ownerIds.push_back(std::move(value)); return *this; }
463 
469  inline DescribeSnapshotsRequest& AddOwnerIds(const char* value) { m_ownerIdsHasBeenSet = true; m_ownerIds.push_back(value); return *this; }
470 
471 
476  inline const Aws::Vector<Aws::String>& GetRestorableByUserIds() const{ return m_restorableByUserIds; }
477 
482  inline bool RestorableByUserIdsHasBeenSet() const { return m_restorableByUserIdsHasBeenSet; }
483 
488  inline void SetRestorableByUserIds(const Aws::Vector<Aws::String>& value) { m_restorableByUserIdsHasBeenSet = true; m_restorableByUserIds = value; }
489 
494  inline void SetRestorableByUserIds(Aws::Vector<Aws::String>&& value) { m_restorableByUserIdsHasBeenSet = true; m_restorableByUserIds = std::move(value); }
495 
500  inline DescribeSnapshotsRequest& WithRestorableByUserIds(const Aws::Vector<Aws::String>& value) { SetRestorableByUserIds(value); return *this;}
501 
506  inline DescribeSnapshotsRequest& WithRestorableByUserIds(Aws::Vector<Aws::String>&& value) { SetRestorableByUserIds(std::move(value)); return *this;}
507 
512  inline DescribeSnapshotsRequest& AddRestorableByUserIds(const Aws::String& value) { m_restorableByUserIdsHasBeenSet = true; m_restorableByUserIds.push_back(value); return *this; }
513 
518  inline DescribeSnapshotsRequest& AddRestorableByUserIds(Aws::String&& value) { m_restorableByUserIdsHasBeenSet = true; m_restorableByUserIds.push_back(std::move(value)); return *this; }
519 
524  inline DescribeSnapshotsRequest& AddRestorableByUserIds(const char* value) { m_restorableByUserIdsHasBeenSet = true; m_restorableByUserIds.push_back(value); return *this; }
525 
526 
531  inline const Aws::Vector<Aws::String>& GetSnapshotIds() const{ return m_snapshotIds; }
532 
537  inline bool SnapshotIdsHasBeenSet() const { return m_snapshotIdsHasBeenSet; }
538 
543  inline void SetSnapshotIds(const Aws::Vector<Aws::String>& value) { m_snapshotIdsHasBeenSet = true; m_snapshotIds = value; }
544 
549  inline void SetSnapshotIds(Aws::Vector<Aws::String>&& value) { m_snapshotIdsHasBeenSet = true; m_snapshotIds = std::move(value); }
550 
555  inline DescribeSnapshotsRequest& WithSnapshotIds(const Aws::Vector<Aws::String>& value) { SetSnapshotIds(value); return *this;}
556 
561  inline DescribeSnapshotsRequest& WithSnapshotIds(Aws::Vector<Aws::String>&& value) { SetSnapshotIds(std::move(value)); return *this;}
562 
567  inline DescribeSnapshotsRequest& AddSnapshotIds(const Aws::String& value) { m_snapshotIdsHasBeenSet = true; m_snapshotIds.push_back(value); return *this; }
568 
573  inline DescribeSnapshotsRequest& AddSnapshotIds(Aws::String&& value) { m_snapshotIdsHasBeenSet = true; m_snapshotIds.push_back(std::move(value)); return *this; }
574 
579  inline DescribeSnapshotsRequest& AddSnapshotIds(const char* value) { m_snapshotIdsHasBeenSet = true; m_snapshotIds.push_back(value); return *this; }
580 
581 
588  inline bool GetDryRun() const{ return m_dryRun; }
589 
596  inline bool DryRunHasBeenSet() const { return m_dryRunHasBeenSet; }
597 
604  inline void SetDryRun(bool value) { m_dryRunHasBeenSet = true; m_dryRun = value; }
605 
612  inline DescribeSnapshotsRequest& WithDryRun(bool value) { SetDryRun(value); return *this;}
613 
614  private:
615 
616  Aws::Vector<Filter> m_filters;
617  bool m_filtersHasBeenSet;
618 
619  int m_maxResults;
620  bool m_maxResultsHasBeenSet;
621 
622  Aws::String m_nextToken;
623  bool m_nextTokenHasBeenSet;
624 
625  Aws::Vector<Aws::String> m_ownerIds;
626  bool m_ownerIdsHasBeenSet;
627 
628  Aws::Vector<Aws::String> m_restorableByUserIds;
629  bool m_restorableByUserIdsHasBeenSet;
630 
631  Aws::Vector<Aws::String> m_snapshotIds;
632  bool m_snapshotIdsHasBeenSet;
633 
634  bool m_dryRun;
635  bool m_dryRunHasBeenSet;
636  };
637 
638 } // namespace Model
639 } // namespace EC2
640 } // namespace Aws
Aws::EC2::Model::DescribeSnapshotsRequest::WithNextToken
DescribeSnapshotsRequest & WithNextToken(const char *value)
Definition: DescribeSnapshotsRequest.h:405
Aws::EC2::Model::DescribeSnapshotsRequest::WithFilters
DescribeSnapshotsRequest & WithFilters(const Aws::Vector< Filter > &value)
Definition: DescribeSnapshotsRequest.h:184
Aws::EC2::Model::DescribeSnapshotsRequest::AddRestorableByUserIds
DescribeSnapshotsRequest & AddRestorableByUserIds(const char *value)
Definition: DescribeSnapshotsRequest.h:524
Aws::Http::URI
Definition: URI.h:32
Aws::EC2::Model::DescribeSnapshotsRequest::SetFilters
void SetFilters(Aws::Vector< Filter > &&value)
Definition: DescribeSnapshotsRequest.h:155
Aws::EC2::Model::DescribeSnapshotsRequest::SetNextToken
void SetNextToken(const char *value)
Definition: DescribeSnapshotsRequest.h:378
Aws::EC2::Model::DescribeSnapshotsRequest::SetRestorableByUserIds
void SetRestorableByUserIds(const Aws::Vector< Aws::String > &value)
Definition: DescribeSnapshotsRequest.h:488
Aws::EC2::Model::DescribeSnapshotsRequest::GetOwnerIds
const Aws::Vector< Aws::String > & GetOwnerIds() const
Definition: DescribeSnapshotsRequest.h:413
Aws::EC2::Model::DescribeSnapshotsRequest::GetNextToken
const Aws::String & GetNextToken() const
Definition: DescribeSnapshotsRequest.h:342
Aws::EC2::Model::DescribeSnapshotsRequest::WithSnapshotIds
DescribeSnapshotsRequest & WithSnapshotIds(const Aws::Vector< Aws::String > &value)
Definition: DescribeSnapshotsRequest.h:555
Aws::EC2::Model::DescribeSnapshotsRequest::DescribeSnapshotsRequest
DescribeSnapshotsRequest()
Aws::EC2::Model::DescribeSnapshotsRequest::SetSnapshotIds
void SetSnapshotIds(Aws::Vector< Aws::String > &&value)
Definition: DescribeSnapshotsRequest.h:549
Aws::EC2::Model::DescribeSnapshotsRequest::AddSnapshotIds
DescribeSnapshotsRequest & AddSnapshotIds(Aws::String &&value)
Definition: DescribeSnapshotsRequest.h:573
Aws::EC2::Model::DescribeSnapshotsRequest::SetOwnerIds
void SetOwnerIds(Aws::Vector< Aws::String > &&value)
Definition: DescribeSnapshotsRequest.h:434
Aws::EC2::Model::DescribeSnapshotsRequest::AddFilters
DescribeSnapshotsRequest & AddFilters(const Filter &value)
Definition: DescribeSnapshotsRequest.h:242
AWS_EC2_API
#define AWS_EC2_API
Definition: EC2_EXPORTS.h:28
Aws::EC2::Model::DescribeSnapshotsRequest::AddRestorableByUserIds
DescribeSnapshotsRequest & AddRestorableByUserIds(const Aws::String &value)
Definition: DescribeSnapshotsRequest.h:512
Aws::EC2::Model::DescribeSnapshotsRequest::AddOwnerIds
DescribeSnapshotsRequest & AddOwnerIds(Aws::String &&value)
Definition: DescribeSnapshotsRequest.h:462
Aws::EC2::Model::Filter
Definition: Filter.h:36
Aws::EC2::Model::DescribeSnapshotsRequest::SetFilters
void SetFilters(const Aws::Vector< Filter > &value)
Definition: DescribeSnapshotsRequest.h:126
Aws::Vector
std::vector< T, Aws::Allocator< T > > Vector
Definition: AWSVector.h:17
Aws::EC2::Model::DescribeSnapshotsRequest::WithOwnerIds
DescribeSnapshotsRequest & WithOwnerIds(const Aws::Vector< Aws::String > &value)
Definition: DescribeSnapshotsRequest.h:441
Aws::EC2::Model::DescribeSnapshotsRequest::WithMaxResults
DescribeSnapshotsRequest & WithMaxResults(int value)
Definition: DescribeSnapshotsRequest.h:332
Aws::EC2::Model::DescribeSnapshotsRequest::SetRestorableByUserIds
void SetRestorableByUserIds(Aws::Vector< Aws::String > &&value)
Definition: DescribeSnapshotsRequest.h:494
Aws::EC2::Model::DescribeSnapshotsRequest::WithDryRun
DescribeSnapshotsRequest & WithDryRun(bool value)
Definition: DescribeSnapshotsRequest.h:612
AWSVector.h
Filter.h
Aws::EC2::Model::DescribeSnapshotsRequest::WithOwnerIds
DescribeSnapshotsRequest & WithOwnerIds(Aws::Vector< Aws::String > &&value)
Definition: DescribeSnapshotsRequest.h:448
Aws::EC2::Model::DescribeSnapshotsRequest::WithRestorableByUserIds
DescribeSnapshotsRequest & WithRestorableByUserIds(const Aws::Vector< Aws::String > &value)
Definition: DescribeSnapshotsRequest.h:500
Aws::EC2::Model::DescribeSnapshotsRequest::GetServiceRequestName
virtual const char * GetServiceRequestName() const override
Definition: DescribeSnapshotsRequest.h:32
Aws::EC2::Model::DescribeSnapshotsRequest::GetSnapshotIds
const Aws::Vector< Aws::String > & GetSnapshotIds() const
Definition: DescribeSnapshotsRequest.h:531
Aws::EC2::Model::DescribeSnapshotsRequest
Definition: DescribeSnapshotsRequest.h:24
Aws::EC2::Model::DescribeSnapshotsRequest::WithSnapshotIds
DescribeSnapshotsRequest & WithSnapshotIds(Aws::Vector< Aws::String > &&value)
Definition: DescribeSnapshotsRequest.h:561
Aws::EC2::Model::DescribeSnapshotsRequest::WithFilters
DescribeSnapshotsRequest & WithFilters(Aws::Vector< Filter > &&value)
Definition: DescribeSnapshotsRequest.h:213
Aws::EC2::Model::DescribeSnapshotsRequest::MaxResultsHasBeenSet
bool MaxResultsHasBeenSet() const
Definition: DescribeSnapshotsRequest.h:302
Aws::EC2::Model::DescribeSnapshotsRequest::SetMaxResults
void SetMaxResults(int value)
Definition: DescribeSnapshotsRequest.h:317
Aws::EC2::Model::DescribeSnapshotsRequest::AddRestorableByUserIds
DescribeSnapshotsRequest & AddRestorableByUserIds(Aws::String &&value)
Definition: DescribeSnapshotsRequest.h:518
Aws::EC2::Model::DescribeSnapshotsRequest::GetFilters
const Aws::Vector< Filter > & GetFilters() const
Definition: DescribeSnapshotsRequest.h:68
EC2Request.h
Aws::EC2::Model::DescribeSnapshotsRequest::GetMaxResults
int GetMaxResults() const
Definition: DescribeSnapshotsRequest.h:287
Aws::EC2::Model::DescribeSnapshotsRequest::AddOwnerIds
DescribeSnapshotsRequest & AddOwnerIds(const char *value)
Definition: DescribeSnapshotsRequest.h:469
AWSString.h
Aws::EC2::Model::DescribeSnapshotsRequest::WithNextToken
DescribeSnapshotsRequest & WithNextToken(Aws::String &&value)
Definition: DescribeSnapshotsRequest.h:396
Aws::EC2::Model::DescribeSnapshotsRequest::SerializePayload
Aws::String SerializePayload() const override
Aws::EC2::Model::DescribeSnapshotsRequest::SetSnapshotIds
void SetSnapshotIds(const Aws::Vector< Aws::String > &value)
Definition: DescribeSnapshotsRequest.h:543
Aws::EC2::Model::DescribeSnapshotsRequest::WithNextToken
DescribeSnapshotsRequest & WithNextToken(const Aws::String &value)
Definition: DescribeSnapshotsRequest.h:387
Aws::EC2::Model::DescribeSnapshotsRequest::SetNextToken
void SetNextToken(const Aws::String &value)
Definition: DescribeSnapshotsRequest.h:360
Aws::EC2::Model::DescribeSnapshotsRequest::GetRestorableByUserIds
const Aws::Vector< Aws::String > & GetRestorableByUserIds() const
Definition: DescribeSnapshotsRequest.h:476
Aws::EC2::Model::DescribeSnapshotsRequest::DryRunHasBeenSet
bool DryRunHasBeenSet() const
Definition: DescribeSnapshotsRequest.h:596
Aws::EC2::Model::DescribeSnapshotsRequest::AddSnapshotIds
DescribeSnapshotsRequest & AddSnapshotIds(const char *value)
Definition: DescribeSnapshotsRequest.h:579
Aws
Definition: AccessManagementClient.h:15
Aws::EC2::Model::DescribeSnapshotsRequest::AddOwnerIds
DescribeSnapshotsRequest & AddOwnerIds(const Aws::String &value)
Definition: DescribeSnapshotsRequest.h:455
Aws::EC2::Model::DescribeSnapshotsRequest::OwnerIdsHasBeenSet
bool OwnerIdsHasBeenSet() const
Definition: DescribeSnapshotsRequest.h:420
Aws::String
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
Definition: AWSString.h:97
Aws::EC2::Model::DescribeSnapshotsRequest::AddFilters
DescribeSnapshotsRequest & AddFilters(Filter &&value)
Definition: DescribeSnapshotsRequest.h:271
Aws::EC2::Model::DescribeSnapshotsRequest::WithRestorableByUserIds
DescribeSnapshotsRequest & WithRestorableByUserIds(Aws::Vector< Aws::String > &&value)
Definition: DescribeSnapshotsRequest.h:506
Aws::EC2::EC2Request
Definition: EC2Request.h:17
Aws::EC2::Model::DescribeSnapshotsRequest::NextTokenHasBeenSet
bool NextTokenHasBeenSet() const
Definition: DescribeSnapshotsRequest.h:351
Aws::EC2::Model::DescribeSnapshotsRequest::FiltersHasBeenSet
bool FiltersHasBeenSet() const
Definition: DescribeSnapshotsRequest.h:97
Aws::EC2::Model::DescribeSnapshotsRequest::AddSnapshotIds
DescribeSnapshotsRequest & AddSnapshotIds(const Aws::String &value)
Definition: DescribeSnapshotsRequest.h:567
Aws::EC2::Model::DescribeSnapshotsRequest::SetOwnerIds
void SetOwnerIds(const Aws::Vector< Aws::String > &value)
Definition: DescribeSnapshotsRequest.h:427
Aws::EC2::Model::DescribeSnapshotsRequest::SetDryRun
void SetDryRun(bool value)
Definition: DescribeSnapshotsRequest.h:604
EC2_EXPORTS.h
Aws::EC2::Model::DescribeSnapshotsRequest::DumpBodyToUrl
void DumpBodyToUrl(Aws::Http::URI &uri) const override
Aws::EC2::Model::DescribeSnapshotsRequest::GetDryRun
bool GetDryRun() const
Definition: DescribeSnapshotsRequest.h:588
Aws::EC2::Model::DescribeSnapshotsRequest::RestorableByUserIdsHasBeenSet
bool RestorableByUserIdsHasBeenSet() const
Definition: DescribeSnapshotsRequest.h:482
Aws::EC2::Model::DescribeSnapshotsRequest::SnapshotIdsHasBeenSet
bool SnapshotIdsHasBeenSet() const
Definition: DescribeSnapshotsRequest.h:537
Aws::EC2::Model::DescribeSnapshotsRequest::SetNextToken
void SetNextToken(Aws::String &&value)
Definition: DescribeSnapshotsRequest.h:369