Skip to content
AWS for Query.Farm

aws.iotsitewise.describe_storage_configuration

Example SQL Queries

SELECT * FROM
aws.iotsitewise.describe_storage_configuration;

Description

Retrieves information about the storage configuration for IoT SiteWise.

Table Definition

Column NameColumn Data Type
_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
configuration_status

Contains current status information for the configuration.

STRUCT(
    "state" VARCHAR,
    "error" STRUCT(
        "code" VARCHAR,
        "message" VARCHAR
    )
)
Show child fields
configuration_status.error

Contains associated error information, if any.

Show child fields
configuration_status.error.code

The error code.

configuration_status.error.message

The error message.

configuration_status.state

The current state of the configuration.

disassociated_data_storage

Contains the storage configuration for time series (data streams) that aren't associated with asset properties. The disassociatedDataStorage can be one of the following values:

  • ENABLED – IoT SiteWise accepts time series that aren't associated with asset properties.

    After the disassociatedDataStorage is enabled, you can't disable it.

  • DISABLED – IoT SiteWise doesn't accept time series (data streams) that aren't associated with asset properties.

For more information, see Data streams in the IoT SiteWise User Guide.

VARCHAR
last_update_date

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

TIMESTAMP_S
multi_layer_storage

Contains information about the storage destination.

STRUCT(
    "customer_managed_s3_storage" STRUCT(
        "s3_resource_arn" VARCHAR,
        "role_arn" VARCHAR
    )
)
Show child fields
multi_layer_storage.customer_managed_s3_storage

Contains information about a customer managed Amazon S3 bucket.

Show child fields
multi_layer_storage.customer_managed_s3_storage.role_arn

The ARN of the Identity and Access Management role that allows IoT SiteWise to send data to Amazon S3.

multi_layer_storage.customer_managed_s3_storage.s3_resource_arn

The ARN of the Amazon S3 object. For more information about how to find the ARN for an Amazon S3 object, see Amazon S3 resources in the Amazon Simple Storage Service User Guide.

retention_period

The number of days your data is kept in the hot tier. By default, your data is kept indefinitely in the hot tier.

STRUCT(
    "number_of_days" BIGINT,
    "unlimited" BOOLEAN
)
Show child fields
retention_period.number_of_days

The number of days that your data is kept.

If you specified a value for this parameter, the unlimited parameter must be false.

retention_period.unlimited

If true, your data is kept indefinitely.

If configured to true, you must not specify a value for the numberOfDays parameter.

storage_type

The storage tier that you specified for your data. The storageType parameter can be one of the following values:

  • SITEWISE_DEFAULT_STORAGE – IoT SiteWise saves your data into the hot tier. The hot tier is a service-managed database.

  • MULTI_LAYER_STORAGE – IoT SiteWise saves your data in both the cold tier and the hot tier. The cold tier is a customer-managed Amazon S3 bucket.

VARCHAR
warm_tier

A service managed storage tier optimized for analytical queries. It stores periodically uploaded, buffered and historical data ingested with the CreaeBulkImportJob API.

VARCHAR
warm_tier_retention_period

Set this period to specify how long your data is stored in the warm tier before it is deleted. You can set this only if cold tier is enabled.

STRUCT(
    "number_of_days" BIGINT,
    "unlimited" BOOLEAN
)
Show child fields
warm_tier_retention_period.number_of_days

The number of days the data is stored in the warm tier.

warm_tier_retention_period.unlimited

If set to true, the data is stored indefinitely in the warm tier.