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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns details about your report jobs.

Synopsis

data ListReportJobs = ListReportJobs' {
- byStatus :: Maybe Text
- byReportPlanName :: Maybe Text
- nextToken :: Maybe Text
- byCreationBefore :: Maybe POSIX
- byCreationAfter :: Maybe POSIX
- maxResults :: Maybe Natural
}
newListReportJobs :: ListReportJobs
listReportJobs_byStatus :: Lens' ListReportJobs (Maybe Text)
listReportJobs_byReportPlanName :: Lens' ListReportJobs (Maybe Text)
listReportJobs_nextToken :: Lens' ListReportJobs (Maybe Text)
listReportJobs_byCreationBefore :: Lens' ListReportJobs (Maybe UTCTime)
listReportJobs_byCreationAfter :: Lens' ListReportJobs (Maybe UTCTime)
listReportJobs_maxResults :: Lens' ListReportJobs (Maybe Natural)
data ListReportJobsResponse = ListReportJobsResponse' {
- reportJobs :: Maybe [ReportJob]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListReportJobsResponse :: Int -> ListReportJobsResponse
listReportJobsResponse_reportJobs :: Lens' ListReportJobsResponse (Maybe [ReportJob])
listReportJobsResponse_nextToken :: Lens' ListReportJobsResponse (Maybe Text)
listReportJobsResponse_httpStatus :: Lens' ListReportJobsResponse Int

Creating a Request

data ListReportJobs Source #

See: newListReportJobs smart constructor.

Constructors

ListReportJobs'

Fields

byStatus :: Maybe Text
Returns only report jobs that are in the specified status. The statuses are:
```
CREATED | RUNNING | COMPLETED | FAILED
```
byReportPlanName :: Maybe Text
Returns only report jobs with the specified report plan name.
nextToken :: Maybe Text
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
byCreationBefore :: Maybe POSIX
Returns only report jobs that were created before the date and time specified in Unix format and Coordinated Universal Time (UTC). For example, the value 1516925490 represents Friday, January 26, 2018 12:11:30 AM.
byCreationAfter :: Maybe POSIX
Returns only report jobs that were created after the date and time specified in Unix format and Coordinated Universal Time (UTC). For example, the value 1516925490 represents Friday, January 26, 2018 12:11:30 AM.
maxResults :: Maybe Natural
The number of desired results from 1 to 1000. Optional. If unspecified, the query will return 1 MB of data.

Instances

Instances details

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

newListReportJobs :: ListReportJobs Source #

Create a value of ListReportJobs 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:byStatus:ListReportJobs', listReportJobs_byStatus - Returns only report jobs that are in the specified status. The statuses are:

CREATED | RUNNING | COMPLETED | FAILED

$sel:byReportPlanName:ListReportJobs', listReportJobs_byReportPlanName - Returns only report jobs with the specified report plan name.

$sel:nextToken:ListReportJobs', listReportJobs_nextToken - An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

$sel:byCreationBefore:ListReportJobs', listReportJobs_byCreationBefore - Returns only report jobs that were created before the date and time specified in Unix format and Coordinated Universal Time (UTC). For example, the value 1516925490 represents Friday, January 26, 2018 12:11:30 AM.

$sel:byCreationAfter:ListReportJobs', listReportJobs_byCreationAfter - Returns only report jobs that were created after the date and time specified in Unix format and Coordinated Universal Time (UTC). For example, the value 1516925490 represents Friday, January 26, 2018 12:11:30 AM.

$sel:maxResults:ListReportJobs', listReportJobs_maxResults - The number of desired results from 1 to 1000. Optional. If unspecified, the query will return 1 MB of data.

Request Lenses

listReportJobs_byStatus :: Lens' ListReportJobs (Maybe Text) Source #

Returns only report jobs that are in the specified status. The statuses are:

CREATED | RUNNING | COMPLETED | FAILED

listReportJobs_byReportPlanName :: Lens' ListReportJobs (Maybe Text) Source #

Returns only report jobs with the specified report plan name.

listReportJobs_nextToken :: Lens' ListReportJobs (Maybe Text) Source #

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

listReportJobs_byCreationBefore :: Lens' ListReportJobs (Maybe UTCTime) Source #

Returns only report jobs that were created before the date and time specified in Unix format and Coordinated Universal Time (UTC). For example, the value 1516925490 represents Friday, January 26, 2018 12:11:30 AM.

listReportJobs_byCreationAfter :: Lens' ListReportJobs (Maybe UTCTime) Source #

Returns only report jobs that were created after the date and time specified in Unix format and Coordinated Universal Time (UTC). For example, the value 1516925490 represents Friday, January 26, 2018 12:11:30 AM.

listReportJobs_maxResults :: Lens' ListReportJobs (Maybe Natural) Source #

The number of desired results from 1 to 1000. Optional. If unspecified, the query will return 1 MB of data.

Destructuring the Response

data ListReportJobsResponse Source #

See: newListReportJobsResponse smart constructor.

Constructors

ListReportJobsResponse'
Fields reportJobs :: Maybe [ReportJob] Details about your report jobs in JSON format. nextToken :: Maybe Text An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newListReportJobsResponse Source #

Arguments

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

Create a value of ListReportJobsResponse 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:reportJobs:ListReportJobsResponse', listReportJobsResponse_reportJobs - Details about your report jobs in JSON format.

$sel:nextToken:ListReportJobs', listReportJobsResponse_nextToken - An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

$sel:httpStatus:ListReportJobsResponse', listReportJobsResponse_httpStatus - The response's http status code.

Response Lenses

listReportJobsResponse_reportJobs :: Lens' ListReportJobsResponse (Maybe [ReportJob]) Source #

Details about your report jobs in JSON format.

listReportJobsResponse_nextToken :: Lens' ListReportJobsResponse (Maybe Text) Source #

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

listReportJobsResponse_httpStatus :: Lens' ListReportJobsResponse Int Source #

The response's http status code.