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

UpdateSequenceStore

Update one or more parameters for the sequence store.

Request Syntax


PATCH /sequencestore/id HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "description": "string",
   "fallbackLocation": "string",
   "name": "string",
   "propagatedSetLevelTags": [ "string" ],
   "s3AccessConfig": { 
      "accessLogLocation": "string"
   }
}

URI Request Parameters

The request uses the following URI parameters.

id

The ID of the sequence store.

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

Pattern: [0-9]+

Required: Yes

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 sequence 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

fallbackLocation

The S3 URI of a bucket and folder to store Read Sets that fail to 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 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}]+

Required: No

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

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",
   "updateTime": "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 ARN of the sequence store.

Type: String

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

Pattern: arn:.+

creationTime

The time when the store was created.

Type: Timestamp

description

Description of the sequence 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}]+

eTagAlgorithmFamily

The ETag algorithm family to use on ingested read sets.

Type: String

Valid Values: MD5up | SHA256up | SHA512up

fallbackLocation

The S3 URI of a bucket and folder to store Read Sets that fail to upload.

Type: String

Pattern: s3://([a-z0-9][a-z0-9-.]{1,61}[a-z0-9])/?((.{1,1024})/)?

id

The ID of the sequence store.

Type: String

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

Pattern: [0-9]+

name

The name 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}]+

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

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

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}]+

updateTime

The last-updated time of the Sequence Store.

Type: Timestamp

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

ConflictException

The request cannot be applied to the target resource in its current state.

HTTP Status Code: 409

InternalServerException

An unexpected error occurred. Try the request again.

HTTP Status Code: 500

RequestTimeoutException

The request timed out.

HTTP Status Code: 408

ResourceNotFoundException

The target resource was not found in the current Region.

HTTP Status Code: 404

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