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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns information about a specific job.

Synopsis

data GetBackendJob = GetBackendJob' {
- appId :: Text
- backendEnvironmentName :: Text
- jobId :: Text
}
newGetBackendJob :: Text -> Text -> Text -> GetBackendJob
getBackendJob_appId :: Lens' GetBackendJob Text
getBackendJob_backendEnvironmentName :: Lens' GetBackendJob Text
getBackendJob_jobId :: Lens' GetBackendJob Text
data GetBackendJobResponse = GetBackendJobResponse' {
- appId :: Maybe Text
- backendEnvironmentName :: Maybe Text
- createTime :: Maybe Text
- error :: Maybe Text
- jobId :: Maybe Text
- operation :: Maybe Text
- status :: Maybe Text
- updateTime :: Maybe Text
- httpStatus :: Int
}
newGetBackendJobResponse :: Int -> GetBackendJobResponse
getBackendJobResponse_appId :: Lens' GetBackendJobResponse (Maybe Text)
getBackendJobResponse_backendEnvironmentName :: Lens' GetBackendJobResponse (Maybe Text)
getBackendJobResponse_createTime :: Lens' GetBackendJobResponse (Maybe Text)
getBackendJobResponse_error :: Lens' GetBackendJobResponse (Maybe Text)
getBackendJobResponse_jobId :: Lens' GetBackendJobResponse (Maybe Text)
getBackendJobResponse_operation :: Lens' GetBackendJobResponse (Maybe Text)
getBackendJobResponse_status :: Lens' GetBackendJobResponse (Maybe Text)
getBackendJobResponse_updateTime :: Lens' GetBackendJobResponse (Maybe Text)
getBackendJobResponse_httpStatus :: Lens' GetBackendJobResponse Int

Creating a Request

data GetBackendJob Source #

See: newGetBackendJob smart constructor.

Constructors

GetBackendJob'
Fields appId :: Text The app ID. backendEnvironmentName :: Text The name of the backend environment. jobId :: Text The ID for the job.

Instances

Instances details

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

newGetBackendJob Source #

Arguments

:: Text	`GetBackendJob`
-> Text	`GetBackendJob`
-> Text	`GetBackendJob`
-> GetBackendJob

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

GetBackendJob, getBackendJob_appId - The app ID.

GetBackendJob, getBackendJob_backendEnvironmentName - The name of the backend environment.

GetBackendJob, getBackendJob_jobId - The ID for the job.

Request Lenses

getBackendJob_appId :: Lens' GetBackendJob Text Source #

The app ID.

getBackendJob_backendEnvironmentName :: Lens' GetBackendJob Text Source #

The name of the backend environment.

getBackendJob_jobId :: Lens' GetBackendJob Text Source #

The ID for the job.

Destructuring the Response

data GetBackendJobResponse Source #

See: newGetBackendJobResponse smart constructor.

Constructors

GetBackendJobResponse'

Fields

appId :: Maybe Text
The app ID.
backendEnvironmentName :: Maybe Text
The name of the backend environment.
createTime :: Maybe Text
The time when the job was created.
error :: Maybe Text
If the request fails, this error is returned.
jobId :: Maybe Text
The ID for the job.
operation :: Maybe Text
The name of the operation.
status :: Maybe Text
The current status of the request.
updateTime :: Maybe Text
The time when the job was last updated.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic GetBackendJobResponse Source #
Instance details Defined in Amazonka.AmplifyBackend.GetBackendJob Associated Types type Rep GetBackendJobResponse :: Type -> Type # Methods from :: GetBackendJobResponse -> Rep GetBackendJobResponse x # to :: Rep GetBackendJobResponse x -> GetBackendJobResponse #
Read GetBackendJobResponse Source #
Instance details Defined in Amazonka.AmplifyBackend.GetBackendJob Methods readsPrec :: Int -> ReadS GetBackendJobResponse # readList :: ReadS [GetBackendJobResponse] # readPrec :: ReadPrec GetBackendJobResponse # readListPrec :: ReadPrec [GetBackendJobResponse] #
Show GetBackendJobResponse Source #
Instance details Defined in Amazonka.AmplifyBackend.GetBackendJob Methods showsPrec :: Int -> GetBackendJobResponse -> ShowS # show :: GetBackendJobResponse -> String # showList :: [GetBackendJobResponse] -> ShowS #
NFData GetBackendJobResponse Source #
Instance details Defined in Amazonka.AmplifyBackend.GetBackendJob Methods rnf :: GetBackendJobResponse -> () #
Eq GetBackendJobResponse Source #
Instance details Defined in Amazonka.AmplifyBackend.GetBackendJob Methods (==) :: GetBackendJobResponse -> GetBackendJobResponse -> Bool # (/=) :: GetBackendJobResponse -> GetBackendJobResponse -> Bool #
type Rep GetBackendJobResponse Source #
Instance details Defined in Amazonka.AmplifyBackend.GetBackendJob type Rep GetBackendJobResponse = D1 ('MetaData "GetBackendJobResponse" "Amazonka.AmplifyBackend.GetBackendJob" "amazonka-amplifybackend-2.0-KAbme26dIsGHSomQ2pZcRc" 'False) (C1 ('MetaCons "GetBackendJobResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "appId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "backendEnvironmentName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "createTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "error") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "jobId") '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 "updateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newGetBackendJobResponse Source #

Arguments

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

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

GetBackendJob, getBackendJobResponse_appId - The app ID.

GetBackendJob, getBackendJobResponse_backendEnvironmentName - The name of the backend environment.

GetBackendJobResponse, getBackendJobResponse_createTime - The time when the job was created.

GetBackendJobResponse, getBackendJobResponse_error - If the request fails, this error is returned.

GetBackendJob, getBackendJobResponse_jobId - The ID for the job.

GetBackendJobResponse, getBackendJobResponse_operation - The name of the operation.

GetBackendJobResponse, getBackendJobResponse_status - The current status of the request.

GetBackendJobResponse, getBackendJobResponse_updateTime - The time when the job was last updated.

$sel:httpStatus:GetBackendJobResponse', getBackendJobResponse_httpStatus - The response's http status code.

Response Lenses

getBackendJobResponse_appId :: Lens' GetBackendJobResponse (Maybe Text) Source #

The app ID.

getBackendJobResponse_backendEnvironmentName :: Lens' GetBackendJobResponse (Maybe Text) Source #

The name of the backend environment.

getBackendJobResponse_createTime :: Lens' GetBackendJobResponse (Maybe Text) Source #

The time when the job was created.

getBackendJobResponse_error :: Lens' GetBackendJobResponse (Maybe Text) Source #

If the request fails, this error is returned.

getBackendJobResponse_jobId :: Lens' GetBackendJobResponse (Maybe Text) Source #

The ID for the job.

getBackendJobResponse_operation :: Lens' GetBackendJobResponse (Maybe Text) Source #

The name of the operation.

getBackendJobResponse_status :: Lens' GetBackendJobResponse (Maybe Text) Source #

The current status of the request.

getBackendJobResponse_updateTime :: Lens' GetBackendJobResponse (Maybe Text) Source #

The time when the job was last updated.

getBackendJobResponse_httpStatus :: Lens' GetBackendJobResponse Int Source #

The response's http status code.