:doc:`WorkspacesInstances <../../workspaces-instances>` / Client / get_workspace_instance

**********************
get_workspace_instance
**********************



.. py:method:: WorkspacesInstances.Client.get_workspace_instance(**kwargs)

  

  Retrieves detailed information about a specific WorkSpace Instance.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/workspaces-instances-2022-07-26/GetWorkspaceInstance>`_  


  **Request Syntax**
  ::

    response = client.get_workspace_instance(
        WorkspaceInstanceId='string'
    )
    
  :type WorkspaceInstanceId: string
  :param WorkspaceInstanceId: **[REQUIRED]** 

    Unique identifier of the WorkSpace Instance to retrieve.

    

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

    
    ::

      {
          'WorkspaceInstanceErrors': [
              {
                  'ErrorCode': 'string',
                  'ErrorMessage': 'string'
              },
          ],
          'EC2InstanceErrors': [
              {
                  'EC2ErrorCode': 'string',
                  'EC2ExceptionType': 'string',
                  'EC2ErrorMessage': 'string'
              },
          ],
          'ProvisionState': 'ALLOCATING'|'ALLOCATED'|'DEALLOCATING'|'DEALLOCATED'|'ERROR_ALLOCATING'|'ERROR_DEALLOCATING',
          'WorkspaceInstanceId': 'string',
          'EC2ManagedInstance': {
              'InstanceId': 'string'
          },
          'BillingConfiguration': {
              'BillingMode': 'MONTHLY'|'HOURLY'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 

      Provides comprehensive details about the requested WorkSpaces Instance.

      
      

      - **WorkspaceInstanceErrors** *(list) --* 

        Captures any errors specific to the WorkSpace Instance lifecycle.

        
        

        - *(dict) --* 

          Captures errors specific to WorkSpace Instance operations.

          
          

          - **ErrorCode** *(string) --* 

            Unique error code for the WorkSpace Instance error.

            
          

          - **ErrorMessage** *(string) --* 

            Detailed description of the WorkSpace Instance error.

            
      
    
      

      - **EC2InstanceErrors** *(list) --* 

        Includes any underlying EC2 instance errors encountered.

        
        

        - *(dict) --* 

          Captures detailed error information for EC2 instance operations.

          
          

          - **EC2ErrorCode** *(string) --* 

            Unique error code identifying the specific EC2 instance error.

            
          

          - **EC2ExceptionType** *(string) --* 

            Type of exception encountered during EC2 instance operation.

            
          

          - **EC2ErrorMessage** *(string) --* 

            Detailed description of the EC2 instance error.

            
      
    
      

      - **ProvisionState** *(string) --* 

        Current provisioning state of the WorkSpaces Instance.

        
      

      - **WorkspaceInstanceId** *(string) --* 

        Unique identifier of the retrieved WorkSpaces Instance.

        
      

      - **EC2ManagedInstance** *(dict) --* 

        Details of the associated EC2 managed instance.

        
        

        - **InstanceId** *(string) --* 

          Unique identifier of the managed EC2 instance.

          
    
      

      - **BillingConfiguration** *(dict) --* 

        Returns the current billing configuration for the WorkSpace Instance, indicating the active billing mode.

        
        

        - **BillingMode** *(string) --* 

          Specifies the billing mode for WorkSpace Instances. MONTHLY provides fixed monthly rates for predictable budgeting, while HOURLY enables pay-per-second billing for actual usage.

          
    
  
  **Exceptions**
  
  *   :py:class:`WorkspacesInstances.Client.exceptions.ValidationException`

  
  *   :py:class:`WorkspacesInstances.Client.exceptions.AccessDeniedException`

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

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

  
  *   :py:class:`WorkspacesInstances.Client.exceptions.InternalServerException`

  