AWS IoT SiteWise

Creates a pre-signed URL to a portal. Use this operation to create URLs to portals that use AWS Identity and Access Management (IAM) to authenticate users. An IAM user with access to a portal can call this API to get a URL to that portal. The URL contains a session token that lets the IAM user access the portal.

See also: AWS API Documentation

Request Syntax

client.create_presigned_portal_url(
    portalId='string',
    sessionDurationSeconds=123
)

type portalId:

string

param portalId:

[REQUIRED]

The ID of the portal to access.

type sessionDurationSeconds:

integer

param sessionDurationSeconds:

The duration (in seconds) for which the session at the URL is valid.

Default: 900 seconds (15 minutes)

rtype:

dict

returns:

Response Syntax

{
    'presignedPortalUrl': 'string'
}

Response Structure

• (dict) --

  • presignedPortalUrl (string) --

    The pre-signed URL to the portal. The URL contains the portal ID and a session token that lets you access the portal. The URL has the following format.

    https://<portal-id>.app.iotsitewise.aws/auth?token=<encrypted-token>