Amazonka.Backup.ListRestoreJobs

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

This operation returns paginated results.

Creating a Request

data ListRestoreJobs

See: newListRestoreJobs smart constructor.

Constructors

ListRestoreJobs'

Fields

• byAccountId :: Maybe Text

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

• byCompleteAfter :: Maybe POSIX

  Returns only copy jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).

• byCompleteBefore :: Maybe POSIX

  Returns only copy jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).

• byCreatedAfter :: Maybe POSIX

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

• byCreatedBefore :: Maybe POSIX

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

• byStatus :: Maybe RestoreJobStatus

  Returns only restore jobs associated with the specified job status.

• maxResults :: Maybe Natural

  The maximum number of items to be returned.

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

Instances

ToHeaders ListRestoreJobs

Defined in Amazonka.Backup.ListRestoreJobs

Methods

toHeaders :: ListRestoreJobs -> [Header]

ToPath ListRestoreJobs

Defined in Amazonka.Backup.ListRestoreJobs

Methods

toPath :: ListRestoreJobs -> ByteString

ToQuery ListRestoreJobs

Defined in Amazonka.Backup.ListRestoreJobs

Methods

toQuery :: ListRestoreJobs -> QueryString

AWSPager ListRestoreJobs

Defined in Amazonka.Backup.ListRestoreJobs

Methods

page :: ListRestoreJobs -> AWSResponse ListRestoreJobs -> Maybe ListRestoreJobs

AWSRequest ListRestoreJobs

Defined in Amazonka.Backup.ListRestoreJobs

Associated Types

type AWSResponse ListRestoreJobs

Methods

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

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

Generic ListRestoreJobs

Defined in Amazonka.Backup.ListRestoreJobs

Associated Types

type Rep ListRestoreJobs :: Type -> Type

Methods

from :: ListRestoreJobs -> Rep ListRestoreJobs x

to :: Rep ListRestoreJobs x -> ListRestoreJobs

Read ListRestoreJobs

Defined in Amazonka.Backup.ListRestoreJobs

Methods

readsPrec :: Int -> ReadS ListRestoreJobs

readList :: ReadS [ListRestoreJobs]

readPrec :: ReadPrec ListRestoreJobs

readListPrec :: ReadPrec [ListRestoreJobs]

Show ListRestoreJobs

Defined in Amazonka.Backup.ListRestoreJobs

Methods

showsPrec :: Int -> ListRestoreJobs -> ShowS

show :: ListRestoreJobs -> String

showList :: [ListRestoreJobs] -> ShowS

NFData ListRestoreJobs

Defined in Amazonka.Backup.ListRestoreJobs

Methods

rnf :: ListRestoreJobs -> ()

Eq ListRestoreJobs

Defined in Amazonka.Backup.ListRestoreJobs

Methods

(==) :: ListRestoreJobs -> ListRestoreJobs -> Bool

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

Hashable ListRestoreJobs

Defined in Amazonka.Backup.ListRestoreJobs

Methods

hashWithSalt :: Int -> ListRestoreJobs -> Int

hash :: ListRestoreJobs -> Int

type AWSResponse ListRestoreJobs

Defined in Amazonka.Backup.ListRestoreJobs

type AWSResponse ListRestoreJobs = ListRestoreJobsResponse

type Rep ListRestoreJobs

Defined in Amazonka.Backup.ListRestoreJobs

type Rep ListRestoreJobs = D1 ('MetaData "ListRestoreJobs" "Amazonka.Backup.ListRestoreJobs" "amazonka-backup-2.0-LovIt41tphM6jvgQJhTyRf" 'False) (C1 ('MetaCons "ListRestoreJobs'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "byAccountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "byCompleteAfter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "byCompleteBefore") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "byCreatedAfter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :*: ((S1 ('MetaSel ('Just "byCreatedBefore") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "byStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RestoreJobStatus))) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newListRestoreJobs :: ListRestoreJobs

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:byAccountId:ListRestoreJobs', listRestoreJobs_byAccountId - The account ID to list the jobs from. Returns only restore jobs associated with the specified account ID.

$sel:byCompleteAfter:ListRestoreJobs', listRestoreJobs_byCompleteAfter - Returns only copy jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).

$sel:byCompleteBefore:ListRestoreJobs', listRestoreJobs_byCompleteBefore - Returns only copy jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).

$sel:byCreatedAfter:ListRestoreJobs', listRestoreJobs_byCreatedAfter - Returns only restore jobs that were created after the specified date.

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

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

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

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.

Request Lenses

listRestoreJobs_byAccountId :: Lens' ListRestoreJobs (Maybe Text)

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

listRestoreJobs_byCompleteAfter :: Lens' ListRestoreJobs (Maybe UTCTime)

Returns only copy jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).

listRestoreJobs_byCompleteBefore :: Lens' ListRestoreJobs (Maybe UTCTime)

Returns only copy jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).

listRestoreJobs_byCreatedAfter :: Lens' ListRestoreJobs (Maybe UTCTime)

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

listRestoreJobs_byCreatedBefore :: Lens' ListRestoreJobs (Maybe UTCTime)

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

listRestoreJobs_byStatus :: Lens' ListRestoreJobs (Maybe RestoreJobStatus)

Returns only restore jobs associated with the specified job status.

listRestoreJobs_maxResults :: Lens' ListRestoreJobs (Maybe Natural)

The maximum number of items to be returned.

listRestoreJobs_nextToken :: Lens' ListRestoreJobs (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.

Destructuring the Response

data ListRestoreJobsResponse

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

Generic ListRestoreJobsResponse

Defined in Amazonka.Backup.ListRestoreJobs

Associated Types

type Rep ListRestoreJobsResponse :: Type -> Type

Methods

from :: ListRestoreJobsResponse -> Rep ListRestoreJobsResponse x

to :: Rep ListRestoreJobsResponse x -> ListRestoreJobsResponse

Read ListRestoreJobsResponse

Defined in Amazonka.Backup.ListRestoreJobs

Methods

readsPrec :: Int -> ReadS ListRestoreJobsResponse

readList :: ReadS [ListRestoreJobsResponse]

readPrec :: ReadPrec ListRestoreJobsResponse

readListPrec :: ReadPrec [ListRestoreJobsResponse]

Show ListRestoreJobsResponse

Defined in Amazonka.Backup.ListRestoreJobs

Methods

showsPrec :: Int -> ListRestoreJobsResponse -> ShowS

show :: ListRestoreJobsResponse -> String

showList :: [ListRestoreJobsResponse] -> ShowS

NFData ListRestoreJobsResponse

Defined in Amazonka.Backup.ListRestoreJobs

Methods

rnf :: ListRestoreJobsResponse -> ()

Eq ListRestoreJobsResponse

Defined in Amazonka.Backup.ListRestoreJobs

Methods

(==) :: ListRestoreJobsResponse -> ListRestoreJobsResponse -> Bool

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

type Rep ListRestoreJobsResponse

Defined in Amazonka.Backup.ListRestoreJobs

type Rep ListRestoreJobsResponse = D1 ('MetaData "ListRestoreJobsResponse" "Amazonka.Backup.ListRestoreJobs" "amazonka-backup-2.0-LovIt41tphM6jvgQJhTyRf" '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

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:

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)

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

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

listRestoreJobsResponse_httpStatus :: Lens' ListRestoreJobsResponse Int

The response's http status code.