IoTSiteWise / Client / delete_portal

delete_portal#

IoTSiteWise.Client.delete_portal(**kwargs)#

Deletes a portal from IoT SiteWise Monitor.

See also: AWS API Documentation

Request Syntax

response = client.delete_portal(
    portalId='string',
    clientToken='string'
)
Parameters:
  • portalId (string) –

    [REQUIRED]

    The ID of the portal to delete.

  • clientToken (string) –

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don’t reuse this client token if a new idempotent request is required.

    This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'portalStatus': {
        'state': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'FAILED',
        'error': {
            'code': 'INTERNAL_FAILURE'|'VALIDATION_ERROR'|'LIMIT_EXCEEDED',
            'message': 'string'
        }
    }
}

Response Structure

  • (dict) –

    • portalStatus (dict) –

      The status of the portal, which contains a state ( DELETING after successfully calling this operation) 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.

Exceptions

  • IoTSiteWise.Client.exceptions.InvalidRequestException

  • IoTSiteWise.Client.exceptions.ResourceNotFoundException

  • IoTSiteWise.Client.exceptions.InternalFailureException

  • IoTSiteWise.Client.exceptions.ThrottlingException

  • IoTSiteWise.Client.exceptions.ConflictingOperationException