Omics / Client / list_annotation_store_versions

list_annotation_store_versions#

Omics.Client.list_annotation_store_versions(**kwargs)#

Lists the versions of an annotation store.

See also: AWS API Documentation

Request Syntax

response = client.list_annotation_store_versions(
    name='string',
    maxResults=123,
    nextToken='string',
    filter={
        'status': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'FAILED'
    }
)
Parameters:

  • name (string) –

    [REQUIRED]

    The name of an annotation store.

  • maxResults (integer) – The maximum number of annotation store versions to return in one page of results.

  • nextToken (string) – Specifies the pagination token from a previous request to retrieve the next page of results.

  • filter (dict) –

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

    • status (string) –

      The status of an annotation store version.

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) –

      Specifies the pagination token from a previous request to retrieve the next page of results.

Exceptions

  • Omics.Client.exceptions.InternalServerException

  • Omics.Client.exceptions.ThrottlingException

  • Omics.Client.exceptions.ValidationException

  • Omics.Client.exceptions.ResourceNotFoundException

  • Omics.Client.exceptions.AccessDeniedException