Skip to content

CreatePortalResponse

Source code in docs_src/capo_iotsitewise/types/create_portal_response.py 
17
18
19
20
21
22
23
24
25
26
27
class CreatePortalResponse(TypedDict, closed=True):
    portal_id: "capo_iotsitewise.types.id.ID"
    """<p>The ID of the created portal.</p>"""
    portal_arn: "capo_iotsitewise.types.arn.ARN"
    """<p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the portal, which has the following format.</p> <p> <code>arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}</code> </p>"""
    portal_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>"""
    portal_status: "capo_iotsitewise.types.portal_status.PortalStatus"
    """<p>The status of the portal, which contains a state (<code>CREATING</code> after successfully calling this operation) and any error message.</p>"""
    sso_application_id: "capo_iotsitewise.types.sso_application_id.SSOApplicationId"
    """<p>The associated IAM Identity Center application ID, if the portal uses IAM Identity Center.</p>"""

portal_arn instance-attribute 

portal_arn: ARN

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

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

portal_id instance-attribute 

portal_id: ID

The ID of the created portal.

portal_start_url instance-attribute 

portal_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.

portal_status instance-attribute 

portal_status: PortalStatus

The status of the portal, which contains a state (CREATING after successfully calling this operation) and any error message.

sso_application_id instance-attribute 

sso_application_id: SSOApplicationId

The associated IAM Identity Center application ID, if the portal uses IAM Identity Center.