List Shares

omics_list_shares

R Documentation

Retrieves the resource shares associated with an account

Description

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

Usage

omics_list_shares(resourceOwner, filter, nextToken, maxResults)

Arguments

resourceOwner

[required] The account that owns the resource shares.

filter

Attributes that you use to filter for a specific subset of resource shares.

nextToken

Next token returned in the response of a previous ListReadSetUploadPartsRequest call. Used to get the next page of results.

maxResults

The maximum number of shares to return in one page of results.

Value

A list with the following syntax:

list(
  shares = list(
    list(
      shareId = "string",
      resourceArn = "string",
      resourceId = "string",
      principalSubscriber = "string",
      ownerId = "string",
      status = "PENDING"|"ACTIVATING"|"ACTIVE"|"DELETING"|"DELETED"|"FAILED",
      statusMessage = "string",
      shareName = "string",
      creationTime = as.POSIXct(
        "2015-01-01"
      ),
      updateTime = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  nextToken = "string"
)

Request syntax

svc$list_shares(
  resourceOwner = "SELF"|"OTHER",
  filter = list(
    resourceArns = list(
      "string"
    ),
    status = list(
      "PENDING"|"ACTIVATING"|"ACTIVE"|"DELETING"|"DELETED"|"FAILED"
    ),
    type = list(
      "VARIANT_STORE"|"ANNOTATION_STORE"|"WORKFLOW"
    )
  ),
  nextToken = "string",
  maxResults = 123
)