Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.EC2.DescribeSnapshots

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes the specified EBS snapshots available to you or all of the EBS snapshots available to you.

The snapshots available to you include public snapshots, private snapshots that you own, and private snapshots owned by other Amazon Web Services accounts for which you have 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 Amazon Web Services accounts have create volume permissions for these snapshots.
explicit: The owner of the snapshot granted create volume permissions to a specific Amazon Web Services account.
implicit: An Amazon Web Services account has implicit create volume permissions for all snapshots it owns.

The list of snapshots returned can be filtered by specifying snapshot IDs, snapshot owners, or Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services 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, we recommend that you 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.

To get the state of fast snapshot restores for a snapshot, use DescribeFastSnapshotRestores.

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

This operation returns paginated results.

Synopsis

data DescribeSnapshots = DescribeSnapshots' {
- dryRun :: Maybe Bool
- filters :: Maybe [Filter]
- maxResults :: Maybe Int
- nextToken :: Maybe Text
- ownerIds :: Maybe [Text]
- restorableByUserIds :: Maybe [Text]
- snapshotIds :: Maybe [Text]
}
newDescribeSnapshots :: DescribeSnapshots
describeSnapshots_dryRun :: Lens' DescribeSnapshots (Maybe Bool)
describeSnapshots_filters :: Lens' DescribeSnapshots (Maybe [Filter])
describeSnapshots_maxResults :: Lens' DescribeSnapshots (Maybe Int)
describeSnapshots_nextToken :: Lens' DescribeSnapshots (Maybe Text)
describeSnapshots_ownerIds :: Lens' DescribeSnapshots (Maybe [Text])
describeSnapshots_restorableByUserIds :: Lens' DescribeSnapshots (Maybe [Text])
describeSnapshots_snapshotIds :: Lens' DescribeSnapshots (Maybe [Text])
data DescribeSnapshotsResponse = DescribeSnapshotsResponse' {
- nextToken :: Maybe Text
- snapshots :: Maybe [Snapshot]
- httpStatus :: Int
}
newDescribeSnapshotsResponse :: Int -> DescribeSnapshotsResponse
describeSnapshotsResponse_nextToken :: Lens' DescribeSnapshotsResponse (Maybe Text)
describeSnapshotsResponse_snapshots :: Lens' DescribeSnapshotsResponse (Maybe [Snapshot])
describeSnapshotsResponse_httpStatus :: Lens' DescribeSnapshotsResponse Int

Creating a Request

data DescribeSnapshots Source #

See: newDescribeSnapshots smart constructor.

Constructors

DescribeSnapshots'

Fields

dryRun :: 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.
filters :: Maybe [Filter]
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.
maxResults :: 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 1,000; if MaxResults is given a value larger than 1,000, only 1,000 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.
nextToken :: 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.
ownerIds :: Maybe [Text]
Scopes the results to snapshots with the specified owners. You can specify a combination of Amazon Web Services account IDs, self, and amazon.
restorableByUserIds :: Maybe [Text]
The IDs of the Amazon Web Services accounts that can create volumes from the snapshot.
snapshotIds :: Maybe [Text]
The snapshot IDs.
Default: Describes the snapshots for which you have create volume permissions.

Instances

Instances details

ToHeaders DescribeSnapshots Source #
Instance details Defined in Amazonka.EC2.DescribeSnapshots Methods toHeaders :: DescribeSnapshots -> [Header] #
ToPath DescribeSnapshots Source #
Instance details Defined in Amazonka.EC2.DescribeSnapshots Methods toPath :: DescribeSnapshots -> ByteString #
ToQuery DescribeSnapshots Source #
Instance details Defined in Amazonka.EC2.DescribeSnapshots Methods toQuery :: DescribeSnapshots -> QueryString #
AWSPager DescribeSnapshots Source #
Instance details Defined in Amazonka.EC2.DescribeSnapshots Methods page :: DescribeSnapshots -> AWSResponse DescribeSnapshots -> Maybe DescribeSnapshots #
AWSRequest DescribeSnapshots Source #
Instance details Defined in Amazonka.EC2.DescribeSnapshots Associated Types type AWSResponse DescribeSnapshots # Methods request :: (Service -> Service) -> DescribeSnapshots -> Request DescribeSnapshots # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeSnapshots -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeSnapshots))) #
Generic DescribeSnapshots Source #
Instance details Defined in Amazonka.EC2.DescribeSnapshots Associated Types type Rep DescribeSnapshots :: Type -> Type # Methods from :: DescribeSnapshots -> Rep DescribeSnapshots x # to :: Rep DescribeSnapshots x -> DescribeSnapshots #
Read DescribeSnapshots Source #
Instance details Defined in Amazonka.EC2.DescribeSnapshots Methods readsPrec :: Int -> ReadS DescribeSnapshots # readList :: ReadS [DescribeSnapshots] # readPrec :: ReadPrec DescribeSnapshots # readListPrec :: ReadPrec [DescribeSnapshots] #
Show DescribeSnapshots Source #
Instance details Defined in Amazonka.EC2.DescribeSnapshots Methods showsPrec :: Int -> DescribeSnapshots -> ShowS # show :: DescribeSnapshots -> String # showList :: [DescribeSnapshots] -> ShowS #
NFData DescribeSnapshots Source #
Instance details Defined in Amazonka.EC2.DescribeSnapshots Methods rnf :: DescribeSnapshots -> () #
Eq DescribeSnapshots Source #
Instance details Defined in Amazonka.EC2.DescribeSnapshots Methods (==) :: DescribeSnapshots -> DescribeSnapshots -> Bool # (/=) :: DescribeSnapshots -> DescribeSnapshots -> Bool #
Hashable DescribeSnapshots Source #
Instance details Defined in Amazonka.EC2.DescribeSnapshots Methods hashWithSalt :: Int -> DescribeSnapshots -> Int # hash :: DescribeSnapshots -> Int #
type AWSResponse DescribeSnapshots Source #
Instance details Defined in Amazonka.EC2.DescribeSnapshots type AWSResponse DescribeSnapshots = DescribeSnapshotsResponse
type Rep DescribeSnapshots Source #
Instance details Defined in Amazonka.EC2.DescribeSnapshots type Rep DescribeSnapshots = D1 ('MetaData "DescribeSnapshots" "Amazonka.EC2.DescribeSnapshots" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeSnapshots'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter])) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :: ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "ownerIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 ('MetaSel ('Just "restorableByUserIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "snapshotIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))))

newDescribeSnapshots :: DescribeSnapshots Source #

Create a value of DescribeSnapshots with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dryRun:DescribeSnapshots', describeSnapshots_dryRun - 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.

$sel:filters:DescribeSnapshots', describeSnapshots_filters - 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.

$sel:maxResults:DescribeSnapshots', describeSnapshots_maxResults - 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 1,000; if MaxResults is given a value larger than 1,000, only 1,000 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.

DescribeSnapshots, describeSnapshots_nextToken - 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.

$sel:ownerIds:DescribeSnapshots', describeSnapshots_ownerIds - Scopes the results to snapshots with the specified owners. You can specify a combination of Amazon Web Services account IDs, self, and amazon.

$sel:restorableByUserIds:DescribeSnapshots', describeSnapshots_restorableByUserIds - The IDs of the Amazon Web Services accounts that can create volumes from the snapshot.

$sel:snapshotIds:DescribeSnapshots', describeSnapshots_snapshotIds - The snapshot IDs.

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

Request Lenses

describeSnapshots_dryRun :: Lens' DescribeSnapshots (Maybe Bool) Source #

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.

describeSnapshots_filters :: Lens' DescribeSnapshots (Maybe [Filter]) Source #

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.

describeSnapshots_maxResults :: Lens' DescribeSnapshots (Maybe Int) Source #

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 1,000; if MaxResults is given a value larger than 1,000, only 1,000 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.

describeSnapshots_nextToken :: Lens' DescribeSnapshots (Maybe Text) Source #

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.

describeSnapshots_ownerIds :: Lens' DescribeSnapshots (Maybe [Text]) Source #

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

describeSnapshots_restorableByUserIds :: Lens' DescribeSnapshots (Maybe [Text]) Source #

The IDs of the Amazon Web Services accounts that can create volumes from the snapshot.

describeSnapshots_snapshotIds :: Lens' DescribeSnapshots (Maybe [Text]) Source #

The snapshot IDs.

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

Destructuring the Response

data DescribeSnapshotsResponse Source #

See: newDescribeSnapshotsResponse smart constructor.

Constructors

DescribeSnapshotsResponse'

Fields

nextToken :: 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.
snapshots :: Maybe [Snapshot]
Information about the snapshots.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DescribeSnapshotsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeSnapshots Associated Types type Rep DescribeSnapshotsResponse :: Type -> Type # Methods from :: DescribeSnapshotsResponse -> Rep DescribeSnapshotsResponse x # to :: Rep DescribeSnapshotsResponse x -> DescribeSnapshotsResponse #
Read DescribeSnapshotsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeSnapshots Methods readsPrec :: Int -> ReadS DescribeSnapshotsResponse # readList :: ReadS [DescribeSnapshotsResponse] # readPrec :: ReadPrec DescribeSnapshotsResponse # readListPrec :: ReadPrec [DescribeSnapshotsResponse] #
Show DescribeSnapshotsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeSnapshots Methods showsPrec :: Int -> DescribeSnapshotsResponse -> ShowS # show :: DescribeSnapshotsResponse -> String # showList :: [DescribeSnapshotsResponse] -> ShowS #
NFData DescribeSnapshotsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeSnapshots Methods rnf :: DescribeSnapshotsResponse -> () #
Eq DescribeSnapshotsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeSnapshots Methods (==) :: DescribeSnapshotsResponse -> DescribeSnapshotsResponse -> Bool # (/=) :: DescribeSnapshotsResponse -> DescribeSnapshotsResponse -> Bool #
type Rep DescribeSnapshotsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeSnapshots type Rep DescribeSnapshotsResponse = D1 ('MetaData "DescribeSnapshotsResponse" "Amazonka.EC2.DescribeSnapshots" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeSnapshotsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "snapshots") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Snapshot])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeSnapshotsResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeSnapshotsResponse'`
-> DescribeSnapshotsResponse

Create a value of DescribeSnapshotsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeSnapshots, describeSnapshotsResponse_nextToken - 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.

$sel:snapshots:DescribeSnapshotsResponse', describeSnapshotsResponse_snapshots - Information about the snapshots.

$sel:httpStatus:DescribeSnapshotsResponse', describeSnapshotsResponse_httpStatus - The response's http status code.

Response Lenses

describeSnapshotsResponse_nextToken :: Lens' DescribeSnapshotsResponse (Maybe Text) Source #

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.

describeSnapshotsResponse_snapshots :: Lens' DescribeSnapshotsResponse (Maybe [Snapshot]) Source #

Information about the snapshots.

describeSnapshotsResponse_httpStatus :: Lens' DescribeSnapshotsResponse Int Source #

The response's http status code.