Skip to content
AWS for Query.Farm

aws.iotsitewise.describe_portal

Example SQL Queries

SELECT * FROM
aws.iotsitewise.describe_portal
WHERE
"portal_id" = 'VALUE';

Description

Retrieves information about a portal.

Table Definition

Column NameColumn Data Type
portal_id Required Input Column

The ID of the portal.

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
alarms

Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal.

STRUCT(
    "alarm_role_arn" VARCHAR,
    "notification_lambda_arn" VARCHAR
)
Show child fields
alarms.alarm_role_arn

The ARN of the IAM role that allows the alarm to perform actions and access Amazon Web Services resources and services, such as IoT Events.

alarms.notification_lambda_arn

The ARN of the Lambda function that manages alarm notifications. For more information, see Managing alarm notifications in the IoT Events Developer Guide.

notification_sender_email

The email address that sends alarm notifications.

VARCHAR
portal_arn

The ARN of the portal, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId} 

VARCHAR
portal_auth_mode

The service to use to authenticate users to the portal.

VARCHAR
portal_client_id

The IAM Identity Center application generated client ID (used with IAM Identity Center API operations). IoT SiteWise includes portalClientId for only portals that use IAM Identity Center to authenticate users.

VARCHAR
portal_contact_email

The Amazon Web Services administrator's contact email address.

VARCHAR
portal_creation_date

The date the portal was created, in Unix epoch time.

TIMESTAMP_S
portal_description

The portal's description.

VARCHAR
portal_last_update_date

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

TIMESTAMP_S
portal_logo_image_location

The portal's logo image, which is available at a URL.

STRUCT(
    "id" VARCHAR,
    "url" VARCHAR
)
Show child fields
portal_logo_image_location.id

The ID of the image.

portal_logo_image_location.url

The URL where the image is available. The URL is valid for 15 minutes so that you can view and download the image

portal_name

The name of the portal.

VARCHAR
portal_start_url

The URL for the IoT SiteWise Monitor portal. You can use this URL to access portals that use IAM Identity Center for authentication. For portals that use IAM for authentication, you must use the IoT SiteWise console to get a URL that you can use to access the portal.

VARCHAR
portal_status

The current status of the portal, which contains a state and any error message.

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

Contains associated error information, if any.

Show child fields
portal_status.error.code

The error code.

portal_status.error.message

The error message.

portal_status.state

The current state of the portal.

role_arn

The ARN of the service role that allows the portal's users to access your IoT SiteWise resources on your behalf. For more information, see Using service roles for IoT SiteWise Monitor in the IoT SiteWise User Guide.

VARCHAR