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',
        ]
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
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) –

  • 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',
            '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) –

      A token to resume pagination.