AWSEC2DescribeSnapshotsRequest
Objective-C
@interface AWSEC2DescribeSnapshotsRequest
Swift
class AWSEC2DescribeSnapshotsRequest
-
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 isUnauthorizedOperation
.Declaration
Objective-C
@property (nonatomic, strong) NSNumber *_Nullable dryRun;
Swift
var dryRun: NSNumber? { get set }
-
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 keyOwner
and the valueTeamA
, specifytag:Owner
for the filter name andTeamA
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.
Declaration
Objective-C
@property (nonatomic, strong) NSArray<AWSEC2Filter *> *_Nullable filters;
Swift
var filters: [AWSEC2Filter]? { get set }
-
The maximum number of snapshot results returned by
DescribeSnapshots
in paginated output. When this parameter is used,DescribeSnapshots
only returnsMaxResults
results in a single page along with aNextToken
response element. The remaining results of the initial request can be seen by sending anotherDescribeSnapshots
request with the returnedNextToken
value. This value can be between 5 and 1,000; ifMaxResults
is given a value larger than 1,000, only 1,000 results are returned. If this parameter is not used, thenDescribeSnapshots
returns all results. You cannot specify this parameter and the snapshot IDs parameter in the same request.Declaration
Objective-C
@property (nonatomic, strong) NSNumber *_Nullable maxResults;
Swift
var maxResults: NSNumber? { get set }
-
The
NextToken
value returned from a previous paginatedDescribeSnapshots
request whereMaxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned theNextToken
value. This value isnull
when there are no more results to return.Declaration
Objective-C
@property (nonatomic, strong) NSString *_Nullable nextToken;
Swift
var nextToken: String? { get set }
-
Scopes the results to snapshots with the specified owners. You can specify a combination of AWS account IDs,
self
, andamazon
.Declaration
Objective-C
@property (nonatomic, strong) NSArray<NSString *> *_Nullable ownerIds;
Swift
var ownerIds: [String]? { get set }
-
The IDs of the AWS accounts that can create volumes from the snapshot.
Declaration
Objective-C
@property (nonatomic, strong) NSArray<NSString *> *_Nullable restorableByUserIds;
Swift
var restorableByUserIds: [String]? { get set }
-
The snapshot IDs.
Default: Describes the snapshots for which you have create volume permissions.
Declaration
Objective-C
@property (nonatomic, strong) NSArray<NSString *> *_Nullable snapshotIds;
Swift
var snapshotIds: [String]? { get set }