:doc:`ServiceCatalog <../../servicecatalog>` / Client / describe_portfolio_share_status

*******************************
describe_portfolio_share_status
*******************************



.. py:method:: ServiceCatalog.Client.describe_portfolio_share_status(**kwargs)

  

  Gets the status of the specified portfolio share operation. This API can only be called by the management account in the organization or by a delegated admin.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/servicecatalog-2015-12-10/DescribePortfolioShareStatus>`_  


  **Request Syntax**
  ::

    response = client.describe_portfolio_share_status(
        PortfolioShareToken='string'
    )
    
  :type PortfolioShareToken: string
  :param PortfolioShareToken: **[REQUIRED]** 

    The token for the portfolio share operation. This token is returned either by CreatePortfolioShare or by DeletePortfolioShare.

    

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

    
    ::

      {
          'PortfolioShareToken': 'string',
          'PortfolioId': 'string',
          'OrganizationNodeValue': 'string',
          'Status': 'NOT_STARTED'|'IN_PROGRESS'|'COMPLETED'|'COMPLETED_WITH_ERRORS'|'ERROR',
          'ShareDetails': {
              'SuccessfulShares': [
                  'string',
              ],
              'ShareErrors': [
                  {
                      'Accounts': [
                          'string',
                      ],
                      'Message': 'string',
                      'Error': 'string'
                  },
              ]
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **PortfolioShareToken** *(string) --* 

        The token for the portfolio share operation. For example, ``share-6v24abcdefghi``.

        
      

      - **PortfolioId** *(string) --* 

        The portfolio identifier.

        
      

      - **OrganizationNodeValue** *(string) --* 

        Organization node identifier. It can be either account id, organizational unit id or organization id.

        
      

      - **Status** *(string) --* 

        Status of the portfolio share operation.

        
      

      - **ShareDetails** *(dict) --* 

        Information about the portfolio share operation.

        
        

        - **SuccessfulShares** *(list) --* 

          List of accounts for whom the operation succeeded.

          
          

          - *(string) --* 
      
        

        - **ShareErrors** *(list) --* 

          List of errors.

          
          

          - *(dict) --* 

            Errors that occurred during the portfolio share operation.

            
            

            - **Accounts** *(list) --* 

              List of accounts impacted by the error.

              
              

              - *(string) --* 
          
            

            - **Message** *(string) --* 

              Information about the error.

              
            

            - **Error** *(string) --* 

              Error type that happened when processing the operation.

              
        
      
    
  
  **Exceptions**
  
  *   :py:class:`ServiceCatalog.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`ServiceCatalog.Client.exceptions.InvalidParametersException`

  
  *   :py:class:`ServiceCatalog.Client.exceptions.OperationNotSupportedException`

  