Skip to content
AWS for Query.Farm

aws.iotsitewise.describe_bulk_import_job

Example SQL Queries

SELECT * FROM
aws.iotsitewise.describe_bulk_import_job
WHERE
"job_id" = 'VALUE';

Description

Retrieves information about a bulk import job request. For more information, see Describe a bulk import job (CLI) in the Amazon Simple Storage Service User Guide.

Table Definition

Column NameColumn Data Type
job_id Required Input Column

The ID of the job.

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
adaptive_ingestion

If set to true, ingest new data into IoT SiteWise storage. Measurements with notifications, metrics and transforms are computed. If set to false, historical data is ingested into IoT SiteWise as is.

BOOLEAN
delete_files_after_import

If set to true, your data files is deleted from S3, after ingestion into IoT SiteWise storage.

BOOLEAN
error_report_location

The Amazon S3 destination where errors associated with the job creation request are saved.

STRUCT(
    "bucket" VARCHAR,
    "prefix" VARCHAR
)
Show child fields
error_report_location.bucket

The name of the Amazon S3 bucket to which errors associated with the bulk import job are sent.

error_report_location.prefix

Amazon S3 uses the prefix as a folder name to organize data in the bucket. Each Amazon S3 object has a key that is its unique identifier in the bucket. Each object in a bucket has exactly one key. The prefix must end with a forward slash (/). For more information, see Organizing objects using prefixes in the Amazon Simple Storage Service User Guide.

files

The files in the specified Amazon S3 bucket that contain your data.

STRUCT(
    "bucket" VARCHAR,
    "key" VARCHAR,
    "version_id" VARCHAR
)[]
Show child fields
files[]
Show child fields
files[].bucket

The name of the Amazon S3 bucket from which data is imported.

files[].key

The key of the Amazon S3 object that contains your data. Each object has a key that is a unique identifier. Each object has exactly one key.

files[].version_id

The version ID to identify a specific version of the Amazon S3 object that contains your data.

job_configuration

Contains the configuration information of a job, such as the file format used to save data in Amazon S3.

STRUCT(
    "file_format" STRUCT(
        "csv" STRUCT(
            "column_names" VARCHAR[]
        ),
        "parquet" BOOLEAN
    )
)
Show child fields
job_configuration.file_format

The file format of the data in S3.

Show child fields
job_configuration.file_format.csv

The file is in .CSV format.

Show child fields
job_configuration.file_format.csv.column_names[]
job_configuration.file_format.parquet

The file is in parquet format.

job_creation_date

The date the job was created, in Unix epoch TIME.

TIMESTAMP_S
job_last_update_date

The date the job was last updated, in Unix epoch time.

TIMESTAMP_S
job_name

The unique name that helps identify the job request.

VARCHAR
job_role_arn

The ARN of the IAM role that allows IoT SiteWise to read Amazon S3 data.

VARCHAR
job_status

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

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

  • CANCELLED – The bulk import job has been canceled.

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

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

  • FAILED – 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 – 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.

VARCHAR