:doc:`Omics <../../omics>` / Client / get_share

*********
get_share
*********



.. py:method:: Omics.Client.get_share(**kwargs)

  

  Retrieves the metadata for the specified resource share.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/GetShare>`_  


  **Request Syntax**
  ::

    response = client.get_share(
        shareId='string'
    )
    
  :type shareId: string
  :param shareId: **[REQUIRED]** 

    The ID of the share.

    

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

    
    ::

      {
          'share': {
              'shareId': 'string',
              'resourceArn': 'string',
              'resourceId': 'string',
              'principalSubscriber': 'string',
              'ownerId': 'string',
              'status': 'PENDING'|'ACTIVATING'|'ACTIVE'|'DELETING'|'DELETED'|'FAILED',
              'statusMessage': 'string',
              'shareName': 'string',
              'creationTime': datetime(2015, 1, 1),
              'updateTime': datetime(2015, 1, 1)
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **share** *(dict) --* 

        A resource share details object. The object includes the status, the resourceArn, and ownerId.

        
        

        - **shareId** *(string) --* 

          The ID of the resource share.

          
        

        - **resourceArn** *(string) --* 

          The Arn of the shared resource.

          
        

        - **resourceId** *(string) --* 

          The ID of the shared resource.

          
        

        - **principalSubscriber** *(string) --* 

          The principal subscriber is the account that is sharing the resource.

          
        

        - **ownerId** *(string) --* 

          The account ID for the data owner. The owner creates the resource share.

          
        

        - **status** *(string) --* 

          The status of the share.

          
        

        - **statusMessage** *(string) --* 

          The status message for a resource share. It provides additional details about the share status.

          
        

        - **shareName** *(string) --* 

          The name of the resource share.

          
        

        - **creationTime** *(datetime) --* 

          The timestamp of when the resource share was created.

          
        

        - **updateTime** *(datetime) --* 

          The timestamp of the resource share update.

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

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

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

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

  
  *   :py:class:`Omics.Client.exceptions.ConflictException`

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

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

  