:doc:`IoTTwinMaker <../../iottwinmaker>` / Client / get_workspace

*************
get_workspace
*************



.. py:method:: IoTTwinMaker.Client.get_workspace(**kwargs)

  

  Retrieves information about a workspace.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/iottwinmaker-2021-11-29/GetWorkspace>`_  


  **Request Syntax**
  ::

    response = client.get_workspace(
        workspaceId='string'
    )
    
  :type workspaceId: string
  :param workspaceId: **[REQUIRED]** 

    The ID of the workspace.

    

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

    
    ::

      {
          'workspaceId': 'string',
          'arn': 'string',
          'description': 'string',
          'linkedServices': [
              'string',
          ],
          's3Location': 'string',
          'role': 'string',
          'creationDateTime': datetime(2015, 1, 1),
          'updateDateTime': datetime(2015, 1, 1)
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **workspaceId** *(string) --* 

        The ID of the workspace.

        
      

      - **arn** *(string) --* 

        The ARN of the workspace.

        
      

      - **description** *(string) --* 

        The description of the workspace.

        
      

      - **linkedServices** *(list) --* 

        A list of services that are linked to the workspace.

        
        

        - *(string) --* 
    
      

      - **s3Location** *(string) --* 

        The ARN of the S3 bucket where resources associated with the workspace are stored.

        
      

      - **role** *(string) --* 

        The ARN of the execution role associated with the workspace.

        
      

      - **creationDateTime** *(datetime) --* 

        The date and time when the workspace was created.

        
      

      - **updateDateTime** *(datetime) --* 

        The date and time when the workspace was last updated.

        
  
  **Exceptions**
  
  *   :py:class:`IoTTwinMaker.Client.exceptions.InternalServerException`

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

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

  
  *   :py:class:`IoTTwinMaker.Client.exceptions.ValidationException`

  
  *   :py:class:`IoTTwinMaker.Client.exceptions.ServiceQuotaExceededException`

  