Omics / Paginator / ListReadSetUploadParts

ListReadSetUploadParts#

class Omics.Paginator.ListReadSetUploadParts#
paginator = client.get_paginator('list_read_set_upload_parts')
paginate(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    sequenceStoreId='string',
    uploadId='string',
    partSource='SOURCE1'|'SOURCE2',
    filter={
        'createdAfter': datetime(2015, 1, 1),
        'createdBefore': datetime(2015, 1, 1)
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
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.

  • 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.

  • 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

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

Response Structure

  • (dict) –

    • 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.

    • NextToken (string) –

      A token to resume pagination.