JobSummary - AWS IoT SiteWise

JobSummary

Contains the job summary information.

Contents

id

The ID of the job.

Type: String

Length Constraints: Fixed length of 36.

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Required: Yes

name

The unique name that helps identify the job request.

Type: String

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

Pattern: [^\u0000-\u001F\u007F]+

Required: Yes

status

The status of the bulk import job can be one of following values:

  • PENDING – AWS IoT SiteWise is waiting for the current bulk import job to finish.

  • CANCELLED – The bulk import job has been canceled.

  • RUNNING – AWS IoT SiteWise is processing your request to import your data from Amazon S3.

  • COMPLETED – AWS IoT SiteWise successfully completed your request to import data from Amazon S3.

  • FAILED – AWS IoT SiteWise couldn't process your request to import data from Amazon S3. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.

  • COMPLETED_WITH_FAILURES – AWS IoT SiteWise completed your request to import data from Amazon S3 with errors. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.

Type: String

Valid Values: PENDING | CANCELLED | RUNNING | COMPLETED | FAILED | COMPLETED_WITH_FAILURES

Required: Yes

See Also

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