Omics / Client / list_shares

list_shares#

Omics.Client.list_shares(**kwargs)#

Lists all shares associated with an account.

Request Syntax

response = client.list_shares(
    resourceOwner='SELF'|'OTHER',
    filter={
        'resourceArns': [
            'string',
        ],
        'status': [
            'PENDING'|'ACTIVATING'|'ACTIVE'|'DELETING'|'DELETED'|'FAILED',
        ]
    },
    nextToken='string',
    maxResults=123
)

Parameters:

resourceOwner (string) –
[REQUIRED]

The account that owns the analytics store shared.
filter (dict) –
Attributes used to filter for a specific subset of shares.
- resourceArns (list) –
  
  The Amazon Resource Number (Arn) for an analytics store.
  - (string) –
- status (list) –
  
  The status of an annotation store version.
  - (string) –
nextToken (string) – Next token returned in the response of a previous ListReadSetUploadPartsRequest call. Used to get the next page of results.
maxResults (integer) – The maximum number of shares to return in one page of results.

Return type:

dict

Returns:

Response Syntax

{
    'shares': [
        {
            'shareId': 'string',
            'resourceArn': '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)
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- shares (list) –
  
  The shares available and their meta details.
  - (dict) –
    
    The details of a share.
    - shareId (string) –
      
      The ID for a share offer for an analytics store .
    - resourceArn (string) –
      
      The resource Arn of the analytics store being shared.
    - principalSubscriber (string) –
      
      The principal subscriber is the account the analytics store data is being shared with.
    - ownerId (string) –
      
      The account ID for the data owner. The owner creates the share offer.
    - status (string) –
      
      The status of a share.
    - statusMessage (string) –
      
      The status message for a share. It provides more details on the status of the share.
    - shareName (string) –
      
      The name of the share.
    - creationTime (datetime) –
      
      The timestamp for when the share was created.
    - updateTime (datetime) –
      
      The timestamp of the share update.
- nextToken (string) –
  
  Next token returned in the response of a previous ListSharesResponse call. Used to get the next page of results.

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