Skip to content

list_read_set_upload_parts

list_read_set_upload_parts(
    sequence_store_id: SequenceStoreId,
    upload_id: UploadId,
    part_source: ReadSetPartSource,
    *,
    config_overrides: Optional[OmicsClientConfig] = None,
    max_results: Optional[int] = None,
    next_token: Optional[NextToken] = None,
    filter: Optional[ReadSetUploadPartListFilter] = None,
) -> ListReadSetUploadPartsResponse

Lists all parts in a multipart read set upload for a sequence store and returns the metadata in a JSON formatted output.

Parameters:

  • sequence_store_id (SequenceStoreId) –

    The Sequence Store ID used for the multipart uploads.

  • upload_id (UploadId) –

    The ID for the initiated multipart upload.

  • part_source (ReadSetPartSource) –

    The source file for the upload part.

  • max_results (Optional[int], default: None ) –

    The maximum number of read set upload parts returned in a page.

  • next_token (Optional[NextToken], default: None ) –

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

  • filter (Optional[ReadSetUploadPartListFilter], default: None ) –

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

Raises:

Source code in docs_src/capo_omics/_services/omics.py
def list_read_set_upload_parts(
    self,
    sequence_store_id: "capo_omics.types.sequence_store_id.SequenceStoreId",
    upload_id: "capo_omics.types.upload_id.UploadId",
    part_source: "capo_omics.types.read_set_part_source.ReadSetPartSource",
    *,
    config_overrides: Optional[OmicsClientConfig] = None,
    max_results: Optional[int] = None,
    next_token: Optional["capo_omics.types.next_token.NextToken"] = None,
    filter: Optional[
        "capo_omics.types.read_set_upload_part_list_filter.ReadSetUploadPartListFilter"
    ] = None,
) -> "capo_omics.types.list_read_set_upload_parts_response.ListReadSetUploadPartsResponse":
    """<p>Lists all parts in a multipart read set upload for a sequence store and returns the metadata in a JSON formatted output.</p>

    Args:
        sequence_store_id: <p>The Sequence Store ID used for the multipart uploads.</p>
        upload_id: <p>The ID for the initiated multipart upload.</p>
        part_source: <p>The source file for the upload part.</p>
        max_results: <p>The maximum number of read set upload parts returned in a page.</p>
        next_token: <p>Next token returned in the response of a previous ListReadSetUploadPartsRequest call. Used to get the next page of results.</p>
        filter: <p>Attributes used to filter for a specific subset of read set part uploads.</p>

    Raises:
        capo_omics.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_omics.errors.internal_server_exception.InternalServerException: <p>An unexpected error occurred. Try the request again.</p>
        capo_omics.errors.not_supported_operation_exception.NotSupportedOperationException: <p> The operation is not supported by Amazon Omics, or the API does not exist. </p>
        capo_omics.errors.request_timeout_exception.RequestTimeoutException: <p>The request timed out.</p>
        capo_omics.errors.resource_not_found_exception.ResourceNotFoundException: <p>The target resource was not found in the current Region.</p>
        capo_omics.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The request exceeds a service quota.</p>
        capo_omics.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_omics.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
        capo_omics.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_omics.types.list_read_set_upload_parts_request.ListReadSetUploadPartsRequest]",
    ) -> OperationResponse[
        "capo_omics.types.list_read_set_upload_parts_response.ListReadSetUploadPartsResponse"
    ]:
        import capo_omics._operations.omics.list_read_set_upload_parts

        output, http_response = (
            capo_omics._operations.omics.list_read_set_upload_parts.list_read_set_upload_parts(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListReadSetUploadParts")
    )
    input_: capo_omics.types.list_read_set_upload_parts_request.ListReadSetUploadPartsRequest = {
        "sequence_store_id": sequence_store_id,
        "upload_id": upload_id,
        "part_source": part_source,
    }
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token
    if filter is not None:
        input_["filter"] = filter

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output