DNAnexus Documentation
APIDownloadsIndex of dx CommandsLegal
  • Overview
  • Getting Started
    • DNAnexus Essentials
    • Key Concepts
      • Projects
      • Organizations
      • Apps and Workflows
    • User Interface Quickstart
    • Command Line Quickstart
    • Developer Quickstart
    • Developer Tutorials
      • Bash
        • Bash Helpers
        • Distributed by Chr (sh)
        • Distributed by Region (sh)
        • SAMtools count
        • TensorBoard Example Web App
        • Git Dependency
        • Mkfifo and dx cat
        • Parallel by Region (sh)
        • Parallel xargs by Chr
        • Precompiled Binary
        • R Shiny Example Web App
      • Python
        • Dash Example Web App
        • Distributed by Region (py)
        • Parallel by Chr (py)
        • Parallel by Region (py)
        • Pysam
      • Web App(let) Tutorials
        • Dash Example Web App
        • TensorBoard Example Web App
      • Concurrent Computing Tutorials
        • Distributed
          • Distributed by Region (sh)
          • Distributed by Chr (sh)
          • Distributed by Region (py)
        • Parallel
          • Parallel by Chr (py)
          • Parallel by Region (py)
          • Parallel by Region (sh)
          • Parallel xargs by Chr
  • User
    • Login and Logout
    • Projects
      • Project Navigation
      • Path Resolution
    • Running Apps and Workflows
      • Running Apps and Applets
      • Running Workflows
      • Running Nextflow Pipelines
      • Running Batch Jobs
      • Monitoring Executions
      • Job Notifications
      • Job Lifecycle
      • Executions and Time Limits
      • Executions and Cost and Spending Limits
      • Smart Reuse (Job Reuse)
      • Apps and Workflows Glossary
      • Tools List
    • Cohort Browser
      • Chart Types
        • Row Chart
        • Histogram
        • Box Plot
        • List View
        • Grouped Box Plot
        • Stacked Row Chart
        • Scatter Plot
        • Kaplan-Meier Survival Curve
      • Locus Details Page
    • Using DXJupyterLab
      • DXJupyterLab Quickstart
      • Running DXJupyterLab
        • FreeSurfer in DXJupyterLab
      • Spark Cluster-Enabled DXJupyterLab
        • Exploring and Querying Datasets
      • Stata in DXJupyterLab
      • Running Older Versions of DXJupyterLab
      • DXJupyterLab Reference
    • Using Spark
      • Apollo Apps
      • Connect to Thrift
      • Example Applications
        • CSV Loader
        • SQL Runner
        • VCF Loader
      • VCF Preprocessing
    • Environment Variables
    • Objects
      • Describing Data Objects
      • Searching Data Objects
      • Visualizing Data
      • Filtering Objects and Jobs
      • Archiving Files
      • Relational Database Clusters
      • Symlinks
      • Uploading and Downloading Files
        • Small File Sets
          • dx upload
          • dx download
        • Batch
          • Upload Agent
          • Download Agent
    • Platform IDs
    • Organization Member Guide
    • Index of dx commands
  • Developer
    • Developing Portable Pipelines
      • dxCompiler
    • Cloud Workstation
    • Apps
      • Introduction to Building Apps
      • App Build Process
      • Advanced Applet Tutorial
      • Bash Apps
      • Python Apps
      • Spark Apps
        • Table Exporter
        • DX Spark Submit Utility
      • HTTPS Apps
        • Isolated Browsing for HTTPS Apps
      • Transitioning from Applets to Apps
      • Third Party and Community Apps
        • Community App Guidelines
        • Third Party App Style Guide
        • Third Party App Publishing Checklist
      • App Metadata
      • App Permissions
      • App Execution Environment
        • Connecting to Jobs
      • Dependency Management
        • Asset Build Process
        • Docker Images
        • Python package installation in Ubuntu 24.04 AEE
      • Job Identity Tokens for Access to Clouds and Third-Party Services
      • Enabling Web Application Users to Log In with DNAnexus Credentials
      • Types of Errors
    • Workflows
      • Importing Workflows
      • Introduction to Building Workflows
      • Building and Running Workflows
      • Workflow Build Process
      • Versioning and Publishing Global Workflows
      • Workflow Metadata
    • Ingesting Data
      • Molecular Expression Assay Loader
        • Common Errors
        • Example Usage
        • Example Input
      • Data Model Loader
        • Data Ingestion Key Steps
        • Ingestion Data Types
        • Data Files Used by the Data Model Loader
        • Troubleshooting
      • Dataset Extender
        • Using Dataset Extender
    • Dataset Management
      • Rebase Cohorts and Dashboards
      • Assay Dataset Merger
      • Clinical Dataset Merger
    • Apollo Datasets
      • Dataset Versions
      • Cohorts
    • Creating Custom Viewers
    • Client Libraries
      • Support for Python 3
    • Walkthroughs
      • Creating a Mixed Phenotypic Assay Dataset
      • Guide for Ingesting a Simple Four Table Dataset
    • DNAnexus API
      • Entity IDs
      • Protocols
      • Authentication
      • Regions
      • Nonces
      • Users
      • Organizations
      • OIDC Clients
      • Data Containers
        • Folders and Deletion
        • Cloning
        • Project API Methods
        • Project Permissions and Sharing
      • Data Object Lifecycle
        • Types
        • Object Details
        • Visibility
      • Data Object Metadata
        • Name
        • Properties
        • Tags
      • Data Object Classes
        • Records
        • Files
        • Databases
        • Drives
        • DBClusters
      • Running Analyses
        • I/O and Run Specifications
        • Instance Types
        • Job Input and Output
        • Applets and Entry Points
        • Apps
        • Workflows and Analyses
        • Global Workflows
        • Containers for Execution
      • Search
      • System Methods
      • Directory of API Methods
      • DNAnexus Service Limits
  • Administrator
    • Billing
    • Org Management
    • Single Sign-On
    • Audit Trail
    • Integrating with External Services
    • Portal Setup
    • GxP
      • Controlled Tool Access (allowed executables)
  • Science Corner
    • Scientific Guides
      • Somatic Small Variant and CNV Discovery Workflow Walkthrough
      • SAIGE GWAS Walkthrough
      • LocusZoom DNAnexus App
      • Human Reference Genomes
    • Using Hail to Analyze Genomic Data
    • Open-Source Tools by DNAnexus Scientists
    • Using IGV Locally with DNAnexus
  • Downloads
  • FAQs
    • EOL Documentation
      • Python 3 Support and Python 2 End of Life (EOL)
    • Automating Analysis Workflow
    • Backups of Customer Data
    • Developing Apps and Applets
    • Importing Data
    • Platform Uptime
    • Legal and Compliance
    • Sharing and Collaboration
    • Product Version Numbering
  • Release Notes
  • Technical Support
  • Legal
Powered by GitBook

Copyright 2025 DNAnexus

On this page

Was this helpful?

Export as PDF
  1. Developer
  2. DNAnexus API

Regions

Last updated 1 year ago

Was this helpful?

On the DNAnexus Platform, a region is an abstraction that unifies access to different cloud providers, as well as to different geographical regions in which a single cloud provider may operate. By specifying a region for your DNAnexus resources, you can ensure that your files are stored in, and that your jobs run in, a particular physical location, in order to satisfy data locality requirements or latency requirements.

A region is represented by a string of the form "cloud:geo"; for example, "aws:us-east-1" denotes the "us-east-1" geographical region of the AWS cloud.

  • Projects and files have affinity to a particular region. A region is chosen for a project at creation time and is fixed throughout the lifetime of the project. All files uploaded to that project will be stored in object storage in the specified region, and all jobs run in that project will be run on instances located in the specified region.

  • You can clone files between projects in the same region. The DNAnexus Platform does not currently support transferring files or projects across regions. For example, you cannot clone a file in one region to a project of a different region.

  • Users and organizations have a set of permitted regions that they are allowed to use. In order to create a project in a particular region, the region must be among the permitted regions of the project's billTo.

To obtain access to additional regions, .

  • Users and organizations have a default region, which may be set by the user, or organization administrator, to any value among the permitted regions. This is the default region that is used when a new project is created and a region is not otherwise specified.

The following API routes consume or return regions:

  • and provide access to the permitted regions and default region of a profile (accessible as permittedRegions and defaultRegion, respectively). If you have permission to see the pricing models of the profile, those are also keyed by region (reflecting possibly different price sheets and instance types available in each region).

  • and allow updates to the defaultRegion field of a profile.

  • allows setting the region with which the newly created project will be associated.

  • and show the region with which the project or container is associated.

Region has implications for, among others, the following operations:

  • When using or , data objects can only be cloned from one container to another if the two containers share the same region.

  • As a special case of the above, if an app or applet is to be run in a project, the bundledDepends associated with the executable, the inputs to the executable, and the project itself must share the same region.

  • Changing the billTo of a project via or is only permitted if the region of the project is among the permittedRegions of the destination billTo.

Available Regions

Provider

Code

Name

AWS

aws:us-east-1

AWS US (East)

AWS

aws:eu-central-1

AWS Europe (Frankfurt)

AWS

aws:ap-southeast-2

AWS Asia Pacific (Sydney)

AWS

aws:eu-west-2

AWS UKB-RAP (London)

AWS

aws:eu-west-2-g

AWS Europe (London)

Azure

azure:westus

Azure West US

Azure

azure:westeurope

Azure West Europe

Azure

azure:uksouth-ofh

Azure OFH-TRE (London)

contact DNAnexus Sales
/project-xxxx/clone
/container-xxxx/clone
/project-xxxx/acceptTransfer
/project/new
/project-xxxx/describe
/project-xxxx/update
/user-xxxx/describe
/user-xxxx/update
/container-xxxx/describe
/org-xxxx/describe
/org-xxxx/update