NIH | National Cancer Institute | NCI Wiki  

Error rendering macro 'rw-search'

null

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 7 Next »

If your user account has the Read, Write, or Own permission level on various collections, you can download one or more data files in those collections, from DME to an Amazon Web Services (AWS) S3 bucket. 

To download one or more data files to S3:

  1. Prepare an S3 bucket, as described in Preparing to use Amazon Web Services S3 with DME. 

  2. Consider whether you want to download a single data file or multiple data files: 

    • To download a single data file: Plan to specify the path for that data file in the command. 
    • To download multiple data files: In your file system, use a command line editor (such as vi editor) to create a file that lists the paths for all of the DME data files you want to download, delimited by newline. Plan to use the -f option to specify that file in the command. 

  3. Run the following command:

    dm_download_dataojbect_s3 [optional parameters] [archive-path] <destination S3 bucket> <destination-path> [AWS credentials file path]

    The following table describes each parameter:

    ParameterDescription
    [-D <REST-response>]

    An optional parameter, specifying a path and filename in your file system. The system always creates a response file:

    • If you specify this parameter, the system saves the response from the server to the specified file in the specified location.
    • If you omit this parameter, the system saves the file as download-dataobject-response-header.tmp in your home directory.
    [-o <output-json-file>]

    An optional parameter, specifying a path and filename in your file system. The system always creates an output file: 

    • If you specify this parameter, the system saves the output to the specified file in the specified location.
    • If you omit this parameter, the system saves the output as download-dataobject-response-message.json.tmp in your home directory.

    If the command is successful, the output file is empty.

    [-f <paths-file>]

    or

    [archive-path]

    One or more paths within DME. Select one of the following methods to specify the data file or data files that you want to download:

    • To specify multiple data files, use the -f parameter to specify a path and filename in your file system, of a file that lists the paths for all of the DME data files you want to download, delimited by newline.
    • To specify a single data file, specify the path for the DME data file you want to download.
    <destination S3 bucket>
    		The name of the destination S3 bucket.
    <destination path>
    		The path to and the name of the folder in the destination bucket. Do not begin the path with a slash.
    [AWS credentials file path]

    The location of the credentials file. If your credentials file is in the default location, as noted in Preparing to use Amazon Web Services S3 with DME, you can omit this parameter.

The following example downloads a data.txt data file from the Project_1 collection in DME to a bucket1 bucket in a collectionA collection. 

Single Collection Example
dm_download_dataobject_s3 /Example_Archive/PI_Lab1/Project_1/data.txt bucket1 collectionA

For another example, consider the following command.

Multiple Collections Example
dm_download_dataobject_s3 -f file-list.txt bucket1 collectionA

With the following code in the specified file-list.txt file, the above command downloads multiple data files from various locations in DME.

Contents of collection-list.txt File
/Example_Archive/PI_Lab2/Project_1/data.txt
/Example_Archive/PI_Lab2/Project_2/image.jpg
/Example_Archive/PI_Lab3/Project_1/image.png

For instructions on performing similar tasks in the GUI, refer to Downloading Data via the GUI.  

  • No labels