Omics / Client / create_share

create_share#

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

Request Syntax

response = client.create_share(
    resourceArn='string',
    principalSubscriber='string',
    shareName='string'
)
Parameters:

  • resourceArn (string) –

    [REQUIRED]

    The ARN of the resource to be shared.

  • principalSubscriber (string) –

    [REQUIRED]

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

  • shareName (string) – A name that the owner defines for the share.

Return type:

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

  • Omics.Client.exceptions.InternalServerException

  • Omics.Client.exceptions.ServiceQuotaExceededException

  • Omics.Client.exceptions.ThrottlingException

  • Omics.Client.exceptions.ValidationException

  • Omics.Client.exceptions.ConflictException

  • Omics.Client.exceptions.ResourceNotFoundException

  • Omics.Client.exceptions.AccessDeniedException