CreateSequenceStore
Creates a sequence store.
Request Syntax
POST /sequencestore HTTP/1.1
Content-type: application/json
{
"clientToken": "string",
"description": "string",
"eTagAlgorithmFamily": "string",
"fallbackLocation": "string",
"name": "string",
"propagatedSetLevelTags": [ "string" ],
"s3AccessConfig": {
"accessLogLocation": "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
- eTagAlgorithmFamily
-
The ETag algorithm family to use for ingested read sets.
Type: String
Valid Values:
MD5up | SHA256up | SHA512upRequired: No
- fallbackLocation
-
An S3 location that is used to store files that have failed a direct upload.
Type: String
Pattern:
s3://([a-z0-9][a-z0-9-.]{1,61}[a-z0-9])/?((.{1,1024})/)?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
- propagatedSetLevelTags
-
The tags keys to propagate to the S3 objects associated with read sets in the sequence store.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 50 items.
Length Constraints: Minimum length of 1. Maximum length of 128.
Required: No
- s3AccessConfig
-
S3 access configuration parameters
Type: S3AccessConfig object
Required: No
- sseConfig
-
Server-side encryption (SSE) settings for the store.
Type: SseConfig object
Required: No
-
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",
"eTagAlgorithmFamily": "string",
"fallbackLocation": "string",
"id": "string",
"name": "string",
"propagatedSetLevelTags": [ "string" ],
"s3Access": {
"accessLogLocation": "string",
"s3AccessPointArn": "string",
"s3Uri": "string"
},
"sseConfig": {
"keyArn": "string",
"type": "string"
},
"status": "string",
"statusMessage": "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}]+ - eTagAlgorithmFamily
-
The algorithm family of the ETag.
Type: String
Valid Values:
MD5up | SHA256up | SHA512up - fallbackLocation
-
An S3 location that is used to store files that have failed a direct upload.
Type: String
Pattern:
s3://([a-z0-9][a-z0-9-.]{1,61}[a-z0-9])/?((.{1,1024})/)? - 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}]+ - propagatedSetLevelTags
-
The tags keys to propagate to the S3 objects associated with read sets in the sequence store.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 50 items.
Length Constraints: Minimum length of 1. Maximum length of 128.
- s3Access
-
The S3 access metadata of the sequence store.
Type: SequenceStoreS3Access object
- sseConfig
-
The store's SSE settings.
Type: SseConfig object
- status
-
The status of the sequence store.
Type: String
Valid Values:
CREATING | ACTIVE | UPDATING | DELETING | FAILED - statusMessage
-
The status message of the sequence 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}]+
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
