Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateReferenceStore

Creates a reference store and returns metadata in JSON format. Reference stores are used to store reference genomes in FASTA format. A reference store is created when the first reference genome is imported. To import additional reference genomes from an Amazon S3 bucket, use the StartReferenceImportJob API operation.

For more information, see Creating a HealthOmics reference store in the AWS HealthOmics User Guide.

Request Syntax


POST /referencestore HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "description": "string",
   "name": "string",
   "sseConfig": { 
      "keyArn": "string",
      "type": "string"
   },
   "tags": { 
      "string" : "string" 
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

clientToken

To ensure that requests don't run multiple times, specify a unique token for each request.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 127.

Pattern: [\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+

Required: No

description

A description for the store.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+

Required: No

name

A name for the store.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 127.

Pattern: [\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+

Required: Yes

sseConfig

Server-side encryption (SSE) settings for the store.

Type: SseConfig object

Required: No

tags

Tags for the store.

Type: String to string map

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "arn": "string",
   "creationTime": "string",
   "description": "string",
   "id": "string",
   "name": "string",
   "sseConfig": { 
      "keyArn": "string",
      "type": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

arn

The store's ARN.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 127.

Pattern: arn:.+

creationTime

When the store was created.

Type: Timestamp

description

The store's description.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+

id

The store's ID.

Type: String

Length Constraints: Minimum length of 10. Maximum length of 36.

Pattern: [0-9]+

name

The store's name.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 127.

Pattern: [\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+

sseConfig

The store's SSE settings.

Type: SseConfig object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

An unexpected error occurred. Try the request again.

HTTP Status Code: 500

RequestTimeoutException

The request timed out.

HTTP Status Code: 408

ServiceQuotaExceededException

The request exceeds a service quota.

HTTP Status Code: 402

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400