Amazonka.DynamoDB.ListBackups

List backups associated with an Amazon Web Services 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.

Creating a Request

data ListBackups

See: newListBackups smart constructor.

Constructors

ListBackups'

Fields

• backupType :: Maybe BackupTypeFilter

  The backups from the table specified by BackupType are listed.

  Where BackupType can be:

  • USER - On-demand backup created by you. (The default setting if no other backup types are specified.)
  • SYSTEM - On-demand backup automatically created by DynamoDB.
  • ALL - All types of on-demand backups (USER and SYSTEM).
• 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.

• limit :: Maybe Natural

  Maximum number of backups to return at once.

• tableName :: Maybe Text

  The backups from the table specified by TableName are listed.

• timeRangeLowerBound :: Maybe POSIX

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

• timeRangeUpperBound :: Maybe POSIX

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

Instances

ToJSON ListBackups

Defined in Amazonka.DynamoDB.ListBackups

Methods

toJSON :: ListBackups -> Value

toEncoding :: ListBackups -> Encoding

toJSONList :: [ListBackups] -> Value

toEncodingList :: [ListBackups] -> Encoding

ToHeaders ListBackups

Defined in Amazonka.DynamoDB.ListBackups

Methods

toHeaders :: ListBackups -> [Header]

ToPath ListBackups

Defined in Amazonka.DynamoDB.ListBackups

Methods

toPath :: ListBackups -> ByteString

ToQuery ListBackups

Defined in Amazonka.DynamoDB.ListBackups

Methods

toQuery :: ListBackups -> QueryString

AWSPager ListBackups

Defined in Amazonka.DynamoDB.ListBackups

Methods

page :: ListBackups -> AWSResponse ListBackups -> Maybe ListBackups

AWSRequest ListBackups

Defined in Amazonka.DynamoDB.ListBackups

Associated Types

type AWSResponse ListBackups

Methods

request :: (Service -> Service) -> ListBackups -> Request ListBackups

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListBackups -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListBackups)))

Generic ListBackups

Defined in Amazonka.DynamoDB.ListBackups

Associated Types

type Rep ListBackups :: Type -> Type

Methods

from :: ListBackups -> Rep ListBackups x

to :: Rep ListBackups x -> ListBackups

Read ListBackups

Defined in Amazonka.DynamoDB.ListBackups

Methods

readsPrec :: Int -> ReadS ListBackups

readList :: ReadS [ListBackups]

readPrec :: ReadPrec ListBackups

readListPrec :: ReadPrec [ListBackups]

Show ListBackups

Defined in Amazonka.DynamoDB.ListBackups

Methods

showsPrec :: Int -> ListBackups -> ShowS

show :: ListBackups -> String

showList :: [ListBackups] -> ShowS

NFData ListBackups

Defined in Amazonka.DynamoDB.ListBackups

Methods

rnf :: ListBackups -> ()

Eq ListBackups

Defined in Amazonka.DynamoDB.ListBackups

Methods

(==) :: ListBackups -> ListBackups -> Bool

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

Hashable ListBackups

Defined in Amazonka.DynamoDB.ListBackups

Methods

hashWithSalt :: Int -> ListBackups -> Int

hash :: ListBackups -> Int

type AWSResponse ListBackups

Defined in Amazonka.DynamoDB.ListBackups

type AWSResponse ListBackups = ListBackupsResponse

type Rep ListBackups

Defined in Amazonka.DynamoDB.ListBackups

type Rep ListBackups = D1 ('MetaData "ListBackups" "Amazonka.DynamoDB.ListBackups" "amazonka-dynamodb-2.0-GNxlseyeFiu302JKQwQrUS" 'False) (C1 ('MetaCons "ListBackups'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "backupType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BackupTypeFilter)) :*: (S1 ('MetaSel ('Just "exclusiveStartBackupArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))) :*: (S1 ('MetaSel ('Just "tableName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "timeRangeLowerBound") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "timeRangeUpperBound") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))))))

newListBackups :: ListBackups

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:

ListBackups, listBackups_backupType - The backups from the table specified by BackupType are listed.

Where BackupType can be:

• USER - On-demand backup created by you. (The default setting if no other backup types are specified.)
• SYSTEM - On-demand backup automatically created by DynamoDB.
• ALL - All types of on-demand backups (USER and SYSTEM).

$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:limit:ListBackups', listBackups_limit - Maximum number of backups to return at once.

ListBackups, listBackups_tableName - The backups from the table specified by TableName are listed.

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

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

Request Lenses

listBackups_backupType :: Lens' ListBackups (Maybe BackupTypeFilter)

The backups from the table specified by BackupType are listed.

Where BackupType can be:

• USER - On-demand backup created by you. (The default setting if no other backup types are specified.)
• SYSTEM - On-demand backup automatically created by DynamoDB.
• ALL - All types of on-demand backups (USER and SYSTEM).

listBackups_exclusiveStartBackupArn :: Lens' ListBackups (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.

listBackups_limit :: Lens' ListBackups (Maybe Natural)

Maximum number of backups to return at once.

listBackups_tableName :: Lens' ListBackups (Maybe Text)

The backups from the table specified by TableName are listed.

listBackups_timeRangeLowerBound :: Lens' ListBackups (Maybe UTCTime)

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

listBackups_timeRangeUpperBound :: Lens' ListBackups (Maybe UTCTime)

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

Destructuring the Response

data ListBackupsResponse

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

Generic ListBackupsResponse

Defined in Amazonka.DynamoDB.ListBackups

Associated Types

type Rep ListBackupsResponse :: Type -> Type

Methods

from :: ListBackupsResponse -> Rep ListBackupsResponse x

to :: Rep ListBackupsResponse x -> ListBackupsResponse

Read ListBackupsResponse

Defined in Amazonka.DynamoDB.ListBackups

Methods

readsPrec :: Int -> ReadS ListBackupsResponse

readList :: ReadS [ListBackupsResponse]

readPrec :: ReadPrec ListBackupsResponse

readListPrec :: ReadPrec [ListBackupsResponse]

Show ListBackupsResponse

Defined in Amazonka.DynamoDB.ListBackups

Methods

showsPrec :: Int -> ListBackupsResponse -> ShowS

show :: ListBackupsResponse -> String

showList :: [ListBackupsResponse] -> ShowS

NFData ListBackupsResponse

Defined in Amazonka.DynamoDB.ListBackups

Methods

rnf :: ListBackupsResponse -> ()

Eq ListBackupsResponse

Defined in Amazonka.DynamoDB.ListBackups

Methods

(==) :: ListBackupsResponse -> ListBackupsResponse -> Bool

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

type Rep ListBackupsResponse

Defined in Amazonka.DynamoDB.ListBackups

type Rep ListBackupsResponse = D1 ('MetaData "ListBackupsResponse" "Amazonka.DynamoDB.ListBackups" "amazonka-dynamodb-2.0-GNxlseyeFiu302JKQwQrUS" '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

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])

List of BackupSummary objects.

listBackupsResponse_lastEvaluatedBackupArn :: Lens' ListBackupsResponse (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.

listBackupsResponse_httpStatus :: Lens' ListBackupsResponse Int

The response's http status code.