Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.OpsWorksCM.DescribeBackups

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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 not valid.

This operation returns paginated results.

Synopsis

data DescribeBackups = DescribeBackups' {
- backupId :: Maybe Text
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- serverName :: Maybe Text
}
newDescribeBackups :: DescribeBackups
describeBackups_backupId :: Lens' DescribeBackups (Maybe Text)
describeBackups_maxResults :: Lens' DescribeBackups (Maybe Natural)
describeBackups_nextToken :: Lens' DescribeBackups (Maybe Text)
describeBackups_serverName :: Lens' DescribeBackups (Maybe Text)
data DescribeBackupsResponse = DescribeBackupsResponse' {
- backups :: Maybe [Backup]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newDescribeBackupsResponse :: Int -> DescribeBackupsResponse
describeBackupsResponse_backups :: Lens' DescribeBackupsResponse (Maybe [Backup])
describeBackupsResponse_nextToken :: Lens' DescribeBackupsResponse (Maybe Text)
describeBackupsResponse_httpStatus :: Lens' DescribeBackupsResponse Int

Creating a Request

data DescribeBackups Source #

See: newDescribeBackups smart constructor.

Constructors

DescribeBackups'
Fields backupId :: Maybe Text Describes a single backup. maxResults :: Maybe Natural This is not currently implemented for `DescribeBackups` requests. nextToken :: Maybe Text This is not currently implemented for `DescribeBackups` requests. serverName :: Maybe Text Returns backups for the server with the specified ServerName.

Instances

Instances details

ToJSON DescribeBackups Source #
Instance details Defined in Amazonka.OpsWorksCM.DescribeBackups Methods toJSON :: DescribeBackups -> Value # toEncoding :: DescribeBackups -> Encoding # toJSONList :: [DescribeBackups] -> Value # toEncodingList :: [DescribeBackups] -> Encoding #
ToHeaders DescribeBackups Source #
Instance details Defined in Amazonka.OpsWorksCM.DescribeBackups Methods toHeaders :: DescribeBackups -> [Header] #
ToPath DescribeBackups Source #
Instance details Defined in Amazonka.OpsWorksCM.DescribeBackups Methods toPath :: DescribeBackups -> ByteString #
ToQuery DescribeBackups Source #
Instance details Defined in Amazonka.OpsWorksCM.DescribeBackups Methods toQuery :: DescribeBackups -> QueryString #
AWSPager DescribeBackups Source #
Instance details Defined in Amazonka.OpsWorksCM.DescribeBackups Methods page :: DescribeBackups -> AWSResponse DescribeBackups -> Maybe DescribeBackups #
AWSRequest DescribeBackups Source #
Instance details Defined in Amazonka.OpsWorksCM.DescribeBackups Associated Types type AWSResponse DescribeBackups # Methods request :: (Service -> Service) -> DescribeBackups -> Request DescribeBackups # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeBackups -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeBackups))) #
Generic DescribeBackups Source #
Instance details Defined in Amazonka.OpsWorksCM.DescribeBackups Associated Types type Rep DescribeBackups :: Type -> Type # Methods from :: DescribeBackups -> Rep DescribeBackups x # to :: Rep DescribeBackups x -> DescribeBackups #
Read DescribeBackups Source #
Instance details Defined in Amazonka.OpsWorksCM.DescribeBackups Methods readsPrec :: Int -> ReadS DescribeBackups # readList :: ReadS [DescribeBackups] # readPrec :: ReadPrec DescribeBackups # readListPrec :: ReadPrec [DescribeBackups] #
Show DescribeBackups Source #
Instance details Defined in Amazonka.OpsWorksCM.DescribeBackups Methods showsPrec :: Int -> DescribeBackups -> ShowS # show :: DescribeBackups -> String # showList :: [DescribeBackups] -> ShowS #
NFData DescribeBackups Source #
Instance details Defined in Amazonka.OpsWorksCM.DescribeBackups Methods rnf :: DescribeBackups -> () #
Eq DescribeBackups Source #
Instance details Defined in Amazonka.OpsWorksCM.DescribeBackups Methods (==) :: DescribeBackups -> DescribeBackups -> Bool # (/=) :: DescribeBackups -> DescribeBackups -> Bool #
Hashable DescribeBackups Source #
Instance details Defined in Amazonka.OpsWorksCM.DescribeBackups Methods hashWithSalt :: Int -> DescribeBackups -> Int # hash :: DescribeBackups -> Int #
type AWSResponse DescribeBackups Source #
Instance details Defined in Amazonka.OpsWorksCM.DescribeBackups type AWSResponse DescribeBackups = DescribeBackupsResponse
type Rep DescribeBackups Source #
Instance details Defined in Amazonka.OpsWorksCM.DescribeBackups type Rep DescribeBackups = D1 ('MetaData "DescribeBackups" "Amazonka.OpsWorksCM.DescribeBackups" "amazonka-opsworks-cm-2.0-4eRKS676FdFBzYMnhnI9o" 'False) (C1 ('MetaCons "DescribeBackups'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "backupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "serverName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newDescribeBackups :: DescribeBackups Source #

Create a value of DescribeBackups 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:

DescribeBackups, describeBackups_backupId - Describes a single backup.

$sel:maxResults:DescribeBackups', describeBackups_maxResults - This is not currently implemented for DescribeBackups requests.

DescribeBackups, describeBackups_nextToken - This is not currently implemented for DescribeBackups requests.

DescribeBackups, describeBackups_serverName - Returns backups for the server with the specified ServerName.

Request Lenses

describeBackups_backupId :: Lens' DescribeBackups (Maybe Text) Source #

Describes a single backup.

describeBackups_maxResults :: Lens' DescribeBackups (Maybe Natural) Source #

This is not currently implemented for DescribeBackups requests.

describeBackups_nextToken :: Lens' DescribeBackups (Maybe Text) Source #

This is not currently implemented for DescribeBackups requests.

describeBackups_serverName :: Lens' DescribeBackups (Maybe Text) Source #

Returns backups for the server with the specified ServerName.

Destructuring the Response

data DescribeBackupsResponse Source #

See: newDescribeBackupsResponse smart constructor.

Constructors

DescribeBackupsResponse'
Fields backups :: Maybe [Backup] Contains the response to a `DescribeBackups` request. nextToken :: Maybe Text This is not currently implemented for `DescribeBackups` requests. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DescribeBackupsResponse Source #
Instance details Defined in Amazonka.OpsWorksCM.DescribeBackups Associated Types type Rep DescribeBackupsResponse :: Type -> Type # Methods from :: DescribeBackupsResponse -> Rep DescribeBackupsResponse x # to :: Rep DescribeBackupsResponse x -> DescribeBackupsResponse #
Read DescribeBackupsResponse Source #
Instance details Defined in Amazonka.OpsWorksCM.DescribeBackups Methods readsPrec :: Int -> ReadS DescribeBackupsResponse # readList :: ReadS [DescribeBackupsResponse] # readPrec :: ReadPrec DescribeBackupsResponse # readListPrec :: ReadPrec [DescribeBackupsResponse] #
Show DescribeBackupsResponse Source #
Instance details Defined in Amazonka.OpsWorksCM.DescribeBackups Methods showsPrec :: Int -> DescribeBackupsResponse -> ShowS # show :: DescribeBackupsResponse -> String # showList :: [DescribeBackupsResponse] -> ShowS #
NFData DescribeBackupsResponse Source #
Instance details Defined in Amazonka.OpsWorksCM.DescribeBackups Methods rnf :: DescribeBackupsResponse -> () #
Eq DescribeBackupsResponse Source #
Instance details Defined in Amazonka.OpsWorksCM.DescribeBackups Methods (==) :: DescribeBackupsResponse -> DescribeBackupsResponse -> Bool # (/=) :: DescribeBackupsResponse -> DescribeBackupsResponse -> Bool #
type Rep DescribeBackupsResponse Source #
Instance details Defined in Amazonka.OpsWorksCM.DescribeBackups type Rep DescribeBackupsResponse = D1 ('MetaData "DescribeBackupsResponse" "Amazonka.OpsWorksCM.DescribeBackups" "amazonka-opsworks-cm-2.0-4eRKS676FdFBzYMnhnI9o" 'False) (C1 ('MetaCons "DescribeBackupsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "backups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Backup])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeBackupsResponse Source #

Arguments

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

Create a value of DescribeBackupsResponse 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:backups:DescribeBackupsResponse', describeBackupsResponse_backups - Contains the response to a DescribeBackups request.

DescribeBackups, describeBackupsResponse_nextToken - This is not currently implemented for DescribeBackups requests.

$sel:httpStatus:DescribeBackupsResponse', describeBackupsResponse_httpStatus - The response's http status code.

Response Lenses

describeBackupsResponse_backups :: Lens' DescribeBackupsResponse (Maybe [Backup]) Source #

Contains the response to a DescribeBackups request.

describeBackupsResponse_nextToken :: Lens' DescribeBackupsResponse (Maybe Text) Source #

This is not currently implemented for DescribeBackups requests.

describeBackupsResponse_httpStatus :: Lens' DescribeBackupsResponse Int Source #

The response's http status code.