Network.AWS.RDS.DescribeDBSnapshots

Returns information about DB snapshots. This API action supports pagination.

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 - Set this value to true to include shared manual DB snapshots from other AWS accounts that this AWS account has been given permission to copy or restore, otherwise set this value to false . The default is false . You can give an AWS account permission to restore a manual DB snapshot from another AWS account by using the ModifyDBSnapshotAttribute API action.
• ddsFilters - This parameter is not currently supported.
• ddsDBSnapshotIdentifier - 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 identifier is for an automated snapshot, the SnapshotType parameter must also be specified.
• ddsSnapshotType - The type of snapshots to 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 don't specify a SnapshotType value, then both automated and manual snapshots are returned. Shared and public DB snapshots are not included in the returned results by default. 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 don't apply for SnapshotType values of manual or automated . The IncludePublic parameter doesn't apply when SnapshotType is set to shared . The IncludeShared parameter doesn't apply when SnapshotType is set to public .
• ddsDBInstanceIdentifier - The ID of the DB instance 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 - 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 - 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 - Set this value to true to include manual DB snapshots that are public and can be copied or restored by any AWS account, otherwise set this value to false . The default is false . You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.

data DescribeDBSnapshots

See: describeDBSnapshots smart constructor.

Instances

Eq DescribeDBSnapshots

Methods

(==) :: DescribeDBSnapshots -> DescribeDBSnapshots -> Bool

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

Data DescribeDBSnapshots

Methods

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

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

toConstr :: DescribeDBSnapshots -> Constr

dataTypeOf :: DescribeDBSnapshots -> DataType

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

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

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

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

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

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

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

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

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

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

Read DescribeDBSnapshots

Methods

readsPrec :: Int -> ReadS DescribeDBSnapshots

readList :: ReadS [DescribeDBSnapshots]

readPrec :: ReadPrec DescribeDBSnapshots

readListPrec :: ReadPrec [DescribeDBSnapshots]

Show DescribeDBSnapshots

Methods

showsPrec :: Int -> DescribeDBSnapshots -> ShowS

show :: DescribeDBSnapshots -> String

showList :: [DescribeDBSnapshots] -> ShowS

Generic DescribeDBSnapshots

Associated Types

type Rep DescribeDBSnapshots :: * -> *

Methods

from :: DescribeDBSnapshots -> Rep DescribeDBSnapshots x

to :: Rep DescribeDBSnapshots x -> DescribeDBSnapshots

Hashable DescribeDBSnapshots

Methods

hashWithSalt :: Int -> DescribeDBSnapshots -> Int

hash :: DescribeDBSnapshots -> Int

NFData DescribeDBSnapshots

Methods

rnf :: DescribeDBSnapshots -> ()

AWSPager DescribeDBSnapshots

Methods

page :: DescribeDBSnapshots -> Rs DescribeDBSnapshots -> Maybe DescribeDBSnapshots

AWSRequest DescribeDBSnapshots

Associated Types

type Rs DescribeDBSnapshots :: *

Methods

request :: DescribeDBSnapshots -> Request DescribeDBSnapshots

response :: MonadResource m => Logger -> Service -> Proxy * DescribeDBSnapshots -> ClientResponse -> m (Response DescribeDBSnapshots)

ToPath DescribeDBSnapshots

Methods

toPath :: DescribeDBSnapshots -> ByteString

ToHeaders DescribeDBSnapshots

Methods

toHeaders :: DescribeDBSnapshots -> [Header]

ToQuery DescribeDBSnapshots

Methods

toQuery :: DescribeDBSnapshots -> QueryString

type Rep DescribeDBSnapshots

type Rep DescribeDBSnapshots = D1 (MetaData "DescribeDBSnapshots" "Network.AWS.RDS.DescribeDBSnapshots" "amazonka-rds-1.4.5-FycntHHvABz6gJkK2IrBDo" False) (C1 (MetaCons "DescribeDBSnapshots'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_ddsIncludeShared") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_ddsFilters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Filter])))) ((:*:) (S1 (MetaSel (Just Symbol "_ddsDBSnapshotIdentifier") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_ddsSnapshotType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_ddsDBInstanceIdentifier") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_ddsMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_ddsMaxRecords") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int))) (S1 (MetaSel (Just Symbol "_ddsIncludePublic") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)))))))

type Rs DescribeDBSnapshots

type Rs DescribeDBSnapshots = DescribeDBSnapshotsResponse

Request Lenses

ddsIncludeShared :: Lens' DescribeDBSnapshots (Maybe Bool)

Set this value to true to include shared manual DB snapshots from other AWS accounts that this AWS account has been given permission to copy or restore, otherwise set this value to false . The default is false . You can give an AWS account permission to restore a manual DB snapshot from another AWS account by using the ModifyDBSnapshotAttribute API action.

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 identifier is for an automated snapshot, the SnapshotType parameter must also be specified.

ddsSnapshotType :: Lens' DescribeDBSnapshots (Maybe Text)

The type of snapshots to 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 don't specify a SnapshotType value, then both automated and manual snapshots are returned. Shared and public DB snapshots are not included in the returned results by default. 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 don't apply for SnapshotType values of manual or automated . The IncludePublic parameter doesn't apply when SnapshotType is set to shared . The IncludeShared parameter doesn't apply when SnapshotType is set to public .

ddsDBInstanceIdentifier :: Lens' DescribeDBSnapshots (Maybe Text)

The ID of the DB instance 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)

Set this value to true to include manual DB snapshots that are public and can be copied or restored by any AWS account, otherwise set this value to false . The default is false . You can share a manual DB snapshot as public by using 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 - 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 - A list of DBSnapshot instances.
• ddsrsResponseStatus - -- | The response status code.

data DescribeDBSnapshotsResponse

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

See: describeDBSnapshotsResponse smart constructor.

Instances

Eq DescribeDBSnapshotsResponse

Methods

(==) :: DescribeDBSnapshotsResponse -> DescribeDBSnapshotsResponse -> Bool

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

Data DescribeDBSnapshotsResponse

Methods

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

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

toConstr :: DescribeDBSnapshotsResponse -> Constr

dataTypeOf :: DescribeDBSnapshotsResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read DescribeDBSnapshotsResponse

Methods

readsPrec :: Int -> ReadS DescribeDBSnapshotsResponse

readList :: ReadS [DescribeDBSnapshotsResponse]

readPrec :: ReadPrec DescribeDBSnapshotsResponse

readListPrec :: ReadPrec [DescribeDBSnapshotsResponse]

Show DescribeDBSnapshotsResponse

Methods

showsPrec :: Int -> DescribeDBSnapshotsResponse -> ShowS

show :: DescribeDBSnapshotsResponse -> String

showList :: [DescribeDBSnapshotsResponse] -> ShowS

Generic DescribeDBSnapshotsResponse

Associated Types

type Rep DescribeDBSnapshotsResponse :: * -> *

Methods

from :: DescribeDBSnapshotsResponse -> Rep DescribeDBSnapshotsResponse x

to :: Rep DescribeDBSnapshotsResponse x -> DescribeDBSnapshotsResponse

NFData DescribeDBSnapshotsResponse

Methods

rnf :: DescribeDBSnapshotsResponse -> ()

type Rep DescribeDBSnapshotsResponse

type Rep DescribeDBSnapshotsResponse = D1 (MetaData "DescribeDBSnapshotsResponse" "Network.AWS.RDS.DescribeDBSnapshots" "amazonka-rds-1.4.5-FycntHHvABz6gJkK2IrBDo" False) (C1 (MetaCons "DescribeDBSnapshotsResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_ddsrsMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_ddsrsDBSnapshots") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [DBSnapshot]))) (S1 (MetaSel (Just Symbol "_ddsrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)))))

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.