IoTSiteWise / Client / describe_portal

describe_portal

IoTSiteWise.Client.describe_portal(**kwargs)

Retrieves information about a portal.

See also: AWS API Documentation

Request Syntax

response = client.describe_portal(
    portalId='string'
)

Parameters:

portalId (string) –

[REQUIRED]

The ID of the portal.

Return type:

dict

Returns:

Response Syntax

{
    'portalId': 'string',
    'portalArn': 'string',
    'portalName': 'string',
    'portalDescription': 'string',
    'portalClientId': 'string',
    'portalStartUrl': 'string',
    'portalContactEmail': 'string',
    'portalStatus': {
        'state': 'CREATING'|'PENDING'|'UPDATING'|'DELETING'|'ACTIVE'|'FAILED',
        'error': {
            'code': 'INTERNAL_FAILURE'|'VALIDATION_ERROR'|'LIMIT_EXCEEDED',
            'message': 'string'
        }
    },
    'portalCreationDate': datetime(2015, 1, 1),
    'portalLastUpdateDate': datetime(2015, 1, 1),
    'portalLogoImageLocation': {
        'id': 'string',
        'url': 'string'
    },
    'roleArn': 'string',
    'portalAuthMode': 'IAM'|'SSO',
    'notificationSenderEmail': 'string',
    'alarms': {
        'alarmRoleArn': 'string',
        'notificationLambdaArn': 'string'
    },
    'portalType': 'SITEWISE_PORTAL_V1'|'SITEWISE_PORTAL_V2',
    'portalTypeConfiguration': {
        'string': {
            'portalTools': [
                'string',
            ]
        }
    }
}

Response Structure

• (dict) –

  • portalId (string) –

    The ID of the portal.

  • portalArn (string) –

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

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

  • portalName (string) –

    The name of the portal.

  • portalDescription (string) –

    The portal’s description.

  • portalClientId (string) –

    The IAM Identity Center application generated client ID (used with IAM Identity Center API operations). IoT SiteWise includes portalClientId for only portals that use IAM Identity Center to authenticate users.

  • portalStartUrl (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.

  • portalContactEmail (string) –

    The Amazon Web Services administrator’s contact email address.

  • portalStatus (dict) –

    The current status of the portal, which contains a state and any error message.

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

  • portalCreationDate (datetime) –

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

  • portalLastUpdateDate (datetime) –

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

  • portalLogoImageLocation (dict) –

    The portal’s logo image, which is available at a URL.

    • id (string) –

      The ID of the image.

    • url (string) –

      The URL where the image is available. The URL is valid for 15 minutes so that you can view and download the image

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

  • portalAuthMode (string) –

    The service to use to authenticate users to the portal.

  • notificationSenderEmail (string) –

    The email address that sends alarm notifications.

  • alarms (dict) –

    Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal.

    • alarmRoleArn (string) –

      The ARN of the IAM role that allows the alarm to perform actions and access Amazon Web Services resources and services, such as IoT Events.

    • notificationLambdaArn (string) –

      The ARN of the Lambda function that manages alarm notifications. For more information, see Managing alarm notifications in the IoT Events Developer Guide.

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

  • portalTypeConfiguration (dict) –

    The configuration entry associated with the specific portal type. The value for IoT SiteWise Monitor (Classic) is SITEWISE_PORTAL_V1. The value for IoT SiteWise Monitor (AI-aware) is SITEWISE_PORTAL_V2.

    • (string) –

      • (dict) –

        The configuration entry associated with the specific portal type. The portalTypeConfiguration is a map of the portalTypeKey to the PortalTypeEntry.

        • portalTools (list) –

          The array of tools associated with the specified portal type. The possible values are ASSISTANT and DASHBOARD.

          • (string) –

Exceptions

• IoTSiteWise.Client.exceptions.InvalidRequestException

• IoTSiteWise.Client.exceptions.ResourceNotFoundException

• IoTSiteWise.Client.exceptions.InternalFailureException

• IoTSiteWise.Client.exceptions.ThrottlingException