View a markdown version of this page

JobSummary - AWS End User Messaging

JobSummary

Contains summary information about an asynchronous job in a list response.

Contents

createdAt

The time when the resource was created, in Unix epoch time.

Type: Timestamp

Required: Yes

jobId

The unique identifier of the asynchronous job. Use the GetJob operation to check the status of the job and to retrieve its results.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [A-Za-z0-9_-]+

Required: Yes

operationType

The type of mutating operation that created the job.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: Yes

status

The current lifecycle status of the job.

Type: String

Valid Values: SUCCESS | PROCESSING | FAILED

Required: Yes

updatedAt

The time when the resource was last updated, in Unix epoch time.

Type: Timestamp

Required: Yes

brandProfileId

The brand profile that the job operates on. This value is absent for operations that create a brand profile.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [A-Za-z0-9_:/-]+

Required: No

errorCode

A machine-readable code that identifies why the job failed. This value is present only when the job status is FAILED.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: No

errorMessage

A human-readable description of why the job failed. This value is present only when the job status is FAILED.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No

resources

The resources that were created or updated by the job.

Type: Array of JobResource objects

Array Members: Minimum number of 1 item. Maximum number of 10 items.

Required: No

See Also

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