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.AmplifyBackend.ListBackendJobs

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the jobs for the backend of an Amplify app.

This operation returns paginated results.

Synopsis

data ListBackendJobs = ListBackendJobs' {
- jobId :: Maybe Text
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- operation :: Maybe Text
- status :: Maybe Text
- appId :: Text
- backendEnvironmentName :: Text
}
newListBackendJobs :: Text -> Text -> ListBackendJobs
listBackendJobs_jobId :: Lens' ListBackendJobs (Maybe Text)
listBackendJobs_maxResults :: Lens' ListBackendJobs (Maybe Natural)
listBackendJobs_nextToken :: Lens' ListBackendJobs (Maybe Text)
listBackendJobs_operation :: Lens' ListBackendJobs (Maybe Text)
listBackendJobs_status :: Lens' ListBackendJobs (Maybe Text)
listBackendJobs_appId :: Lens' ListBackendJobs Text
listBackendJobs_backendEnvironmentName :: Lens' ListBackendJobs Text
data ListBackendJobsResponse = ListBackendJobsResponse' {
- jobs :: Maybe [BackendJobRespObj]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListBackendJobsResponse :: Int -> ListBackendJobsResponse
listBackendJobsResponse_jobs :: Lens' ListBackendJobsResponse (Maybe [BackendJobRespObj])
listBackendJobsResponse_nextToken :: Lens' ListBackendJobsResponse (Maybe Text)
listBackendJobsResponse_httpStatus :: Lens' ListBackendJobsResponse Int

Creating a Request

data ListBackendJobs Source #

The request body for ListBackendJobs.

See: newListBackendJobs smart constructor.

Constructors

ListBackendJobs'

Fields

jobId :: Maybe Text
The ID for the job.
maxResults :: Maybe Natural
The maximum number of results that you want in the response.
nextToken :: Maybe Text
The token for the next set of results.
operation :: Maybe Text
Filters the list of response objects to include only those with the specified operation name.
status :: Maybe Text
Filters the list of response objects to include only those with the specified status.
appId :: Text
The app ID.
backendEnvironmentName :: Text
The name of the backend environment.

Instances

Instances details

ToJSON ListBackendJobs Source #
Instance details Defined in Amazonka.AmplifyBackend.ListBackendJobs Methods toJSON :: ListBackendJobs -> Value # toEncoding :: ListBackendJobs -> Encoding # toJSONList :: [ListBackendJobs] -> Value # toEncodingList :: [ListBackendJobs] -> Encoding #
ToHeaders ListBackendJobs Source #
Instance details Defined in Amazonka.AmplifyBackend.ListBackendJobs Methods toHeaders :: ListBackendJobs -> [Header] #
ToPath ListBackendJobs Source #
Instance details Defined in Amazonka.AmplifyBackend.ListBackendJobs Methods toPath :: ListBackendJobs -> ByteString #
ToQuery ListBackendJobs Source #
Instance details Defined in Amazonka.AmplifyBackend.ListBackendJobs Methods toQuery :: ListBackendJobs -> QueryString #
AWSPager ListBackendJobs Source #
Instance details Defined in Amazonka.AmplifyBackend.ListBackendJobs Methods page :: ListBackendJobs -> AWSResponse ListBackendJobs -> Maybe ListBackendJobs #
AWSRequest ListBackendJobs Source #
Instance details Defined in Amazonka.AmplifyBackend.ListBackendJobs Associated Types type AWSResponse ListBackendJobs # Methods request :: (Service -> Service) -> ListBackendJobs -> Request ListBackendJobs # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListBackendJobs -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListBackendJobs))) #
Generic ListBackendJobs Source #
Instance details Defined in Amazonka.AmplifyBackend.ListBackendJobs Associated Types type Rep ListBackendJobs :: Type -> Type # Methods from :: ListBackendJobs -> Rep ListBackendJobs x # to :: Rep ListBackendJobs x -> ListBackendJobs #
Read ListBackendJobs Source #
Instance details Defined in Amazonka.AmplifyBackend.ListBackendJobs Methods readsPrec :: Int -> ReadS ListBackendJobs # readList :: ReadS [ListBackendJobs] # readPrec :: ReadPrec ListBackendJobs # readListPrec :: ReadPrec [ListBackendJobs] #
Show ListBackendJobs Source #
Instance details Defined in Amazonka.AmplifyBackend.ListBackendJobs Methods showsPrec :: Int -> ListBackendJobs -> ShowS # show :: ListBackendJobs -> String # showList :: [ListBackendJobs] -> ShowS #
NFData ListBackendJobs Source #
Instance details Defined in Amazonka.AmplifyBackend.ListBackendJobs Methods rnf :: ListBackendJobs -> () #
Eq ListBackendJobs Source #
Instance details Defined in Amazonka.AmplifyBackend.ListBackendJobs Methods (==) :: ListBackendJobs -> ListBackendJobs -> Bool # (/=) :: ListBackendJobs -> ListBackendJobs -> Bool #
Hashable ListBackendJobs Source #
Instance details Defined in Amazonka.AmplifyBackend.ListBackendJobs Methods hashWithSalt :: Int -> ListBackendJobs -> Int # hash :: ListBackendJobs -> Int #
type AWSResponse ListBackendJobs Source #
Instance details Defined in Amazonka.AmplifyBackend.ListBackendJobs type AWSResponse ListBackendJobs = ListBackendJobsResponse
type Rep ListBackendJobs Source #
Instance details Defined in Amazonka.AmplifyBackend.ListBackendJobs type Rep ListBackendJobs = D1 ('MetaData "ListBackendJobs" "Amazonka.AmplifyBackend.ListBackendJobs" "amazonka-amplifybackend-2.0-KAbme26dIsGHSomQ2pZcRc" 'False) (C1 ('MetaCons "ListBackendJobs'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "jobId") '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 "operation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "appId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "backendEnvironmentName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newListBackendJobs Source #

Arguments

:: Text	`ListBackendJobs`
-> Text	`ListBackendJobs`
-> ListBackendJobs

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

ListBackendJobs, listBackendJobs_jobId - The ID for the job.

$sel:maxResults:ListBackendJobs', listBackendJobs_maxResults - The maximum number of results that you want in the response.

ListBackendJobs, listBackendJobs_nextToken - The token for the next set of results.

ListBackendJobs, listBackendJobs_operation - Filters the list of response objects to include only those with the specified operation name.

ListBackendJobs, listBackendJobs_status - Filters the list of response objects to include only those with the specified status.

ListBackendJobs, listBackendJobs_appId - The app ID.

ListBackendJobs, listBackendJobs_backendEnvironmentName - The name of the backend environment.

Request Lenses

listBackendJobs_jobId :: Lens' ListBackendJobs (Maybe Text) Source #

The ID for the job.

listBackendJobs_maxResults :: Lens' ListBackendJobs (Maybe Natural) Source #

The maximum number of results that you want in the response.

listBackendJobs_nextToken :: Lens' ListBackendJobs (Maybe Text) Source #

The token for the next set of results.

listBackendJobs_operation :: Lens' ListBackendJobs (Maybe Text) Source #

Filters the list of response objects to include only those with the specified operation name.

listBackendJobs_status :: Lens' ListBackendJobs (Maybe Text) Source #

Filters the list of response objects to include only those with the specified status.

listBackendJobs_appId :: Lens' ListBackendJobs Text Source #

The app ID.

listBackendJobs_backendEnvironmentName :: Lens' ListBackendJobs Text Source #

The name of the backend environment.

Destructuring the Response

data ListBackendJobsResponse Source #

See: newListBackendJobsResponse smart constructor.

Constructors

ListBackendJobsResponse'
Fields jobs :: Maybe [BackendJobRespObj] An array of jobs and their properties. nextToken :: Maybe Text The token for the next set of results. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newListBackendJobsResponse Source #

Arguments

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

Create a value of ListBackendJobsResponse 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:jobs:ListBackendJobsResponse', listBackendJobsResponse_jobs - An array of jobs and their properties.

ListBackendJobs, listBackendJobsResponse_nextToken - The token for the next set of results.

$sel:httpStatus:ListBackendJobsResponse', listBackendJobsResponse_httpStatus - The response's http status code.

Response Lenses

listBackendJobsResponse_jobs :: Lens' ListBackendJobsResponse (Maybe [BackendJobRespObj]) Source #

An array of jobs and their properties.

listBackendJobsResponse_nextToken :: Lens' ListBackendJobsResponse (Maybe Text) Source #

The token for the next set of results.

listBackendJobsResponse_httpStatus :: Lens' ListBackendJobsResponse Int Source #

The response's http status code.