- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
CreateSequenceStoreCommand
Creates a sequence store.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { OmicsClient, CreateSequenceStoreCommand } from "@aws-sdk/client-omics"; // ES Modules import
// const { OmicsClient, CreateSequenceStoreCommand } = require("@aws-sdk/client-omics"); // CommonJS import
const client = new OmicsClient(config);
const input = { // CreateSequenceStoreRequest
name: "STRING_VALUE", // required
description: "STRING_VALUE",
sseConfig: { // SseConfig
type: "STRING_VALUE", // required
keyArn: "STRING_VALUE",
},
tags: { // TagMap
"<keys>": "STRING_VALUE",
},
clientToken: "STRING_VALUE",
fallbackLocation: "STRING_VALUE",
eTagAlgorithmFamily: "STRING_VALUE",
propagatedSetLevelTags: [ // PropagatedSetLevelTags
"STRING_VALUE",
],
s3AccessConfig: { // S3AccessConfig
accessLogLocation: "STRING_VALUE",
},
};
const command = new CreateSequenceStoreCommand(input);
const response = await client.send(command);
// { // CreateSequenceStoreResponse
// id: "STRING_VALUE", // required
// arn: "STRING_VALUE", // required
// name: "STRING_VALUE",
// description: "STRING_VALUE",
// sseConfig: { // SseConfig
// type: "STRING_VALUE", // required
// keyArn: "STRING_VALUE",
// },
// creationTime: new Date("TIMESTAMP"), // required
// fallbackLocation: "STRING_VALUE",
// eTagAlgorithmFamily: "STRING_VALUE",
// status: "STRING_VALUE",
// statusMessage: "STRING_VALUE",
// propagatedSetLevelTags: [ // PropagatedSetLevelTags
// "STRING_VALUE",
// ],
// s3Access: { // SequenceStoreS3Access
// s3Uri: "STRING_VALUE",
// s3AccessPointArn: "STRING_VALUE",
// accessLogLocation: "STRING_VALUE",
// },
// };
CreateSequenceStoreCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
name Required | string | undefined | A name for the store. |
clientToken | string | undefined | To ensure that requests don't run multiple times, specify a unique token for each request. |
description | string | undefined | A description for the store. |
eTagAlgorithmFamily | ETagAlgorithmFamily | undefined | The ETag algorithm family to use for ingested read sets. |
fallbackLocation | string | undefined | An S3 location that is used to store files that have failed a direct upload. |
propagatedSetLevelTags | string[] | undefined | The tags keys to propagate to the S3 objects associated with read sets in the sequence store. |
s3AccessConfig | S3AccessConfig | undefined | S3 access configuration parameters |
sseConfig | SseConfig | undefined | Server-side encryption (SSE) settings for the store. |
tags | Record<string, string> | undefined | Tags for the store. |
CreateSequenceStoreCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
arn Required | string | undefined | The store's ARN. |
creationTime Required | Date | undefined | When the store was created. |
id Required | string | undefined | The store's ID. |
description | string | undefined | The store's description. |
eTagAlgorithmFamily | ETagAlgorithmFamily | undefined | The algorithm family of the ETag. |
fallbackLocation | string | undefined | An S3 location that is used to store files that have failed a direct upload. |
name | string | undefined | The store's name. |
propagatedSetLevelTags | string[] | undefined | The tags keys to propagate to the S3 objects associated with read sets in the sequence store. |
s3Access | SequenceStoreS3Access | undefined | The S3 access metadata of the sequence store. |
sseConfig | SseConfig | undefined | The store's SSE settings. |
status | SequenceStoreStatus | undefined | The status of the sequence store. |
statusMessage | string | undefined | The status message of the sequence store. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
AccessDeniedException | client | You do not have sufficient access to perform this action. |
InternalServerException | server | An unexpected error occurred. Try the request again. |
RequestTimeoutException | client | The request timed out. |
ServiceQuotaExceededException | client | The request exceeds a service quota. |
ThrottlingException | client | The request was denied due to request throttling. |
ValidationException | client | The input fails to satisfy the constraints specified by an AWS service. |
OmicsServiceException | Base exception class for all service exceptions from Omics service. |