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.Backup.ListRestoreJobs

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a list of jobs that Backup initiated to restore a saved resource, including details about the recovery process.

Synopsis

data ListRestoreJobs = ListRestoreJobs' {
- byCreatedAfter :: Maybe POSIX
- byStatus :: Maybe RestoreJobStatus
- byAccountId :: Maybe Text
- byCreatedBefore :: Maybe POSIX
- nextToken :: Maybe Text
- maxResults :: Maybe Natural
}
newListRestoreJobs :: ListRestoreJobs
listRestoreJobs_byCreatedAfter :: Lens' ListRestoreJobs (Maybe UTCTime)
listRestoreJobs_byStatus :: Lens' ListRestoreJobs (Maybe RestoreJobStatus)
listRestoreJobs_byAccountId :: Lens' ListRestoreJobs (Maybe Text)
listRestoreJobs_byCreatedBefore :: Lens' ListRestoreJobs (Maybe UTCTime)
listRestoreJobs_nextToken :: Lens' ListRestoreJobs (Maybe Text)
listRestoreJobs_maxResults :: Lens' ListRestoreJobs (Maybe Natural)
data ListRestoreJobsResponse = ListRestoreJobsResponse' {
- nextToken :: Maybe Text
- restoreJobs :: Maybe [RestoreJobsListMember]
- httpStatus :: Int
}
newListRestoreJobsResponse :: Int -> ListRestoreJobsResponse
listRestoreJobsResponse_nextToken :: Lens' ListRestoreJobsResponse (Maybe Text)
listRestoreJobsResponse_restoreJobs :: Lens' ListRestoreJobsResponse (Maybe [RestoreJobsListMember])
listRestoreJobsResponse_httpStatus :: Lens' ListRestoreJobsResponse Int

Creating a Request

data ListRestoreJobs Source #

See: newListRestoreJobs smart constructor.

Constructors

ListRestoreJobs'

Fields

byCreatedAfter :: Maybe POSIX
Returns only restore jobs that were created after the specified date.
byStatus :: Maybe RestoreJobStatus
Returns only restore jobs associated with the specified job status.
byAccountId :: Maybe Text
The account ID to list the jobs from. Returns only restore jobs associated with the specified account ID.
byCreatedBefore :: Maybe POSIX
Returns only restore jobs that were created before the specified date.
nextToken :: Maybe Text
The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
maxResults :: Maybe Natural
The maximum number of items to be returned.

Instances

Instances details

Eq ListRestoreJobs Source #
Instance details Defined in Amazonka.Backup.ListRestoreJobs Methods (==) :: ListRestoreJobs -> ListRestoreJobs -> Bool # (/=) :: ListRestoreJobs -> ListRestoreJobs -> Bool #
Read ListRestoreJobs Source #
Instance details Defined in Amazonka.Backup.ListRestoreJobs Methods readsPrec :: Int -> ReadS ListRestoreJobs # readList :: ReadS [ListRestoreJobs] # readPrec :: ReadPrec ListRestoreJobs # readListPrec :: ReadPrec [ListRestoreJobs] #
Show ListRestoreJobs Source #
Instance details Defined in Amazonka.Backup.ListRestoreJobs Methods showsPrec :: Int -> ListRestoreJobs -> ShowS # show :: ListRestoreJobs -> String # showList :: [ListRestoreJobs] -> ShowS #
Generic ListRestoreJobs Source #
Instance details Defined in Amazonka.Backup.ListRestoreJobs Associated Types type Rep ListRestoreJobs :: Type -> Type # Methods from :: ListRestoreJobs -> Rep ListRestoreJobs x # to :: Rep ListRestoreJobs x -> ListRestoreJobs #
NFData ListRestoreJobs Source #
Instance details Defined in Amazonka.Backup.ListRestoreJobs Methods rnf :: ListRestoreJobs -> () #
Hashable ListRestoreJobs Source #
Instance details Defined in Amazonka.Backup.ListRestoreJobs Methods hashWithSalt :: Int -> ListRestoreJobs -> Int # hash :: ListRestoreJobs -> Int #
AWSRequest ListRestoreJobs Source #
Instance details Defined in Amazonka.Backup.ListRestoreJobs Associated Types type AWSResponse ListRestoreJobs # Methods request :: ListRestoreJobs -> Request ListRestoreJobs # response :: MonadResource m => Logger -> Service -> Proxy ListRestoreJobs -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListRestoreJobs))) #
ToHeaders ListRestoreJobs Source #
Instance details Defined in Amazonka.Backup.ListRestoreJobs Methods toHeaders :: ListRestoreJobs -> [Header] #
ToPath ListRestoreJobs Source #
Instance details Defined in Amazonka.Backup.ListRestoreJobs Methods toPath :: ListRestoreJobs -> ByteString #
ToQuery ListRestoreJobs Source #
Instance details Defined in Amazonka.Backup.ListRestoreJobs Methods toQuery :: ListRestoreJobs -> QueryString #
type Rep ListRestoreJobs Source #
Instance details Defined in Amazonka.Backup.ListRestoreJobs type Rep ListRestoreJobs = D1 ('MetaData "ListRestoreJobs" "Amazonka.Backup.ListRestoreJobs" "libZSservicesZSamazonka-backupZSamazonka-backup" 'False) (C1 ('MetaCons "ListRestoreJobs'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "byCreatedAfter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "byStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RestoreJobStatus)) :: S1 ('MetaSel ('Just "byAccountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "byCreatedBefore") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))))
type AWSResponse ListRestoreJobs Source #
Instance details Defined in Amazonka.Backup.ListRestoreJobs type AWSResponse ListRestoreJobs = ListRestoreJobsResponse

newListRestoreJobs :: ListRestoreJobs Source #

Create a value of ListRestoreJobs 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:byCreatedAfter:ListRestoreJobs', listRestoreJobs_byCreatedAfter - Returns only restore jobs that were created after the specified date.

$sel:byStatus:ListRestoreJobs', listRestoreJobs_byStatus - Returns only restore jobs associated with the specified job status.

$sel:byAccountId:ListRestoreJobs', listRestoreJobs_byAccountId - The account ID to list the jobs from. Returns only restore jobs associated with the specified account ID.

$sel:byCreatedBefore:ListRestoreJobs', listRestoreJobs_byCreatedBefore - Returns only restore jobs that were created before the specified date.

$sel:nextToken:ListRestoreJobs', listRestoreJobs_nextToken - The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

$sel:maxResults:ListRestoreJobs', listRestoreJobs_maxResults - The maximum number of items to be returned.

Request Lenses

listRestoreJobs_byCreatedAfter :: Lens' ListRestoreJobs (Maybe UTCTime) Source #

Returns only restore jobs that were created after the specified date.

listRestoreJobs_byStatus :: Lens' ListRestoreJobs (Maybe RestoreJobStatus) Source #

Returns only restore jobs associated with the specified job status.

listRestoreJobs_byAccountId :: Lens' ListRestoreJobs (Maybe Text) Source #

The account ID to list the jobs from. Returns only restore jobs associated with the specified account ID.

listRestoreJobs_byCreatedBefore :: Lens' ListRestoreJobs (Maybe UTCTime) Source #

Returns only restore jobs that were created before the specified date.

listRestoreJobs_nextToken :: Lens' ListRestoreJobs (Maybe Text) Source #

The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

listRestoreJobs_maxResults :: Lens' ListRestoreJobs (Maybe Natural) Source #

The maximum number of items to be returned.

Destructuring the Response

data ListRestoreJobsResponse Source #

See: newListRestoreJobsResponse smart constructor.

Constructors

ListRestoreJobsResponse'

Fields

nextToken :: Maybe Text
The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
restoreJobs :: Maybe [RestoreJobsListMember]
An array of objects that contain detailed information about jobs to restore saved resources.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newListRestoreJobsResponse Source #

Arguments

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

Create a value of ListRestoreJobsResponse 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:nextToken:ListRestoreJobs', listRestoreJobsResponse_nextToken - The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

$sel:restoreJobs:ListRestoreJobsResponse', listRestoreJobsResponse_restoreJobs - An array of objects that contain detailed information about jobs to restore saved resources.

$sel:httpStatus:ListRestoreJobsResponse', listRestoreJobsResponse_httpStatus - The response's http status code.

Response Lenses

listRestoreJobsResponse_nextToken :: Lens' ListRestoreJobsResponse (Maybe Text) Source #

The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

listRestoreJobsResponse_restoreJobs :: Lens' ListRestoreJobsResponse (Maybe [RestoreJobsListMember]) Source #

An array of objects that contain detailed information about jobs to restore saved resources.

listRestoreJobsResponse_httpStatus :: Lens' ListRestoreJobsResponse Int Source #

The response's http status code.