Network.AWS.EC2.DescribeSnapshots

Describes one or more of the EBS snapshots available to you. Available snapshots include public snapshots available for any AWS account to launch, private snapshots that you own, and private snapshots owned by another AWS account but for which you've been given explicit create volume permissions.

The create volume permissions fall into the following categories:

• public : The owner of the snapshot granted create volume permissions for the snapshot to the all group. All AWS accounts have create volume permissions for these snapshots.
• explicit : The owner of the snapshot granted create volume permissions to a specific AWS account.
• implicit : An AWS account has implicit create volume permissions for all snapshots it owns.

The list of snapshots returned can be modified by specifying snapshot IDs, snapshot owners, or AWS accounts with create volume permissions. If no options are specified, Amazon EC2 returns all snapshots for which you have create volume permissions.

If you specify one or more snapshot IDs, only snapshots that have the specified IDs are returned. If you specify an invalid snapshot ID, an error is returned. If you specify a snapshot ID for which you do not have access, it is not included in the returned results.

If you specify one or more snapshot owners using the OwnerIds option, only snapshots from the specified owners and for which you have access are returned. The results can include the AWS account IDs of the specified owners, amazon for snapshots owned by Amazon, or self for snapshots that you own.

If you specify a list of restorable users, only snapshots with create snapshot permissions for those users are returned. You can specify AWS account IDs (if you own the snapshots), self for snapshots for which you own or have explicit permissions, or all for public snapshots.

If you are describing a long list of snapshots, you can paginate the output to make the list more manageable. The MaxResults parameter sets the maximum number of results returned in a single page. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeSnapshots request to retrieve the remaining results.

For more information about EBS snapshots, see Amazon EBS Snapshots in the Amazon Elastic Compute Cloud User Guide .

This operation returns paginated results.

Creating a Request

describeSnapshots :: DescribeSnapshots

Creates a value of DescribeSnapshots with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dssOwnerIds - Returns the snapshots owned by the specified owner. Multiple owners can be specified.
• dssFilters - One or more filters. * description - A description of the snapshot. * owner-alias - Value from an Amazon-maintained list (amazon | aws-marketplace | microsoft ) of snapshot owners. Not to be confused with the user-configured AWS account alias, which is set from the IAM console. * owner-id - The ID of the AWS account that owns the snapshot. * 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 =value - The keyvalue combination of a tag assigned to the resource. Specify the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag Purpose=X, specify tag:Purpose for the filter name and X for the filter value. * tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag :key =value/ filter. * tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter. * volume-id - The ID of the volume the snapshot is for. * volume-size - The size of the volume, in GiB.
• dssNextToken - 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.
• dssSnapshotIds - One or more snapshot IDs. Default: Describes snapshots for which you have launch permissions.
• dssRestorableByUserIds - One or more AWS accounts IDs that can create volumes from the snapshot.
• dssDryRun - 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 .
• dssMaxResults - 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.

data DescribeSnapshots

Contains the parameters for DescribeSnapshots.

See: describeSnapshots smart constructor.

Instances

Eq DescribeSnapshots

Defined in Network.AWS.EC2.DescribeSnapshots

Methods

(==) :: DescribeSnapshots -> DescribeSnapshots -> Bool

(/=) :: DescribeSnapshots -> DescribeSnapshots -> Bool

Data DescribeSnapshots

Defined in Network.AWS.EC2.DescribeSnapshots

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeSnapshots -> c DescribeSnapshots

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeSnapshots

toConstr :: DescribeSnapshots -> Constr

dataTypeOf :: DescribeSnapshots -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DescribeSnapshots)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeSnapshots)

gmapT :: (forall b. Data b => b -> b) -> DescribeSnapshots -> DescribeSnapshots

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeSnapshots -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeSnapshots -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeSnapshots -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeSnapshots -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeSnapshots -> m DescribeSnapshots

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeSnapshots -> m DescribeSnapshots

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeSnapshots -> m DescribeSnapshots

Read DescribeSnapshots

Defined in Network.AWS.EC2.DescribeSnapshots

Methods

readsPrec :: Int -> ReadS DescribeSnapshots

readList :: ReadS [DescribeSnapshots]

readPrec :: ReadPrec DescribeSnapshots

readListPrec :: ReadPrec [DescribeSnapshots]

Show DescribeSnapshots

Defined in Network.AWS.EC2.DescribeSnapshots

Methods

showsPrec :: Int -> DescribeSnapshots -> ShowS

show :: DescribeSnapshots -> String

showList :: [DescribeSnapshots] -> ShowS

Generic DescribeSnapshots

Defined in Network.AWS.EC2.DescribeSnapshots

Associated Types

type Rep DescribeSnapshots :: Type -> Type

Methods

from :: DescribeSnapshots -> Rep DescribeSnapshots x

to :: Rep DescribeSnapshots x -> DescribeSnapshots

Hashable DescribeSnapshots

Defined in Network.AWS.EC2.DescribeSnapshots

Methods

hashWithSalt :: Int -> DescribeSnapshots -> Int

hash :: DescribeSnapshots -> Int

AWSPager DescribeSnapshots

Defined in Network.AWS.EC2.DescribeSnapshots

Methods

page :: DescribeSnapshots -> Rs DescribeSnapshots -> Maybe DescribeSnapshots

AWSRequest DescribeSnapshots

Defined in Network.AWS.EC2.DescribeSnapshots

Associated Types

type Rs DescribeSnapshots :: Type

Methods

request :: DescribeSnapshots -> Request DescribeSnapshots

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy DescribeSnapshots -> ClientResponse -> m (Response DescribeSnapshots)

ToHeaders DescribeSnapshots

Defined in Network.AWS.EC2.DescribeSnapshots

Methods

toHeaders :: DescribeSnapshots -> [Header]

ToPath DescribeSnapshots

Defined in Network.AWS.EC2.DescribeSnapshots

Methods

toPath :: DescribeSnapshots -> ByteString

ToQuery DescribeSnapshots

Defined in Network.AWS.EC2.DescribeSnapshots

Methods

toQuery :: DescribeSnapshots -> QueryString

NFData DescribeSnapshots

Defined in Network.AWS.EC2.DescribeSnapshots

Methods

rnf :: DescribeSnapshots -> ()

type Rep DescribeSnapshots

Defined in Network.AWS.EC2.DescribeSnapshots

type Rep DescribeSnapshots = D1 (MetaData "DescribeSnapshots" "Network.AWS.EC2.DescribeSnapshots" "amazonka-ec2-1.6.1-GgG1M0FWcBrE5I5IM2QktE" False) (C1 (MetaCons "DescribeSnapshots'" PrefixI True) ((S1 (MetaSel (Just "_dssOwnerIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 (MetaSel (Just "_dssFilters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Filter])) :*: S1 (MetaSel (Just "_dssNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 (MetaSel (Just "_dssSnapshotIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 (MetaSel (Just "_dssRestorableByUserIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 (MetaSel (Just "_dssDryRun") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 (MetaSel (Just "_dssMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int))))))

type Rs DescribeSnapshots

Defined in Network.AWS.EC2.DescribeSnapshots

type Rs DescribeSnapshots = DescribeSnapshotsResponse

Request Lenses

dssOwnerIds :: Lens' DescribeSnapshots [Text]

Returns the snapshots owned by the specified owner. Multiple owners can be specified.

dssFilters :: Lens' DescribeSnapshots [Filter]

One or more filters. * description - A description of the snapshot. * owner-alias - Value from an Amazon-maintained list (amazon | aws-marketplace | microsoft ) of snapshot owners. Not to be confused with the user-configured AWS account alias, which is set from the IAM console. * owner-id - The ID of the AWS account that owns the snapshot. * 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 =value - The keyvalue combination of a tag assigned to the resource. Specify the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag Purpose=X, specify tag:Purpose for the filter name and X for the filter value. * tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag :key =value/ filter. * tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter. * volume-id - The ID of the volume the snapshot is for. * volume-size - The size of the volume, in GiB.

dssNextToken :: Lens' DescribeSnapshots (Maybe Text)

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.

dssSnapshotIds :: Lens' DescribeSnapshots [Text]

One or more snapshot IDs. Default: Describes snapshots for which you have launch permissions.

dssRestorableByUserIds :: Lens' DescribeSnapshots [Text]

One or more AWS accounts IDs that can create volumes from the snapshot.

dssDryRun :: Lens' DescribeSnapshots (Maybe Bool)

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 .

dssMaxResults :: Lens' DescribeSnapshots (Maybe Int)

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.

Destructuring the Response

describeSnapshotsResponse

Arguments

:: Int

dssrsResponseStatus

-> DescribeSnapshotsResponse

Creates a value of DescribeSnapshotsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dssrsNextToken - The NextToken value to include in a future DescribeSnapshots request. When the results of a DescribeSnapshots request exceed MaxResults , this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
• dssrsSnapshots - Information about the snapshots.
• dssrsResponseStatus - -- | The response status code.

data DescribeSnapshotsResponse

Contains the output of DescribeSnapshots.

See: describeSnapshotsResponse smart constructor.

Instances

Eq DescribeSnapshotsResponse

Defined in Network.AWS.EC2.DescribeSnapshots

Methods

(==) :: DescribeSnapshotsResponse -> DescribeSnapshotsResponse -> Bool

(/=) :: DescribeSnapshotsResponse -> DescribeSnapshotsResponse -> Bool

Data DescribeSnapshotsResponse

Defined in Network.AWS.EC2.DescribeSnapshots

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeSnapshotsResponse -> c DescribeSnapshotsResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeSnapshotsResponse

toConstr :: DescribeSnapshotsResponse -> Constr

dataTypeOf :: DescribeSnapshotsResponse -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DescribeSnapshotsResponse)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeSnapshotsResponse)

gmapT :: (forall b. Data b => b -> b) -> DescribeSnapshotsResponse -> DescribeSnapshotsResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeSnapshotsResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeSnapshotsResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeSnapshotsResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeSnapshotsResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeSnapshotsResponse -> m DescribeSnapshotsResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeSnapshotsResponse -> m DescribeSnapshotsResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeSnapshotsResponse -> m DescribeSnapshotsResponse

Read DescribeSnapshotsResponse

Defined in Network.AWS.EC2.DescribeSnapshots

Methods

readsPrec :: Int -> ReadS DescribeSnapshotsResponse

readList :: ReadS [DescribeSnapshotsResponse]

readPrec :: ReadPrec DescribeSnapshotsResponse

readListPrec :: ReadPrec [DescribeSnapshotsResponse]

Show DescribeSnapshotsResponse

Defined in Network.AWS.EC2.DescribeSnapshots

Methods

showsPrec :: Int -> DescribeSnapshotsResponse -> ShowS

show :: DescribeSnapshotsResponse -> String

showList :: [DescribeSnapshotsResponse] -> ShowS

Generic DescribeSnapshotsResponse

Defined in Network.AWS.EC2.DescribeSnapshots

Associated Types

type Rep DescribeSnapshotsResponse :: Type -> Type

Methods

from :: DescribeSnapshotsResponse -> Rep DescribeSnapshotsResponse x

to :: Rep DescribeSnapshotsResponse x -> DescribeSnapshotsResponse

NFData DescribeSnapshotsResponse

Defined in Network.AWS.EC2.DescribeSnapshots

Methods

rnf :: DescribeSnapshotsResponse -> ()

type Rep DescribeSnapshotsResponse

Defined in Network.AWS.EC2.DescribeSnapshots

type Rep DescribeSnapshotsResponse = D1 (MetaData "DescribeSnapshotsResponse" "Network.AWS.EC2.DescribeSnapshots" "amazonka-ec2-1.6.1-GgG1M0FWcBrE5I5IM2QktE" False) (C1 (MetaCons "DescribeSnapshotsResponse'" PrefixI True) (S1 (MetaSel (Just "_dssrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_dssrsSnapshots") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Snapshot])) :*: S1 (MetaSel (Just "_dssrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

dssrsNextToken :: Lens' DescribeSnapshotsResponse (Maybe Text)

The NextToken value to include in a future DescribeSnapshots request. When the results of a DescribeSnapshots request exceed MaxResults , this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

dssrsSnapshots :: Lens' DescribeSnapshotsResponse [Snapshot]

Information about the snapshots.

dssrsResponseStatus :: Lens' DescribeSnapshotsResponse Int

• - | The response status code.