Omics / Paginator / ListShares

ListShares

class Omics.Paginator.ListShares

paginator = client.get_paginator('list_shares')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Omics.Client.list_shares().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    resourceOwner='SELF'|'OTHER',
    filter={
        'resourceArns': [
            'string',
        ],
        'status': [
            'PENDING'|'ACTIVATING'|'ACTIVE'|'DELETING'|'DELETED'|'FAILED',
        ],
        'type': [
            'VARIANT_STORE'|'ANNOTATION_STORE'|'WORKFLOW',
        ]
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• resourceOwner (string) –

  [REQUIRED]

  The account that owns the resource shares.

• filter (dict) –

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

  • resourceArns (list) –

    Filter based on the Amazon Resource Number (ARN) of the resource. You can specify up to 10 values.

    • (string) –

  • status (list) –

    Filter based on the resource status. You can specify up to 10 values.

    • (string) –

  • type (list) –

    The type of resources to be filtered. You can specify one or more of the resource types.

    • (string) –

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'shares': [
        {
            'shareId': 'string',
            'resourceArn': 'string',
            'resourceId': '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 metadata details.

    • (dict) –

      The details of a resource share.

      • shareId (string) –

        The ID of the resource share.

      • resourceArn (string) –

        The Arn of the shared resource.

      • resourceId (string) –

        The ID of the shared resource.

      • principalSubscriber (string) –

        The principal subscriber is the account that is sharing the resource.

      • ownerId (string) –

        The account ID for the data owner. The owner creates the resource share.

      • status (string) –

        The status of the share.

      • statusMessage (string) –

        The status message for a resource share. It provides additional details about the share status.

      • shareName (string) –

        The name of the resource share.

      • creationTime (datetime) –

        The timestamp of when the resource share was created.

      • updateTime (datetime) –

        The timestamp of the resource share update.

  • NextToken (string) –

    A token to resume pagination.