amazonka-elasticache-1.0.0: Amazon ElastiCache SDK.

Copyright(c) 2013-2015 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.ElastiCache.DescribeSnapshots

Contents

Description

The DescribeSnapshots action returns information about cache cluster snapshots. By default, DescribeSnapshots lists all of your snapshots; it can optionally describe a single snapshot, or just the snapshots associated with a particular cache cluster.

See: AWS API Reference for DescribeSnapshots.

This operation returns paginated results.

Synopsis

Creating a Request

describeSnapshots :: DescribeSnapshots Source

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:

Request Lenses

dsCacheClusterId :: Lens' DescribeSnapshots (Maybe Text) Source

A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cache cluster will be described.

dsMaxRecords :: Lens' DescribeSnapshots (Maybe Int) Source

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 50

Constraints: minimum 20; maximum 50.

dsMarker :: Lens' DescribeSnapshots (Maybe Text) Source

An optional marker returned from a prior request. Use this marker for pagination of results from this action. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

dsSnapshotName :: Lens' DescribeSnapshots (Maybe Text) Source

A user-supplied name of the snapshot. If this parameter is specified, only this snapshot will be described.

dsSnapshotSource :: Lens' DescribeSnapshots (Maybe Text) Source

If set to system, the output shows snapshots that were automatically created by ElastiCache. If set to user the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.

Destructuring the Response

describeSnapshotsResponse Source

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:

Response Lenses

dssrsSnapshots :: Lens' DescribeSnapshotsResponse [Snapshot] Source

A list of snapshots. Each item in the list contains detailed information about one snapshot.

dssrsMarker :: Lens' DescribeSnapshotsResponse (Maybe Text) Source

An optional marker returned from a prior request. Use this marker for pagination of results from this action. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.