Skip to content
AWS for Query.Farm

aws.iot.get_ota_update

Example SQL Queries

SELECT * FROM
aws.iot.get_ota_update
WHERE
"ota_update_id" = 'VALUE';

Description

Gets an OTA update.

Requires permission to access the GetOTAUpdate action.

Table Definition

Column NameColumn Data Type
ota_update_id Required Input Column

The OTA update ID.

VARCHAR
_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
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
ota_update_info

The OTA update info.

STRUCT(
    "ota_update_id" VARCHAR,
    "ota_update_arn" VARCHAR,
    "creation_date" TIMESTAMP_S,
    "last_modified_date" TIMESTAMP_S,
    "description" VARCHAR,
    "targets" VARCHAR[],
    "protocols" VARCHAR[],
    "aws_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
            )
        )
    ),
    "aws_job_presigned_url_config" STRUCT(
        "expires_in_sec" BIGINT
    ),
    "target_selection" VARCHAR,
    "ota_update_files" STRUCT(
        "file_name" VARCHAR,
        "file_type" BIGINT,
        "file_version" VARCHAR,
        "file_location" STRUCT(
            "stream" STRUCT(
                "stream_id" VARCHAR,
                "file_id" BIGINT
            ),
            "s3_location" STRUCT(
                "bucket" VARCHAR,
                "key" VARCHAR,
                "version" VARCHAR
            )
        ),
        "code_signing" STRUCT(
            "aws_signer_job_id" VARCHAR,
            "start_signing_job_parameter" STRUCT(
                "signing_profile_parameter" STRUCT(
                    "certificate_arn" VARCHAR,
                    "platform" VARCHAR,
                    "certificate_path_on_device" VARCHAR
                ),
                "signing_profile_name" VARCHAR,
                "destination" STRUCT(
                    "s3_destination" STRUCT(
                        "bucket" VARCHAR,
                        "prefix" VARCHAR
                    )
                )
            ),
            "custom_code_signing" STRUCT(
                "signature" STRUCT(
                    "inline_document" BLOB
                ),
                "certificate_chain" STRUCT(
                    "certificate_name" VARCHAR,
                    "inline_document" VARCHAR
                ),
                "hash_algorithm" VARCHAR,
                "signature_algorithm" VARCHAR
            )
        ),
        "attributes" MAP(VARCHAR, VARCHAR)
    )[],
    "ota_update_status" VARCHAR,
    "aws_iot_job_id" VARCHAR,
    "aws_iot_job_arn" VARCHAR,
    "error_info" STRUCT(
        "code" VARCHAR,
        "message" VARCHAR
    ),
    "additional_parameters" MAP(VARCHAR, VARCHAR)
)
Show child fields
ota_update_info.additional_parameters

A collection of name/value pairs

ota_update_info.aws_iot_job_arn

The IoT job ARN associated with the OTA update.

ota_update_info.aws_iot_job_id

The IoT job ID associated with the OTA update.

ota_update_info.aws_job_executions_rollout_config

Configuration for the rollout of OTA updates.

Show child fields
ota_update_info.aws_job_executions_rollout_config.exponential_rate

The rate of increase for a job rollout. This parameter allows you to define an exponential rate increase for a job rollout.

Show child fields
ota_update_info.aws_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 the job rollout. This is the initial rate of the rollout.

ota_update_info.aws_job_executions_rollout_config.exponential_rate.increment_factor

The rate of increase for a job rollout. The number of things notified is multiplied by this factor.

ota_update_info.aws_job_executions_rollout_config.exponential_rate.rate_increase_criteria

The criteria to initiate the increase in 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).

Show child fields
ota_update_info.aws_job_executions_rollout_config.exponential_rate.rate_increase_criteria.number_of_notified_things

When this number of things have been notified, it will initiate an increase in the rollout rate.

ota_update_info.aws_job_executions_rollout_config.exponential_rate.rate_increase_criteria.number_of_succeeded_things

When this number of things have succeeded in their job execution, it will initiate an increase in the rollout rate.

ota_update_info.aws_job_executions_rollout_config.maximum_per_minute

The maximum number of OTA update job executions started per minute.

ota_update_info.aws_job_presigned_url_config

Configuration information for pre-signed URLs. Valid when protocols contains HTTP.

Show child fields
ota_update_info.aws_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 1800 seconds. Pre-signed URLs are generated when a request for the job document is received.

ota_update_info.creation_date

The date when the OTA update was created.

ota_update_info.description

A description of the OTA update.

ota_update_info.error_info

Error information associated with the OTA update.

Show child fields
ota_update_info.error_info.code

The error code.

ota_update_info.error_info.message

The error message.

ota_update_info.last_modified_date

The date when the OTA update was last updated.

ota_update_info.ota_update_arn

The OTA update ARN.

ota_update_info.ota_update_files[]
Show child fields
ota_update_info.ota_update_files[].attributes

A list of name-attribute pairs. They won't be sent to devices as a part of the Job document.

ota_update_info.ota_update_files[].code_signing

The code signing method of the file.

Show child fields
ota_update_info.ota_update_files[].code_signing.aws_signer_job_id

The ID of the AWSSignerJob which was created to sign the file.

ota_update_info.ota_update_files[].code_signing.custom_code_signing

A custom method for code signing a file.

Show child fields
ota_update_info.ota_update_files[].code_signing.custom_code_signing.certificate_chain

The certificate chain.

Show child fields
ota_update_info.ota_update_files[].code_signing.custom_code_signing.certificate_chain.certificate_name

The name of the certificate.

ota_update_info.ota_update_files[].code_signing.custom_code_signing.certificate_chain.inline_document

A base64 encoded binary representation of the code signing certificate chain.

ota_update_info.ota_update_files[].code_signing.custom_code_signing.hash_algorithm

The hash algorithm used to code sign the file. You can use a string as the algorithm name if the target over-the-air (OTA) update devices are able to verify the signature that was generated using the same signature algorithm. For example, FreeRTOS uses SHA256 or SHA1, so you can pass either of them based on which was used for generating the signature.

ota_update_info.ota_update_files[].code_signing.custom_code_signing.signature

The signature for the file.

Show child fields
ota_update_info.ota_update_files[].code_signing.custom_code_signing.signature.inline_document

A base64 encoded binary representation of the code signing signature.

ota_update_info.ota_update_files[].code_signing.custom_code_signing.signature_algorithm

The signature algorithm used to code sign the file. You can use a string as the algorithm name if the target over-the-air (OTA) update devices are able to verify the signature that was generated using the same signature algorithm. For example, FreeRTOS uses ECDSA or RSA, so you can pass either of them based on which was used for generating the signature.

ota_update_info.ota_update_files[].code_signing.start_signing_job_parameter

Describes the code-signing job.

Show child fields
ota_update_info.ota_update_files[].code_signing.start_signing_job_parameter.destination

The location to write the code-signed file.

Show child fields
ota_update_info.ota_update_files[].code_signing.start_signing_job_parameter.destination.s3_destination

Describes the location in S3 of the updated firmware.

Show child fields
ota_update_info.ota_update_files[].code_signing.start_signing_job_parameter.destination.s3_destination.bucket

The S3 bucket that contains the updated firmware.

ota_update_info.ota_update_files[].code_signing.start_signing_job_parameter.destination.s3_destination.prefix

The S3 prefix.

ota_update_info.ota_update_files[].code_signing.start_signing_job_parameter.signing_profile_name

The code-signing profile name.

ota_update_info.ota_update_files[].code_signing.start_signing_job_parameter.signing_profile_parameter

Describes the code-signing profile.

Show child fields
ota_update_info.ota_update_files[].code_signing.start_signing_job_parameter.signing_profile_parameter.certificate_arn

Certificate ARN.

ota_update_info.ota_update_files[].code_signing.start_signing_job_parameter.signing_profile_parameter.certificate_path_on_device

The location of the code-signing certificate on your device.

ota_update_info.ota_update_files[].code_signing.start_signing_job_parameter.signing_profile_parameter.platform

The hardware platform of your device.

ota_update_info.ota_update_files[].file_location

The location of the updated firmware.

Show child fields
ota_update_info.ota_update_files[].file_location.s3_location

The location of the updated firmware in S3.

Show child fields
ota_update_info.ota_update_files[].file_location.s3_location.bucket

The S3 bucket.

ota_update_info.ota_update_files[].file_location.s3_location.key

The S3 key.

ota_update_info.ota_update_files[].file_location.s3_location.version

The S3 bucket version.

ota_update_info.ota_update_files[].file_location.stream

The stream that contains the OTA update.

Show child fields
ota_update_info.ota_update_files[].file_location.stream.file_id

The ID of a file associated with a stream.

ota_update_info.ota_update_files[].file_location.stream.stream_id

The stream ID.

ota_update_info.ota_update_files[].file_name

The name of the file.

ota_update_info.ota_update_files[].file_type

An integer value you can include in the job document to allow your devices to identify the type of file received from the cloud.

ota_update_info.ota_update_files[].file_version

The file version.

ota_update_info.ota_update_id

The OTA update ID.

ota_update_info.ota_update_status

The status of the OTA update.

ota_update_info.protocols[]
ota_update_info.target_selection

Specifies whether the OTA update will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the OTA update (SNAPSHOT). If continuous, the OTA update may also be run on a thing when a change is detected in a target. For example, an OTA update will run on a thing when the thing is added to a target group, even after the OTA update was completed by all things originally in the group.

ota_update_info.targets[]