Skip to content
AWS for Query.Farm

aws.iottwinmaker.get_metadata_transfer_job

Example SQL Queries

SELECT * FROM
aws.iottwinmaker.get_metadata_transfer_job
WHERE
"metadata_transfer_job_id" = 'VALUE';

Description

Gets a nmetadata transfer job.

Table Definition

Column NameColumn Data Type
metadata_transfer_job_id Required Input Column

The metadata transfer job 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
arn

The metadata transfer job ARN.

VARCHAR
creation_date_time

The metadata transfer job's creation DateTime property.

TIMESTAMP_S
description

The metadata transfer job description.

VARCHAR
destination

The metadata transfer job's destination.

STRUCT(
    "type" VARCHAR,
    "s3_configuration" STRUCT(
        "location" VARCHAR
    ),
    "iot_twin_maker_configuration" STRUCT(
        "workspace" VARCHAR
    )
)
Show child fields
destination.iot_twin_maker_configuration

The metadata transfer job Amazon Web Services IoT TwinMaker configuration.

Show child fields
destination.iot_twin_maker_configuration.workspace

The IoT TwinMaker workspace.

destination.s3_configuration

The metadata transfer job S3 configuration. [need to add S3 entity]

Show child fields
destination.s3_configuration.location

The S3 destination configuration location.

destination.type

The destination type.

metadata_transfer_job_role

The metadata transfer job's role.

VARCHAR
progress

The metadata transfer job's progress.

STRUCT(
    "total_count" BIGINT,
    "succeeded_count" BIGINT,
    "skipped_count" BIGINT,
    "failed_count" BIGINT
)
Show child fields
progress.failed_count

The failed count.

progress.skipped_count

The skipped count.

progress.succeeded_count

The succeeded count.

progress.total_count

The total count. [of what]

report_url

The metadata transfer job's report URL.

VARCHAR
sources

The metadata transfer job's sources.

STRUCT(
    "type" VARCHAR,
    "s3_configuration" STRUCT(
        "location" VARCHAR
    ),
    "iot_site_wise_configuration" STRUCT(
        "filters" STRUCT(
            "filter_by_asset_model" STRUCT(
                "asset_model_id" VARCHAR,
                "asset_model_external_id" VARCHAR,
                "include_offspring" BOOLEAN,
                "include_assets" BOOLEAN
            ),
            "filter_by_asset" STRUCT(
                "asset_id" VARCHAR,
                "asset_external_id" VARCHAR,
                "include_offspring" BOOLEAN,
                "include_asset_model" BOOLEAN
            )
        )[]
    ),
    "iot_twin_maker_configuration" STRUCT(
        "workspace" VARCHAR,
        "filters" STRUCT(
            "filter_by_component_type" STRUCT(
                "component_type_id" VARCHAR
            ),
            "filter_by_entity" STRUCT(
                "entity_id" VARCHAR
            )
        )[]
    )
)[]
Show child fields
sources[]
Show child fields
sources[].iot_site_wise_configuration

The source configuration IoT SiteWise configuration.

Show child fields
sources[].iot_site_wise_configuration.filters[]
Show child fields
sources[].iot_site_wise_configuration.filters[].filter_by_asset

Filter by asset.

Show child fields
sources[].iot_site_wise_configuration.filters[].filter_by_asset.asset_external_id

The external-Id property of an asset.

sources[].iot_site_wise_configuration.filters[].filter_by_asset.asset_id

Filter by asset Id.

sources[].iot_site_wise_configuration.filters[].filter_by_asset.include_asset_model

Boolean to include the asset model.

sources[].iot_site_wise_configuration.filters[].filter_by_asset.include_offspring

Includes sub-assets.[need description hekp for this]

sources[].iot_site_wise_configuration.filters[].filter_by_asset_model

Filter by asset model.

Show child fields
sources[].iot_site_wise_configuration.filters[].filter_by_asset_model.asset_model_external_id

The external-Id property of an asset model.

sources[].iot_site_wise_configuration.filters[].filter_by_asset_model.asset_model_id

The asset model Id.

sources[].iot_site_wise_configuration.filters[].filter_by_asset_model.include_assets

Bolean to include assets.

sources[].iot_site_wise_configuration.filters[].filter_by_asset_model.include_offspring

Include asset offspring. [need desc.]

sources[].iot_twin_maker_configuration

The source configuration IoT TwinMaker configuration.

Show child fields
sources[].iot_twin_maker_configuration.filters[]
Show child fields
sources[].iot_twin_maker_configuration.filters[].filter_by_component_type

Filter by component type.

Show child fields
sources[].iot_twin_maker_configuration.filters[].filter_by_component_type.component_type_id

The component type Id.

sources[].iot_twin_maker_configuration.filters[].filter_by_entity

Filter by entity.

Show child fields
sources[].iot_twin_maker_configuration.filters[].filter_by_entity.entity_id

The entity Id.

sources[].iot_twin_maker_configuration.workspace

The IoT TwinMaker workspace.

sources[].s3_configuration

The source configuration S3 configuration.

Show child fields
sources[].s3_configuration.location

The S3 destination source configuration location.

sources[].type

The source configuration type.

status

The metadata transfer job's status.

STRUCT(
    "state" VARCHAR,
    "error" STRUCT(
        "code" VARCHAR,
        "message" VARCHAR
    ),
    "queued_position" BIGINT
)
Show child fields
status.error

The metadata transfer job error.

Show child fields
status.error.code

The error code.

status.error.message

The error message.

status.queued_position

The queued position.

status.state

The metadata transfer job state.

update_date_time

The metadata transfer job's update DateTime property.

TIMESTAMP_S