amazonka-dynamodb-1.6.0: Amazon DynamoDB SDK.

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

Network.AWS.DynamoDB.ListBackups

Contents

Description

List backups associated with an AWS account. To list backups for a given table, specify TableName . ListBackups returns a paginated list of results with at most 1MB worth of items in a page. You can also specify a limit for the maximum number of entries to be returned in a page.

In the request, start time is inclusive but end time is exclusive. Note that these limits are for the time at which the original backup was requested.

You can call ListBackups a maximum of 5 times per second.

This operation returns paginated results.

Synopsis

Creating a Request

listBackups :: ListBackups Source #

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

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

  • lbTimeRangeUpperBound - Only backups created before this time are listed. TimeRangeUpperBound is exclusive.
  • lbTimeRangeLowerBound - Only backups created after this time are listed. TimeRangeLowerBound is inclusive.
  • lbLimit - Maximum number of backups to return at once.
  • lbExclusiveStartBackupARN - LastEvaluatedBackupARN returned by the previous ListBackups call.
  • lbTableName - The backups from the table specified by TableName are listed.

data ListBackups Source #

See: listBackups smart constructor.

Instances

Eq ListBackups Source # 
Data ListBackups Source # 

Methods

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

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

toConstr :: ListBackups -> Constr #

dataTypeOf :: ListBackups -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> ListBackups -> ListBackups #

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

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

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

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

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

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

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

Read ListBackups Source # 
Show ListBackups Source # 
Generic ListBackups Source # 

Associated Types

type Rep ListBackups :: * -> * #

Hashable ListBackups Source # 
ToJSON ListBackups Source # 
NFData ListBackups Source # 

Methods

rnf :: ListBackups -> () #

AWSPager ListBackups Source # 
AWSRequest ListBackups Source # 
ToHeaders ListBackups Source # 

Methods

toHeaders :: ListBackups -> [Header] #

ToPath ListBackups Source # 
ToQuery ListBackups Source # 
type Rep ListBackups Source # 
type Rep ListBackups = D1 * (MetaData "ListBackups" "Network.AWS.DynamoDB.ListBackups" "amazonka-dynamodb-1.6.0-Be8FXVQVyEHEMZza56FG0o" False) (C1 * (MetaCons "ListBackups'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_lbTimeRangeUpperBound") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe POSIX))) (S1 * (MetaSel (Just Symbol "_lbTimeRangeLowerBound") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe POSIX)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_lbLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat))) ((:*:) * (S1 * (MetaSel (Just Symbol "_lbExclusiveStartBackupARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_lbTableName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))))))
type Rs ListBackups Source # 

Request Lenses

lbTimeRangeUpperBound :: Lens' ListBackups (Maybe UTCTime) Source #

Only backups created before this time are listed. TimeRangeUpperBound is exclusive.

lbTimeRangeLowerBound :: Lens' ListBackups (Maybe UTCTime) Source #

Only backups created after this time are listed. TimeRangeLowerBound is inclusive.

lbLimit :: Lens' ListBackups (Maybe Natural) Source #

Maximum number of backups to return at once.

lbExclusiveStartBackupARN :: Lens' ListBackups (Maybe Text) Source #

LastEvaluatedBackupARN returned by the previous ListBackups call.

lbTableName :: Lens' ListBackups (Maybe Text) Source #

The backups from the table specified by TableName are listed.

Destructuring the Response

listBackupsResponse Source #

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

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

data ListBackupsResponse Source #

See: listBackupsResponse smart constructor.

Instances

Eq ListBackupsResponse Source # 
Data ListBackupsResponse Source # 

Methods

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

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

toConstr :: ListBackupsResponse -> Constr #

dataTypeOf :: ListBackupsResponse -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> ListBackupsResponse -> ListBackupsResponse #

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

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

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

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

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

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

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

Read ListBackupsResponse Source # 
Show ListBackupsResponse Source # 
Generic ListBackupsResponse Source # 
NFData ListBackupsResponse Source # 

Methods

rnf :: ListBackupsResponse -> () #

type Rep ListBackupsResponse Source # 
type Rep ListBackupsResponse = D1 * (MetaData "ListBackupsResponse" "Network.AWS.DynamoDB.ListBackups" "amazonka-dynamodb-1.6.0-Be8FXVQVyEHEMZza56FG0o" False) (C1 * (MetaCons "ListBackupsResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_lbrsBackupSummaries") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [BackupSummary]))) ((:*:) * (S1 * (MetaSel (Just Symbol "_lbrsLastEvaluatedBackupARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_lbrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

lbrsResponseStatus :: Lens' ListBackupsResponse Int Source #

  • - | The response status code.