:doc:`Omics <../../omics>` / Client / create_multipart_read_set_upload

********************************
create_multipart_read_set_upload
********************************



.. py:method:: Omics.Client.create_multipart_read_set_upload(**kwargs)

  

  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 ``uploadId`` obtained from the previous call to ``CreateMultipartReadSetUpload``.
   
  * 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 <https://docs.aws.amazon.com/omics/latest/dev/synchronous-uploads.html>`__ in the *Amazon Web Services HealthOmics User Guide*.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/CreateMultipartReadSetUpload>`_  


  **Request Syntax**
  ::

    response = client.create_multipart_read_set_upload(
        sequenceStoreId='string',
        clientToken='string',
        sourceFileType='FASTQ'|'BAM'|'CRAM'|'UBAM',
        subjectId='string',
        sampleId='string',
        generatedFrom='string',
        referenceArn='string',
        name='string',
        description='string',
        tags={
            'string': 'string'
        }
    )
    
  :type sequenceStoreId: string
  :param sequenceStoreId: **[REQUIRED]** 

    The sequence store ID for the store that is the destination of the multipart uploads.

    

  
  :type clientToken: string
  :param clientToken: 

    An idempotency token that can be used to avoid triggering multiple multipart uploads.

    

  
  :type sourceFileType: string
  :param sourceFileType: **[REQUIRED]** 

    The type of file being uploaded.

    

  
  :type subjectId: string
  :param subjectId: **[REQUIRED]** 

    The source's subject ID.

    

  
  :type sampleId: string
  :param sampleId: **[REQUIRED]** 

    The source's sample ID.

    

  
  :type generatedFrom: string
  :param generatedFrom: 

    Where the source originated.

    

  
  :type referenceArn: string
  :param referenceArn: 

    The ARN of the reference.

    

  
  :type name: string
  :param name: **[REQUIRED]** 

    The name of the read set.

    

  
  :type description: string
  :param description: 

    The description of the read set.

    

  
  :type tags: dict
  :param tags: 

    Any tags to add to the read set.

    

  
    - *(string) --* 

    
      - *(string) --* 

      


  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'sequenceStoreId': 'string',
          'uploadId': 'string',
          'sourceFileType': 'FASTQ'|'BAM'|'CRAM'|'UBAM',
          'subjectId': 'string',
          'sampleId': 'string',
          'generatedFrom': 'string',
          'referenceArn': 'string',
          'name': 'string',
          'description': 'string',
          'tags': {
              'string': 'string'
          },
          'creationTime': datetime(2015, 1, 1)
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **sequenceStoreId** *(string) --* 

        The sequence store ID for the store that the read set will be created in.

        
      

      - **uploadId** *(string) --* 

        The ID for the initiated multipart upload.

        
      

      - **sourceFileType** *(string) --* 

        The file type of the read set source.

        
      

      - **subjectId** *(string) --* 

        The source's subject ID.

        
      

      - **sampleId** *(string) --* 

        The source's sample ID.

        
      

      - **generatedFrom** *(string) --* 

        The source of the read set.

        
      

      - **referenceArn** *(string) --* 

        The read set source's reference ARN.

        
      

      - **name** *(string) --* 

        The name of the read set.

        
      

      - **description** *(string) --* 

        The description of the read set.

        
      

      - **tags** *(dict) --* 

        The tags to add to the read set.

        
        

        - *(string) --* 
          

          - *(string) --* 
    
  
      

      - **creationTime** *(datetime) --* 

        The creation time of the multipart upload.

        
  
  **Exceptions**
  
  *   :py:class:`Omics.Client.exceptions.InternalServerException`

  
  *   :py:class:`Omics.Client.exceptions.NotSupportedOperationException`

  
  *   :py:class:`Omics.Client.exceptions.ServiceQuotaExceededException`

  
  *   :py:class:`Omics.Client.exceptions.ThrottlingException`

  
  *   :py:class:`Omics.Client.exceptions.ValidationException`

  
  *   :py:class:`Omics.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`Omics.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`Omics.Client.exceptions.RequestTimeoutException`

  