JobSummary - Amplify

JobSummary

Describes the summary for an execution job for an Amplify app.

Contents

commitId

The commit ID from a third-party repository provider for the job.

Type: String

Length Constraints: Maximum length of 255.

Pattern: (?s).*

Required: Yes

commitMessage

The commit message from a third-party repository provider for the job.

Type: String

Length Constraints: Maximum length of 10000.

Pattern: (?s).*

Required: Yes

commitTime

The commit date and time for the job.

Type: Timestamp

Required: Yes

jobArn

The Amazon Resource Name (ARN) for the job.

Type: String

Length Constraints: Maximum length of 1000.

Required: Yes

jobId

The unique ID for the job.

Type: String

Length Constraints: Maximum length of 255.

Pattern: [0-9]+

Required: Yes

jobType

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.

Type: String

Length Constraints: Maximum length of 10.

Valid Values: RELEASE | RETRY | MANUAL | WEB_HOOK

Required: Yes

startTime

The start date and time for the job.

Type: Timestamp

Required: Yes

status

The current status for the job.

Type: String

Valid Values: PENDING | PROVISIONING | RUNNING | FAILED | SUCCEED | CANCELLING | CANCELLED

Required: Yes

endTime

The end date and time for the job.

Type: Timestamp

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: