_aws_profile Input Column
The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role. | STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
) |
job
Information about the job. | STRUCT(
"job_arn" VARCHAR,
"job_id" VARCHAR,
"target_selection" VARCHAR,
"status" VARCHAR,
"force_canceled" BOOLEAN,
"reason_code" VARCHAR,
"comment" VARCHAR,
"targets" VARCHAR[],
"description" VARCHAR,
"presigned_url_config" STRUCT(
"role_arn" VARCHAR,
"expires_in_sec" BIGINT
),
"job_executions_rollout_config" STRUCT(
"maximum_per_minute" BIGINT,
"exponential_rate" STRUCT(
"base_rate_per_minute" BIGINT,
"increment_factor" DOUBLE,
"rate_increase_criteria" STRUCT(
"number_of_notified_things" BIGINT,
"number_of_succeeded_things" BIGINT
)
)
),
"abort_config" STRUCT(
"criteria_list" STRUCT(
"failure_type" VARCHAR,
"action" VARCHAR,
"threshold_percentage" DOUBLE,
"min_number_of_executed_things" BIGINT
)[]
),
"created_at" TIMESTAMP_S,
"last_updated_at" TIMESTAMP_S,
"completed_at" TIMESTAMP_S,
"job_process_details" STRUCT(
"processing_targets" VARCHAR[],
"number_of_canceled_things" BIGINT,
"number_of_succeeded_things" BIGINT,
"number_of_failed_things" BIGINT,
"number_of_rejected_things" BIGINT,
"number_of_queued_things" BIGINT,
"number_of_in_progress_things" BIGINT,
"number_of_removed_things" BIGINT,
"number_of_timed_out_things" BIGINT
),
"timeout_config" STRUCT(
"in_progress_timeout_in_minutes" BIGINT
),
"namespace_id" VARCHAR,
"job_template_arn" VARCHAR,
"job_executions_retry_config" STRUCT(
"criteria_list" STRUCT(
"failure_type" VARCHAR,
"number_of_retries" BIGINT
)[]
),
"document_parameters" MAP(VARCHAR, VARCHAR),
"is_concurrent" BOOLEAN,
"scheduling_config" STRUCT(
"start_time" VARCHAR,
"end_time" VARCHAR,
"end_behavior" VARCHAR,
"maintenance_windows" STRUCT(
"start_time" VARCHAR,
"duration_in_minutes" BIGINT
)[]
),
"scheduled_job_rollouts" STRUCT(
"start_time" VARCHAR
)[],
"destination_package_versions" VARCHAR[]
) |
Show child fields- job.abort_config
Configuration for criteria to abort the job. Show child fields- job.abort_config.criteria_list[]
Show child fields- job.abort_config.criteria_list[].action
The type of job action to take to initiate the job abort. - job.abort_config.criteria_list[].failure_type
The type of job execution failures that can initiate a job abort. - job.abort_config.criteria_list[].min_number_of_executed_things
The minimum number of things which must receive job execution notifications before the job can be aborted. - job.abort_config.criteria_list[].threshold_percentage
The minimum percentage of job execution failures that must occur to initiate the job abort. Amazon Web Services IoT Core supports up to two digits after the decimal (for example, 10.9 and 10.99, but not 10.999).
- job.comment
If the job was updated, describes the reason for the update. - job.completed_at
The time, in seconds since the epoch, when the job was completed. - job.created_at
The time, in seconds since the epoch, when the job was created. - job.description
A short text description of the job. - job.destination_package_versions[]
- job.document_parameters
A key-value map that pairs the patterns that need to be replaced in a managed template job document schema. You can use the description of each key as a guidance to specify the inputs during runtime when creating a job. documentParameters can only be used when creating jobs from Amazon Web Services managed templates. This parameter can't be used with custom job templates or to create jobs from them. - job.force_canceled
Will be true if the job was canceled with the optional force parameter set to true. - job.is_concurrent
Indicates whether a job is concurrent. Will be true when a job is rolling out new job executions or canceling previously created executions, otherwise false. - job.job_arn
An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId". - job.job_executions_retry_config
The configuration for the criteria to retry the job. Show child fields- job.job_executions_retry_config.criteria_list[]
Show child fields- job.job_executions_retry_config.criteria_list[].failure_type
The type of job execution failures that can initiate a job retry. - job.job_executions_retry_config.criteria_list[].number_of_retries
The number of retries allowed for a failure type for the job.
- job.job_executions_rollout_config
Allows you to create a staged rollout of a job. Show child fields- job.job_executions_rollout_config.exponential_rate
The rate of increase for a job rollout. This parameter allows you to define an exponential rate for a job rollout. Show child fields- job.job_executions_rollout_config.exponential_rate.base_rate_per_minute
The minimum number of things that will be notified of a pending job, per minute at the start of job rollout. This parameter allows you to define the initial rate of rollout. - job.job_executions_rollout_config.exponential_rate.increment_factor
The exponential factor to increase the rate of rollout for a job. Amazon Web Services IoT Core supports up to one digit after the decimal (for example, 1.5, but not 1.55). - job.job_executions_rollout_config.exponential_rate.rate_increase_criteria
The criteria to initiate the increase in rate of rollout for a job. Show child fields- job.job_executions_rollout_config.exponential_rate.rate_increase_criteria.number_of_notified_things
The threshold for number of notified things that will initiate the increase in rate of rollout. - job.job_executions_rollout_config.exponential_rate.rate_increase_criteria.number_of_succeeded_things
The threshold for number of succeeded things that will initiate the increase in rate of rollout.
- job.job_executions_rollout_config.maximum_per_minute
The maximum number of things that will be notified of a pending job, per minute. This parameter allows you to create a staged rollout.
- job.job_id
The unique identifier you assigned to this job when it was created. - job.job_process_details
Details about the job process. Show child fields- job.job_process_details.number_of_canceled_things
The number of things that cancelled the job. - job.job_process_details.number_of_failed_things
The number of things that failed executing the job. - job.job_process_details.number_of_in_progress_things
The number of things currently executing the job. - job.job_process_details.number_of_queued_things
The number of things that are awaiting execution of the job. - job.job_process_details.number_of_rejected_things
The number of things that rejected the job. - job.job_process_details.number_of_removed_things
The number of things that are no longer scheduled to execute the job because they have been deleted or have been removed from the group that was a target of the job. - job.job_process_details.number_of_succeeded_things
The number of things which successfully completed the job. - job.job_process_details.number_of_timed_out_things
The number of things whose job execution status is TIMED_OUT. - job.job_process_details.processing_targets[]
- job.job_template_arn
The ARN of the job template used to create the job. - job.last_updated_at
The time, in seconds since the epoch, when the job was last updated. - job.namespace_id
The namespace used to indicate that a job is a customer-managed job. When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format. $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/ The namespaceId feature is only supported by IoT Greengrass at this time. For more information, see Setting up IoT Greengrass core devices. - job.presigned_url_config
Configuration for pre-signed S3 URLs. Show child fields- job.presigned_url_config.expires_in_sec
How long (in seconds) pre-signed URLs are valid. Valid values are 60 - 3600, the default value is 3600 seconds. Pre-signed URLs are generated when Jobs receives an MQTT request for the job document. - job.presigned_url_config.role_arn
The ARN of an IAM role that grants permission to download files from the S3 bucket where the job data/updates are stored. The role must also grant permission for IoT to download the files. For information about addressing the confused deputy problem, see cross-service confused deputy prevention in the Amazon Web Services IoT Core developer guide.
- job.reason_code
If the job was updated, provides the reason code for the update. - job.scheduled_job_rollouts[]
Show child fields- job.scheduled_job_rollouts[].start_time
Displays the start times of the next seven maintenance window occurrences.
- job.scheduling_config
The configuration that allows you to schedule a job for a future date and time in addition to specifying the end behavior for each job execution. Show child fields- job.scheduling_config.end_behavior
Specifies the end behavior for all job executions after a job reaches the selected endTime. If endTime is not selected when creating the job, then endBehavior does not apply. - job.scheduling_config.end_time
The time a job will stop rollout of the job document to all devices in the target group for a job. The endTime must take place no later than two years from the current time and be scheduled a minimum of thirty minutes from the current time. The minimum duration between startTime and endTime is thirty minutes. The maximum duration between startTime and endTime is two years. The date and time format for the endTime is YYYY-MM-DD for the date and HH:MM for the time. For more information on the syntax for endTime when using an API command or the Command Line Interface, see Timestamp. - job.scheduling_config.maintenance_windows[]
Show child fields- job.scheduling_config.maintenance_windows[].duration_in_minutes
Displays the duration of the next maintenance window. - job.scheduling_config.maintenance_windows[].start_time
Displays the start time of the next maintenance window.
- job.scheduling_config.start_time
The time a job will begin rollout of the job document to all devices in the target group for a job. The startTime can be scheduled up to a year in advance and must be scheduled a minimum of thirty minutes from the current time. The date and time format for the startTime is YYYY-MM-DD for the date and HH:MM for the time. For more information on the syntax for startTime when using an API command or the Command Line Interface, see Timestamp.
- job.status
The status of the job, one of IN_PROGRESS, CANCELED, DELETION_IN_PROGRESS or COMPLETED. - job.target_selection
Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a device when the thing representing the device is added to a target group, even after the job was completed by all things originally in the group. We recommend that you use continuous jobs instead of snapshot jobs for dynamic thing group targets. By using continuous jobs, devices that join the group receive the job execution even after the job has been created. - job.targets[]
- job.timeout_config
Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT. Show child fields- job.timeout_config.in_progress_timeout_in_minutes
Specifies the amount of time, in minutes, this device has to finish execution of this job. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The in progress timer can't be updated and will apply to all job executions for the job. Whenever a job execution remains in the IN_PROGRESS status for longer than this interval, the job execution will fail and switch to the terminal TIMED_OUT status.
|