Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Describes backups. The results are ordered by time, with newest backups first. If you do not specify a BackupId or ServerName, the command returns all backups.
This operation is synchronous.
A ResourceNotFoundException
is thrown when the backup does not exist. A ValidationException
is raised when parameters of the request are invalid.
- describeBackups :: DescribeBackups
- data DescribeBackups
- dServerName :: Lens' DescribeBackups (Maybe Text)
- dBackupId :: Lens' DescribeBackups (Maybe Text)
- dNextToken :: Lens' DescribeBackups (Maybe Text)
- dMaxResults :: Lens' DescribeBackups (Maybe Natural)
- describeBackupsResponse :: Int -> DescribeBackupsResponse
- data DescribeBackupsResponse
- drsBackups :: Lens' DescribeBackupsResponse [Backup]
- drsNextToken :: Lens' DescribeBackupsResponse (Maybe Text)
- drsResponseStatus :: Lens' DescribeBackupsResponse Int
Creating a Request
describeBackups :: DescribeBackups Source #
Creates a value of DescribeBackups
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dServerName
- Returns backups for the server with the specified ServerName.dBackupId
- Describes a single backup.dNextToken
- NextToken is a string that is returned in some command responses. It indicates that not all entries have been returned, and that you must run at least one more request to get remaining items. To get remaining results, callDescribeBackups
again, and assign the token from the previous results as the value of thenextToken
parameter. If there are no more results, the response object'snextToken
parameter value isnull
. Setting anextToken
value that was not returned in your previous results causes anInvalidNextTokenException
to occur.dMaxResults
- To receive a paginated response, use this parameter to specify the maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes aNextToken
value that you can assign to theNextToken
request parameter to get the next set of results.
data DescribeBackups Source #
See: describeBackups
smart constructor.
Request Lenses
dServerName :: Lens' DescribeBackups (Maybe Text) Source #
Returns backups for the server with the specified ServerName.
dNextToken :: Lens' DescribeBackups (Maybe Text) Source #
NextToken is a string that is returned in some command responses. It indicates that not all entries have been returned, and that you must run at least one more request to get remaining items. To get remaining results, call DescribeBackups
again, and assign the token from the previous results as the value of the nextToken
parameter. If there are no more results, the response object's nextToken
parameter value is null
. Setting a nextToken
value that was not returned in your previous results causes an InvalidNextTokenException
to occur.
dMaxResults :: Lens' DescribeBackups (Maybe Natural) Source #
To receive a paginated response, use this parameter to specify the maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken
value that you can assign to the NextToken
request parameter to get the next set of results.
Destructuring the Response
describeBackupsResponse Source #
Creates a value of DescribeBackupsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
drsBackups
- Contains the response to aDescribeBackups
request.drsNextToken
- NextToken is a string that is returned in some command responses. It indicates that not all entries have been returned, and that you must run at least one more request to get remaining items. To get remaining results, callDescribeBackups
again, and assign the token from the previous results as the value of thenextToken
parameter. If there are no more results, the response object'snextToken
parameter value isnull
. Setting anextToken
value that was not returned in your previous results causes anInvalidNextTokenException
to occur.drsResponseStatus
- -- | The response status code.
data DescribeBackupsResponse Source #
See: describeBackupsResponse
smart constructor.
Response Lenses
drsBackups :: Lens' DescribeBackupsResponse [Backup] Source #
Contains the response to a DescribeBackups
request.
drsNextToken :: Lens' DescribeBackupsResponse (Maybe Text) Source #
NextToken is a string that is returned in some command responses. It indicates that not all entries have been returned, and that you must run at least one more request to get remaining items. To get remaining results, call DescribeBackups
again, and assign the token from the previous results as the value of the nextToken
parameter. If there are no more results, the response object's nextToken
parameter value is null
. Setting a nextToken
value that was not returned in your previous results causes an InvalidNextTokenException
to occur.
drsResponseStatus :: Lens' DescribeBackupsResponse Int Source #
- - | The response status code.