Amazonka.Amplify.StopJob

Stops a job that is in progress for a branch of an Amplify app.

Creating a Request

data StopJob

The request structure for the stop job request.

See: newStopJob smart constructor.

Constructors

StopJob'

Fields

• appId :: Text

  The unique ID for an Amplify app.

• branchName :: Text

  The name for the branch, for the job.

• jobId :: Text

  The unique id for the job.

Instances

ToHeaders StopJob

Defined in Amazonka.Amplify.StopJob

Methods

toHeaders :: StopJob -> [Header]

ToPath StopJob

Defined in Amazonka.Amplify.StopJob

Methods

toPath :: StopJob -> ByteString

ToQuery StopJob

Defined in Amazonka.Amplify.StopJob

Methods

toQuery :: StopJob -> QueryString

AWSRequest StopJob

Defined in Amazonka.Amplify.StopJob

Associated Types

type AWSResponse StopJob

Methods

request :: (Service -> Service) -> StopJob -> Request StopJob

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy StopJob -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StopJob)))

Generic StopJob

Defined in Amazonka.Amplify.StopJob

Associated Types

type Rep StopJob :: Type -> Type

Methods

from :: StopJob -> Rep StopJob x

to :: Rep StopJob x -> StopJob

Read StopJob

Defined in Amazonka.Amplify.StopJob

Methods

readsPrec :: Int -> ReadS StopJob

readList :: ReadS [StopJob]

readPrec :: ReadPrec StopJob

readListPrec :: ReadPrec [StopJob]

Show StopJob

Defined in Amazonka.Amplify.StopJob

Methods

showsPrec :: Int -> StopJob -> ShowS

show :: StopJob -> String

showList :: [StopJob] -> ShowS

NFData StopJob

Defined in Amazonka.Amplify.StopJob

Methods

rnf :: StopJob -> ()

Eq StopJob

Defined in Amazonka.Amplify.StopJob

Methods

(==) :: StopJob -> StopJob -> Bool

(/=) :: StopJob -> StopJob -> Bool

Hashable StopJob

Defined in Amazonka.Amplify.StopJob

Methods

hashWithSalt :: Int -> StopJob -> Int

hash :: StopJob -> Int

type AWSResponse StopJob

Defined in Amazonka.Amplify.StopJob

type AWSResponse StopJob = StopJobResponse

type Rep StopJob

Defined in Amazonka.Amplify.StopJob

type Rep StopJob = D1 ('MetaData "StopJob" "Amazonka.Amplify.StopJob" "amazonka-amplify-2.0-FzmP32buJCeA4C8B1HzWt" 'False) (C1 ('MetaCons "StopJob'" 'PrefixI 'True) (S1 ('MetaSel ('Just "appId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "branchName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newStopJob

Arguments

:: Text

StopJob

-> Text

StopJob

-> Text

StopJob

-> StopJob

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

StopJob, stopJob_appId - The unique ID for an Amplify app.

StopJob, stopJob_branchName - The name for the branch, for the job.

StopJob, stopJob_jobId - The unique id for the job.

Request Lenses

stopJob_appId :: Lens' StopJob Text

The unique ID for an Amplify app.

stopJob_branchName :: Lens' StopJob Text

The name for the branch, for the job.

stopJob_jobId :: Lens' StopJob Text

The unique id for the job.

Destructuring the Response

data StopJobResponse

The result structure for the stop job request.

See: newStopJobResponse smart constructor.

Constructors

StopJobResponse'

Fields

• httpStatus :: Int

  The response's http status code.

• jobSummary :: JobSummary

  The summary for the job.

Instances

Generic StopJobResponse

Defined in Amazonka.Amplify.StopJob

Associated Types

type Rep StopJobResponse :: Type -> Type

Methods

from :: StopJobResponse -> Rep StopJobResponse x

to :: Rep StopJobResponse x -> StopJobResponse

Read StopJobResponse

Defined in Amazonka.Amplify.StopJob

Methods

readsPrec :: Int -> ReadS StopJobResponse

readList :: ReadS [StopJobResponse]

readPrec :: ReadPrec StopJobResponse

readListPrec :: ReadPrec [StopJobResponse]

Show StopJobResponse

Defined in Amazonka.Amplify.StopJob

Methods

showsPrec :: Int -> StopJobResponse -> ShowS

show :: StopJobResponse -> String

showList :: [StopJobResponse] -> ShowS

NFData StopJobResponse

Defined in Amazonka.Amplify.StopJob

Methods

rnf :: StopJobResponse -> ()

Eq StopJobResponse

Defined in Amazonka.Amplify.StopJob

Methods

(==) :: StopJobResponse -> StopJobResponse -> Bool

(/=) :: StopJobResponse -> StopJobResponse -> Bool

type Rep StopJobResponse

Defined in Amazonka.Amplify.StopJob

type Rep StopJobResponse = D1 ('MetaData "StopJobResponse" "Amazonka.Amplify.StopJob" "amazonka-amplify-2.0-FzmP32buJCeA4C8B1HzWt" 'False) (C1 ('MetaCons "StopJobResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "jobSummary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 JobSummary)))

newStopJobResponse

Arguments

:: Int

$sel:httpStatus:StopJobResponse'

-> JobSummary

$sel:jobSummary:StopJobResponse'

-> StopJobResponse

Create a value of StopJobResponse 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:httpStatus:StopJobResponse', stopJobResponse_httpStatus - The response's http status code.

$sel:jobSummary:StopJobResponse', stopJobResponse_jobSummary - The summary for the job.

Response Lenses

stopJobResponse_httpStatus :: Lens' StopJobResponse Int

The response's http status code.

stopJobResponse_jobSummary :: Lens' StopJobResponse JobSummary

The summary for the job.