delete_job
(**kwargs)¶Deletes a job for a branch of an Amplify app.
See also: AWS API Documentation
Request Syntax
response = client.delete_job(
appId='string',
branchName='string',
jobId='string'
)
[REQUIRED]
The unique ID for an Amplify app.
[REQUIRED]
The name for the branch, for the job.
[REQUIRED]
The unique ID for the job.
dict
Response Syntax
{
'jobSummary': {
'jobArn': 'string',
'jobId': 'string',
'commitId': 'string',
'commitMessage': 'string',
'commitTime': datetime(2015, 1, 1),
'startTime': datetime(2015, 1, 1),
'status': 'PENDING'|'PROVISIONING'|'RUNNING'|'FAILED'|'SUCCEED'|'CANCELLING'|'CANCELLED',
'endTime': datetime(2015, 1, 1),
'jobType': 'RELEASE'|'RETRY'|'MANUAL'|'WEB_HOOK'
}
}
Response Structure
(dict) --
The result structure for the delete job request.
jobSummary (dict) --
Describes the summary for an execution job for an Amplify app.
jobArn (string) --
The Amazon Resource Name (ARN) for the job.
jobId (string) --
The unique ID for the job.
commitId (string) --
The commit ID from a third-party repository provider for the job.
commitMessage (string) --
The commit message from a third-party repository provider for the job.
commitTime (datetime) --
The commit date and time for the job.
startTime (datetime) --
The start date and time for the job.
status (string) --
The current status for the job.
endTime (datetime) --
The end date and time for the job.
jobType (string) --
The type for the job. If the value is RELEASE
, the job was manually released from its source by using the StartJob
API. If the value is RETRY
, the job was manually retried using the StartJob
API. If the value is WEB_HOOK
, the job was automatically triggered by webhooks.
Exceptions
Amplify.Client.exceptions.BadRequestException
Amplify.Client.exceptions.UnauthorizedException
Amplify.Client.exceptions.InternalFailureException
Amplify.Client.exceptions.NotFoundException
Amplify.Client.exceptions.LimitExceededException