Omics / Client / create_share
create_share#
- Omics.Client.create_share(**kwargs)#
Creates a share offer that can be accepted outside the account by a subscriber. The share is created by the owner and accepted by the principal subscriber.
See also: AWS API Documentation
Request Syntax
response = client.create_share( resourceArn='string', principalSubscriber='string', shareName='string' )
- Parameters:
resourceArn (string) –
[REQUIRED]
The resource ARN for the analytics store to be shared.
principalSubscriber (string) –
[REQUIRED]
The principal subscriber is the account being given access to the analytics store data through the share offer.
shareName (string) – A name given to the share.
- Return type:
dict
- Returns:
Response Syntax
{ 'shareId': 'string', 'status': 'PENDING'|'ACTIVATING'|'ACTIVE'|'DELETING'|'DELETED'|'FAILED', 'shareName': 'string' }
Response Structure
(dict) –
shareId (string) –
An ID generated for the share.
status (string) –
The status of a share.
shareName (string) –
A name given to 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