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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates a specific job.

Synopsis

data UpdateBackendJob = UpdateBackendJob' {
- operation :: Maybe Text
- status :: Maybe Text
- appId :: Text
- backendEnvironmentName :: Text
- jobId :: Text
}
newUpdateBackendJob :: Text -> Text -> Text -> UpdateBackendJob
updateBackendJob_operation :: Lens' UpdateBackendJob (Maybe Text)
updateBackendJob_status :: Lens' UpdateBackendJob (Maybe Text)
updateBackendJob_appId :: Lens' UpdateBackendJob Text
updateBackendJob_backendEnvironmentName :: Lens' UpdateBackendJob Text
updateBackendJob_jobId :: Lens' UpdateBackendJob Text
data UpdateBackendJobResponse = UpdateBackendJobResponse' {
- 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
}
newUpdateBackendJobResponse :: Int -> UpdateBackendJobResponse
updateBackendJobResponse_appId :: Lens' UpdateBackendJobResponse (Maybe Text)
updateBackendJobResponse_backendEnvironmentName :: Lens' UpdateBackendJobResponse (Maybe Text)
updateBackendJobResponse_createTime :: Lens' UpdateBackendJobResponse (Maybe Text)
updateBackendJobResponse_error :: Lens' UpdateBackendJobResponse (Maybe Text)
updateBackendJobResponse_jobId :: Lens' UpdateBackendJobResponse (Maybe Text)
updateBackendJobResponse_operation :: Lens' UpdateBackendJobResponse (Maybe Text)
updateBackendJobResponse_status :: Lens' UpdateBackendJobResponse (Maybe Text)
updateBackendJobResponse_updateTime :: Lens' UpdateBackendJobResponse (Maybe Text)
updateBackendJobResponse_httpStatus :: Lens' UpdateBackendJobResponse Int

Creating a Request

data UpdateBackendJob Source #

The request body for GetBackendJob.

See: newUpdateBackendJob smart constructor.

Constructors

UpdateBackendJob'
Fields 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. jobId :: Text The ID for the job.

Instances

Instances details

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

newUpdateBackendJob Source #

Arguments

:: Text	`UpdateBackendJob`
-> Text	`UpdateBackendJob`
-> Text	`UpdateBackendJob`
-> UpdateBackendJob

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

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

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

UpdateBackendJob, updateBackendJob_appId - The app ID.

UpdateBackendJob, updateBackendJob_backendEnvironmentName - The name of the backend environment.

UpdateBackendJob, updateBackendJob_jobId - The ID for the job.

Request Lenses

updateBackendJob_operation :: Lens' UpdateBackendJob (Maybe Text) Source #

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

updateBackendJob_status :: Lens' UpdateBackendJob (Maybe Text) Source #

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

updateBackendJob_appId :: Lens' UpdateBackendJob Text Source #

The app ID.

updateBackendJob_backendEnvironmentName :: Lens' UpdateBackendJob Text Source #

The name of the backend environment.

updateBackendJob_jobId :: Lens' UpdateBackendJob Text Source #

The ID for the job.

Destructuring the Response

data UpdateBackendJobResponse Source #

See: newUpdateBackendJobResponse smart constructor.

Constructors

UpdateBackendJobResponse'

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 UpdateBackendJobResponse Source #
Instance details Defined in Amazonka.AmplifyBackend.UpdateBackendJob Associated Types type Rep UpdateBackendJobResponse :: Type -> Type # Methods from :: UpdateBackendJobResponse -> Rep UpdateBackendJobResponse x # to :: Rep UpdateBackendJobResponse x -> UpdateBackendJobResponse #
Read UpdateBackendJobResponse Source #
Instance details Defined in Amazonka.AmplifyBackend.UpdateBackendJob Methods readsPrec :: Int -> ReadS UpdateBackendJobResponse # readList :: ReadS [UpdateBackendJobResponse] # readPrec :: ReadPrec UpdateBackendJobResponse # readListPrec :: ReadPrec [UpdateBackendJobResponse] #
Show UpdateBackendJobResponse Source #
Instance details Defined in Amazonka.AmplifyBackend.UpdateBackendJob Methods showsPrec :: Int -> UpdateBackendJobResponse -> ShowS # show :: UpdateBackendJobResponse -> String # showList :: [UpdateBackendJobResponse] -> ShowS #
NFData UpdateBackendJobResponse Source #
Instance details Defined in Amazonka.AmplifyBackend.UpdateBackendJob Methods rnf :: UpdateBackendJobResponse -> () #
Eq UpdateBackendJobResponse Source #
Instance details Defined in Amazonka.AmplifyBackend.UpdateBackendJob Methods (==) :: UpdateBackendJobResponse -> UpdateBackendJobResponse -> Bool # (/=) :: UpdateBackendJobResponse -> UpdateBackendJobResponse -> Bool #
type Rep UpdateBackendJobResponse Source #
Instance details Defined in Amazonka.AmplifyBackend.UpdateBackendJob type Rep UpdateBackendJobResponse = D1 ('MetaData "UpdateBackendJobResponse" "Amazonka.AmplifyBackend.UpdateBackendJob" "amazonka-amplifybackend-2.0-KAbme26dIsGHSomQ2pZcRc" 'False) (C1 ('MetaCons "UpdateBackendJobResponse'" '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))))))

newUpdateBackendJobResponse Source #

Arguments

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

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

UpdateBackendJob, updateBackendJobResponse_appId - The app ID.

UpdateBackendJob, updateBackendJobResponse_backendEnvironmentName - The name of the backend environment.

UpdateBackendJobResponse, updateBackendJobResponse_createTime - The time when the job was created.

UpdateBackendJobResponse, updateBackendJobResponse_error - If the request fails, this error is returned.

UpdateBackendJob, updateBackendJobResponse_jobId - The ID for the job.

UpdateBackendJob, updateBackendJobResponse_operation - The name of the operation.

UpdateBackendJob, updateBackendJobResponse_status - The current status of the request.

UpdateBackendJobResponse, updateBackendJobResponse_updateTime - The time when the job was last updated.

$sel:httpStatus:UpdateBackendJobResponse', updateBackendJobResponse_httpStatus - The response's http status code.

Response Lenses

updateBackendJobResponse_appId :: Lens' UpdateBackendJobResponse (Maybe Text) Source #

The app ID.

updateBackendJobResponse_backendEnvironmentName :: Lens' UpdateBackendJobResponse (Maybe Text) Source #

The name of the backend environment.

updateBackendJobResponse_createTime :: Lens' UpdateBackendJobResponse (Maybe Text) Source #

The time when the job was created.

updateBackendJobResponse_error :: Lens' UpdateBackendJobResponse (Maybe Text) Source #

If the request fails, this error is returned.

updateBackendJobResponse_jobId :: Lens' UpdateBackendJobResponse (Maybe Text) Source #

The ID for the job.

updateBackendJobResponse_operation :: Lens' UpdateBackendJobResponse (Maybe Text) Source #

The name of the operation.

updateBackendJobResponse_status :: Lens' UpdateBackendJobResponse (Maybe Text) Source #

The current status of the request.

updateBackendJobResponse_updateTime :: Lens' UpdateBackendJobResponse (Maybe Text) Source #

The time when the job was last updated.

updateBackendJobResponse_httpStatus :: Lens' UpdateBackendJobResponse Int Source #

The response's http status code.