Omics / Paginator / ListAnnotationStoreVersions

ListAnnotationStoreVersions

class Omics.Paginator.ListAnnotationStoreVersions

paginator = client.get_paginator('list_annotation_store_versions')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    name='string',
    filter={
        'status': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'FAILED'
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• name (string) –

  [REQUIRED]

  The name of an annotation store.

• filter (dict) –

  A filter to apply to the list of annotation store versions.

  • status (string) –

    The status of an annotation store version.

• 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

{
    'annotationStoreVersions': [
        {
            'storeId': 'string',
            'id': 'string',
            'status': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'FAILED',
            'versionArn': 'string',
            'name': 'string',
            'versionName': 'string',
            'description': 'string',
            'creationTime': datetime(2015, 1, 1),
            'updateTime': datetime(2015, 1, 1),
            'statusMessage': 'string',
            'versionSizeBytes': 123
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • annotationStoreVersions (list) –

    Lists all versions of an annotation store.

    • (dict) –

      Annotation store versions.

      • storeId (string) –

        The store ID for an annotation store version.

      • id (string) –

        The annotation store version ID.

      • status (string) –

        The status of an annotation store version.

      • versionArn (string) –

        The Arn for an annotation store version.

      • name (string) –

        A name given to an annotation store version to distinguish it from others.

      • versionName (string) –

        The name of an annotation store version.

      • description (string) –

        The description of an annotation store version.

      • creationTime (datetime) –

        The time stamp for when an annotation store version was created.

      • updateTime (datetime) –

        The time stamp for when an annotation store version was updated.

      • statusMessage (string) –

        The status of an annotation store version.

      • versionSizeBytes (integer) –

        The size of an annotation store version in Bytes.

  • NextToken (string) –

    A token to resume pagination.