Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.DynamoDB.ListBackups

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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 1 MB worth of items in a page. You can also specify a 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 boundaries are for the time at which the original backup was requested.

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

This operation returns paginated results.

Synopsis

data ListBackups = ListBackups' {
- timeRangeUpperBound :: Maybe POSIX
- timeRangeLowerBound :: Maybe POSIX
- limit :: Maybe Natural
- exclusiveStartBackupArn :: Maybe Text
- backupType :: Maybe BackupTypeFilter
- tableName :: Maybe Text
}
newListBackups :: ListBackups
listBackups_timeRangeUpperBound :: Lens' ListBackups (Maybe UTCTime)
listBackups_timeRangeLowerBound :: Lens' ListBackups (Maybe UTCTime)
listBackups_limit :: Lens' ListBackups (Maybe Natural)
listBackups_exclusiveStartBackupArn :: Lens' ListBackups (Maybe Text)
listBackups_backupType :: Lens' ListBackups (Maybe BackupTypeFilter)
listBackups_tableName :: Lens' ListBackups (Maybe Text)
data ListBackupsResponse = ListBackupsResponse' {
- backupSummaries :: Maybe [BackupSummary]
- lastEvaluatedBackupArn :: Maybe Text
- httpStatus :: Int
}
newListBackupsResponse :: Int -> ListBackupsResponse
listBackupsResponse_backupSummaries :: Lens' ListBackupsResponse (Maybe [BackupSummary])
listBackupsResponse_lastEvaluatedBackupArn :: Lens' ListBackupsResponse (Maybe Text)
listBackupsResponse_httpStatus :: Lens' ListBackupsResponse Int

Creating a Request

data ListBackups Source #

See: newListBackups smart constructor.

Constructors

ListBackups'

Fields

timeRangeUpperBound :: Maybe POSIX
Only backups created before this time are listed. TimeRangeUpperBound is exclusive.
timeRangeLowerBound :: Maybe POSIX
Only backups created after this time are listed. TimeRangeLowerBound is inclusive.
limit :: Maybe Natural
Maximum number of backups to return at once.
exclusiveStartBackupArn :: Maybe Text
LastEvaluatedBackupArn is the Amazon Resource Name (ARN) of the backup last evaluated when the current page of results was returned, inclusive of the current page of results. This value may be specified as the ExclusiveStartBackupArn of a new ListBackups operation in order to fetch the next page of results.
backupType :: Maybe BackupTypeFilter
The backups from the table specified by BackupType are listed.
Where BackupType can be:
- USER - On-demand backup created by you.
- SYSTEM - On-demand backup automatically created by DynamoDB.
- ALL - All types of on-demand backups (USER and SYSTEM).
tableName :: Maybe Text
The backups from the table specified by TableName are listed.

Instances

Instances details

Eq ListBackups Source #
Instance details Defined in Amazonka.DynamoDB.ListBackups Methods (==) :: ListBackups -> ListBackups -> Bool # (/=) :: ListBackups -> ListBackups -> Bool #
Read ListBackups Source #
Instance details Defined in Amazonka.DynamoDB.ListBackups Methods readsPrec :: Int -> ReadS ListBackups # readList :: ReadS [ListBackups] # readPrec :: ReadPrec ListBackups # readListPrec :: ReadPrec [ListBackups] #
Show ListBackups Source #
Instance details Defined in Amazonka.DynamoDB.ListBackups Methods showsPrec :: Int -> ListBackups -> ShowS # show :: ListBackups -> String # showList :: [ListBackups] -> ShowS #
Generic ListBackups Source #
Instance details Defined in Amazonka.DynamoDB.ListBackups Associated Types type Rep ListBackups :: Type -> Type # Methods from :: ListBackups -> Rep ListBackups x # to :: Rep ListBackups x -> ListBackups #
NFData ListBackups Source #
Instance details Defined in Amazonka.DynamoDB.ListBackups Methods rnf :: ListBackups -> () #
Hashable ListBackups Source #
Instance details Defined in Amazonka.DynamoDB.ListBackups Methods hashWithSalt :: Int -> ListBackups -> Int # hash :: ListBackups -> Int #
ToJSON ListBackups Source #
Instance details Defined in Amazonka.DynamoDB.ListBackups Methods toJSON :: ListBackups -> Value # toEncoding :: ListBackups -> Encoding # toJSONList :: [ListBackups] -> Value # toEncodingList :: [ListBackups] -> Encoding #
AWSPager ListBackups Source #
Instance details Defined in Amazonka.DynamoDB.ListBackups Methods page :: ListBackups -> AWSResponse ListBackups -> Maybe ListBackups #
AWSRequest ListBackups Source #
Instance details Defined in Amazonka.DynamoDB.ListBackups Associated Types type AWSResponse ListBackups # Methods request :: ListBackups -> Request ListBackups # response :: MonadResource m => Logger -> Service -> Proxy ListBackups -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListBackups))) #
ToHeaders ListBackups Source #
Instance details Defined in Amazonka.DynamoDB.ListBackups Methods toHeaders :: ListBackups -> [Header] #
ToPath ListBackups Source #
Instance details Defined in Amazonka.DynamoDB.ListBackups Methods toPath :: ListBackups -> ByteString #
ToQuery ListBackups Source #
Instance details Defined in Amazonka.DynamoDB.ListBackups Methods toQuery :: ListBackups -> QueryString #
type Rep ListBackups Source #
Instance details Defined in Amazonka.DynamoDB.ListBackups type Rep ListBackups = D1 ('MetaData "ListBackups" "Amazonka.DynamoDB.ListBackups" "libZSservicesZSamazonka-dynamodbZSamazonka-dynamodb" 'False) (C1 ('MetaCons "ListBackups'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "timeRangeUpperBound") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "timeRangeLowerBound") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))) :: (S1 ('MetaSel ('Just "exclusiveStartBackupArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "backupType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BackupTypeFilter)) :*: S1 ('MetaSel ('Just "tableName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))
type AWSResponse ListBackups Source #
Instance details Defined in Amazonka.DynamoDB.ListBackups type AWSResponse ListBackups = ListBackupsResponse

newListBackups :: ListBackups Source #

Create a value of ListBackups with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:timeRangeUpperBound:ListBackups', listBackups_timeRangeUpperBound - Only backups created before this time are listed. TimeRangeUpperBound is exclusive.

$sel:timeRangeLowerBound:ListBackups', listBackups_timeRangeLowerBound - Only backups created after this time are listed. TimeRangeLowerBound is inclusive.

$sel:limit:ListBackups', listBackups_limit - Maximum number of backups to return at once.

$sel:exclusiveStartBackupArn:ListBackups', listBackups_exclusiveStartBackupArn - LastEvaluatedBackupArn is the Amazon Resource Name (ARN) of the backup last evaluated when the current page of results was returned, inclusive of the current page of results. This value may be specified as the ExclusiveStartBackupArn of a new ListBackups operation in order to fetch the next page of results.

$sel:backupType:ListBackups', listBackups_backupType - The backups from the table specified by BackupType are listed.

Where BackupType can be:

USER - On-demand backup created by you.
SYSTEM - On-demand backup automatically created by DynamoDB.
ALL - All types of on-demand backups (USER and SYSTEM).

$sel:tableName:ListBackups', listBackups_tableName - The backups from the table specified by TableName are listed.

Request Lenses

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

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

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

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

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

Maximum number of backups to return at once.

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

LastEvaluatedBackupArn is the Amazon Resource Name (ARN) of the backup last evaluated when the current page of results was returned, inclusive of the current page of results. This value may be specified as the ExclusiveStartBackupArn of a new ListBackups operation in order to fetch the next page of results.

listBackups_backupType :: Lens' ListBackups (Maybe BackupTypeFilter) Source #

The backups from the table specified by BackupType are listed.

Where BackupType can be:

USER - On-demand backup created by you.
SYSTEM - On-demand backup automatically created by DynamoDB.
ALL - All types of on-demand backups (USER and SYSTEM).

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

The backups from the table specified by TableName are listed.

Destructuring the Response

data ListBackupsResponse Source #

See: newListBackupsResponse smart constructor.

Constructors

ListBackupsResponse'

Fields

backupSummaries :: Maybe [BackupSummary]
List of BackupSummary objects.
lastEvaluatedBackupArn :: Maybe Text
The ARN of the backup last evaluated when the current page of results was returned, inclusive of the current page of results. This value may be specified as the ExclusiveStartBackupArn of a new ListBackups operation in order to fetch the next page of results.
If LastEvaluatedBackupArn is empty, then the last page of results has been processed and there are no more results to be retrieved.
If LastEvaluatedBackupArn is not empty, this may or may not indicate that there is more data to be returned. All results are guaranteed to have been returned if and only if no value for LastEvaluatedBackupArn is returned.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq ListBackupsResponse Source #
Instance details Defined in Amazonka.DynamoDB.ListBackups Methods (==) :: ListBackupsResponse -> ListBackupsResponse -> Bool # (/=) :: ListBackupsResponse -> ListBackupsResponse -> Bool #
Read ListBackupsResponse Source #
Instance details Defined in Amazonka.DynamoDB.ListBackups Methods readsPrec :: Int -> ReadS ListBackupsResponse # readList :: ReadS [ListBackupsResponse] # readPrec :: ReadPrec ListBackupsResponse # readListPrec :: ReadPrec [ListBackupsResponse] #
Show ListBackupsResponse Source #
Instance details Defined in Amazonka.DynamoDB.ListBackups Methods showsPrec :: Int -> ListBackupsResponse -> ShowS # show :: ListBackupsResponse -> String # showList :: [ListBackupsResponse] -> ShowS #
Generic ListBackupsResponse Source #
Instance details Defined in Amazonka.DynamoDB.ListBackups Associated Types type Rep ListBackupsResponse :: Type -> Type # Methods from :: ListBackupsResponse -> Rep ListBackupsResponse x # to :: Rep ListBackupsResponse x -> ListBackupsResponse #
NFData ListBackupsResponse Source #
Instance details Defined in Amazonka.DynamoDB.ListBackups Methods rnf :: ListBackupsResponse -> () #
type Rep ListBackupsResponse Source #
Instance details Defined in Amazonka.DynamoDB.ListBackups type Rep ListBackupsResponse = D1 ('MetaData "ListBackupsResponse" "Amazonka.DynamoDB.ListBackups" "libZSservicesZSamazonka-dynamodbZSamazonka-dynamodb" 'False) (C1 ('MetaCons "ListBackupsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "backupSummaries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [BackupSummary])) :: (S1 ('MetaSel ('Just "lastEvaluatedBackupArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListBackupsResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListBackupsResponse'`
-> ListBackupsResponse

Create a value of ListBackupsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:backupSummaries:ListBackupsResponse', listBackupsResponse_backupSummaries - List of BackupSummary objects.

$sel:lastEvaluatedBackupArn:ListBackupsResponse', listBackupsResponse_lastEvaluatedBackupArn - The ARN of the backup last evaluated when the current page of results was returned, inclusive of the current page of results. This value may be specified as the ExclusiveStartBackupArn of a new ListBackups operation in order to fetch the next page of results.

If LastEvaluatedBackupArn is empty, then the last page of results has been processed and there are no more results to be retrieved.

If LastEvaluatedBackupArn is not empty, this may or may not indicate that there is more data to be returned. All results are guaranteed to have been returned if and only if no value for LastEvaluatedBackupArn is returned.

$sel:httpStatus:ListBackupsResponse', listBackupsResponse_httpStatus - The response's http status code.

Response Lenses

listBackupsResponse_backupSummaries :: Lens' ListBackupsResponse (Maybe [BackupSummary]) Source #

List of BackupSummary objects.

listBackupsResponse_lastEvaluatedBackupArn :: Lens' ListBackupsResponse (Maybe Text) Source #

The ARN of the backup last evaluated when the current page of results was returned, inclusive of the current page of results. This value may be specified as the ExclusiveStartBackupArn of a new ListBackups operation in order to fetch the next page of results.

If LastEvaluatedBackupArn is empty, then the last page of results has been processed and there are no more results to be retrieved.

If LastEvaluatedBackupArn is not empty, this may or may not indicate that there is more data to be returned. All results are guaranteed to have been returned if and only if no value for LastEvaluatedBackupArn is returned.

listBackupsResponse_httpStatus :: Lens' ListBackupsResponse Int Source #

The response's http status code.