+ * Accepts a share for an analytics store. + *
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OmicsClient, AcceptShareCommand } from "@aws-sdk/client-omics"; // ES Modules import + * // const { OmicsClient, AcceptShareCommand } = require("@aws-sdk/client-omics"); // CommonJS import + * const client = new OmicsClient(config); + * const input = { // AcceptShareRequest + * shareId: "STRING_VALUE", // required + * }; + * const command = new AcceptShareCommand(input); + * const response = await client.send(command); + * // { // AcceptShareResponse + * // status: "STRING_VALUE", + * // }; + * + * ``` + * + * @param AcceptShareCommandInput - {@link AcceptShareCommandInput} + * @returns {@link AcceptShareCommandOutput} + * @see {@link AcceptShareCommandInput} for command's `input` shape. + * @see {@link AcceptShareCommandOutput} for command's `response` shape. + * @see {@link OmicsClientResolvedConfig | config} for OmicsClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You do not have sufficient access to perform this action.
+ * + * @throws {@link ConflictException} (client fault) + *The request cannot be applied to the target resource in its current state.
+ * + * @throws {@link InternalServerException} (server fault) + *An unexpected error occurred. Try the request again.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The target resource was not found in the current Region.
+ * + * @throws {@link ServiceQuotaExceededException} (client fault) + *The request exceeds a service quota.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling.
+ * + * @throws {@link ValidationException} (client fault) + *The input fails to satisfy the constraints specified by an AWS service.
+ * + * @throws {@link OmicsServiceException} + *Base exception class for all service exceptions from Omics service.
+ * + */ +export class AcceptShareCommand extends $Command< + AcceptShareCommandInput, + AcceptShareCommandOutput, + OmicsClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: AcceptShareCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStack+ * Creates a new version of an annotation store. + *
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OmicsClient, CreateAnnotationStoreVersionCommand } from "@aws-sdk/client-omics"; // ES Modules import + * // const { OmicsClient, CreateAnnotationStoreVersionCommand } = require("@aws-sdk/client-omics"); // CommonJS import + * const client = new OmicsClient(config); + * const input = { // CreateAnnotationStoreVersionRequest + * name: "STRING_VALUE", // required + * versionName: "STRING_VALUE", // required + * description: "STRING_VALUE", + * versionOptions: { // VersionOptions Union: only one key present + * tsvVersionOptions: { // TsvVersionOptions + * annotationType: "STRING_VALUE", + * formatToHeader: { // FormatToHeader + * "You do not have sufficient access to perform this action.
+ * + * @throws {@link ConflictException} (client fault) + *The request cannot be applied to the target resource in its current state.
+ * + * @throws {@link InternalServerException} (server fault) + *An unexpected error occurred. Try the request again.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The target resource was not found in the current Region.
+ * + * @throws {@link ServiceQuotaExceededException} (client fault) + *The request exceeds a service quota.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling.
+ * + * @throws {@link ValidationException} (client fault) + *The input fails to satisfy the constraints specified by an AWS service.
+ * + * @throws {@link OmicsServiceException} + *Base exception class for all service exceptions from Omics service.
+ * + */ +export class CreateAnnotationStoreVersionCommand extends $Command< + CreateAnnotationStoreVersionCommandInput, + CreateAnnotationStoreVersionCommandOutput, + OmicsClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: CreateAnnotationStoreVersionCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStack+ * 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. + *
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OmicsClient, CreateShareCommand } from "@aws-sdk/client-omics"; // ES Modules import + * // const { OmicsClient, CreateShareCommand } = require("@aws-sdk/client-omics"); // CommonJS import + * const client = new OmicsClient(config); + * const input = { // CreateShareRequest + * resourceArn: "STRING_VALUE", // required + * principalSubscriber: "STRING_VALUE", // required + * shareName: "STRING_VALUE", + * }; + * const command = new CreateShareCommand(input); + * const response = await client.send(command); + * // { // CreateShareResponse + * // shareId: "STRING_VALUE", + * // status: "STRING_VALUE", + * // shareName: "STRING_VALUE", + * // }; + * + * ``` + * + * @param CreateShareCommandInput - {@link CreateShareCommandInput} + * @returns {@link CreateShareCommandOutput} + * @see {@link CreateShareCommandInput} for command's `input` shape. + * @see {@link CreateShareCommandOutput} for command's `response` shape. + * @see {@link OmicsClientResolvedConfig | config} for OmicsClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You do not have sufficient access to perform this action.
+ * + * @throws {@link ConflictException} (client fault) + *The request cannot be applied to the target resource in its current state.
+ * + * @throws {@link InternalServerException} (server fault) + *An unexpected error occurred. Try the request again.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The target resource was not found in the current Region.
+ * + * @throws {@link ServiceQuotaExceededException} (client fault) + *The request exceeds a service quota.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling.
+ * + * @throws {@link ValidationException} (client fault) + *The input fails to satisfy the constraints specified by an AWS service.
+ * + * @throws {@link OmicsServiceException} + *Base exception class for all service exceptions from Omics service.
+ * + */ +export class CreateShareCommand extends $Command< + CreateShareCommandInput, + CreateShareCommandOutput, + OmicsClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: CreateShareCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStack+ * Deletes one or multiple versions of an annotation store. + *
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OmicsClient, DeleteAnnotationStoreVersionsCommand } from "@aws-sdk/client-omics"; // ES Modules import + * // const { OmicsClient, DeleteAnnotationStoreVersionsCommand } = require("@aws-sdk/client-omics"); // CommonJS import + * const client = new OmicsClient(config); + * const input = { // DeleteAnnotationStoreVersionsRequest + * name: "STRING_VALUE", // required + * versions: [ // VersionList // required + * "STRING_VALUE", + * ], + * force: true || false, + * }; + * const command = new DeleteAnnotationStoreVersionsCommand(input); + * const response = await client.send(command); + * // { // DeleteAnnotationStoreVersionsResponse + * // errors: [ // VersionDeleteErrorList + * // { // VersionDeleteError + * // versionName: "STRING_VALUE", // required + * // message: "STRING_VALUE", // required + * // }, + * // ], + * // }; + * + * ``` + * + * @param DeleteAnnotationStoreVersionsCommandInput - {@link DeleteAnnotationStoreVersionsCommandInput} + * @returns {@link DeleteAnnotationStoreVersionsCommandOutput} + * @see {@link DeleteAnnotationStoreVersionsCommandInput} for command's `input` shape. + * @see {@link DeleteAnnotationStoreVersionsCommandOutput} for command's `response` shape. + * @see {@link OmicsClientResolvedConfig | config} for OmicsClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You do not have sufficient access to perform this action.
+ * + * @throws {@link ConflictException} (client fault) + *The request cannot be applied to the target resource in its current state.
+ * + * @throws {@link InternalServerException} (server fault) + *An unexpected error occurred. Try the request again.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The target resource was not found in the current Region.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling.
+ * + * @throws {@link ValidationException} (client fault) + *The input fails to satisfy the constraints specified by an AWS service.
+ * + * @throws {@link OmicsServiceException} + *Base exception class for all service exceptions from Omics service.
+ * + */ +export class DeleteAnnotationStoreVersionsCommand extends $Command< + DeleteAnnotationStoreVersionsCommandInput, + DeleteAnnotationStoreVersionsCommandOutput, + OmicsClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: DeleteAnnotationStoreVersionsCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStack+ * Deletes a share of an analytics store. + *
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OmicsClient, DeleteShareCommand } from "@aws-sdk/client-omics"; // ES Modules import + * // const { OmicsClient, DeleteShareCommand } = require("@aws-sdk/client-omics"); // CommonJS import + * const client = new OmicsClient(config); + * const input = { // DeleteShareRequest + * shareId: "STRING_VALUE", // required + * }; + * const command = new DeleteShareCommand(input); + * const response = await client.send(command); + * // { // DeleteShareResponse + * // status: "STRING_VALUE", + * // }; + * + * ``` + * + * @param DeleteShareCommandInput - {@link DeleteShareCommandInput} + * @returns {@link DeleteShareCommandOutput} + * @see {@link DeleteShareCommandInput} for command's `input` shape. + * @see {@link DeleteShareCommandOutput} for command's `response` shape. + * @see {@link OmicsClientResolvedConfig | config} for OmicsClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You do not have sufficient access to perform this action.
+ * + * @throws {@link ConflictException} (client fault) + *The request cannot be applied to the target resource in its current state.
+ * + * @throws {@link InternalServerException} (server fault) + *An unexpected error occurred. Try the request again.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The target resource was not found in the current Region.
+ * + * @throws {@link ServiceQuotaExceededException} (client fault) + *The request exceeds a service quota.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling.
+ * + * @throws {@link ValidationException} (client fault) + *The input fails to satisfy the constraints specified by an AWS service.
+ * + * @throws {@link OmicsServiceException} + *Base exception class for all service exceptions from Omics service.
+ * + */ +export class DeleteShareCommand extends $Command< + DeleteShareCommandInput, + DeleteShareCommandOutput, + OmicsClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: DeleteShareCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStack+ * Retrieves the metadata for an annotation store version. + *
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OmicsClient, GetAnnotationStoreVersionCommand } from "@aws-sdk/client-omics"; // ES Modules import + * // const { OmicsClient, GetAnnotationStoreVersionCommand } = require("@aws-sdk/client-omics"); // CommonJS import + * const client = new OmicsClient(config); + * const input = { // GetAnnotationStoreVersionRequest + * name: "STRING_VALUE", // required + * versionName: "STRING_VALUE", // required + * }; + * const command = new GetAnnotationStoreVersionCommand(input); + * const response = await client.send(command); + * // { // GetAnnotationStoreVersionResponse + * // storeId: "STRING_VALUE", // required + * // id: "STRING_VALUE", // required + * // status: "STRING_VALUE", // required + * // versionArn: "STRING_VALUE", // required + * // name: "STRING_VALUE", // required + * // versionName: "STRING_VALUE", // required + * // description: "STRING_VALUE", // required + * // creationTime: new Date("TIMESTAMP"), // required + * // updateTime: new Date("TIMESTAMP"), // required + * // tags: { // TagMap // required + * // "You do not have sufficient access to perform this action.
+ * + * @throws {@link InternalServerException} (server fault) + *An unexpected error occurred. Try the request again.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The target resource was not found in the current Region.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling.
+ * + * @throws {@link ValidationException} (client fault) + *The input fails to satisfy the constraints specified by an AWS service.
+ * + * @throws {@link OmicsServiceException} + *Base exception class for all service exceptions from Omics service.
+ * + */ +export class GetAnnotationStoreVersionCommand extends $Command< + GetAnnotationStoreVersionCommandInput, + GetAnnotationStoreVersionCommandOutput, + OmicsClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: GetAnnotationStoreVersionCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStack+ * Retrieves the metadata for a share. + *
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OmicsClient, GetShareCommand } from "@aws-sdk/client-omics"; // ES Modules import + * // const { OmicsClient, GetShareCommand } = require("@aws-sdk/client-omics"); // CommonJS import + * const client = new OmicsClient(config); + * const input = { // GetShareRequest + * shareId: "STRING_VALUE", // required + * }; + * const command = new GetShareCommand(input); + * const response = await client.send(command); + * // { // GetShareResponse + * // share: { // ShareDetails + * // shareId: "STRING_VALUE", + * // resourceArn: "STRING_VALUE", + * // principalSubscriber: "STRING_VALUE", + * // ownerId: "STRING_VALUE", + * // status: "STRING_VALUE", + * // statusMessage: "STRING_VALUE", + * // shareName: "STRING_VALUE", + * // creationTime: new Date("TIMESTAMP"), + * // updateTime: new Date("TIMESTAMP"), + * // }, + * // }; + * + * ``` + * + * @param GetShareCommandInput - {@link GetShareCommandInput} + * @returns {@link GetShareCommandOutput} + * @see {@link GetShareCommandInput} for command's `input` shape. + * @see {@link GetShareCommandOutput} for command's `response` shape. + * @see {@link OmicsClientResolvedConfig | config} for OmicsClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You do not have sufficient access to perform this action.
+ * + * @throws {@link ConflictException} (client fault) + *The request cannot be applied to the target resource in its current state.
+ * + * @throws {@link InternalServerException} (server fault) + *An unexpected error occurred. Try the request again.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The target resource was not found in the current Region.
+ * + * @throws {@link ServiceQuotaExceededException} (client fault) + *The request exceeds a service quota.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling.
+ * + * @throws {@link ValidationException} (client fault) + *The input fails to satisfy the constraints specified by an AWS service.
+ * + * @throws {@link OmicsServiceException} + *Base exception class for all service exceptions from Omics service.
+ * + */ +export class GetShareCommand extends $Command+ * Lists the versions of an annotation store. + *
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OmicsClient, ListAnnotationStoreVersionsCommand } from "@aws-sdk/client-omics"; // ES Modules import + * // const { OmicsClient, ListAnnotationStoreVersionsCommand } = require("@aws-sdk/client-omics"); // CommonJS import + * const client = new OmicsClient(config); + * const input = { // ListAnnotationStoreVersionsRequest + * name: "STRING_VALUE", // required + * maxResults: Number("int"), + * nextToken: "STRING_VALUE", + * filter: { // ListAnnotationStoreVersionsFilter + * status: "STRING_VALUE", + * }, + * }; + * const command = new ListAnnotationStoreVersionsCommand(input); + * const response = await client.send(command); + * // { // ListAnnotationStoreVersionsResponse + * // annotationStoreVersions: [ // AnnotationStoreVersionItems + * // { // AnnotationStoreVersionItem + * // storeId: "STRING_VALUE", // required + * // id: "STRING_VALUE", // required + * // status: "STRING_VALUE", // required + * // versionArn: "STRING_VALUE", // required + * // name: "STRING_VALUE", // required + * // versionName: "STRING_VALUE", // required + * // description: "STRING_VALUE", // required + * // creationTime: new Date("TIMESTAMP"), // required + * // updateTime: new Date("TIMESTAMP"), // required + * // statusMessage: "STRING_VALUE", // required + * // versionSizeBytes: Number("long"), // required + * // }, + * // ], + * // nextToken: "STRING_VALUE", + * // }; + * + * ``` + * + * @param ListAnnotationStoreVersionsCommandInput - {@link ListAnnotationStoreVersionsCommandInput} + * @returns {@link ListAnnotationStoreVersionsCommandOutput} + * @see {@link ListAnnotationStoreVersionsCommandInput} for command's `input` shape. + * @see {@link ListAnnotationStoreVersionsCommandOutput} for command's `response` shape. + * @see {@link OmicsClientResolvedConfig | config} for OmicsClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You do not have sufficient access to perform this action.
+ * + * @throws {@link InternalServerException} (server fault) + *An unexpected error occurred. Try the request again.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The target resource was not found in the current Region.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling.
+ * + * @throws {@link ValidationException} (client fault) + *The input fails to satisfy the constraints specified by an AWS service.
+ * + * @throws {@link OmicsServiceException} + *Base exception class for all service exceptions from Omics service.
+ * + */ +export class ListAnnotationStoreVersionsCommand extends $Command< + ListAnnotationStoreVersionsCommandInput, + ListAnnotationStoreVersionsCommandOutput, + OmicsClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: ListAnnotationStoreVersionsCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStack+ * Lists all shares associated with an account. + *
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OmicsClient, ListSharesCommand } from "@aws-sdk/client-omics"; // ES Modules import + * // const { OmicsClient, ListSharesCommand } = require("@aws-sdk/client-omics"); // CommonJS import + * const client = new OmicsClient(config); + * const input = { // ListSharesRequest + * resourceOwner: "STRING_VALUE", // required + * filter: { // Filter + * resourceArns: [ // ArnList + * "STRING_VALUE", + * ], + * status: [ // StatusList + * "STRING_VALUE", + * ], + * }, + * nextToken: "STRING_VALUE", + * maxResults: Number("int"), + * }; + * const command = new ListSharesCommand(input); + * const response = await client.send(command); + * // { // ListSharesResponse + * // shares: [ // ShareDetailsList // required + * // { // ShareDetails + * // shareId: "STRING_VALUE", + * // resourceArn: "STRING_VALUE", + * // principalSubscriber: "STRING_VALUE", + * // ownerId: "STRING_VALUE", + * // status: "STRING_VALUE", + * // statusMessage: "STRING_VALUE", + * // shareName: "STRING_VALUE", + * // creationTime: new Date("TIMESTAMP"), + * // updateTime: new Date("TIMESTAMP"), + * // }, + * // ], + * // nextToken: "STRING_VALUE", + * // }; + * + * ``` + * + * @param ListSharesCommandInput - {@link ListSharesCommandInput} + * @returns {@link ListSharesCommandOutput} + * @see {@link ListSharesCommandInput} for command's `input` shape. + * @see {@link ListSharesCommandOutput} for command's `response` shape. + * @see {@link OmicsClientResolvedConfig | config} for OmicsClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You do not have sufficient access to perform this action.
+ * + * @throws {@link ConflictException} (client fault) + *The request cannot be applied to the target resource in its current state.
+ * + * @throws {@link InternalServerException} (server fault) + *An unexpected error occurred. Try the request again.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The target resource was not found in the current Region.
+ * + * @throws {@link ServiceQuotaExceededException} (client fault) + *The request exceeds a service quota.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling.
+ * + * @throws {@link ValidationException} (client fault) + *The input fails to satisfy the constraints specified by an AWS service.
+ * + * @throws {@link OmicsServiceException} + *Base exception class for all service exceptions from Omics service.
+ * + */ +export class ListSharesCommand extends $Command< + ListSharesCommandInput, + ListSharesCommandOutput, + OmicsClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: ListSharesCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStack+ * Updates the description of an annotation store version. + *
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OmicsClient, UpdateAnnotationStoreVersionCommand } from "@aws-sdk/client-omics"; // ES Modules import + * // const { OmicsClient, UpdateAnnotationStoreVersionCommand } = require("@aws-sdk/client-omics"); // CommonJS import + * const client = new OmicsClient(config); + * const input = { // UpdateAnnotationStoreVersionRequest + * name: "STRING_VALUE", // required + * versionName: "STRING_VALUE", // required + * description: "STRING_VALUE", + * }; + * const command = new UpdateAnnotationStoreVersionCommand(input); + * const response = await client.send(command); + * // { // UpdateAnnotationStoreVersionResponse + * // storeId: "STRING_VALUE", // required + * // id: "STRING_VALUE", // required + * // status: "STRING_VALUE", // required + * // name: "STRING_VALUE", // required + * // versionName: "STRING_VALUE", // required + * // description: "STRING_VALUE", // required + * // creationTime: new Date("TIMESTAMP"), // required + * // updateTime: new Date("TIMESTAMP"), // required + * // }; + * + * ``` + * + * @param UpdateAnnotationStoreVersionCommandInput - {@link UpdateAnnotationStoreVersionCommandInput} + * @returns {@link UpdateAnnotationStoreVersionCommandOutput} + * @see {@link UpdateAnnotationStoreVersionCommandInput} for command's `input` shape. + * @see {@link UpdateAnnotationStoreVersionCommandOutput} for command's `response` shape. + * @see {@link OmicsClientResolvedConfig | config} for OmicsClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You do not have sufficient access to perform this action.
+ * + * @throws {@link InternalServerException} (server fault) + *An unexpected error occurred. Try the request again.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The target resource was not found in the current Region.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling.
+ * + * @throws {@link ValidationException} (client fault) + *The input fails to satisfy the constraints specified by an AWS service.
+ * + * @throws {@link OmicsServiceException} + *Base exception class for all service exceptions from Omics service.
+ * + */ +export class UpdateAnnotationStoreVersionCommand extends $Command< + UpdateAnnotationStoreVersionCommandInput, + UpdateAnnotationStoreVersionCommandOutput, + OmicsClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: UpdateAnnotationStoreVersionCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStack+ * The ID for a share offer for analytics store data. + *
+ */ + shareId: string | undefined; +} + +/** + * @public + * @enum + */ +export const ShareStatus = { + /** + * The share is activated + */ + ACTIVATING: "ACTIVATING", + /** + * The share is active and can be used + */ + ACTIVE: "ACTIVE", + /** + * The share has been deleted + */ + DELETED: "DELETED", + /** + * The share is being deleted + */ + DELETING: "DELETING", + /** + * The share has failed to activate or delete + */ + FAILED: "FAILED", + /** + * The share has been created but is not yet active + */ + PENDING: "PENDING", +} as const; + +/** + * @public + */ +export type ShareStatus = (typeof ShareStatus)[keyof typeof ShareStatus]; + +/** + * @public + */ +export interface AcceptShareResponse { + /** + * @public + *+ * The status of an analytics store share. + *
+ */ + status?: ShareStatus | string; +} + +/** + * @public + *The request cannot be applied to the target resource in its current state.
+ */ +export class ConflictException extends __BaseException { + readonly name: "ConflictException" = "ConflictException"; + readonly $fault: "client" = "client"; + /** + * @internal + */ + constructor(opts: __ExceptionOptionType+ * The name of the annotation store version. + *
+ */ + versionName: string | undefined; + /** * @public *The job's service role ARN.
@@ -710,6 +800,14 @@ export interface AnnotationImportJobItem { */ destinationName: string | undefined; + /** + * @public + *+ * The name of the annotation store version. + *
+ */ + versionName: string | undefined; + /** * @public *The job's service role ARN.
@@ -794,6 +892,14 @@ export interface StartAnnotationImportRequest { */ items: AnnotationImportItemSource[] | undefined; + /** + * @public + *+ * The name of the annotation store version. + *
+ */ + versionName?: string; + /** * @public *Formatting options for the annotation file.
@@ -826,26 +932,6 @@ export interface StartAnnotationImportResponse { jobId: string | undefined; } -/** - * @public - *The request cannot be applied to the target resource in its current state.
- */ -export class ConflictException extends __BaseException { - readonly name: "ConflictException" = "ConflictException"; - readonly $fault: "client" = "client"; - /** - * @internal - */ - constructor(opts: __ExceptionOptionTypeA genome reference.
@@ -1126,6 +1212,14 @@ export interface CreateAnnotationStoreRequest { */ tags?: Record+ * The name given to an annotation store version to distinguish it from other versions. + *
+ */ + versionName?: string; + /** * @public *Server-side encryption (SSE) settings for the store.
@@ -1217,6 +1311,14 @@ export interface CreateAnnotationStoreResponse { */ name: string | undefined; + /** + * @public + *+ * The name given to an annotation store version to distinguish it from other versions. + *
+ */ + versionName: string | undefined; + /** * @public *When the store was created.
@@ -1350,6 +1452,14 @@ export interface GetAnnotationStoreResponse { *The store's size in bytes.
*/ storeSizeBytes: number | undefined; + + /** + * @public + *+ * An integer indicating how many versions of an annotation store exist. + *
+ */ + numVersions: number | undefined; } /** @@ -1517,51 +1627,726 @@ export interface UpdateAnnotationStoreResponse { /** * @public - *The store's genome reference.
+ *The store's genome reference.
+ */ + reference: ReferenceItem | undefined; + + /** + * @public + *The store's status.
+ */ + status: StoreStatus | string | undefined; + + /** + * @public + *The store's name.
+ */ + name: string | undefined; + + /** + * @public + *The store's description.
+ */ + description: string | undefined; + + /** + * @public + *When the store was created.
+ */ + creationTime: Date | undefined; + + /** + * @public + *When the store was updated.
+ */ + updateTime: Date | undefined; + + /** + * @public + *Parsing options for the store.
+ */ + storeOptions?: StoreOptions; + + /** + * @public + *The annotation file format of the store.
+ */ + storeFormat?: StoreFormat | string; +} + +/** + * @public + *+ * The options for a TSV file. + *
+ */ +export interface TsvVersionOptions { + /** + * @public + *+ * The store version's annotation type. + *
+ */ + annotationType?: AnnotationType | string; + + /** + * @public + *+ * The annotation store version's header key to column name mapping. + *
+ */ + formatToHeader?: Record+ * The TSV schema for an annotation store version. + *
+ */ + schema?: Record+ * The options for an annotation store version. + *
+ */ +export type VersionOptions = VersionOptions.TsvVersionOptionsMember | VersionOptions.$UnknownMember; + +/** + * @public + */ +export namespace VersionOptions { + /** + * @public + *+ * File settings for a version of a TSV store. + *
+ */ + export interface TsvVersionOptionsMember { + tsvVersionOptions: TsvVersionOptions; + $unknown?: never; + } + + /** + * @public + */ + export interface $UnknownMember { + tsvVersionOptions?: never; + $unknown: [string, any]; + } + + export interface Visitor+ * The name of an annotation store version from which versions are being created. + *
+ */ + name: string | undefined; + + /** + * @public + *+ * The name given to an annotation store version to distinguish it from other versions. + *
+ */ + versionName: string | undefined; + + /** + * @public + *+ * The description of an annotation store version. + *
+ */ + description?: string; + + /** + * @public + *+ * The options for an annotation store version. + *
+ */ + versionOptions?: VersionOptions; + + /** + * @public + *+ * Any tags added to annotation store version. + *
+ */ + tags?: Record+ * A generated ID for the annotation store + *
+ */ + id: string | undefined; + + /** + * @public + *+ * The name given to an annotation store version to distinguish it from other versions. + *
+ */ + versionName: string | undefined; + + /** + * @public + *+ * The ID for the annotation store from which new versions are being created. + *
+ */ + storeId: string | undefined; + + /** + * @public + *+ * The options for an annotation store version. + *
+ */ + versionOptions?: VersionOptions; + + /** + * @public + *+ * The name given to an annotation store version to distinguish it from other versions. + *
+ */ + name: string | undefined; + + /** + * @public + *+ * The status of a annotation store version. + *
+ */ + status: VersionStatus | string | undefined; + + /** + * @public + *+ * The time stamp for the creation of an annotation store version. + *
+ */ + creationTime: Date | undefined; +} + +/** + * @public + */ +export interface DeleteAnnotationStoreVersionsRequest { + /** + * @public + *+ * The name of the annotation store from which versions are being deleted. + *
+ */ + name: string | undefined; + + /** + * @public + *+ * The versions of an annotation store to be deleted. + *
+ */ + versions: string[] | undefined; + + /** + * @public + *+ * Forces the deletion of an annotation store version when imports are in-progress.. + *
+ */ + force?: boolean; +} + +/** + * @public + *+ * The error preventing deletion of the annotation store version. + *
+ */ +export interface VersionDeleteError { + /** + * @public + *+ * The name given to an annotation store version. + *
+ */ + versionName: string | undefined; + + /** + * @public + *+ * The message explaining the error in annotation store deletion. + *
+ */ + message: string | undefined; +} + +/** + * @public + */ +export interface DeleteAnnotationStoreVersionsResponse { + /** + * @public + *+ * Any errors that occur when attempting to delete an annotation store version. + *
+ */ + errors?: VersionDeleteError[]; +} + +/** + * @public + */ +export interface GetAnnotationStoreVersionRequest { + /** + * @public + *+ * The name given to an annotation store version to distinguish it from others. + *
+ */ + name: string | undefined; + + /** + * @public + *+ * The name given to an annotation store version to distinguish it from others. + *
+ */ + versionName: string | undefined; +} + +/** + * @public + */ +export interface GetAnnotationStoreVersionResponse { + /** + * @public + *+ * The store ID for annotation store version. + *
+ */ + storeId: string | undefined; + + /** + * @public + *+ * The annotation store version ID. + *
+ */ + id: string | undefined; + + /** + * @public + *+ * The status of an annotation store version. + *
+ */ + status: VersionStatus | string | undefined; + + /** + * @public + *+ * The Arn for the annotation store. + *
+ */ + versionArn: string | undefined; + + /** + * @public + *+ * The name of the annotation store. + *
+ */ + name: string | undefined; + + /** + * @public + *+ * The name given to an annotation store version to distinguish it from others. + *
+ */ + versionName: string | undefined; + + /** + * @public + *+ * The description for an annotation store version. + *
+ */ + description: string | undefined; + + /** + * @public + *+ * The time stamp for when an annotation store version was created. + *
+ */ + creationTime: Date | undefined; + + /** + * @public + *+ * The time stamp for when an annotation store version was updated. + *
+ */ + updateTime: Date | undefined; + + /** + * @public + *+ * Any tags associated with an annotation store version. + *
+ */ + tags: Record+ * The options for an annotation store version. + *
+ */ + versionOptions?: VersionOptions; + + /** + * @public + *+ * The status of an annotation store version. + *
+ */ + statusMessage: string | undefined; + + /** + * @public + *+ * The size of the annotation store version in Bytes. + *
+ */ + versionSizeBytes: number | undefined; +} + +/** + * @public + *+ * Use filters to focus the returned annotation store versions on a specific parameter, such as the status of the annotation store. + *
+ */ +export interface ListAnnotationStoreVersionsFilter { + /** + * @public + *+ * The status of an annotation store version. + *
+ */ + status?: VersionStatus | string; +} + +/** + * @public + */ +export interface ListAnnotationStoreVersionsRequest { + /** + * @public + *+ * The name of an annotation store. + *
+ */ + name: string | undefined; + + /** + * @public + *+ * The maximum number of annotation store versions to return in one page of results. + *
+ */ + maxResults?: number; + + /** + * @public + *+ * Specifies the pagination token from a previous request to retrieve the next page of results. + *
+ */ + nextToken?: string; + + /** + * @public + *+ * A filter to apply to the list of annotation store versions. + *
+ */ + filter?: ListAnnotationStoreVersionsFilter; +} + +/** + * @public + *+ * Annotation store versions. + *
+ */ +export interface AnnotationStoreVersionItem { + /** + * @public + *+ * The store ID for an annotation store version. + *
+ */ + storeId: string | undefined; + + /** + * @public + *+ * The annotation store version ID. + *
+ */ + id: string | undefined; + + /** + * @public + *+ * The status of an annotation store version. + *
+ */ + status: VersionStatus | string | undefined; + + /** + * @public + *+ * The Arn for an annotation store version. + *
+ */ + versionArn: string | undefined; + + /** + * @public + *+ * A name given to an annotation store version to distinguish it from others. + *
+ */ + name: string | undefined; + + /** + * @public + *+ * The name of an annotation store version. + *
+ */ + versionName: string | undefined; + + /** + * @public + *+ * The description of an annotation store version. + *
+ */ + description: string | undefined; + + /** + * @public + *+ * The time stamp for when an annotation store version was created. + *
+ */ + creationTime: Date | undefined; + + /** + * @public + *+ * The time stamp for when an annotation store version was updated. + *
+ */ + updateTime: Date | undefined; + + /** + * @public + *+ * The status of an annotation store version. + *
+ */ + statusMessage: string | undefined; + + /** + * @public + *+ * The size of an annotation store version in Bytes. + *
+ */ + versionSizeBytes: number | undefined; +} + +/** + * @public + */ +export interface ListAnnotationStoreVersionsResponse { + /** + * @public + *+ * Lists all versions of an annotation store. + *
+ */ + annotationStoreVersions?: AnnotationStoreVersionItem[]; + + /** + * @public + *+ * Specifies the pagination token from a previous request to retrieve the next page of results. + *
+ */ + nextToken?: string; +} + +/** + * @public + */ +export interface UpdateAnnotationStoreVersionRequest { + /** + * @public + *+ * The name of an annotation store. + *
+ */ + name: string | undefined; + + /** + * @public + *+ * The name of an annotation store version. + *
+ */ + versionName: string | undefined; + + /** + * @public + *+ * The description of an annotation store. + *
+ */ + description?: string; +} + +/** + * @public + */ +export interface UpdateAnnotationStoreVersionResponse { + /** + * @public + *+ * The annotation store ID. + *
*/ - reference: ReferenceItem | undefined; + storeId: string | undefined; /** * @public - *The store's status.
+ *+ * The annotation store version ID. + *
*/ - status: StoreStatus | string | undefined; + id: string | undefined; /** * @public - *The store's name.
+ *+ * The status of an annotation store version. + *
*/ - name: string | undefined; + status: VersionStatus | string | undefined; /** * @public - *The store's description.
+ *+ * The name of an annotation store. + *
*/ - description: string | undefined; + name: string | undefined; /** * @public - *When the store was created.
+ *+ * The name of an annotation store version.
*/ - creationTime: Date | undefined; + versionName: string | undefined; /** * @public - *When the store was updated.
+ *+ * The description of an annotation store version. + *
*/ - updateTime: Date | undefined; + description: string | undefined; /** * @public - *Parsing options for the store.
+ *+ * The time stamp for when an annotation store version was created. + *
*/ - storeOptions?: StoreOptions; + creationTime: Date | undefined; /** * @public - *The annotation file format of the store.
+ *+ * The time stamp for when an annotation store version was updated. + *
*/ - storeFormat?: StoreFormat | string; + updateTime: Date | undefined; } /** @@ -2164,6 +2949,64 @@ export interface CreateSequenceStoreResponse { fallbackLocation?: string; } +/** + * @public + */ +export interface CreateShareRequest { + /** + * @public + *+ * The resource ARN for the analytics store to be shared. + *
+ */ + resourceArn: string | undefined; + + /** + * @public + *+ * The principal subscriber is the account being given access to the analytics store data through the share offer. + *
+ */ + principalSubscriber: string | undefined; + + /** + * @public + *+ * A name given to the share. + *
+ */ + shareName?: string; +} + +/** + * @public + */ +export interface CreateShareResponse { + /** + * @public + *+ * An ID generated for the share. + *
+ */ + shareId?: string; + + /** + * @public + *+ * The status of a share. + *
+ */ + status?: ShareStatus | string; + + /** + * @public + *+ * A name given to the share. + *
+ */ + shareName?: string; +} + /** * @public */ @@ -2477,6 +3320,32 @@ export interface DeleteSequenceStoreRequest { */ export interface DeleteSequenceStoreResponse {} +/** + * @public + */ +export interface DeleteShareRequest { + /** + * @public + *+ * The ID for the share request to be deleted. + *
+ */ + shareId: string | undefined; +} + +/** + * @public + */ +export interface DeleteShareResponse { + /** + * @public + *+ * The status of the share being deleted. + *
+ */ + status?: ShareStatus | string; +} + /** * @public */ @@ -2677,6 +3546,30 @@ export interface FileInformation { contentLength?: number; } +/** + * @public + *+ * Use filters to focus the returned annotation store versions on a specific parameter, such as the status of the annotation store. + *
+ */ +export interface Filter { + /** + * @public + *+ * The Amazon Resource Number (Arn) for an analytics store. + *
+ */ + resourceArns?: string[]; + + /** + * @public + *+ * The status of an annotation store version. + *
+ */ + status?: (ShareStatus | string)[]; +} + /** * @public * @enum @@ -4126,6 +5019,112 @@ export interface GetSequenceStoreResponse { fallbackLocation?: string; } +/** + * @public + */ +export interface GetShareRequest { + /** + * @public + *+ * The generated ID for a share. + *
+ */ + shareId: string | undefined; +} + +/** + * @public + *+ * The details of a share. + *
+ */ +export interface ShareDetails { + /** + * @public + *+ * The ID for a share offer for an analytics store . + *
+ */ + shareId?: string; + + /** + * @public + *+ * The resource Arn of the analytics store being shared. + *
+ */ + resourceArn?: string; + + /** + * @public + *+ * The principal subscriber is the account the analytics store data is being shared with. + *
+ */ + principalSubscriber?: string; + + /** + * @public + *+ * The account ID for the data owner. The owner creates the share offer. + *
+ */ + ownerId?: string; + + /** + * @public + *+ * The status of a share. + *
+ */ + status?: ShareStatus | string; + + /** + * @public + *+ * The status message for a share. It provides more details on the status of the share. + *
+ */ + statusMessage?: string; + + /** + * @public + *+ * The name of the share. + *
+ */ + shareName?: string; + + /** + * @public + *+ * The timestamp for when the share was created. + *
+ */ + creationTime?: Date; + + /** + * @public + *+ * The timestamp of the share update. + *
+ */ + updateTime?: Date; +} + +/** + * @public + */ +export interface GetShareResponse { + /** + * @public + *+ * An analytic store share details object. contains status, resourceArn, ownerId, etc. + *
+ */ + share?: ShareDetails; +} + /** * @public */ @@ -5980,6 +6979,84 @@ export interface ListSequenceStoresResponse { sequenceStores: SequenceStoreDetail[] | undefined; } +/** + * @public + * @enum + */ +export const ResourceOwner = { + /** + * The resource owner is an account other than the caller + */ + OTHER: "OTHER", + /** + * The resource owner is the calling account + */ + SELF: "SELF", +} as const; + +/** + * @public + */ +export type ResourceOwner = (typeof ResourceOwner)[keyof typeof ResourceOwner]; + +/** + * @public + */ +export interface ListSharesRequest { + /** + * @public + *+ * The account that owns the analytics store shared. + *
+ */ + resourceOwner: ResourceOwner | string | undefined; + + /** + * @public + *+ * Attributes used to filter for a specific subset of shares. + *
+ */ + filter?: Filter; + + /** + * @public + *+ * Next token returned in the response of a previous ListReadSetUploadPartsRequest call. Used to get the next page of results. + *
+ */ + nextToken?: string; + + /** + * @public + *+ * The maximum number of shares to return in one page of results. + *
+ */ + maxResults?: number; +} + +/** + * @public + */ +export interface ListSharesResponse { + /** + * @public + *+ * The shares available and their meta details. + *
+ */ + shares: ShareDetails[] | undefined; + + /** + * @public + *+ * Next token returned in the response of a previous ListSharesResponse call. Used to get the next page of results. + *
+ */ + nextToken?: string; +} + /** * @public */ diff --git a/clients/client-omics/src/pagination/ListAnnotationStoreVersionsPaginator.ts b/clients/client-omics/src/pagination/ListAnnotationStoreVersionsPaginator.ts new file mode 100644 index 0000000000000..4c5b3d6e6fe31 --- /dev/null +++ b/clients/client-omics/src/pagination/ListAnnotationStoreVersionsPaginator.ts @@ -0,0 +1,50 @@ +// smithy-typescript generated code +import { Paginator } from "@smithy/types"; + +import { + ListAnnotationStoreVersionsCommand, + ListAnnotationStoreVersionsCommandInput, + ListAnnotationStoreVersionsCommandOutput, +} from "../commands/ListAnnotationStoreVersionsCommand"; +import { OmicsClient } from "../OmicsClient"; +import { OmicsPaginationConfiguration } from "./Interfaces"; + +/** + * @internal + */ +const makePagedClientRequest = async ( + client: OmicsClient, + input: ListAnnotationStoreVersionsCommandInput, + ...args: any +): Promise\nAccepts a share for an analytics store. \n
", + "smithy.api#endpoint": { + "hostPrefix": "analytics-" + }, + "smithy.api#http": { + "method": "POST", + "uri": "/share/{shareId}", + "code": 200 + } + } + }, + "com.amazonaws.omics#AcceptShareRequest": { + "type": "structure", + "members": { + "shareId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "\nThe ID for a share offer for analytics store data. \n
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.omics#AcceptShareResponse": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.omics#ShareStatus", + "traits": { + "smithy.api#documentation": "\nThe status of an analytics store share. \n
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.omics#AccessDeniedException": { "type": "structure", "members": { @@ -348,6 +421,13 @@ "smithy.api#required": {} } }, + "versionName": { + "target": "com.amazonaws.omics#VersionName", + "traits": { + "smithy.api#documentation": "\nThe name of the annotation store version. \n
", + "smithy.api#required": {} + } + }, "roleArn": { "target": "com.amazonaws.omics#Arn", "traits": { @@ -475,7 +555,7 @@ } }, "description": { - "target": "com.amazonaws.omics#StoreDescription", + "target": "com.amazonaws.omics#Description", "traits": { "smithy.api#documentation": "The store's description.
", "smithy.api#required": {} @@ -527,6 +607,125 @@ "target": "com.amazonaws.omics#AnnotationStoreItem" } }, + "com.amazonaws.omics#AnnotationStoreVersion": { + "type": "resource", + "identifiers": { + "name": { + "target": "smithy.api#String" + }, + "versionName": { + "target": "smithy.api#String" + } + }, + "create": { + "target": "com.amazonaws.omics#CreateAnnotationStoreVersion" + }, + "read": { + "target": "com.amazonaws.omics#GetAnnotationStoreVersion" + }, + "update": { + "target": "com.amazonaws.omics#UpdateAnnotationStoreVersion" + }, + "list": { + "target": "com.amazonaws.omics#ListAnnotationStoreVersions" + }, + "collectionOperations": [ + { + "target": "com.amazonaws.omics#DeleteAnnotationStoreVersions" + } + ] + }, + "com.amazonaws.omics#AnnotationStoreVersionItem": { + "type": "structure", + "members": { + "storeId": { + "target": "com.amazonaws.omics#ResourceId", + "traits": { + "smithy.api#documentation": "\nThe store ID for an annotation store version. \n
", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.omics#ResourceId", + "traits": { + "smithy.api#documentation": "\nThe annotation store version ID. \n
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.omics#VersionStatus", + "traits": { + "smithy.api#documentation": "\nThe status of an annotation store version. \n
", + "smithy.api#required": {} + } + }, + "versionArn": { + "target": "com.amazonaws.omics#Arn", + "traits": { + "smithy.api#documentation": "\nThe Arn for an annotation store version. \n
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.omics#StoreName", + "traits": { + "smithy.api#documentation": "\nA name given to an annotation store version to distinguish it from others. \n
", + "smithy.api#required": {} + } + }, + "versionName": { + "target": "com.amazonaws.omics#VersionName", + "traits": { + "smithy.api#documentation": "\nThe name of an annotation store version.\n
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.omics#Description", + "traits": { + "smithy.api#documentation": "\nThe description of an annotation store version. \n
", + "smithy.api#required": {} + } + }, + "creationTime": { + "target": "com.amazonaws.omics#CreationTime", + "traits": { + "smithy.api#documentation": "\nThe time stamp for when an annotation store version was created. \n
", + "smithy.api#required": {} + } + }, + "updateTime": { + "target": "com.amazonaws.omics#UpdateTime", + "traits": { + "smithy.api#documentation": "\nThe time stamp for when an annotation store version was updated. \n
", + "smithy.api#required": {} + } + }, + "statusMessage": { + "target": "com.amazonaws.omics#StatusMessage", + "traits": { + "smithy.api#documentation": "\nThe status of an annotation store version.\n
", + "smithy.api#required": {} + } + }, + "versionSizeBytes": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "\nThe size of an annotation store version in Bytes. \n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "\nAnnotation store versions.\n
" + } + }, + "com.amazonaws.omics#AnnotationStoreVersionItems": { + "type": "list", + "member": { + "target": "com.amazonaws.omics#AnnotationStoreVersionItem" + } + }, "com.amazonaws.omics#AnnotationType": { "type": "string", "traits": { @@ -579,6 +778,19 @@ "smithy.api#pattern": "^arn:([^:\n]*):([^:\n]*):([^:\n]*):([0-9]{12}):([^:\n]*)$" } }, + "com.amazonaws.omics#ArnList": { + "type": "list", + "member": { + "target": "smithy.api#String" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + }, + "smithy.api#uniqueItems": {} + } + }, "com.amazonaws.omics#BatchDeleteReadSet": { "type": "operation", "input": { @@ -1064,14 +1276,13 @@ } }, "name": { - "target": "smithy.api#String", + "target": "com.amazonaws.omics#StoreName", "traits": { - "smithy.api#documentation": "A name for the store.
", - "smithy.api#pattern": "^([a-z]){1}([a-z0-9_]){2,254}$" + "smithy.api#documentation": "A name for the store.
" } }, "description": { - "target": "com.amazonaws.omics#StoreDescription", + "target": "com.amazonaws.omics#Description", "traits": { "smithy.api#documentation": "A description for the store.
" } @@ -1082,6 +1293,12 @@ "smithy.api#documentation": "Tags for the store.
" } }, + "versionName": { + "target": "com.amazonaws.omics#VersionName", + "traits": { + "smithy.api#documentation": "\nThe name given to an annotation store version to distinguish it from other versions. \n
" + } + }, "sseConfig": { "target": "com.amazonaws.omics#SseConfig", "traits": { @@ -1148,6 +1365,13 @@ "smithy.api#required": {} } }, + "versionName": { + "target": "com.amazonaws.omics#VersionName", + "traits": { + "smithy.api#documentation": "\nThe name given to an annotation store version to distinguish it from other versions. \n
", + "smithy.api#required": {} + } + }, "creationTime": { "target": "com.amazonaws.omics#CreationTime", "traits": { @@ -1160,26 +1384,23 @@ "smithy.api#output": {} } }, - "com.amazonaws.omics#CreateMultipartReadSetUpload": { + "com.amazonaws.omics#CreateAnnotationStoreVersion": { "type": "operation", "input": { - "target": "com.amazonaws.omics#CreateMultipartReadSetUploadRequest" + "target": "com.amazonaws.omics#CreateAnnotationStoreVersionRequest" }, "output": { - "target": "com.amazonaws.omics#CreateMultipartReadSetUploadResponse" + "target": "com.amazonaws.omics#CreateAnnotationStoreVersionResponse" }, "errors": [ { "target": "com.amazonaws.omics#AccessDeniedException" }, { - "target": "com.amazonaws.omics#InternalServerException" - }, - { - "target": "com.amazonaws.omics#NotSupportedOperationException" + "target": "com.amazonaws.omics#ConflictException" }, { - "target": "com.amazonaws.omics#RequestTimeoutException" + "target": "com.amazonaws.omics#InternalServerException" }, { "target": "com.amazonaws.omics#ResourceNotFoundException" @@ -1195,84 +1416,51 @@ } ], "traits": { - "smithy.api#documentation": "\n Begins a multipart read set upload. \n
", + "smithy.api#documentation": "\nCreates a new version of an annotation store. \n
", "smithy.api#endpoint": { - "hostPrefix": "control-storage-" + "hostPrefix": "analytics-" }, "smithy.api#http": { "method": "POST", - "uri": "/sequencestore/{sequenceStoreId}/upload" + "uri": "/annotationStore/{name}/version", + "code": 200 } } }, - "com.amazonaws.omics#CreateMultipartReadSetUploadRequest": { + "com.amazonaws.omics#CreateAnnotationStoreVersionRequest": { "type": "structure", "members": { - "sequenceStoreId": { - "target": "com.amazonaws.omics#SequenceStoreId", + "name": { + "target": "com.amazonaws.omics#StoreName", "traits": { - "smithy.api#documentation": "\n The sequence store ID for the store that is the destination of the multipart uploads.\n
", + "smithy.api#documentation": "\nThe name of an annotation store version from which versions are being created. \n
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "clientToken": { - "target": "com.amazonaws.omics#ClientToken", - "traits": { - "smithy.api#documentation": "\n An idempotency token that can be used to avoid triggering multiple multipart uploads.\n
" - } - }, - "sourceFileType": { - "target": "com.amazonaws.omics#FileType", - "traits": { - "smithy.api#documentation": "\n The type of file being uploaded.\n
", - "smithy.api#required": {} - } - }, - "subjectId": { - "target": "com.amazonaws.omics#SubjectId", - "traits": { - "smithy.api#documentation": "\n The source's subject ID.\n
", - "smithy.api#required": {} - } - }, - "sampleId": { - "target": "com.amazonaws.omics#SampleId", - "traits": { - "smithy.api#documentation": "\n The source's sample ID.\n
", - "smithy.api#required": {} - } - }, - "generatedFrom": { - "target": "com.amazonaws.omics#GeneratedFrom", - "traits": { - "smithy.api#documentation": "\n Where the source originated.\n
" - } - }, - "referenceArn": { - "target": "com.amazonaws.omics#ReferenceArn", + "versionName": { + "target": "com.amazonaws.omics#VersionName", "traits": { - "smithy.api#documentation": "\n The ARN of the reference.\n
", + "smithy.api#documentation": "\nThe name given to an annotation store version to distinguish it from other versions. \n
", "smithy.api#required": {} } }, - "name": { - "target": "com.amazonaws.omics#ReadSetName", + "description": { + "target": "com.amazonaws.omics#Description", "traits": { - "smithy.api#documentation": "\n The name of the read set.\n
", - "smithy.api#required": {} + "smithy.api#documentation": "\nThe description of an annotation store version. \n
" } }, - "description": { - "target": "com.amazonaws.omics#ReadSetDescription", + "versionOptions": { + "target": "com.amazonaws.omics#VersionOptions", "traits": { - "smithy.api#documentation": "\n The description of the read set.\n
" + "smithy.api#documentation": "\nThe options for an annotation store version. \n
" } }, "tags": { "target": "com.amazonaws.omics#TagMap", "traits": { - "smithy.api#documentation": "\n Any tags to add to the read set.\n
" + "smithy.api#documentation": "\nAny tags added to annotation store version. \n
" } } }, @@ -1280,34 +1468,210 @@ "smithy.api#input": {} } }, - "com.amazonaws.omics#CreateMultipartReadSetUploadResponse": { + "com.amazonaws.omics#CreateAnnotationStoreVersionResponse": { "type": "structure", "members": { - "sequenceStoreId": { - "target": "com.amazonaws.omics#SequenceStoreId", + "id": { + "target": "com.amazonaws.omics#ResourceId", "traits": { - "smithy.api#documentation": "\n The sequence store ID for the store that the read set will be created in.\n
", + "smithy.api#documentation": "\nA generated ID for the annotation store \n
", "smithy.api#required": {} } }, - "uploadId": { - "target": "com.amazonaws.omics#UploadId", + "versionName": { + "target": "com.amazonaws.omics#VersionName", "traits": { - "smithy.api#documentation": "\n he ID for the initiated multipart upload.\n
", + "smithy.api#documentation": "\nThe name given to an annotation store version to distinguish it from other versions. \n
", "smithy.api#required": {} } }, - "sourceFileType": { - "target": "com.amazonaws.omics#FileType", + "storeId": { + "target": "com.amazonaws.omics#ResourceId", "traits": { - "smithy.api#documentation": "\n The file type of the read set source.\n
", + "smithy.api#documentation": "\nThe ID for the annotation store from which new versions are being created. \n
", "smithy.api#required": {} } }, - "subjectId": { - "target": "com.amazonaws.omics#SubjectId", + "versionOptions": { + "target": "com.amazonaws.omics#VersionOptions", "traits": { - "smithy.api#documentation": "\n The source's subject ID.\n
", + "smithy.api#documentation": "\nThe options for an annotation store version. \n
" + } + }, + "name": { + "target": "com.amazonaws.omics#StoreName", + "traits": { + "smithy.api#documentation": "\nThe name given to an annotation store version to distinguish it from other versions. \n
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.omics#VersionStatus", + "traits": { + "smithy.api#documentation": "\nThe status of a annotation store version. \n
", + "smithy.api#required": {} + } + }, + "creationTime": { + "target": "com.amazonaws.omics#CreationTime", + "traits": { + "smithy.api#documentation": "\nThe time stamp for the creation of an annotation store version. \n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.omics#CreateMultipartReadSetUpload": { + "type": "operation", + "input": { + "target": "com.amazonaws.omics#CreateMultipartReadSetUploadRequest" + }, + "output": { + "target": "com.amazonaws.omics#CreateMultipartReadSetUploadResponse" + }, + "errors": [ + { + "target": "com.amazonaws.omics#AccessDeniedException" + }, + { + "target": "com.amazonaws.omics#InternalServerException" + }, + { + "target": "com.amazonaws.omics#NotSupportedOperationException" + }, + { + "target": "com.amazonaws.omics#RequestTimeoutException" + }, + { + "target": "com.amazonaws.omics#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.omics#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.omics#ThrottlingException" + }, + { + "target": "com.amazonaws.omics#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "\n Begins a multipart read set upload. \n
", + "smithy.api#endpoint": { + "hostPrefix": "control-storage-" + }, + "smithy.api#http": { + "method": "POST", + "uri": "/sequencestore/{sequenceStoreId}/upload" + } + } + }, + "com.amazonaws.omics#CreateMultipartReadSetUploadRequest": { + "type": "structure", + "members": { + "sequenceStoreId": { + "target": "com.amazonaws.omics#SequenceStoreId", + "traits": { + "smithy.api#documentation": "\n The sequence store ID for the store that is the destination of the multipart uploads.\n
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.omics#ClientToken", + "traits": { + "smithy.api#documentation": "\n An idempotency token that can be used to avoid triggering multiple multipart uploads.\n
" + } + }, + "sourceFileType": { + "target": "com.amazonaws.omics#FileType", + "traits": { + "smithy.api#documentation": "\n The type of file being uploaded.\n
", + "smithy.api#required": {} + } + }, + "subjectId": { + "target": "com.amazonaws.omics#SubjectId", + "traits": { + "smithy.api#documentation": "\n The source's subject ID.\n
", + "smithy.api#required": {} + } + }, + "sampleId": { + "target": "com.amazonaws.omics#SampleId", + "traits": { + "smithy.api#documentation": "\n The source's sample ID.\n
", + "smithy.api#required": {} + } + }, + "generatedFrom": { + "target": "com.amazonaws.omics#GeneratedFrom", + "traits": { + "smithy.api#documentation": "\n Where the source originated.\n
" + } + }, + "referenceArn": { + "target": "com.amazonaws.omics#ReferenceArn", + "traits": { + "smithy.api#documentation": "\n The ARN of the reference.\n
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.omics#ReadSetName", + "traits": { + "smithy.api#documentation": "\n The name of the read set.\n
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.omics#ReadSetDescription", + "traits": { + "smithy.api#documentation": "\n The description of the read set.\n
" + } + }, + "tags": { + "target": "com.amazonaws.omics#TagMap", + "traits": { + "smithy.api#documentation": "\n Any tags to add to the read set.\n
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.omics#CreateMultipartReadSetUploadResponse": { + "type": "structure", + "members": { + "sequenceStoreId": { + "target": "com.amazonaws.omics#SequenceStoreId", + "traits": { + "smithy.api#documentation": "\n The sequence store ID for the store that the read set will be created in.\n
", + "smithy.api#required": {} + } + }, + "uploadId": { + "target": "com.amazonaws.omics#UploadId", + "traits": { + "smithy.api#documentation": "\n he ID for the initiated multipart upload.\n
", + "smithy.api#required": {} + } + }, + "sourceFileType": { + "target": "com.amazonaws.omics#FileType", + "traits": { + "smithy.api#documentation": "\n The file type of the read set source.\n
", + "smithy.api#required": {} + } + }, + "subjectId": { + "target": "com.amazonaws.omics#SubjectId", + "traits": { + "smithy.api#documentation": "\n The source's subject ID.\n
", "smithy.api#required": {} } }, @@ -1768,6 +2132,103 @@ "smithy.api#output": {} } }, + "com.amazonaws.omics#CreateShare": { + "type": "operation", + "input": { + "target": "com.amazonaws.omics#CreateShareRequest" + }, + "output": { + "target": "com.amazonaws.omics#CreateShareResponse" + }, + "errors": [ + { + "target": "com.amazonaws.omics#AccessDeniedException" + }, + { + "target": "com.amazonaws.omics#ConflictException" + }, + { + "target": "com.amazonaws.omics#InternalServerException" + }, + { + "target": "com.amazonaws.omics#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.omics#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.omics#ThrottlingException" + }, + { + "target": "com.amazonaws.omics#ValidationException" + } + ], + "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#endpoint": { + "hostPrefix": "analytics-" + }, + "smithy.api#http": { + "method": "POST", + "uri": "/share", + "code": 200 + } + } + }, + "com.amazonaws.omics#CreateShareRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "\n The resource ARN for the analytics store to be shared.\n
", + "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#required": {} + } + }, + "shareName": { + "target": "com.amazonaws.omics#ShareName", + "traits": { + "smithy.api#documentation": "\n A name given to the share. \n
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.omics#CreateShareResponse": { + "type": "structure", + "members": { + "shareId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "\n An ID generated for the share. \n
" + } + }, + "status": { + "target": "com.amazonaws.omics#ShareStatus", + "traits": { + "smithy.api#documentation": "\n The status of a share. \n
" + } + }, + "shareName": { + "target": "com.amazonaws.omics#ShareName", + "traits": { + "smithy.api#documentation": "\n A name given to the share. \n
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.omics#CreateVariantStore": { "type": "operation", "input": { @@ -1822,14 +2283,13 @@ } }, "name": { - "target": "smithy.api#String", + "target": "com.amazonaws.omics#StoreName", "traits": { - "smithy.api#documentation": "A name for the store.
", - "smithy.api#pattern": "^([a-z]){1}([a-z0-9_]){2,254}$" + "smithy.api#documentation": "A name for the store.
" } }, "description": { - "target": "com.amazonaws.omics#StoreDescription", + "target": "com.amazonaws.omics#Description", "traits": { "smithy.api#documentation": "A description for the store.
" } @@ -2153,13 +2613,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.omics#DeleteReference": { + "com.amazonaws.omics#DeleteAnnotationStoreVersions": { "type": "operation", "input": { - "target": "com.amazonaws.omics#DeleteReferenceRequest" + "target": "com.amazonaws.omics#DeleteAnnotationStoreVersionsRequest" }, "output": { - "target": "com.amazonaws.omics#DeleteReferenceResponse" + "target": "com.amazonaws.omics#DeleteAnnotationStoreVersionsResponse" }, "errors": [ { @@ -2172,7 +2632,93 @@ "target": "com.amazonaws.omics#InternalServerException" }, { - "target": "com.amazonaws.omics#RequestTimeoutException" + "target": "com.amazonaws.omics#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.omics#ThrottlingException" + }, + { + "target": "com.amazonaws.omics#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "\nDeletes one or multiple versions of an annotation store. \n
", + "smithy.api#endpoint": { + "hostPrefix": "analytics-" + }, + "smithy.api#http": { + "method": "POST", + "uri": "/annotationStore/{name}/versions/delete", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.omics#DeleteAnnotationStoreVersionsRequest": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "\nThe name of the annotation store from which versions are being deleted. \n
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "versions": { + "target": "com.amazonaws.omics#VersionList", + "traits": { + "smithy.api#documentation": "\nThe versions of an annotation store to be deleted. \n
", + "smithy.api#required": {} + } + }, + "force": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "\nForces the deletion of an annotation store version when imports are in-progress.. \n
", + "smithy.api#httpQuery": "force" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.omics#DeleteAnnotationStoreVersionsResponse": { + "type": "structure", + "members": { + "errors": { + "target": "com.amazonaws.omics#VersionDeleteErrorList", + "traits": { + "smithy.api#documentation": "\nAny errors that occur when attempting to delete an annotation store version. \n
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.omics#DeleteReference": { + "type": "operation", + "input": { + "target": "com.amazonaws.omics#DeleteReferenceRequest" + }, + "output": { + "target": "com.amazonaws.omics#DeleteReferenceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.omics#AccessDeniedException" + }, + { + "target": "com.amazonaws.omics#ConflictException" + }, + { + "target": "com.amazonaws.omics#InternalServerException" + }, + { + "target": "com.amazonaws.omics#RequestTimeoutException" }, { "target": "com.amazonaws.omics#ResourceNotFoundException" @@ -2488,6 +3034,80 @@ "smithy.api#output": {} } }, + "com.amazonaws.omics#DeleteShare": { + "type": "operation", + "input": { + "target": "com.amazonaws.omics#DeleteShareRequest" + }, + "output": { + "target": "com.amazonaws.omics#DeleteShareResponse" + }, + "errors": [ + { + "target": "com.amazonaws.omics#AccessDeniedException" + }, + { + "target": "com.amazonaws.omics#ConflictException" + }, + { + "target": "com.amazonaws.omics#InternalServerException" + }, + { + "target": "com.amazonaws.omics#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.omics#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.omics#ThrottlingException" + }, + { + "target": "com.amazonaws.omics#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "\n Deletes a share of an analytics store. \n
", + "smithy.api#endpoint": { + "hostPrefix": "analytics-" + }, + "smithy.api#http": { + "method": "DELETE", + "uri": "/share/{shareId}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.omics#DeleteShareRequest": { + "type": "structure", + "members": { + "shareId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "\n The ID for the share request to be deleted. \n
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.omics#DeleteShareResponse": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.omics#ShareStatus", + "traits": { + "smithy.api#documentation": "\n The status of the share being deleted. \n
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.omics#DeleteVariantStore": { "type": "operation", "input": { @@ -2631,6 +3251,15 @@ "smithy.api#input": {} } }, + "com.amazonaws.omics#Description": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 500 + } + } + }, "com.amazonaws.omics#Encoding": { "type": "string", "traits": { @@ -2874,6 +3503,26 @@ ] } }, + "com.amazonaws.omics#Filter": { + "type": "structure", + "members": { + "resourceArns": { + "target": "com.amazonaws.omics#ArnList", + "traits": { + "smithy.api#documentation": "\nThe Amazon Resource Number (Arn) for an analytics store. \n
" + } + }, + "status": { + "target": "com.amazonaws.omics#StatusList", + "traits": { + "smithy.api#documentation": "\nThe status of an annotation store version. \n
" + } + } + }, + "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
" + } + }, "com.amazonaws.omics#FormatOptions": { "type": "union", "members": { @@ -3080,6 +3729,13 @@ "smithy.api#required": {} } }, + "versionName": { + "target": "com.amazonaws.omics#VersionName", + "traits": { + "smithy.api#documentation": "\nThe name of the annotation store version. \n
", + "smithy.api#required": {} + } + }, "roleArn": { "target": "com.amazonaws.omics#Arn", "traits": { @@ -3132,21 +3788,268 @@ "runLeftNormalization": { "target": "com.amazonaws.omics#RunLeftNormalization", "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "The job's left normalization setting.
", + "smithy.api#default": false, + "smithy.api#documentation": "The job's left normalization setting.
", + "smithy.api#required": {} + } + }, + "formatOptions": { + "target": "com.amazonaws.omics#FormatOptions", + "traits": { + "smithy.api#required": {} + } + }, + "annotationFields": { + "target": "com.amazonaws.omics#AnnotationFieldMap", + "traits": { + "smithy.api#documentation": "\n The annotation schema generated by the parsed annotation data.\n
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.omics#GetAnnotationStore": { + "type": "operation", + "input": { + "target": "com.amazonaws.omics#GetAnnotationStoreRequest" + }, + "output": { + "target": "com.amazonaws.omics#GetAnnotationStoreResponse" + }, + "errors": [ + { + "target": "com.amazonaws.omics#AccessDeniedException" + }, + { + "target": "com.amazonaws.omics#InternalServerException" + }, + { + "target": "com.amazonaws.omics#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.omics#ThrottlingException" + }, + { + "target": "com.amazonaws.omics#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets information about an annotation store.
", + "smithy.api#endpoint": { + "hostPrefix": "analytics-" + }, + "smithy.api#http": { + "method": "GET", + "uri": "/annotationStore/{name}", + "code": 200 + }, + "smithy.api#readonly": {}, + "smithy.waiters#waitable": { + "AnnotationStoreCreated": { + "documentation": "Wait until an annotation store is created", + "minDelay": 30, + "maxDelay": 600, + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "status", + "expected": "ACTIVE", + "comparator": "stringEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "output": { + "path": "status", + "expected": "CREATING", + "comparator": "stringEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "output": { + "path": "status", + "expected": "UPDATING", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "status", + "expected": "FAILED", + "comparator": "stringEquals" + } + } + } + ] + }, + "AnnotationStoreDeleted": { + "documentation": "Wait until an annotation store is deleted.", + "minDelay": 30, + "maxDelay": 600, + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "status", + "expected": "DELETED", + "comparator": "stringEquals" + } + } + }, + { + "state": "success", + "matcher": { + "errorType": "ResourceNotFoundException" + } + }, + { + "state": "retry", + "matcher": { + "output": { + "path": "status", + "expected": "DELETING", + "comparator": "stringEquals" + } + } + } + ] + } + } + } + }, + "com.amazonaws.omics#GetAnnotationStoreRequest": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The store's name.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.omics#GetAnnotationStoreResponse": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.omics#ResourceId", + "traits": { + "smithy.api#documentation": "The store's ID.
", + "smithy.api#required": {} + } + }, + "reference": { + "target": "com.amazonaws.omics#ReferenceItem", + "traits": { + "smithy.api#documentation": "The store's genome reference.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.omics#StoreStatus", + "traits": { + "smithy.api#documentation": "The store's status.
", + "smithy.api#required": {} + } + }, + "storeArn": { + "target": "com.amazonaws.omics#Arn", + "traits": { + "smithy.api#documentation": "The store's ARN.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The store's name.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.omics#Description", + "traits": { + "smithy.api#documentation": "The store's description.
", + "smithy.api#required": {} + } + }, + "sseConfig": { + "target": "com.amazonaws.omics#SseConfig", + "traits": { + "smithy.api#documentation": "The store's server-side encryption (SSE) settings.
", + "smithy.api#required": {} + } + }, + "creationTime": { + "target": "com.amazonaws.omics#CreationTime", + "traits": { + "smithy.api#documentation": "When the store was created.
", + "smithy.api#required": {} + } + }, + "updateTime": { + "target": "com.amazonaws.omics#UpdateTime", + "traits": { + "smithy.api#documentation": "When the store was updated.
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.omics#TagMap", + "traits": { + "smithy.api#documentation": "The store's tags.
", + "smithy.api#required": {} + } + }, + "storeOptions": { + "target": "com.amazonaws.omics#StoreOptions", + "traits": { + "smithy.api#documentation": "The store's parsing options.
" + } + }, + "storeFormat": { + "target": "com.amazonaws.omics#StoreFormat", + "traits": { + "smithy.api#documentation": "The store's annotation file format.
" + } + }, + "statusMessage": { + "target": "com.amazonaws.omics#StatusMessage", + "traits": { + "smithy.api#documentation": "A status message.
", "smithy.api#required": {} } }, - "formatOptions": { - "target": "com.amazonaws.omics#FormatOptions", + "storeSizeBytes": { + "target": "smithy.api#Long", "traits": { + "smithy.api#documentation": "The store's size in bytes.
", "smithy.api#required": {} } }, - "annotationFields": { - "target": "com.amazonaws.omics#AnnotationFieldMap", + "numVersions": { + "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "\n The annotation schema generated by the parsed annotation data.\n
" + "smithy.api#documentation": "\nAn integer indicating how many versions of an annotation store exist. \n
", + "smithy.api#required": {} } } }, @@ -3154,13 +4057,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.omics#GetAnnotationStore": { + "com.amazonaws.omics#GetAnnotationStoreVersion": { "type": "operation", "input": { - "target": "com.amazonaws.omics#GetAnnotationStoreRequest" + "target": "com.amazonaws.omics#GetAnnotationStoreVersionRequest" }, "output": { - "target": "com.amazonaws.omics#GetAnnotationStoreResponse" + "target": "com.amazonaws.omics#GetAnnotationStoreVersionResponse" }, "errors": [ { @@ -3180,19 +4083,19 @@ } ], "traits": { - "smithy.api#documentation": "Gets information about an annotation store.
", + "smithy.api#documentation": "\nRetrieves the metadata for an annotation store version. \n
", "smithy.api#endpoint": { "hostPrefix": "analytics-" }, "smithy.api#http": { "method": "GET", - "uri": "/annotationStore/{name}", + "uri": "/annotationStore/{name}/version/{versionName}", "code": 200 }, "smithy.api#readonly": {}, "smithy.waiters#waitable": { - "AnnotationStoreCreated": { - "documentation": "Wait until an annotation store is created", + "AnnotationStoreVersionCreated": { + "documentation": "Wait until an annotation store version is created", "minDelay": 30, "maxDelay": 600, "acceptors": [ @@ -3238,8 +4141,8 @@ } ] }, - "AnnotationStoreDeleted": { - "documentation": "Wait until an annotation store is deleted.", + "AnnotationStoreVersionDeleted": { + "documentation": "Wait until an annotation store version is deleted.", "minDelay": 30, "maxDelay": 600, "acceptors": [ @@ -3274,13 +4177,21 @@ } } }, - "com.amazonaws.omics#GetAnnotationStoreRequest": { + "com.amazonaws.omics#GetAnnotationStoreVersionRequest": { "type": "structure", "members": { "name": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The store's name.
", + "smithy.api#documentation": "\nThe name given to an annotation store version to distinguish it from others. \n
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "versionName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "\nThe name given to an annotation store version to distinguish it from others. \n
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3290,102 +4201,96 @@ "smithy.api#input": {} } }, - "com.amazonaws.omics#GetAnnotationStoreResponse": { + "com.amazonaws.omics#GetAnnotationStoreVersionResponse": { "type": "structure", "members": { - "id": { + "storeId": { "target": "com.amazonaws.omics#ResourceId", "traits": { - "smithy.api#documentation": "The store's ID.
", + "smithy.api#documentation": "\nThe store ID for annotation store version.\n
", "smithy.api#required": {} } }, - "reference": { - "target": "com.amazonaws.omics#ReferenceItem", + "id": { + "target": "com.amazonaws.omics#ResourceId", "traits": { - "smithy.api#documentation": "The store's genome reference.
", + "smithy.api#documentation": "\nThe annotation store version ID.\n
", "smithy.api#required": {} } }, "status": { - "target": "com.amazonaws.omics#StoreStatus", + "target": "com.amazonaws.omics#VersionStatus", "traits": { - "smithy.api#documentation": "The store's status.
", + "smithy.api#documentation": "\nThe status of an annotation store version. \n
", "smithy.api#required": {} } }, - "storeArn": { + "versionArn": { "target": "com.amazonaws.omics#Arn", "traits": { - "smithy.api#documentation": "The store's ARN.
", + "smithy.api#documentation": "\nThe Arn for the annotation store. \n
", "smithy.api#required": {} } }, "name": { - "target": "smithy.api#String", + "target": "com.amazonaws.omics#StoreName", "traits": { - "smithy.api#documentation": "The store's name.
", + "smithy.api#documentation": "\nThe name of the annotation store. \n
", "smithy.api#required": {} } }, - "description": { - "target": "com.amazonaws.omics#StoreDescription", + "versionName": { + "target": "com.amazonaws.omics#VersionName", "traits": { - "smithy.api#documentation": "The store's description.
", + "smithy.api#documentation": "\nThe name given to an annotation store version to distinguish it from others. \n
", "smithy.api#required": {} } }, - "sseConfig": { - "target": "com.amazonaws.omics#SseConfig", + "description": { + "target": "com.amazonaws.omics#Description", "traits": { - "smithy.api#documentation": "The store's server-side encryption (SSE) settings.
", + "smithy.api#documentation": "\nThe description for an annotation store version. \n
", "smithy.api#required": {} } }, "creationTime": { "target": "com.amazonaws.omics#CreationTime", "traits": { - "smithy.api#documentation": "When the store was created.
", + "smithy.api#documentation": "\nThe time stamp for when an annotation store version was created. \n
", "smithy.api#required": {} } }, "updateTime": { "target": "com.amazonaws.omics#UpdateTime", "traits": { - "smithy.api#documentation": "When the store was updated.
", + "smithy.api#documentation": "\nThe time stamp for when an annotation store version was updated. \n
", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.omics#TagMap", "traits": { - "smithy.api#documentation": "The store's tags.
", + "smithy.api#documentation": "\nAny tags associated with an annotation store version. \n
", "smithy.api#required": {} } }, - "storeOptions": { - "target": "com.amazonaws.omics#StoreOptions", - "traits": { - "smithy.api#documentation": "The store's parsing options.
" - } - }, - "storeFormat": { - "target": "com.amazonaws.omics#StoreFormat", + "versionOptions": { + "target": "com.amazonaws.omics#VersionOptions", "traits": { - "smithy.api#documentation": "The store's annotation file format.
" + "smithy.api#documentation": "\nThe options for an annotation store version. \n
" } }, "statusMessage": { "target": "com.amazonaws.omics#StatusMessage", "traits": { - "smithy.api#documentation": "A status message.
", + "smithy.api#documentation": "\nThe status of an annotation store version.\n
", "smithy.api#required": {} } }, - "storeSizeBytes": { + "versionSizeBytes": { "target": "smithy.api#Long", "traits": { - "smithy.api#documentation": "The store's size in bytes.
", + "smithy.api#documentation": "\nThe size of the annotation store version in Bytes. \n
", "smithy.api#required": {} } } @@ -5739,6 +6644,80 @@ "smithy.api#output": {} } }, + "com.amazonaws.omics#GetShare": { + "type": "operation", + "input": { + "target": "com.amazonaws.omics#GetShareRequest" + }, + "output": { + "target": "com.amazonaws.omics#GetShareResponse" + }, + "errors": [ + { + "target": "com.amazonaws.omics#AccessDeniedException" + }, + { + "target": "com.amazonaws.omics#ConflictException" + }, + { + "target": "com.amazonaws.omics#InternalServerException" + }, + { + "target": "com.amazonaws.omics#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.omics#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.omics#ThrottlingException" + }, + { + "target": "com.amazonaws.omics#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "\n Retrieves the metadata for a share. \n
", + "smithy.api#endpoint": { + "hostPrefix": "analytics-" + }, + "smithy.api#http": { + "method": "GET", + "uri": "/share/{shareId}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.omics#GetShareRequest": { + "type": "structure", + "members": { + "shareId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "\n The generated ID for a share. \n
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.omics#GetShareResponse": { + "type": "structure", + "members": { + "share": { + "target": "com.amazonaws.omics#ShareDetails", + "traits": { + "smithy.api#documentation": "\n An analytic store share details object. contains status, resourceArn, ownerId, etc. \n
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.omics#GetVariantImportJob": { "type": "operation", "input": { @@ -6111,7 +7090,7 @@ } }, "description": { - "target": "com.amazonaws.omics#StoreDescription", + "target": "com.amazonaws.omics#Description", "traits": { "smithy.api#documentation": "The store's description.
", "smithy.api#required": {} @@ -6786,38 +7765,168 @@ "name": "COMPLETED_WITH_FAILURES", "documentation": "The Job completed with failed runs" } - ] - } - }, - "com.amazonaws.omics#JobStatusMessage": { - "type": "string", + ] + } + }, + "com.amazonaws.omics#JobStatusMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 127 + }, + "smithy.api#pattern": "^[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+$" + } + }, + "com.amazonaws.omics#JobStatusMsg": { + "type": "string" + }, + "com.amazonaws.omics#LineSep": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + } + } + }, + "com.amazonaws.omics#ListAnnotationImportJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.omics#ListAnnotationImportJobsRequest" + }, + "output": { + "target": "com.amazonaws.omics#ListAnnotationImportJobsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.omics#AccessDeniedException" + }, + { + "target": "com.amazonaws.omics#InternalServerException" + }, + { + "target": "com.amazonaws.omics#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.omics#ThrottlingException" + }, + { + "target": "com.amazonaws.omics#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves a list of annotation import jobs.
", + "smithy.api#endpoint": { + "hostPrefix": "analytics-" + }, + "smithy.api#http": { + "method": "POST", + "uri": "/import/annotations", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "annotationImportJobs" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.omics#ListAnnotationImportJobsFilter": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.omics#JobStatus", + "traits": { + "smithy.api#documentation": "A status to filter on.
" + } + }, + "storeName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A store name to filter on.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A filter for annotation import jobs.
" + } + }, + "com.amazonaws.omics#ListAnnotationImportJobsRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The maximum number of jobs to return in one page of results.
", + "smithy.api#httpQuery": "maxResults", + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "ids": { + "target": "com.amazonaws.omics#IdList", + "traits": { + "smithy.api#documentation": "IDs of annotation import jobs to retrieve.
", + "smithy.api#length": { + "min": 1, + "max": 20 + } + } + }, + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Specifies the pagination token from a previous request to retrieve the next page of results.
", + "smithy.api#httpQuery": "nextToken", + "smithy.api#length": { + "min": 1, + "max": 10000 + } + } + }, + "filter": { + "target": "com.amazonaws.omics#ListAnnotationImportJobsFilter", + "traits": { + "smithy.api#documentation": "A filter to apply to the list.
" + } + } + }, "traits": { - "smithy.api#length": { - "min": 1, - "max": 127 - }, - "smithy.api#pattern": "^[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+$" + "smithy.api#input": {} } }, - "com.amazonaws.omics#JobStatusMsg": { - "type": "string" - }, - "com.amazonaws.omics#LineSep": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 20 + "com.amazonaws.omics#ListAnnotationImportJobsResponse": { + "type": "structure", + "members": { + "annotationImportJobs": { + "target": "com.amazonaws.omics#AnnotationImportJobItems", + "traits": { + "smithy.api#documentation": "A list of jobs.
" + } + }, + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Specifies the pagination token from a previous request to retrieve the next page of results.
" + } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.omics#ListAnnotationImportJobs": { + "com.amazonaws.omics#ListAnnotationStoreVersions": { "type": "operation", "input": { - "target": "com.amazonaws.omics#ListAnnotationImportJobsRequest" + "target": "com.amazonaws.omics#ListAnnotationStoreVersionsRequest" }, "output": { - "target": "com.amazonaws.omics#ListAnnotationImportJobsResponse" + "target": "com.amazonaws.omics#ListAnnotationStoreVersionsResponse" }, "errors": [ { @@ -6837,51 +7946,53 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves a list of annotation import jobs.
", + "smithy.api#documentation": "\nLists the versions of an annotation store. \n
", "smithy.api#endpoint": { "hostPrefix": "analytics-" }, "smithy.api#http": { "method": "POST", - "uri": "/import/annotations", + "uri": "/annotationStore/{name}/versions", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", - "items": "annotationImportJobs" + "items": "annotationStoreVersions" }, "smithy.api#readonly": {} } }, - "com.amazonaws.omics#ListAnnotationImportJobsFilter": { + "com.amazonaws.omics#ListAnnotationStoreVersionsFilter": { "type": "structure", "members": { "status": { - "target": "com.amazonaws.omics#JobStatus", - "traits": { - "smithy.api#documentation": "A status to filter on.
" - } - }, - "storeName": { - "target": "smithy.api#String", + "target": "com.amazonaws.omics#VersionStatus", "traits": { - "smithy.api#documentation": "A store name to filter on.
" + "smithy.api#documentation": "\nThe status of an annotation store version. \n
" } } }, "traits": { - "smithy.api#documentation": "A filter for annotation import jobs.
" + "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
" } }, - "com.amazonaws.omics#ListAnnotationImportJobsRequest": { + "com.amazonaws.omics#ListAnnotationStoreVersionsRequest": { "type": "structure", "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "\nThe name of an annotation store. \n
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "maxResults": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "The maximum number of jobs to return in one page of results.
", + "smithy.api#documentation": "\nThe maximum number of annotation store versions to return in one page of results.\n
", "smithy.api#httpQuery": "maxResults", "smithy.api#range": { "min": 1, @@ -6889,20 +8000,10 @@ } } }, - "ids": { - "target": "com.amazonaws.omics#IdList", - "traits": { - "smithy.api#documentation": "IDs of annotation import jobs to retrieve.
", - "smithy.api#length": { - "min": 1, - "max": 20 - } - } - }, "nextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Specifies the pagination token from a previous request to retrieve the next page of results.
", + "smithy.api#documentation": "\nSpecifies the pagination token from a previous request to retrieve the next page of results.\n
", "smithy.api#httpQuery": "nextToken", "smithy.api#length": { "min": 1, @@ -6911,9 +8012,9 @@ } }, "filter": { - "target": "com.amazonaws.omics#ListAnnotationImportJobsFilter", + "target": "com.amazonaws.omics#ListAnnotationStoreVersionsFilter", "traits": { - "smithy.api#documentation": "A filter to apply to the list.
" + "smithy.api#documentation": "\nA filter to apply to the list of annotation store versions.\n
" } } }, @@ -6921,19 +8022,19 @@ "smithy.api#input": {} } }, - "com.amazonaws.omics#ListAnnotationImportJobsResponse": { + "com.amazonaws.omics#ListAnnotationStoreVersionsResponse": { "type": "structure", "members": { - "annotationImportJobs": { - "target": "com.amazonaws.omics#AnnotationImportJobItems", + "annotationStoreVersions": { + "target": "com.amazonaws.omics#AnnotationStoreVersionItems", "traits": { - "smithy.api#documentation": "A list of jobs.
" + "smithy.api#documentation": "\nLists all versions of an annotation store.\n
" } }, "nextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Specifies the pagination token from a previous request to retrieve the next page of results.
" + "smithy.api#documentation": "\nSpecifies the pagination token from a previous request to retrieve the next page of results.\n
" } } }, @@ -8468,6 +9569,112 @@ "smithy.api#output": {} } }, + "com.amazonaws.omics#ListShares": { + "type": "operation", + "input": { + "target": "com.amazonaws.omics#ListSharesRequest" + }, + "output": { + "target": "com.amazonaws.omics#ListSharesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.omics#AccessDeniedException" + }, + { + "target": "com.amazonaws.omics#ConflictException" + }, + { + "target": "com.amazonaws.omics#InternalServerException" + }, + { + "target": "com.amazonaws.omics#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.omics#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.omics#ThrottlingException" + }, + { + "target": "com.amazonaws.omics#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "\n Lists all shares associated with an account. \n
", + "smithy.api#endpoint": { + "hostPrefix": "analytics-" + }, + "smithy.api#http": { + "method": "POST", + "uri": "/shares", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "shares" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.omics#ListSharesRequest": { + "type": "structure", + "members": { + "resourceOwner": { + "target": "com.amazonaws.omics#ResourceOwner", + "traits": { + "smithy.api#documentation": "\n The account that owns the analytics store shared. \n
", + "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
" + } + }, + "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#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#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.omics#ListSharesResponse": { + "type": "structure", + "members": { + "shares": { + "target": "com.amazonaws.omics#ShareDetailsList", + "traits": { + "smithy.api#documentation": "\n The shares available and their meta details. \n
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "\nNext token returned in the response of a previous ListSharesResponse call. Used to get the next page of results.\n
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.omics#ListTagsForResource": { "type": "operation", "input": { @@ -9048,6 +10255,9 @@ { "target": "com.amazonaws.omics#AnnotationStore" }, + { + "target": "com.amazonaws.omics#AnnotationStoreVersion" + }, { "target": "com.amazonaws.omics#ReferenceStoreResource" }, @@ -9060,6 +10270,9 @@ { "target": "com.amazonaws.omics#SequenceStoreResource" }, + { + "target": "com.amazonaws.omics#Share" + }, { "target": "com.amazonaws.omics#TaggingResource" }, @@ -11085,6 +12298,23 @@ "smithy.api#httpError": 404 } }, + "com.amazonaws.omics#ResourceOwner": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SELF", + "name": "SELF", + "documentation": "The resource owner is the calling account" + }, + { + "value": "OTHER", + "name": "OTHER", + "documentation": "The resource owner is an account other than the caller" + } + ] + } + }, "com.amazonaws.omics#RoleArn": { "type": "string", "traits": { @@ -11961,9 +13191,147 @@ } }, "traits": { - "smithy.api#documentation": "The request exceeds a service quota.
", - "smithy.api#error": "client", - "smithy.api#httpError": 402 + "smithy.api#documentation": "The request exceeds a service quota.
", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.omics#Share": { + "type": "resource", + "identifiers": { + "shareId": { + "target": "smithy.api#String" + } + }, + "create": { + "target": "com.amazonaws.omics#CreateShare" + }, + "read": { + "target": "com.amazonaws.omics#GetShare" + }, + "update": { + "target": "com.amazonaws.omics#AcceptShare" + }, + "delete": { + "target": "com.amazonaws.omics#DeleteShare" + }, + "list": { + "target": "com.amazonaws.omics#ListShares" + } + }, + "com.amazonaws.omics#ShareDetails": { + "type": "structure", + "members": { + "shareId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "\n The ID for a share offer for an analytics store .\n
" + } + }, + "resourceArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "\n The resource Arn of the analytics store being shared. \n
" + } + }, + "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
" + } + }, + "ownerId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "\n The account ID for the data owner. The owner creates the share offer. \n
" + } + }, + "status": { + "target": "com.amazonaws.omics#ShareStatus", + "traits": { + "smithy.api#documentation": "\n The status of a share. \n
" + } + }, + "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
" + } + }, + "shareName": { + "target": "com.amazonaws.omics#ShareName", + "traits": { + "smithy.api#documentation": "\n The name of the share. \n
" + } + }, + "creationTime": { + "target": "com.amazonaws.omics#CreationTime", + "traits": { + "smithy.api#documentation": "\n The timestamp for when the share was created. \n
" + } + }, + "updateTime": { + "target": "com.amazonaws.omics#UpdateTime", + "traits": { + "smithy.api#documentation": "\n The timestamp of the share update. \n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n The details of a share. \n
" + } + }, + "com.amazonaws.omics#ShareDetailsList": { + "type": "list", + "member": { + "target": "com.amazonaws.omics#ShareDetails" + } + }, + "com.amazonaws.omics#ShareName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_-]+$" + } + }, + "com.amazonaws.omics#ShareStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PENDING", + "name": "PENDING", + "documentation": "The share has been created but is not yet active" + }, + { + "value": "ACTIVATING", + "name": "ACTIVATING", + "documentation": "The share is activated" + }, + { + "value": "ACTIVE", + "name": "ACTIVE", + "documentation": "The share is active and can be used" + }, + { + "value": "DELETING", + "name": "DELETING", + "documentation": "The share is being deleted" + }, + { + "value": "DELETED", + "name": "DELETED", + "documentation": "The share has been deleted" + }, + { + "value": "FAILED", + "name": "FAILED", + "documentation": "The share has failed to activate or delete" + } + ] } }, "com.amazonaws.omics#SourceFiles": { @@ -12077,6 +13445,12 @@ "smithy.api#required": {} } }, + "versionName": { + "target": "com.amazonaws.omics#VersionName", + "traits": { + "smithy.api#documentation": "\nThe name of the annotation store version. \n
" + } + }, "formatOptions": { "target": "com.amazonaws.omics#FormatOptions", "traits": { @@ -13019,21 +14393,21 @@ "smithy.api#output": {} } }, - "com.amazonaws.omics#StatusMessage": { - "type": "string", + "com.amazonaws.omics#StatusList": { + "type": "list", + "member": { + "target": "com.amazonaws.omics#ShareStatus" + }, "traits": { - "smithy.api#length": { - "min": 0, - "max": 1000 - } + "smithy.api#uniqueItems": {} } }, - "com.amazonaws.omics#StoreDescription": { + "com.amazonaws.omics#StatusMessage": { "type": "string", "traits": { "smithy.api#length": { "min": 0, - "max": 500 + "max": 1000 } } }, @@ -13537,6 +14911,36 @@ "smithy.api#documentation": "File settings for a TSV store.
" } }, + "com.amazonaws.omics#TsvVersionOptions": { + "type": "structure", + "members": { + "annotationType": { + "target": "com.amazonaws.omics#AnnotationType", + "traits": { + "smithy.api#documentation": "\nThe store version's annotation type.\n
" + } + }, + "formatToHeader": { + "target": "com.amazonaws.omics#FormatToHeader", + "traits": { + "smithy.api#documentation": "\nThe annotation store version's header key to column name mapping.\n
" + } + }, + "schema": { + "target": "com.amazonaws.omics#Schema", + "traits": { + "smithy.api#documentation": "\nThe TSV schema for an annotation store version. \n
", + "smithy.api#length": { + "min": 1, + "max": 5000 + } + } + } + }, + "traits": { + "smithy.api#documentation": "\nThe options for a TSV file.\n
" + } + }, "com.amazonaws.omics#UntagResource": { "type": "operation", "input": { @@ -13664,7 +15068,7 @@ } }, "description": { - "target": "com.amazonaws.omics#StoreDescription", + "target": "com.amazonaws.omics#Description", "traits": { "smithy.api#documentation": "A description for the store.
" } @@ -13706,7 +15110,7 @@ } }, "description": { - "target": "com.amazonaws.omics#StoreDescription", + "target": "com.amazonaws.omics#Description", "traits": { "smithy.api#documentation": "The store's description.
", "smithy.api#required": {} @@ -13743,6 +15147,137 @@ "smithy.api#output": {} } }, + "com.amazonaws.omics#UpdateAnnotationStoreVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.omics#UpdateAnnotationStoreVersionRequest" + }, + "output": { + "target": "com.amazonaws.omics#UpdateAnnotationStoreVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.omics#AccessDeniedException" + }, + { + "target": "com.amazonaws.omics#InternalServerException" + }, + { + "target": "com.amazonaws.omics#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.omics#ThrottlingException" + }, + { + "target": "com.amazonaws.omics#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "\nUpdates the description of an annotation store version. \n
", + "smithy.api#endpoint": { + "hostPrefix": "analytics-" + }, + "smithy.api#http": { + "method": "POST", + "uri": "/annotationStore/{name}/version/{versionName}", + "code": 200 + } + } + }, + "com.amazonaws.omics#UpdateAnnotationStoreVersionRequest": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "\nThe name of an annotation store. \n
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "versionName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "\nThe name of an annotation store version. \n
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.omics#Description", + "traits": { + "smithy.api#documentation": "\nThe description of an annotation store. \n
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.omics#UpdateAnnotationStoreVersionResponse": { + "type": "structure", + "members": { + "storeId": { + "target": "com.amazonaws.omics#ResourceId", + "traits": { + "smithy.api#documentation": "\nThe annotation store ID. \n
", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.omics#ResourceId", + "traits": { + "smithy.api#documentation": "\nThe annotation store version ID.\n
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.omics#VersionStatus", + "traits": { + "smithy.api#documentation": "\nThe status of an annotation store version. \n
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.omics#StoreName", + "traits": { + "smithy.api#documentation": "\nThe name of an annotation store. \n
", + "smithy.api#required": {} + } + }, + "versionName": { + "target": "com.amazonaws.omics#VersionName", + "traits": { + "smithy.api#documentation": "\nThe name of an annotation store version.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.omics#Description", + "traits": { + "smithy.api#documentation": "\nThe description of an annotation store version.\n
", + "smithy.api#required": {} + } + }, + "creationTime": { + "target": "com.amazonaws.omics#CreationTime", + "traits": { + "smithy.api#documentation": "\nThe time stamp for when an annotation store version was created. \n
", + "smithy.api#required": {} + } + }, + "updateTime": { + "target": "com.amazonaws.omics#UpdateTime", + "traits": { + "smithy.api#documentation": "\nThe time stamp for when an annotation store version was updated. \n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.omics#UpdateRunGroup": { "type": "operation", "input": { @@ -13906,7 +15441,7 @@ } }, "description": { - "target": "com.amazonaws.omics#StoreDescription", + "target": "com.amazonaws.omics#Description", "traits": { "smithy.api#documentation": "A description for the store.
" } @@ -13948,7 +15483,7 @@ } }, "description": { - "target": "com.amazonaws.omics#StoreDescription", + "target": "com.amazonaws.omics#Description", "traits": { "smithy.api#documentation": "The store's description.
", "smithy.api#required": {} @@ -14408,7 +15943,7 @@ } }, "description": { - "target": "com.amazonaws.omics#StoreDescription", + "target": "com.amazonaws.omics#Description", "traits": { "smithy.api#documentation": "The store's description.
", "smithy.api#required": {} @@ -14480,6 +16015,102 @@ "smithy.api#documentation": "Formatting options for a VCF file.
" } }, + "com.amazonaws.omics#VersionDeleteError": { + "type": "structure", + "members": { + "versionName": { + "target": "com.amazonaws.omics#VersionName", + "traits": { + "smithy.api#documentation": "\nThe name given to an annotation store version.\n
", + "smithy.api#required": {} + } + }, + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "\nThe message explaining the error in annotation store deletion.\n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "\nThe error preventing deletion of the annotation store version. \n
" + } + }, + "com.amazonaws.omics#VersionDeleteErrorList": { + "type": "list", + "member": { + "target": "com.amazonaws.omics#VersionDeleteError" + } + }, + "com.amazonaws.omics#VersionList": { + "type": "list", + "member": { + "target": "com.amazonaws.omics#VersionName" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.omics#VersionName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 255 + }, + "smithy.api#pattern": "^([a-z]){1}([a-z0-9_]){2,254}$" + } + }, + "com.amazonaws.omics#VersionOptions": { + "type": "union", + "members": { + "tsvVersionOptions": { + "target": "com.amazonaws.omics#TsvVersionOptions", + "traits": { + "smithy.api#documentation": "\nFile settings for a version of a TSV store.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\nThe options for an annotation store version. \n
" + } + }, + "com.amazonaws.omics#VersionStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CREATING", + "name": "CREATING", + "documentation": "The Version is being created" + }, + { + "value": "UPDATING", + "name": "UPDATING", + "documentation": "The Version is updating" + }, + { + "value": "DELETING", + "name": "DELETING", + "documentation": "The Version is deleting" + }, + { + "value": "ACTIVE", + "name": "ACTIVE", + "documentation": "The Version is active" + }, + { + "value": "FAILED", + "name": "FAILED", + "documentation": "The Version creation failed" + } + ] + } + }, "com.amazonaws.omics#WorkflowArn": { "type": "string", "traits": {