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

************
create_share
************



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

  

  Creates a cross-account shared resource. The resource owner makes an offer to share the resource with the principal subscriber (an AWS user with a different account than the resource owner).

   

  The following resources support cross-account sharing:

   

  
  * HealthOmics variant stores
   
  * HealthOmics annotation stores
   
  * Private workflows
  

  

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


  **Request Syntax**
  ::

    response = client.create_share(
        resourceArn='string',
        principalSubscriber='string',
        shareName='string'
    )
    
  :type resourceArn: string
  :param resourceArn: **[REQUIRED]** 

    The ARN of the resource to be shared.

    

  
  :type principalSubscriber: string
  :param principalSubscriber: **[REQUIRED]** 

    The principal subscriber is the account being offered shared access to the resource.

    

  
  :type shareName: string
  :param shareName: 

    A name that the owner defines for the share.

    

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

    
    ::

      {
          'shareId': 'string',
          'status': 'PENDING'|'ACTIVATING'|'ACTIVE'|'DELETING'|'DELETED'|'FAILED',
          'shareName': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        The ID that HealthOmics generates for the share.

        
      

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

        The status of the share.

        
      

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

        The name of the share.

        
  
  **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`

  