@aws-sdk/client-omics 3.696.0 → 3.699.0

package/dist-types/models/models_0.d.ts

@@ -1,4 +1,4 @@
-import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
+import { ExceptionOptionType as __ExceptionOptionType, LazyJsonString as __LazyJsonString } from "@smithy/smithy-client";
 import { DocumentType as __DocumentType, StreamingBlobTypes } from "@smithy/types";
 import { OmicsServiceException as __BaseException } from "./OmicsServiceException";
 /**
@@ -2037,6 +2037,18 @@ export interface BatchDeleteReadSetResponse {
      */
     errors?: ReadSetBatchError[] | undefined;
 }
+/**
+ * @public
+ * @enum
+ */
+export declare const CacheBehavior: {
+    readonly CACHE_ALWAYS: "CACHE_ALWAYS";
+    readonly CACHE_ON_FAILURE: "CACHE_ON_FAILURE";
+};
+/**
+ * @public
+ */
+export type CacheBehavior = (typeof CacheBehavior)[keyof typeof CacheBehavior];
 /**
  * @public
  */
@@ -2327,6 +2339,98 @@ export interface CreateReferenceStoreResponse {
      */
     creationTime: Date | undefined;
 }
+/**
+ * @public
+ */
+export interface CreateRunCacheRequest {
+    /**
+     * <p>Default cache behavior for runs that use this cache. Supported values are:</p>
+     *          <p>
+     *             <code>CACHE_ON_FAILURE</code>: Caches task outputs from completed tasks for runs that fail. This setting is
+     *         useful if you're debugging a workflow that fails after several
+     *         tasks completed successfully. The subsequent run uses the cache outputs for previously-completed tasks if the task definition,
+     *         inputs, and container in ECR are identical to the prior run.</p>
+     *          <p>
+     *             <code>CACHE_ALWAYS</code>: Caches task outputs from completed tasks for all runs. This setting
+     *        is useful in development mode, but do not use it in a production setting.</p>
+     *          <p>If you don't specify a value, the default behavior is CACHE_ON_FAILURE.
+     *       When you start a run that uses this cache, you can override the default cache behavior.</p>
+     *          <p>For more information, see <a href="https://docs.aws.amazon.com/omics/latest/dev/how-run-cache.html#run-cache-behavior">Run cache behavior</a> in the AWS HealthOmics User Guide.</p>
+     * @public
+     */
+    cacheBehavior?: CacheBehavior | undefined;
+    /**
+     * <p>Specify the S3 location for storing the cached task outputs.
+     *       This data must be immediately accessible (not in an archived state).</p>
+     * @public
+     */
+    cacheS3Location: string | undefined;
+    /**
+     * <p>Enter a description of the run cache.</p>
+     * @public
+     */
+    description?: string | undefined;
+    /**
+     * <p>Enter a user-friendly name for the run cache.</p>
+     * @public
+     */
+    name?: string | undefined;
+    /**
+     * <p>A unique request token, to ensure idempotency. If you don't specify a token,
+     *       HealthOmics automatically generates a universally unique identifier (UUID) for the request.</p>
+     * @public
+     */
+    requestId?: string | undefined;
+    /**
+     * <p>Specify one or more tags to associate with this run cache.</p>
+     * @public
+     */
+    tags?: Record<string, string> | undefined;
+    /**
+     * <p>The AWS account ID of the expected owner of the S3 bucket for the run cache.
+     *       If not provided, your account ID is set as the owner of the bucket.</p>
+     * @public
+     */
+    cacheBucketOwnerId?: string | undefined;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const RunCacheStatus: {
+    readonly ACTIVE: "ACTIVE";
+    readonly DELETED: "DELETED";
+    readonly FAILED: "FAILED";
+};
+/**
+ * @public
+ */
+export type RunCacheStatus = (typeof RunCacheStatus)[keyof typeof RunCacheStatus];
+/**
+ * @public
+ */
+export interface CreateRunCacheResponse {
+    /**
+     * <p>Unique resource identifier for the run cache.</p>
+     * @public
+     */
+    arn?: string | undefined;
+    /**
+     * <p>Identifier for the run cache.</p>
+     * @public
+     */
+    id?: string | undefined;
+    /**
+     * <p>Run cache status.</p>
+     * @public
+     */
+    status?: RunCacheStatus | undefined;
+    /**
+     * <p>The tags associated with this run cache.</p>
+     * @public
+     */
+    tags?: Record<string, string> | undefined;
+}
 /**
  * @public
  */
@@ -2403,6 +2507,17 @@ export declare const ETagAlgorithmFamily: {
  * @public
  */
 export type ETagAlgorithmFamily = (typeof ETagAlgorithmFamily)[keyof typeof ETagAlgorithmFamily];
+/**
+ * <p>S3 access configuration parameters.</p>
+ * @public
+ */
+export interface S3AccessConfig {
+    /**
+     * <p>Location of the access logs.</p>
+     * @public
+     */
+    accessLogLocation?: string | undefined;
+}
 /**
  * @public
  */
@@ -2442,7 +2557,53 @@ export interface CreateSequenceStoreRequest {
      * @public
      */
     eTagAlgorithmFamily?: ETagAlgorithmFamily | undefined;
+    /**
+     * <p>The tags keys to propagate to the S3 objects associated with read sets in the sequence store.</p>
+     * @public
+     */
+    propagatedSetLevelTags?: string[] | undefined;
+    /**
+     * <p>S3 access configuration parameters</p>
+     * @public
+     */
+    s3AccessConfig?: S3AccessConfig | undefined;
 }
+/**
+ * <p>The S3 access metadata of the sequence store.</p>
+ * @public
+ */
+export interface SequenceStoreS3Access {
+    /**
+     * <p>The S3 URI of the sequence store.</p>
+     * @public
+     */
+    s3Uri?: string | undefined;
+    /**
+     * <p>This is ARN of the access point associated with the S3 bucket storing read sets.</p>
+     * @public
+     */
+    s3AccessPointArn?: string | undefined;
+    /**
+     * <p>Location of the access logs.</p>
+     * @public
+     */
+    accessLogLocation?: string | undefined;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const SequenceStoreStatus: {
+    readonly ACTIVE: "ACTIVE";
+    readonly CREATING: "CREATING";
+    readonly DELETING: "DELETING";
+    readonly FAILED: "FAILED";
+    readonly UPDATING: "UPDATING";
+};
+/**
+ * @public
+ */
+export type SequenceStoreStatus = (typeof SequenceStoreStatus)[keyof typeof SequenceStoreStatus];
 /**
  * @public
  */
@@ -2487,6 +2648,26 @@ export interface CreateSequenceStoreResponse {
      * @public
      */
     eTagAlgorithmFamily?: ETagAlgorithmFamily | undefined;
+    /**
+     * <p>The status of the sequence store.</p>
+     * @public
+     */
+    status?: SequenceStoreStatus | undefined;
+    /**
+     * <p>The status message of the sequence store.</p>
+     * @public
+     */
+    statusMessage?: string | undefined;
+    /**
+     * <p>The tags keys to propagate to the S3 objects associated with read sets in the sequence store.</p>
+     * @public
+     */
+    propagatedSetLevelTags?: string[] | undefined;
+    /**
+     * <p>The S3 access metadata of the sequence store.</p>
+     * @public
+     */
+    s3Access?: SequenceStoreS3Access | undefined;
 }
 /**
  * @public
@@ -2775,6 +2956,16 @@ export interface DeleteRunRequest {
      */
     id: string | undefined;
 }
+/**
+ * @public
+ */
+export interface DeleteRunCacheRequest {
+    /**
+     * <p>Run cache identifier for the cache you want to delete.</p>
+     * @public
+     */
+    id: string | undefined;
+}
 /**
  * @public
  */
@@ -2785,6 +2976,21 @@ export interface DeleteRunGroupRequest {
      */
     id: string | undefined;
 }
+/**
+ * @public
+ */
+export interface DeleteS3AccessPolicyRequest {
+    /**
+     * <p>The S3 access point ARN that has the access policy.</p>
+     * @public
+     */
+    s3AccessPointArn: string | undefined;
+}
+/**
+ * @public
+ */
+export interface DeleteS3AccessPolicyResponse {
+}
 /**
  * @public
  */
@@ -4089,6 +4295,21 @@ export interface GetRunResponse {
      * @public
      */
     id?: string | undefined;
+    /**
+     * <p>The run cache associated with the run.</p>
+     * @public
+     */
+    cacheId?: string | undefined;
+    /**
+     * <p>The run cache behavior for the run.</p>
+     * @public
+     */
+    cacheBehavior?: CacheBehavior | undefined;
+    /**
+     * <p>The workflow engine version.</p>
+     * @public
+     */
+    engineVersion?: string | undefined;
     /**
      * <p>The run's status.</p>
      * @public
@@ -4237,6 +4458,71 @@ export interface GetRunResponse {
      */
     workflowOwnerId?: string | undefined;
 }
+/**
+ * @public
+ */
+export interface GetRunCacheRequest {
+    /**
+     * <p>The identifier of the run cache to retrieve.</p>
+     * @public
+     */
+    id: string | undefined;
+}
+/**
+ * @public
+ */
+export interface GetRunCacheResponse {
+    /**
+     * <p>Unique resource identifier for the run cache.</p>
+     * @public
+     */
+    arn?: string | undefined;
+    /**
+     * <p>The default cache behavior for runs using this cache.</p>
+     * @public
+     */
+    cacheBehavior?: CacheBehavior | undefined;
+    /**
+     * <p>The identifier of the bucket owner.</p>
+     * @public
+     */
+    cacheBucketOwnerId?: string | undefined;
+    /**
+     * <p>The S3 URI where the cache data is stored.</p>
+     * @public
+     */
+    cacheS3Uri?: string | undefined;
+    /**
+     * <p>Creation time of the run cache (an ISO 8601 formatted string).</p>
+     * @public
+     */
+    creationTime?: Date | undefined;
+    /**
+     * <p>The run cache description.</p>
+     * @public
+     */
+    description?: string | undefined;
+    /**
+     * <p>The run cache ID.</p>
+     * @public
+     */
+    id?: string | undefined;
+    /**
+     * <p>The run cache name.</p>
+     * @public
+     */
+    name?: string | undefined;
+    /**
+     * <p>The run cache status.</p>
+     * @public
+     */
+    status?: RunCacheStatus | undefined;
+    /**
+     * <p>The tags associated with the run cache.</p>
+     * @public
+     */
+    tags?: Record<string, string> | undefined;
+}
 /**
  * @public
  */
@@ -4353,6 +4639,16 @@ export interface GetRunTaskResponse {
      * @public
      */
     cpus?: number | undefined;
+    /**
+     * <p>Set to true if AWS HealthOmics found a matching entry in the run cache for this task.</p>
+     * @public
+     */
+    cacheHit?: boolean | undefined;
+    /**
+     * <p>The S3 URI of the cache location.</p>
+     * @public
+     */
+    cacheS3Uri?: string | undefined;
     /**
      * <p>The task's memory use in gigabytes.</p>
      * @public
@@ -4402,28 +4698,64 @@ export interface GetRunTaskResponse {
 /**
  * @public
  */
-export interface GetSequenceStoreRequest {
+export interface GetS3AccessPolicyRequest {
     /**
-     * <p>The store's ID.</p>
+     * <p>The S3 access point ARN that has the access policy.</p>
      * @public
      */
-    id: string | undefined;
+    s3AccessPointArn: string | undefined;
 }
 /**
- * <p>The S3 access metadata of the sequence store.</p>
  * @public
+ * @enum
  */
-export interface SequenceStoreS3Access {
+export declare const StoreType: {
+    readonly REFERENCE_STORE: "REFERENCE_STORE";
+    readonly SEQUENCE_STORE: "SEQUENCE_STORE";
+};
+/**
+ * @public
+ */
+export type StoreType = (typeof StoreType)[keyof typeof StoreType];
+/**
+ * @public
+ */
+export interface GetS3AccessPolicyResponse {
     /**
-     * <p>The S3 URI of the sequence store.</p>
+     * <p>The S3 access point ARN that has the access policy.</p>
      * @public
      */
-    s3Uri?: string | undefined;
+    s3AccessPointArn?: string | undefined;
     /**
-     * <p>This is ARN of the access point associated with the S3 bucket storing read sets.</p>
+     * <p>The AWS-generated Sequence Store or Reference Store ID.</p>
      * @public
      */
-    s3AccessPointArn?: string | undefined;
+    storeId?: string | undefined;
+    /**
+     * <p>The type of store associated with the access point.</p>
+     * @public
+     */
+    storeType?: StoreType | undefined;
+    /**
+     * <p>The time when the policy was last updated.</p>
+     * @public
+     */
+    updateTime?: Date | undefined;
+    /**
+     * <p>The current resource policy that controls S3 access on the store.</p>
+     * @public
+     */
+    s3AccessPolicy: __LazyJsonString | string | undefined;
+}
+/**
+ * @public
+ */
+export interface GetSequenceStoreRequest {
+    /**
+     * <p>The store's ID.</p>
+     * @public
+     */
+    id: string | undefined;
 }
 /**
  * @public
@@ -4474,6 +4806,26 @@ export interface GetSequenceStoreResponse {
      * @public
      */
     eTagAlgorithmFamily?: ETagAlgorithmFamily | undefined;
+    /**
+     * <p>The status of the sequence store.</p>
+     * @public
+     */
+    status?: SequenceStoreStatus | undefined;
+    /**
+     * <p>The status message of the sequence store.</p>
+     * @public
+     */
+    statusMessage?: string | undefined;
+    /**
+     * <p>The tags keys to propagate to the S3 objects associated with read sets in the sequence store.</p>
+     * @public
+     */
+    propagatedSetLevelTags?: string[] | undefined;
+    /**
+     * <p>The last-updated time of the sequence store.</p>
+     * @public
+     */
+    updateTime?: Date | undefined;
 }
 /**
  * @public
@@ -5756,6 +6108,78 @@ export interface ListReferenceStoresResponse {
      */
     referenceStores: ReferenceStoreDetail[] | undefined;
 }
+/**
+ * @public
+ */
+export interface ListRunCachesRequest {
+    /**
+     * <p>The maximum number of results to return.</p>
+     * @public
+     */
+    maxResults?: number | undefined;
+    /**
+     * <p>Optional pagination token returned from a prior call to the <code>ListRunCaches</code> API operation.</p>
+     * @public
+     */
+    startingToken?: string | undefined;
+}
+/**
+ * <p>List entry for one run cache.</p>
+ * @public
+ */
+export interface RunCacheListItem {
+    /**
+     * <p>Unique resource identifier for the run cache.</p>
+     * @public
+     */
+    arn?: string | undefined;
+    /**
+     * <p>Default cache behavior for the run cache.</p>
+     * @public
+     */
+    cacheBehavior?: CacheBehavior | undefined;
+    /**
+     * <p>The S3 uri for the run cache data.</p>
+     * @public
+     */
+    cacheS3Uri?: string | undefined;
+    /**
+     * <p>The time that this run cache was created (an ISO 8601 formatted string).</p>
+     * @public
+     */
+    creationTime?: Date | undefined;
+    /**
+     * <p>The identifier for this run cache.</p>
+     * @public
+     */
+    id?: string | undefined;
+    /**
+     * <p>The name of the run cache.</p>
+     * @public
+     */
+    name?: string | undefined;
+    /**
+     * <p>The run cache status.</p>
+     * @public
+     */
+    status?: RunCacheStatus | undefined;
+}
+/**
+ * @public
+ */
+export interface ListRunCachesResponse {
+    /**
+     * <p>Details about each run cache in the response.</p>
+     * @public
+     */
+    items?: RunCacheListItem[] | undefined;
+    /**
+     * <p>Pagination token to retrieve additional run caches. If the response does not have a
+     *       <code>nextToken</code>value, you have reached to the end of the list.</p>
+     * @public
+     */
+    nextToken?: string | undefined;
+}
 /**
  * @public
  */
@@ -5997,6 +6421,16 @@ export interface TaskListItem {
      * @public
      */
     cpus?: number | undefined;
+    /**
+     * <p>Set to true if AWS HealthOmics found a matching entry in the run cache for this task.</p>
+     * @public
+     */
+    cacheHit?: boolean | undefined;
+    /**
+     * <p>The S3 URI of the cache location.</p>
+     * @public
+     */
+    cacheS3Uri?: string | undefined;
     /**
      * <p>The task's memory use in gigabyes.</p>
      * @public
@@ -6065,6 +6499,21 @@ export interface SequenceStoreFilter {
      * @public
      */
     createdBefore?: Date | undefined;
+    /**
+     * <p>Filter results based on status.</p>
+     * @public
+     */
+    status?: SequenceStoreStatus | undefined;
+    /**
+     * <p>Filter results based on stores updated after the specified time.</p>
+     * @public
+     */
+    updatedAfter?: Date | undefined;
+    /**
+     * <p>Filter results based on stores updated before the specified time.</p>
+     * @public
+     */
+    updatedBefore?: Date | undefined;
 }
 /**
  * @public
@@ -6133,6 +6582,21 @@ export interface SequenceStoreDetail {
      * @public
      */
     eTagAlgorithmFamily?: ETagAlgorithmFamily | undefined;
+    /**
+     * <p>Status of the sequence store.</p>
+     * @public
+     */
+    status?: SequenceStoreStatus | undefined;
+    /**
+     * <p>The status message of the sequence store.</p>
+     * @public
+     */
+    statusMessage?: string | undefined;
+    /**
+     * <p>The last-updated time of the Sequence Store.</p>
+     * @public
+     */
+    updateTime?: Date | undefined;
 }
 /**
  * @public
@@ -6539,6 +7003,41 @@ export interface ListWorkflowsResponse {
      */
     nextToken?: string | undefined;
 }
+/**
+ * @public
+ */
+export interface PutS3AccessPolicyRequest {
+    /**
+     * <p>The S3 access point ARN where you want to put the access policy.</p>
+     * @public
+     */
+    s3AccessPointArn: string | undefined;
+    /**
+     * <p>The resource policy that controls S3 access to the store.</p>
+     * @public
+     */
+    s3AccessPolicy: __LazyJsonString | string | undefined;
+}
+/**
+ * @public
+ */
+export interface PutS3AccessPolicyResponse {
+    /**
+     * <p>The S3 access point ARN that now has the access policy.</p>
+     * @public
+     */
+    s3AccessPointArn?: string | undefined;
+    /**
+     * <p>The AWS-generated Sequence Store or Reference Store ID.</p>
+     * @public
+     */
+    storeId?: string | undefined;
+    /**
+     * <p>The type of store associated with the access point.</p>
+     * @public
+     */
+    storeType?: StoreType | undefined;
+}
 /**
  * <p>A source for a reference import job.</p>
  * @public
@@ -6620,6 +7119,31 @@ export interface StartReferenceImportJobResponse {
      */
     creationTime: Date | undefined;
 }
+/**
+ * @public
+ */
+export interface UpdateRunCacheRequest {
+    /**
+     * <p>Update the default run cache behavior.</p>
+     * @public
+     */
+    cacheBehavior?: CacheBehavior | undefined;
+    /**
+     * <p>Update the run cache description.</p>
+     * @public
+     */
+    description?: string | undefined;
+    /**
+     * <p>The identifier of the run cache you want to update.</p>
+     * @public
+     */
+    id: string | undefined;
+    /**
+     * <p>Update the name of the run cache.</p>
+     * @public
+     */
+    name?: string | undefined;
+}
 /**
  * @public
  */
@@ -6684,6 +7208,19 @@ export interface StartRunRequest {
      * @public
      */
     name?: string | undefined;
+    /**
+     * <p>Identifier of the cache associated with this run. If you don't specify a cache ID, no task outputs are cached
+     *     for this run.</p>
+     * @public
+     */
+    cacheId?: string | undefined;
+    /**
+     * <p>The cache behavior for the run. You specify this value if you want to override
+     *        the default behavior for the cache. You had set the default value when you created the cache.
+     *       For more information, see <a href="https://docs.aws.amazon.com/omics/latest/dev/how-run-cache.html#run-cache-behavior">Run cache behavior</a> in the AWS HealthOmics User Guide.</p>
+     * @public
+     */
+    cacheBehavior?: CacheBehavior | undefined;
     /**
      * <p>The run's group ID.</p>
      * @public
@@ -6726,7 +7263,14 @@ export interface StartRunRequest {
      */
     requestId?: string | undefined;
     /**
-     * <p>The retention mode for the run.</p>
+     * <p>The retention mode for the run. The default value is RETAIN. </p>
+     *          <p>HealthOmics stores a fixed number of runs that are available to the console and API.
+     *       In the default mode (RETAIN), you need to remove runs manually when the number of run exceeds the maximum.
+     *       If you set the retention mode to <code>REMOVE</code>, HealthOmics automatically
+     *       removes runs (that have mode set to REMOVE) when the number of run exceeds the maximum.
+     *       All run logs are available in CloudWatch logs, if you need information about a run that is no longer available to the API.</p>
+     *          <p>For more information about retention mode, see <a href="https://docs.aws.amazon.com/omics/latest/dev/starting-a-run.html">Specifying run retention mode</a>
+     *     in the <i>AWS HealthOmics User Guide</i>.</p>
      * @public
      */
     retentionMode?: RunRetentionMode | undefined;
@@ -6748,7 +7292,7 @@ export interface StartRunRequest {
  */
 export interface StartRunResponse {
     /**
-     * <p>The run's ARN.</p>
+     * <p>Unique resource identifier for the run.</p>
      * @public
      */
     arn?: string | undefined;
@@ -7000,6 +7544,116 @@ export interface StartReadSetImportJobResponse {
      */
     creationTime: Date | undefined;
 }
+/**
+ * @public
+ */
+export interface UpdateSequenceStoreRequest {
+    /**
+     * <p>The ID of the sequence store.</p>
+     * @public
+     */
+    id: string | undefined;
+    /**
+     * <p>A name for the sequence store.</p>
+     * @public
+     */
+    name?: string | undefined;
+    /**
+     * <p>A description for the sequence store.</p>
+     * @public
+     */
+    description?: string | undefined;
+    /**
+     * <p>To ensure that requests don't run multiple times, specify a unique token for each request.</p>
+     * @public
+     */
+    clientToken?: string | undefined;
+    /**
+     * <p>The S3 URI of a bucket and folder to store Read Sets that fail to upload.</p>
+     * @public
+     */
+    fallbackLocation?: string | undefined;
+    /**
+     * <p>The tags keys to propagate to the S3 objects associated with read sets in the sequence store.</p>
+     * @public
+     */
+    propagatedSetLevelTags?: string[] | undefined;
+    /**
+     * <p>S3 access configuration parameters.</p>
+     * @public
+     */
+    s3AccessConfig?: S3AccessConfig | undefined;
+}
+/**
+ * @public
+ */
+export interface UpdateSequenceStoreResponse {
+    /**
+     * <p>The ID of the sequence store.</p>
+     * @public
+     */
+    id: string | undefined;
+    /**
+     * <p>The ARN of the sequence store.</p>
+     * @public
+     */
+    arn: string | undefined;
+    /**
+     * <p>The name of the sequence store.</p>
+     * @public
+     */
+    name?: string | undefined;
+    /**
+     * <p>Description of the sequence store.</p>
+     * @public
+     */
+    description?: string | undefined;
+    /**
+     * <p>Server-side encryption (SSE) settings for a store.</p>
+     * @public
+     */
+    sseConfig?: SseConfig | undefined;
+    /**
+     * <p>The time when the store was created.</p>
+     * @public
+     */
+    creationTime: Date | undefined;
+    /**
+     * <p>The last-updated time of the Sequence Store.</p>
+     * @public
+     */
+    updateTime?: Date | undefined;
+    /**
+     * <p>The tags keys to propagate to the S3 objects associated with read sets in the sequence store.</p>
+     * @public
+     */
+    propagatedSetLevelTags?: string[] | undefined;
+    /**
+     * <p>The status of the sequence store.</p>
+     * @public
+     */
+    status?: SequenceStoreStatus | undefined;
+    /**
+     * <p>The status message of the sequence store.</p>
+     * @public
+     */
+    statusMessage?: string | undefined;
+    /**
+     * <p>The S3 URI of a bucket and folder to store Read Sets that fail to upload.</p>
+     * @public
+     */
+    fallbackLocation?: string | undefined;
+    /**
+     * <p>The S3 access metadata of the sequence store.</p>
+     * @public
+     */
+    s3Access?: SequenceStoreS3Access | undefined;
+    /**
+     * <p>The ETag algorithm family to use on ingested read sets.</p>
+     * @public
+     */
+    eTagAlgorithmFamily?: ETagAlgorithmFamily | undefined;
+}
 /**
  * @public
  */