shares

Creates, updates, deletes, gets or lists a shares resource.

Overview

Name	shares
Type	Resource
Id	aws.omics.shares

Fields

The following fields are returned by SELECT queries:

get_share

Name	Datatype	Description
creation_time	string (date-time)	The timestamp of when the resource share was created.
owner_id	string	The account ID for the data owner. The owner creates the resource share.
principal_subscriber	string	The principal subscriber is the account that is sharing the resource.
resource_arn	string	The Arn of the shared resource.
resource_id	string	The ID of the shared resource.
share_id	string	The ID of the resource share.
share_name	string	The name of the resource share. (pattern: <code>[a-zA-Z0-9_-]+</code>)
status	string	The status of the share. (PENDING, ACTIVATING, ACTIVE, DELETING, DELETED, FAILED)
status_message	string	The status message for a resource share. It provides additional details about the share status.
update_time	string (date-time)	The timestamp of the resource share update.

list_shares

Name	Datatype	Description
creation_time	string (date-time)	The timestamp of when the resource share was created.
owner_id	string	The account ID for the data owner. The owner creates the resource share.
principal_subscriber	string	The principal subscriber is the account that is sharing the resource.
resource_arn	string	The Arn of the shared resource.
resource_id	string	The ID of the shared resource.
share_id	string	The ID of the resource share.
share_name	string	The name of the resource share. (pattern: <code>[a-zA-Z0-9_-]+</code>)
status	string	The status of the share. (PENDING, ACTIVATING, ACTIVE, DELETING, DELETED, FAILED)
status_message	string	The status message for a resource share. It provides additional details about the share status.
update_time	string (date-time)	The timestamp of the resource share update.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_share	select	share_id, region		Retrieves the metadata for the specified resource share.
list_shares	select	region	nextToken, maxResults	Retrieves the resource shares associated with an account. Use the filter parameter to retrieve a specific subset of the shares.
create_share	insert	region, resourceArn, principalSubscriber		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
delete_share	delete	share_id, region		Deletes a resource share. If you are the resource owner, the subscriber will no longer have access to the shared resource. If you are the subscriber, this operation deletes your access to the share.
accept_share	exec	share_id, region		Accept a resource share request.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
share_id	string	The ID of the resource share.
maxResults	integer	The maximum number of shares to return in one page of results.
nextToken	string	Next token returned in the response of a previous ListReadSetUploadPartsRequest call. Used to get the next page of results.

SELECT examples

get_share

Retrieves the metadata for the specified resource share.

SELECT
creation_time,
owner_id,
principal_subscriber,
resource_arn,
resource_id,
share_id,
share_name,
status,
status_message,
update_time
FROM aws.omics.shares
WHERE share_id = '{{ share_id }}' -- required
AND region = '{{ region }}' -- required
;

list_shares

Retrieves the resource shares associated with an account. Use the filter parameter to retrieve a specific subset of the shares.

SELECT
creation_time,
owner_id,
principal_subscriber,
resource_arn,
resource_id,
share_id,
share_name,
status,
status_message,
update_time
FROM aws.omics.shares
WHERE region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

INSERT examples

create_share

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

INSERT INTO aws.omics.shares (
resourceArn,
principalSubscriber,
shareName,
region
)
SELECT 
'{{ resourceArn }}' /* required */,
'{{ principalSubscriber }}' /* required */,
'{{ shareName }}',
'{{ region }}'
RETURNING
share_id,
share_name,
status
;

Manifest

# Description fields are for documentation purposes
- name: shares
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the shares resource.
  - name: resourceArn
    value: "{{ resourceArn }}"
  - name: principalSubscriber
    value: "{{ principalSubscriber }}"
  - name: shareName
    value: "{{ shareName }}"

DELETE examples

delete_share

Deletes a resource share. If you are the resource owner, the subscriber will no longer have access to the shared resource. If you are the subscriber, this operation deletes your access to the share.

DELETE FROM aws.omics.shares
WHERE share_id = '{{ share_id }}' --required
AND region = '{{ region }}' --required
;

Lifecycle Methods

accept_share

Accept a resource share request.

EXEC aws.omics.shares.accept_share 
@share_id='{{ share_id }}' --required, 
@region='{{ region }}' --required
;