IoTSiteWise / Client / list_portals

list_portals

IoTSiteWise.Client.list_portals(**kwargs)

Retrieves a paginated list of IoT SiteWise Monitor portals.

See also: AWS API Documentation

Request Syntax

response = client.list_portals(
    nextToken='string',
    maxResults=123
)

Parameters:

• nextToken (string) – The token to be used for the next set of paginated results.

• maxResults (integer) –

  The maximum number of results to return for each paginated request.

  Default: 50

Return type:

dict

Returns:

Response Syntax

{
    'portalSummaries': [
        {
            'id': 'string',
            'name': 'string',
            'description': 'string',
            'startUrl': 'string',
            'creationDate': datetime(2015, 1, 1),
            'lastUpdateDate': datetime(2015, 1, 1),
            'roleArn': 'string',
            'status': {
                'state': 'CREATING'|'PENDING'|'UPDATING'|'DELETING'|'ACTIVE'|'FAILED',
                'error': {
                    'code': 'INTERNAL_FAILURE'|'VALIDATION_ERROR'|'LIMIT_EXCEEDED',
                    'message': 'string'
                }
            },
            'portalType': 'SITEWISE_PORTAL_V1'|'SITEWISE_PORTAL_V2'
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) –

  • portalSummaries (list) –

    A list that summarizes each portal.

    • (dict) –

      Contains a portal summary.

      • id (string) –

        The ID of the portal.

      • name (string) –

        The name of the portal.

      • description (string) –

        The portal’s description.

      • startUrl (string) –

        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.

      • creationDate (datetime) –

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

      • lastUpdateDate (datetime) –

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

      • roleArn (string) –

        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.

      • status (dict) –

        Contains information about the current status of a portal.

        • state (string) –

          The current state of the portal.

        • error (dict) –

          Contains associated error information, if any.

          • code (string) –

            The error code.

          • message (string) –

            The error message.

      • portalType (string) –

        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.

  • nextToken (string) –

    The token for the next set of results, or null if there are no additional results.

Exceptions

• IoTSiteWise.Client.exceptions.InvalidRequestException

• IoTSiteWise.Client.exceptions.InternalFailureException

• IoTSiteWise.Client.exceptions.ThrottlingException