Skip to content

PortalSummary

Source code in docs_src/capo_iotsitewise/types/portal_summary.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
class PortalSummary(TypedDict, closed=True):
    id: "capo_iotsitewise.types.id.ID"
    """<p>The ID of the portal.</p>"""
    name: "capo_iotsitewise.types.name.Name"
    """<p>The name of the portal.</p>"""
    description: NotRequired["capo_iotsitewise.types.description.Description"]
    """<p>The portal's description.</p>"""
    start_url: "capo_iotsitewise.types.url.Url"
    """<p>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.</p>"""
    creation_date: NotRequired["capo_iotsitewise.types.timestamp.Timestamp"]
    """<p>The date the portal was created, in Unix epoch time.</p>"""
    last_update_date: NotRequired["capo_iotsitewise.types.timestamp.Timestamp"]
    """<p>The date the portal was last updated, in Unix epoch time.</p>"""
    role_arn: NotRequired["capo_iotsitewise.types.iam_arn.IamArn"]
    """<p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the service role that allows the portal's users to access your IoT SiteWise resources on your behalf. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-service-role.html">Using service roles for IoT SiteWise Monitor</a> in the <i>IoT SiteWise User Guide</i>.</p>"""
    status: "capo_iotsitewise.types.portal_status.PortalStatus"
    portal_type: NotRequired["capo_iotsitewise.types.portal_type.PortalType"]
    """<p>Define the type of portal. The value for IoT SiteWise Monitor (Classic) is <code>SITEWISE_PORTAL_V1</code>. The value for IoT SiteWise Monitor (AI-aware) is <code>SITEWISE_PORTAL_V2</code>.</p>"""

creation_date instance-attribute 

creation_date: NotRequired[Timestamp]

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

description instance-attribute 

description: NotRequired[Description]

The portal's description.

id instance-attribute 

id: ID

The ID of the portal.

last_update_date instance-attribute 

last_update_date: NotRequired[Timestamp]

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

name instance-attribute 

name: Name

The name of the portal.

portal_type instance-attribute 

portal_type: NotRequired[PortalType]

Define the type of portal. The value for IoT SiteWise Monitor (Classic) is SITEWISE_PORTAL_V1. The value for IoT SiteWise Monitor (AI-aware) is SITEWISE_PORTAL_V2.

role_arn instance-attribute 

role_arn: NotRequired[IamArn]

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.

start_url instance-attribute 

start_url: 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.

status instance-attribute 

status: PortalStatus