create_multipart_read_set_upload
async
¶
create_multipart_read_set_upload(
sequence_store_id: SequenceStoreId,
source_file_type: FileType,
subject_id: SubjectId,
sample_id: SampleId,
name: ReadSetName,
*,
config_overrides: Optional[AsyncOmicsClientConfig] = None,
client_token: Optional[ClientToken] = None,
generated_from: Optional[GeneratedFrom] = None,
reference_arn: Optional[ReferenceArn] = None,
description: Optional[ReadSetDescription] = None,
tags: Optional[TagMap] = None,
) -> CreateMultipartReadSetUploadResponse
Initiates a multipart read set upload for uploading partitioned source files into a sequence store. You can directly import source files from an EC2 instance and other local compute, or from an S3 bucket. To separate these source files into parts, use the split operation. Each part cannot be larger than 100 MB. If the operation is successful, it provides an uploadId which is required by the UploadReadSetPart API operation to upload parts into a sequence store.
To continue uploading a multipart read set into your sequence store, you must use the UploadReadSetPart API operation to upload each part individually following the steps below:
-
Specify the
uploadIdobtained from the previous call toCreateMultipartReadSetUpload. -
Upload parts for that
uploadId.
When you have finished uploading parts, use the CompleteMultipartReadSetUpload API to complete the multipart read set upload and to retrieve the final read set IDs in the response.
To learn more about creating parts and the split operation, see Direct upload to a sequence store in the Amazon Web Services HealthOmics User Guide.
Parameters:
-
sequence_store_id(SequenceStoreId) –The sequence store ID for the store that is the destination of the multipart uploads.
-
client_token(Optional[ClientToken], default:None) –An idempotency token that can be used to avoid triggering multiple multipart uploads.
-
source_file_type(FileType) –The type of file being uploaded.
-
subject_id(SubjectId) –The source's subject ID.
-
sample_id(SampleId) –The source's sample ID.
-
generated_from(Optional[GeneratedFrom], default:None) –Where the source originated.
-
reference_arn(Optional[ReferenceArn], default:None) –The ARN of the reference.
-
name(ReadSetName) –The name of the read set.
-
description(Optional[ReadSetDescription], default:None) –The description of the read set.
-
tags(Optional[TagMap], default:None) –Any tags to add to the read set.
Raises:
-
AccessDeniedException–You do not have sufficient access to perform this action.
-
InternalServerException–An unexpected error occurred. Try the request again.
-
NotSupportedOperationException–The operation is not supported by Amazon Omics, or the API does not exist.
-
RequestTimeoutException–The request timed out.
-
ResourceNotFoundException–The target resource was not found in the current Region.
-
ServiceQuotaExceededException–The request exceeds a service quota.
-
ThrottlingException–The request was denied due to request throttling.
-
ValidationException–The input fails to satisfy the constraints specified by an Amazon Web Services service.
-
UnknownServiceError–The service returned an error code this client does not model.
Source code in docs_src/capo_omics/_services/async_omics.py
4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 | |