:doc:`PrometheusService <../../amp>` / Client / describe_workspace

******************
describe_workspace
******************



.. py:method:: PrometheusService.Client.describe_workspace(**kwargs)

  

  Returns information about an existing workspace.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/DescribeWorkspace>`_  


  **Request Syntax**
  ::

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

    The ID of the workspace to describe.

    

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

    
    ::

      {
          'workspace': {
              'workspaceId': 'string',
              'alias': 'string',
              'arn': 'string',
              'status': {
                  'statusCode': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'CREATION_FAILED'
              },
              'prometheusEndpoint': 'string',
              'createdAt': datetime(2015, 1, 1),
              'tags': {
                  'string': 'string'
              },
              'kmsKeyArn': 'string'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 

      Represents the output of a ``DescribeWorkspace`` operation.

      
      

      - **workspace** *(dict) --* 

        A structure that contains details about the workspace.

        
        

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

          The unique ID for the workspace. For example, ``ws-example1-1234-abcd-5678-ef90abcd1234``.

          
        

        - **alias** *(string) --* 

          The alias that is assigned to this workspace to help identify it. It does not need to be unique.

          
        

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

          The ARN of the workspace. For example, ``arn:aws:aps:<region>:123456789012:workspace/ws-example1-1234-abcd-5678-ef90abcd1234``.

          
        

        - **status** *(dict) --* 

          The current status of the workspace.

          
          

          - **statusCode** *(string) --* 

            The current status of the workspace.

            
      
        

        - **prometheusEndpoint** *(string) --* 

          The Prometheus endpoint available for this workspace. For example, ``https://aps-workspaces.<region>.amazonaws.com/workspaces/ws-example1-1234-abcd-5678-ef90abcd1234/api/v1/``.

          
        

        - **createdAt** *(datetime) --* 

          The date and time that the workspace was created.

          
        

        - **tags** *(dict) --* 

          The list of tag keys and values that are associated with the workspace.

          
          

          - *(string) --* 

            The key of the tag. Must not begin with ``aws:``.

            
            

            - *(string) --* 

              The value of the tag.

              
      
    
        

        - **kmsKeyArn** *(string) --* 

          (optional) If the workspace was created with a customer managed KMS key, the ARN for the key used.

          
    
  
  **Exceptions**
  
  *   :py:class:`PrometheusService.Client.exceptions.ThrottlingException`

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

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

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

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

  