IoTSiteWise / Paginator / ListPortals

ListPortals

class IoTSiteWise.Paginator.ListPortals

paginator = client.get_paginator('list_portals')

paginate(**kwargs)

Creates an iterator that will paginate through responses from IoTSiteWise.Client.list_portals().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

PaginationConfig (dict) –

A dictionary that provides parameters to control pagination.

• MaxItems (integer) –

  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

• PageSize (integer) –

  The size of each page.

• StartingToken (string) –

  A token to specify where to start paginating. This is the NextToken from a previous response.

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) –

    A token to resume pagination.