Omics / Client / get_share

get_share#

Omics.Client.get_share(**kwargs)#

Retrieves the metadata for a share.

See also: AWS API Documentation

Request Syntax

response = client.get_share(
    shareId='string'
)
Parameters:

shareId (string) –

[REQUIRED]

The generated ID for a share.

Return type:

dict

Returns:

Response Syntax

{
    'share': {
        '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)
    }
}

Response Structure

  • (dict) –

    • share (dict) –

      An analytic store share details object. contains status, resourceArn, ownerId, etc.

      • 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.

Exceptions