Network.AWS.RDS.DescribeDBSnapshots

Returns information about DB snapshots. This API supports pagination.

See: AWS API Reference for DescribeDBSnapshots.

This operation returns paginated results.

Creating a Request

describeDBSnapshots :: DescribeDBSnapshots

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

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

• ddsFilters
• ddsDBSnapshotIdentifier
• ddsSnapshotType
• ddsDBInstanceIdentifier
• ddsMaxRecords
• ddsMarker

data DescribeDBSnapshots

See: describeDBSnapshots smart constructor.

Instances

Eq DescribeDBSnapshots

Data DescribeDBSnapshots

Read DescribeDBSnapshots

Show DescribeDBSnapshots

Generic DescribeDBSnapshots

AWSPager DescribeDBSnapshots

AWSRequest DescribeDBSnapshots

ToPath DescribeDBSnapshots

ToHeaders DescribeDBSnapshots

ToQuery DescribeDBSnapshots

Typeable * DescribeDBSnapshots

type Rep DescribeDBSnapshots

type Rs DescribeDBSnapshots = DescribeDBSnapshotsResponse

Request Lenses

ddsFilters :: Lens' DescribeDBSnapshots [Filter]

This parameter is not currently supported.

ddsDBSnapshotIdentifier :: Lens' DescribeDBSnapshots (Maybe Text)

A specific DB snapshot identifier to describe. This parameter cannot be used in conjunction with DBInstanceIdentifier. This value is stored as a lowercase string.

Constraints:

• Must be 1 to 255 alphanumeric characters.
• First character must be a letter.
• Cannot end with a hyphen or contain two consecutive hyphens.
• If this is the identifier of an automated snapshot, the SnapshotType parameter must also be specified.

ddsSnapshotType :: Lens' DescribeDBSnapshots (Maybe Text)

The type of snapshots that will be returned. Values can be "automated" or "manual." If not specified, the returned results will include all snapshots types.

ddsDBInstanceIdentifier :: Lens' DescribeDBSnapshots (Maybe Text)

A DB instance identifier to retrieve the list of DB snapshots for. This parameter cannot be used in conjunction with DBSnapshotIdentifier. This parameter is not case-sensitive.

Constraints:

• Must contain from 1 to 63 alphanumeric characters or hyphens
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

ddsMaxRecords :: Lens' DescribeDBSnapshots (Maybe Int)

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

Default: 100

Constraints: Minimum 20, maximum 100.

ddsMarker :: Lens' DescribeDBSnapshots (Maybe Text)

An optional pagination token provided by a previous DescribeDBSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Destructuring the Response

describeDBSnapshotsResponse

Arguments

:: Int

ddsrsStatus

-> DescribeDBSnapshotsResponse

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

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

• ddsrsMarker
• ddsrsDBSnapshots
• ddsrsStatus

data DescribeDBSnapshotsResponse

Contains the result of a successful invocation of the DescribeDBSnapshots action.

See: describeDBSnapshotsResponse smart constructor.

Instances

Eq DescribeDBSnapshotsResponse

Data DescribeDBSnapshotsResponse

Read DescribeDBSnapshotsResponse

Show DescribeDBSnapshotsResponse

Generic DescribeDBSnapshotsResponse

Typeable * DescribeDBSnapshotsResponse

type Rep DescribeDBSnapshotsResponse

Response Lenses

ddsrsMarker :: Lens' DescribeDBSnapshotsResponse (Maybe Text)

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

ddsrsDBSnapshots :: Lens' DescribeDBSnapshotsResponse [DBSnapshot]

A list of DBSnapshot instances.

ddsrsStatus :: Lens' DescribeDBSnapshotsResponse Int

The response status code.