@aws-sdk/client-omics 3.693.0 → 3.697.0

package/dist-types/commands/ListRunsCommand.d.ts

@@ -28,6 +28,10 @@ declare const ListRunsCommand_base: {
 };
 /**
  * <p>Retrieves a list of runs.</p>
+ *          <p>HealthOmics stores a fixed number of runs that are available to the console and API. If
+ *       the ListRuns response doesn't include specific runs that you expected, you can find run logs
+ *       for all runs in the CloudWatch logs. For more information about viewing the run logs, see <a href="https://docs.aws.amazon.com/omics/latest/dev/cloudwatch-logs.html">CloudWatch logs</a>
+ *       in the <i>AWS HealthOmics User Guide</i>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/StartRunCommand.d.ts

@@ -30,9 +30,10 @@ declare const StartRunCommand_base: {
  * <p>Starts a workflow run. To duplicate a run, specify the run's ID and a role ARN. The
  *       remaining parameters are copied from the previous run.</p>
  *          <p>StartRun will not support re-run for a workflow that is shared with you.</p>
- *          <p>The total number of runs in your account is subject to a quota per Region. To avoid
- *       needing to delete runs manually, you can set the retention mode to <code>REMOVE</code>.
- *       Runs with this setting are deleted automatically when the run quoata is exceeded.</p>
+ *          <p>HealthOmics stores a fixed number of runs that are available to the console and API.
+ *         By default, HealthOmics doesn't any remove any runs. If HealthOmics reaches the maximum
+ *         number of runs, you must manually remove runs. To have older runs removed automatically,
+ *         set the retention mode to <code>REMOVE</code>.</p>
  *          <p>By default, the run uses STATIC storage. For STATIC storage, set the <code>storageCapacity</code> field.
  *       You can set the storage type to DYNAMIC. You do not set <code>storageCapacity</code>,
  *       because HealthOmics dynamically scales the storage up or down as required.
@@ -50,6 +51,8 @@ declare const StartRunCommand_base: {
  *   runId: "STRING_VALUE",
  *   roleArn: "STRING_VALUE", // required
  *   name: "STRING_VALUE",
+ *   cacheId: "STRING_VALUE",
+ *   cacheBehavior: "STRING_VALUE",
  *   runGroupId: "STRING_VALUE",
  *   priority: Number("int"),
  *   parameters: "DOCUMENT_VALUE",

package/dist-types/commands/UpdateRunCacheCommand.d.ts

@@ -0,0 +1,96 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { UpdateRunCacheRequest } from "../models/models_0";
+import { OmicsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OmicsClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdateRunCacheCommand}.
+ */
+export interface UpdateRunCacheCommandInput extends UpdateRunCacheRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateRunCacheCommand}.
+ */
+export interface UpdateRunCacheCommandOutput extends __MetadataBearer {
+}
+declare const UpdateRunCacheCommand_base: {
+    new (input: UpdateRunCacheCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateRunCacheCommandInput, UpdateRunCacheCommandOutput, OmicsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: UpdateRunCacheCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateRunCacheCommandInput, UpdateRunCacheCommandOutput, OmicsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Update a run cache. </p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { OmicsClient, UpdateRunCacheCommand } from "@aws-sdk/client-omics"; // ES Modules import
+ * // const { OmicsClient, UpdateRunCacheCommand } = require("@aws-sdk/client-omics"); // CommonJS import
+ * const client = new OmicsClient(config);
+ * const input = { // UpdateRunCacheRequest
+ *   cacheBehavior: "STRING_VALUE",
+ *   description: "STRING_VALUE",
+ *   id: "STRING_VALUE", // required
+ *   name: "STRING_VALUE",
+ * };
+ * const command = new UpdateRunCacheCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param UpdateRunCacheCommandInput - {@link UpdateRunCacheCommandInput}
+ * @returns {@link UpdateRunCacheCommandOutput}
+ * @see {@link UpdateRunCacheCommandInput} for command's `input` shape.
+ * @see {@link UpdateRunCacheCommandOutput} for command's `response` shape.
+ * @see {@link OmicsClientResolvedConfig | config} for OmicsClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have sufficient access to perform this action.</p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>The request cannot be applied to the target resource in its current state.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>An unexpected error occurred. Try the request again.</p>
+ *
+ * @throws {@link RequestTimeoutException} (client fault)
+ *  <p>The request timed out.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The target resource was not found in the current Region.</p>
+ *
+ * @throws {@link ServiceQuotaExceededException} (client fault)
+ *  <p>The request exceeds a service quota.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input fails to satisfy the constraints specified by an AWS service.</p>
+ *
+ * @throws {@link OmicsServiceException}
+ * <p>Base exception class for all service exceptions from Omics service.</p>
+ *
+ * @public
+ */
+export declare class UpdateRunCacheCommand extends UpdateRunCacheCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: UpdateRunCacheRequest;
+            output: {};
+        };
+        sdk: {
+            input: UpdateRunCacheCommandInput;
+            output: UpdateRunCacheCommandOutput;
+        };
+    };
+}

package/dist-types/commands/index.d.ts

@@ -9,6 +9,7 @@ export * from "./CreateAnnotationStoreCommand";
 export * from "./CreateAnnotationStoreVersionCommand";
 export * from "./CreateMultipartReadSetUploadCommand";
 export * from "./CreateReferenceStoreCommand";
+export * from "./CreateRunCacheCommand";
 export * from "./CreateRunGroupCommand";
 export * from "./CreateSequenceStoreCommand";
 export * from "./CreateShareCommand";
@@ -18,6 +19,7 @@ export * from "./DeleteAnnotationStoreCommand";
 export * from "./DeleteAnnotationStoreVersionsCommand";
 export * from "./DeleteReferenceCommand";
 export * from "./DeleteReferenceStoreCommand";
+export * from "./DeleteRunCacheCommand";
 export * from "./DeleteRunCommand";
 export * from "./DeleteRunGroupCommand";
 export * from "./DeleteSequenceStoreCommand";
@@ -36,6 +38,7 @@ export * from "./GetReferenceCommand";
 export * from "./GetReferenceImportJobCommand";
 export * from "./GetReferenceMetadataCommand";
 export * from "./GetReferenceStoreCommand";
+export * from "./GetRunCacheCommand";
 export * from "./GetRunCommand";
 export * from "./GetRunGroupCommand";
 export * from "./GetRunTaskCommand";
@@ -56,6 +59,7 @@ export * from "./ListReadSetsCommand";
 export * from "./ListReferenceImportJobsCommand";
 export * from "./ListReferenceStoresCommand";
 export * from "./ListReferencesCommand";
+export * from "./ListRunCachesCommand";
 export * from "./ListRunGroupsCommand";
 export * from "./ListRunTasksCommand";
 export * from "./ListRunsCommand";
@@ -76,6 +80,7 @@ export * from "./TagResourceCommand";
 export * from "./UntagResourceCommand";
 export * from "./UpdateAnnotationStoreCommand";
 export * from "./UpdateAnnotationStoreVersionCommand";
+export * from "./UpdateRunCacheCommand";
 export * from "./UpdateRunGroupCommand";
 export * from "./UpdateVariantStoreCommand";
 export * from "./UpdateWorkflowCommand";

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

@@ -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
  */
@@ -2775,6 +2879,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
  */
@@ -4089,6 +4203,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 +4366,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 +4547,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
@@ -5756,6 +5960,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 +6273,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
@@ -6620,6 +6906,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 +6995,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 +7050,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 +7079,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;

package/dist-types/pagination/ListRunCachesPaginator.d.ts

@@ -0,0 +1,7 @@
+import { Paginator } from "@smithy/types";
+import { ListRunCachesCommandInput, ListRunCachesCommandOutput } from "../commands/ListRunCachesCommand";
+import { OmicsPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
+export declare const paginateListRunCaches: (config: OmicsPaginationConfiguration, input: ListRunCachesCommandInput, ...rest: any[]) => Paginator<ListRunCachesCommandOutput>;

package/dist-types/pagination/index.d.ts

@@ -11,6 +11,7 @@ export * from "./ListReadSetsPaginator";
 export * from "./ListReferenceImportJobsPaginator";
 export * from "./ListReferenceStoresPaginator";
 export * from "./ListReferencesPaginator";
+export * from "./ListRunCachesPaginator";
 export * from "./ListRunGroupsPaginator";
 export * from "./ListRunTasksPaginator";
 export * from "./ListRunsPaginator";