amazonka-opsworks-cm-1.4.5: Amazon OpsWorks for Chef Automate SDK.

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

Network.AWS.OpsWorksCM.DescribeBackups

Contents

Description

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.

Synopsis

Creating a Request

describeBackups :: DescribeBackups #

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, 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 - 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.

data DescribeBackups #

See: describeBackups smart constructor.

Instances

Eq DescribeBackups # 
Data DescribeBackups # 

Methods

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

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

toConstr :: DescribeBackups -> Constr #

dataTypeOf :: DescribeBackups -> DataType #

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

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

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

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

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

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

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

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

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

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

Read DescribeBackups # 
Show DescribeBackups # 
Generic DescribeBackups # 
Hashable DescribeBackups # 
ToJSON DescribeBackups # 
NFData DescribeBackups # 

Methods

rnf :: DescribeBackups -> () #

AWSRequest DescribeBackups # 
ToQuery DescribeBackups # 
ToPath DescribeBackups # 
ToHeaders DescribeBackups # 
type Rep DescribeBackups # 
type Rep DescribeBackups = D1 (MetaData "DescribeBackups" "Network.AWS.OpsWorksCM.DescribeBackups" "amazonka-opsworks-cm-1.4.5-AhfVC6jsAX0FFNzDXhBrcp" False) (C1 (MetaCons "DescribeBackups'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_dServerName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dBackupId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_dNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))))))
type Rs DescribeBackups # 

Request Lenses

dServerName :: Lens' DescribeBackups (Maybe Text) #

Returns backups for the server with the specified ServerName.

dBackupId :: Lens' DescribeBackups (Maybe Text) #

Describes a single backup.

dNextToken :: Lens' DescribeBackups (Maybe Text) #

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

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 #

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 a DescribeBackups 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, 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 - -- | The response status code.

data DescribeBackupsResponse #

See: describeBackupsResponse smart constructor.

Instances

Eq DescribeBackupsResponse # 
Data DescribeBackupsResponse # 

Methods

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

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

toConstr :: DescribeBackupsResponse -> Constr #

dataTypeOf :: DescribeBackupsResponse -> DataType #

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

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

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

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

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

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

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

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

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

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

Read DescribeBackupsResponse # 
Show DescribeBackupsResponse # 
Generic DescribeBackupsResponse # 
NFData DescribeBackupsResponse # 

Methods

rnf :: DescribeBackupsResponse -> () #

type Rep DescribeBackupsResponse # 
type Rep DescribeBackupsResponse = D1 (MetaData "DescribeBackupsResponse" "Network.AWS.OpsWorksCM.DescribeBackups" "amazonka-opsworks-cm-1.4.5-AhfVC6jsAX0FFNzDXhBrcp" False) (C1 (MetaCons "DescribeBackupsResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_drsBackups") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Backup]))) ((:*:) (S1 (MetaSel (Just Symbol "_drsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_drsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)))))

Response Lenses

drsBackups :: Lens' DescribeBackupsResponse [Backup] #

Contains the response to a DescribeBackups request.

drsNextToken :: Lens' DescribeBackupsResponse (Maybe Text) #

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 #

  • - | The response status code.