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:

• ddsIncludeShared
• ddsFilters
• ddsDBSnapshotIdentifier
• ddsSnapshotType
• ddsDBInstanceIdentifier
• ddsMarker
• ddsMaxRecords
• ddsIncludePublic

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

type Rep DescribeDBSnapshots

type Rs DescribeDBSnapshots = DescribeDBSnapshotsResponse

Request Lenses

ddsIncludeShared :: Lens' DescribeDBSnapshots (Maybe Bool)

True to include shared manual DB snapshots from other AWS accounts that this AWS account has been given permission to copy or restore; otherwise false. The default is false.

An AWS account is given permission to restore a manual DB snapshot from another AWS account by the ModifyDBSnapshotAttribute API.

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. You can specify one of the following values:

• automated - Return all DB snapshots that have been automatically taken by Amazon RDS for my AWS account.
• manual - Return all DB snapshots that have been taken by my AWS account.
• shared - Return all manual DB snapshots that have been shared to my AWS account.
• public - Return all DB snapshots that have been marked as public.

If you do not specify a SnapshotType, then both automated and manual snapshots are returned. You can include shared snapshots with these results by setting the IncludeShared parameter to true. You can include public snapshots with these results by setting the IncludePublic parameter to true.

The IncludeShared and IncludePublic parameters do not apply for SnapshotType values of manual or automated. The IncludePublic parameter does not apply when SnapshotType is set to shared. the IncludeShared parameter does not apply when SnapshotType is set to public.

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

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.

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.

ddsIncludePublic :: Lens' DescribeDBSnapshots (Maybe Bool)

True to include manual DB snapshots that are public and can be copied or restored by any AWS account; otherwise false. The default is false.

An manual DB snapshot is shared as public by the ModifyDBSnapshotAttribute API.

Destructuring the Response

describeDBSnapshotsResponse

Arguments

:: Int

ddsrsResponseStatus

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

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

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.

ddsrsResponseStatus :: Lens' DescribeDBSnapshotsResponse Int

The response status code.