Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . omics ]

create-multipart-read-set-upload

Description

Begins a multipart read set upload.

See also: AWS API Documentation

Synopsis

  create-multipart-read-set-upload
--sequence-store-id <value>
[--client-token <value>]
--source-file-type <value>
--subject-id <value>
--sample-id <value>
[--generated-from <value>]
[--reference-arn <value>]
--name <value>
[--description <value>]
[--tags <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--sequence-store-id (string)

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

--client-token (string)

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

--source-file-type (string)

The type of file being uploaded.

Possible values:

• FASTQ
• BAM
• CRAM
• UBAM

--subject-id (string)

The source's subject ID.

--sample-id (string)

The source's sample ID.

--generated-from (string)

Where the source originated.

--reference-arn (string)

The ARN of the reference.

--name (string)

The name of the read set.

--description (string)

The description of the read set.

--tags (map)

Any tags to add to the read set.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To begin a multipart read set upload.

The following create-multipart-read-set-upload example initiates a multipart read set upload.

aws omics create-multipart-read-set-upload \
    --sequence-store-id 0123456789 \
    --name HG00146 \
    --source-file-type FASTQ \
    --subject-id mySubject\
    --sample-id mySample\
    --description "FASTQ for HG00146"\
    --generated-from "1000 Genomes"

Output:

{
    "creationTime": "2022-07-13T23:25:20Z",
    "description": "FASTQ for HG00146",
    "generatedFrom": "1000 Genomes",
    "name": "HG00146",
    "sampleId": "mySample",
    "sequenceStoreId": "0123456789",
    "sourceFileType": "FASTQ",
    "subjectId": "mySubject",
    "uploadId": "1122334455"
}

For more information, see Direct upload to a sequence store in the AWS HealthOmics User Guide.

Output

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 -> (map)

The tags to add to the read set.

key -> (string)

value -> (string)

creationTime -> (timestamp)

The creation time of the multipart upload.