Omics / Client / batch_delete_read_set

batch_delete_read_set

Omics.Client.batch_delete_read_set(**kwargs)

Deletes one or more read sets. If the operation is successful, it returns a response with no body. If there is an error with deleting one of the read sets, the operation returns an error list. If the operation successfully deletes only a subset of files, it will return an error list for the remaining files that fail to be deleted. There is a limit of 100 read sets that can be deleted in each BatchDeleteReadSet API call.

See also: AWS API Documentation

Request Syntax

response = client.batch_delete_read_set(
    ids=[
        'string',
    ],
    sequenceStoreId='string'
)

Parameters:

• ids (list) –

  [REQUIRED]

  The read sets’ IDs.

  • (string) –

• sequenceStoreId (string) –

  [REQUIRED]

  The read sets’ sequence store ID.

Return type:

dict

Returns:

Response Syntax

{
    'errors': [
        {
            'id': 'string',
            'code': 'string',
            'message': 'string'
        },
    ]
}

Response Structure

• (dict) –

  • errors (list) –

    Errors returned by individual delete operations.

    • (dict) –

      An error from a batch read set operation.

      • id (string) –

        The error’s ID.

      • code (string) –

        The error’s code.

      • message (string) –

        The error’s message.

Exceptions

• Omics.Client.exceptions.InternalServerException

• Omics.Client.exceptions.ThrottlingException

• Omics.Client.exceptions.ValidationException

• Omics.Client.exceptions.ResourceNotFoundException

• Omics.Client.exceptions.AccessDeniedException

• Omics.Client.exceptions.RequestTimeoutException