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 is UnauthorizedOperation.

    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 Amazon Web Services account alias set using the IAM console. We recommend that you use the related parameter instead of this filter.

    • owner-id - The Amazon Web Services 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).

    • storage-tier - The storage tier of the snapshot (archive | standard).

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<AWSEC2Filter *> *_Nullable filters;

    Swift

    var filters: [AWSEC2Filter]? { get set }

  • The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable maxResults;

    Swift

    var maxResults: NSNumber? { get set }

  • The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

    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 Amazon Web Services account IDs, self, and amazon.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<NSString *> *_Nullable ownerIds;

    Swift

    var ownerIds: [String]? { get set }

  • The IDs of the Amazon Web Services 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 }