:doc:`IoTSiteWise <../../iotsitewise>` / Client / delete_portal

*************
delete_portal
*************



.. py:method:: IoTSiteWise.Client.delete_portal(**kwargs)

  

  Deletes a portal from IoT SiteWise Monitor.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DeletePortal>`_  


  **Request Syntax**
  ::

    response = client.delete_portal(
        portalId='string',
        clientToken='string'
    )
    
  :type portalId: string
  :param portalId: **[REQUIRED]** 

    The ID of the portal to delete.

    

  
  :type clientToken: string
  :param clientToken: 

    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.

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'portalStatus': {
              'state': 'CREATING'|'PENDING'|'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**
  
  *   :py:class:`IoTSiteWise.Client.exceptions.InvalidRequestException`

  
  *   :py:class:`IoTSiteWise.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`IoTSiteWise.Client.exceptions.InternalFailureException`

  
  *   :py:class:`IoTSiteWise.Client.exceptions.ThrottlingException`

  
  *   :py:class:`IoTSiteWise.Client.exceptions.ConflictingOperationException`

  