Omics / Client / delete_annotation_store_versions

delete_annotation_store_versions#

Omics.Client.delete_annotation_store_versions(**kwargs)#

Deletes one or multiple versions of an annotation store.

See also: AWS API Documentation

Request Syntax

response = client.delete_annotation_store_versions(
    name='string',
    versions=[
        'string',
    ],
    force=True|False
)
Parameters:

  • name (string) –

    [REQUIRED]

    The name of the annotation store from which versions are being deleted.

  • versions (list) –

    [REQUIRED]

    The versions of an annotation store to be deleted.

    • (string) –

  • force (boolean) – Forces the deletion of an annotation store version when imports are in-progress..

Return type:

dict

Returns:

Response Syntax

{
    'errors': [
        {
            'versionName': 'string',
            'message': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • errors (list) –

      Any errors that occur when attempting to delete an annotation store version.

      • (dict) –

        The error preventing deletion of the annotation store version.

        • versionName (string) –

          The name given to an annotation store version.

        • message (string) –

          The message explaining the error in annotation store deletion.

Exceptions