Omics / Client / list_read_set_upload_parts

list_read_set_upload_parts#

Omics.Client.list_read_set_upload_parts(**kwargs)#

This operation will list all parts in a requested multipart upload for a sequence store.

See also: AWS API Documentation

Request Syntax

response = client.list_read_set_upload_parts(
    sequenceStoreId='string',
    uploadId='string',
    partSource='SOURCE1'|'SOURCE2',
    maxResults=123,
    nextToken='string',
    filter={
        'createdAfter': datetime(2015, 1, 1),
        'createdBefore': datetime(2015, 1, 1)
    }
)
Parameters:
  • sequenceStoreId (string) –

    [REQUIRED]

    The Sequence Store ID used for the multipart uploads.

  • uploadId (string) –

    [REQUIRED]

    The ID for the initiated multipart upload.

  • partSource (string) –

    [REQUIRED]

    The source file for the upload part.

  • maxResults (integer) – The maximum number of read set upload parts returned in a page.

  • nextToken (string) – Next token returned in the response of a previous ListReadSetUploadPartsRequest call. Used to get the next page of results.

  • filter (dict) –

    Attributes used to filter for a specific subset of read set part uploads.

    • createdAfter (datetime) –

      Filters for read set uploads after a specified time.

    • createdBefore (datetime) –

      Filters for read set part uploads before a specified time.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'parts': [
        {
            'partNumber': 123,
            'partSize': 123,
            'partSource': 'SOURCE1'|'SOURCE2',
            'checksum': 'string',
            'creationTime': datetime(2015, 1, 1),
            'lastUpdatedTime': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

  • (dict) –

    • nextToken (string) –

      Next token returned in the response of a previous ListReadSetUploadParts call. Used to get the next page of results.

    • parts (list) –

      An array of upload parts.

      • (dict) –

        The metadata of a single part of a file that was added to a multipart upload. A list of these parts is returned in the response to the ListReadSetUploadParts API.

        • partNumber (integer) –

          The number identifying the part in an upload.

        • partSize (integer) –

          The size of the the part in an upload.

        • partSource (string) –

          The origin of the part being direct uploaded.

        • checksum (string) –

          A unique identifier used to confirm that parts are being added to the correct upload.

        • creationTime (datetime) –

          The time stamp for when a direct upload was created.

        • lastUpdatedTime (datetime) –

          The time stamp for the most recent update to an uploaded part.

Exceptions

  • Omics.Client.exceptions.InternalServerException

  • Omics.Client.exceptions.NotSupportedOperationException

  • Omics.Client.exceptions.ServiceQuotaExceededException

  • Omics.Client.exceptions.ThrottlingException

  • Omics.Client.exceptions.ValidationException

  • Omics.Client.exceptions.ResourceNotFoundException

  • Omics.Client.exceptions.AccessDeniedException

  • Omics.Client.exceptions.RequestTimeoutException