- * Accepts a share for an analytics store. - *
+ *Accept a resource share request.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-omics/src/commands/CreateShareCommand.ts b/clients/client-omics/src/commands/CreateShareCommand.ts index 68ec71d8a853..854b4f87bafd 100644 --- a/clients/client-omics/src/commands/CreateShareCommand.ts +++ b/clients/client-omics/src/commands/CreateShareCommand.ts @@ -27,9 +27,20 @@ export interface CreateShareCommandInput extends CreateShareRequest {} export interface CreateShareCommandOutput extends CreateShareResponse, __MetadataBearer {} /** - *- * Creates a share offer that can be accepted outside the account by a subscriber. The share is created by the owner and accepted by the principal subscriber. - *
+ *Creates a cross-account shared resource. The resource owner makes an offer to share the resource + * with the principal subscriber (an AWS user with a different account than the resource owner).
+ *The following resources support cross-account sharing:
+ *Healthomics variant stores
+ *Healthomics annotation stores
+ *Private workflows
+ *- * Deletes a share of an analytics store. - *
+ *Deletes a resource share. If you are the resource owner, the subscriber will no longer have + * access to the shared resource. If you are the subscriber, this operation deletes your access to the share.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-omics/src/commands/GetRunCommand.ts b/clients/client-omics/src/commands/GetRunCommand.ts index e3db65d2c368..9cf9817c4c8b 100644 --- a/clients/client-omics/src/commands/GetRunCommand.ts +++ b/clients/client-omics/src/commands/GetRunCommand.ts @@ -28,6 +28,7 @@ export interface GetRunCommandOutput extends GetRunResponse, __MetadataBearer {} /** *Gets information about a workflow run.
+ *If a workflow is shared with you, you cannot export information about the run.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -79,6 +80,8 @@ export interface GetRunCommandOutput extends GetRunResponse, __MetadataBearer {} * // }, * // uuid: "STRING_VALUE", * // runOutputUri: "STRING_VALUE", + * // storageType: "STRING_VALUE", + * // workflowOwnerId: "STRING_VALUE", * // }; * * ``` diff --git a/clients/client-omics/src/commands/GetShareCommand.ts b/clients/client-omics/src/commands/GetShareCommand.ts index 2bccaafb7848..fa2808ad184b 100644 --- a/clients/client-omics/src/commands/GetShareCommand.ts +++ b/clients/client-omics/src/commands/GetShareCommand.ts @@ -27,9 +27,7 @@ export interface GetShareCommandInput extends GetShareRequest {} export interface GetShareCommandOutput extends GetShareResponse, __MetadataBearer {} /** - *- * Retrieves the metadata for a share. - *
+ *Retrieves the metadata for the specified resource share.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -45,6 +43,7 @@ export interface GetShareCommandOutput extends GetShareResponse, __MetadataBeare * // share: { // ShareDetails * // shareId: "STRING_VALUE", * // resourceArn: "STRING_VALUE", + * // resourceId: "STRING_VALUE", * // principalSubscriber: "STRING_VALUE", * // ownerId: "STRING_VALUE", * // status: "STRING_VALUE", diff --git a/clients/client-omics/src/commands/GetWorkflowCommand.ts b/clients/client-omics/src/commands/GetWorkflowCommand.ts index 47530647f244..0e33517110ca 100644 --- a/clients/client-omics/src/commands/GetWorkflowCommand.ts +++ b/clients/client-omics/src/commands/GetWorkflowCommand.ts @@ -28,6 +28,7 @@ export interface GetWorkflowCommandOutput extends GetWorkflowResponse, __Metadat /** *Gets information about a workflow.
+ *If a workflow is shared with you, you cannot export the workflow.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -40,6 +41,7 @@ export interface GetWorkflowCommandOutput extends GetWorkflowResponse, __Metadat * export: [ // WorkflowExportList * "STRING_VALUE", * ], + * workflowOwnerId: "STRING_VALUE", * }; * const command = new GetWorkflowCommand(input); * const response = await client.send(command); diff --git a/clients/client-omics/src/commands/ListRunsCommand.ts b/clients/client-omics/src/commands/ListRunsCommand.ts index 26ae049267f4..c9489fbd169d 100644 --- a/clients/client-omics/src/commands/ListRunsCommand.ts +++ b/clients/client-omics/src/commands/ListRunsCommand.ts @@ -56,6 +56,7 @@ export interface ListRunsCommandOutput extends ListRunsResponse, __MetadataBeare * // creationTime: new Date("TIMESTAMP"), * // startTime: new Date("TIMESTAMP"), * // stopTime: new Date("TIMESTAMP"), + * // storageType: "STRING_VALUE", * // }, * // ], * // nextToken: "STRING_VALUE", diff --git a/clients/client-omics/src/commands/ListSharesCommand.ts b/clients/client-omics/src/commands/ListSharesCommand.ts index 1f41a459824c..8640dfac8db8 100644 --- a/clients/client-omics/src/commands/ListSharesCommand.ts +++ b/clients/client-omics/src/commands/ListSharesCommand.ts @@ -27,9 +27,8 @@ export interface ListSharesCommandInput extends ListSharesRequest {} export interface ListSharesCommandOutput extends ListSharesResponse, __MetadataBearer {} /** - *- * Lists all shares associated with an account. - *
+ *Retrieves the resource shares associated with an account. Use the filter parameter to + * retrieve a specific subset of the shares.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -45,6 +44,9 @@ export interface ListSharesCommandOutput extends ListSharesResponse, __MetadataB * status: [ // StatusList * "STRING_VALUE", * ], + * type: [ // TypeList + * "STRING_VALUE", + * ], * }, * nextToken: "STRING_VALUE", * maxResults: Number("int"), @@ -56,6 +58,7 @@ export interface ListSharesCommandOutput extends ListSharesResponse, __MetadataB * // { // ShareDetails * // shareId: "STRING_VALUE", * // resourceArn: "STRING_VALUE", + * // resourceId: "STRING_VALUE", * // principalSubscriber: "STRING_VALUE", * // ownerId: "STRING_VALUE", * // status: "STRING_VALUE", diff --git a/clients/client-omics/src/commands/StartRunCommand.ts b/clients/client-omics/src/commands/StartRunCommand.ts index d6580ef0c4d9..14cf5fda0e9f 100644 --- a/clients/client-omics/src/commands/StartRunCommand.ts +++ b/clients/client-omics/src/commands/StartRunCommand.ts @@ -29,9 +29,15 @@ export interface StartRunCommandOutput extends StartRunResponse, __MetadataBeare /** *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.
+ *StartRun will not support re-run for a workflow that is shared with you.
*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 REMOVE.
* Runs with this setting are deleted automatically when the run quoata is exceeded.
By default, the run uses STATIC storage. For STATIC storage, set the storageCapacity field.
+ * You can set the storage type to DYNAMIC. You do not set storageCapacity,
+ * because HealthOmics dynamically scales the storage up or down as required.
+ * For more information about static and dynamic storage, see Running workflows
+ * in the AWS HealthOmics User Guide.
- * The ID for a share offer for analytics store data. - *
+ *The ID of the resource share.
* @public */ shareId: string | undefined; @@ -260,9 +258,7 @@ export type ShareStatus = (typeof ShareStatus)[keyof typeof ShareStatus]; */ export interface AcceptShareResponse { /** - *- * The status of an analytics store share. - *
+ *The status of the resource share.
* @public */ status?: ShareStatus; @@ -2076,16 +2072,13 @@ export interface GetAnnotationStoreVersionResponse { } /** - *- * Use filters to focus the returned annotation store versions on a specific parameter, such as the status of the annotation store. - *
+ *Use filters to focus the returned annotation store versions on a specific parameter, + * such as the status of the annotation store.
* @public */ export interface ListAnnotationStoreVersionsFilter { /** - *- * The status of an annotation store version. - *
+ *The status of an annotation store version.
* @public */ status?: VersionStatus; @@ -2919,25 +2912,19 @@ export interface CreateSequenceStoreResponse { */ export interface CreateShareRequest { /** - *- * The resource ARN for the analytics store to be shared. - *
+ *The ARN of the resource to be shared.
* @public */ resourceArn: string | undefined; /** - *- * The principal subscriber is the account being given access to the analytics store data through the share offer. - *
+ *The principal subscriber is the account being offered shared access to the resource.
* @public */ principalSubscriber: string | undefined; /** - *- * A name given to the share. - *
+ *A name that the owner defines for the share.
* @public */ shareName?: string; @@ -2948,25 +2935,19 @@ export interface CreateShareRequest { */ export interface CreateShareResponse { /** - *- * An ID generated for the share. - *
+ *The ID that HealthOmics generates for the share.
* @public */ shareId?: string; /** - *- * The status of a share. - *
+ *The status of the share.
* @public */ status?: ShareStatus; /** - *- * A name given to the share. - *
+ *The name of the share.
* @public */ shareName?: string; @@ -3122,7 +3103,7 @@ export interface CreateWorkflowRequest { parameterTemplate?: RecordA storage capacity for the workflow in gibibytes.
+ *The storage capacity for the workflow in gibibytes.
* @public */ storageCapacity?: number; @@ -3288,9 +3269,7 @@ export interface DeleteSequenceStoreResponse {} */ export interface DeleteShareRequest { /** - *- * The ID for the share request to be deleted. - *
+ *The ID for the resource share to be deleted.
* @public */ shareId: string | undefined; @@ -3301,9 +3280,7 @@ export interface DeleteShareRequest { */ export interface DeleteShareResponse { /** - *- * The status of the share being deleted. - *
+ *The status of the share being deleted.
* @public */ status?: ShareStatus; @@ -3573,27 +3550,52 @@ export interface FileInformation { } /** - *- * Use filters to focus the returned annotation store versions on a specific parameter, such as the status of the annotation store. - *
+ * @public + * @enum + */ +export const ShareResourceType = { + /** + * The share is on an annotation store + */ + ANNOTATION_STORE: "ANNOTATION_STORE", + /** + * The share is on a variant store + */ + VARIANT_STORE: "VARIANT_STORE", + /** + * The share is on a workflow + */ + WORKFLOW: "WORKFLOW", +} as const; + +/** + * @public + */ +export type ShareResourceType = (typeof ShareResourceType)[keyof typeof ShareResourceType]; + +/** + *Use filters to return a subset of resources. You can define filters for specific parameters, + * such as the resource status.
* @public */ export interface Filter { /** - *- * The Amazon Resource Number (Arn) for an analytics store. - *
+ *Filter based on the Amazon Resource Number (ARN) of the resource. You can specify up to 10 values.
* @public */ resourceArns?: string[]; /** - *- * The status of an annotation store version. - *
+ *Filter based on the resource status. You can specify up to 10 values.
* @public */ status?: ShareStatus[]; + + /** + *The type of resources to be filtered. You can specify one or more of the resource types.
+ * @public + */ + type?: ShareResourceType[]; } /** @@ -4667,6 +4669,20 @@ export const RunStatus = { */ export type RunStatus = (typeof RunStatus)[keyof typeof RunStatus]; +/** + * @public + * @enum + */ +export const StorageType = { + DYNAMIC: "DYNAMIC", + STATIC: "STATIC", +} as const; + +/** + * @public + */ +export type StorageType = (typeof StorageType)[keyof typeof StorageType]; + /** * @public * @enum @@ -4764,7 +4780,9 @@ export interface GetRunResponse { parameters?: __DocumentType; /** - *The run's storage capacity in gigabytes.
+ *The run's storage capacity in gibibytes. For dynamic storage, + * after the run has completed, this value is the maximum amount of storage + * used during the run.
* @public */ storageCapacity?: number; @@ -4858,6 +4876,18 @@ export interface GetRunResponse { * @public */ runOutputUri?: string; + + /** + *The run's storage type.
+ * @public + */ + storageType?: StorageType; + + /** + *The ID of the workflow owner.
+ * @public + */ + workflowOwnerId?: string; } /** @@ -5142,89 +5172,73 @@ export interface GetSequenceStoreResponse { */ export interface GetShareRequest { /** - *- * The generated ID for a share. - *
+ *The ID of the share.
* @public */ shareId: string | undefined; } /** - *- * The details of a share. - *
+ *The details of a resource share.
* @public */ export interface ShareDetails { /** - *- * The ID for a share offer for an analytics store . - *
+ *The ID of the resource share.
* @public */ shareId?: string; /** - *- * The resource Arn of the analytics store being shared. - *
+ *The Arn of the shared resource.
* @public */ resourceArn?: string; /** - *- * The principal subscriber is the account the analytics store data is being shared with. - *
+ *The ID of the shared resource.
+ * @public + */ + resourceId?: string; + + /** + *The principal subscriber is the account that is sharing the resource.
* @public */ principalSubscriber?: string; /** - *- * The account ID for the data owner. The owner creates the share offer. - *
+ *The account ID for the data owner. The owner creates the resource share.
* @public */ ownerId?: string; /** - *- * The status of a share. - *
+ *The status of the share.
* @public */ status?: ShareStatus; /** - *- * The status message for a share. It provides more details on the status of the share. - *
+ *The status message for a resource share. It provides additional details about the share status.
* @public */ statusMessage?: string; /** - *- * The name of the share. - *
+ *The name of the resource share.
* @public */ shareName?: string; /** - *- * The timestamp for when the share was created. - *
+ *The timestamp of when the resource share was created.
* @public */ creationTime?: Date; /** - *- * The timestamp of the share update. - *
+ *The timestamp of the resource share update.
* @public */ updateTime?: Date; @@ -5235,9 +5249,7 @@ export interface ShareDetails { */ export interface GetShareResponse { /** - *- * An analytic store share details object. contains status, resourceArn, ownerId, etc. - *
+ *A resource share details object. The object includes the status, the resourceArn, and ownerId.
* @public */ share?: ShareDetails; @@ -5471,6 +5483,12 @@ export interface GetWorkflowRequest { * @public */ export?: WorkflowExport[]; + + /** + *The ID of the workflow owner.
+ * @public + */ + workflowOwnerId?: string; } /** @@ -5544,7 +5562,7 @@ export interface GetWorkflowResponse { parameterTemplate?: RecordThe workflow's storage capacity in gigabytes.
+ *The workflow's storage capacity in gibibytes.
* @public */ storageCapacity?: number; @@ -6803,7 +6821,9 @@ export interface RunListItem { priority?: number; /** - *The run's storage capacity.
+ *The run's storage capacity in gibibytes. For dynamic storage, + * after the run has completed, this value is the maximum amount of storage + * used during the run.
* @public */ storageCapacity?: number; @@ -6825,6 +6845,12 @@ export interface RunListItem { * @public */ stopTime?: Date; + + /** + *The run's storage type.
+ * @public + */ + storageType?: StorageType; } /** @@ -7103,33 +7129,26 @@ export type ResourceOwner = (typeof ResourceOwner)[keyof typeof ResourceOwner]; */ export interface ListSharesRequest { /** - *- * The account that owns the analytics store shared. - *
+ *The account that owns the resource shares.
* @public */ resourceOwner: ResourceOwner | undefined; /** - *- * Attributes used to filter for a specific subset of shares. - *
+ *Attributes that you use to filter for a specific subset of resource shares.
* @public */ filter?: Filter; /** - *- * Next token returned in the response of a previous ListReadSetUploadPartsRequest call. Used to get the next page of results. - *
+ *Next token returned in the response of a previous ListReadSetUploadPartsRequest call. + * Used to get the next page of results.
* @public */ nextToken?: string; /** - *- * The maximum number of shares to return in one page of results. - *
+ *The maximum number of shares to return in one page of results.
* @public */ maxResults?: number; @@ -7140,9 +7159,7 @@ export interface ListSharesRequest { */ export interface ListSharesResponse { /** - *- * The shares available and their meta details. - *
+ *The shares available and their metadata details.
* @public */ shares: ShareDetails[] | undefined; @@ -7439,13 +7456,13 @@ export interface ListVariantStoresResponse { */ export interface ListWorkflowsRequest { /** - *The workflows' type.
+ *Filter the list by workflow type.
* @public */ type?: WorkflowType; /** - *The workflows' name.
+ *Filter the list by workflow name.
* @public */ name?: string; @@ -7524,7 +7541,7 @@ export interface WorkflowListItem { */ export interface ListWorkflowsResponse { /** - *The workflows' items.
+ *A list of workflow items.
* @public */ items?: WorkflowListItem[]; @@ -7724,7 +7741,8 @@ export interface StartRunRequest { parameters?: __DocumentType; /** - *A storage capacity for the run in gibibytes.
+ *A storage capacity for the run in gibibytes. This field is not required if the storage type is dynamic + * (the system ignores any value that you enter).
* @public */ storageCapacity?: number; @@ -7758,6 +7776,20 @@ export interface StartRunRequest { * @public */ retentionMode?: RunRetentionMode; + + /** + *The run's storage type. By default, the run uses STATIC storage type, which allocates a fixed amount of storage. + * If you set the storage type to DYNAMIC, HealthOmics dynamically scales the storage up + * or down, based on file system utilization.
+ * @public + */ + storageType?: StorageType; + + /** + *The ID of the workflow owner.
+ * @public + */ + workflowOwnerId?: string; } /** diff --git a/clients/client-omics/src/protocols/Aws_restJson1.ts b/clients/client-omics/src/protocols/Aws_restJson1.ts index d3315651b3a3..77f66e3ab7ef 100644 --- a/clients/client-omics/src/protocols/Aws_restJson1.ts +++ b/clients/client-omics/src/protocols/Aws_restJson1.ts @@ -290,6 +290,7 @@ import { SequenceStoreFilter, ServiceQuotaExceededException, ShareDetails, + ShareResourceType, ShareStatus, SourceFiles, SseConfig, @@ -1566,6 +1567,7 @@ export const se_GetWorkflowCommand = async ( const query: any = map({ [_t]: [, input[_t]!], [_e]: [() => input.export !== void 0, () => (input[_e]! || []).map((_entry) => _entry as any)], + [_wOI]: [, input[_wOI]!], }); let body: any; let { hostname: resolvedHostname } = await context.endpoint(); @@ -2467,8 +2469,10 @@ export const se_StartRunCommand = async ( runGroupId: [], runId: [], storageCapacity: [], + storageType: [], tags: (_) => _json(_), workflowId: [], + workflowOwnerId: [], workflowType: [], }) ); @@ -3709,9 +3713,11 @@ export const de_GetRunCommand = async ( statusMessage: __expectString, stopTime: (_) => __expectNonNull(__parseRfc3339DateTimeWithOffset(_)), storageCapacity: __expectInt32, + storageType: __expectString, tags: _json, uuid: __expectString, workflowId: __expectString, + workflowOwnerId: __expectString, workflowType: __expectString, }); Object.assign(contents, doc); @@ -5157,6 +5163,8 @@ const se_SequenceStoreFilter = (input: SequenceStoreFilter, context: __SerdeCont // se_TsvVersionOptions omitted. +// se_TypeList omitted. + // se_VariantImportItemSource omitted. // se_VariantImportItemSources omitted. @@ -5612,6 +5620,7 @@ const de_RunListItem = (output: any, context: __SerdeContext): RunListItem => { status: __expectString, stopTime: (_: any) => __expectNonNull(__parseRfc3339DateTimeWithOffset(_)), storageCapacity: __expectInt32, + storageType: __expectString, workflowId: __expectString, }) as any; }; @@ -5672,6 +5681,7 @@ const de_ShareDetails = (output: any, context: __SerdeContext): ShareDetails => ownerId: __expectString, principalSubscriber: __expectString, resourceArn: __expectString, + resourceId: __expectString, shareId: __expectString, shareName: __expectString, status: __expectString, @@ -5875,3 +5885,4 @@ const _s = "status"; const _sT = "startingToken"; const _t = "type"; const _tK = "tagKeys"; +const _wOI = "workflowOwnerId"; diff --git a/codegen/sdk-codegen/aws-models/omics.json b/codegen/sdk-codegen/aws-models/omics.json index b04c81aaace5..b3b7cc71e673 100644 --- a/codegen/sdk-codegen/aws-models/omics.json +++ b/codegen/sdk-codegen/aws-models/omics.json @@ -125,7 +125,7 @@ } ], "traits": { - "smithy.api#documentation": "\nAccepts a share for an analytics store. \n
", + "smithy.api#documentation": "Accept a resource share request.
", "smithy.api#endpoint": { "hostPrefix": "analytics-" }, @@ -142,7 +142,7 @@ "shareId": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "\nThe ID for a share offer for analytics store data. \n
", + "smithy.api#documentation": "The ID of the resource share.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -158,7 +158,7 @@ "status": { "target": "com.amazonaws.omics#ShareStatus", "traits": { - "smithy.api#documentation": "\nThe status of an analytics store share. \n
" + "smithy.api#documentation": "The status of the resource share.
" } } }, @@ -508,6 +508,9 @@ }, "list": { "target": "com.amazonaws.omics#ListAnnotationStores" + }, + "traits": { + "smithy.api#documentation": "Represents a resource that stores annotation data" } }, "com.amazonaws.omics#AnnotationStoreItem": { @@ -1263,6 +1266,9 @@ } ], "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to create an Annotation Store" + }, "smithy.api#documentation": "Creates an annotation store.
", "smithy.api#endpoint": { "hostPrefix": "analytics-" @@ -2186,7 +2192,7 @@ } ], "traits": { - "smithy.api#documentation": "\n Creates a share offer that can be accepted outside the account by a subscriber. The share is created by the owner and accepted by the principal subscriber. \n
", + "smithy.api#documentation": "Creates a cross-account shared resource. The resource owner makes an offer to share the resource \n with the principal subscriber (an AWS user with a different account than the resource owner).
\nThe following resources support cross-account sharing:
\nHealthomics variant stores
\nHealthomics annotation stores
\nPrivate workflows
\n\n The resource ARN for the analytics store to be shared.\n
", + "smithy.api#documentation": "The ARN of the resource to be shared.
", "smithy.api#required": {} } }, "principalSubscriber": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "\n The principal subscriber is the account being given access to the analytics store data through the share offer. \n
", + "smithy.api#documentation": "The principal subscriber is the account being offered shared access to the resource.
", "smithy.api#required": {} } }, "shareName": { "target": "com.amazonaws.omics#ShareName", "traits": { - "smithy.api#documentation": "\n A name given to the share. \n
" + "smithy.api#documentation": "A name that the owner defines for the share.
" } } }, @@ -2231,19 +2237,19 @@ "shareId": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "\n An ID generated for the share. \n
" + "smithy.api#documentation": "The ID that HealthOmics generates for the share.
" } }, "status": { "target": "com.amazonaws.omics#ShareStatus", "traits": { - "smithy.api#documentation": "\n The status of a share. \n
" + "smithy.api#documentation": "The status of the share.
" } }, "shareName": { "target": "com.amazonaws.omics#ShareName", "traits": { - "smithy.api#documentation": "\n A name given to the share. \n
" + "smithy.api#documentation": "The name of the share.
" } } }, @@ -2283,6 +2289,9 @@ } ], "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to create a Variant Store" + }, "smithy.api#documentation": "Creates a variant store.
", "smithy.api#endpoint": { "hostPrefix": "analytics-" @@ -2470,7 +2479,7 @@ "storageCapacity": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "A storage capacity for the workflow in gibibytes.
", + "smithy.api#documentation": "The storage capacity for the workflow in gibibytes.
", "smithy.api#range": { "min": 0, "max": 100000 @@ -2584,6 +2593,9 @@ } ], "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to delete an Annotation Store" + }, "smithy.api#documentation": "Deletes an annotation store.
", "smithy.api#endpoint": { "hostPrefix": "analytics-" @@ -3091,7 +3103,7 @@ } ], "traits": { - "smithy.api#documentation": "\n Deletes a share of an analytics store. \n
", + "smithy.api#documentation": "Deletes a resource share. If you are the resource owner, the subscriber will no longer have \n access to the shared resource. If you are the subscriber, this operation deletes your access to the share.
", "smithy.api#endpoint": { "hostPrefix": "analytics-" }, @@ -3109,7 +3121,7 @@ "shareId": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "\n The ID for the share request to be deleted. \n
", + "smithy.api#documentation": "The ID for the resource share to be deleted.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3125,7 +3137,7 @@ "status": { "target": "com.amazonaws.omics#ShareStatus", "traits": { - "smithy.api#documentation": "\n The status of the share being deleted. \n
" + "smithy.api#documentation": "The status of the share being deleted.
" } } }, @@ -3162,6 +3174,9 @@ } ], "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to delete a Variant Store" + }, "smithy.api#documentation": "Deletes a variant store.
", "smithy.api#endpoint": { "hostPrefix": "analytics-" @@ -3638,18 +3653,24 @@ "resourceArns": { "target": "com.amazonaws.omics#ArnList", "traits": { - "smithy.api#documentation": "\nThe Amazon Resource Number (Arn) for an analytics store. \n
" + "smithy.api#documentation": "Filter based on the Amazon Resource Number (ARN) of the resource. You can specify up to 10 values.
" } }, "status": { "target": "com.amazonaws.omics#StatusList", "traits": { - "smithy.api#documentation": "\nThe status of an annotation store version. \n
" + "smithy.api#documentation": "Filter based on the resource status. You can specify up to 10 values.
" + } + }, + "type": { + "target": "com.amazonaws.omics#TypeList", + "traits": { + "smithy.api#documentation": "The type of resources to be filtered. You can specify one or more of the resource types.
" } } }, "traits": { - "smithy.api#documentation": "\nUse filters to focus the returned annotation store versions on a specific parameter, such as the status of the annotation store.\n
" + "smithy.api#documentation": "Use filters to return a subset of resources. You can define filters for specific parameters,\n such as the resource status.
" } }, "com.amazonaws.omics#FormatOptions": { @@ -3965,6 +3986,9 @@ } ], "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to get detailed information about an Annotation Store" + }, "smithy.api#documentation": "Gets information about an annotation store.
", "smithy.api#endpoint": { "hostPrefix": "analytics-" @@ -5929,7 +5953,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets information about a workflow run.
", + "smithy.api#documentation": "Gets information about a workflow run.
\nIf a workflow is shared with you, you cannot export information about the run.
", "smithy.api#endpoint": { "hostPrefix": "workflows-" }, @@ -6319,7 +6343,7 @@ "storageCapacity": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "The run's storage capacity in gigabytes.
", + "smithy.api#documentation": "The run's storage capacity in gibibytes. For dynamic storage, \n after the run has completed, this value is the maximum amount of storage\n used during the run.
", "smithy.api#range": { "min": 0, "max": 100000 @@ -6415,6 +6439,18 @@ "traits": { "smithy.api#documentation": "The destination for workflow outputs.
" } + }, + "storageType": { + "target": "com.amazonaws.omics#StorageType", + "traits": { + "smithy.api#documentation": "The run's storage type.
" + } + }, + "workflowOwnerId": { + "target": "com.amazonaws.omics#WorkflowOwnerId", + "traits": { + "smithy.api#documentation": "The ID of the workflow owner.
" + } } }, "traits": { @@ -6869,7 +6905,7 @@ } ], "traits": { - "smithy.api#documentation": "\n Retrieves the metadata for a share. \n
", + "smithy.api#documentation": "Retrieves the metadata for the specified resource share.
", "smithy.api#endpoint": { "hostPrefix": "analytics-" }, @@ -6887,7 +6923,7 @@ "shareId": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "\n The generated ID for a share. \n
", + "smithy.api#documentation": "The ID of the share.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6903,7 +6939,7 @@ "share": { "target": "com.amazonaws.omics#ShareDetails", "traits": { - "smithy.api#documentation": "\n An analytic store share details object. contains status, resourceArn, ownerId, etc. \n
" + "smithy.api#documentation": "A resource share details object. The object includes the status, the resourceArn, and ownerId.
" } } }, @@ -7134,6 +7170,9 @@ } ], "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to get detailed information about a Variant Store" + }, "smithy.api#documentation": "Gets information about a variant store.
", "smithy.api#endpoint": { "hostPrefix": "analytics-" @@ -7371,7 +7410,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets information about a workflow.
", + "smithy.api#documentation": "Gets information about a workflow.
\nIf a workflow is shared with you, you cannot export the workflow.
", "smithy.api#endpoint": { "hostPrefix": "workflows-" }, @@ -7456,6 +7495,13 @@ "smithy.api#documentation": "The export format for the workflow.
", "smithy.api#httpQuery": "export" } + }, + "workflowOwnerId": { + "target": "com.amazonaws.omics#WorkflowOwnerId", + "traits": { + "smithy.api#documentation": "The ID of the workflow owner.
", + "smithy.api#httpQuery": "workflowOwnerId" + } } }, "traits": { @@ -7536,7 +7582,7 @@ "storageCapacity": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "The workflow's storage capacity in gigabytes.
", + "smithy.api#documentation": "The workflow's storage capacity in gibibytes.
", "smithy.api#range": { "min": 0, "max": 100000 @@ -8163,12 +8209,12 @@ "status": { "target": "com.amazonaws.omics#VersionStatus", "traits": { - "smithy.api#documentation": "\nThe status of an annotation store version. \n
" + "smithy.api#documentation": "The status of an annotation store version.
" } } }, "traits": { - "smithy.api#documentation": "\nUse filters to focus the returned annotation store versions on a specific parameter, such as the status of the annotation store.\n
" + "smithy.api#documentation": "Use filters to focus the returned annotation store versions on a specific parameter,\n such as the status of the annotation store.
" } }, "com.amazonaws.omics#ListAnnotationStoreVersionsRequest": { @@ -8261,6 +8307,9 @@ } ], "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to retrieve a list of information about Annotation Stores" + }, "smithy.api#documentation": "Retrieves a list of annotation stores.
", "smithy.api#endpoint": { "hostPrefix": "analytics-" @@ -9804,7 +9853,7 @@ } ], "traits": { - "smithy.api#documentation": "\n Lists all shares associated with an account. \n
", + "smithy.api#documentation": "Retrieves the resource shares associated with an account. Use the filter parameter to \n retrieve a specific subset of the shares.
", "smithy.api#endpoint": { "hostPrefix": "analytics-" }, @@ -9828,27 +9877,27 @@ "resourceOwner": { "target": "com.amazonaws.omics#ResourceOwner", "traits": { - "smithy.api#documentation": "\n The account that owns the analytics store shared. \n
", + "smithy.api#documentation": "The account that owns the resource shares.
", "smithy.api#required": {} } }, "filter": { "target": "com.amazonaws.omics#Filter", "traits": { - "smithy.api#documentation": "\n Attributes used to filter for a specific subset of shares. \n
" + "smithy.api#documentation": "Attributes that you use to filter for a specific subset of resource shares.
" } }, "nextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "\n Next token returned in the response of a previous ListReadSetUploadPartsRequest call. Used to get the next page of results.\n
", + "smithy.api#documentation": "Next token returned in the response of a previous ListReadSetUploadPartsRequest call.\n Used to get the next page of results.
", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "\n The maximum number of shares to return in one page of results.\n
", + "smithy.api#documentation": "The maximum number of shares to return in one page of results.
", "smithy.api#httpQuery": "maxResults" } } @@ -9863,7 +9912,7 @@ "shares": { "target": "com.amazonaws.omics#ShareDetailsList", "traits": { - "smithy.api#documentation": "\n The shares available and their meta details. \n
", + "smithy.api#documentation": "The shares available and their metadata details.
", "smithy.api#required": {} } }, @@ -10112,6 +10161,9 @@ } ], "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to retrieve a list of metadata for Variant Stores" + }, "smithy.api#documentation": "Retrieves a list of variant stores.
", "smithy.api#endpoint": { "hostPrefix": "analytics-" @@ -10269,14 +10321,14 @@ "type": { "target": "com.amazonaws.omics#WorkflowType", "traits": { - "smithy.api#documentation": "The workflows' type.
", + "smithy.api#documentation": "Filter the list by workflow type.
", "smithy.api#httpQuery": "type" } }, "name": { "target": "com.amazonaws.omics#WorkflowName", "traits": { - "smithy.api#documentation": "The workflows' name.
", + "smithy.api#documentation": "Filter the list by workflow name.
", "smithy.api#httpQuery": "name" } }, @@ -10309,7 +10361,7 @@ "items": { "target": "com.amazonaws.omics#WorkflowList", "traits": { - "smithy.api#documentation": "The workflows' items.
" + "smithy.api#documentation": "A list of workflow items.
" } }, "nextToken": { @@ -12846,7 +12898,7 @@ "storageCapacity": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "The run's storage capacity.
", + "smithy.api#documentation": "The run's storage capacity in gibibytes. For dynamic storage, \n after the run has completed, this value is the maximum amount of storage\n used during the run.
", "smithy.api#range": { "min": 0, "max": 100000 @@ -12870,6 +12922,12 @@ "traits": { "smithy.api#documentation": "When the run stopped.
" } + }, + "storageType": { + "target": "com.amazonaws.omics#StorageType", + "traits": { + "smithy.api#documentation": "The run's storage type.
" + } } }, "traits": { @@ -13563,60 +13621,66 @@ "shareId": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "\n The ID for a share offer for an analytics store .\n
" + "smithy.api#documentation": "The ID of the resource share.
" } }, "resourceArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "\n The resource Arn of the analytics store being shared. \n
" + "smithy.api#documentation": "The Arn of the shared resource.
" + } + }, + "resourceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the shared resource.
" } }, "principalSubscriber": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "\n The principal subscriber is the account the analytics store data is being shared with. \n
" + "smithy.api#documentation": "The principal subscriber is the account that is sharing the resource.
" } }, "ownerId": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "\n The account ID for the data owner. The owner creates the share offer. \n
" + "smithy.api#documentation": "The account ID for the data owner. The owner creates the resource share.
" } }, "status": { "target": "com.amazonaws.omics#ShareStatus", "traits": { - "smithy.api#documentation": "\n The status of a share. \n
" + "smithy.api#documentation": "The status of the share.
" } }, "statusMessage": { "target": "com.amazonaws.omics#StatusMessage", "traits": { - "smithy.api#documentation": "\n The status message for a share. It provides more details on the status of the share.\n
" + "smithy.api#documentation": "The status message for a resource share. It provides additional details about the share status.
" } }, "shareName": { "target": "com.amazonaws.omics#ShareName", "traits": { - "smithy.api#documentation": "\n The name of the share. \n
" + "smithy.api#documentation": "The name of the resource share.
" } }, "creationTime": { "target": "com.amazonaws.omics#CreationTime", "traits": { - "smithy.api#documentation": "\n The timestamp for when the share was created. \n
" + "smithy.api#documentation": "The timestamp of when the resource share was created.
" } }, "updateTime": { "target": "com.amazonaws.omics#UpdateTime", "traits": { - "smithy.api#documentation": "\n The timestamp of the share update. \n
" + "smithy.api#documentation": "The timestamp of the resource share update.
" } } }, "traits": { - "smithy.api#documentation": "\n The details of a share. \n
" + "smithy.api#documentation": "The details of a resource share.
" } }, "com.amazonaws.omics#ShareDetailsList": { @@ -13635,6 +13699,28 @@ "smithy.api#pattern": "^[a-zA-Z0-9_-]+$" } }, + "com.amazonaws.omics#ShareResourceType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "VARIANT_STORE", + "name": "VARIANT_STORE", + "documentation": "The share is on a variant store" + }, + { + "value": "ANNOTATION_STORE", + "name": "ANNOTATION_STORE", + "documentation": "The share is on an annotation store" + }, + { + "value": "WORKFLOW", + "name": "WORKFLOW", + "documentation": "The share is on a workflow" + } + ] + } + }, "com.amazonaws.omics#ShareStatus": { "type": "string", "traits": { @@ -14497,7 +14583,7 @@ } ], "traits": { - "smithy.api#documentation": "Starts a workflow run. To duplicate a run, specify the run's ID and a role ARN. The\n remaining parameters are copied from the previous run.
\nThe total number of runs in your account is subject to a quota per Region. To avoid\n needing to delete runs manually, you can set the retention mode to REMOVE.\n Runs with this setting are deleted automatically when the run quoata is exceeded.
Starts a workflow run. To duplicate a run, specify the run's ID and a role ARN. The\n remaining parameters are copied from the previous run.
\nStartRun will not support re-run for a workflow that is shared with you.
\nThe total number of runs in your account is subject to a quota per Region. To avoid\n needing to delete runs manually, you can set the retention mode to REMOVE.\n Runs with this setting are deleted automatically when the run quoata is exceeded.
By default, the run uses STATIC storage. For STATIC storage, set the storageCapacity field. \n You can set the storage type to DYNAMIC. You do not set storageCapacity,\n because HealthOmics dynamically scales the storage up or down as required.\n For more information about static and dynamic storage, see Running workflows \n in the AWS HealthOmics User Guide.
A storage capacity for the run in gibibytes.
", + "smithy.api#documentation": "A storage capacity for the run in gibibytes. This field is not required if the storage type is dynamic\n (the system ignores any value that you enter).
", "smithy.api#range": { "min": 0, "max": 100000 @@ -14605,6 +14691,18 @@ "traits": { "smithy.api#documentation": "The retention mode for the run.
" } + }, + "storageType": { + "target": "com.amazonaws.omics#StorageType", + "traits": { + "smithy.api#documentation": "The run's storage type. By default, the run uses STATIC storage type, which allocates a fixed amount of storage.\n If you set the storage type to DYNAMIC, HealthOmics dynamically scales the storage up \n or down, based on file system utilization.
" + } + }, + "workflowOwnerId": { + "target": "com.amazonaws.omics#WorkflowOwnerId", + "traits": { + "smithy.api#documentation": "The ID of the workflow owner.
" + } } }, "traits": { @@ -14758,6 +14856,10 @@ "target": "com.amazonaws.omics#ShareStatus" }, "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + }, "smithy.api#uniqueItems": {} } }, @@ -14770,6 +14872,25 @@ } } }, + "com.amazonaws.omics#StorageType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "STATIC", + "value": "STATIC" + }, + { + "name": "DYNAMIC", + "value": "DYNAMIC" + } + ], + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, "com.amazonaws.omics#StoreFormat": { "type": "string", "traits": { @@ -15310,6 +15431,19 @@ "smithy.api#documentation": "\nThe options for a TSV file.\n
" } }, + "com.amazonaws.omics#TypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.omics#ShareResourceType" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + }, + "smithy.api#uniqueItems": {} + } + }, "com.amazonaws.omics#UntagResource": { "type": "operation", "input": { @@ -15414,6 +15548,9 @@ } ], "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to update information about the Annotation Store" + }, "smithy.api#documentation": "Updates an annotation store.
", "smithy.api#endpoint": { "hostPrefix": "analytics-" @@ -15787,6 +15924,9 @@ } ], "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to update metadata about the Variant Store" + }, "smithy.api#documentation": "Updates a variant store.
", "smithy.api#endpoint": { "hostPrefix": "analytics-" @@ -16272,6 +16412,9 @@ }, "list": { "target": "com.amazonaws.omics#ListVariantStores" + }, + "traits": { + "smithy.api#documentation": "Represents a resource that stores variant data" } }, "com.amazonaws.omics#VariantStoreItem": { @@ -16699,6 +16842,12 @@ "smithy.api#pattern": "^[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+$" } }, + "com.amazonaws.omics#WorkflowOwnerId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[0-9]{12}$" + } + }, "com.amazonaws.omics#WorkflowParameter": { "type": "structure", "members": {