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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns details about your report jobs.

Synopsis

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

Creating a Request

data ListReportJobs Source #

See: newListReportJobs smart constructor.

Constructors

ListReportJobs'

Fields

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.
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.
byReportPlanName :: Maybe Text
Returns only report jobs with the specified report plan name.
byStatus :: Maybe Text
Returns only report jobs that are in the specified status. The statuses are:
```
CREATED | RUNNING | COMPLETED | FAILED
```
maxResults :: Maybe Natural
The number of desired results from 1 to 1000. Optional. If unspecified, the query will return 1 MB of data.
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.

Instances

Instances details

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 #
AWSRequest ListReportJobs Source #
Instance details Defined in Amazonka.Backup.ListReportJobs Associated Types type AWSResponse ListReportJobs # Methods request :: (Service -> Service) -> ListReportJobs -> Request ListReportJobs # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListReportJobs -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListReportJobs))) #
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 #
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 #
NFData ListReportJobs Source #
Instance details Defined in Amazonka.Backup.ListReportJobs Methods rnf :: ListReportJobs -> () #
Eq ListReportJobs Source #
Instance details Defined in Amazonka.Backup.ListReportJobs Methods (==) :: ListReportJobs -> ListReportJobs -> Bool # (/=) :: ListReportJobs -> ListReportJobs -> Bool #
Hashable ListReportJobs Source #
Instance details Defined in Amazonka.Backup.ListReportJobs Methods hashWithSalt :: Int -> ListReportJobs -> Int # hash :: ListReportJobs -> Int #
type AWSResponse ListReportJobs Source #
Instance details Defined in Amazonka.Backup.ListReportJobs type AWSResponse ListReportJobs = ListReportJobsResponse
type Rep ListReportJobs Source #
Instance details Defined in Amazonka.Backup.ListReportJobs type Rep ListReportJobs = D1 ('MetaData "ListReportJobs" "Amazonka.Backup.ListReportJobs" "amazonka-backup-2.0-LovIt41tphM6jvgQJhTyRf" 'False) (C1 ('MetaCons "ListReportJobs'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "byCreationAfter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "byCreationBefore") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "byReportPlanName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "byStatus") '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))))))

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: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: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:byReportPlanName:ListReportJobs', listReportJobs_byReportPlanName - Returns only report jobs with the specified report plan name.

$sel:byStatus:ListReportJobs', listReportJobs_byStatus - Returns only report jobs that are in the specified status. The statuses are:

CREATED | RUNNING | COMPLETED | FAILED

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

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.

Request Lenses

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_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_byReportPlanName :: Lens' ListReportJobs (Maybe Text) Source #

Returns only report jobs with the specified report plan name.

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

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.

Destructuring the Response

data ListReportJobsResponse Source #

See: newListReportJobsResponse smart constructor.

Constructors

ListReportJobsResponse'
Fields 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. reportJobs :: Maybe [ReportJob] Details about your report jobs in JSON format. httpStatus :: Int The response's http status code.

Instances

Instances details

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 #
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 #
NFData ListReportJobsResponse Source #
Instance details Defined in Amazonka.Backup.ListReportJobs Methods rnf :: ListReportJobsResponse -> () #
Eq ListReportJobsResponse Source #
Instance details Defined in Amazonka.Backup.ListReportJobs Methods (==) :: ListReportJobsResponse -> ListReportJobsResponse -> Bool # (/=) :: ListReportJobsResponse -> ListReportJobsResponse -> Bool #
type Rep ListReportJobsResponse Source #
Instance details Defined in Amazonka.Backup.ListReportJobs type Rep ListReportJobsResponse = D1 ('MetaData "ListReportJobsResponse" "Amazonka.Backup.ListReportJobs" "amazonka-backup-2.0-LovIt41tphM6jvgQJhTyRf" 'False) (C1 ('MetaCons "ListReportJobsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "reportJobs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ReportJob])) :: 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:

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

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

Response Lenses

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_reportJobs :: Lens' ListReportJobsResponse (Maybe [ReportJob]) Source #

Details about your report jobs in JSON format.

listReportJobsResponse_httpStatus :: Lens' ListReportJobsResponse Int Source #

The response's http status code.