create_sequence_store
async
¶
create_sequence_store(
name: SequenceStoreName,
*,
config_overrides: Optional[AsyncOmicsClientConfig] = None,
description: Optional[SequenceStoreDescription] = None,
sse_config: Optional[SseConfig] = None,
tags: Optional[TagMap] = None,
client_token: Optional[ClientToken] = None,
fallback_location: Optional[FallbackLocation] = None,
e_tag_algorithm_family: Optional[ETagAlgorithmFamily] = None,
propagated_set_level_tags: Optional[PropagatedSetLevelTags] = None,
s3_access_config: Optional[S3AccessConfig] = None,
) -> CreateSequenceStoreResponse
Creates a sequence store and returns its metadata. Sequence stores are used to store sequence data files called read sets that are saved in FASTQ, BAM, uBAM, or CRAM formats. For aligned formats (BAM and CRAM), a sequence store can only use one reference genome. For unaligned formats (FASTQ and uBAM), a reference genome is not required. You can create multiple sequence stores per region per account.
The following are optional parameters you can specify for your sequence store:
-
Use
s3AccessConfigto configure your sequence store with S3 access logs (recommended). -
Use
sseConfigto define your own KMS key for encryption. -
Use
eTagAlgorithmFamilyto define which algorithm to use for the HealthOmics eTag on objects. -
Use
fallbackLocationto define a backup location for storing files that have failed a direct upload. -
Use
propagatedSetLevelTagsto configure tags that propagate to all objects in your store.
For more information, see Creating a HealthOmics sequence store in the Amazon Web Services HealthOmics User Guide.
Parameters:
-
name(SequenceStoreName) –A name for the store.
-
description(Optional[SequenceStoreDescription], default:None) –A description for the store.
-
sse_config(Optional[SseConfig], default:None) –Server-side encryption (SSE) settings for the store.
-
tags(Optional[TagMap], default:None) –Tags for the store. You can configure up to 50 tags.
-
client_token(Optional[ClientToken], default:None) –An idempotency token used to dedupe retry requests so that duplicate runs are not created.
-
fallback_location(Optional[FallbackLocation], default:None) –An S3 location that is used to store files that have failed a direct upload. You can add or change the
fallbackLocationafter creating a sequence store. This is not required if you are uploading files from a different S3 bucket. -
e_tag_algorithm_family(Optional[ETagAlgorithmFamily], default:None) –The ETag algorithm family to use for ingested read sets. The default value is MD5up. For more information on ETags, see ETags and data provenance in the Amazon Web Services HealthOmics User Guide.
-
propagated_set_level_tags(Optional[PropagatedSetLevelTags], default:None) –The tags keys to propagate to the S3 objects associated with read sets in the sequence store. These tags can be used as input to add metadata to your read sets.
-
s3_access_config(Optional[S3AccessConfig], default:None) –S3 access configuration parameters. This specifies the parameters needed to access logs stored in S3 buckets. The S3 bucket must be in the same region and account as the sequence store.
Raises:
-
AccessDeniedException–You do not have sufficient access to perform this action.
-
InternalServerException–An unexpected error occurred. Try the request again.
-
RequestTimeoutException–The request timed out.
-
ServiceQuotaExceededException–The request exceeds a service quota.
-
ThrottlingException–The request was denied due to request throttling.
-
ValidationException–The input fails to satisfy the constraints specified by an Amazon Web Services service.
-
UnknownServiceError–The service returned an error code this client does not model.
Source code in docs_src/capo_omics/_services/async_omics.py
4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 | |