Submits a request to cancel the trained model job.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CleanRoomsMLClient, CancelTrainedModelCommand } from "@aws-sdk/client-cleanroomsml"; // ES Modules import + * // const { CleanRoomsMLClient, CancelTrainedModelCommand } = require("@aws-sdk/client-cleanroomsml"); // CommonJS import + * const client = new CleanRoomsMLClient(config); + * const input = { // CancelTrainedModelRequest + * membershipIdentifier: "STRING_VALUE", // required + * trainedModelArn: "STRING_VALUE", // required + * }; + * const command = new CancelTrainedModelCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param CancelTrainedModelCommandInput - {@link CancelTrainedModelCommandInput} + * @returns {@link CancelTrainedModelCommandOutput} + * @see {@link CancelTrainedModelCommandInput} for command's `input` shape. + * @see {@link CancelTrainedModelCommandOutput} for command's `response` shape. + * @see {@link CleanRoomsMLClientResolvedConfig | config} for CleanRoomsMLClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You do not have sufficient access to perform this action.
+ * + * @throws {@link ConflictException} (client fault) + *You can't complete this action because another resource depends on this resource.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource you are requesting does not exist.
+ * + * @throws {@link ValidationException} (client fault) + *The request parameters for this request are incorrect.
+ * + * @throws {@link CleanRoomsMLServiceException} + *Base exception class for all service exceptions from CleanRoomsML service.
+ * + * @public + */ +export class CancelTrainedModelCommand extends $Command + .classBuilder< + CancelTrainedModelCommandInput, + CancelTrainedModelCommandOutput, + CleanRoomsMLClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: CleanRoomsMLClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AWSStarkControlService", "CancelTrainedModel", {}) + .n("CleanRoomsMLClient", "CancelTrainedModelCommand") + .f(void 0, void 0) + .ser(se_CancelTrainedModelCommand) + .de(de_CancelTrainedModelCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: CancelTrainedModelRequest; + output: {}; + }; + sdk: { + input: CancelTrainedModelCommandInput; + output: CancelTrainedModelCommandOutput; + }; + }; +} diff --git a/clients/client-cleanroomsml/src/commands/CancelTrainedModelInferenceJobCommand.ts b/clients/client-cleanroomsml/src/commands/CancelTrainedModelInferenceJobCommand.ts new file mode 100644 index 000000000000..c962c1f3b0bf --- /dev/null +++ b/clients/client-cleanroomsml/src/commands/CancelTrainedModelInferenceJobCommand.ts @@ -0,0 +1,106 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { CleanRoomsMLClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CleanRoomsMLClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { CancelTrainedModelInferenceJobRequest } from "../models/models_0"; +import { + de_CancelTrainedModelInferenceJobCommand, + se_CancelTrainedModelInferenceJobCommand, +} from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link CancelTrainedModelInferenceJobCommand}. + */ +export interface CancelTrainedModelInferenceJobCommandInput extends CancelTrainedModelInferenceJobRequest {} +/** + * @public + * + * The output of {@link CancelTrainedModelInferenceJobCommand}. + */ +export interface CancelTrainedModelInferenceJobCommandOutput extends __MetadataBearer {} + +/** + *Submits a request to cancel a trained model inference job.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CleanRoomsMLClient, CancelTrainedModelInferenceJobCommand } from "@aws-sdk/client-cleanroomsml"; // ES Modules import + * // const { CleanRoomsMLClient, CancelTrainedModelInferenceJobCommand } = require("@aws-sdk/client-cleanroomsml"); // CommonJS import + * const client = new CleanRoomsMLClient(config); + * const input = { // CancelTrainedModelInferenceJobRequest + * membershipIdentifier: "STRING_VALUE", // required + * trainedModelInferenceJobArn: "STRING_VALUE", // required + * }; + * const command = new CancelTrainedModelInferenceJobCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param CancelTrainedModelInferenceJobCommandInput - {@link CancelTrainedModelInferenceJobCommandInput} + * @returns {@link CancelTrainedModelInferenceJobCommandOutput} + * @see {@link CancelTrainedModelInferenceJobCommandInput} for command's `input` shape. + * @see {@link CancelTrainedModelInferenceJobCommandOutput} for command's `response` shape. + * @see {@link CleanRoomsMLClientResolvedConfig | config} for CleanRoomsMLClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You do not have sufficient access to perform this action.
+ * + * @throws {@link ConflictException} (client fault) + *You can't complete this action because another resource depends on this resource.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource you are requesting does not exist.
+ * + * @throws {@link ValidationException} (client fault) + *The request parameters for this request are incorrect.
+ * + * @throws {@link CleanRoomsMLServiceException} + *Base exception class for all service exceptions from CleanRoomsML service.
+ * + * @public + */ +export class CancelTrainedModelInferenceJobCommand extends $Command + .classBuilder< + CancelTrainedModelInferenceJobCommandInput, + CancelTrainedModelInferenceJobCommandOutput, + CleanRoomsMLClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: CleanRoomsMLClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AWSStarkControlService", "CancelTrainedModelInferenceJob", {}) + .n("CleanRoomsMLClient", "CancelTrainedModelInferenceJobCommand") + .f(void 0, void 0) + .ser(se_CancelTrainedModelInferenceJobCommand) + .de(de_CancelTrainedModelInferenceJobCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: CancelTrainedModelInferenceJobRequest; + output: {}; + }; + sdk: { + input: CancelTrainedModelInferenceJobCommandInput; + output: CancelTrainedModelInferenceJobCommandOutput; + }; + }; +} diff --git a/clients/client-cleanroomsml/src/commands/CreateConfiguredModelAlgorithmAssociationCommand.ts b/clients/client-cleanroomsml/src/commands/CreateConfiguredModelAlgorithmAssociationCommand.ts new file mode 100644 index 000000000000..852860609723 --- /dev/null +++ b/clients/client-cleanroomsml/src/commands/CreateConfiguredModelAlgorithmAssociationCommand.ts @@ -0,0 +1,162 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { CleanRoomsMLClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CleanRoomsMLClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { + CreateConfiguredModelAlgorithmAssociationRequest, + CreateConfiguredModelAlgorithmAssociationResponse, +} from "../models/models_0"; +import { + de_CreateConfiguredModelAlgorithmAssociationCommand, + se_CreateConfiguredModelAlgorithmAssociationCommand, +} from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link CreateConfiguredModelAlgorithmAssociationCommand}. + */ +export interface CreateConfiguredModelAlgorithmAssociationCommandInput + extends CreateConfiguredModelAlgorithmAssociationRequest {} +/** + * @public + * + * The output of {@link CreateConfiguredModelAlgorithmAssociationCommand}. + */ +export interface CreateConfiguredModelAlgorithmAssociationCommandOutput + extends CreateConfiguredModelAlgorithmAssociationResponse, + __MetadataBearer {} + +/** + *Associates a configured model algorithm to a collaboration for use by any member of the collaboration.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CleanRoomsMLClient, CreateConfiguredModelAlgorithmAssociationCommand } from "@aws-sdk/client-cleanroomsml"; // ES Modules import + * // const { CleanRoomsMLClient, CreateConfiguredModelAlgorithmAssociationCommand } = require("@aws-sdk/client-cleanroomsml"); // CommonJS import + * const client = new CleanRoomsMLClient(config); + * const input = { // CreateConfiguredModelAlgorithmAssociationRequest + * membershipIdentifier: "STRING_VALUE", // required + * configuredModelAlgorithmArn: "STRING_VALUE", // required + * name: "STRING_VALUE", // required + * description: "STRING_VALUE", + * privacyConfiguration: { // PrivacyConfiguration + * policies: { // PrivacyConfigurationPolicies + * trainedModels: { // TrainedModelsConfigurationPolicy + * containerLogs: [ // LogsConfigurationPolicyList + * { // LogsConfigurationPolicy + * allowedAccountIds: [ // AccountIdList // required + * "STRING_VALUE", + * ], + * filterPattern: "STRING_VALUE", + * }, + * ], + * containerMetrics: { // MetricsConfigurationPolicy + * noiseLevel: "HIGH" || "MEDIUM" || "LOW" || "NONE", // required + * }, + * }, + * trainedModelExports: { // TrainedModelExportsConfigurationPolicy + * maxSize: { // TrainedModelExportsMaxSize + * unit: "GB", // required + * value: Number("double"), // required + * }, + * filesToExport: [ // TrainedModelExportFileTypeList // required + * "MODEL" || "OUTPUT", + * ], + * }, + * trainedModelInferenceJobs: { // TrainedModelInferenceJobsConfigurationPolicy + * containerLogs: [ + * { + * allowedAccountIds: [ // required + * "STRING_VALUE", + * ], + * filterPattern: "STRING_VALUE", + * }, + * ], + * maxOutputSize: { // TrainedModelInferenceMaxOutputSize + * unit: "GB", // required + * value: Number("double"), // required + * }, + * }, + * }, + * }, + * tags: { // TagMap + * "You do not have sufficient access to perform this action.
+ * + * @throws {@link ConflictException} (client fault) + *You can't complete this action because another resource depends on this resource.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource you are requesting does not exist.
+ * + * @throws {@link ServiceQuotaExceededException} (client fault) + *You have exceeded your service quota.
+ * + * @throws {@link ValidationException} (client fault) + *The request parameters for this request are incorrect.
+ * + * @throws {@link CleanRoomsMLServiceException} + *Base exception class for all service exceptions from CleanRoomsML service.
+ * + * @public + */ +export class CreateConfiguredModelAlgorithmAssociationCommand extends $Command + .classBuilder< + CreateConfiguredModelAlgorithmAssociationCommandInput, + CreateConfiguredModelAlgorithmAssociationCommandOutput, + CleanRoomsMLClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: CleanRoomsMLClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AWSStarkControlService", "CreateConfiguredModelAlgorithmAssociation", {}) + .n("CleanRoomsMLClient", "CreateConfiguredModelAlgorithmAssociationCommand") + .f(void 0, void 0) + .ser(se_CreateConfiguredModelAlgorithmAssociationCommand) + .de(de_CreateConfiguredModelAlgorithmAssociationCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: CreateConfiguredModelAlgorithmAssociationRequest; + output: CreateConfiguredModelAlgorithmAssociationResponse; + }; + sdk: { + input: CreateConfiguredModelAlgorithmAssociationCommandInput; + output: CreateConfiguredModelAlgorithmAssociationCommandOutput; + }; + }; +} diff --git a/clients/client-cleanroomsml/src/commands/CreateConfiguredModelAlgorithmCommand.ts b/clients/client-cleanroomsml/src/commands/CreateConfiguredModelAlgorithmCommand.ts new file mode 100644 index 000000000000..5f2326280b4c --- /dev/null +++ b/clients/client-cleanroomsml/src/commands/CreateConfiguredModelAlgorithmCommand.ts @@ -0,0 +1,133 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { CleanRoomsMLClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CleanRoomsMLClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { CreateConfiguredModelAlgorithmRequest, CreateConfiguredModelAlgorithmResponse } from "../models/models_0"; +import { + de_CreateConfiguredModelAlgorithmCommand, + se_CreateConfiguredModelAlgorithmCommand, +} from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link CreateConfiguredModelAlgorithmCommand}. + */ +export interface CreateConfiguredModelAlgorithmCommandInput extends CreateConfiguredModelAlgorithmRequest {} +/** + * @public + * + * The output of {@link CreateConfiguredModelAlgorithmCommand}. + */ +export interface CreateConfiguredModelAlgorithmCommandOutput + extends CreateConfiguredModelAlgorithmResponse, + __MetadataBearer {} + +/** + *Creates a configured model algorithm using a container image stored in an ECR repository.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CleanRoomsMLClient, CreateConfiguredModelAlgorithmCommand } from "@aws-sdk/client-cleanroomsml"; // ES Modules import + * // const { CleanRoomsMLClient, CreateConfiguredModelAlgorithmCommand } = require("@aws-sdk/client-cleanroomsml"); // CommonJS import + * const client = new CleanRoomsMLClient(config); + * const input = { // CreateConfiguredModelAlgorithmRequest + * name: "STRING_VALUE", // required + * description: "STRING_VALUE", + * roleArn: "STRING_VALUE", // required + * trainingContainerConfig: { // ContainerConfig + * imageUri: "STRING_VALUE", // required + * entrypoint: [ // ContainerEntrypoint + * "STRING_VALUE", + * ], + * arguments: [ // ContainerArguments + * "STRING_VALUE", + * ], + * metricDefinitions: [ // MetricDefinitionList + * { // MetricDefinition + * name: "STRING_VALUE", // required + * regex: "STRING_VALUE", // required + * }, + * ], + * }, + * inferenceContainerConfig: { // InferenceContainerConfig + * imageUri: "STRING_VALUE", // required + * }, + * tags: { // TagMap + * "You do not have sufficient access to perform this action.
+ * + * @throws {@link ConflictException} (client fault) + *You can't complete this action because another resource depends on this resource.
+ * + * @throws {@link ServiceQuotaExceededException} (client fault) + *You have exceeded your service quota.
+ * + * @throws {@link ValidationException} (client fault) + *The request parameters for this request are incorrect.
+ * + * @throws {@link CleanRoomsMLServiceException} + *Base exception class for all service exceptions from CleanRoomsML service.
+ * + * @public + */ +export class CreateConfiguredModelAlgorithmCommand extends $Command + .classBuilder< + CreateConfiguredModelAlgorithmCommandInput, + CreateConfiguredModelAlgorithmCommandOutput, + CleanRoomsMLClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: CleanRoomsMLClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AWSStarkControlService", "CreateConfiguredModelAlgorithm", {}) + .n("CleanRoomsMLClient", "CreateConfiguredModelAlgorithmCommand") + .f(void 0, void 0) + .ser(se_CreateConfiguredModelAlgorithmCommand) + .de(de_CreateConfiguredModelAlgorithmCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: CreateConfiguredModelAlgorithmRequest; + output: CreateConfiguredModelAlgorithmResponse; + }; + sdk: { + input: CreateConfiguredModelAlgorithmCommandInput; + output: CreateConfiguredModelAlgorithmCommandOutput; + }; + }; +} diff --git a/clients/client-cleanroomsml/src/commands/CreateMLInputChannelCommand.ts b/clients/client-cleanroomsml/src/commands/CreateMLInputChannelCommand.ts new file mode 100644 index 000000000000..5aa326d9ef26 --- /dev/null +++ b/clients/client-cleanroomsml/src/commands/CreateMLInputChannelCommand.ts @@ -0,0 +1,141 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { CleanRoomsMLClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CleanRoomsMLClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { + CreateMLInputChannelRequest, + CreateMLInputChannelRequestFilterSensitiveLog, + CreateMLInputChannelResponse, +} from "../models/models_0"; +import { de_CreateMLInputChannelCommand, se_CreateMLInputChannelCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link CreateMLInputChannelCommand}. + */ +export interface CreateMLInputChannelCommandInput extends CreateMLInputChannelRequest {} +/** + * @public + * + * The output of {@link CreateMLInputChannelCommand}. + */ +export interface CreateMLInputChannelCommandOutput extends CreateMLInputChannelResponse, __MetadataBearer {} + +/** + *Provides the information to create an ML input channel. An ML input channel is the result of a query that can be used for ML modeling.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CleanRoomsMLClient, CreateMLInputChannelCommand } from "@aws-sdk/client-cleanroomsml"; // ES Modules import + * // const { CleanRoomsMLClient, CreateMLInputChannelCommand } = require("@aws-sdk/client-cleanroomsml"); // CommonJS import + * const client = new CleanRoomsMLClient(config); + * const input = { // CreateMLInputChannelRequest + * membershipIdentifier: "STRING_VALUE", // required + * configuredModelAlgorithmAssociations: [ // ConfiguredModelAlgorithmAssociationArnList // required + * "STRING_VALUE", + * ], + * inputChannel: { // InputChannel + * dataSource: { // InputChannelDataSource Union: only one key present + * protectedQueryInputParameters: { // ProtectedQueryInputParameters + * sqlParameters: { // ProtectedQuerySQLParameters + * queryString: "STRING_VALUE", + * analysisTemplateArn: "STRING_VALUE", + * parameters: { // ParameterMap + * "You do not have sufficient access to perform this action.
+ * + * @throws {@link ConflictException} (client fault) + *You can't complete this action because another resource depends on this resource.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource you are requesting does not exist.
+ * + * @throws {@link ServiceQuotaExceededException} (client fault) + *You have exceeded your service quota.
+ * + * @throws {@link ValidationException} (client fault) + *The request parameters for this request are incorrect.
+ * + * @throws {@link CleanRoomsMLServiceException} + *Base exception class for all service exceptions from CleanRoomsML service.
+ * + * @public + */ +export class CreateMLInputChannelCommand extends $Command + .classBuilder< + CreateMLInputChannelCommandInput, + CreateMLInputChannelCommandOutput, + CleanRoomsMLClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: CleanRoomsMLClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AWSStarkControlService", "CreateMLInputChannel", {}) + .n("CleanRoomsMLClient", "CreateMLInputChannelCommand") + .f(CreateMLInputChannelRequestFilterSensitiveLog, void 0) + .ser(se_CreateMLInputChannelCommand) + .de(de_CreateMLInputChannelCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: CreateMLInputChannelRequest; + output: CreateMLInputChannelResponse; + }; + sdk: { + input: CreateMLInputChannelCommandInput; + output: CreateMLInputChannelCommandOutput; + }; + }; +} diff --git a/clients/client-cleanroomsml/src/commands/CreateTrainedModelCommand.ts b/clients/client-cleanroomsml/src/commands/CreateTrainedModelCommand.ts new file mode 100644 index 000000000000..3017c3e98f29 --- /dev/null +++ b/clients/client-cleanroomsml/src/commands/CreateTrainedModelCommand.ts @@ -0,0 +1,134 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { CleanRoomsMLClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CleanRoomsMLClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { CreateTrainedModelRequest, CreateTrainedModelResponse } from "../models/models_0"; +import { de_CreateTrainedModelCommand, se_CreateTrainedModelCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link CreateTrainedModelCommand}. + */ +export interface CreateTrainedModelCommandInput extends CreateTrainedModelRequest {} +/** + * @public + * + * The output of {@link CreateTrainedModelCommand}. + */ +export interface CreateTrainedModelCommandOutput extends CreateTrainedModelResponse, __MetadataBearer {} + +/** + *Creates a trained model from an associated configured model algorithm using data from any member of the collaboration.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CleanRoomsMLClient, CreateTrainedModelCommand } from "@aws-sdk/client-cleanroomsml"; // ES Modules import + * // const { CleanRoomsMLClient, CreateTrainedModelCommand } = require("@aws-sdk/client-cleanroomsml"); // CommonJS import + * const client = new CleanRoomsMLClient(config); + * const input = { // CreateTrainedModelRequest + * membershipIdentifier: "STRING_VALUE", // required + * name: "STRING_VALUE", // required + * configuredModelAlgorithmAssociationArn: "STRING_VALUE", // required + * hyperparameters: { // HyperParameters + * "You do not have sufficient access to perform this action.
+ * + * @throws {@link ConflictException} (client fault) + *You can't complete this action because another resource depends on this resource.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource you are requesting does not exist.
+ * + * @throws {@link ServiceQuotaExceededException} (client fault) + *You have exceeded your service quota.
+ * + * @throws {@link ValidationException} (client fault) + *The request parameters for this request are incorrect.
+ * + * @throws {@link CleanRoomsMLServiceException} + *Base exception class for all service exceptions from CleanRoomsML service.
+ * + * @public + */ +export class CreateTrainedModelCommand extends $Command + .classBuilder< + CreateTrainedModelCommandInput, + CreateTrainedModelCommandOutput, + CleanRoomsMLClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: CleanRoomsMLClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AWSStarkControlService", "CreateTrainedModel", {}) + .n("CleanRoomsMLClient", "CreateTrainedModelCommand") + .f(void 0, void 0) + .ser(se_CreateTrainedModelCommand) + .de(de_CreateTrainedModelCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: CreateTrainedModelRequest; + output: CreateTrainedModelResponse; + }; + sdk: { + input: CreateTrainedModelCommandInput; + output: CreateTrainedModelCommandOutput; + }; + }; +} diff --git a/clients/client-cleanroomsml/src/commands/DeleteConfiguredModelAlgorithmAssociationCommand.ts b/clients/client-cleanroomsml/src/commands/DeleteConfiguredModelAlgorithmAssociationCommand.ts new file mode 100644 index 000000000000..4f17337e4a5e --- /dev/null +++ b/clients/client-cleanroomsml/src/commands/DeleteConfiguredModelAlgorithmAssociationCommand.ts @@ -0,0 +1,107 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { CleanRoomsMLClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CleanRoomsMLClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { DeleteConfiguredModelAlgorithmAssociationRequest } from "../models/models_0"; +import { + de_DeleteConfiguredModelAlgorithmAssociationCommand, + se_DeleteConfiguredModelAlgorithmAssociationCommand, +} from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link DeleteConfiguredModelAlgorithmAssociationCommand}. + */ +export interface DeleteConfiguredModelAlgorithmAssociationCommandInput + extends DeleteConfiguredModelAlgorithmAssociationRequest {} +/** + * @public + * + * The output of {@link DeleteConfiguredModelAlgorithmAssociationCommand}. + */ +export interface DeleteConfiguredModelAlgorithmAssociationCommandOutput extends __MetadataBearer {} + +/** + *Deletes a configured model algorithm association.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CleanRoomsMLClient, DeleteConfiguredModelAlgorithmAssociationCommand } from "@aws-sdk/client-cleanroomsml"; // ES Modules import + * // const { CleanRoomsMLClient, DeleteConfiguredModelAlgorithmAssociationCommand } = require("@aws-sdk/client-cleanroomsml"); // CommonJS import + * const client = new CleanRoomsMLClient(config); + * const input = { // DeleteConfiguredModelAlgorithmAssociationRequest + * configuredModelAlgorithmAssociationArn: "STRING_VALUE", // required + * membershipIdentifier: "STRING_VALUE", // required + * }; + * const command = new DeleteConfiguredModelAlgorithmAssociationCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param DeleteConfiguredModelAlgorithmAssociationCommandInput - {@link DeleteConfiguredModelAlgorithmAssociationCommandInput} + * @returns {@link DeleteConfiguredModelAlgorithmAssociationCommandOutput} + * @see {@link DeleteConfiguredModelAlgorithmAssociationCommandInput} for command's `input` shape. + * @see {@link DeleteConfiguredModelAlgorithmAssociationCommandOutput} for command's `response` shape. + * @see {@link CleanRoomsMLClientResolvedConfig | config} for CleanRoomsMLClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You do not have sufficient access to perform this action.
+ * + * @throws {@link ConflictException} (client fault) + *You can't complete this action because another resource depends on this resource.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource you are requesting does not exist.
+ * + * @throws {@link ValidationException} (client fault) + *The request parameters for this request are incorrect.
+ * + * @throws {@link CleanRoomsMLServiceException} + *Base exception class for all service exceptions from CleanRoomsML service.
+ * + * @public + */ +export class DeleteConfiguredModelAlgorithmAssociationCommand extends $Command + .classBuilder< + DeleteConfiguredModelAlgorithmAssociationCommandInput, + DeleteConfiguredModelAlgorithmAssociationCommandOutput, + CleanRoomsMLClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: CleanRoomsMLClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AWSStarkControlService", "DeleteConfiguredModelAlgorithmAssociation", {}) + .n("CleanRoomsMLClient", "DeleteConfiguredModelAlgorithmAssociationCommand") + .f(void 0, void 0) + .ser(se_DeleteConfiguredModelAlgorithmAssociationCommand) + .de(de_DeleteConfiguredModelAlgorithmAssociationCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: DeleteConfiguredModelAlgorithmAssociationRequest; + output: {}; + }; + sdk: { + input: DeleteConfiguredModelAlgorithmAssociationCommandInput; + output: DeleteConfiguredModelAlgorithmAssociationCommandOutput; + }; + }; +} diff --git a/clients/client-cleanroomsml/src/commands/DeleteConfiguredModelAlgorithmCommand.ts b/clients/client-cleanroomsml/src/commands/DeleteConfiguredModelAlgorithmCommand.ts new file mode 100644 index 000000000000..ae3702b8faad --- /dev/null +++ b/clients/client-cleanroomsml/src/commands/DeleteConfiguredModelAlgorithmCommand.ts @@ -0,0 +1,105 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { CleanRoomsMLClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CleanRoomsMLClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { DeleteConfiguredModelAlgorithmRequest } from "../models/models_0"; +import { + de_DeleteConfiguredModelAlgorithmCommand, + se_DeleteConfiguredModelAlgorithmCommand, +} from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link DeleteConfiguredModelAlgorithmCommand}. + */ +export interface DeleteConfiguredModelAlgorithmCommandInput extends DeleteConfiguredModelAlgorithmRequest {} +/** + * @public + * + * The output of {@link DeleteConfiguredModelAlgorithmCommand}. + */ +export interface DeleteConfiguredModelAlgorithmCommandOutput extends __MetadataBearer {} + +/** + *Deletes a configured model algorithm.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CleanRoomsMLClient, DeleteConfiguredModelAlgorithmCommand } from "@aws-sdk/client-cleanroomsml"; // ES Modules import + * // const { CleanRoomsMLClient, DeleteConfiguredModelAlgorithmCommand } = require("@aws-sdk/client-cleanroomsml"); // CommonJS import + * const client = new CleanRoomsMLClient(config); + * const input = { // DeleteConfiguredModelAlgorithmRequest + * configuredModelAlgorithmArn: "STRING_VALUE", // required + * }; + * const command = new DeleteConfiguredModelAlgorithmCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param DeleteConfiguredModelAlgorithmCommandInput - {@link DeleteConfiguredModelAlgorithmCommandInput} + * @returns {@link DeleteConfiguredModelAlgorithmCommandOutput} + * @see {@link DeleteConfiguredModelAlgorithmCommandInput} for command's `input` shape. + * @see {@link DeleteConfiguredModelAlgorithmCommandOutput} for command's `response` shape. + * @see {@link CleanRoomsMLClientResolvedConfig | config} for CleanRoomsMLClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You do not have sufficient access to perform this action.
+ * + * @throws {@link ConflictException} (client fault) + *You can't complete this action because another resource depends on this resource.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource you are requesting does not exist.
+ * + * @throws {@link ValidationException} (client fault) + *The request parameters for this request are incorrect.
+ * + * @throws {@link CleanRoomsMLServiceException} + *Base exception class for all service exceptions from CleanRoomsML service.
+ * + * @public + */ +export class DeleteConfiguredModelAlgorithmCommand extends $Command + .classBuilder< + DeleteConfiguredModelAlgorithmCommandInput, + DeleteConfiguredModelAlgorithmCommandOutput, + CleanRoomsMLClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: CleanRoomsMLClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AWSStarkControlService", "DeleteConfiguredModelAlgorithm", {}) + .n("CleanRoomsMLClient", "DeleteConfiguredModelAlgorithmCommand") + .f(void 0, void 0) + .ser(se_DeleteConfiguredModelAlgorithmCommand) + .de(de_DeleteConfiguredModelAlgorithmCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: DeleteConfiguredModelAlgorithmRequest; + output: {}; + }; + sdk: { + input: DeleteConfiguredModelAlgorithmCommandInput; + output: DeleteConfiguredModelAlgorithmCommandOutput; + }; + }; +} diff --git a/clients/client-cleanroomsml/src/commands/DeleteMLConfigurationCommand.ts b/clients/client-cleanroomsml/src/commands/DeleteMLConfigurationCommand.ts new file mode 100644 index 000000000000..6d160095e022 --- /dev/null +++ b/clients/client-cleanroomsml/src/commands/DeleteMLConfigurationCommand.ts @@ -0,0 +1,99 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { CleanRoomsMLClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CleanRoomsMLClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { DeleteMLConfigurationRequest } from "../models/models_0"; +import { de_DeleteMLConfigurationCommand, se_DeleteMLConfigurationCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link DeleteMLConfigurationCommand}. + */ +export interface DeleteMLConfigurationCommandInput extends DeleteMLConfigurationRequest {} +/** + * @public + * + * The output of {@link DeleteMLConfigurationCommand}. + */ +export interface DeleteMLConfigurationCommandOutput extends __MetadataBearer {} + +/** + *Deletes a ML modeling configuration.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CleanRoomsMLClient, DeleteMLConfigurationCommand } from "@aws-sdk/client-cleanroomsml"; // ES Modules import + * // const { CleanRoomsMLClient, DeleteMLConfigurationCommand } = require("@aws-sdk/client-cleanroomsml"); // CommonJS import + * const client = new CleanRoomsMLClient(config); + * const input = { // DeleteMLConfigurationRequest + * membershipIdentifier: "STRING_VALUE", // required + * }; + * const command = new DeleteMLConfigurationCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param DeleteMLConfigurationCommandInput - {@link DeleteMLConfigurationCommandInput} + * @returns {@link DeleteMLConfigurationCommandOutput} + * @see {@link DeleteMLConfigurationCommandInput} for command's `input` shape. + * @see {@link DeleteMLConfigurationCommandOutput} for command's `response` shape. + * @see {@link CleanRoomsMLClientResolvedConfig | config} for CleanRoomsMLClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You do not have sufficient access to perform this action.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource you are requesting does not exist.
+ * + * @throws {@link ValidationException} (client fault) + *The request parameters for this request are incorrect.
+ * + * @throws {@link CleanRoomsMLServiceException} + *Base exception class for all service exceptions from CleanRoomsML service.
+ * + * @public + */ +export class DeleteMLConfigurationCommand extends $Command + .classBuilder< + DeleteMLConfigurationCommandInput, + DeleteMLConfigurationCommandOutput, + CleanRoomsMLClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: CleanRoomsMLClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AWSStarkControlService", "DeleteMLConfiguration", {}) + .n("CleanRoomsMLClient", "DeleteMLConfigurationCommand") + .f(void 0, void 0) + .ser(se_DeleteMLConfigurationCommand) + .de(de_DeleteMLConfigurationCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: DeleteMLConfigurationRequest; + output: {}; + }; + sdk: { + input: DeleteMLConfigurationCommandInput; + output: DeleteMLConfigurationCommandOutput; + }; + }; +} diff --git a/clients/client-cleanroomsml/src/commands/DeleteMLInputChannelDataCommand.ts b/clients/client-cleanroomsml/src/commands/DeleteMLInputChannelDataCommand.ts new file mode 100644 index 000000000000..75350867846f --- /dev/null +++ b/clients/client-cleanroomsml/src/commands/DeleteMLInputChannelDataCommand.ts @@ -0,0 +1,103 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { CleanRoomsMLClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CleanRoomsMLClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { DeleteMLInputChannelDataRequest } from "../models/models_0"; +import { de_DeleteMLInputChannelDataCommand, se_DeleteMLInputChannelDataCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link DeleteMLInputChannelDataCommand}. + */ +export interface DeleteMLInputChannelDataCommandInput extends DeleteMLInputChannelDataRequest {} +/** + * @public + * + * The output of {@link DeleteMLInputChannelDataCommand}. + */ +export interface DeleteMLInputChannelDataCommandOutput extends __MetadataBearer {} + +/** + *Provides the information necessary to delete an ML input channel.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CleanRoomsMLClient, DeleteMLInputChannelDataCommand } from "@aws-sdk/client-cleanroomsml"; // ES Modules import + * // const { CleanRoomsMLClient, DeleteMLInputChannelDataCommand } = require("@aws-sdk/client-cleanroomsml"); // CommonJS import + * const client = new CleanRoomsMLClient(config); + * const input = { // DeleteMLInputChannelDataRequest + * mlInputChannelArn: "STRING_VALUE", // required + * membershipIdentifier: "STRING_VALUE", // required + * }; + * const command = new DeleteMLInputChannelDataCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param DeleteMLInputChannelDataCommandInput - {@link DeleteMLInputChannelDataCommandInput} + * @returns {@link DeleteMLInputChannelDataCommandOutput} + * @see {@link DeleteMLInputChannelDataCommandInput} for command's `input` shape. + * @see {@link DeleteMLInputChannelDataCommandOutput} for command's `response` shape. + * @see {@link CleanRoomsMLClientResolvedConfig | config} for CleanRoomsMLClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You do not have sufficient access to perform this action.
+ * + * @throws {@link ConflictException} (client fault) + *You can't complete this action because another resource depends on this resource.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource you are requesting does not exist.
+ * + * @throws {@link ValidationException} (client fault) + *The request parameters for this request are incorrect.
+ * + * @throws {@link CleanRoomsMLServiceException} + *Base exception class for all service exceptions from CleanRoomsML service.
+ * + * @public + */ +export class DeleteMLInputChannelDataCommand extends $Command + .classBuilder< + DeleteMLInputChannelDataCommandInput, + DeleteMLInputChannelDataCommandOutput, + CleanRoomsMLClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: CleanRoomsMLClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AWSStarkControlService", "DeleteMLInputChannelData", {}) + .n("CleanRoomsMLClient", "DeleteMLInputChannelDataCommand") + .f(void 0, void 0) + .ser(se_DeleteMLInputChannelDataCommand) + .de(de_DeleteMLInputChannelDataCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: DeleteMLInputChannelDataRequest; + output: {}; + }; + sdk: { + input: DeleteMLInputChannelDataCommandInput; + output: DeleteMLInputChannelDataCommandOutput; + }; + }; +} diff --git a/clients/client-cleanroomsml/src/commands/DeleteTrainedModelOutputCommand.ts b/clients/client-cleanroomsml/src/commands/DeleteTrainedModelOutputCommand.ts new file mode 100644 index 000000000000..ee2cf4597801 --- /dev/null +++ b/clients/client-cleanroomsml/src/commands/DeleteTrainedModelOutputCommand.ts @@ -0,0 +1,103 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { CleanRoomsMLClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CleanRoomsMLClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { DeleteTrainedModelOutputRequest } from "../models/models_0"; +import { de_DeleteTrainedModelOutputCommand, se_DeleteTrainedModelOutputCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link DeleteTrainedModelOutputCommand}. + */ +export interface DeleteTrainedModelOutputCommandInput extends DeleteTrainedModelOutputRequest {} +/** + * @public + * + * The output of {@link DeleteTrainedModelOutputCommand}. + */ +export interface DeleteTrainedModelOutputCommandOutput extends __MetadataBearer {} + +/** + *Deletes the output of a trained model.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CleanRoomsMLClient, DeleteTrainedModelOutputCommand } from "@aws-sdk/client-cleanroomsml"; // ES Modules import + * // const { CleanRoomsMLClient, DeleteTrainedModelOutputCommand } = require("@aws-sdk/client-cleanroomsml"); // CommonJS import + * const client = new CleanRoomsMLClient(config); + * const input = { // DeleteTrainedModelOutputRequest + * trainedModelArn: "STRING_VALUE", // required + * membershipIdentifier: "STRING_VALUE", // required + * }; + * const command = new DeleteTrainedModelOutputCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param DeleteTrainedModelOutputCommandInput - {@link DeleteTrainedModelOutputCommandInput} + * @returns {@link DeleteTrainedModelOutputCommandOutput} + * @see {@link DeleteTrainedModelOutputCommandInput} for command's `input` shape. + * @see {@link DeleteTrainedModelOutputCommandOutput} for command's `response` shape. + * @see {@link CleanRoomsMLClientResolvedConfig | config} for CleanRoomsMLClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You do not have sufficient access to perform this action.
+ * + * @throws {@link ConflictException} (client fault) + *You can't complete this action because another resource depends on this resource.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource you are requesting does not exist.
+ * + * @throws {@link ValidationException} (client fault) + *The request parameters for this request are incorrect.
+ * + * @throws {@link CleanRoomsMLServiceException} + *Base exception class for all service exceptions from CleanRoomsML service.
+ * + * @public + */ +export class DeleteTrainedModelOutputCommand extends $Command + .classBuilder< + DeleteTrainedModelOutputCommandInput, + DeleteTrainedModelOutputCommandOutput, + CleanRoomsMLClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: CleanRoomsMLClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AWSStarkControlService", "DeleteTrainedModelOutput", {}) + .n("CleanRoomsMLClient", "DeleteTrainedModelOutputCommand") + .f(void 0, void 0) + .ser(se_DeleteTrainedModelOutputCommand) + .de(de_DeleteTrainedModelOutputCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: DeleteTrainedModelOutputRequest; + output: {}; + }; + sdk: { + input: DeleteTrainedModelOutputCommandInput; + output: DeleteTrainedModelOutputCommandOutput; + }; + }; +} diff --git a/clients/client-cleanroomsml/src/commands/GetCollaborationConfiguredModelAlgorithmAssociationCommand.ts b/clients/client-cleanroomsml/src/commands/GetCollaborationConfiguredModelAlgorithmAssociationCommand.ts new file mode 100644 index 000000000000..759a7671550d --- /dev/null +++ b/clients/client-cleanroomsml/src/commands/GetCollaborationConfiguredModelAlgorithmAssociationCommand.ts @@ -0,0 +1,159 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { CleanRoomsMLClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CleanRoomsMLClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { + GetCollaborationConfiguredModelAlgorithmAssociationRequest, + GetCollaborationConfiguredModelAlgorithmAssociationResponse, +} from "../models/models_0"; +import { + de_GetCollaborationConfiguredModelAlgorithmAssociationCommand, + se_GetCollaborationConfiguredModelAlgorithmAssociationCommand, +} from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link GetCollaborationConfiguredModelAlgorithmAssociationCommand}. + */ +export interface GetCollaborationConfiguredModelAlgorithmAssociationCommandInput + extends GetCollaborationConfiguredModelAlgorithmAssociationRequest {} +/** + * @public + * + * The output of {@link GetCollaborationConfiguredModelAlgorithmAssociationCommand}. + */ +export interface GetCollaborationConfiguredModelAlgorithmAssociationCommandOutput + extends GetCollaborationConfiguredModelAlgorithmAssociationResponse, + __MetadataBearer {} + +/** + *Returns information about the configured model algorithm association in a collaboration.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CleanRoomsMLClient, GetCollaborationConfiguredModelAlgorithmAssociationCommand } from "@aws-sdk/client-cleanroomsml"; // ES Modules import + * // const { CleanRoomsMLClient, GetCollaborationConfiguredModelAlgorithmAssociationCommand } = require("@aws-sdk/client-cleanroomsml"); // CommonJS import + * const client = new CleanRoomsMLClient(config); + * const input = { // GetCollaborationConfiguredModelAlgorithmAssociationRequest + * configuredModelAlgorithmAssociationArn: "STRING_VALUE", // required + * collaborationIdentifier: "STRING_VALUE", // required + * }; + * const command = new GetCollaborationConfiguredModelAlgorithmAssociationCommand(input); + * const response = await client.send(command); + * // { // GetCollaborationConfiguredModelAlgorithmAssociationResponse + * // createTime: new Date("TIMESTAMP"), // required + * // updateTime: new Date("TIMESTAMP"), // required + * // configuredModelAlgorithmAssociationArn: "STRING_VALUE", // required + * // membershipIdentifier: "STRING_VALUE", // required + * // collaborationIdentifier: "STRING_VALUE", // required + * // configuredModelAlgorithmArn: "STRING_VALUE", // required + * // name: "STRING_VALUE", // required + * // description: "STRING_VALUE", + * // creatorAccountId: "STRING_VALUE", // required + * // privacyConfiguration: { // PrivacyConfiguration + * // policies: { // PrivacyConfigurationPolicies + * // trainedModels: { // TrainedModelsConfigurationPolicy + * // containerLogs: [ // LogsConfigurationPolicyList + * // { // LogsConfigurationPolicy + * // allowedAccountIds: [ // AccountIdList // required + * // "STRING_VALUE", + * // ], + * // filterPattern: "STRING_VALUE", + * // }, + * // ], + * // containerMetrics: { // MetricsConfigurationPolicy + * // noiseLevel: "HIGH" || "MEDIUM" || "LOW" || "NONE", // required + * // }, + * // }, + * // trainedModelExports: { // TrainedModelExportsConfigurationPolicy + * // maxSize: { // TrainedModelExportsMaxSize + * // unit: "GB", // required + * // value: Number("double"), // required + * // }, + * // filesToExport: [ // TrainedModelExportFileTypeList // required + * // "MODEL" || "OUTPUT", + * // ], + * // }, + * // trainedModelInferenceJobs: { // TrainedModelInferenceJobsConfigurationPolicy + * // containerLogs: [ + * // { + * // allowedAccountIds: [ // required + * // "STRING_VALUE", + * // ], + * // filterPattern: "STRING_VALUE", + * // }, + * // ], + * // maxOutputSize: { // TrainedModelInferenceMaxOutputSize + * // unit: "GB", // required + * // value: Number("double"), // required + * // }, + * // }, + * // }, + * // }, + * // }; + * + * ``` + * + * @param GetCollaborationConfiguredModelAlgorithmAssociationCommandInput - {@link GetCollaborationConfiguredModelAlgorithmAssociationCommandInput} + * @returns {@link GetCollaborationConfiguredModelAlgorithmAssociationCommandOutput} + * @see {@link GetCollaborationConfiguredModelAlgorithmAssociationCommandInput} for command's `input` shape. + * @see {@link GetCollaborationConfiguredModelAlgorithmAssociationCommandOutput} for command's `response` shape. + * @see {@link CleanRoomsMLClientResolvedConfig | config} for CleanRoomsMLClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You do not have sufficient access to perform this action.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource you are requesting does not exist.
+ * + * @throws {@link ValidationException} (client fault) + *The request parameters for this request are incorrect.
+ * + * @throws {@link CleanRoomsMLServiceException} + *Base exception class for all service exceptions from CleanRoomsML service.
+ * + * @public + */ +export class GetCollaborationConfiguredModelAlgorithmAssociationCommand extends $Command + .classBuilder< + GetCollaborationConfiguredModelAlgorithmAssociationCommandInput, + GetCollaborationConfiguredModelAlgorithmAssociationCommandOutput, + CleanRoomsMLClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: CleanRoomsMLClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AWSStarkControlService", "GetCollaborationConfiguredModelAlgorithmAssociation", {}) + .n("CleanRoomsMLClient", "GetCollaborationConfiguredModelAlgorithmAssociationCommand") + .f(void 0, void 0) + .ser(se_GetCollaborationConfiguredModelAlgorithmAssociationCommand) + .de(de_GetCollaborationConfiguredModelAlgorithmAssociationCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: GetCollaborationConfiguredModelAlgorithmAssociationRequest; + output: GetCollaborationConfiguredModelAlgorithmAssociationResponse; + }; + sdk: { + input: GetCollaborationConfiguredModelAlgorithmAssociationCommandInput; + output: GetCollaborationConfiguredModelAlgorithmAssociationCommandOutput; + }; + }; +} diff --git a/clients/client-cleanroomsml/src/commands/GetCollaborationMLInputChannelCommand.ts b/clients/client-cleanroomsml/src/commands/GetCollaborationMLInputChannelCommand.ts new file mode 100644 index 000000000000..f360052e63f2 --- /dev/null +++ b/clients/client-cleanroomsml/src/commands/GetCollaborationMLInputChannelCommand.ts @@ -0,0 +1,124 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { CleanRoomsMLClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CleanRoomsMLClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { GetCollaborationMLInputChannelRequest, GetCollaborationMLInputChannelResponse } from "../models/models_0"; +import { + de_GetCollaborationMLInputChannelCommand, + se_GetCollaborationMLInputChannelCommand, +} from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link GetCollaborationMLInputChannelCommand}. + */ +export interface GetCollaborationMLInputChannelCommandInput extends GetCollaborationMLInputChannelRequest {} +/** + * @public + * + * The output of {@link GetCollaborationMLInputChannelCommand}. + */ +export interface GetCollaborationMLInputChannelCommandOutput + extends GetCollaborationMLInputChannelResponse, + __MetadataBearer {} + +/** + *Returns information about a specific ML input channel in a collaboration.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CleanRoomsMLClient, GetCollaborationMLInputChannelCommand } from "@aws-sdk/client-cleanroomsml"; // ES Modules import + * // const { CleanRoomsMLClient, GetCollaborationMLInputChannelCommand } = require("@aws-sdk/client-cleanroomsml"); // CommonJS import + * const client = new CleanRoomsMLClient(config); + * const input = { // GetCollaborationMLInputChannelRequest + * mlInputChannelArn: "STRING_VALUE", // required + * collaborationIdentifier: "STRING_VALUE", // required + * }; + * const command = new GetCollaborationMLInputChannelCommand(input); + * const response = await client.send(command); + * // { // GetCollaborationMLInputChannelResponse + * // createTime: new Date("TIMESTAMP"), // required + * // updateTime: new Date("TIMESTAMP"), // required + * // creatorAccountId: "STRING_VALUE", // required + * // membershipIdentifier: "STRING_VALUE", // required + * // collaborationIdentifier: "STRING_VALUE", // required + * // mlInputChannelArn: "STRING_VALUE", // required + * // name: "STRING_VALUE", // required + * // configuredModelAlgorithmAssociations: [ // ConfiguredModelAlgorithmAssociationArnList // required + * // "STRING_VALUE", + * // ], + * // status: "CREATE_PENDING" || "CREATE_IN_PROGRESS" || "CREATE_FAILED" || "ACTIVE" || "DELETE_PENDING" || "DELETE_IN_PROGRESS" || "DELETE_FAILED" || "INACTIVE", // required + * // statusDetails: { // StatusDetails + * // statusCode: "STRING_VALUE", + * // message: "STRING_VALUE", + * // }, + * // retentionInDays: Number("int"), // required + * // numberOfRecords: Number("long"), + * // description: "STRING_VALUE", + * // }; + * + * ``` + * + * @param GetCollaborationMLInputChannelCommandInput - {@link GetCollaborationMLInputChannelCommandInput} + * @returns {@link GetCollaborationMLInputChannelCommandOutput} + * @see {@link GetCollaborationMLInputChannelCommandInput} for command's `input` shape. + * @see {@link GetCollaborationMLInputChannelCommandOutput} for command's `response` shape. + * @see {@link CleanRoomsMLClientResolvedConfig | config} for CleanRoomsMLClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You do not have sufficient access to perform this action.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource you are requesting does not exist.
+ * + * @throws {@link ValidationException} (client fault) + *The request parameters for this request are incorrect.
+ * + * @throws {@link CleanRoomsMLServiceException} + *Base exception class for all service exceptions from CleanRoomsML service.
+ * + * @public + */ +export class GetCollaborationMLInputChannelCommand extends $Command + .classBuilder< + GetCollaborationMLInputChannelCommandInput, + GetCollaborationMLInputChannelCommandOutput, + CleanRoomsMLClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: CleanRoomsMLClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AWSStarkControlService", "GetCollaborationMLInputChannel", {}) + .n("CleanRoomsMLClient", "GetCollaborationMLInputChannelCommand") + .f(void 0, void 0) + .ser(se_GetCollaborationMLInputChannelCommand) + .de(de_GetCollaborationMLInputChannelCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: GetCollaborationMLInputChannelRequest; + output: GetCollaborationMLInputChannelResponse; + }; + sdk: { + input: GetCollaborationMLInputChannelCommandInput; + output: GetCollaborationMLInputChannelCommandOutput; + }; + }; +} diff --git a/clients/client-cleanroomsml/src/commands/GetCollaborationTrainedModelCommand.ts b/clients/client-cleanroomsml/src/commands/GetCollaborationTrainedModelCommand.ts new file mode 100644 index 000000000000..ec0733c78052 --- /dev/null +++ b/clients/client-cleanroomsml/src/commands/GetCollaborationTrainedModelCommand.ts @@ -0,0 +1,133 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { CleanRoomsMLClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CleanRoomsMLClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { GetCollaborationTrainedModelRequest, GetCollaborationTrainedModelResponse } from "../models/models_0"; +import { + de_GetCollaborationTrainedModelCommand, + se_GetCollaborationTrainedModelCommand, +} from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link GetCollaborationTrainedModelCommand}. + */ +export interface GetCollaborationTrainedModelCommandInput extends GetCollaborationTrainedModelRequest {} +/** + * @public + * + * The output of {@link GetCollaborationTrainedModelCommand}. + */ +export interface GetCollaborationTrainedModelCommandOutput + extends GetCollaborationTrainedModelResponse, + __MetadataBearer {} + +/** + *Returns information about a trained model in a collaboration.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CleanRoomsMLClient, GetCollaborationTrainedModelCommand } from "@aws-sdk/client-cleanroomsml"; // ES Modules import + * // const { CleanRoomsMLClient, GetCollaborationTrainedModelCommand } = require("@aws-sdk/client-cleanroomsml"); // CommonJS import + * const client = new CleanRoomsMLClient(config); + * const input = { // GetCollaborationTrainedModelRequest + * trainedModelArn: "STRING_VALUE", // required + * collaborationIdentifier: "STRING_VALUE", // required + * }; + * const command = new GetCollaborationTrainedModelCommand(input); + * const response = await client.send(command); + * // { // GetCollaborationTrainedModelResponse + * // membershipIdentifier: "STRING_VALUE", // required + * // collaborationIdentifier: "STRING_VALUE", // required + * // trainedModelArn: "STRING_VALUE", // required + * // name: "STRING_VALUE", // required + * // description: "STRING_VALUE", + * // status: "CREATE_PENDING" || "CREATE_IN_PROGRESS" || "CREATE_FAILED" || "ACTIVE" || "DELETE_PENDING" || "DELETE_IN_PROGRESS" || "DELETE_FAILED" || "INACTIVE" || "CANCEL_PENDING" || "CANCEL_IN_PROGRESS" || "CANCEL_FAILED", // required + * // statusDetails: { // StatusDetails + * // statusCode: "STRING_VALUE", + * // message: "STRING_VALUE", + * // }, + * // configuredModelAlgorithmAssociationArn: "STRING_VALUE", // required + * // resourceConfig: { // ResourceConfig + * // instanceCount: Number("int"), + * // instanceType: "ml.m4.xlarge" || "ml.m4.2xlarge" || "ml.m4.4xlarge" || "ml.m4.10xlarge" || "ml.m4.16xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.12xlarge" || "ml.m5.24xlarge" || "ml.c4.xlarge" || "ml.c4.2xlarge" || "ml.c4.4xlarge" || "ml.c4.8xlarge" || "ml.p2.xlarge" || "ml.p2.8xlarge" || "ml.p2.16xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.p5.48xlarge" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.18xlarge" || "ml.c5n.xlarge" || "ml.c5n.2xlarge" || "ml.c5n.4xlarge" || "ml.c5n.9xlarge" || "ml.c5n.18xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge" || "ml.m6i.large" || "ml.m6i.xlarge" || "ml.m6i.2xlarge" || "ml.m6i.4xlarge" || "ml.m6i.8xlarge" || "ml.m6i.12xlarge" || "ml.m6i.16xlarge" || "ml.m6i.24xlarge" || "ml.m6i.32xlarge" || "ml.c6i.xlarge" || "ml.c6i.2xlarge" || "ml.c6i.8xlarge" || "ml.c6i.4xlarge" || "ml.c6i.12xlarge" || "ml.c6i.16xlarge" || "ml.c6i.24xlarge" || "ml.c6i.32xlarge" || "ml.r5d.large" || "ml.r5d.xlarge" || "ml.r5d.2xlarge" || "ml.r5d.4xlarge" || "ml.r5d.8xlarge" || "ml.r5d.12xlarge" || "ml.r5d.16xlarge" || "ml.r5d.24xlarge" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge", // required + * // volumeSizeInGB: Number("int"), // required + * // }, + * // stoppingCondition: { // StoppingCondition + * // maxRuntimeInSeconds: Number("int"), + * // }, + * // metricsStatus: "PUBLISH_SUCCEEDED" || "PUBLISH_FAILED", + * // metricsStatusDetails: "STRING_VALUE", + * // logsStatus: "PUBLISH_SUCCEEDED" || "PUBLISH_FAILED", + * // logsStatusDetails: "STRING_VALUE", + * // trainingContainerImageDigest: "STRING_VALUE", + * // createTime: new Date("TIMESTAMP"), // required + * // updateTime: new Date("TIMESTAMP"), // required + * // creatorAccountId: "STRING_VALUE", // required + * // }; + * + * ``` + * + * @param GetCollaborationTrainedModelCommandInput - {@link GetCollaborationTrainedModelCommandInput} + * @returns {@link GetCollaborationTrainedModelCommandOutput} + * @see {@link GetCollaborationTrainedModelCommandInput} for command's `input` shape. + * @see {@link GetCollaborationTrainedModelCommandOutput} for command's `response` shape. + * @see {@link CleanRoomsMLClientResolvedConfig | config} for CleanRoomsMLClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You do not have sufficient access to perform this action.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource you are requesting does not exist.
+ * + * @throws {@link ValidationException} (client fault) + *The request parameters for this request are incorrect.
+ * + * @throws {@link CleanRoomsMLServiceException} + *Base exception class for all service exceptions from CleanRoomsML service.
+ * + * @public + */ +export class GetCollaborationTrainedModelCommand extends $Command + .classBuilder< + GetCollaborationTrainedModelCommandInput, + GetCollaborationTrainedModelCommandOutput, + CleanRoomsMLClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: CleanRoomsMLClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AWSStarkControlService", "GetCollaborationTrainedModel", {}) + .n("CleanRoomsMLClient", "GetCollaborationTrainedModelCommand") + .f(void 0, void 0) + .ser(se_GetCollaborationTrainedModelCommand) + .de(de_GetCollaborationTrainedModelCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: GetCollaborationTrainedModelRequest; + output: GetCollaborationTrainedModelResponse; + }; + sdk: { + input: GetCollaborationTrainedModelCommandInput; + output: GetCollaborationTrainedModelCommandOutput; + }; + }; +} diff --git a/clients/client-cleanroomsml/src/commands/GetConfiguredModelAlgorithmAssociationCommand.ts b/clients/client-cleanroomsml/src/commands/GetConfiguredModelAlgorithmAssociationCommand.ts new file mode 100644 index 000000000000..8a8b955e4477 --- /dev/null +++ b/clients/client-cleanroomsml/src/commands/GetConfiguredModelAlgorithmAssociationCommand.ts @@ -0,0 +1,161 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { CleanRoomsMLClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CleanRoomsMLClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { + GetConfiguredModelAlgorithmAssociationRequest, + GetConfiguredModelAlgorithmAssociationResponse, +} from "../models/models_0"; +import { + de_GetConfiguredModelAlgorithmAssociationCommand, + se_GetConfiguredModelAlgorithmAssociationCommand, +} from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link GetConfiguredModelAlgorithmAssociationCommand}. + */ +export interface GetConfiguredModelAlgorithmAssociationCommandInput + extends GetConfiguredModelAlgorithmAssociationRequest {} +/** + * @public + * + * The output of {@link GetConfiguredModelAlgorithmAssociationCommand}. + */ +export interface GetConfiguredModelAlgorithmAssociationCommandOutput + extends GetConfiguredModelAlgorithmAssociationResponse, + __MetadataBearer {} + +/** + *Returns information about a configured model algorithm association.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CleanRoomsMLClient, GetConfiguredModelAlgorithmAssociationCommand } from "@aws-sdk/client-cleanroomsml"; // ES Modules import + * // const { CleanRoomsMLClient, GetConfiguredModelAlgorithmAssociationCommand } = require("@aws-sdk/client-cleanroomsml"); // CommonJS import + * const client = new CleanRoomsMLClient(config); + * const input = { // GetConfiguredModelAlgorithmAssociationRequest + * configuredModelAlgorithmAssociationArn: "STRING_VALUE", // required + * membershipIdentifier: "STRING_VALUE", // required + * }; + * const command = new GetConfiguredModelAlgorithmAssociationCommand(input); + * const response = await client.send(command); + * // { // GetConfiguredModelAlgorithmAssociationResponse + * // createTime: new Date("TIMESTAMP"), // required + * // updateTime: new Date("TIMESTAMP"), // required + * // configuredModelAlgorithmAssociationArn: "STRING_VALUE", // required + * // membershipIdentifier: "STRING_VALUE", // required + * // collaborationIdentifier: "STRING_VALUE", // required + * // configuredModelAlgorithmArn: "STRING_VALUE", // required + * // name: "STRING_VALUE", // required + * // privacyConfiguration: { // PrivacyConfiguration + * // policies: { // PrivacyConfigurationPolicies + * // trainedModels: { // TrainedModelsConfigurationPolicy + * // containerLogs: [ // LogsConfigurationPolicyList + * // { // LogsConfigurationPolicy + * // allowedAccountIds: [ // AccountIdList // required + * // "STRING_VALUE", + * // ], + * // filterPattern: "STRING_VALUE", + * // }, + * // ], + * // containerMetrics: { // MetricsConfigurationPolicy + * // noiseLevel: "HIGH" || "MEDIUM" || "LOW" || "NONE", // required + * // }, + * // }, + * // trainedModelExports: { // TrainedModelExportsConfigurationPolicy + * // maxSize: { // TrainedModelExportsMaxSize + * // unit: "GB", // required + * // value: Number("double"), // required + * // }, + * // filesToExport: [ // TrainedModelExportFileTypeList // required + * // "MODEL" || "OUTPUT", + * // ], + * // }, + * // trainedModelInferenceJobs: { // TrainedModelInferenceJobsConfigurationPolicy + * // containerLogs: [ + * // { + * // allowedAccountIds: [ // required + * // "STRING_VALUE", + * // ], + * // filterPattern: "STRING_VALUE", + * // }, + * // ], + * // maxOutputSize: { // TrainedModelInferenceMaxOutputSize + * // unit: "GB", // required + * // value: Number("double"), // required + * // }, + * // }, + * // }, + * // }, + * // description: "STRING_VALUE", + * // tags: { // TagMap + * // "You do not have sufficient access to perform this action.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource you are requesting does not exist.
+ * + * @throws {@link ValidationException} (client fault) + *The request parameters for this request are incorrect.
+ * + * @throws {@link CleanRoomsMLServiceException} + *Base exception class for all service exceptions from CleanRoomsML service.
+ * + * @public + */ +export class GetConfiguredModelAlgorithmAssociationCommand extends $Command + .classBuilder< + GetConfiguredModelAlgorithmAssociationCommandInput, + GetConfiguredModelAlgorithmAssociationCommandOutput, + CleanRoomsMLClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: CleanRoomsMLClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AWSStarkControlService", "GetConfiguredModelAlgorithmAssociation", {}) + .n("CleanRoomsMLClient", "GetConfiguredModelAlgorithmAssociationCommand") + .f(void 0, void 0) + .ser(se_GetConfiguredModelAlgorithmAssociationCommand) + .de(de_GetConfiguredModelAlgorithmAssociationCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: GetConfiguredModelAlgorithmAssociationRequest; + output: GetConfiguredModelAlgorithmAssociationResponse; + }; + sdk: { + input: GetConfiguredModelAlgorithmAssociationCommandInput; + output: GetConfiguredModelAlgorithmAssociationCommandOutput; + }; + }; +} diff --git a/clients/client-cleanroomsml/src/commands/GetConfiguredModelAlgorithmCommand.ts b/clients/client-cleanroomsml/src/commands/GetConfiguredModelAlgorithmCommand.ts new file mode 100644 index 000000000000..210c491d29a2 --- /dev/null +++ b/clients/client-cleanroomsml/src/commands/GetConfiguredModelAlgorithmCommand.ts @@ -0,0 +1,133 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { CleanRoomsMLClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CleanRoomsMLClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { GetConfiguredModelAlgorithmRequest, GetConfiguredModelAlgorithmResponse } from "../models/models_0"; +import { + de_GetConfiguredModelAlgorithmCommand, + se_GetConfiguredModelAlgorithmCommand, +} from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link GetConfiguredModelAlgorithmCommand}. + */ +export interface GetConfiguredModelAlgorithmCommandInput extends GetConfiguredModelAlgorithmRequest {} +/** + * @public + * + * The output of {@link GetConfiguredModelAlgorithmCommand}. + */ +export interface GetConfiguredModelAlgorithmCommandOutput + extends GetConfiguredModelAlgorithmResponse, + __MetadataBearer {} + +/** + *Returns information about a configured model algorithm.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CleanRoomsMLClient, GetConfiguredModelAlgorithmCommand } from "@aws-sdk/client-cleanroomsml"; // ES Modules import + * // const { CleanRoomsMLClient, GetConfiguredModelAlgorithmCommand } = require("@aws-sdk/client-cleanroomsml"); // CommonJS import + * const client = new CleanRoomsMLClient(config); + * const input = { // GetConfiguredModelAlgorithmRequest + * configuredModelAlgorithmArn: "STRING_VALUE", // required + * }; + * const command = new GetConfiguredModelAlgorithmCommand(input); + * const response = await client.send(command); + * // { // GetConfiguredModelAlgorithmResponse + * // createTime: new Date("TIMESTAMP"), // required + * // updateTime: new Date("TIMESTAMP"), // required + * // configuredModelAlgorithmArn: "STRING_VALUE", // required + * // name: "STRING_VALUE", // required + * // trainingContainerConfig: { // ContainerConfig + * // imageUri: "STRING_VALUE", // required + * // entrypoint: [ // ContainerEntrypoint + * // "STRING_VALUE", + * // ], + * // arguments: [ // ContainerArguments + * // "STRING_VALUE", + * // ], + * // metricDefinitions: [ // MetricDefinitionList + * // { // MetricDefinition + * // name: "STRING_VALUE", // required + * // regex: "STRING_VALUE", // required + * // }, + * // ], + * // }, + * // inferenceContainerConfig: { // InferenceContainerConfig + * // imageUri: "STRING_VALUE", // required + * // }, + * // roleArn: "STRING_VALUE", // required + * // description: "STRING_VALUE", + * // tags: { // TagMap + * // "You do not have sufficient access to perform this action.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource you are requesting does not exist.
+ * + * @throws {@link ValidationException} (client fault) + *The request parameters for this request are incorrect.
+ * + * @throws {@link CleanRoomsMLServiceException} + *Base exception class for all service exceptions from CleanRoomsML service.
+ * + * @public + */ +export class GetConfiguredModelAlgorithmCommand extends $Command + .classBuilder< + GetConfiguredModelAlgorithmCommandInput, + GetConfiguredModelAlgorithmCommandOutput, + CleanRoomsMLClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: CleanRoomsMLClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AWSStarkControlService", "GetConfiguredModelAlgorithm", {}) + .n("CleanRoomsMLClient", "GetConfiguredModelAlgorithmCommand") + .f(void 0, void 0) + .ser(se_GetConfiguredModelAlgorithmCommand) + .de(de_GetConfiguredModelAlgorithmCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: GetConfiguredModelAlgorithmRequest; + output: GetConfiguredModelAlgorithmResponse; + }; + sdk: { + input: GetConfiguredModelAlgorithmCommandInput; + output: GetConfiguredModelAlgorithmCommandOutput; + }; + }; +} diff --git a/clients/client-cleanroomsml/src/commands/GetMLConfigurationCommand.ts b/clients/client-cleanroomsml/src/commands/GetMLConfigurationCommand.ts new file mode 100644 index 000000000000..ea706ca05235 --- /dev/null +++ b/clients/client-cleanroomsml/src/commands/GetMLConfigurationCommand.ts @@ -0,0 +1,111 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { CleanRoomsMLClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CleanRoomsMLClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { GetMLConfigurationRequest, GetMLConfigurationResponse } from "../models/models_0"; +import { de_GetMLConfigurationCommand, se_GetMLConfigurationCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link GetMLConfigurationCommand}. + */ +export interface GetMLConfigurationCommandInput extends GetMLConfigurationRequest {} +/** + * @public + * + * The output of {@link GetMLConfigurationCommand}. + */ +export interface GetMLConfigurationCommandOutput extends GetMLConfigurationResponse, __MetadataBearer {} + +/** + *Returns information about a specific ML configuration.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CleanRoomsMLClient, GetMLConfigurationCommand } from "@aws-sdk/client-cleanroomsml"; // ES Modules import + * // const { CleanRoomsMLClient, GetMLConfigurationCommand } = require("@aws-sdk/client-cleanroomsml"); // CommonJS import + * const client = new CleanRoomsMLClient(config); + * const input = { // GetMLConfigurationRequest + * membershipIdentifier: "STRING_VALUE", // required + * }; + * const command = new GetMLConfigurationCommand(input); + * const response = await client.send(command); + * // { // GetMLConfigurationResponse + * // membershipIdentifier: "STRING_VALUE", // required + * // defaultOutputLocation: { // MLOutputConfiguration + * // destination: { // Destination + * // s3Destination: { // S3ConfigMap + * // s3Uri: "STRING_VALUE", // required + * // }, + * // }, + * // roleArn: "STRING_VALUE", // required + * // }, + * // createTime: new Date("TIMESTAMP"), // required + * // updateTime: new Date("TIMESTAMP"), // required + * // }; + * + * ``` + * + * @param GetMLConfigurationCommandInput - {@link GetMLConfigurationCommandInput} + * @returns {@link GetMLConfigurationCommandOutput} + * @see {@link GetMLConfigurationCommandInput} for command's `input` shape. + * @see {@link GetMLConfigurationCommandOutput} for command's `response` shape. + * @see {@link CleanRoomsMLClientResolvedConfig | config} for CleanRoomsMLClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You do not have sufficient access to perform this action.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource you are requesting does not exist.
+ * + * @throws {@link ValidationException} (client fault) + *The request parameters for this request are incorrect.
+ * + * @throws {@link CleanRoomsMLServiceException} + *Base exception class for all service exceptions from CleanRoomsML service.
+ * + * @public + */ +export class GetMLConfigurationCommand extends $Command + .classBuilder< + GetMLConfigurationCommandInput, + GetMLConfigurationCommandOutput, + CleanRoomsMLClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: CleanRoomsMLClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AWSStarkControlService", "GetMLConfiguration", {}) + .n("CleanRoomsMLClient", "GetMLConfigurationCommand") + .f(void 0, void 0) + .ser(se_GetMLConfigurationCommand) + .de(de_GetMLConfigurationCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: GetMLConfigurationRequest; + output: GetMLConfigurationResponse; + }; + sdk: { + input: GetMLConfigurationCommandInput; + output: GetMLConfigurationCommandOutput; + }; + }; +} diff --git a/clients/client-cleanroomsml/src/commands/GetMLInputChannelCommand.ts b/clients/client-cleanroomsml/src/commands/GetMLInputChannelCommand.ts new file mode 100644 index 000000000000..0f962efb8a43 --- /dev/null +++ b/clients/client-cleanroomsml/src/commands/GetMLInputChannelCommand.ts @@ -0,0 +1,149 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { CleanRoomsMLClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CleanRoomsMLClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { + GetMLInputChannelRequest, + GetMLInputChannelResponse, + GetMLInputChannelResponseFilterSensitiveLog, +} from "../models/models_0"; +import { de_GetMLInputChannelCommand, se_GetMLInputChannelCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link GetMLInputChannelCommand}. + */ +export interface GetMLInputChannelCommandInput extends GetMLInputChannelRequest {} +/** + * @public + * + * The output of {@link GetMLInputChannelCommand}. + */ +export interface GetMLInputChannelCommandOutput extends GetMLInputChannelResponse, __MetadataBearer {} + +/** + *Returns information about an ML input channel.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CleanRoomsMLClient, GetMLInputChannelCommand } from "@aws-sdk/client-cleanroomsml"; // ES Modules import + * // const { CleanRoomsMLClient, GetMLInputChannelCommand } = require("@aws-sdk/client-cleanroomsml"); // CommonJS import + * const client = new CleanRoomsMLClient(config); + * const input = { // GetMLInputChannelRequest + * mlInputChannelArn: "STRING_VALUE", // required + * membershipIdentifier: "STRING_VALUE", // required + * }; + * const command = new GetMLInputChannelCommand(input); + * const response = await client.send(command); + * // { // GetMLInputChannelResponse + * // createTime: new Date("TIMESTAMP"), // required + * // updateTime: new Date("TIMESTAMP"), // required + * // membershipIdentifier: "STRING_VALUE", // required + * // collaborationIdentifier: "STRING_VALUE", // required + * // inputChannel: { // InputChannel + * // dataSource: { // InputChannelDataSource Union: only one key present + * // protectedQueryInputParameters: { // ProtectedQueryInputParameters + * // sqlParameters: { // ProtectedQuerySQLParameters + * // queryString: "STRING_VALUE", + * // analysisTemplateArn: "STRING_VALUE", + * // parameters: { // ParameterMap + * // "You do not have sufficient access to perform this action.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource you are requesting does not exist.
+ * + * @throws {@link ValidationException} (client fault) + *The request parameters for this request are incorrect.
+ * + * @throws {@link CleanRoomsMLServiceException} + *Base exception class for all service exceptions from CleanRoomsML service.
+ * + * @public + */ +export class GetMLInputChannelCommand extends $Command + .classBuilder< + GetMLInputChannelCommandInput, + GetMLInputChannelCommandOutput, + CleanRoomsMLClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: CleanRoomsMLClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AWSStarkControlService", "GetMLInputChannel", {}) + .n("CleanRoomsMLClient", "GetMLInputChannelCommand") + .f(void 0, GetMLInputChannelResponseFilterSensitiveLog) + .ser(se_GetMLInputChannelCommand) + .de(de_GetMLInputChannelCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: GetMLInputChannelRequest; + output: GetMLInputChannelResponse; + }; + sdk: { + input: GetMLInputChannelCommandInput; + output: GetMLInputChannelCommandOutput; + }; + }; +} diff --git a/clients/client-cleanroomsml/src/commands/GetTrainedModelCommand.ts b/clients/client-cleanroomsml/src/commands/GetTrainedModelCommand.ts new file mode 100644 index 000000000000..efbfb8db13c9 --- /dev/null +++ b/clients/client-cleanroomsml/src/commands/GetTrainedModelCommand.ts @@ -0,0 +1,143 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { CleanRoomsMLClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CleanRoomsMLClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { GetTrainedModelRequest, GetTrainedModelResponse } from "../models/models_0"; +import { de_GetTrainedModelCommand, se_GetTrainedModelCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link GetTrainedModelCommand}. + */ +export interface GetTrainedModelCommandInput extends GetTrainedModelRequest {} +/** + * @public + * + * The output of {@link GetTrainedModelCommand}. + */ +export interface GetTrainedModelCommandOutput extends GetTrainedModelResponse, __MetadataBearer {} + +/** + *Returns information about a trained model.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CleanRoomsMLClient, GetTrainedModelCommand } from "@aws-sdk/client-cleanroomsml"; // ES Modules import + * // const { CleanRoomsMLClient, GetTrainedModelCommand } = require("@aws-sdk/client-cleanroomsml"); // CommonJS import + * const client = new CleanRoomsMLClient(config); + * const input = { // GetTrainedModelRequest + * trainedModelArn: "STRING_VALUE", // required + * membershipIdentifier: "STRING_VALUE", // required + * }; + * const command = new GetTrainedModelCommand(input); + * const response = await client.send(command); + * // { // GetTrainedModelResponse + * // membershipIdentifier: "STRING_VALUE", // required + * // collaborationIdentifier: "STRING_VALUE", // required + * // trainedModelArn: "STRING_VALUE", // required + * // name: "STRING_VALUE", // required + * // description: "STRING_VALUE", + * // status: "CREATE_PENDING" || "CREATE_IN_PROGRESS" || "CREATE_FAILED" || "ACTIVE" || "DELETE_PENDING" || "DELETE_IN_PROGRESS" || "DELETE_FAILED" || "INACTIVE" || "CANCEL_PENDING" || "CANCEL_IN_PROGRESS" || "CANCEL_FAILED", // required + * // statusDetails: { // StatusDetails + * // statusCode: "STRING_VALUE", + * // message: "STRING_VALUE", + * // }, + * // configuredModelAlgorithmAssociationArn: "STRING_VALUE", // required + * // resourceConfig: { // ResourceConfig + * // instanceCount: Number("int"), + * // instanceType: "ml.m4.xlarge" || "ml.m4.2xlarge" || "ml.m4.4xlarge" || "ml.m4.10xlarge" || "ml.m4.16xlarge" || "ml.g4dn.xlarge" || "ml.g4dn.2xlarge" || "ml.g4dn.4xlarge" || "ml.g4dn.8xlarge" || "ml.g4dn.12xlarge" || "ml.g4dn.16xlarge" || "ml.m5.large" || "ml.m5.xlarge" || "ml.m5.2xlarge" || "ml.m5.4xlarge" || "ml.m5.12xlarge" || "ml.m5.24xlarge" || "ml.c4.xlarge" || "ml.c4.2xlarge" || "ml.c4.4xlarge" || "ml.c4.8xlarge" || "ml.p2.xlarge" || "ml.p2.8xlarge" || "ml.p2.16xlarge" || "ml.p3.2xlarge" || "ml.p3.8xlarge" || "ml.p3.16xlarge" || "ml.p3dn.24xlarge" || "ml.p4d.24xlarge" || "ml.p4de.24xlarge" || "ml.p5.48xlarge" || "ml.c5.xlarge" || "ml.c5.2xlarge" || "ml.c5.4xlarge" || "ml.c5.9xlarge" || "ml.c5.18xlarge" || "ml.c5n.xlarge" || "ml.c5n.2xlarge" || "ml.c5n.4xlarge" || "ml.c5n.9xlarge" || "ml.c5n.18xlarge" || "ml.g5.xlarge" || "ml.g5.2xlarge" || "ml.g5.4xlarge" || "ml.g5.8xlarge" || "ml.g5.16xlarge" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.g5.48xlarge" || "ml.trn1.2xlarge" || "ml.trn1.32xlarge" || "ml.trn1n.32xlarge" || "ml.m6i.large" || "ml.m6i.xlarge" || "ml.m6i.2xlarge" || "ml.m6i.4xlarge" || "ml.m6i.8xlarge" || "ml.m6i.12xlarge" || "ml.m6i.16xlarge" || "ml.m6i.24xlarge" || "ml.m6i.32xlarge" || "ml.c6i.xlarge" || "ml.c6i.2xlarge" || "ml.c6i.8xlarge" || "ml.c6i.4xlarge" || "ml.c6i.12xlarge" || "ml.c6i.16xlarge" || "ml.c6i.24xlarge" || "ml.c6i.32xlarge" || "ml.r5d.large" || "ml.r5d.xlarge" || "ml.r5d.2xlarge" || "ml.r5d.4xlarge" || "ml.r5d.8xlarge" || "ml.r5d.12xlarge" || "ml.r5d.16xlarge" || "ml.r5d.24xlarge" || "ml.t3.medium" || "ml.t3.large" || "ml.t3.xlarge" || "ml.t3.2xlarge" || "ml.r5.large" || "ml.r5.xlarge" || "ml.r5.2xlarge" || "ml.r5.4xlarge" || "ml.r5.8xlarge" || "ml.r5.12xlarge" || "ml.r5.16xlarge" || "ml.r5.24xlarge", // required + * // volumeSizeInGB: Number("int"), // required + * // }, + * // stoppingCondition: { // StoppingCondition + * // maxRuntimeInSeconds: Number("int"), + * // }, + * // metricsStatus: "PUBLISH_SUCCEEDED" || "PUBLISH_FAILED", + * // metricsStatusDetails: "STRING_VALUE", + * // logsStatus: "PUBLISH_SUCCEEDED" || "PUBLISH_FAILED", + * // logsStatusDetails: "STRING_VALUE", + * // trainingContainerImageDigest: "STRING_VALUE", + * // createTime: new Date("TIMESTAMP"), // required + * // updateTime: new Date("TIMESTAMP"), // required + * // hyperparameters: { // HyperParameters + * // "You do not have sufficient access to perform this action.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource you are requesting does not exist.
+ * + * @throws {@link ValidationException} (client fault) + *The request parameters for this request are incorrect.
+ * + * @throws {@link CleanRoomsMLServiceException} + *Base exception class for all service exceptions from CleanRoomsML service.
+ * + * @public + */ +export class GetTrainedModelCommand extends $Command + .classBuilder< + GetTrainedModelCommandInput, + GetTrainedModelCommandOutput, + CleanRoomsMLClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: CleanRoomsMLClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AWSStarkControlService", "GetTrainedModel", {}) + .n("CleanRoomsMLClient", "GetTrainedModelCommand") + .f(void 0, void 0) + .ser(se_GetTrainedModelCommand) + .de(de_GetTrainedModelCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: GetTrainedModelRequest; + output: GetTrainedModelResponse; + }; + sdk: { + input: GetTrainedModelCommandInput; + output: GetTrainedModelCommandOutput; + }; + }; +} diff --git a/clients/client-cleanroomsml/src/commands/GetTrainedModelInferenceJobCommand.ts b/clients/client-cleanroomsml/src/commands/GetTrainedModelInferenceJobCommand.ts new file mode 100644 index 000000000000..0927b6e8192a --- /dev/null +++ b/clients/client-cleanroomsml/src/commands/GetTrainedModelInferenceJobCommand.ts @@ -0,0 +1,149 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { CleanRoomsMLClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CleanRoomsMLClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { GetTrainedModelInferenceJobRequest, GetTrainedModelInferenceJobResponse } from "../models/models_0"; +import { + de_GetTrainedModelInferenceJobCommand, + se_GetTrainedModelInferenceJobCommand, +} from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link GetTrainedModelInferenceJobCommand}. + */ +export interface GetTrainedModelInferenceJobCommandInput extends GetTrainedModelInferenceJobRequest {} +/** + * @public + * + * The output of {@link GetTrainedModelInferenceJobCommand}. + */ +export interface GetTrainedModelInferenceJobCommandOutput + extends GetTrainedModelInferenceJobResponse, + __MetadataBearer {} + +/** + *Returns information about a trained model inference job.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CleanRoomsMLClient, GetTrainedModelInferenceJobCommand } from "@aws-sdk/client-cleanroomsml"; // ES Modules import + * // const { CleanRoomsMLClient, GetTrainedModelInferenceJobCommand } = require("@aws-sdk/client-cleanroomsml"); // CommonJS import + * const client = new CleanRoomsMLClient(config); + * const input = { // GetTrainedModelInferenceJobRequest + * membershipIdentifier: "STRING_VALUE", // required + * trainedModelInferenceJobArn: "STRING_VALUE", // required + * }; + * const command = new GetTrainedModelInferenceJobCommand(input); + * const response = await client.send(command); + * // { // GetTrainedModelInferenceJobResponse + * // createTime: new Date("TIMESTAMP"), // required + * // updateTime: new Date("TIMESTAMP"), // required + * // trainedModelInferenceJobArn: "STRING_VALUE", // required + * // configuredModelAlgorithmAssociationArn: "STRING_VALUE", + * // name: "STRING_VALUE", // required + * // status: "CREATE_PENDING" || "CREATE_IN_PROGRESS" || "CREATE_FAILED" || "ACTIVE" || "CANCEL_PENDING" || "CANCEL_IN_PROGRESS" || "CANCEL_FAILED" || "INACTIVE", // required + * // trainedModelArn: "STRING_VALUE", // required + * // resourceConfig: { // InferenceResourceConfig + * // instanceType: "ml.r7i.48xlarge" || "ml.r6i.16xlarge" || "ml.m6i.xlarge" || "ml.m5.4xlarge" || "ml.p2.xlarge" || "ml.m4.16xlarge" || "ml.r7i.16xlarge" || "ml.m7i.xlarge" || "ml.m6i.12xlarge" || "ml.r7i.8xlarge" || "ml.r7i.large" || "ml.m7i.12xlarge" || "ml.m6i.24xlarge" || "ml.m7i.24xlarge" || "ml.r6i.8xlarge" || "ml.r6i.large" || "ml.g5.2xlarge" || "ml.m5.large" || "ml.p3.16xlarge" || "ml.m7i.48xlarge" || "ml.m6i.16xlarge" || "ml.p2.16xlarge" || "ml.g5.4xlarge" || "ml.m7i.16xlarge" || "ml.c4.2xlarge" || "ml.c5.2xlarge" || "ml.c6i.32xlarge" || "ml.c4.4xlarge" || "ml.g5.8xlarge" || "ml.c6i.xlarge" || "ml.c5.4xlarge" || "ml.g4dn.xlarge" || "ml.c7i.xlarge" || "ml.c6i.12xlarge" || "ml.g4dn.12xlarge" || "ml.c7i.12xlarge" || "ml.c6i.24xlarge" || "ml.g4dn.2xlarge" || "ml.c7i.24xlarge" || "ml.c7i.2xlarge" || "ml.c4.8xlarge" || "ml.c6i.2xlarge" || "ml.g4dn.4xlarge" || "ml.c7i.48xlarge" || "ml.c7i.4xlarge" || "ml.c6i.16xlarge" || "ml.c5.9xlarge" || "ml.g4dn.16xlarge" || "ml.c7i.16xlarge" || "ml.c6i.4xlarge" || "ml.c5.xlarge" || "ml.c4.xlarge" || "ml.g4dn.8xlarge" || "ml.c7i.8xlarge" || "ml.c7i.large" || "ml.g5.xlarge" || "ml.c6i.8xlarge" || "ml.c6i.large" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.m7i.2xlarge" || "ml.c5.18xlarge" || "ml.g5.48xlarge" || "ml.m6i.2xlarge" || "ml.g5.16xlarge" || "ml.m7i.4xlarge" || "ml.p3.2xlarge" || "ml.r6i.32xlarge" || "ml.m6i.4xlarge" || "ml.m5.xlarge" || "ml.m4.10xlarge" || "ml.r6i.xlarge" || "ml.m5.12xlarge" || "ml.m4.xlarge" || "ml.r7i.2xlarge" || "ml.r7i.xlarge" || "ml.r6i.12xlarge" || "ml.m5.24xlarge" || "ml.r7i.12xlarge" || "ml.m7i.8xlarge" || "ml.m7i.large" || "ml.r6i.24xlarge" || "ml.r6i.2xlarge" || "ml.m4.2xlarge" || "ml.r7i.24xlarge" || "ml.r7i.4xlarge" || "ml.m6i.8xlarge" || "ml.m6i.large" || "ml.m5.2xlarge" || "ml.p2.8xlarge" || "ml.r6i.4xlarge" || "ml.m6i.32xlarge" || "ml.p3.8xlarge" || "ml.m4.4xlarge", // required + * // instanceCount: Number("int"), + * // }, + * // outputConfiguration: { // InferenceOutputConfiguration + * // accept: "STRING_VALUE", + * // members: [ // InferenceReceiverMembers // required + * // { // InferenceReceiverMember + * // accountId: "STRING_VALUE", // required + * // }, + * // ], + * // }, + * // membershipIdentifier: "STRING_VALUE", // required + * // dataSource: { // ModelInferenceDataSource + * // mlInputChannelArn: "STRING_VALUE", // required + * // }, + * // containerExecutionParameters: { // InferenceContainerExecutionParameters + * // maxPayloadInMB: Number("int"), + * // }, + * // statusDetails: { // StatusDetails + * // statusCode: "STRING_VALUE", + * // message: "STRING_VALUE", + * // }, + * // description: "STRING_VALUE", + * // inferenceContainerImageDigest: "STRING_VALUE", + * // environment: { // InferenceEnvironmentMap + * // "You do not have sufficient access to perform this action.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource you are requesting does not exist.
+ * + * @throws {@link ValidationException} (client fault) + *The request parameters for this request are incorrect.
+ * + * @throws {@link CleanRoomsMLServiceException} + *Base exception class for all service exceptions from CleanRoomsML service.
+ * + * @public + */ +export class GetTrainedModelInferenceJobCommand extends $Command + .classBuilder< + GetTrainedModelInferenceJobCommandInput, + GetTrainedModelInferenceJobCommandOutput, + CleanRoomsMLClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: CleanRoomsMLClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AWSStarkControlService", "GetTrainedModelInferenceJob", {}) + .n("CleanRoomsMLClient", "GetTrainedModelInferenceJobCommand") + .f(void 0, void 0) + .ser(se_GetTrainedModelInferenceJobCommand) + .de(de_GetTrainedModelInferenceJobCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: GetTrainedModelInferenceJobRequest; + output: GetTrainedModelInferenceJobResponse; + }; + sdk: { + input: GetTrainedModelInferenceJobCommandInput; + output: GetTrainedModelInferenceJobCommandOutput; + }; + }; +} diff --git a/clients/client-cleanroomsml/src/commands/ListCollaborationConfiguredModelAlgorithmAssociationsCommand.ts b/clients/client-cleanroomsml/src/commands/ListCollaborationConfiguredModelAlgorithmAssociationsCommand.ts new file mode 100644 index 000000000000..80f51ce5888a --- /dev/null +++ b/clients/client-cleanroomsml/src/commands/ListCollaborationConfiguredModelAlgorithmAssociationsCommand.ts @@ -0,0 +1,122 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { CleanRoomsMLClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CleanRoomsMLClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { + ListCollaborationConfiguredModelAlgorithmAssociationsRequest, + ListCollaborationConfiguredModelAlgorithmAssociationsResponse, +} from "../models/models_0"; +import { + de_ListCollaborationConfiguredModelAlgorithmAssociationsCommand, + se_ListCollaborationConfiguredModelAlgorithmAssociationsCommand, +} from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link ListCollaborationConfiguredModelAlgorithmAssociationsCommand}. + */ +export interface ListCollaborationConfiguredModelAlgorithmAssociationsCommandInput + extends ListCollaborationConfiguredModelAlgorithmAssociationsRequest {} +/** + * @public + * + * The output of {@link ListCollaborationConfiguredModelAlgorithmAssociationsCommand}. + */ +export interface ListCollaborationConfiguredModelAlgorithmAssociationsCommandOutput + extends ListCollaborationConfiguredModelAlgorithmAssociationsResponse, + __MetadataBearer {} + +/** + *Returns a list of the configured model algorithm associations in a collaboration.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CleanRoomsMLClient, ListCollaborationConfiguredModelAlgorithmAssociationsCommand } from "@aws-sdk/client-cleanroomsml"; // ES Modules import + * // const { CleanRoomsMLClient, ListCollaborationConfiguredModelAlgorithmAssociationsCommand } = require("@aws-sdk/client-cleanroomsml"); // CommonJS import + * const client = new CleanRoomsMLClient(config); + * const input = { // ListCollaborationConfiguredModelAlgorithmAssociationsRequest + * nextToken: "STRING_VALUE", + * maxResults: Number("int"), + * collaborationIdentifier: "STRING_VALUE", // required + * }; + * const command = new ListCollaborationConfiguredModelAlgorithmAssociationsCommand(input); + * const response = await client.send(command); + * // { // ListCollaborationConfiguredModelAlgorithmAssociationsResponse + * // nextToken: "STRING_VALUE", + * // collaborationConfiguredModelAlgorithmAssociations: [ // CollaborationConfiguredModelAlgorithmAssociationList // required + * // { // CollaborationConfiguredModelAlgorithmAssociationSummary + * // createTime: new Date("TIMESTAMP"), // required + * // updateTime: new Date("TIMESTAMP"), // required + * // configuredModelAlgorithmAssociationArn: "STRING_VALUE", // required + * // name: "STRING_VALUE", // required + * // description: "STRING_VALUE", + * // membershipIdentifier: "STRING_VALUE", // required + * // collaborationIdentifier: "STRING_VALUE", // required + * // configuredModelAlgorithmArn: "STRING_VALUE", // required + * // creatorAccountId: "STRING_VALUE", // required + * // }, + * // ], + * // }; + * + * ``` + * + * @param ListCollaborationConfiguredModelAlgorithmAssociationsCommandInput - {@link ListCollaborationConfiguredModelAlgorithmAssociationsCommandInput} + * @returns {@link ListCollaborationConfiguredModelAlgorithmAssociationsCommandOutput} + * @see {@link ListCollaborationConfiguredModelAlgorithmAssociationsCommandInput} for command's `input` shape. + * @see {@link ListCollaborationConfiguredModelAlgorithmAssociationsCommandOutput} for command's `response` shape. + * @see {@link CleanRoomsMLClientResolvedConfig | config} for CleanRoomsMLClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You do not have sufficient access to perform this action.
+ * + * @throws {@link ValidationException} (client fault) + *The request parameters for this request are incorrect.
+ * + * @throws {@link CleanRoomsMLServiceException} + *Base exception class for all service exceptions from CleanRoomsML service.
+ * + * @public + */ +export class ListCollaborationConfiguredModelAlgorithmAssociationsCommand extends $Command + .classBuilder< + ListCollaborationConfiguredModelAlgorithmAssociationsCommandInput, + ListCollaborationConfiguredModelAlgorithmAssociationsCommandOutput, + CleanRoomsMLClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: CleanRoomsMLClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AWSStarkControlService", "ListCollaborationConfiguredModelAlgorithmAssociations", {}) + .n("CleanRoomsMLClient", "ListCollaborationConfiguredModelAlgorithmAssociationsCommand") + .f(void 0, void 0) + .ser(se_ListCollaborationConfiguredModelAlgorithmAssociationsCommand) + .de(de_ListCollaborationConfiguredModelAlgorithmAssociationsCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: ListCollaborationConfiguredModelAlgorithmAssociationsRequest; + output: ListCollaborationConfiguredModelAlgorithmAssociationsResponse; + }; + sdk: { + input: ListCollaborationConfiguredModelAlgorithmAssociationsCommandInput; + output: ListCollaborationConfiguredModelAlgorithmAssociationsCommandOutput; + }; + }; +} diff --git a/clients/client-cleanroomsml/src/commands/ListCollaborationMLInputChannelsCommand.ts b/clients/client-cleanroomsml/src/commands/ListCollaborationMLInputChannelsCommand.ts new file mode 100644 index 000000000000..c1bc2c6d05d6 --- /dev/null +++ b/clients/client-cleanroomsml/src/commands/ListCollaborationMLInputChannelsCommand.ts @@ -0,0 +1,121 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { CleanRoomsMLClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CleanRoomsMLClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { ListCollaborationMLInputChannelsRequest, ListCollaborationMLInputChannelsResponse } from "../models/models_0"; +import { + de_ListCollaborationMLInputChannelsCommand, + se_ListCollaborationMLInputChannelsCommand, +} from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link ListCollaborationMLInputChannelsCommand}. + */ +export interface ListCollaborationMLInputChannelsCommandInput extends ListCollaborationMLInputChannelsRequest {} +/** + * @public + * + * The output of {@link ListCollaborationMLInputChannelsCommand}. + */ +export interface ListCollaborationMLInputChannelsCommandOutput + extends ListCollaborationMLInputChannelsResponse, + __MetadataBearer {} + +/** + *Returns a list of the ML input channels in a collaboration.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CleanRoomsMLClient, ListCollaborationMLInputChannelsCommand } from "@aws-sdk/client-cleanroomsml"; // ES Modules import + * // const { CleanRoomsMLClient, ListCollaborationMLInputChannelsCommand } = require("@aws-sdk/client-cleanroomsml"); // CommonJS import + * const client = new CleanRoomsMLClient(config); + * const input = { // ListCollaborationMLInputChannelsRequest + * nextToken: "STRING_VALUE", + * maxResults: Number("int"), + * collaborationIdentifier: "STRING_VALUE", // required + * }; + * const command = new ListCollaborationMLInputChannelsCommand(input); + * const response = await client.send(command); + * // { // ListCollaborationMLInputChannelsResponse + * // nextToken: "STRING_VALUE", + * // collaborationMLInputChannelsList: [ // CollaborationMLInputChannelsList // required + * // { // CollaborationMLInputChannelSummary + * // createTime: new Date("TIMESTAMP"), // required + * // updateTime: new Date("TIMESTAMP"), // required + * // membershipIdentifier: "STRING_VALUE", // required + * // collaborationIdentifier: "STRING_VALUE", // required + * // name: "STRING_VALUE", // required + * // configuredModelAlgorithmAssociations: [ // ConfiguredModelAlgorithmAssociationArnList // required + * // "STRING_VALUE", + * // ], + * // mlInputChannelArn: "STRING_VALUE", // required + * // status: "CREATE_PENDING" || "CREATE_IN_PROGRESS" || "CREATE_FAILED" || "ACTIVE" || "DELETE_PENDING" || "DELETE_IN_PROGRESS" || "DELETE_FAILED" || "INACTIVE", // required + * // creatorAccountId: "STRING_VALUE", // required + * // description: "STRING_VALUE", + * // }, + * // ], + * // }; + * + * ``` + * + * @param ListCollaborationMLInputChannelsCommandInput - {@link ListCollaborationMLInputChannelsCommandInput} + * @returns {@link ListCollaborationMLInputChannelsCommandOutput} + * @see {@link ListCollaborationMLInputChannelsCommandInput} for command's `input` shape. + * @see {@link ListCollaborationMLInputChannelsCommandOutput} for command's `response` shape. + * @see {@link CleanRoomsMLClientResolvedConfig | config} for CleanRoomsMLClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You do not have sufficient access to perform this action.
+ * + * @throws {@link ValidationException} (client fault) + *The request parameters for this request are incorrect.
+ * + * @throws {@link CleanRoomsMLServiceException} + *Base exception class for all service exceptions from CleanRoomsML service.
+ * + * @public + */ +export class ListCollaborationMLInputChannelsCommand extends $Command + .classBuilder< + ListCollaborationMLInputChannelsCommandInput, + ListCollaborationMLInputChannelsCommandOutput, + CleanRoomsMLClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: CleanRoomsMLClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AWSStarkControlService", "ListCollaborationMLInputChannels", {}) + .n("CleanRoomsMLClient", "ListCollaborationMLInputChannelsCommand") + .f(void 0, void 0) + .ser(se_ListCollaborationMLInputChannelsCommand) + .de(de_ListCollaborationMLInputChannelsCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: ListCollaborationMLInputChannelsRequest; + output: ListCollaborationMLInputChannelsResponse; + }; + sdk: { + input: ListCollaborationMLInputChannelsCommandInput; + output: ListCollaborationMLInputChannelsCommandOutput; + }; + }; +} diff --git a/clients/client-cleanroomsml/src/commands/ListCollaborationTrainedModelExportJobsCommand.ts b/clients/client-cleanroomsml/src/commands/ListCollaborationTrainedModelExportJobsCommand.ts new file mode 100644 index 000000000000..bce87da5df19 --- /dev/null +++ b/clients/client-cleanroomsml/src/commands/ListCollaborationTrainedModelExportJobsCommand.ts @@ -0,0 +1,134 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { CleanRoomsMLClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CleanRoomsMLClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { + ListCollaborationTrainedModelExportJobsRequest, + ListCollaborationTrainedModelExportJobsResponse, +} from "../models/models_0"; +import { + de_ListCollaborationTrainedModelExportJobsCommand, + se_ListCollaborationTrainedModelExportJobsCommand, +} from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link ListCollaborationTrainedModelExportJobsCommand}. + */ +export interface ListCollaborationTrainedModelExportJobsCommandInput + extends ListCollaborationTrainedModelExportJobsRequest {} +/** + * @public + * + * The output of {@link ListCollaborationTrainedModelExportJobsCommand}. + */ +export interface ListCollaborationTrainedModelExportJobsCommandOutput + extends ListCollaborationTrainedModelExportJobsResponse, + __MetadataBearer {} + +/** + *Returns a list of the export jobs for a trained model in a collaboration.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CleanRoomsMLClient, ListCollaborationTrainedModelExportJobsCommand } from "@aws-sdk/client-cleanroomsml"; // ES Modules import + * // const { CleanRoomsMLClient, ListCollaborationTrainedModelExportJobsCommand } = require("@aws-sdk/client-cleanroomsml"); // CommonJS import + * const client = new CleanRoomsMLClient(config); + * const input = { // ListCollaborationTrainedModelExportJobsRequest + * nextToken: "STRING_VALUE", + * maxResults: Number("int"), + * collaborationIdentifier: "STRING_VALUE", // required + * trainedModelArn: "STRING_VALUE", // required + * }; + * const command = new ListCollaborationTrainedModelExportJobsCommand(input); + * const response = await client.send(command); + * // { // ListCollaborationTrainedModelExportJobsResponse + * // nextToken: "STRING_VALUE", + * // collaborationTrainedModelExportJobs: [ // CollaborationTrainedModelExportJobList // required + * // { // CollaborationTrainedModelExportJobSummary + * // createTime: new Date("TIMESTAMP"), // required + * // updateTime: new Date("TIMESTAMP"), // required + * // name: "STRING_VALUE", // required + * // outputConfiguration: { // TrainedModelExportOutputConfiguration + * // members: [ // TrainedModelExportReceiverMembers // required + * // { // TrainedModelExportReceiverMember + * // accountId: "STRING_VALUE", // required + * // }, + * // ], + * // }, + * // status: "CREATE_PENDING" || "CREATE_IN_PROGRESS" || "CREATE_FAILED" || "ACTIVE", // required + * // statusDetails: { // StatusDetails + * // statusCode: "STRING_VALUE", + * // message: "STRING_VALUE", + * // }, + * // description: "STRING_VALUE", + * // creatorAccountId: "STRING_VALUE", // required + * // trainedModelArn: "STRING_VALUE", // required + * // membershipIdentifier: "STRING_VALUE", // required + * // collaborationIdentifier: "STRING_VALUE", // required + * // }, + * // ], + * // }; + * + * ``` + * + * @param ListCollaborationTrainedModelExportJobsCommandInput - {@link ListCollaborationTrainedModelExportJobsCommandInput} + * @returns {@link ListCollaborationTrainedModelExportJobsCommandOutput} + * @see {@link ListCollaborationTrainedModelExportJobsCommandInput} for command's `input` shape. + * @see {@link ListCollaborationTrainedModelExportJobsCommandOutput} for command's `response` shape. + * @see {@link CleanRoomsMLClientResolvedConfig | config} for CleanRoomsMLClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You do not have sufficient access to perform this action.
+ * + * @throws {@link ValidationException} (client fault) + *The request parameters for this request are incorrect.
+ * + * @throws {@link CleanRoomsMLServiceException} + *Base exception class for all service exceptions from CleanRoomsML service.
+ * + * @public + */ +export class ListCollaborationTrainedModelExportJobsCommand extends $Command + .classBuilder< + ListCollaborationTrainedModelExportJobsCommandInput, + ListCollaborationTrainedModelExportJobsCommandOutput, + CleanRoomsMLClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: CleanRoomsMLClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AWSStarkControlService", "ListCollaborationTrainedModelExportJobs", {}) + .n("CleanRoomsMLClient", "ListCollaborationTrainedModelExportJobsCommand") + .f(void 0, void 0) + .ser(se_ListCollaborationTrainedModelExportJobsCommand) + .de(de_ListCollaborationTrainedModelExportJobsCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: ListCollaborationTrainedModelExportJobsRequest; + output: ListCollaborationTrainedModelExportJobsResponse; + }; + sdk: { + input: ListCollaborationTrainedModelExportJobsCommandInput; + output: ListCollaborationTrainedModelExportJobsCommandOutput; + }; + }; +} diff --git a/clients/client-cleanroomsml/src/commands/ListCollaborationTrainedModelInferenceJobsCommand.ts b/clients/client-cleanroomsml/src/commands/ListCollaborationTrainedModelInferenceJobsCommand.ts new file mode 100644 index 000000000000..4bd370021d2b --- /dev/null +++ b/clients/client-cleanroomsml/src/commands/ListCollaborationTrainedModelInferenceJobsCommand.ts @@ -0,0 +1,137 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { CleanRoomsMLClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CleanRoomsMLClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { + ListCollaborationTrainedModelInferenceJobsRequest, + ListCollaborationTrainedModelInferenceJobsResponse, +} from "../models/models_0"; +import { + de_ListCollaborationTrainedModelInferenceJobsCommand, + se_ListCollaborationTrainedModelInferenceJobsCommand, +} from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link ListCollaborationTrainedModelInferenceJobsCommand}. + */ +export interface ListCollaborationTrainedModelInferenceJobsCommandInput + extends ListCollaborationTrainedModelInferenceJobsRequest {} +/** + * @public + * + * The output of {@link ListCollaborationTrainedModelInferenceJobsCommand}. + */ +export interface ListCollaborationTrainedModelInferenceJobsCommandOutput + extends ListCollaborationTrainedModelInferenceJobsResponse, + __MetadataBearer {} + +/** + *Returns a list of trained model inference jobs in a specified collaboration.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CleanRoomsMLClient, ListCollaborationTrainedModelInferenceJobsCommand } from "@aws-sdk/client-cleanroomsml"; // ES Modules import + * // const { CleanRoomsMLClient, ListCollaborationTrainedModelInferenceJobsCommand } = require("@aws-sdk/client-cleanroomsml"); // CommonJS import + * const client = new CleanRoomsMLClient(config); + * const input = { // ListCollaborationTrainedModelInferenceJobsRequest + * nextToken: "STRING_VALUE", + * maxResults: Number("int"), + * collaborationIdentifier: "STRING_VALUE", // required + * trainedModelArn: "STRING_VALUE", + * }; + * const command = new ListCollaborationTrainedModelInferenceJobsCommand(input); + * const response = await client.send(command); + * // { // ListCollaborationTrainedModelInferenceJobsResponse + * // nextToken: "STRING_VALUE", + * // collaborationTrainedModelInferenceJobs: [ // CollaborationTrainedModelInferenceJobList // required + * // { // CollaborationTrainedModelInferenceJobSummary + * // trainedModelInferenceJobArn: "STRING_VALUE", // required + * // configuredModelAlgorithmAssociationArn: "STRING_VALUE", + * // membershipIdentifier: "STRING_VALUE", // required + * // trainedModelArn: "STRING_VALUE", // required + * // collaborationIdentifier: "STRING_VALUE", // required + * // status: "CREATE_PENDING" || "CREATE_IN_PROGRESS" || "CREATE_FAILED" || "ACTIVE" || "CANCEL_PENDING" || "CANCEL_IN_PROGRESS" || "CANCEL_FAILED" || "INACTIVE", // required + * // outputConfiguration: { // InferenceOutputConfiguration + * // accept: "STRING_VALUE", + * // members: [ // InferenceReceiverMembers // required + * // { // InferenceReceiverMember + * // accountId: "STRING_VALUE", // required + * // }, + * // ], + * // }, + * // name: "STRING_VALUE", // required + * // description: "STRING_VALUE", + * // metricsStatus: "PUBLISH_SUCCEEDED" || "PUBLISH_FAILED", + * // metricsStatusDetails: "STRING_VALUE", + * // logsStatus: "PUBLISH_SUCCEEDED" || "PUBLISH_FAILED", + * // logsStatusDetails: "STRING_VALUE", + * // createTime: new Date("TIMESTAMP"), // required + * // updateTime: new Date("TIMESTAMP"), // required + * // creatorAccountId: "STRING_VALUE", // required + * // }, + * // ], + * // }; + * + * ``` + * + * @param ListCollaborationTrainedModelInferenceJobsCommandInput - {@link ListCollaborationTrainedModelInferenceJobsCommandInput} + * @returns {@link ListCollaborationTrainedModelInferenceJobsCommandOutput} + * @see {@link ListCollaborationTrainedModelInferenceJobsCommandInput} for command's `input` shape. + * @see {@link ListCollaborationTrainedModelInferenceJobsCommandOutput} for command's `response` shape. + * @see {@link CleanRoomsMLClientResolvedConfig | config} for CleanRoomsMLClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You do not have sufficient access to perform this action.
+ * + * @throws {@link ValidationException} (client fault) + *The request parameters for this request are incorrect.
+ * + * @throws {@link CleanRoomsMLServiceException} + *Base exception class for all service exceptions from CleanRoomsML service.
+ * + * @public + */ +export class ListCollaborationTrainedModelInferenceJobsCommand extends $Command + .classBuilder< + ListCollaborationTrainedModelInferenceJobsCommandInput, + ListCollaborationTrainedModelInferenceJobsCommandOutput, + CleanRoomsMLClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: CleanRoomsMLClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AWSStarkControlService", "ListCollaborationTrainedModelInferenceJobs", {}) + .n("CleanRoomsMLClient", "ListCollaborationTrainedModelInferenceJobsCommand") + .f(void 0, void 0) + .ser(se_ListCollaborationTrainedModelInferenceJobsCommand) + .de(de_ListCollaborationTrainedModelInferenceJobsCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: ListCollaborationTrainedModelInferenceJobsRequest; + output: ListCollaborationTrainedModelInferenceJobsResponse; + }; + sdk: { + input: ListCollaborationTrainedModelInferenceJobsCommandInput; + output: ListCollaborationTrainedModelInferenceJobsCommandOutput; + }; + }; +} diff --git a/clients/client-cleanroomsml/src/commands/ListCollaborationTrainedModelsCommand.ts b/clients/client-cleanroomsml/src/commands/ListCollaborationTrainedModelsCommand.ts new file mode 100644 index 000000000000..60590eb0c31e --- /dev/null +++ b/clients/client-cleanroomsml/src/commands/ListCollaborationTrainedModelsCommand.ts @@ -0,0 +1,119 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { CleanRoomsMLClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CleanRoomsMLClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { ListCollaborationTrainedModelsRequest, ListCollaborationTrainedModelsResponse } from "../models/models_0"; +import { + de_ListCollaborationTrainedModelsCommand, + se_ListCollaborationTrainedModelsCommand, +} from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link ListCollaborationTrainedModelsCommand}. + */ +export interface ListCollaborationTrainedModelsCommandInput extends ListCollaborationTrainedModelsRequest {} +/** + * @public + * + * The output of {@link ListCollaborationTrainedModelsCommand}. + */ +export interface ListCollaborationTrainedModelsCommandOutput + extends ListCollaborationTrainedModelsResponse, + __MetadataBearer {} + +/** + *Returns a list of the trained models in a collaboration.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CleanRoomsMLClient, ListCollaborationTrainedModelsCommand } from "@aws-sdk/client-cleanroomsml"; // ES Modules import + * // const { CleanRoomsMLClient, ListCollaborationTrainedModelsCommand } = require("@aws-sdk/client-cleanroomsml"); // CommonJS import + * const client = new CleanRoomsMLClient(config); + * const input = { // ListCollaborationTrainedModelsRequest + * nextToken: "STRING_VALUE", + * maxResults: Number("int"), + * collaborationIdentifier: "STRING_VALUE", // required + * }; + * const command = new ListCollaborationTrainedModelsCommand(input); + * const response = await client.send(command); + * // { // ListCollaborationTrainedModelsResponse + * // nextToken: "STRING_VALUE", + * // collaborationTrainedModels: [ // CollaborationTrainedModelList // required + * // { // CollaborationTrainedModelSummary + * // createTime: new Date("TIMESTAMP"), // required + * // updateTime: new Date("TIMESTAMP"), // required + * // trainedModelArn: "STRING_VALUE", // required + * // name: "STRING_VALUE", // required + * // description: "STRING_VALUE", + * // membershipIdentifier: "STRING_VALUE", // required + * // collaborationIdentifier: "STRING_VALUE", // required + * // status: "CREATE_PENDING" || "CREATE_IN_PROGRESS" || "CREATE_FAILED" || "ACTIVE" || "DELETE_PENDING" || "DELETE_IN_PROGRESS" || "DELETE_FAILED" || "INACTIVE" || "CANCEL_PENDING" || "CANCEL_IN_PROGRESS" || "CANCEL_FAILED", // required + * // configuredModelAlgorithmAssociationArn: "STRING_VALUE", // required + * // creatorAccountId: "STRING_VALUE", // required + * // }, + * // ], + * // }; + * + * ``` + * + * @param ListCollaborationTrainedModelsCommandInput - {@link ListCollaborationTrainedModelsCommandInput} + * @returns {@link ListCollaborationTrainedModelsCommandOutput} + * @see {@link ListCollaborationTrainedModelsCommandInput} for command's `input` shape. + * @see {@link ListCollaborationTrainedModelsCommandOutput} for command's `response` shape. + * @see {@link CleanRoomsMLClientResolvedConfig | config} for CleanRoomsMLClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You do not have sufficient access to perform this action.
+ * + * @throws {@link ValidationException} (client fault) + *The request parameters for this request are incorrect.
+ * + * @throws {@link CleanRoomsMLServiceException} + *Base exception class for all service exceptions from CleanRoomsML service.
+ * + * @public + */ +export class ListCollaborationTrainedModelsCommand extends $Command + .classBuilder< + ListCollaborationTrainedModelsCommandInput, + ListCollaborationTrainedModelsCommandOutput, + CleanRoomsMLClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: CleanRoomsMLClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AWSStarkControlService", "ListCollaborationTrainedModels", {}) + .n("CleanRoomsMLClient", "ListCollaborationTrainedModelsCommand") + .f(void 0, void 0) + .ser(se_ListCollaborationTrainedModelsCommand) + .de(de_ListCollaborationTrainedModelsCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: ListCollaborationTrainedModelsRequest; + output: ListCollaborationTrainedModelsResponse; + }; + sdk: { + input: ListCollaborationTrainedModelsCommandInput; + output: ListCollaborationTrainedModelsCommandOutput; + }; + }; +} diff --git a/clients/client-cleanroomsml/src/commands/ListConfiguredModelAlgorithmAssociationsCommand.ts b/clients/client-cleanroomsml/src/commands/ListConfiguredModelAlgorithmAssociationsCommand.ts new file mode 100644 index 000000000000..0d1d226687ca --- /dev/null +++ b/clients/client-cleanroomsml/src/commands/ListConfiguredModelAlgorithmAssociationsCommand.ts @@ -0,0 +1,121 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { CleanRoomsMLClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CleanRoomsMLClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { + ListConfiguredModelAlgorithmAssociationsRequest, + ListConfiguredModelAlgorithmAssociationsResponse, +} from "../models/models_0"; +import { + de_ListConfiguredModelAlgorithmAssociationsCommand, + se_ListConfiguredModelAlgorithmAssociationsCommand, +} from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link ListConfiguredModelAlgorithmAssociationsCommand}. + */ +export interface ListConfiguredModelAlgorithmAssociationsCommandInput + extends ListConfiguredModelAlgorithmAssociationsRequest {} +/** + * @public + * + * The output of {@link ListConfiguredModelAlgorithmAssociationsCommand}. + */ +export interface ListConfiguredModelAlgorithmAssociationsCommandOutput + extends ListConfiguredModelAlgorithmAssociationsResponse, + __MetadataBearer {} + +/** + *Returns a list of configured model algorithm associations.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CleanRoomsMLClient, ListConfiguredModelAlgorithmAssociationsCommand } from "@aws-sdk/client-cleanroomsml"; // ES Modules import + * // const { CleanRoomsMLClient, ListConfiguredModelAlgorithmAssociationsCommand } = require("@aws-sdk/client-cleanroomsml"); // CommonJS import + * const client = new CleanRoomsMLClient(config); + * const input = { // ListConfiguredModelAlgorithmAssociationsRequest + * nextToken: "STRING_VALUE", + * maxResults: Number("int"), + * membershipIdentifier: "STRING_VALUE", // required + * }; + * const command = new ListConfiguredModelAlgorithmAssociationsCommand(input); + * const response = await client.send(command); + * // { // ListConfiguredModelAlgorithmAssociationsResponse + * // nextToken: "STRING_VALUE", + * // configuredModelAlgorithmAssociations: [ // ConfiguredModelAlgorithmAssociationList // required + * // { // ConfiguredModelAlgorithmAssociationSummary + * // createTime: new Date("TIMESTAMP"), // required + * // updateTime: new Date("TIMESTAMP"), // required + * // configuredModelAlgorithmAssociationArn: "STRING_VALUE", // required + * // configuredModelAlgorithmArn: "STRING_VALUE", // required + * // name: "STRING_VALUE", // required + * // description: "STRING_VALUE", + * // membershipIdentifier: "STRING_VALUE", // required + * // collaborationIdentifier: "STRING_VALUE", // required + * // }, + * // ], + * // }; + * + * ``` + * + * @param ListConfiguredModelAlgorithmAssociationsCommandInput - {@link ListConfiguredModelAlgorithmAssociationsCommandInput} + * @returns {@link ListConfiguredModelAlgorithmAssociationsCommandOutput} + * @see {@link ListConfiguredModelAlgorithmAssociationsCommandInput} for command's `input` shape. + * @see {@link ListConfiguredModelAlgorithmAssociationsCommandOutput} for command's `response` shape. + * @see {@link CleanRoomsMLClientResolvedConfig | config} for CleanRoomsMLClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You do not have sufficient access to perform this action.
+ * + * @throws {@link ValidationException} (client fault) + *The request parameters for this request are incorrect.
+ * + * @throws {@link CleanRoomsMLServiceException} + *Base exception class for all service exceptions from CleanRoomsML service.
+ * + * @public + */ +export class ListConfiguredModelAlgorithmAssociationsCommand extends $Command + .classBuilder< + ListConfiguredModelAlgorithmAssociationsCommandInput, + ListConfiguredModelAlgorithmAssociationsCommandOutput, + CleanRoomsMLClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: CleanRoomsMLClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AWSStarkControlService", "ListConfiguredModelAlgorithmAssociations", {}) + .n("CleanRoomsMLClient", "ListConfiguredModelAlgorithmAssociationsCommand") + .f(void 0, void 0) + .ser(se_ListConfiguredModelAlgorithmAssociationsCommand) + .de(de_ListConfiguredModelAlgorithmAssociationsCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: ListConfiguredModelAlgorithmAssociationsRequest; + output: ListConfiguredModelAlgorithmAssociationsResponse; + }; + sdk: { + input: ListConfiguredModelAlgorithmAssociationsCommandInput; + output: ListConfiguredModelAlgorithmAssociationsCommandOutput; + }; + }; +} diff --git a/clients/client-cleanroomsml/src/commands/ListConfiguredModelAlgorithmsCommand.ts b/clients/client-cleanroomsml/src/commands/ListConfiguredModelAlgorithmsCommand.ts new file mode 100644 index 000000000000..26de26b787d7 --- /dev/null +++ b/clients/client-cleanroomsml/src/commands/ListConfiguredModelAlgorithmsCommand.ts @@ -0,0 +1,113 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { CleanRoomsMLClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CleanRoomsMLClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { ListConfiguredModelAlgorithmsRequest, ListConfiguredModelAlgorithmsResponse } from "../models/models_0"; +import { + de_ListConfiguredModelAlgorithmsCommand, + se_ListConfiguredModelAlgorithmsCommand, +} from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link ListConfiguredModelAlgorithmsCommand}. + */ +export interface ListConfiguredModelAlgorithmsCommandInput extends ListConfiguredModelAlgorithmsRequest {} +/** + * @public + * + * The output of {@link ListConfiguredModelAlgorithmsCommand}. + */ +export interface ListConfiguredModelAlgorithmsCommandOutput + extends ListConfiguredModelAlgorithmsResponse, + __MetadataBearer {} + +/** + *Returns a list of configured model algorithms.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CleanRoomsMLClient, ListConfiguredModelAlgorithmsCommand } from "@aws-sdk/client-cleanroomsml"; // ES Modules import + * // const { CleanRoomsMLClient, ListConfiguredModelAlgorithmsCommand } = require("@aws-sdk/client-cleanroomsml"); // CommonJS import + * const client = new CleanRoomsMLClient(config); + * const input = { // ListConfiguredModelAlgorithmsRequest + * nextToken: "STRING_VALUE", + * maxResults: Number("int"), + * }; + * const command = new ListConfiguredModelAlgorithmsCommand(input); + * const response = await client.send(command); + * // { // ListConfiguredModelAlgorithmsResponse + * // nextToken: "STRING_VALUE", + * // configuredModelAlgorithms: [ // ConfiguredModelAlgorithmList // required + * // { // ConfiguredModelAlgorithmSummary + * // createTime: new Date("TIMESTAMP"), // required + * // updateTime: new Date("TIMESTAMP"), // required + * // configuredModelAlgorithmArn: "STRING_VALUE", // required + * // name: "STRING_VALUE", // required + * // description: "STRING_VALUE", + * // }, + * // ], + * // }; + * + * ``` + * + * @param ListConfiguredModelAlgorithmsCommandInput - {@link ListConfiguredModelAlgorithmsCommandInput} + * @returns {@link ListConfiguredModelAlgorithmsCommandOutput} + * @see {@link ListConfiguredModelAlgorithmsCommandInput} for command's `input` shape. + * @see {@link ListConfiguredModelAlgorithmsCommandOutput} for command's `response` shape. + * @see {@link CleanRoomsMLClientResolvedConfig | config} for CleanRoomsMLClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You do not have sufficient access to perform this action.
+ * + * @throws {@link ValidationException} (client fault) + *The request parameters for this request are incorrect.
+ * + * @throws {@link CleanRoomsMLServiceException} + *Base exception class for all service exceptions from CleanRoomsML service.
+ * + * @public + */ +export class ListConfiguredModelAlgorithmsCommand extends $Command + .classBuilder< + ListConfiguredModelAlgorithmsCommandInput, + ListConfiguredModelAlgorithmsCommandOutput, + CleanRoomsMLClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: CleanRoomsMLClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AWSStarkControlService", "ListConfiguredModelAlgorithms", {}) + .n("CleanRoomsMLClient", "ListConfiguredModelAlgorithmsCommand") + .f(void 0, void 0) + .ser(se_ListConfiguredModelAlgorithmsCommand) + .de(de_ListConfiguredModelAlgorithmsCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: ListConfiguredModelAlgorithmsRequest; + output: ListConfiguredModelAlgorithmsResponse; + }; + sdk: { + input: ListConfiguredModelAlgorithmsCommandInput; + output: ListConfiguredModelAlgorithmsCommandOutput; + }; + }; +} diff --git a/clients/client-cleanroomsml/src/commands/ListMLInputChannelsCommand.ts b/clients/client-cleanroomsml/src/commands/ListMLInputChannelsCommand.ts new file mode 100644 index 000000000000..818353e79dce --- /dev/null +++ b/clients/client-cleanroomsml/src/commands/ListMLInputChannelsCommand.ts @@ -0,0 +1,116 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { CleanRoomsMLClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CleanRoomsMLClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { ListMLInputChannelsRequest, ListMLInputChannelsResponse } from "../models/models_0"; +import { de_ListMLInputChannelsCommand, se_ListMLInputChannelsCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link ListMLInputChannelsCommand}. + */ +export interface ListMLInputChannelsCommandInput extends ListMLInputChannelsRequest {} +/** + * @public + * + * The output of {@link ListMLInputChannelsCommand}. + */ +export interface ListMLInputChannelsCommandOutput extends ListMLInputChannelsResponse, __MetadataBearer {} + +/** + *Returns a list of ML input channels.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CleanRoomsMLClient, ListMLInputChannelsCommand } from "@aws-sdk/client-cleanroomsml"; // ES Modules import + * // const { CleanRoomsMLClient, ListMLInputChannelsCommand } = require("@aws-sdk/client-cleanroomsml"); // CommonJS import + * const client = new CleanRoomsMLClient(config); + * const input = { // ListMLInputChannelsRequest + * nextToken: "STRING_VALUE", + * maxResults: Number("int"), + * membershipIdentifier: "STRING_VALUE", // required + * }; + * const command = new ListMLInputChannelsCommand(input); + * const response = await client.send(command); + * // { // ListMLInputChannelsResponse + * // nextToken: "STRING_VALUE", + * // mlInputChannelsList: [ // MLInputChannelsList // required + * // { // MLInputChannelSummary + * // createTime: new Date("TIMESTAMP"), // required + * // updateTime: new Date("TIMESTAMP"), // required + * // membershipIdentifier: "STRING_VALUE", // required + * // collaborationIdentifier: "STRING_VALUE", // required + * // name: "STRING_VALUE", // required + * // configuredModelAlgorithmAssociations: [ // ConfiguredModelAlgorithmAssociationArnList // required + * // "STRING_VALUE", + * // ], + * // protectedQueryIdentifier: "STRING_VALUE", + * // mlInputChannelArn: "STRING_VALUE", // required + * // status: "CREATE_PENDING" || "CREATE_IN_PROGRESS" || "CREATE_FAILED" || "ACTIVE" || "DELETE_PENDING" || "DELETE_IN_PROGRESS" || "DELETE_FAILED" || "INACTIVE", // required + * // description: "STRING_VALUE", + * // }, + * // ], + * // }; + * + * ``` + * + * @param ListMLInputChannelsCommandInput - {@link ListMLInputChannelsCommandInput} + * @returns {@link ListMLInputChannelsCommandOutput} + * @see {@link ListMLInputChannelsCommandInput} for command's `input` shape. + * @see {@link ListMLInputChannelsCommandOutput} for command's `response` shape. + * @see {@link CleanRoomsMLClientResolvedConfig | config} for CleanRoomsMLClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You do not have sufficient access to perform this action.
+ * + * @throws {@link ValidationException} (client fault) + *The request parameters for this request are incorrect.
+ * + * @throws {@link CleanRoomsMLServiceException} + *Base exception class for all service exceptions from CleanRoomsML service.
+ * + * @public + */ +export class ListMLInputChannelsCommand extends $Command + .classBuilder< + ListMLInputChannelsCommandInput, + ListMLInputChannelsCommandOutput, + CleanRoomsMLClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: CleanRoomsMLClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AWSStarkControlService", "ListMLInputChannels", {}) + .n("CleanRoomsMLClient", "ListMLInputChannelsCommand") + .f(void 0, void 0) + .ser(se_ListMLInputChannelsCommand) + .de(de_ListMLInputChannelsCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: ListMLInputChannelsRequest; + output: ListMLInputChannelsResponse; + }; + sdk: { + input: ListMLInputChannelsCommandInput; + output: ListMLInputChannelsCommandOutput; + }; + }; +} diff --git a/clients/client-cleanroomsml/src/commands/ListTrainedModelInferenceJobsCommand.ts b/clients/client-cleanroomsml/src/commands/ListTrainedModelInferenceJobsCommand.ts new file mode 100644 index 000000000000..3f2f90bcebbe --- /dev/null +++ b/clients/client-cleanroomsml/src/commands/ListTrainedModelInferenceJobsCommand.ts @@ -0,0 +1,132 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { CleanRoomsMLClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CleanRoomsMLClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { ListTrainedModelInferenceJobsRequest, ListTrainedModelInferenceJobsResponse } from "../models/models_0"; +import { + de_ListTrainedModelInferenceJobsCommand, + se_ListTrainedModelInferenceJobsCommand, +} from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link ListTrainedModelInferenceJobsCommand}. + */ +export interface ListTrainedModelInferenceJobsCommandInput extends ListTrainedModelInferenceJobsRequest {} +/** + * @public + * + * The output of {@link ListTrainedModelInferenceJobsCommand}. + */ +export interface ListTrainedModelInferenceJobsCommandOutput + extends ListTrainedModelInferenceJobsResponse, + __MetadataBearer {} + +/** + *Returns a list of trained model inference jobs that match the request parameters.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CleanRoomsMLClient, ListTrainedModelInferenceJobsCommand } from "@aws-sdk/client-cleanroomsml"; // ES Modules import + * // const { CleanRoomsMLClient, ListTrainedModelInferenceJobsCommand } = require("@aws-sdk/client-cleanroomsml"); // CommonJS import + * const client = new CleanRoomsMLClient(config); + * const input = { // ListTrainedModelInferenceJobsRequest + * nextToken: "STRING_VALUE", + * maxResults: Number("int"), + * membershipIdentifier: "STRING_VALUE", // required + * trainedModelArn: "STRING_VALUE", + * }; + * const command = new ListTrainedModelInferenceJobsCommand(input); + * const response = await client.send(command); + * // { // ListTrainedModelInferenceJobsResponse + * // nextToken: "STRING_VALUE", + * // trainedModelInferenceJobs: [ // TrainedModelInferenceJobList // required + * // { // TrainedModelInferenceJobSummary + * // trainedModelInferenceJobArn: "STRING_VALUE", // required + * // configuredModelAlgorithmAssociationArn: "STRING_VALUE", + * // membershipIdentifier: "STRING_VALUE", // required + * // trainedModelArn: "STRING_VALUE", // required + * // collaborationIdentifier: "STRING_VALUE", // required + * // status: "CREATE_PENDING" || "CREATE_IN_PROGRESS" || "CREATE_FAILED" || "ACTIVE" || "CANCEL_PENDING" || "CANCEL_IN_PROGRESS" || "CANCEL_FAILED" || "INACTIVE", // required + * // outputConfiguration: { // InferenceOutputConfiguration + * // accept: "STRING_VALUE", + * // members: [ // InferenceReceiverMembers // required + * // { // InferenceReceiverMember + * // accountId: "STRING_VALUE", // required + * // }, + * // ], + * // }, + * // name: "STRING_VALUE", // required + * // description: "STRING_VALUE", + * // metricsStatus: "PUBLISH_SUCCEEDED" || "PUBLISH_FAILED", + * // metricsStatusDetails: "STRING_VALUE", + * // logsStatus: "PUBLISH_SUCCEEDED" || "PUBLISH_FAILED", + * // logsStatusDetails: "STRING_VALUE", + * // createTime: new Date("TIMESTAMP"), // required + * // updateTime: new Date("TIMESTAMP"), // required + * // }, + * // ], + * // }; + * + * ``` + * + * @param ListTrainedModelInferenceJobsCommandInput - {@link ListTrainedModelInferenceJobsCommandInput} + * @returns {@link ListTrainedModelInferenceJobsCommandOutput} + * @see {@link ListTrainedModelInferenceJobsCommandInput} for command's `input` shape. + * @see {@link ListTrainedModelInferenceJobsCommandOutput} for command's `response` shape. + * @see {@link CleanRoomsMLClientResolvedConfig | config} for CleanRoomsMLClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You do not have sufficient access to perform this action.
+ * + * @throws {@link ValidationException} (client fault) + *The request parameters for this request are incorrect.
+ * + * @throws {@link CleanRoomsMLServiceException} + *Base exception class for all service exceptions from CleanRoomsML service.
+ * + * @public + */ +export class ListTrainedModelInferenceJobsCommand extends $Command + .classBuilder< + ListTrainedModelInferenceJobsCommandInput, + ListTrainedModelInferenceJobsCommandOutput, + CleanRoomsMLClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: CleanRoomsMLClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AWSStarkControlService", "ListTrainedModelInferenceJobs", {}) + .n("CleanRoomsMLClient", "ListTrainedModelInferenceJobsCommand") + .f(void 0, void 0) + .ser(se_ListTrainedModelInferenceJobsCommand) + .de(de_ListTrainedModelInferenceJobsCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: ListTrainedModelInferenceJobsRequest; + output: ListTrainedModelInferenceJobsResponse; + }; + sdk: { + input: ListTrainedModelInferenceJobsCommandInput; + output: ListTrainedModelInferenceJobsCommandOutput; + }; + }; +} diff --git a/clients/client-cleanroomsml/src/commands/ListTrainedModelsCommand.ts b/clients/client-cleanroomsml/src/commands/ListTrainedModelsCommand.ts new file mode 100644 index 000000000000..8ab712aeff63 --- /dev/null +++ b/clients/client-cleanroomsml/src/commands/ListTrainedModelsCommand.ts @@ -0,0 +1,113 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { CleanRoomsMLClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CleanRoomsMLClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { ListTrainedModelsRequest, ListTrainedModelsResponse } from "../models/models_0"; +import { de_ListTrainedModelsCommand, se_ListTrainedModelsCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link ListTrainedModelsCommand}. + */ +export interface ListTrainedModelsCommandInput extends ListTrainedModelsRequest {} +/** + * @public + * + * The output of {@link ListTrainedModelsCommand}. + */ +export interface ListTrainedModelsCommandOutput extends ListTrainedModelsResponse, __MetadataBearer {} + +/** + *Returns a list of trained models.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CleanRoomsMLClient, ListTrainedModelsCommand } from "@aws-sdk/client-cleanroomsml"; // ES Modules import + * // const { CleanRoomsMLClient, ListTrainedModelsCommand } = require("@aws-sdk/client-cleanroomsml"); // CommonJS import + * const client = new CleanRoomsMLClient(config); + * const input = { // ListTrainedModelsRequest + * nextToken: "STRING_VALUE", + * maxResults: Number("int"), + * membershipIdentifier: "STRING_VALUE", // required + * }; + * const command = new ListTrainedModelsCommand(input); + * const response = await client.send(command); + * // { // ListTrainedModelsResponse + * // nextToken: "STRING_VALUE", + * // trainedModels: [ // TrainedModelList // required + * // { // TrainedModelSummary + * // createTime: new Date("TIMESTAMP"), // required + * // updateTime: new Date("TIMESTAMP"), // required + * // trainedModelArn: "STRING_VALUE", // required + * // name: "STRING_VALUE", // required + * // description: "STRING_VALUE", + * // membershipIdentifier: "STRING_VALUE", // required + * // collaborationIdentifier: "STRING_VALUE", // required + * // status: "CREATE_PENDING" || "CREATE_IN_PROGRESS" || "CREATE_FAILED" || "ACTIVE" || "DELETE_PENDING" || "DELETE_IN_PROGRESS" || "DELETE_FAILED" || "INACTIVE" || "CANCEL_PENDING" || "CANCEL_IN_PROGRESS" || "CANCEL_FAILED", // required + * // configuredModelAlgorithmAssociationArn: "STRING_VALUE", // required + * // }, + * // ], + * // }; + * + * ``` + * + * @param ListTrainedModelsCommandInput - {@link ListTrainedModelsCommandInput} + * @returns {@link ListTrainedModelsCommandOutput} + * @see {@link ListTrainedModelsCommandInput} for command's `input` shape. + * @see {@link ListTrainedModelsCommandOutput} for command's `response` shape. + * @see {@link CleanRoomsMLClientResolvedConfig | config} for CleanRoomsMLClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You do not have sufficient access to perform this action.
+ * + * @throws {@link ValidationException} (client fault) + *The request parameters for this request are incorrect.
+ * + * @throws {@link CleanRoomsMLServiceException} + *Base exception class for all service exceptions from CleanRoomsML service.
+ * + * @public + */ +export class ListTrainedModelsCommand extends $Command + .classBuilder< + ListTrainedModelsCommandInput, + ListTrainedModelsCommandOutput, + CleanRoomsMLClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: CleanRoomsMLClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AWSStarkControlService", "ListTrainedModels", {}) + .n("CleanRoomsMLClient", "ListTrainedModelsCommand") + .f(void 0, void 0) + .ser(se_ListTrainedModelsCommand) + .de(de_ListTrainedModelsCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: ListTrainedModelsRequest; + output: ListTrainedModelsResponse; + }; + sdk: { + input: ListTrainedModelsCommandInput; + output: ListTrainedModelsCommandOutput; + }; + }; +} diff --git a/clients/client-cleanroomsml/src/commands/PutMLConfigurationCommand.ts b/clients/client-cleanroomsml/src/commands/PutMLConfigurationCommand.ts new file mode 100644 index 000000000000..a585e4890a3e --- /dev/null +++ b/clients/client-cleanroomsml/src/commands/PutMLConfigurationCommand.ts @@ -0,0 +1,104 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { CleanRoomsMLClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CleanRoomsMLClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { PutMLConfigurationRequest } from "../models/models_0"; +import { de_PutMLConfigurationCommand, se_PutMLConfigurationCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link PutMLConfigurationCommand}. + */ +export interface PutMLConfigurationCommandInput extends PutMLConfigurationRequest {} +/** + * @public + * + * The output of {@link PutMLConfigurationCommand}. + */ +export interface PutMLConfigurationCommandOutput extends __MetadataBearer {} + +/** + *Assigns information about an ML configuration.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CleanRoomsMLClient, PutMLConfigurationCommand } from "@aws-sdk/client-cleanroomsml"; // ES Modules import + * // const { CleanRoomsMLClient, PutMLConfigurationCommand } = require("@aws-sdk/client-cleanroomsml"); // CommonJS import + * const client = new CleanRoomsMLClient(config); + * const input = { // PutMLConfigurationRequest + * membershipIdentifier: "STRING_VALUE", // required + * defaultOutputLocation: { // MLOutputConfiguration + * destination: { // Destination + * s3Destination: { // S3ConfigMap + * s3Uri: "STRING_VALUE", // required + * }, + * }, + * roleArn: "STRING_VALUE", // required + * }, + * }; + * const command = new PutMLConfigurationCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param PutMLConfigurationCommandInput - {@link PutMLConfigurationCommandInput} + * @returns {@link PutMLConfigurationCommandOutput} + * @see {@link PutMLConfigurationCommandInput} for command's `input` shape. + * @see {@link PutMLConfigurationCommandOutput} for command's `response` shape. + * @see {@link CleanRoomsMLClientResolvedConfig | config} for CleanRoomsMLClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You do not have sufficient access to perform this action.
+ * + * @throws {@link ValidationException} (client fault) + *The request parameters for this request are incorrect.
+ * + * @throws {@link CleanRoomsMLServiceException} + *Base exception class for all service exceptions from CleanRoomsML service.
+ * + * @public + */ +export class PutMLConfigurationCommand extends $Command + .classBuilder< + PutMLConfigurationCommandInput, + PutMLConfigurationCommandOutput, + CleanRoomsMLClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: CleanRoomsMLClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AWSStarkControlService", "PutMLConfiguration", {}) + .n("CleanRoomsMLClient", "PutMLConfigurationCommand") + .f(void 0, void 0) + .ser(se_PutMLConfigurationCommand) + .de(de_PutMLConfigurationCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: PutMLConfigurationRequest; + output: {}; + }; + sdk: { + input: PutMLConfigurationCommandInput; + output: PutMLConfigurationCommandOutput; + }; + }; +} diff --git a/clients/client-cleanroomsml/src/commands/StartTrainedModelExportJobCommand.ts b/clients/client-cleanroomsml/src/commands/StartTrainedModelExportJobCommand.ts new file mode 100644 index 000000000000..4eeb019204cf --- /dev/null +++ b/clients/client-cleanroomsml/src/commands/StartTrainedModelExportJobCommand.ts @@ -0,0 +1,112 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { CleanRoomsMLClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CleanRoomsMLClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { StartTrainedModelExportJobRequest } from "../models/models_0"; +import { de_StartTrainedModelExportJobCommand, se_StartTrainedModelExportJobCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link StartTrainedModelExportJobCommand}. + */ +export interface StartTrainedModelExportJobCommandInput extends StartTrainedModelExportJobRequest {} +/** + * @public + * + * The output of {@link StartTrainedModelExportJobCommand}. + */ +export interface StartTrainedModelExportJobCommandOutput extends __MetadataBearer {} + +/** + *Provides the information necessary to start a trained model export job.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CleanRoomsMLClient, StartTrainedModelExportJobCommand } from "@aws-sdk/client-cleanroomsml"; // ES Modules import + * // const { CleanRoomsMLClient, StartTrainedModelExportJobCommand } = require("@aws-sdk/client-cleanroomsml"); // CommonJS import + * const client = new CleanRoomsMLClient(config); + * const input = { // StartTrainedModelExportJobRequest + * name: "STRING_VALUE", // required + * trainedModelArn: "STRING_VALUE", // required + * membershipIdentifier: "STRING_VALUE", // required + * outputConfiguration: { // TrainedModelExportOutputConfiguration + * members: [ // TrainedModelExportReceiverMembers // required + * { // TrainedModelExportReceiverMember + * accountId: "STRING_VALUE", // required + * }, + * ], + * }, + * description: "STRING_VALUE", + * }; + * const command = new StartTrainedModelExportJobCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param StartTrainedModelExportJobCommandInput - {@link StartTrainedModelExportJobCommandInput} + * @returns {@link StartTrainedModelExportJobCommandOutput} + * @see {@link StartTrainedModelExportJobCommandInput} for command's `input` shape. + * @see {@link StartTrainedModelExportJobCommandOutput} for command's `response` shape. + * @see {@link CleanRoomsMLClientResolvedConfig | config} for CleanRoomsMLClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You do not have sufficient access to perform this action.
+ * + * @throws {@link ConflictException} (client fault) + *You can't complete this action because another resource depends on this resource.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource you are requesting does not exist.
+ * + * @throws {@link ValidationException} (client fault) + *The request parameters for this request are incorrect.
+ * + * @throws {@link CleanRoomsMLServiceException} + *Base exception class for all service exceptions from CleanRoomsML service.
+ * + * @public + */ +export class StartTrainedModelExportJobCommand extends $Command + .classBuilder< + StartTrainedModelExportJobCommandInput, + StartTrainedModelExportJobCommandOutput, + CleanRoomsMLClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: CleanRoomsMLClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AWSStarkControlService", "StartTrainedModelExportJob", {}) + .n("CleanRoomsMLClient", "StartTrainedModelExportJobCommand") + .f(void 0, void 0) + .ser(se_StartTrainedModelExportJobCommand) + .de(de_StartTrainedModelExportJobCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: StartTrainedModelExportJobRequest; + output: {}; + }; + sdk: { + input: StartTrainedModelExportJobCommandInput; + output: StartTrainedModelExportJobCommandOutput; + }; + }; +} diff --git a/clients/client-cleanroomsml/src/commands/StartTrainedModelInferenceJobCommand.ts b/clients/client-cleanroomsml/src/commands/StartTrainedModelInferenceJobCommand.ts new file mode 100644 index 000000000000..1c9a1341f0b0 --- /dev/null +++ b/clients/client-cleanroomsml/src/commands/StartTrainedModelInferenceJobCommand.ts @@ -0,0 +1,141 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { CleanRoomsMLClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CleanRoomsMLClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { StartTrainedModelInferenceJobRequest, StartTrainedModelInferenceJobResponse } from "../models/models_0"; +import { + de_StartTrainedModelInferenceJobCommand, + se_StartTrainedModelInferenceJobCommand, +} from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link StartTrainedModelInferenceJobCommand}. + */ +export interface StartTrainedModelInferenceJobCommandInput extends StartTrainedModelInferenceJobRequest {} +/** + * @public + * + * The output of {@link StartTrainedModelInferenceJobCommand}. + */ +export interface StartTrainedModelInferenceJobCommandOutput + extends StartTrainedModelInferenceJobResponse, + __MetadataBearer {} + +/** + *Defines the information necessary to begin a trained model inference job.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CleanRoomsMLClient, StartTrainedModelInferenceJobCommand } from "@aws-sdk/client-cleanroomsml"; // ES Modules import + * // const { CleanRoomsMLClient, StartTrainedModelInferenceJobCommand } = require("@aws-sdk/client-cleanroomsml"); // CommonJS import + * const client = new CleanRoomsMLClient(config); + * const input = { // StartTrainedModelInferenceJobRequest + * membershipIdentifier: "STRING_VALUE", // required + * name: "STRING_VALUE", // required + * trainedModelArn: "STRING_VALUE", // required + * configuredModelAlgorithmAssociationArn: "STRING_VALUE", + * resourceConfig: { // InferenceResourceConfig + * instanceType: "ml.r7i.48xlarge" || "ml.r6i.16xlarge" || "ml.m6i.xlarge" || "ml.m5.4xlarge" || "ml.p2.xlarge" || "ml.m4.16xlarge" || "ml.r7i.16xlarge" || "ml.m7i.xlarge" || "ml.m6i.12xlarge" || "ml.r7i.8xlarge" || "ml.r7i.large" || "ml.m7i.12xlarge" || "ml.m6i.24xlarge" || "ml.m7i.24xlarge" || "ml.r6i.8xlarge" || "ml.r6i.large" || "ml.g5.2xlarge" || "ml.m5.large" || "ml.p3.16xlarge" || "ml.m7i.48xlarge" || "ml.m6i.16xlarge" || "ml.p2.16xlarge" || "ml.g5.4xlarge" || "ml.m7i.16xlarge" || "ml.c4.2xlarge" || "ml.c5.2xlarge" || "ml.c6i.32xlarge" || "ml.c4.4xlarge" || "ml.g5.8xlarge" || "ml.c6i.xlarge" || "ml.c5.4xlarge" || "ml.g4dn.xlarge" || "ml.c7i.xlarge" || "ml.c6i.12xlarge" || "ml.g4dn.12xlarge" || "ml.c7i.12xlarge" || "ml.c6i.24xlarge" || "ml.g4dn.2xlarge" || "ml.c7i.24xlarge" || "ml.c7i.2xlarge" || "ml.c4.8xlarge" || "ml.c6i.2xlarge" || "ml.g4dn.4xlarge" || "ml.c7i.48xlarge" || "ml.c7i.4xlarge" || "ml.c6i.16xlarge" || "ml.c5.9xlarge" || "ml.g4dn.16xlarge" || "ml.c7i.16xlarge" || "ml.c6i.4xlarge" || "ml.c5.xlarge" || "ml.c4.xlarge" || "ml.g4dn.8xlarge" || "ml.c7i.8xlarge" || "ml.c7i.large" || "ml.g5.xlarge" || "ml.c6i.8xlarge" || "ml.c6i.large" || "ml.g5.12xlarge" || "ml.g5.24xlarge" || "ml.m7i.2xlarge" || "ml.c5.18xlarge" || "ml.g5.48xlarge" || "ml.m6i.2xlarge" || "ml.g5.16xlarge" || "ml.m7i.4xlarge" || "ml.p3.2xlarge" || "ml.r6i.32xlarge" || "ml.m6i.4xlarge" || "ml.m5.xlarge" || "ml.m4.10xlarge" || "ml.r6i.xlarge" || "ml.m5.12xlarge" || "ml.m4.xlarge" || "ml.r7i.2xlarge" || "ml.r7i.xlarge" || "ml.r6i.12xlarge" || "ml.m5.24xlarge" || "ml.r7i.12xlarge" || "ml.m7i.8xlarge" || "ml.m7i.large" || "ml.r6i.24xlarge" || "ml.r6i.2xlarge" || "ml.m4.2xlarge" || "ml.r7i.24xlarge" || "ml.r7i.4xlarge" || "ml.m6i.8xlarge" || "ml.m6i.large" || "ml.m5.2xlarge" || "ml.p2.8xlarge" || "ml.r6i.4xlarge" || "ml.m6i.32xlarge" || "ml.p3.8xlarge" || "ml.m4.4xlarge", // required + * instanceCount: Number("int"), + * }, + * outputConfiguration: { // InferenceOutputConfiguration + * accept: "STRING_VALUE", + * members: [ // InferenceReceiverMembers // required + * { // InferenceReceiverMember + * accountId: "STRING_VALUE", // required + * }, + * ], + * }, + * dataSource: { // ModelInferenceDataSource + * mlInputChannelArn: "STRING_VALUE", // required + * }, + * description: "STRING_VALUE", + * containerExecutionParameters: { // InferenceContainerExecutionParameters + * maxPayloadInMB: Number("int"), + * }, + * environment: { // InferenceEnvironmentMap + * "You do not have sufficient access to perform this action.
+ * + * @throws {@link ConflictException} (client fault) + *You can't complete this action because another resource depends on this resource.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource you are requesting does not exist.
+ * + * @throws {@link ServiceQuotaExceededException} (client fault) + *You have exceeded your service quota.
+ * + * @throws {@link ValidationException} (client fault) + *The request parameters for this request are incorrect.
+ * + * @throws {@link CleanRoomsMLServiceException} + *Base exception class for all service exceptions from CleanRoomsML service.
+ * + * @public + */ +export class StartTrainedModelInferenceJobCommand extends $Command + .classBuilder< + StartTrainedModelInferenceJobCommandInput, + StartTrainedModelInferenceJobCommandOutput, + CleanRoomsMLClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: CleanRoomsMLClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AWSStarkControlService", "StartTrainedModelInferenceJob", {}) + .n("CleanRoomsMLClient", "StartTrainedModelInferenceJobCommand") + .f(void 0, void 0) + .ser(se_StartTrainedModelInferenceJobCommand) + .de(de_StartTrainedModelInferenceJobCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: StartTrainedModelInferenceJobRequest; + output: StartTrainedModelInferenceJobResponse; + }; + sdk: { + input: StartTrainedModelInferenceJobCommandInput; + output: StartTrainedModelInferenceJobCommandOutput; + }; + }; +} diff --git a/clients/client-cleanroomsml/src/commands/index.ts b/clients/client-cleanroomsml/src/commands/index.ts index d0322e294e40..c89cbc8ab613 100644 --- a/clients/client-cleanroomsml/src/commands/index.ts +++ b/clients/client-cleanroomsml/src/commands/index.ts @@ -1,26 +1,59 @@ // smithy-typescript generated code +export * from "./CancelTrainedModelCommand"; +export * from "./CancelTrainedModelInferenceJobCommand"; export * from "./CreateAudienceModelCommand"; export * from "./CreateConfiguredAudienceModelCommand"; +export * from "./CreateConfiguredModelAlgorithmAssociationCommand"; +export * from "./CreateConfiguredModelAlgorithmCommand"; +export * from "./CreateMLInputChannelCommand"; +export * from "./CreateTrainedModelCommand"; export * from "./CreateTrainingDatasetCommand"; export * from "./DeleteAudienceGenerationJobCommand"; export * from "./DeleteAudienceModelCommand"; export * from "./DeleteConfiguredAudienceModelCommand"; export * from "./DeleteConfiguredAudienceModelPolicyCommand"; +export * from "./DeleteConfiguredModelAlgorithmAssociationCommand"; +export * from "./DeleteConfiguredModelAlgorithmCommand"; +export * from "./DeleteMLConfigurationCommand"; +export * from "./DeleteMLInputChannelDataCommand"; +export * from "./DeleteTrainedModelOutputCommand"; export * from "./DeleteTrainingDatasetCommand"; export * from "./GetAudienceGenerationJobCommand"; export * from "./GetAudienceModelCommand"; +export * from "./GetCollaborationConfiguredModelAlgorithmAssociationCommand"; +export * from "./GetCollaborationMLInputChannelCommand"; +export * from "./GetCollaborationTrainedModelCommand"; export * from "./GetConfiguredAudienceModelCommand"; export * from "./GetConfiguredAudienceModelPolicyCommand"; +export * from "./GetConfiguredModelAlgorithmAssociationCommand"; +export * from "./GetConfiguredModelAlgorithmCommand"; +export * from "./GetMLConfigurationCommand"; +export * from "./GetMLInputChannelCommand"; +export * from "./GetTrainedModelCommand"; +export * from "./GetTrainedModelInferenceJobCommand"; export * from "./GetTrainingDatasetCommand"; export * from "./ListAudienceExportJobsCommand"; export * from "./ListAudienceGenerationJobsCommand"; export * from "./ListAudienceModelsCommand"; +export * from "./ListCollaborationConfiguredModelAlgorithmAssociationsCommand"; +export * from "./ListCollaborationMLInputChannelsCommand"; +export * from "./ListCollaborationTrainedModelExportJobsCommand"; +export * from "./ListCollaborationTrainedModelInferenceJobsCommand"; +export * from "./ListCollaborationTrainedModelsCommand"; export * from "./ListConfiguredAudienceModelsCommand"; +export * from "./ListConfiguredModelAlgorithmAssociationsCommand"; +export * from "./ListConfiguredModelAlgorithmsCommand"; +export * from "./ListMLInputChannelsCommand"; export * from "./ListTagsForResourceCommand"; +export * from "./ListTrainedModelInferenceJobsCommand"; +export * from "./ListTrainedModelsCommand"; export * from "./ListTrainingDatasetsCommand"; export * from "./PutConfiguredAudienceModelPolicyCommand"; +export * from "./PutMLConfigurationCommand"; export * from "./StartAudienceExportJobCommand"; export * from "./StartAudienceGenerationJobCommand"; +export * from "./StartTrainedModelExportJobCommand"; +export * from "./StartTrainedModelInferenceJobCommand"; export * from "./TagResourceCommand"; export * from "./UntagResourceCommand"; export * from "./UpdateConfiguredAudienceModelCommand"; diff --git a/clients/client-cleanroomsml/src/models/models_0.ts b/clients/client-cleanroomsml/src/models/models_0.ts index 24f1d90c7c43..93ea5d90b132 100644 --- a/clients/client-cleanroomsml/src/models/models_0.ts +++ b/clients/client-cleanroomsml/src/models/models_0.ts @@ -203,7 +203,7 @@ export interface AudienceExportJobSummary { */ export interface ListAudienceExportJobsResponse { /** - *The token value retrieved from a previous call to access the next page of results.
+ *The token value used to access the next page of results.
* @public */ nextToken?: string; @@ -650,7 +650,7 @@ export interface AudienceGenerationJobSummary { */ export interface ListAudienceGenerationJobsResponse { /** - *The token value retrieved from a previous call to access the next page of results.
+ *The token value used to access the next page of results.
* @public */ nextToken?: string; @@ -1014,7 +1014,7 @@ export interface AudienceModelSummary { */ export interface ListAudienceModelsResponse { /** - *The token value retrieved from a previous call to access the next page of results.
+ *The token value used to access the next page of results.
* @public */ nextToken?: string; @@ -1387,7 +1387,7 @@ export interface ConfiguredAudienceModelSummary { */ export interface ListConfiguredAudienceModelsResponse { /** - *The token value retrieved from a previous call to access the next page of results.
+ *The token value used to access the next page of results.
* @public */ nextToken?: string; @@ -1563,215 +1563,98 @@ export interface PutConfiguredAudienceModelPolicyResponse { } /** + *Provides configuration information for the inference container.
* @public */ -export interface ListTagsForResourceRequest { - /** - *The Amazon Resource Name (ARN) of the resource that you are interested in.
- * @public - */ - resourceArn: string | undefined; -} - -/** - * @public - */ -export interface ListTagsForResourceResponse { - /** - *The tags that are associated with the resource.
- * @public - */ - tags: RecordThe Amazon Resource Name (ARN) of the resource that you want to assign tags.
- * @public - */ - resourceArn: string | undefined; - +export interface InferenceContainerConfig { /** - *The optional metadata that you apply to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
- *The following basic restrictions apply to tags:
- *Maximum number of tags per resource - 50.
- *For each resource, each tag key must be unique, and each tag key can have only one value.
- *Maximum key length - 128 Unicode characters in UTF-8.
- *Maximum value length - 256 Unicode characters in UTF-8.
- *If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
- *Tag keys and values are case sensitive.
- *Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.
- *The registry path of the docker image that contains the inference algorithm. Clean Rooms ML supports both registry/repository[:tag] and registry/repositry[@digest] image path formats. For more information about using images in Clean Rooms ML, see the Sagemaker API reference.
Information about the model metric that is reported for a trained model.
* @public */ -export interface TagResourceResponse {} - -/** - *Defines the Glue data source that contains the training data.
- * @public - */ -export interface GlueDataSource { - /** - *The Glue table that contains the training data.
- * @public - */ - tableName: string | undefined; - +export interface MetricDefinition { /** - *The Glue database that contains the training data.
- * @public - */ - databaseName: string | undefined; - - /** - *The Glue catalog that contains the training data.
+ *The name of the model metric.
* @public */ - catalogId?: string; -} + name: string | undefined; -/** - *Defines information about the Glue data source that contains the training data.
- * @public - */ -export interface DataSource { /** - *A GlueDataSource object that defines the catalog ID, database name, and table name for the training data.
+ *The regular expression statement that defines how the model metric is reported.
* @public */ - glueDataSource: GlueDataSource | undefined; + regex: string | undefined; } /** - * @public - * @enum - */ -export const ColumnType = { - CATEGORICAL_FEATURE: "CATEGORICAL_FEATURE", - ITEM_ID: "ITEM_ID", - NUMERICAL_FEATURE: "NUMERICAL_FEATURE", - TIMESTAMP: "TIMESTAMP", - USER_ID: "USER_ID", -} as const; - -/** - * @public - */ -export type ColumnType = (typeof ColumnType)[keyof typeof ColumnType]; - -/** - *Metadata for a column.
+ *Provides configuration information for the dockerized container where the model algorithm is stored.
* @public */ -export interface ColumnSchema { +export interface ContainerConfig { /** - *The name of a column.
+ *The registry path of the docker image that contains the algorithm. Clean Rooms ML supports both registry/repository[:tag] and registry/repositry[@digest] image path formats. For more information about using images in Clean Rooms ML, see the Sagemaker API reference.
The data type of column.
+ *The entrypoint script for a Docker container used to run a training job. This script takes precedence over the default train processing instructions. See How Amazon SageMaker Runs Your Training Image for additional information. For more information, see How Sagemaker runs your training image.
* @public */ - columnTypes: ColumnType[] | undefined; -} + entrypoint?: string[]; -/** - *Defines the Glue data source and schema mapping information.
- * @public - */ -export interface DatasetInputConfig { /** - *The schema information for the training data.
+ *The arguments for a container used to run a training job. See How Amazon SageMaker Runs Your Training Image for additional information. For more information, see How Sagemaker runs your training image.
* @public */ - schema: ColumnSchema[] | undefined; + arguments?: string[]; /** - *A DataSource object that specifies the Glue data source for the training data.
+ *A list of metric definition objects. Each object specifies the metric name and regular expressions used to parse algorithm logs. Amazon Web Services Clean Rooms ML publishes each metric to all members' Amazon CloudWatch using IAM role configured in PutMLConfiguration.
* @public */ - dataSource: DataSource | undefined; + metricDefinitions?: MetricDefinition[]; } /** - * @public - * @enum - */ -export const DatasetType = { - INTERACTIONS: "INTERACTIONS", -} as const; - -/** - * @public - */ -export type DatasetType = (typeof DatasetType)[keyof typeof DatasetType]; - -/** - *Defines where the training dataset is located, what type of data it contains, and how to access the data.
* @public */ -export interface Dataset { +export interface CreateConfiguredModelAlgorithmRequest { /** - *What type of information is found in the dataset.
+ *The name of the configured model algorithm.
* @public */ - type: DatasetType | undefined; + name: string | undefined; /** - *A DatasetInputConfig object that defines the data source and schema mapping.
+ *The description of the configured model algorithm.
* @public */ - inputConfig: DatasetInputConfig | undefined; -} + description?: string; -/** - * @public - */ -export interface CreateTrainingDatasetRequest { /** - *The name of the training dataset. This name must be unique in your account and region.
+ *The Amazon Resource Name (ARN) of the role that is used to access the repository.
* @public */ - name: string | undefined; + roleArn: string | undefined; /** - *The ARN of the IAM role that Clean Rooms ML can assume to read the data referred to in the dataSource field of each dataset.
Passing a role across AWS accounts is not allowed. If you pass a role that isn't in your account, you get an AccessDeniedException error.
Configuration information for the training container, including entrypoints and arguments.
* @public */ - roleArn: string | undefined; + trainingContainerConfig?: ContainerConfig; /** - *An array of information that lists the Dataset objects, which specifies the dataset type and details on its location and schema. You must provide a role that has read access to these tables.
+ *Configuration information for the inference container that is used when you run an inference job on a configured model algorithm.
* @public */ - trainingData: Dataset[] | undefined; + inferenceContainerConfig?: InferenceContainerConfig; /** *The optional metadata that you apply to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
@@ -1804,121 +1687,138 @@ export interface CreateTrainingDatasetRequest { tags?: RecordThe description of the training dataset.
+ *The Amazon Resource Name (ARN) of the KMS key. This key is used to encrypt and decrypt customer-owned data in the configured ML model algorithm and associated data.
* @public */ - description?: string; + kmsKeyArn?: string; } /** * @public */ -export interface CreateTrainingDatasetResponse { +export interface CreateConfiguredModelAlgorithmResponse { /** - *The Amazon Resource Name (ARN) of the training dataset resource.
+ *The Amazon Resource Name (ARN) of the configured model algorithm.
* @public */ - trainingDatasetArn: string | undefined; + configuredModelAlgorithmArn: string | undefined; } /** * @public */ -export interface DeleteTrainingDatasetRequest { +export interface DeleteConfiguredModelAlgorithmRequest { /** - *The Amazon Resource Name (ARN) of the training dataset that you want to delete.
+ *The Amazon Resource Name (ARN) of the configured model algorithm that you want to delete.
* @public */ - trainingDatasetArn: string | undefined; + configuredModelAlgorithmArn: string | undefined; } /** * @public */ -export interface GetTrainingDatasetRequest { +export interface GetConfiguredModelAlgorithmRequest { /** - *The Amazon Resource Name (ARN) of the training dataset that you are interested in.
+ *The Amazon Resource Name (ARN) of the configured model algorithm that you want to return information about.
* @public */ - trainingDatasetArn: string | undefined; + configuredModelAlgorithmArn: string | undefined; } -/** - * @public - * @enum - */ -export const TrainingDatasetStatus = { - ACTIVE: "ACTIVE", -} as const; - /** * @public */ -export type TrainingDatasetStatus = (typeof TrainingDatasetStatus)[keyof typeof TrainingDatasetStatus]; - -/** - * @public - */ -export interface GetTrainingDatasetResponse { +export interface GetConfiguredModelAlgorithmResponse { /** - *The time at which the training dataset was created.
+ *The time at which the configured model algorithm was created.
* @public */ createTime: Date | undefined; /** - *The most recent time at which the training dataset was updated.
+ *The most recent time at which the configured model algorithm was updated.
* @public */ updateTime: Date | undefined; /** - *The Amazon Resource Name (ARN) of the training dataset.
+ *The Amazon Resource Name (ARN) of the configured model algorithm.
* @public */ - trainingDatasetArn: string | undefined; + configuredModelAlgorithmArn: string | undefined; /** - *The name of the training dataset.
+ *The name of the configured model algorithm.
* @public */ name: string | undefined; /** - *Metadata about the requested training data.
+ *The configuration information of the training container for the configured model algorithm.
* @public */ - trainingData: Dataset[] | undefined; + trainingContainerConfig?: ContainerConfig; /** - *The status of the training dataset.
+ *Configuration information for the inference container.
* @public */ - status: TrainingDatasetStatus | undefined; + inferenceContainerConfig?: InferenceContainerConfig; /** - *The IAM role used to read the training data.
+ *The Amazon Resource Name (ARN) of the service role that was used to create the configured model algorithm.
* @public */ roleArn: string | undefined; /** - *The tags that are assigned to this training dataset.
+ *The description of the configured model algorithm.
+ * @public + */ + description?: string; + + /** + *The optional metadata that you applied to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
+ *The following basic restrictions apply to tags:
+ *Maximum number of tags per resource - 50.
+ *For each resource, each tag key must be unique, and each tag key can have only one value.
+ *Maximum key length - 128 Unicode characters in UTF-8.
+ *Maximum value length - 256 Unicode characters in UTF-8.
+ *If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
+ *Tag keys and values are case sensitive.
+ *Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms ML considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.
+ *The description of the training dataset.
+ *The Amazon Resource Name (ARN) of the KMS key. This key is used to encrypt and decrypt customer-owned data in the configured ML model and associated data.
* @public */ - description?: string; + kmsKeyArn?: string; } /** * @public */ -export interface ListTrainingDatasetsRequest { +export interface ListConfiguredModelAlgorithmsRequest { /** *The token value retrieved from a previous call to access the next page of results.
* @public @@ -1933,42 +1833,36 @@ export interface ListTrainingDatasetsRequest { } /** - *Provides information about the training dataset.
+ *Provides summary information about a configured model algorithm.
* @public */ -export interface TrainingDatasetSummary { +export interface ConfiguredModelAlgorithmSummary { /** - *The time at which the training dataset was created.
+ *The time at which the configured model algorithm was created.
* @public */ createTime: Date | undefined; /** - *The most recent time at which the training dataset was updated.
+ *The most recent time at which the configured model algorithm was updated.
* @public */ updateTime: Date | undefined; /** - *The Amazon Resource Name (ARN) of the training dataset.
+ *The Amazon Resource Name (ARN) of the configured model algorithm.
* @public */ - trainingDatasetArn: string | undefined; + configuredModelAlgorithmArn: string | undefined; /** - *The name of the training dataset.
+ *The name of the configured model algorithm.
* @public */ name: string | undefined; /** - *The status of the training dataset.
- * @public - */ - status: TrainingDatasetStatus | undefined; - - /** - *The description of the training dataset.
+ *The description of the configured model algorithm.
* @public */ description?: string; @@ -1977,34 +1871,3841 @@ export interface TrainingDatasetSummary { /** * @public */ -export interface ListTrainingDatasetsResponse { +export interface ListConfiguredModelAlgorithmsResponse { /** - *The token value retrieved from a previous call to access the next page of results.
+ *The token value used to access the next page of results.
* @public */ nextToken?: string; /** - *The training datasets that match the request.
+ *The list of configured model algorithms.
* @public */ - trainingDatasets: TrainingDatasetSummary[] | undefined; + configuredModelAlgorithms: ConfiguredModelAlgorithmSummary[] | undefined; } /** * @public + * @enum */ -export interface UntagResourceRequest { - /** - *The Amazon Resource Name (ARN) of the resource that you want to remove tags from.
- * @public - */ - resourceArn: string | undefined; +export const TrainedModelExportFileType = { + MODEL: "MODEL", + OUTPUT: "OUTPUT", +} as const; - /** - *The key values of tags that you want to remove.
- * @public - */ +/** + * @public + */ +export type TrainedModelExportFileType = (typeof TrainedModelExportFileType)[keyof typeof TrainedModelExportFileType]; + +/** + * @public + * @enum + */ +export const TrainedModelExportsMaxSizeUnitType = { + GB: "GB", +} as const; + +/** + * @public + */ +export type TrainedModelExportsMaxSizeUnitType = + (typeof TrainedModelExportsMaxSizeUnitType)[keyof typeof TrainedModelExportsMaxSizeUnitType]; + +/** + *The maximum size of the trained model metrics that can be exported. If the trained model metrics dataset is larger than this value, it will not be exported.
+ * @public + */ +export interface TrainedModelExportsMaxSize { + /** + *The unit of measurement for the data size.
+ * @public + */ + unit: TrainedModelExportsMaxSizeUnitType | undefined; + + /** + *The maximum size of the dataset to export.
+ * @public + */ + value: number | undefined; +} + +/** + *Information about how the trained model exports are configured.
+ * @public + */ +export interface TrainedModelExportsConfigurationPolicy { + /** + *The maximum size of the data that can be exported.
+ * @public + */ + maxSize: TrainedModelExportsMaxSize | undefined; + + /** + *The files that are exported during the trained model export job.
+ * @public + */ + filesToExport: TrainedModelExportFileType[] | undefined; +} + +/** + *Provides the information necessary for a user to access the logs.
+ * @public + */ +export interface LogsConfigurationPolicy { + /** + *A list of account IDs that are allowed to access the logs.
+ * @public + */ + allowedAccountIds: string[] | undefined; + + /** + *A regular expression pattern that is used to parse the logs and return information that matches the pattern.
+ * @public + */ + filterPattern?: string; +} + +/** + * @public + * @enum + */ +export const TrainedModelInferenceMaxOutputSizeUnitType = { + GB: "GB", +} as const; + +/** + * @public + */ +export type TrainedModelInferenceMaxOutputSizeUnitType = + (typeof TrainedModelInferenceMaxOutputSizeUnitType)[keyof typeof TrainedModelInferenceMaxOutputSizeUnitType]; + +/** + *Information about the maximum output size for a trained model inference job.
+ * @public + */ +export interface TrainedModelInferenceMaxOutputSize { + /** + *The measurement unit to use.
+ * @public + */ + unit: TrainedModelInferenceMaxOutputSizeUnitType | undefined; + + /** + *The maximum output size value.
+ * @public + */ + value: number | undefined; +} + +/** + *Provides configuration information for the trained model inference job.
+ * @public + */ +export interface TrainedModelInferenceJobsConfigurationPolicy { + /** + *The logs container for the trained model inference job.
+ * @public + */ + containerLogs?: LogsConfigurationPolicy[]; + + /** + *The maximum allowed size of the output of the trained model inference job.
+ * @public + */ + maxOutputSize?: TrainedModelInferenceMaxOutputSize; +} + +/** + * @public + * @enum + */ +export const NoiseLevelType = { + HIGH: "HIGH", + LOW: "LOW", + MEDIUM: "MEDIUM", + NONE: "NONE", +} as const; + +/** + * @public + */ +export type NoiseLevelType = (typeof NoiseLevelType)[keyof typeof NoiseLevelType]; + +/** + *Provides the configuration policy for metrics generation.
+ * @public + */ +export interface MetricsConfigurationPolicy { + /** + *The noise level for the generated metrics.
+ * @public + */ + noiseLevel: NoiseLevelType | undefined; +} + +/** + *The configuration policy for the trained models.
+ * @public + */ +export interface TrainedModelsConfigurationPolicy { + /** + *The container for the logs of the trained model.
+ * @public + */ + containerLogs?: LogsConfigurationPolicy[]; + + /** + *The container for the metrics of the trained model.
+ * @public + */ + containerMetrics?: MetricsConfigurationPolicy; +} + +/** + *Information about the privacy configuration policies for a configured model algorithm association.
+ * @public + */ +export interface PrivacyConfigurationPolicies { + /** + *Specifies who will receive the trained models.
+ * @public + */ + trainedModels?: TrainedModelsConfigurationPolicy; + + /** + *Specifies who will receive the trained model export.
+ * @public + */ + trainedModelExports?: TrainedModelExportsConfigurationPolicy; + + /** + *Specifies who will receive the trained model inference jobs.
+ * @public + */ + trainedModelInferenceJobs?: TrainedModelInferenceJobsConfigurationPolicy; +} + +/** + *Information about the privacy configuration for a configured model algorithm association.
+ * @public + */ +export interface PrivacyConfiguration { + /** + *The privacy configuration policies for a configured model algorithm association.
+ * @public + */ + policies: PrivacyConfigurationPolicies | undefined; +} + +/** + * @public + */ +export interface CreateConfiguredModelAlgorithmAssociationRequest { + /** + *The membership ID of the member who is associating this configured model algorithm.
+ * @public + */ + membershipIdentifier: string | undefined; + + /** + *The Amazon Resource Name (ARN) of the configured model algorithm that you want to associate.
+ * @public + */ + configuredModelAlgorithmArn: string | undefined; + + /** + *The name of the configured model algorithm association.
+ * @public + */ + name: string | undefined; + + /** + *The description of the configured model algorithm association.
+ * @public + */ + description?: string; + + /** + *Specifies the privacy configuration information for the configured model algorithm association. This information includes the maximum data size that can be exported.
+ * @public + */ + privacyConfiguration?: PrivacyConfiguration; + + /** + *The optional metadata that you apply to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
+ *The following basic restrictions apply to tags:
+ *Maximum number of tags per resource - 50.
+ *For each resource, each tag key must be unique, and each tag key can have only one value.
+ *Maximum key length - 128 Unicode characters in UTF-8.
+ *Maximum value length - 256 Unicode characters in UTF-8.
+ *If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
+ *Tag keys and values are case sensitive.
+ *Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms ML considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.
+ *The Amazon Resource Name (ARN) of the configured model algorithm association.
+ * @public + */ + configuredModelAlgorithmAssociationArn: string | undefined; +} + +/** + * @public + */ +export interface DeleteConfiguredModelAlgorithmAssociationRequest { + /** + *The Amazon Resource Name (ARN) of the configured model algorithm association that you want to delete.
+ * @public + */ + configuredModelAlgorithmAssociationArn: string | undefined; + + /** + *The membership ID of the member that is deleting the configured model algorithm association.
+ * @public + */ + membershipIdentifier: string | undefined; +} + +/** + * @public + */ +export interface GetCollaborationConfiguredModelAlgorithmAssociationRequest { + /** + *The Amazon Resource Name (ARN) of the configured model algorithm association that you want to return information about.
+ * @public + */ + configuredModelAlgorithmAssociationArn: string | undefined; + + /** + *The collaboration ID for the collaboration that contains the configured model algorithm association that you want to return information about.
+ * @public + */ + collaborationIdentifier: string | undefined; +} + +/** + * @public + */ +export interface GetCollaborationConfiguredModelAlgorithmAssociationResponse { + /** + *The time at which the configured model algorithm association was created.
+ * @public + */ + createTime: Date | undefined; + + /** + *The most recent time at which the configured model algorithm association was updated.
+ * @public + */ + updateTime: Date | undefined; + + /** + *The Amazon Resource Name (ARN) of the configured model algorithm association.
+ * @public + */ + configuredModelAlgorithmAssociationArn: string | undefined; + + /** + *The membership ID of the member that created the configured model algorithm association.
+ * @public + */ + membershipIdentifier: string | undefined; + + /** + *The collaboration ID of the collaboration that contains the configured model algorithm association.
+ * @public + */ + collaborationIdentifier: string | undefined; + + /** + *The Amazon Resource Name (ARN) of the configured model algorithm association.
+ * @public + */ + configuredModelAlgorithmArn: string | undefined; + + /** + *The name of the configured model algorithm association.
+ * @public + */ + name: string | undefined; + + /** + *The description of the configured model algorithm association.
+ * @public + */ + description?: string; + + /** + *The account ID of the member that created the configured model algorithm association.
+ * @public + */ + creatorAccountId: string | undefined; + + /** + *Information about the privacy configuration for a configured model algorithm association.
+ * @public + */ + privacyConfiguration?: PrivacyConfiguration; +} + +/** + * @public + */ +export interface GetConfiguredModelAlgorithmAssociationRequest { + /** + *The Amazon Resource Name (ARN) of the configured model algorithm association that you want to return information about.
+ * @public + */ + configuredModelAlgorithmAssociationArn: string | undefined; + + /** + *The membership ID of the member that created the configured model algorithm association.
+ * @public + */ + membershipIdentifier: string | undefined; +} + +/** + * @public + */ +export interface GetConfiguredModelAlgorithmAssociationResponse { + /** + *The time at which the configured model algorithm association was created.
+ * @public + */ + createTime: Date | undefined; + + /** + *The most recent time at which the configured model algorithm association was updated.
+ * @public + */ + updateTime: Date | undefined; + + /** + *The Amazon Resource Name (ARN) of the configured model algorithm association.
+ * @public + */ + configuredModelAlgorithmAssociationArn: string | undefined; + + /** + *The membership ID of the member that created the configured model algorithm association.
+ * @public + */ + membershipIdentifier: string | undefined; + + /** + *The collaboration ID of the collaboration that contains the configured model algorithm association.
+ * @public + */ + collaborationIdentifier: string | undefined; + + /** + *The Amazon Resource Name (ARN) of the configured model algorithm that was associated to the collaboration.
+ * @public + */ + configuredModelAlgorithmArn: string | undefined; + + /** + *The name of the configured model algorithm association.
+ * @public + */ + name: string | undefined; + + /** + *The privacy configuration information for the configured model algorithm association.
+ * @public + */ + privacyConfiguration?: PrivacyConfiguration; + + /** + *The description of the configured model algorithm association.
+ * @public + */ + description?: string; + + /** + *The optional metadata that you applied to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
+ *The following basic restrictions apply to tags:
+ *Maximum number of tags per resource - 50.
+ *For each resource, each tag key must be unique, and each tag key can have only one value.
+ *Maximum key length - 128 Unicode characters in UTF-8.
+ *Maximum value length - 256 Unicode characters in UTF-8.
+ *If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
+ *Tag keys and values are case sensitive.
+ *Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms ML considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.
+ *The token value retrieved from a previous call to access the next page of results.
+ * @public + */ + nextToken?: string; + + /** + *The maximum size of the results that is returned per call.
+ * @public + */ + maxResults?: number; + + /** + *The membership ID of the member that created the configured model algorithm associations you are interested in.
+ * @public + */ + membershipIdentifier: string | undefined; +} + +/** + *Provides summary information about the configured model algorithm association.
+ * @public + */ +export interface ConfiguredModelAlgorithmAssociationSummary { + /** + *The time at which the configured model algorithm association was created.
+ * @public + */ + createTime: Date | undefined; + + /** + *The most recent time at which the configured model algorithm association was updated.
+ * @public + */ + updateTime: Date | undefined; + + /** + *The Amazon Resource Name (ARN) of the configured model algorithm association.
+ * @public + */ + configuredModelAlgorithmAssociationArn: string | undefined; + + /** + *The Amazon Resource Name (ARN) of the configured model algorithm that is being associated.
+ * @public + */ + configuredModelAlgorithmArn: string | undefined; + + /** + *The name of the configured model algorithm association.
+ * @public + */ + name: string | undefined; + + /** + *The description of the configured model algorithm association.
+ * @public + */ + description?: string; + + /** + *The membership ID of the member that created the configured model algorithm association.
+ * @public + */ + membershipIdentifier: string | undefined; + + /** + *The collaboration ID of the collaboration that contains the configured model algorithm association.
+ * @public + */ + collaborationIdentifier: string | undefined; +} + +/** + * @public + */ +export interface ListConfiguredModelAlgorithmAssociationsResponse { + /** + *The token value used to access the next page of results.
+ * @public + */ + nextToken?: string; + + /** + *The list of configured model algorithm associations.
+ * @public + */ + configuredModelAlgorithmAssociations: ConfiguredModelAlgorithmAssociationSummary[] | undefined; +} + +/** + * @public + */ +export interface ListCollaborationConfiguredModelAlgorithmAssociationsRequest { + /** + *The token value retrieved from a previous call to access the next page of results.
+ * @public + */ + nextToken?: string; + + /** + *The maximum size of the results that is returned per call.
+ * @public + */ + maxResults?: number; + + /** + *The collaboration ID of the collaboration that contains the configured model algorithm associations that you are interested in.
+ * @public + */ + collaborationIdentifier: string | undefined; +} + +/** + *Provides summary information about a configured model algorithm in a collaboration.
+ * @public + */ +export interface CollaborationConfiguredModelAlgorithmAssociationSummary { + /** + *The time at which the configured model algorithm association was created.
+ * @public + */ + createTime: Date | undefined; + + /** + *The most recent time at which the configured model algorithm association was updated.
+ * @public + */ + updateTime: Date | undefined; + + /** + *The Amazon Resource Name (ARN) of the configured model algorithm association.
+ * @public + */ + configuredModelAlgorithmAssociationArn: string | undefined; + + /** + *The name of the configured model algorithm association.
+ * @public + */ + name: string | undefined; + + /** + *The description of the configured model algorithm association.
+ * @public + */ + description?: string; + + /** + *The membership ID of the member that created the configured model algorithm association.
+ * @public + */ + membershipIdentifier: string | undefined; + + /** + *The collaboration ID of the collaboration that contains the configured model algorithm association.
+ * @public + */ + collaborationIdentifier: string | undefined; + + /** + *The Amazon Resource Name (ARN) of the configured model algorithm that is associated to the collaboration.
+ * @public + */ + configuredModelAlgorithmArn: string | undefined; + + /** + *The account ID of the member that created the configured model algorithm association.
+ * @public + */ + creatorAccountId: string | undefined; +} + +/** + * @public + */ +export interface ListCollaborationConfiguredModelAlgorithmAssociationsResponse { + /** + *The token value used to access the next page of results.
+ * @public + */ + nextToken?: string; + + /** + *The configured model algorithm associations that belong to this collaboration.
+ * @public + */ + collaborationConfiguredModelAlgorithmAssociations: + | CollaborationConfiguredModelAlgorithmAssociationSummary[] + | undefined; +} + +/** + * @public + */ +export interface ListCollaborationMLInputChannelsRequest { + /** + *The token value retrieved from a previous call to access the next page of results.
+ * @public + */ + nextToken?: string; + + /** + *The maximum number of results to return.
+ * @public + */ + maxResults?: number; + + /** + *The collaboration ID of the collaboration that contains the ML input channels that you want to list.
+ * @public + */ + collaborationIdentifier: string | undefined; +} + +/** + * @public + * @enum + */ +export const MLInputChannelStatus = { + ACTIVE: "ACTIVE", + CREATE_FAILED: "CREATE_FAILED", + CREATE_IN_PROGRESS: "CREATE_IN_PROGRESS", + CREATE_PENDING: "CREATE_PENDING", + DELETE_FAILED: "DELETE_FAILED", + DELETE_IN_PROGRESS: "DELETE_IN_PROGRESS", + DELETE_PENDING: "DELETE_PENDING", + INACTIVE: "INACTIVE", +} as const; + +/** + * @public + */ +export type MLInputChannelStatus = (typeof MLInputChannelStatus)[keyof typeof MLInputChannelStatus]; + +/** + *Provides summary information about an ML input channel in a collaboration.
+ * @public + */ +export interface CollaborationMLInputChannelSummary { + /** + *The time at which the ML input channel was created.
+ * @public + */ + createTime: Date | undefined; + + /** + *The most recent time at which the ML input channel was updated.
+ * @public + */ + updateTime: Date | undefined; + + /** + *The membership ID of the membership that contains the ML input channel.
+ * @public + */ + membershipIdentifier: string | undefined; + + /** + *The collaboration ID of the collaboration that contains the ML input channel.
+ * @public + */ + collaborationIdentifier: string | undefined; + + /** + *The name of the ML input channel.
+ * @public + */ + name: string | undefined; + + /** + *The associated configured model algorithms used to create the ML input channel.
+ * @public + */ + configuredModelAlgorithmAssociations: string[] | undefined; + + /** + *The Amazon Resource Name (ARN) of the ML input channel.
+ * @public + */ + mlInputChannelArn: string | undefined; + + /** + *The status of the ML input channel.
+ * @public + */ + status: MLInputChannelStatus | undefined; + + /** + *The account ID of the member who created the ML input channel.
+ * @public + */ + creatorAccountId: string | undefined; + + /** + *The description of the ML input channel.
+ * @public + */ + description?: string; +} + +/** + * @public + */ +export interface ListCollaborationMLInputChannelsResponse { + /** + *The token value used to access the next page of results.
+ * @public + */ + nextToken?: string; + + /** + *The list of ML input channels that you wanted.
+ * @public + */ + collaborationMLInputChannelsList: CollaborationMLInputChannelSummary[] | undefined; +} + +/** + * @public + */ +export interface ListCollaborationTrainedModelExportJobsRequest { + /** + *The token value retrieved from a previous call to access the next page of results.
+ * @public + */ + nextToken?: string; + + /** + *The maximum size of the results that is returned per call.
+ * @public + */ + maxResults?: number; + + /** + *The collaboration ID of the collaboration that contains the trained model export jobs that you are interested in.
+ * @public + */ + collaborationIdentifier: string | undefined; + + /** + *The Amazon Resource Name (ARN) of the trained model that was used to create the export jobs that you are interested in.
+ * @public + */ + trainedModelArn: string | undefined; +} + +/** + *Provides information about the member who will receive trained model exports.
+ * @public + */ +export interface TrainedModelExportReceiverMember { + /** + *The account ID of the member who will receive trained model exports.
+ * @public + */ + accountId: string | undefined; +} + +/** + *Information about the output of the trained model export job.
+ * @public + */ +export interface TrainedModelExportOutputConfiguration { + /** + *The members that will received the exported trained model output.
+ * @public + */ + members: TrainedModelExportReceiverMember[] | undefined; +} + +/** + * @public + * @enum + */ +export const TrainedModelExportJobStatus = { + ACTIVE: "ACTIVE", + CREATE_FAILED: "CREATE_FAILED", + CREATE_IN_PROGRESS: "CREATE_IN_PROGRESS", + CREATE_PENDING: "CREATE_PENDING", +} as const; + +/** + * @public + */ +export type TrainedModelExportJobStatus = + (typeof TrainedModelExportJobStatus)[keyof typeof TrainedModelExportJobStatus]; + +/** + *Provides summary information about a trained model export job in a collaboration.
+ * @public + */ +export interface CollaborationTrainedModelExportJobSummary { + /** + *The time at which the trained model export job was created.
+ * @public + */ + createTime: Date | undefined; + + /** + *The most recent time at which the trained model export job was updated.
+ * @public + */ + updateTime: Date | undefined; + + /** + *The name of the trained model export job.
+ * @public + */ + name: string | undefined; + + /** + *Information about the output of the trained model export job.
+ * @public + */ + outputConfiguration: TrainedModelExportOutputConfiguration | undefined; + + /** + *The status of the trained model.
+ * @public + */ + status: TrainedModelExportJobStatus | undefined; + + /** + *Details about the status of a resource.
+ * @public + */ + statusDetails?: StatusDetails; + + /** + *The description of the trained model.
+ * @public + */ + description?: string; + + /** + *The account ID of the member that created the trained model.
+ * @public + */ + creatorAccountId: string | undefined; + + /** + *The Amazon Resource Name (ARN) of the trained model that is being exported.
+ * @public + */ + trainedModelArn: string | undefined; + + /** + *The membership ID of the member that created the trained model export job.
+ * @public + */ + membershipIdentifier: string | undefined; + + /** + *The collaboration ID of the collaboration that contains the trained model export job.
+ * @public + */ + collaborationIdentifier: string | undefined; +} + +/** + * @public + */ +export interface ListCollaborationTrainedModelExportJobsResponse { + /** + *The token value used to access the next page of results.
+ * @public + */ + nextToken?: string; + + /** + *The exports jobs that exist for the requested trained model in the requested collaboration.
+ * @public + */ + collaborationTrainedModelExportJobs: CollaborationTrainedModelExportJobSummary[] | undefined; +} + +/** + * @public + */ +export interface ListCollaborationTrainedModelInferenceJobsRequest { + /** + *The token value retrieved from a previous call to access the next page of results.
+ * @public + */ + nextToken?: string; + + /** + *The maximum size of the results that is returned per call.
+ * @public + */ + maxResults?: number; + + /** + *The collaboration ID of the collaboration that contains the trained model inference jobs that you are interested in.
+ * @public + */ + collaborationIdentifier: string | undefined; + + /** + *The Amazon Resource Name (ARN) of the trained model that was used to create the trained model inference jobs that you are interested in.
+ * @public + */ + trainedModelArn?: string; +} + +/** + * @public + * @enum + */ +export const LogsStatus = { + PUBLISH_FAILED: "PUBLISH_FAILED", + PUBLISH_SUCCEEDED: "PUBLISH_SUCCEEDED", +} as const; + +/** + * @public + */ +export type LogsStatus = (typeof LogsStatus)[keyof typeof LogsStatus]; + +/** + * @public + * @enum + */ +export const MetricsStatus = { + PUBLISH_FAILED: "PUBLISH_FAILED", + PUBLISH_SUCCEEDED: "PUBLISH_SUCCEEDED", +} as const; + +/** + * @public + */ +export type MetricsStatus = (typeof MetricsStatus)[keyof typeof MetricsStatus]; + +/** + *Defines who will receive inference results.
+ * @public + */ +export interface InferenceReceiverMember { + /** + *The account ID of the member that can receive inference results.
+ * @public + */ + accountId: string | undefined; +} + +/** + *Configuration information about how the inference output is stored.
+ * @public + */ +export interface InferenceOutputConfiguration { + /** + *The MIME type used to specify the output data.
+ * @public + */ + accept?: string; + + /** + *Defines the members that can receive inference output.
+ * @public + */ + members: InferenceReceiverMember[] | undefined; +} + +/** + * @public + * @enum + */ +export const TrainedModelInferenceJobStatus = { + ACTIVE: "ACTIVE", + CANCEL_FAILED: "CANCEL_FAILED", + CANCEL_IN_PROGRESS: "CANCEL_IN_PROGRESS", + CANCEL_PENDING: "CANCEL_PENDING", + CREATE_FAILED: "CREATE_FAILED", + CREATE_IN_PROGRESS: "CREATE_IN_PROGRESS", + CREATE_PENDING: "CREATE_PENDING", + INACTIVE: "INACTIVE", +} as const; + +/** + * @public + */ +export type TrainedModelInferenceJobStatus = + (typeof TrainedModelInferenceJobStatus)[keyof typeof TrainedModelInferenceJobStatus]; + +/** + *Provides summary information about a trained model inference job in a collaboration.
+ * @public + */ +export interface CollaborationTrainedModelInferenceJobSummary { + /** + *The Amazon Resource Name (ARN) of the trained model inference job.
+ * @public + */ + trainedModelInferenceJobArn: string | undefined; + + /** + *The Amazon Resource Name (ARN) of the configured model algorithm association that is used for the trained model inference job.
+ * @public + */ + configuredModelAlgorithmAssociationArn?: string; + + /** + *The membership ID of the membership that contains the trained model inference job.
+ * @public + */ + membershipIdentifier: string | undefined; + + /** + *The Amazon Resource Name (ARN) of the trained model that is used for the trained model inference job.
+ * @public + */ + trainedModelArn: string | undefined; + + /** + *The collaboration ID of the collaboration that contains the trained model inference job.
+ * @public + */ + collaborationIdentifier: string | undefined; + + /** + *The status of the trained model inference job.
+ * @public + */ + status: TrainedModelInferenceJobStatus | undefined; + + /** + *Returns output configuration information for the trained model inference job.
+ * @public + */ + outputConfiguration: InferenceOutputConfiguration | undefined; + + /** + *The name of the trained model inference job.
+ * @public + */ + name: string | undefined; + + /** + *The description of the trained model inference job.
+ * @public + */ + description?: string; + + /** + *the trained model inference job metrics status.
+ * @public + */ + metricsStatus?: MetricsStatus; + + /** + *Details about the metrics status for trained model inference job.
+ * @public + */ + metricsStatusDetails?: string; + + /** + *The trained model inference job logs status.
+ * @public + */ + logsStatus?: LogsStatus; + + /** + *Details about the logs status for the trained model inference job.
+ * @public + */ + logsStatusDetails?: string; + + /** + *The time at which the trained model inference job was created.
+ * @public + */ + createTime: Date | undefined; + + /** + *The most recent time at which the trained model inference job was updated.
+ * @public + */ + updateTime: Date | undefined; + + /** + *The account ID that created the trained model inference job.
+ * @public + */ + creatorAccountId: string | undefined; +} + +/** + * @public + */ +export interface ListCollaborationTrainedModelInferenceJobsResponse { + /** + *The token value used to access the next page of results.
+ * @public + */ + nextToken?: string; + + /** + *The trained model inference jobs that you are interested in.
+ * @public + */ + collaborationTrainedModelInferenceJobs: CollaborationTrainedModelInferenceJobSummary[] | undefined; +} + +/** + * @public + */ +export interface ListCollaborationTrainedModelsRequest { + /** + *The token value retrieved from a previous call to access the next page of results.
+ * @public + */ + nextToken?: string; + + /** + *The maximum size of the results that is returned per call.
+ * @public + */ + maxResults?: number; + + /** + *The collaboration ID of the collaboration that contains the trained models you are interested in.
+ * @public + */ + collaborationIdentifier: string | undefined; +} + +/** + * @public + * @enum + */ +export const TrainedModelStatus = { + ACTIVE: "ACTIVE", + CANCEL_FAILED: "CANCEL_FAILED", + CANCEL_IN_PROGRESS: "CANCEL_IN_PROGRESS", + CANCEL_PENDING: "CANCEL_PENDING", + CREATE_FAILED: "CREATE_FAILED", + CREATE_IN_PROGRESS: "CREATE_IN_PROGRESS", + CREATE_PENDING: "CREATE_PENDING", + DELETE_FAILED: "DELETE_FAILED", + DELETE_IN_PROGRESS: "DELETE_IN_PROGRESS", + DELETE_PENDING: "DELETE_PENDING", + INACTIVE: "INACTIVE", +} as const; + +/** + * @public + */ +export type TrainedModelStatus = (typeof TrainedModelStatus)[keyof typeof TrainedModelStatus]; + +/** + *Provides summary information about a trained model in a collaboration.
+ * @public + */ +export interface CollaborationTrainedModelSummary { + /** + *The time at which the trained model was created.
+ * @public + */ + createTime: Date | undefined; + + /** + *The most recent time at which the trained model was updated.
+ * @public + */ + updateTime: Date | undefined; + + /** + *The Amazon Resource Name (ARN) of the trained model.
+ * @public + */ + trainedModelArn: string | undefined; + + /** + *The name of the trained model.
+ * @public + */ + name: string | undefined; + + /** + *The description of the trained model.
+ * @public + */ + description?: string; + + /** + *The membership ID of the member that created the trained model.
+ * @public + */ + membershipIdentifier: string | undefined; + + /** + *The collaboration ID of the collaboration that contains the trained model.
+ * @public + */ + collaborationIdentifier: string | undefined; + + /** + *The status of the trained model.
+ * @public + */ + status: TrainedModelStatus | undefined; + + /** + *The Amazon Resource Name (ARN) of the configured model algorithm association that is used for this trained model.
+ * @public + */ + configuredModelAlgorithmAssociationArn: string | undefined; + + /** + *The account ID of the member that created the trained model.
+ * @public + */ + creatorAccountId: string | undefined; +} + +/** + * @public + */ +export interface ListCollaborationTrainedModelsResponse { + /** + *The token value used to access the next page of results.
+ * @public + */ + nextToken?: string; + + /** + *The trained models in the collaboration that you requested.
+ * @public + */ + collaborationTrainedModels: CollaborationTrainedModelSummary[] | undefined; +} + +/** + * @public + */ +export interface ListTagsForResourceRequest { + /** + *The Amazon Resource Name (ARN) of the resource that you are interested in.
+ * @public + */ + resourceArn: string | undefined; +} + +/** + * @public + */ +export interface ListTagsForResourceResponse { + /** + *The tags that are associated with the resource.
+ * @public + */ + tags: RecordThe membership ID of the of the member that is deleting the ML modeling configuration.
+ * @public + */ + membershipIdentifier: string | undefined; +} + +/** + * @public + */ +export interface GetMLConfigurationRequest { + /** + *The membership ID of the member that owns the ML configuration you want to return information about.
+ * @public + */ + membershipIdentifier: string | undefined; +} + +/** + *The Amazon S3 location where the exported model artifacts are stored.
+ * @public + */ +export interface Destination { + /** + *Provides information about an Amazon S3 bucket and path.
+ * @public + */ + s3Destination: S3ConfigMap | undefined; +} + +/** + *Configuration information about how the exported model artifacts are stored.
+ * @public + */ +export interface MLOutputConfiguration { + /** + *The Amazon S3 location where exported model artifacts are stored.
+ * @public + */ + destination?: Destination; + + /** + *The Amazon Resource Name (ARN) of the service access role that is used to store the model artifacts.
+ * @public + */ + roleArn: string | undefined; +} + +/** + * @public + */ +export interface GetMLConfigurationResponse { + /** + *The membership ID of the member that owns the ML configuration you requested.
+ * @public + */ + membershipIdentifier: string | undefined; + + /** + *The Amazon S3 location where ML model output is stored.
+ * @public + */ + defaultOutputLocation: MLOutputConfiguration | undefined; + + /** + *The time at which the ML configuration was created.
+ * @public + */ + createTime: Date | undefined; + + /** + *The most recent time at which the ML configuration was updated.
+ * @public + */ + updateTime: Date | undefined; +} + +/** + * @public + */ +export interface PutMLConfigurationRequest { + /** + *The membership ID of the member that is being configured.
+ * @public + */ + membershipIdentifier: string | undefined; + + /** + *The default Amazon S3 location where ML output is stored for the specified member.
+ * @public + */ + defaultOutputLocation: MLOutputConfiguration | undefined; +} + +/** + * @public + * @enum + */ +export const WorkerComputeType = { + CR1X: "CR.1X", + CR4X: "CR.4X", +} as const; + +/** + * @public + */ +export type WorkerComputeType = (typeof WorkerComputeType)[keyof typeof WorkerComputeType]; + +/** + *Configuration information about the compute workers that perform the transform job.
+ * @public + */ +export interface WorkerComputeConfiguration { + /** + *The instance type of the compute workers that are used.
+ * @public + */ + type?: WorkerComputeType; + + /** + *The number of compute workers that are used.
+ * @public + */ + number?: number; +} + +/** + *Provides configuration information for the instances that will perform the compute work.
+ * @public + */ +export type ComputeConfiguration = ComputeConfiguration.WorkerMember | ComputeConfiguration.$UnknownMember; + +/** + * @public + */ +export namespace ComputeConfiguration { + /** + *The worker instances that will perform the compute work.
+ * @public + */ + export interface WorkerMember { + worker: WorkerComputeConfiguration; + $unknown?: never; + } + + /** + * @public + */ + export interface $UnknownMember { + worker?: never; + $unknown: [string, any]; + } + + export interface VisitorProvides information necessary to perform the protected query.
+ * @public + */ +export interface ProtectedQueryInputParameters { + /** + *The parameters for the SQL type Protected Query.
+ * @public + */ + sqlParameters: ProtectedQuerySQLParameters | undefined; + + /** + *Provides configuration information for the workers that will perform the protected query.
+ * @public + */ + computeConfiguration?: ComputeConfiguration; +} + +/** + *Provides the data source that is used to define an input channel.
+ * @public + */ +export type InputChannelDataSource = + | InputChannelDataSource.ProtectedQueryInputParametersMember + | InputChannelDataSource.$UnknownMember; + +/** + * @public + */ +export namespace InputChannelDataSource { + /** + *Provides information necessary to perform the protected query.
+ * @public + */ + export interface ProtectedQueryInputParametersMember { + protectedQueryInputParameters: ProtectedQueryInputParameters; + $unknown?: never; + } + + /** + * @public + */ + export interface $UnknownMember { + protectedQueryInputParameters?: never; + $unknown: [string, any]; + } + + export interface VisitorProvides information about the data source that is used to create an ML input channel.
+ * @public + */ +export interface InputChannel { + /** + *The data source that is used to create the ML input channel.
+ * @public + */ + dataSource: InputChannelDataSource | undefined; + + /** + *The ARN of the IAM role that Clean Rooms ML can assume to read the data referred to in the dataSource field the input channel.
Passing a role across AWS accounts is not allowed. If you pass a role that isn't in your account, you get an AccessDeniedException error.
The membership ID of the member that is creating the ML input channel.
+ * @public + */ + membershipIdentifier: string | undefined; + + /** + *The associated configured model algorithms that are necessary to create this ML input channel.
+ * @public + */ + configuredModelAlgorithmAssociations: string[] | undefined; + + /** + *The input data that is used to create this ML input channel.
+ * @public + */ + inputChannel: InputChannel | undefined; + + /** + *The name of the ML input channel.
+ * @public + */ + name: string | undefined; + + /** + *The number of days that the data in the ML input channel is retained.
+ * @public + */ + retentionInDays: number | undefined; + + /** + *The description of the ML input channel.
+ * @public + */ + description?: string; + + /** + *The Amazon Resource Name (ARN) of the KMS key that is used to access the input channel.
+ * @public + */ + kmsKeyArn?: string; + + /** + *The optional metadata that you apply to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
+ *The following basic restrictions apply to tags:
+ *Maximum number of tags per resource - 50.
+ *For each resource, each tag key must be unique, and each tag key can have only one value.
+ *Maximum key length - 128 Unicode characters in UTF-8.
+ *Maximum value length - 256 Unicode characters in UTF-8.
+ *If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
+ *Tag keys and values are case sensitive.
+ *Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms ML considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.
+ *The Amazon Resource Name (ARN) of the ML input channel.
+ * @public + */ + mlInputChannelArn: string | undefined; +} + +/** + * @public + */ +export interface DeleteMLInputChannelDataRequest { + /** + *The Amazon Resource Name (ARN) of the ML input channel that you want to delete.
+ * @public + */ + mlInputChannelArn: string | undefined; + + /** + *The membership ID of the membership that contains the ML input channel you want to delete.
+ * @public + */ + membershipIdentifier: string | undefined; +} + +/** + * @public + */ +export interface GetCollaborationMLInputChannelRequest { + /** + *The Amazon Resource Name (ARN) of the ML input channel that you want to get.
+ * @public + */ + mlInputChannelArn: string | undefined; + + /** + *The collaboration ID of the collaboration that contains the ML input channel that you want to get.
+ * @public + */ + collaborationIdentifier: string | undefined; +} + +/** + * @public + */ +export interface GetCollaborationMLInputChannelResponse { + /** + *The time at which the ML input channel was created.
+ * @public + */ + createTime: Date | undefined; + + /** + *The most recent time at which the ML input channel was updated.
+ * @public + */ + updateTime: Date | undefined; + + /** + *The account ID of the member who created the ML input channel.
+ * @public + */ + creatorAccountId: string | undefined; + + /** + *The membership ID of the membership that contains the ML input channel.
+ * @public + */ + membershipIdentifier: string | undefined; + + /** + *The collaboration ID of the collaboration that contains the ML input channel.
+ * @public + */ + collaborationIdentifier: string | undefined; + + /** + *The Amazon Resource Name (ARN) of the ML input channel.
+ * @public + */ + mlInputChannelArn: string | undefined; + + /** + *The name of the ML input channel.
+ * @public + */ + name: string | undefined; + + /** + *The configured model algorithm associations that were used to create the ML input channel.
+ * @public + */ + configuredModelAlgorithmAssociations: string[] | undefined; + + /** + *The status of the ML input channel.
+ * @public + */ + status: MLInputChannelStatus | undefined; + + /** + *Details about the status of a resource.
+ * @public + */ + statusDetails?: StatusDetails; + + /** + *The number of days to retain the data for the ML input channel.
+ * @public + */ + retentionInDays: number | undefined; + + /** + *The number of records in the ML input channel.
+ * @public + */ + numberOfRecords?: number; + + /** + *The description of the ML input channel.
+ * @public + */ + description?: string; +} + +/** + * @public + */ +export interface GetMLInputChannelRequest { + /** + *The Amazon Resource Name (ARN) of the ML input channel that you want to get.
+ * @public + */ + mlInputChannelArn: string | undefined; + + /** + *The membership ID of the membership that contains the ML input channel that you want to get.
+ * @public + */ + membershipIdentifier: string | undefined; +} + +/** + * @public + */ +export interface GetMLInputChannelResponse { + /** + *The time at which the ML input channel was created.
+ * @public + */ + createTime: Date | undefined; + + /** + *The most recent time at which the ML input channel was updated.
+ * @public + */ + updateTime: Date | undefined; + + /** + *The membership ID of the membership that contains the ML input channel.
+ * @public + */ + membershipIdentifier: string | undefined; + + /** + *The collaboration ID of the collaboration that contains the ML input channel.
+ * @public + */ + collaborationIdentifier: string | undefined; + + /** + *The input channel that was used to create the ML input channel.
+ * @public + */ + inputChannel: InputChannel | undefined; + + /** + *The ID of the protected query that was used to create the ML input channel.
+ * @public + */ + protectedQueryIdentifier?: string; + + /** + *The Amazon Resource Name (ARN) of the ML input channel.
+ * @public + */ + mlInputChannelArn: string | undefined; + + /** + *The name of the ML input channel.
+ * @public + */ + name: string | undefined; + + /** + *The configured model algorithm associations that were used to create the ML input channel.
+ * @public + */ + configuredModelAlgorithmAssociations: string[] | undefined; + + /** + *The status of the ML input channel.
+ * @public + */ + status: MLInputChannelStatus | undefined; + + /** + *Details about the status of a resource.
+ * @public + */ + statusDetails?: StatusDetails; + + /** + *The number of days to keep the data in the ML input channel.
+ * @public + */ + retentionInDays: number | undefined; + + /** + *The number of records in the ML input channel.
+ * @public + */ + numberOfRecords?: number; + + /** + *The number of files in the ML input channel.
+ * @public + */ + numberOfFiles?: number; + + /** + *The size, in GB, of the ML input channel.
+ * @public + */ + sizeInGb?: number; + + /** + *The description of the ML input channel.
+ * @public + */ + description?: string; + + /** + *The Amazon Resource Name (ARN) of the KMS key that was used to create the ML input channel.
+ * @public + */ + kmsKeyArn?: string; + + /** + *The optional metadata that you applied to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
+ *The following basic restrictions apply to tags:
+ *Maximum number of tags per resource - 50.
+ *For each resource, each tag key must be unique, and each tag key can have only one value.
+ *Maximum key length - 128 Unicode characters in UTF-8.
+ *Maximum value length - 256 Unicode characters in UTF-8.
+ *If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
+ *Tag keys and values are case sensitive.
+ *Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms ML considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.
+ *The token value retrieved from a previous call to access the next page of results.
+ * @public + */ + nextToken?: string; + + /** + *The maximum number of ML input channels to return.
+ * @public + */ + maxResults?: number; + + /** + *The membership ID of the membership that contains the ML input channels that you want to list.
+ * @public + */ + membershipIdentifier: string | undefined; +} + +/** + *Provides summary information about the ML input channel.
+ * @public + */ +export interface MLInputChannelSummary { + /** + *The time at which the ML input channel was created.
+ * @public + */ + createTime: Date | undefined; + + /** + *The most recent time at which the ML input channel was updated.
+ * @public + */ + updateTime: Date | undefined; + + /** + *The membership ID of the membership that contains the ML input channel.
+ * @public + */ + membershipIdentifier: string | undefined; + + /** + *The collaboration ID of the collaboration that contains the ML input channel.
+ * @public + */ + collaborationIdentifier: string | undefined; + + /** + *The name of the ML input channel.
+ * @public + */ + name: string | undefined; + + /** + *The associated configured model algorithms used to create the ML input channel.
+ * @public + */ + configuredModelAlgorithmAssociations: string[] | undefined; + + /** + *The ID of the protected query that was used to create the ML input channel.
+ * @public + */ + protectedQueryIdentifier?: string; + + /** + *The Amazon Resource Name (ARN) of the ML input channel.
+ * @public + */ + mlInputChannelArn: string | undefined; + + /** + *The status of the ML input channel.
+ * @public + */ + status: MLInputChannelStatus | undefined; + + /** + *The description of the ML input channel.
+ * @public + */ + description?: string; +} + +/** + * @public + */ +export interface ListMLInputChannelsResponse { + /** + *The token value used to access the next page of results.
+ * @public + */ + nextToken?: string; + + /** + *The list of ML input channels that you wanted.
+ * @public + */ + mlInputChannelsList: MLInputChannelSummary[] | undefined; +} + +/** + * @public + */ +export interface TagResourceRequest { + /** + *The Amazon Resource Name (ARN) of the resource that you want to assign tags.
+ * @public + */ + resourceArn: string | undefined; + + /** + *The optional metadata that you apply to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
+ *The following basic restrictions apply to tags:
+ *Maximum number of tags per resource - 50.
+ *For each resource, each tag key must be unique, and each tag key can have only one value.
+ *Maximum key length - 128 Unicode characters in UTF-8.
+ *Maximum value length - 256 Unicode characters in UTF-8.
+ *If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
+ *Tag keys and values are case sensitive.
+ *Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.
+ *The membership ID of the trained model job that you want to cancel.
+ * @public + */ + membershipIdentifier: string | undefined; + + /** + *The Amazon Resource Name (ARN) of the trained model job that you want to cancel.
+ * @public + */ + trainedModelArn: string | undefined; +} + +/** + *Information about the model training data channel. A training data channel is a named data source that the training algorithms can consume.
+ * @public + */ +export interface ModelTrainingDataChannel { + /** + *The Amazon Resource Name (ARN) of the ML input channel for this model training data channel.
+ * @public + */ + mlInputChannelArn: string | undefined; + + /** + *The name of the training data channel.
+ * @public + */ + channelName: string | undefined; +} + +/** + * @public + * @enum + */ +export const _InstanceType = { + ML_C4_2XLARGE: "ml.c4.2xlarge", + ML_C4_4XLARGE: "ml.c4.4xlarge", + ML_C4_8XLARGE: "ml.c4.8xlarge", + ML_C4_XLARGE: "ml.c4.xlarge", + ML_C5N_18XLARGE: "ml.c5n.18xlarge", + ML_C5N_2XLARGE: "ml.c5n.2xlarge", + ML_C5N_4XLARGE: "ml.c5n.4xlarge", + ML_C5N_9XLARGE: "ml.c5n.9xlarge", + ML_C5N_XLARGE: "ml.c5n.xlarge", + ML_C5_18XLARGE: "ml.c5.18xlarge", + ML_C5_2XLARGE: "ml.c5.2xlarge", + ML_C5_4XLARGE: "ml.c5.4xlarge", + ML_C5_9XLARGE: "ml.c5.9xlarge", + ML_C5_XLARGE: "ml.c5.xlarge", + ML_C6I_12XLARGE: "ml.c6i.12xlarge", + ML_C6I_16XLARGE: "ml.c6i.16xlarge", + ML_C6I_24XLARGE: "ml.c6i.24xlarge", + ML_C6I_2XLARGE: "ml.c6i.2xlarge", + ML_C6I_32XLARGE: "ml.c6i.32xlarge", + ML_C6I_4XLARGE: "ml.c6i.4xlarge", + ML_C6I_8XLARGE: "ml.c6i.8xlarge", + ML_C6I_XLARGE: "ml.c6i.xlarge", + ML_G4DN_12XLARGE: "ml.g4dn.12xlarge", + ML_G4DN_16XLARGE: "ml.g4dn.16xlarge", + ML_G4DN_2XLARGE: "ml.g4dn.2xlarge", + ML_G4DN_4XLARGE: "ml.g4dn.4xlarge", + ML_G4DN_8XLARGE: "ml.g4dn.8xlarge", + ML_G4DN_XLARGE: "ml.g4dn.xlarge", + ML_G5_12XLARGE: "ml.g5.12xlarge", + ML_G5_16XLARGE: "ml.g5.16xlarge", + ML_G5_24XLARGE: "ml.g5.24xlarge", + ML_G5_2XLARGE: "ml.g5.2xlarge", + ML_G5_48XLARGE: "ml.g5.48xlarge", + ML_G5_4XLARGE: "ml.g5.4xlarge", + ML_G5_8XLARGE: "ml.g5.8xlarge", + ML_G5_XLARGE: "ml.g5.xlarge", + ML_M4_10XLARGE: "ml.m4.10xlarge", + ML_M4_16XLARGE: "ml.m4.16xlarge", + ML_M4_2XLARGE: "ml.m4.2xlarge", + ML_M4_4XLARGE: "ml.m4.4xlarge", + ML_M4_XLARGE: "ml.m4.xlarge", + ML_M5_12XLARGE: "ml.m5.12xlarge", + ML_M5_24XLARGE: "ml.m5.24xlarge", + ML_M5_2XLARGE: "ml.m5.2xlarge", + ML_M5_4XLARGE: "ml.m5.4xlarge", + ML_M5_LARGE: "ml.m5.large", + ML_M5_XLARGE: "ml.m5.xlarge", + ML_M6I_12XLARGE: "ml.m6i.12xlarge", + ML_M6I_16XLARGE: "ml.m6i.16xlarge", + ML_M6I_24XLARGE: "ml.m6i.24xlarge", + ML_M6I_2XLARGE: "ml.m6i.2xlarge", + ML_M6I_32XLARGE: "ml.m6i.32xlarge", + ML_M6I_4XLARGE: "ml.m6i.4xlarge", + ML_M6I_8XLARGE: "ml.m6i.8xlarge", + ML_M6I_LARGE: "ml.m6i.large", + ML_M6I_XLARGE: "ml.m6i.xlarge", + ML_P2_16XLARGE: "ml.p2.16xlarge", + ML_P2_8XLARGE: "ml.p2.8xlarge", + ML_P2_XLARGE: "ml.p2.xlarge", + ML_P3DN_24XLARGE: "ml.p3dn.24xlarge", + ML_P3_16XLARGE: "ml.p3.16xlarge", + ML_P3_2XLARGE: "ml.p3.2xlarge", + ML_P3_8XLARGE: "ml.p3.8xlarge", + ML_P4DE_24XLARGE: "ml.p4de.24xlarge", + ML_P4D_24XLARGE: "ml.p4d.24xlarge", + ML_P5_48XLARGE: "ml.p5.48xlarge", + ML_R5D_12XLARGE: "ml.r5d.12xlarge", + ML_R5D_16XLARGE: "ml.r5d.16xlarge", + ML_R5D_24XLARGE: "ml.r5d.24xlarge", + ML_R5D_2XLARGE: "ml.r5d.2xlarge", + ML_R5D_4XLARGE: "ml.r5d.4xlarge", + ML_R5D_8XLARGE: "ml.r5d.8xlarge", + ML_R5D_LARGE: "ml.r5d.large", + ML_R5D_XLARGE: "ml.r5d.xlarge", + ML_R5_12XLARGE: "ml.r5.12xlarge", + ML_R5_16XLARGE: "ml.r5.16xlarge", + ML_R5_24XLARGE: "ml.r5.24xlarge", + ML_R5_2XLARGE: "ml.r5.2xlarge", + ML_R5_4XLARGE: "ml.r5.4xlarge", + ML_R5_8XLARGE: "ml.r5.8xlarge", + ML_R5_LARGE: "ml.r5.large", + ML_R5_XLARGE: "ml.r5.xlarge", + ML_T3_2XLARGE: "ml.t3.2xlarge", + ML_T3_LARGE: "ml.t3.large", + ML_T3_MEDIUM: "ml.t3.medium", + ML_T3_XLARGE: "ml.t3.xlarge", + ML_TRN1N_32XLARGE: "ml.trn1n.32xlarge", + ML_TRN1_2XLARGE: "ml.trn1.2xlarge", + ML_TRN1_32XLARGE: "ml.trn1.32xlarge", +} as const; + +/** + * @public + */ +export type _InstanceType = (typeof _InstanceType)[keyof typeof _InstanceType]; + +/** + *Information about the EC2 resources that are used to train the model.
+ * @public + */ +export interface ResourceConfig { + /** + *The number of resources that are used to train the model.
+ * @public + */ + instanceCount?: number; + + /** + *The instance type that is used to train the model.
+ * @public + */ + instanceType: _InstanceType | undefined; + + /** + *The maximum size of the instance that is used to train the model.
+ * @public + */ + volumeSizeInGB: number | undefined; +} + +/** + *The criteria used to stop model training.
+ * @public + */ +export interface StoppingCondition { + /** + *The maximum amount of time, in seconds, that model training can run before it is terminated.
+ * @public + */ + maxRuntimeInSeconds?: number; +} + +/** + * @public + */ +export interface CreateTrainedModelRequest { + /** + *The membership ID of the member that is creating the trained model.
+ * @public + */ + membershipIdentifier: string | undefined; + + /** + *The name of the trained model.
+ * @public + */ + name: string | undefined; + + /** + *The associated configured model algorithm used to train this model.
+ * @public + */ + configuredModelAlgorithmAssociationArn: string | undefined; + + /** + *Algorithm-specific parameters that influence the quality of the model. You set hyperparameters before you start the learning process.
+ * @public + */ + hyperparameters?: RecordThe environment variables to set in the Docker container.
+ * @public + */ + environment?: RecordInformation about the EC2 resources that are used to train this model.
+ * @public + */ + resourceConfig: ResourceConfig | undefined; + + /** + *The criteria that is used to stop model training.
+ * @public + */ + stoppingCondition?: StoppingCondition; + + /** + *Defines the data channels that are used as input for the trained model request.
+ * @public + */ + dataChannels: ModelTrainingDataChannel[] | undefined; + + /** + *The description of the trained model.
+ * @public + */ + description?: string; + + /** + *The Amazon Resource Name (ARN) of the KMS key. This key is used to encrypt and decrypt customer-owned data in the trained ML model and the associated data.
+ * @public + */ + kmsKeyArn?: string; + + /** + *The optional metadata that you apply to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
+ *The following basic restrictions apply to tags:
+ *Maximum number of tags per resource - 50.
+ *For each resource, each tag key must be unique, and each tag key can have only one value.
+ *Maximum key length - 128 Unicode characters in UTF-8.
+ *Maximum value length - 256 Unicode characters in UTF-8.
+ *If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
+ *Tag keys and values are case sensitive.
+ *Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms ML considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.
+ *The Amazon Resource Name (ARN) of the trained model.
+ * @public + */ + trainedModelArn: string | undefined; +} + +/** + * @public + */ +export interface DeleteTrainedModelOutputRequest { + /** + *The Amazon Resource Name (ARN) of the trained model whose output you want to delete.
+ * @public + */ + trainedModelArn: string | undefined; + + /** + *The membership ID of the member that is deleting the trained model output.
+ * @public + */ + membershipIdentifier: string | undefined; +} + +/** + * @public + */ +export interface GetCollaborationTrainedModelRequest { + /** + *The Amazon Resource Name (ARN) of the trained model that you want to return information about.
+ * @public + */ + trainedModelArn: string | undefined; + + /** + *The collaboration ID that contains the trained model that you want to return information about.
+ * @public + */ + collaborationIdentifier: string | undefined; +} + +/** + * @public + */ +export interface GetCollaborationTrainedModelResponse { + /** + *The membership ID of the member that created the trained model.
+ * @public + */ + membershipIdentifier: string | undefined; + + /** + *The collaboration ID of the collaboration that contains the trained model.
+ * @public + */ + collaborationIdentifier: string | undefined; + + /** + *The Amazon Resource Name (ARN) of the trained model.
+ * @public + */ + trainedModelArn: string | undefined; + + /** + *The name of the trained model.
+ * @public + */ + name: string | undefined; + + /** + *The description of the trained model.
+ * @public + */ + description?: string; + + /** + *The status of the trained model.
+ * @public + */ + status: TrainedModelStatus | undefined; + + /** + *Details about the status of a resource.
+ * @public + */ + statusDetails?: StatusDetails; + + /** + *The Amazon Resource Name (ARN) of the configured model algorithm association that was used to create this trained model.
+ * @public + */ + configuredModelAlgorithmAssociationArn: string | undefined; + + /** + *The EC2 resource configuration that was used to train this model.
+ * @public + */ + resourceConfig?: ResourceConfig; + + /** + *The stopping condition that determined when model training ended.
+ * @public + */ + stoppingCondition?: StoppingCondition; + + /** + *The status of the model metrics.
+ * @public + */ + metricsStatus?: MetricsStatus; + + /** + *Details about the status information for the model metrics.
+ * @public + */ + metricsStatusDetails?: string; + + /** + *Status information for the logs.
+ * @public + */ + logsStatus?: LogsStatus; + + /** + *Details about the status information for the logs.
+ * @public + */ + logsStatusDetails?: string; + + /** + *Information about the training container image.
+ * @public + */ + trainingContainerImageDigest?: string; + + /** + *The time at which the trained model was created.
+ * @public + */ + createTime: Date | undefined; + + /** + *The most recent time at which the trained model was updated.
+ * @public + */ + updateTime: Date | undefined; + + /** + *The account ID of the member that created the trained model.
+ * @public + */ + creatorAccountId: string | undefined; +} + +/** + * @public + */ +export interface GetTrainedModelRequest { + /** + *The Amazon Resource Name (ARN) of the trained model that you are interested in.
+ * @public + */ + trainedModelArn: string | undefined; + + /** + *The membership ID of the member that created the trained model that you are interested in.
+ * @public + */ + membershipIdentifier: string | undefined; +} + +/** + * @public + */ +export interface GetTrainedModelResponse { + /** + *The membership ID of the member that created the trained model.
+ * @public + */ + membershipIdentifier: string | undefined; + + /** + *The collaboration ID of the collaboration that contains the trained model.
+ * @public + */ + collaborationIdentifier: string | undefined; + + /** + *The Amazon Resource Name (ARN) of the trained model.
+ * @public + */ + trainedModelArn: string | undefined; + + /** + *The name of the trained model.
+ * @public + */ + name: string | undefined; + + /** + *The description of the trained model.
+ * @public + */ + description?: string; + + /** + *The status of the trained model.
+ * @public + */ + status: TrainedModelStatus | undefined; + + /** + *Details about the status of a resource.
+ * @public + */ + statusDetails?: StatusDetails; + + /** + *The Amazon Resource Name (ARN) of the configured model algorithm association that was used to create the trained model.
+ * @public + */ + configuredModelAlgorithmAssociationArn: string | undefined; + + /** + *The EC2 resource configuration that was used to create the trained model.
+ * @public + */ + resourceConfig?: ResourceConfig; + + /** + *The stopping condition that was used to terminate model training.
+ * @public + */ + stoppingCondition?: StoppingCondition; + + /** + *The status of the model metrics.
+ * @public + */ + metricsStatus?: MetricsStatus; + + /** + *Details about the metrics status for the trained model.
+ * @public + */ + metricsStatusDetails?: string; + + /** + *The logs status for the trained model.
+ * @public + */ + logsStatus?: LogsStatus; + + /** + *Details about the logs status for the trained model.
+ * @public + */ + logsStatusDetails?: string; + + /** + *Information about the training image container.
+ * @public + */ + trainingContainerImageDigest?: string; + + /** + *The time at which the trained model was created.
+ * @public + */ + createTime: Date | undefined; + + /** + *The most recent time at which the trained model was updated.
+ * @public + */ + updateTime: Date | undefined; + + /** + *The hyperparameters that were used to create the trained model.
+ * @public + */ + hyperparameters?: RecordThe EC2 environment that was used to create the trained model.
+ * @public + */ + environment?: RecordThe Amazon Resource Name (ARN) of the KMS key. This key is used to encrypt and decrypt customer-owned data in the trained ML model and associated data.
+ * @public + */ + kmsKeyArn?: string; + + /** + *The optional metadata that you applied to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
+ *The following basic restrictions apply to tags:
+ *Maximum number of tags per resource - 50.
+ *For each resource, each tag key must be unique, and each tag key can have only one value.
+ *Maximum key length - 128 Unicode characters in UTF-8.
+ *Maximum value length - 256 Unicode characters in UTF-8.
+ *If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
+ *Tag keys and values are case sensitive.
+ *Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms ML considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.
+ *The data channels that were used for the trained model.
+ * @public + */ + dataChannels: ModelTrainingDataChannel[] | undefined; +} + +/** + * @public + */ +export interface ListTrainedModelsRequest { + /** + *The token value retrieved from a previous call to access the next page of results.
+ * @public + */ + nextToken?: string; + + /** + *The maximum size of the results that is returned per call.
+ * @public + */ + maxResults?: number; + + /** + *The membership ID of the member that created the trained models you are interested in.
+ * @public + */ + membershipIdentifier: string | undefined; +} + +/** + *Summary information about the trained model.
+ * @public + */ +export interface TrainedModelSummary { + /** + *The time at which the trained model was created.
+ * @public + */ + createTime: Date | undefined; + + /** + *The most recent time at which the trained model was updated.
+ * @public + */ + updateTime: Date | undefined; + + /** + *The Amazon Resource Name (ARN) of the trained model.
+ * @public + */ + trainedModelArn: string | undefined; + + /** + *The name of the trained model.
+ * @public + */ + name: string | undefined; + + /** + *The description of the trained model.
+ * @public + */ + description?: string; + + /** + *The membership ID of the member that created the trained model.
+ * @public + */ + membershipIdentifier: string | undefined; + + /** + *The collaboration ID of the collaboration that contains the trained model.
+ * @public + */ + collaborationIdentifier: string | undefined; + + /** + *The status of the trained model.
+ * @public + */ + status: TrainedModelStatus | undefined; + + /** + *The Amazon Resource Name (ARN) of the configured model algorithm association that was used to create this trained model.
+ * @public + */ + configuredModelAlgorithmAssociationArn: string | undefined; +} + +/** + * @public + */ +export interface ListTrainedModelsResponse { + /** + *The token value used to access the next page of results.
+ * @public + */ + nextToken?: string; + + /** + *The list of trained models.
+ * @public + */ + trainedModels: TrainedModelSummary[] | undefined; +} + +/** + * @public + */ +export interface StartTrainedModelExportJobRequest { + /** + *The name of the trained model export job.
+ * @public + */ + name: string | undefined; + + /** + *The Amazon Resource Name (ARN) of the trained model that you want to export.
+ * @public + */ + trainedModelArn: string | undefined; + + /** + *The membership ID of the member that is receiving the exported trained model artifacts.
+ * @public + */ + membershipIdentifier: string | undefined; + + /** + *The output configuration information for the trained model export job.
+ * @public + */ + outputConfiguration: TrainedModelExportOutputConfiguration | undefined; + + /** + *The description of the trained model export job.
+ * @public + */ + description?: string; +} + +/** + * @public + */ +export interface CancelTrainedModelInferenceJobRequest { + /** + *The membership ID of the trained model inference job that you want to cancel.
+ * @public + */ + membershipIdentifier: string | undefined; + + /** + *The Amazon Resource Name (ARN) of the trained model inference job that you want to cancel.
+ * @public + */ + trainedModelInferenceJobArn: string | undefined; +} + +/** + * @public + */ +export interface GetTrainedModelInferenceJobRequest { + /** + *Provides the membership ID of the membership that contains the trained model inference job that you are interested in.
+ * @public + */ + membershipIdentifier: string | undefined; + + /** + *Provides the Amazon Resource Name (ARN) of the trained model inference job that you are interested in.
+ * @public + */ + trainedModelInferenceJobArn: string | undefined; +} + +/** + *Provides execution parameters for the inference container.
+ * @public + */ +export interface InferenceContainerExecutionParameters { + /** + *The maximum size of the inference container payload, specified in MB.
+ * @public + */ + maxPayloadInMB?: number; +} + +/** + *Defines information about the data source used for model inference.
+ * @public + */ +export interface ModelInferenceDataSource { + /** + *The Amazon Resource Name (ARN) of the ML input channel for this model inference data source.
+ * @public + */ + mlInputChannelArn: string | undefined; +} + +/** + * @public + * @enum + */ +export const InferenceInstanceType = { + ML_C4_2XLARGE: "ml.c4.2xlarge", + ML_C4_4XLARGE: "ml.c4.4xlarge", + ML_C4_8XLARGE: "ml.c4.8xlarge", + ML_C4_XLARGE: "ml.c4.xlarge", + ML_C5_18XLARGE: "ml.c5.18xlarge", + ML_C5_2XLARGE: "ml.c5.2xlarge", + ML_C5_4XLARGE: "ml.c5.4xlarge", + ML_C5_9XLARGE: "ml.c5.9xlarge", + ML_C5_XLARGE: "ml.c5.xlarge", + ML_C6I_12XLARGE: "ml.c6i.12xlarge", + ML_C6I_16XLARGE: "ml.c6i.16xlarge", + ML_C6I_24XLARGE: "ml.c6i.24xlarge", + ML_C6I_2XLARGE: "ml.c6i.2xlarge", + ML_C6I_32XLARGE: "ml.c6i.32xlarge", + ML_C6I_4XLARGE: "ml.c6i.4xlarge", + ML_C6I_8XLARGE: "ml.c6i.8xlarge", + ML_C6I_LARGE: "ml.c6i.large", + ML_C6I_XLARGE: "ml.c6i.xlarge", + ML_C7I_12XLARGE: "ml.c7i.12xlarge", + ML_C7I_16XLARGE: "ml.c7i.16xlarge", + ML_C7I_24XLARGE: "ml.c7i.24xlarge", + ML_C7I_2XLARGE: "ml.c7i.2xlarge", + ML_C7I_48XLARGE: "ml.c7i.48xlarge", + ML_C7I_4XLARGE: "ml.c7i.4xlarge", + ML_C7I_8XLARGE: "ml.c7i.8xlarge", + ML_C7I_LARGE: "ml.c7i.large", + ML_C7I_XLARGE: "ml.c7i.xlarge", + ML_G4DN_12XLARGE: "ml.g4dn.12xlarge", + ML_G4DN_16XLARGE: "ml.g4dn.16xlarge", + ML_G4DN_2XLARGE: "ml.g4dn.2xlarge", + ML_G4DN_4XLARGE: "ml.g4dn.4xlarge", + ML_G4DN_8XLARGE: "ml.g4dn.8xlarge", + ML_G4DN_XLARGE: "ml.g4dn.xlarge", + ML_G5_12XLARGE: "ml.g5.12xlarge", + ML_G5_16XLARGE: "ml.g5.16xlarge", + ML_G5_24XLARGE: "ml.g5.24xlarge", + ML_G5_2XLARGE: "ml.g5.2xlarge", + ML_G5_48XLARGE: "ml.g5.48xlarge", + ML_G5_4XLARGE: "ml.g5.4xlarge", + ML_G5_8XLARGE: "ml.g5.8xlarge", + ML_G5_XLARGE: "ml.g5.xlarge", + ML_M4_10XLARGE: "ml.m4.10xlarge", + ML_M4_16XLARGE: "ml.m4.16xlarge", + ML_M4_2XLARGE: "ml.m4.2xlarge", + ML_M4_4XLARGE: "ml.m4.4xlarge", + ML_M4_XLARGE: "ml.m4.xlarge", + ML_M5_12XLARGE: "ml.m5.12xlarge", + ML_M5_24XLARGE: "ml.m5.24xlarge", + ML_M5_2XLARGE: "ml.m5.2xlarge", + ML_M5_4XLARGE: "ml.m5.4xlarge", + ML_M5_LARGE: "ml.m5.large", + ML_M5_XLARGE: "ml.m5.xlarge", + ML_M6I_12XLARGE: "ml.m6i.12xlarge", + ML_M6I_16XLARGE: "ml.m6i.16xlarge", + ML_M6I_24XLARGE: "ml.m6i.24xlarge", + ML_M6I_2XLARGE: "ml.m6i.2xlarge", + ML_M6I_32XLARGE: "ml.m6i.32xlarge", + ML_M6I_4XLARGE: "ml.m6i.4xlarge", + ML_M6I_8XLARGE: "ml.m6i.8xlarge", + ML_M6I_LARGE: "ml.m6i.large", + ML_M6I_XLARGE: "ml.m6i.xlarge", + ML_M7I_12XLARGE: "ml.m7i.12xlarge", + ML_M7I_16XLARGE: "ml.m7i.16xlarge", + ML_M7I_24XLARGE: "ml.m7i.24xlarge", + ML_M7I_2XLARGE: "ml.m7i.2xlarge", + ML_M7I_48XLARGE: "ml.m7i.48xlarge", + ML_M7I_4XLARGE: "ml.m7i.4xlarge", + ML_M7I_8XLARGE: "ml.m7i.8xlarge", + ML_M7I_LARGE: "ml.m7i.large", + ML_M7I_XLARGE: "ml.m7i.xlarge", + ML_P2_16XLARGE: "ml.p2.16xlarge", + ML_P2_8XLARGE: "ml.p2.8xlarge", + ML_P2_XLARGE: "ml.p2.xlarge", + ML_P3_16XLARGE: "ml.p3.16xlarge", + ML_P3_2XLARGE: "ml.p3.2xlarge", + ML_P3_8XLARGE: "ml.p3.8xlarge", + ML_R6I_12XLARGE: "ml.r6i.12xlarge", + ML_R6I_16XLARGE: "ml.r6i.16xlarge", + ML_R6I_24XLARGE: "ml.r6i.24xlarge", + ML_R6I_2XLARGE: "ml.r6i.2xlarge", + ML_R6I_32XLARGE: "ml.r6i.32xlarge", + ML_R6I_4XLARGE: "ml.r6i.4xlarge", + ML_R6I_8XLARGE: "ml.r6i.8xlarge", + ML_R6I_LARGE: "ml.r6i.large", + ML_R6I_XLARGE: "ml.r6i.xlarge", + ML_R7I_12XLARGE: "ml.r7i.12xlarge", + ML_R7I_16XLARGE: "ml.r7i.16xlarge", + ML_R7I_24XLARGE: "ml.r7i.24xlarge", + ML_R7I_2XLARGE: "ml.r7i.2xlarge", + ML_R7I_48XLARGE: "ml.r7i.48xlarge", + ML_R7I_4XLARGE: "ml.r7i.4xlarge", + ML_R7I_8XLARGE: "ml.r7i.8xlarge", + ML_R7I_LARGE: "ml.r7i.large", + ML_R7I_XLARGE: "ml.r7i.xlarge", +} as const; + +/** + * @public + */ +export type InferenceInstanceType = (typeof InferenceInstanceType)[keyof typeof InferenceInstanceType]; + +/** + *Defines the resources used to perform model inference.
+ * @public + */ +export interface InferenceResourceConfig { + /** + *The type of instance that is used to perform model inference.
+ * @public + */ + instanceType: InferenceInstanceType | undefined; + + /** + *The number of instances to use.
+ * @public + */ + instanceCount?: number; +} + +/** + * @public + */ +export interface GetTrainedModelInferenceJobResponse { + /** + *The time at which the trained model inference job was created.
+ * @public + */ + createTime: Date | undefined; + + /** + *The most recent time at which the trained model inference job was updated.
+ * @public + */ + updateTime: Date | undefined; + + /** + *The Amazon Resource Name (ARN) of the trained model inference job.
+ * @public + */ + trainedModelInferenceJobArn: string | undefined; + + /** + *The Amazon Resource Name (ARN) of the configured model algorithm association that was used for the trained model inference job.
+ * @public + */ + configuredModelAlgorithmAssociationArn?: string; + + /** + *The name of the trained model inference job.
+ * @public + */ + name: string | undefined; + + /** + *The status of the trained model inference job.
+ * @public + */ + status: TrainedModelInferenceJobStatus | undefined; + + /** + *The Amazon Resource Name (ARN) for the trained model that was used for the trained model inference job.
+ * @public + */ + trainedModelArn: string | undefined; + + /** + *The resource configuration information for the trained model inference job.
+ * @public + */ + resourceConfig: InferenceResourceConfig | undefined; + + /** + *The output configuration information for the trained model inference job.
+ * @public + */ + outputConfiguration: InferenceOutputConfiguration | undefined; + + /** + *The membership ID of the membership that contains the trained model inference job.
+ * @public + */ + membershipIdentifier: string | undefined; + + /** + *The data source that was used for the trained model inference job.
+ * @public + */ + dataSource: ModelInferenceDataSource | undefined; + + /** + *The execution parameters for the model inference job container.
+ * @public + */ + containerExecutionParameters?: InferenceContainerExecutionParameters; + + /** + *Details about the status of a resource.
+ * @public + */ + statusDetails?: StatusDetails; + + /** + *The description of the trained model inference job.
+ * @public + */ + description?: string; + + /** + *Information about the training container image.
+ * @public + */ + inferenceContainerImageDigest?: string; + + /** + *The environment variables to set in the Docker container.
+ * @public + */ + environment?: RecordThe Amazon Resource Name (ARN) of the KMS key. This key is used to encrypt and decrypt customer-owned data in the ML inference job and associated data.
+ * @public + */ + kmsKeyArn?: string; + + /** + *The metrics status for the trained model inference job.
+ * @public + */ + metricsStatus?: MetricsStatus; + + /** + *Details about the metrics status for the trained model inference job.
+ * @public + */ + metricsStatusDetails?: string; + + /** + *The logs status for the trained model inference job.
+ * @public + */ + logsStatus?: LogsStatus; + + /** + *Details about the logs status for the trained model inference job.
+ * @public + */ + logsStatusDetails?: string; + + /** + *The optional metadata that you applied to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
+ *The following basic restrictions apply to tags:
+ *Maximum number of tags per resource - 50.
+ *For each resource, each tag key must be unique, and each tag key can have only one value.
+ *Maximum key length - 128 Unicode characters in UTF-8.
+ *Maximum value length - 256 Unicode characters in UTF-8.
+ *If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
+ *Tag keys and values are case sensitive.
+ *Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms ML considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.
+ *The token value retrieved from a previous call to access the next page of results.
+ * @public + */ + nextToken?: string; + + /** + *The maximum size of the results that is returned per call.
+ * @public + */ + maxResults?: number; + + /** + *The membership
+ * @public + */ + membershipIdentifier: string | undefined; + + /** + *The Amazon Resource Name (ARN) of a trained model that was used to create the trained model inference jobs that you are interested in.
+ * @public + */ + trainedModelArn?: string; +} + +/** + *Provides information about the trained model inference job.
+ * @public + */ +export interface TrainedModelInferenceJobSummary { + /** + *The Amazon Resource Name (ARN) of the trained model inference job.
+ * @public + */ + trainedModelInferenceJobArn: string | undefined; + + /** + *The Amazon Resource Name (ARN) of the configured model algorithm association that is used for the trained model inference job.
+ * @public + */ + configuredModelAlgorithmAssociationArn?: string; + + /** + *The membership ID of the membership that contains the trained model inference job.
+ * @public + */ + membershipIdentifier: string | undefined; + + /** + *The Amazon Resource Name (ARN) of the trained model that is used for the trained model inference job.
+ * @public + */ + trainedModelArn: string | undefined; + + /** + *The collaboration ID of the collaboration that contains the trained model inference job.
+ * @public + */ + collaborationIdentifier: string | undefined; + + /** + *The status of the trained model inference job.
+ * @public + */ + status: TrainedModelInferenceJobStatus | undefined; + + /** + *The output configuration information of the trained model job.
+ * @public + */ + outputConfiguration: InferenceOutputConfiguration | undefined; + + /** + *The name of the trained model inference job.
+ * @public + */ + name: string | undefined; + + /** + *The description of the trained model inference job.
+ * @public + */ + description?: string; + + /** + *The metric status of the trained model inference job.
+ * @public + */ + metricsStatus?: MetricsStatus; + + /** + *Details about the metrics status for the trained model inference job.
+ * @public + */ + metricsStatusDetails?: string; + + /** + *The log status of the trained model inference job.
+ * @public + */ + logsStatus?: LogsStatus; + + /** + *Details about the log status for the trained model inference job.
+ * @public + */ + logsStatusDetails?: string; + + /** + *The time at which the trained model inference job was created.
+ * @public + */ + createTime: Date | undefined; + + /** + *The most recent time at which the trained model inference job was updated.
+ * @public + */ + updateTime: Date | undefined; +} + +/** + * @public + */ +export interface ListTrainedModelInferenceJobsResponse { + /** + *The token value used to access the next page of results.
+ * @public + */ + nextToken?: string; + + /** + *Returns the requested trained model inference jobs.
+ * @public + */ + trainedModelInferenceJobs: TrainedModelInferenceJobSummary[] | undefined; +} + +/** + * @public + */ +export interface StartTrainedModelInferenceJobRequest { + /** + *The membership ID of the membership that contains the trained model inference job.
+ * @public + */ + membershipIdentifier: string | undefined; + + /** + *The name of the trained model inference job.
+ * @public + */ + name: string | undefined; + + /** + *The Amazon Resource Name (ARN) of the trained model that is used for this trained model inference job.
+ * @public + */ + trainedModelArn: string | undefined; + + /** + *The Amazon Resource Name (ARN) of the configured model algorithm association that is used for this trained model inference job.
+ * @public + */ + configuredModelAlgorithmAssociationArn?: string; + + /** + *Defines the resource configuration for the trained model inference job.
+ * @public + */ + resourceConfig: InferenceResourceConfig | undefined; + + /** + *Defines the output configuration information for the trained model inference job.
+ * @public + */ + outputConfiguration: InferenceOutputConfiguration | undefined; + + /** + *Defines he data source that is used for the trained model inference job.
+ * @public + */ + dataSource: ModelInferenceDataSource | undefined; + + /** + *The description of the trained model inference job.
+ * @public + */ + description?: string; + + /** + *The execution parameters for the container.
+ * @public + */ + containerExecutionParameters?: InferenceContainerExecutionParameters; + + /** + *The environment variables to set in the Docker container.
+ * @public + */ + environment?: RecordThe Amazon Resource Name (ARN) of the KMS key. This key is used to encrypt and decrypt customer-owned data in the ML inference job and associated data.
+ * @public + */ + kmsKeyArn?: string; + + /** + *The optional metadata that you apply to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
+ *The following basic restrictions apply to tags:
+ *Maximum number of tags per resource - 50.
+ *For each resource, each tag key must be unique, and each tag key can have only one value.
+ *Maximum key length - 128 Unicode characters in UTF-8.
+ *Maximum value length - 256 Unicode characters in UTF-8.
+ *If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
+ *Tag keys and values are case sensitive.
+ *Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms ML considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.
+ *The Amazon Resource Name (ARN) of the trained model inference job.
+ * @public + */ + trainedModelInferenceJobArn: string | undefined; +} + +/** + *Defines the Glue data source that contains the training data.
+ * @public + */ +export interface GlueDataSource { + /** + *The Glue table that contains the training data.
+ * @public + */ + tableName: string | undefined; + + /** + *The Glue database that contains the training data.
+ * @public + */ + databaseName: string | undefined; + + /** + *The Glue catalog that contains the training data.
+ * @public + */ + catalogId?: string; +} + +/** + *Defines information about the Glue data source that contains the training data.
+ * @public + */ +export interface DataSource { + /** + *A GlueDataSource object that defines the catalog ID, database name, and table name for the training data.
+ * @public + */ + glueDataSource: GlueDataSource | undefined; +} + +/** + * @public + * @enum + */ +export const ColumnType = { + CATEGORICAL_FEATURE: "CATEGORICAL_FEATURE", + ITEM_ID: "ITEM_ID", + NUMERICAL_FEATURE: "NUMERICAL_FEATURE", + TIMESTAMP: "TIMESTAMP", + USER_ID: "USER_ID", +} as const; + +/** + * @public + */ +export type ColumnType = (typeof ColumnType)[keyof typeof ColumnType]; + +/** + *Metadata for a column.
+ * @public + */ +export interface ColumnSchema { + /** + *The name of a column.
+ * @public + */ + columnName: string | undefined; + + /** + *The data type of column.
+ * @public + */ + columnTypes: ColumnType[] | undefined; +} + +/** + *Defines the Glue data source and schema mapping information.
+ * @public + */ +export interface DatasetInputConfig { + /** + *The schema information for the training data.
+ * @public + */ + schema: ColumnSchema[] | undefined; + + /** + *A DataSource object that specifies the Glue data source for the training data.
+ * @public + */ + dataSource: DataSource | undefined; +} + +/** + * @public + * @enum + */ +export const DatasetType = { + INTERACTIONS: "INTERACTIONS", +} as const; + +/** + * @public + */ +export type DatasetType = (typeof DatasetType)[keyof typeof DatasetType]; + +/** + *Defines where the training dataset is located, what type of data it contains, and how to access the data.
+ * @public + */ +export interface Dataset { + /** + *What type of information is found in the dataset.
+ * @public + */ + type: DatasetType | undefined; + + /** + *A DatasetInputConfig object that defines the data source and schema mapping.
+ * @public + */ + inputConfig: DatasetInputConfig | undefined; +} + +/** + * @public + */ +export interface CreateTrainingDatasetRequest { + /** + *The name of the training dataset. This name must be unique in your account and region.
+ * @public + */ + name: string | undefined; + + /** + *The ARN of the IAM role that Clean Rooms ML can assume to read the data referred to in the dataSource field of each dataset.
Passing a role across AWS accounts is not allowed. If you pass a role that isn't in your account, you get an AccessDeniedException error.
An array of information that lists the Dataset objects, which specifies the dataset type and details on its location and schema. You must provide a role that has read access to these tables.
+ * @public + */ + trainingData: Dataset[] | undefined; + + /** + *The optional metadata that you apply to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
+ *The following basic restrictions apply to tags:
+ *Maximum number of tags per resource - 50.
+ *For each resource, each tag key must be unique, and each tag key can have only one value.
+ *Maximum key length - 128 Unicode characters in UTF-8.
+ *Maximum value length - 256 Unicode characters in UTF-8.
+ *If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
+ *Tag keys and values are case sensitive.
+ *Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms ML considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.
+ *The description of the training dataset.
+ * @public + */ + description?: string; +} + +/** + * @public + */ +export interface CreateTrainingDatasetResponse { + /** + *The Amazon Resource Name (ARN) of the training dataset resource.
+ * @public + */ + trainingDatasetArn: string | undefined; +} + +/** + * @public + */ +export interface DeleteTrainingDatasetRequest { + /** + *The Amazon Resource Name (ARN) of the training dataset that you want to delete.
+ * @public + */ + trainingDatasetArn: string | undefined; +} + +/** + * @public + */ +export interface GetTrainingDatasetRequest { + /** + *The Amazon Resource Name (ARN) of the training dataset that you are interested in.
+ * @public + */ + trainingDatasetArn: string | undefined; +} + +/** + * @public + * @enum + */ +export const TrainingDatasetStatus = { + ACTIVE: "ACTIVE", +} as const; + +/** + * @public + */ +export type TrainingDatasetStatus = (typeof TrainingDatasetStatus)[keyof typeof TrainingDatasetStatus]; + +/** + * @public + */ +export interface GetTrainingDatasetResponse { + /** + *The time at which the training dataset was created.
+ * @public + */ + createTime: Date | undefined; + + /** + *The most recent time at which the training dataset was updated.
+ * @public + */ + updateTime: Date | undefined; + + /** + *The Amazon Resource Name (ARN) of the training dataset.
+ * @public + */ + trainingDatasetArn: string | undefined; + + /** + *The name of the training dataset.
+ * @public + */ + name: string | undefined; + + /** + *Metadata about the requested training data.
+ * @public + */ + trainingData: Dataset[] | undefined; + + /** + *The status of the training dataset.
+ * @public + */ + status: TrainingDatasetStatus | undefined; + + /** + *The IAM role used to read the training data.
+ * @public + */ + roleArn: string | undefined; + + /** + *The tags that are assigned to this training dataset.
+ * @public + */ + tags?: RecordThe description of the training dataset.
+ * @public + */ + description?: string; +} + +/** + * @public + */ +export interface ListTrainingDatasetsRequest { + /** + *The token value retrieved from a previous call to access the next page of results.
+ * @public + */ + nextToken?: string; + + /** + *The maximum size of the results that is returned per call.
+ * @public + */ + maxResults?: number; +} + +/** + *Provides information about the training dataset.
+ * @public + */ +export interface TrainingDatasetSummary { + /** + *The time at which the training dataset was created.
+ * @public + */ + createTime: Date | undefined; + + /** + *The most recent time at which the training dataset was updated.
+ * @public + */ + updateTime: Date | undefined; + + /** + *The Amazon Resource Name (ARN) of the training dataset.
+ * @public + */ + trainingDatasetArn: string | undefined; + + /** + *The name of the training dataset.
+ * @public + */ + name: string | undefined; + + /** + *The status of the training dataset.
+ * @public + */ + status: TrainingDatasetStatus | undefined; + + /** + *The description of the training dataset.
+ * @public + */ + description?: string; +} + +/** + * @public + */ +export interface ListTrainingDatasetsResponse { + /** + *The token value used to access the next page of results.
+ * @public + */ + nextToken?: string; + + /** + *The training datasets that match the request.
+ * @public + */ + trainingDatasets: TrainingDatasetSummary[] | undefined; +} + +/** + * @public + */ +export interface UntagResourceRequest { + /** + *The Amazon Resource Name (ARN) of the resource that you want to remove tags from.
+ * @public + */ + resourceArn: string | undefined; + + /** + *The key values of tags that you want to remove.
+ * @public + */ tagKeys: string[] | undefined; } @@ -2043,3 +5744,47 @@ export const StartAudienceGenerationJobRequestFilterSensitiveLog = (obj: StartAu ...obj, ...(obj.seedAudience && { seedAudience: AudienceGenerationJobDataSourceFilterSensitiveLog(obj.seedAudience) }), }); + +/** + * @internal + */ +export const ProtectedQueryInputParametersFilterSensitiveLog = (obj: ProtectedQueryInputParameters): any => ({ + ...obj, + ...(obj.sqlParameters && { sqlParameters: SENSITIVE_STRING }), + ...(obj.computeConfiguration && { computeConfiguration: obj.computeConfiguration }), +}); + +/** + * @internal + */ +export const InputChannelDataSourceFilterSensitiveLog = (obj: InputChannelDataSource): any => { + if (obj.protectedQueryInputParameters !== undefined) + return { + protectedQueryInputParameters: ProtectedQueryInputParametersFilterSensitiveLog(obj.protectedQueryInputParameters), + }; + if (obj.$unknown !== undefined) return { [obj.$unknown[0]]: "UNKNOWN" }; +}; + +/** + * @internal + */ +export const InputChannelFilterSensitiveLog = (obj: InputChannel): any => ({ + ...obj, + ...(obj.dataSource && { dataSource: InputChannelDataSourceFilterSensitiveLog(obj.dataSource) }), +}); + +/** + * @internal + */ +export const CreateMLInputChannelRequestFilterSensitiveLog = (obj: CreateMLInputChannelRequest): any => ({ + ...obj, + ...(obj.inputChannel && { inputChannel: InputChannelFilterSensitiveLog(obj.inputChannel) }), +}); + +/** + * @internal + */ +export const GetMLInputChannelResponseFilterSensitiveLog = (obj: GetMLInputChannelResponse): any => ({ + ...obj, + ...(obj.inputChannel && { inputChannel: InputChannelFilterSensitiveLog(obj.inputChannel) }), +}); diff --git a/clients/client-cleanroomsml/src/pagination/ListCollaborationConfiguredModelAlgorithmAssociationsPaginator.ts b/clients/client-cleanroomsml/src/pagination/ListCollaborationConfiguredModelAlgorithmAssociationsPaginator.ts new file mode 100644 index 000000000000..3478f1211819 --- /dev/null +++ b/clients/client-cleanroomsml/src/pagination/ListCollaborationConfiguredModelAlgorithmAssociationsPaginator.ts @@ -0,0 +1,30 @@ +// smithy-typescript generated code +import { createPaginator } from "@smithy/core"; +import { Paginator } from "@smithy/types"; + +import { CleanRoomsMLClient } from "../CleanRoomsMLClient"; +import { + ListCollaborationConfiguredModelAlgorithmAssociationsCommand, + ListCollaborationConfiguredModelAlgorithmAssociationsCommandInput, + ListCollaborationConfiguredModelAlgorithmAssociationsCommandOutput, +} from "../commands/ListCollaborationConfiguredModelAlgorithmAssociationsCommand"; +import { CleanRoomsMLPaginationConfiguration } from "./Interfaces"; + +/** + * @public + */ +export const paginateListCollaborationConfiguredModelAlgorithmAssociations: ( + config: CleanRoomsMLPaginationConfiguration, + input: ListCollaborationConfiguredModelAlgorithmAssociationsCommandInput, + ...rest: any[] +) => PaginatorThe recall score of the generated audience. Recall is the percentage of the most similar users (by default, the most similar 20%) from a sample of the training data that are included in the seed audience by the audience generation job. Values range from 0-1, larger values indicate a better audience. A recall value approximately equal to the maximum bin size indicates that the audience model is equivalent to random selection.\n
" + "smithy.api#documentation": "The recall score of the generated audience. Recall is the percentage of the most similar users (by default, the most similar 20%) from a sample of the training data that are included in the seed audience by the audience generation job. Values range from 0-1, larger values indicate a better audience. A recall value approximately equal to the maximum bin size indicates that the audience model is equivalent to random selection.\n
", + "smithy.api#range": { + "min": 0.0, + "max": 1.0 + } } } }, @@ -1356,196 +1418,131 @@ } } }, - "com.amazonaws.cleanroomsml#ColumnName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?$" - } - }, - "com.amazonaws.cleanroomsml#ColumnSchema": { - "type": "structure", - "members": { - "columnName": { - "target": "com.amazonaws.cleanroomsml#ColumnName", - "traits": { - "smithy.api#documentation": "The name of a column.
", - "smithy.api#required": {} - } - }, - "columnTypes": { - "target": "com.amazonaws.cleanroomsml#ColumnTypeList", - "traits": { - "smithy.api#documentation": "The data type of column.
", - "smithy.api#required": {} - } - } + "com.amazonaws.cleanroomsml#CancelTrainedModel": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanroomsml#CancelTrainedModelRequest" }, - "traits": { - "smithy.api#documentation": "Metadata for a column.
" - } - }, - "com.amazonaws.cleanroomsml#ColumnType": { - "type": "enum", - "members": { - "USER_ID": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "USER_ID" - } - }, - "ITEM_ID": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ITEM_ID" - } + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cleanroomsml#AccessDeniedException" }, - "TIMESTAMP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TIMESTAMP" - } + { + "target": "com.amazonaws.cleanroomsml#ConflictException" }, - "CATEGORICAL_FEATURE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CATEGORICAL_FEATURE" - } + { + "target": "com.amazonaws.cleanroomsml#ResourceNotFoundException" }, - "NUMERICAL_FEATURE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NUMERICAL_FEATURE" - } + { + "target": "com.amazonaws.cleanroomsml#ValidationException" } - } - }, - "com.amazonaws.cleanroomsml#ColumnTypeList": { - "type": "list", - "member": { - "target": "com.amazonaws.cleanroomsml#ColumnType" - }, + ], "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - } + "smithy.api#documentation": "Submits a request to cancel the trained model job.
", + "smithy.api#http": { + "code": 200, + "method": "PATCH", + "uri": "/memberships/{membershipIdentifier}/trained-models/{trainedModelArn}" + }, + "smithy.api#idempotent": {} } }, - "com.amazonaws.cleanroomsml#ConfiguredAudienceModel": { - "type": "resource", - "identifiers": { - "configuredAudienceModelArn": { - "target": "com.amazonaws.cleanroomsml#ConfiguredAudienceModelArn" - } - }, - "create": { - "target": "com.amazonaws.cleanroomsml#CreateConfiguredAudienceModel" - }, - "read": { - "target": "com.amazonaws.cleanroomsml#GetConfiguredAudienceModel" - }, - "update": { - "target": "com.amazonaws.cleanroomsml#UpdateConfiguredAudienceModel" - }, - "delete": { - "target": "com.amazonaws.cleanroomsml#DeleteConfiguredAudienceModel" + "com.amazonaws.cleanroomsml#CancelTrainedModelInferenceJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanroomsml#CancelTrainedModelInferenceJobRequest" }, - "list": { - "target": "com.amazonaws.cleanroomsml#ListConfiguredAudienceModels" + "output": { + "target": "smithy.api#Unit" }, - "traits": { - "aws.api#arn": { - "template": "{configuredAudienceModelArn}", - "absolute": true + "errors": [ + { + "target": "com.amazonaws.cleanroomsml#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanroomsml#ConflictException" + }, + { + "target": "com.amazonaws.cleanroomsml#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanroomsml#ValidationException" } - } - }, - "com.amazonaws.cleanroomsml#ConfiguredAudienceModelArn": { - "type": "string", + ], "traits": { - "aws.api#arnReference": { - "service": "com.amazonaws.cleanroomsml#AWSStarkControlService", - "resource": "com.amazonaws.cleanroomsml#ConfiguredAudienceModel" - }, - "smithy.api#length": { - "min": 20, - "max": 2048 + "smithy.api#documentation": "Submits a request to cancel a trained model inference job.
", + "smithy.api#http": { + "code": 200, + "method": "PATCH", + "uri": "/memberships/{membershipIdentifier}/trained-model-inference-jobs/{trainedModelInferenceJobArn}" }, - "smithy.api#pattern": "^arn:aws[-a-z]*:cleanrooms-ml:[-a-z0-9]+:[0-9]{12}:configured-audience-model/[-a-zA-Z0-9_/.]+$" - } - }, - "com.amazonaws.cleanroomsml#ConfiguredAudienceModelList": { - "type": "list", - "member": { - "target": "com.amazonaws.cleanroomsml#ConfiguredAudienceModelSummary" + "smithy.api#idempotent": {} } }, - "com.amazonaws.cleanroomsml#ConfiguredAudienceModelOutputConfig": { + "com.amazonaws.cleanroomsml#CancelTrainedModelInferenceJobRequest": { "type": "structure", "members": { - "destination": { - "target": "com.amazonaws.cleanroomsml#AudienceDestination", + "membershipIdentifier": { + "target": "com.amazonaws.cleanroomsml#UUID", "traits": { + "smithy.api#documentation": "The membership ID of the trained model inference job that you want to cancel.
", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "roleArn": { - "target": "com.amazonaws.cleanroomsml#IamRoleArn", + "trainedModelInferenceJobArn": { + "target": "com.amazonaws.cleanroomsml#TrainedModelInferenceJobArn", "traits": { - "smithy.api#documentation": "The ARN of the IAM role that can write the Amazon S3 bucket.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the trained model inference job that you want to cancel.
", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Configuration information necessary for the configure audience model output.
" + "smithy.api#input": {} } }, - "com.amazonaws.cleanroomsml#ConfiguredAudienceModelPolicy": { - "type": "resource", - "identifiers": { - "configuredAudienceModelArn": { - "target": "com.amazonaws.cleanroomsml#ConfiguredAudienceModelArn" + "com.amazonaws.cleanroomsml#CancelTrainedModelRequest": { + "type": "structure", + "members": { + "membershipIdentifier": { + "target": "com.amazonaws.cleanroomsml#UUID", + "traits": { + "smithy.api#documentation": "The membership ID of the trained model job that you want to cancel.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "trainedModelArn": { + "target": "com.amazonaws.cleanroomsml#TrainedModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the trained model job that you want to cancel.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } } }, - "put": { - "target": "com.amazonaws.cleanroomsml#PutConfiguredAudienceModelPolicy" - }, - "read": { - "target": "com.amazonaws.cleanroomsml#GetConfiguredAudienceModelPolicy" - }, - "delete": { - "target": "com.amazonaws.cleanroomsml#DeleteConfiguredAudienceModelPolicy" - }, "traits": { - "aws.api#arn": { - "template": "{configuredAudienceModelArn}", - "absolute": true - } + "smithy.api#input": {} } }, - "com.amazonaws.cleanroomsml#ConfiguredAudienceModelStatus": { - "type": "enum", - "members": { - "ACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACTIVE" - } - } + "com.amazonaws.cleanroomsml#CollaborationConfiguredModelAlgorithmAssociationList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanroomsml#CollaborationConfiguredModelAlgorithmAssociationSummary" } }, - "com.amazonaws.cleanroomsml#ConfiguredAudienceModelSummary": { + "com.amazonaws.cleanroomsml#CollaborationConfiguredModelAlgorithmAssociationSummary": { "type": "structure", "members": { "createTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "The time at which the configured audience model was created.
", + "smithy.api#documentation": "The time at which the configured model algorithm association was created.
", "smithy.api#required": {}, "smithy.api#timestampFormat": "date-time" } @@ -1553,556 +1550,6612 @@ "updateTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "The most recent time at which the configured audience model was updated.
", + "smithy.api#documentation": "The most recent time at which the configured model algorithm association was updated.
", "smithy.api#required": {}, "smithy.api#timestampFormat": "date-time" } }, - "name": { - "target": "com.amazonaws.cleanroomsml#NameString", + "configuredModelAlgorithmAssociationArn": { + "target": "com.amazonaws.cleanroomsml#ConfiguredModelAlgorithmAssociationArn", "traits": { - "smithy.api#documentation": "The name of the configured audience model.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the configured model algorithm association.
", "smithy.api#required": {} } }, - "audienceModelArn": { - "target": "com.amazonaws.cleanroomsml#AudienceModelArn", + "name": { + "target": "com.amazonaws.cleanroomsml#NameString", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the audience model that was used to create the configured audience model.
", + "smithy.api#documentation": "The name of the configured model algorithm association.
", "smithy.api#required": {} } }, - "outputConfig": { - "target": "com.amazonaws.cleanroomsml#ConfiguredAudienceModelOutputConfig", + "description": { + "target": "com.amazonaws.cleanroomsml#ResourceDescription", "traits": { - "smithy.api#documentation": "The output configuration of the configured audience model.
", - "smithy.api#required": {} + "smithy.api#documentation": "The description of the configured model algorithm association.
" } }, - "description": { - "target": "com.amazonaws.cleanroomsml#ResourceDescription", + "membershipIdentifier": { + "target": "com.amazonaws.cleanroomsml#UUID", "traits": { - "smithy.api#documentation": "The description of the configured audience model.
" + "smithy.api#documentation": "The membership ID of the member that created the configured model algorithm association.
", + "smithy.api#required": {} } }, - "configuredAudienceModelArn": { - "target": "com.amazonaws.cleanroomsml#ConfiguredAudienceModelArn", + "collaborationIdentifier": { + "target": "com.amazonaws.cleanroomsml#UUID", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the configured audience model that you are interested in.
", + "smithy.api#documentation": "The collaboration ID of the collaboration that contains the configured model algorithm association.
", "smithy.api#required": {} } }, - "status": { - "target": "com.amazonaws.cleanroomsml#ConfiguredAudienceModelStatus", + "configuredModelAlgorithmArn": { + "target": "com.amazonaws.cleanroomsml#ConfiguredModelAlgorithmArn", "traits": { - "smithy.api#documentation": "The status of the configured audience model.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the configured model algorithm that is associated to the collaboration.
", "smithy.api#required": {} } - } - }, - "traits": { - "smithy.api#documentation": "Information about the configured audience model.
" - } - }, - "com.amazonaws.cleanroomsml#ConflictException": { - "type": "structure", - "members": { - "message": { - "target": "smithy.api#String", + }, + "creatorAccountId": { + "target": "com.amazonaws.cleanroomsml#AccountId", "traits": { + "smithy.api#documentation": "The account ID of the member that created the configured model algorithm association.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "You can't complete this action because another resource depends on this resource.
", - "smithy.api#error": "client", - "smithy.api#httpError": 409 - } - }, - "com.amazonaws.cleanroomsml#CreateAudienceModel": { - "type": "operation", - "input": { - "target": "com.amazonaws.cleanroomsml#CreateAudienceModelRequest" - }, - "output": { - "target": "com.amazonaws.cleanroomsml#CreateAudienceModelResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cleanroomsml#AccessDeniedException" - }, - { - "target": "com.amazonaws.cleanroomsml#ConflictException" - }, - { - "target": "com.amazonaws.cleanroomsml#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cleanroomsml#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.cleanroomsml#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Defines the information necessary to create an audience model. An audience model is a machine learning model that Clean Rooms ML trains to measure similarity between users. Clean Rooms ML manages training and storing the audience model. The audience model can be used in multiple calls to the StartAudienceGenerationJob API.
", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/audience-model" - }, - "smithy.api#idempotent": {} + "smithy.api#documentation": "Provides summary information about a configured model algorithm in a collaboration.
" } }, - "com.amazonaws.cleanroomsml#CreateAudienceModelRequest": { + "com.amazonaws.cleanroomsml#CollaborationMLInputChannelSummary": { "type": "structure", "members": { - "trainingDataStartTime": { + "createTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "The start date and time of the training window.
", + "smithy.api#documentation": "The time at which the ML input channel was created.
", + "smithy.api#required": {}, "smithy.api#timestampFormat": "date-time" } }, - "trainingDataEndTime": { + "updateTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "The end date and time of the training window.
", + "smithy.api#documentation": "The most recent time at which the ML input channel was updated.
", + "smithy.api#required": {}, "smithy.api#timestampFormat": "date-time" } }, + "membershipIdentifier": { + "target": "com.amazonaws.cleanroomsml#UUID", + "traits": { + "smithy.api#documentation": "The membership ID of the membership that contains the ML input channel.
", + "smithy.api#required": {} + } + }, + "collaborationIdentifier": { + "target": "com.amazonaws.cleanroomsml#UUID", + "traits": { + "smithy.api#documentation": "The collaboration ID of the collaboration that contains the ML input channel.
", + "smithy.api#required": {} + } + }, "name": { "target": "com.amazonaws.cleanroomsml#NameString", "traits": { - "smithy.api#documentation": "The name of the audience model resource.
", + "smithy.api#documentation": "The name of the ML input channel.
", "smithy.api#required": {} } }, - "trainingDatasetArn": { - "target": "com.amazonaws.cleanroomsml#TrainingDatasetArn", + "configuredModelAlgorithmAssociations": { + "target": "com.amazonaws.cleanroomsml#ConfiguredModelAlgorithmAssociationArnList", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the training dataset for this audience model.
", + "smithy.api#documentation": "The associated configured model algorithms used to create the ML input channel.
", + "smithy.api#length": { + "min": 1, + "max": 1 + }, "smithy.api#required": {} } }, - "kmsKeyArn": { - "target": "com.amazonaws.cleanroomsml#KmsKeyArn", + "mlInputChannelArn": { + "target": "com.amazonaws.cleanroomsml#MLInputChannelArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key. This key is used to encrypt and decrypt customer-owned data in the trained ML model and the associated data.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the ML input channel.
", + "smithy.api#required": {} } }, - "tags": { - "target": "com.amazonaws.cleanroomsml#TagMap", + "status": { + "target": "com.amazonaws.cleanroomsml#MLInputChannelStatus", "traits": { - "smithy.api#documentation": "The optional metadata that you apply to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50.
\nFor each resource, each tag key must be unique, and each tag key can have only one value.
\nMaximum key length - 128 Unicode characters in UTF-8.
\nMaximum value length - 256 Unicode characters in UTF-8.
\nIf your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms ML considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.
\nThe status of the ML input channel.
", + "smithy.api#required": {} + } + }, + "creatorAccountId": { + "target": "com.amazonaws.cleanroomsml#AccountId", + "traits": { + "smithy.api#documentation": "The account ID of the member who created the ML input channel.
", + "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.cleanroomsml#ResourceDescription", "traits": { - "smithy.api#documentation": "The description of the audience model.
" + "smithy.api#documentation": "The description of the ML input channel.
" } } }, "traits": { - "smithy.api#input": {} + "smithy.api#documentation": "Provides summary information about an ML input channel in a collaboration.
" } }, - "com.amazonaws.cleanroomsml#CreateAudienceModelResponse": { - "type": "structure", - "members": { - "audienceModelArn": { - "target": "com.amazonaws.cleanroomsml#AudienceModelArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the audience model.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} + "com.amazonaws.cleanroomsml#CollaborationMLInputChannelsList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanroomsml#CollaborationMLInputChannelSummary" } }, - "com.amazonaws.cleanroomsml#CreateConfiguredAudienceModel": { - "type": "operation", - "input": { - "target": "com.amazonaws.cleanroomsml#CreateConfiguredAudienceModelRequest" - }, - "output": { - "target": "com.amazonaws.cleanroomsml#CreateConfiguredAudienceModelResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cleanroomsml#AccessDeniedException" - }, - { - "target": "com.amazonaws.cleanroomsml#ConflictException" - }, - { - "target": "com.amazonaws.cleanroomsml#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cleanroomsml#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.cleanroomsml#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Defines the information necessary to create a configured audience model.
", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/configured-audience-model" - }, - "smithy.api#idempotent": {} + "com.amazonaws.cleanroomsml#CollaborationTrainedModelExportJobList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanroomsml#CollaborationTrainedModelExportJobSummary" } }, - "com.amazonaws.cleanroomsml#CreateConfiguredAudienceModelRequest": { + "com.amazonaws.cleanroomsml#CollaborationTrainedModelExportJobSummary": { "type": "structure", "members": { + "createTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the trained model export job was created.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "updateTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The most recent time at which the trained model export job was updated.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, "name": { "target": "com.amazonaws.cleanroomsml#NameString", "traits": { - "smithy.api#documentation": "The name of the configured audience model.
", + "smithy.api#documentation": "The name of the trained model export job.
", "smithy.api#required": {} } }, - "audienceModelArn": { - "target": "com.amazonaws.cleanroomsml#AudienceModelArn", + "outputConfiguration": { + "target": "com.amazonaws.cleanroomsml#TrainedModelExportOutputConfiguration", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the audience model to use for the configured audience model.
", "smithy.api#required": {} } }, - "outputConfig": { - "target": "com.amazonaws.cleanroomsml#ConfiguredAudienceModelOutputConfig", + "status": { + "target": "com.amazonaws.cleanroomsml#TrainedModelExportJobStatus", "traits": { - "smithy.api#documentation": "Configure the Amazon S3 location and IAM Role for audiences created using this configured audience model. Each audience will have a unique location. The IAM Role must have s3:PutObject permission on the destination Amazon S3 location. If the destination is protected with Amazon S3 KMS-SSE, then the Role must also have the required KMS permissions.
The status of the trained model.
", "smithy.api#required": {} } }, + "statusDetails": { + "target": "com.amazonaws.cleanroomsml#StatusDetails" + }, "description": { "target": "com.amazonaws.cleanroomsml#ResourceDescription", "traits": { - "smithy.api#documentation": "The description of the configured audience model.
" + "smithy.api#documentation": "The description of the trained model.
" } }, - "sharedAudienceMetrics": { - "target": "com.amazonaws.cleanroomsml#MetricsList", + "creatorAccountId": { + "target": "com.amazonaws.cleanroomsml#AccountId", "traits": { - "smithy.api#documentation": "Whether audience metrics are shared.
", + "smithy.api#documentation": "The account ID of the member that created the trained model.
", "smithy.api#required": {} } }, - "minMatchingSeedSize": { - "target": "com.amazonaws.cleanroomsml#MinMatchingSeedSize", - "traits": { - "smithy.api#default": 500, - "smithy.api#documentation": "The minimum number of users from the seed audience that must match with users in the training data of the audience model. The default value is 500.
" - } - }, - "audienceSizeConfig": { - "target": "com.amazonaws.cleanroomsml#AudienceSizeConfig", + "trainedModelArn": { + "target": "com.amazonaws.cleanroomsml#TrainedModelArn", "traits": { - "smithy.api#documentation": "Configure the list of output sizes of audiences that can be created using this configured audience model. A request to StartAudienceGenerationJob that uses this configured audience model must have an audienceSize selected from this list. You can use the ABSOLUTE\n AudienceSize to configure out audience sizes using the count of identifiers in the output. You can use the Percentage\n AudienceSize to configure sizes in the range 1-100 percent.
The Amazon Resource Name (ARN) of the trained model that is being exported.
", + "smithy.api#required": {} } }, - "tags": { - "target": "com.amazonaws.cleanroomsml#TagMap", + "membershipIdentifier": { + "target": "com.amazonaws.cleanroomsml#UUID", "traits": { - "smithy.api#documentation": "The optional metadata that you apply to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50.
\nFor each resource, each tag key must be unique, and each tag key can have only one value.
\nMaximum key length - 128 Unicode characters in UTF-8.
\nMaximum value length - 256 Unicode characters in UTF-8.
\nIf your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms ML considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.
\nThe membership ID of the member that created the trained model export job.
", + "smithy.api#required": {} } }, - "childResourceTagOnCreatePolicy": { - "target": "com.amazonaws.cleanroomsml#TagOnCreatePolicy", + "collaborationIdentifier": { + "target": "com.amazonaws.cleanroomsml#UUID", "traits": { - "smithy.api#documentation": "Configure how the service tags audience generation jobs created using this configured audience model. If you specify NONE, the tags from the StartAudienceGenerationJob request determine the tags of the audience generation job. If you specify FROM_PARENT_RESOURCE, the audience generation job inherits the tags from the configured audience model, by default. Tags in the StartAudienceGenerationJob will override the default.
When the client is in a different account than the configured audience model, the tags from the client are never applied to a resource in the caller's account.
" + "smithy.api#documentation": "The collaboration ID of the collaboration that contains the trained model export job.
", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#input": {} + "smithy.api#documentation": "Provides summary information about a trained model export job in a collaboration.
" } }, - "com.amazonaws.cleanroomsml#CreateConfiguredAudienceModelResponse": { + "com.amazonaws.cleanroomsml#CollaborationTrainedModelInferenceJobList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanroomsml#CollaborationTrainedModelInferenceJobSummary" + } + }, + "com.amazonaws.cleanroomsml#CollaborationTrainedModelInferenceJobSummary": { "type": "structure", "members": { - "configuredAudienceModelArn": { - "target": "com.amazonaws.cleanroomsml#ConfiguredAudienceModelArn", + "trainedModelInferenceJobArn": { + "target": "com.amazonaws.cleanroomsml#TrainedModelInferenceJobArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the configured audience model.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the trained model inference job.
", "smithy.api#required": {} } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cleanroomsml#CreateTrainingDataset": { - "type": "operation", - "input": { - "target": "com.amazonaws.cleanroomsml#CreateTrainingDatasetRequest" - }, - "output": { - "target": "com.amazonaws.cleanroomsml#CreateTrainingDatasetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cleanroomsml#AccessDeniedException" }, - { - "target": "com.amazonaws.cleanroomsml#ConflictException" + "configuredModelAlgorithmAssociationArn": { + "target": "com.amazonaws.cleanroomsml#ConfiguredModelAlgorithmAssociationArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the configured model algorithm association that is used for the trained model inference job.
" + } }, - { - "target": "com.amazonaws.cleanroomsml#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Defines the information necessary to create a training dataset. In Clean Rooms ML, the TrainingDataset is metadata that points to a Glue table, which is read only during AudienceModel creation.
The membership ID of the membership that contains the trained model inference job.
", + "smithy.api#required": {} + } }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.cleanroomsml#CreateTrainingDatasetRequest": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.cleanroomsml#NameString", + "trainedModelArn": { + "target": "com.amazonaws.cleanroomsml#TrainedModelArn", "traits": { - "smithy.api#documentation": "The name of the training dataset. This name must be unique in your account and region.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the trained model that is used for the trained model inference job.
", "smithy.api#required": {} } }, - "roleArn": { - "target": "com.amazonaws.cleanroomsml#IamRoleArn", + "collaborationIdentifier": { + "target": "com.amazonaws.cleanroomsml#UUID", "traits": { - "smithy.api#documentation": "The ARN of the IAM role that Clean Rooms ML can assume to read the data referred to in the dataSource field of each dataset.
Passing a role across AWS accounts is not allowed. If you pass a role that isn't in your account, you get an AccessDeniedException error.
The collaboration ID of the collaboration that contains the trained model inference job.
", "smithy.api#required": {} } }, - "trainingData": { - "target": "com.amazonaws.cleanroomsml#DatasetList", + "status": { + "target": "com.amazonaws.cleanroomsml#TrainedModelInferenceJobStatus", "traits": { - "smithy.api#documentation": "An array of information that lists the Dataset objects, which specifies the dataset type and details on its location and schema. You must provide a role that has read access to these tables.
", - "smithy.api#length": { - "min": 1, - "max": 1 - }, + "smithy.api#documentation": "The status of the trained model inference job.
", "smithy.api#required": {} } }, - "tags": { - "target": "com.amazonaws.cleanroomsml#TagMap", + "outputConfiguration": { + "target": "com.amazonaws.cleanroomsml#InferenceOutputConfiguration", "traits": { - "smithy.api#documentation": "The optional metadata that you apply to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50.
\nFor each resource, each tag key must be unique, and each tag key can have only one value.
\nMaximum key length - 128 Unicode characters in UTF-8.
\nMaximum value length - 256 Unicode characters in UTF-8.
\nIf your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms ML considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.
\nReturns output configuration information for the trained model inference job.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.cleanroomsml#NameString", + "traits": { + "smithy.api#documentation": "The name of the trained model inference job.
", + "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.cleanroomsml#ResourceDescription", "traits": { - "smithy.api#documentation": "The description of the training dataset.
" + "smithy.api#documentation": "The description of the trained model inference job.
" } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cleanroomsml#CreateTrainingDatasetResponse": { - "type": "structure", - "members": { - "trainingDatasetArn": { - "target": "com.amazonaws.cleanroomsml#TrainingDatasetArn", + }, + "metricsStatus": { + "target": "com.amazonaws.cleanroomsml#MetricsStatus", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the training dataset resource.
", + "smithy.api#documentation": "the trained model inference job metrics status.
" + } + }, + "metricsStatusDetails": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Details about the metrics status for trained model inference job.
" + } + }, + "logsStatus": { + "target": "com.amazonaws.cleanroomsml#LogsStatus", + "traits": { + "smithy.api#documentation": "The trained model inference job logs status.
" + } + }, + "logsStatusDetails": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Details about the logs status for the trained model inference job.
" + } + }, + "createTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the trained model inference job was created.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "updateTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The most recent time at which the trained model inference job was updated.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "creatorAccountId": { + "target": "com.amazonaws.cleanroomsml#AccountId", + "traits": { + "smithy.api#documentation": "The account ID that created the trained model inference job.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#output": {} + "smithy.api#documentation": "Provides summary information about a trained model inference job in a collaboration.
" } }, - "com.amazonaws.cleanroomsml#DataSource": { + "com.amazonaws.cleanroomsml#CollaborationTrainedModelList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanroomsml#CollaborationTrainedModelSummary" + } + }, + "com.amazonaws.cleanroomsml#CollaborationTrainedModelSummary": { "type": "structure", "members": { - "glueDataSource": { - "target": "com.amazonaws.cleanroomsml#GlueDataSource", + "createTime": { + "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "A GlueDataSource object that defines the catalog ID, database name, and table name for the training data.
", + "smithy.api#documentation": "The time at which the trained model was created.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "updateTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The most recent time at which the trained model was updated.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "trainedModelArn": { + "target": "com.amazonaws.cleanroomsml#TrainedModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the trained model.
", "smithy.api#required": {} } - } - }, - "traits": { - "smithy.api#documentation": "Defines information about the Glue data source that contains the training data.
" - } - }, - "com.amazonaws.cleanroomsml#Dataset": { - "type": "structure", - "members": { - "type": { - "target": "com.amazonaws.cleanroomsml#DatasetType", + }, + "name": { + "target": "com.amazonaws.cleanroomsml#NameString", "traits": { - "smithy.api#documentation": "What type of information is found in the dataset.
", + "smithy.api#documentation": "The name of the trained model.
", "smithy.api#required": {} } }, - "inputConfig": { - "target": "com.amazonaws.cleanroomsml#DatasetInputConfig", + "description": { + "target": "com.amazonaws.cleanroomsml#ResourceDescription", "traits": { - "smithy.api#documentation": "A DatasetInputConfig object that defines the data source and schema mapping.
", + "smithy.api#documentation": "The description of the trained model.
" + } + }, + "membershipIdentifier": { + "target": "com.amazonaws.cleanroomsml#UUID", + "traits": { + "smithy.api#documentation": "The membership ID of the member that created the trained model.
", + "smithy.api#required": {} + } + }, + "collaborationIdentifier": { + "target": "com.amazonaws.cleanroomsml#UUID", + "traits": { + "smithy.api#documentation": "The collaboration ID of the collaboration that contains the trained model.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.cleanroomsml#TrainedModelStatus", + "traits": { + "smithy.api#documentation": "The status of the trained model.
", + "smithy.api#required": {} + } + }, + "configuredModelAlgorithmAssociationArn": { + "target": "com.amazonaws.cleanroomsml#ConfiguredModelAlgorithmAssociationArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the configured model algorithm association that is used for this trained model.
", + "smithy.api#required": {} + } + }, + "creatorAccountId": { + "target": "com.amazonaws.cleanroomsml#AccountId", + "traits": { + "smithy.api#documentation": "The account ID of the member that created the trained model.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Defines where the training dataset is located, what type of data it contains, and how to access the data.
" + "smithy.api#documentation": "Provides summary information about a trained model in a collaboration.
" } }, - "com.amazonaws.cleanroomsml#DatasetInputConfig": { + "com.amazonaws.cleanroomsml#ColumnName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?$" + } + }, + "com.amazonaws.cleanroomsml#ColumnSchema": { "type": "structure", "members": { - "schema": { - "target": "com.amazonaws.cleanroomsml#DatasetSchemaList", + "columnName": { + "target": "com.amazonaws.cleanroomsml#ColumnName", "traits": { - "smithy.api#documentation": "The schema information for the training data.
", - "smithy.api#length": { - "min": 1, - "max": 100 - }, + "smithy.api#documentation": "The name of a column.
", "smithy.api#required": {} } }, - "dataSource": { - "target": "com.amazonaws.cleanroomsml#DataSource", + "columnTypes": { + "target": "com.amazonaws.cleanroomsml#ColumnTypeList", "traits": { - "smithy.api#documentation": "A DataSource object that specifies the Glue data source for the training data.
", + "smithy.api#documentation": "The data type of column.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Defines the Glue data source and schema mapping information.
" - } - }, - "com.amazonaws.cleanroomsml#DatasetList": { - "type": "list", - "member": { - "target": "com.amazonaws.cleanroomsml#Dataset" - } - }, - "com.amazonaws.cleanroomsml#DatasetSchemaList": { - "type": "list", - "member": { - "target": "com.amazonaws.cleanroomsml#ColumnSchema" + "smithy.api#documentation": "Metadata for a column.
" } }, - "com.amazonaws.cleanroomsml#DatasetType": { + "com.amazonaws.cleanroomsml#ColumnType": { "type": "enum", "members": { - "INTERACTIONS": { + "USER_ID": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "INTERACTIONS" + "smithy.api#enumValue": "USER_ID" } - } - } - }, - "com.amazonaws.cleanroomsml#DeleteAudienceGenerationJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.cleanroomsml#DeleteAudienceGenerationJobRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.cleanroomsml#AccessDeniedException" }, - { - "target": "com.amazonaws.cleanroomsml#ConflictException" + "ITEM_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ITEM_ID" + } }, - { - "target": "com.amazonaws.cleanroomsml#ResourceNotFoundException" + "TIMESTAMP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TIMESTAMP" + } }, - { - "target": "com.amazonaws.cleanroomsml#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes the specified audience generation job, and removes all data associated with the job.
", - "smithy.api#http": { - "code": 200, - "method": "DELETE", - "uri": "/audience-generation-job/{audienceGenerationJobArn}" + "CATEGORICAL_FEATURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CATEGORICAL_FEATURE" + } }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.cleanroomsml#DeleteAudienceGenerationJobRequest": { - "type": "structure", - "members": { - "audienceGenerationJobArn": { - "target": "com.amazonaws.cleanroomsml#AudienceGenerationJobArn", + "NUMERICAL_FEATURE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the audience generation job that you want to delete.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#enumValue": "NUMERICAL_FEATURE" } } - }, - "traits": { - "smithy.api#input": {} } }, - "com.amazonaws.cleanroomsml#DeleteAudienceModel": { + "com.amazonaws.cleanroomsml#ColumnTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanroomsml#ColumnType" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.cleanroomsml#ComputeConfiguration": { + "type": "union", + "members": { + "worker": { + "target": "com.amazonaws.cleanroomsml#WorkerComputeConfiguration", + "traits": { + "smithy.api#documentation": "The worker instances that will perform the compute work.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides configuration information for the instances that will perform the compute work.
" + } + }, + "com.amazonaws.cleanroomsml#ConfiguredAudienceModel": { + "type": "resource", + "identifiers": { + "configuredAudienceModelArn": { + "target": "com.amazonaws.cleanroomsml#ConfiguredAudienceModelArn" + } + }, + "create": { + "target": "com.amazonaws.cleanroomsml#CreateConfiguredAudienceModel" + }, + "read": { + "target": "com.amazonaws.cleanroomsml#GetConfiguredAudienceModel" + }, + "update": { + "target": "com.amazonaws.cleanroomsml#UpdateConfiguredAudienceModel" + }, + "delete": { + "target": "com.amazonaws.cleanroomsml#DeleteConfiguredAudienceModel" + }, + "list": { + "target": "com.amazonaws.cleanroomsml#ListConfiguredAudienceModels" + }, + "traits": { + "aws.api#arn": { + "template": "{configuredAudienceModelArn}", + "absolute": true + } + } + }, + "com.amazonaws.cleanroomsml#ConfiguredAudienceModelArn": { + "type": "string", + "traits": { + "aws.api#arnReference": { + "service": "com.amazonaws.cleanroomsml#AWSStarkControlService", + "resource": "com.amazonaws.cleanroomsml#ConfiguredAudienceModel" + }, + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws[-a-z]*:cleanrooms-ml:[-a-z0-9]+:[0-9]{12}:configured-audience-model/[-a-zA-Z0-9_/.]+$" + } + }, + "com.amazonaws.cleanroomsml#ConfiguredAudienceModelList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanroomsml#ConfiguredAudienceModelSummary" + } + }, + "com.amazonaws.cleanroomsml#ConfiguredAudienceModelOutputConfig": { + "type": "structure", + "members": { + "destination": { + "target": "com.amazonaws.cleanroomsml#AudienceDestination", + "traits": { + "smithy.api#required": {} + } + }, + "roleArn": { + "target": "com.amazonaws.cleanroomsml#IamRoleArn", + "traits": { + "smithy.api#documentation": "The ARN of the IAM role that can write the Amazon S3 bucket.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration information necessary for the configure audience model output.
" + } + }, + "com.amazonaws.cleanroomsml#ConfiguredAudienceModelPolicy": { + "type": "resource", + "identifiers": { + "configuredAudienceModelArn": { + "target": "com.amazonaws.cleanroomsml#ConfiguredAudienceModelArn" + } + }, + "put": { + "target": "com.amazonaws.cleanroomsml#PutConfiguredAudienceModelPolicy" + }, + "read": { + "target": "com.amazonaws.cleanroomsml#GetConfiguredAudienceModelPolicy" + }, + "delete": { + "target": "com.amazonaws.cleanroomsml#DeleteConfiguredAudienceModelPolicy" + }, + "traits": { + "aws.api#arn": { + "template": "{configuredAudienceModelArn}", + "absolute": true + } + } + }, + "com.amazonaws.cleanroomsml#ConfiguredAudienceModelStatus": { + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + } + } + }, + "com.amazonaws.cleanroomsml#ConfiguredAudienceModelSummary": { + "type": "structure", + "members": { + "createTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the configured audience model was created.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "updateTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The most recent time at which the configured audience model was updated.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "name": { + "target": "com.amazonaws.cleanroomsml#NameString", + "traits": { + "smithy.api#documentation": "The name of the configured audience model.
", + "smithy.api#required": {} + } + }, + "audienceModelArn": { + "target": "com.amazonaws.cleanroomsml#AudienceModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the audience model that was used to create the configured audience model.
", + "smithy.api#required": {} + } + }, + "outputConfig": { + "target": "com.amazonaws.cleanroomsml#ConfiguredAudienceModelOutputConfig", + "traits": { + "smithy.api#documentation": "The output configuration of the configured audience model.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.cleanroomsml#ResourceDescription", + "traits": { + "smithy.api#documentation": "The description of the configured audience model.
" + } + }, + "configuredAudienceModelArn": { + "target": "com.amazonaws.cleanroomsml#ConfiguredAudienceModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the configured audience model that you are interested in.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.cleanroomsml#ConfiguredAudienceModelStatus", + "traits": { + "smithy.api#documentation": "The status of the configured audience model.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the configured audience model.
" + } + }, + "com.amazonaws.cleanroomsml#ConfiguredModelAlgorithm": { + "type": "resource", + "identifiers": { + "configuredModelAlgorithmArn": { + "target": "com.amazonaws.cleanroomsml#ConfiguredModelAlgorithmArn" + } + }, + "create": { + "target": "com.amazonaws.cleanroomsml#CreateConfiguredModelAlgorithm" + }, + "read": { + "target": "com.amazonaws.cleanroomsml#GetConfiguredModelAlgorithm" + }, + "delete": { + "target": "com.amazonaws.cleanroomsml#DeleteConfiguredModelAlgorithm" + }, + "list": { + "target": "com.amazonaws.cleanroomsml#ListConfiguredModelAlgorithms" + }, + "traits": { + "aws.api#arn": { + "template": "{configuredModelAlgorithmArn}", + "absolute": true + } + } + }, + "com.amazonaws.cleanroomsml#ConfiguredModelAlgorithmArn": { + "type": "string", + "traits": { + "aws.api#arnReference": { + "service": "com.amazonaws.cleanroomsml#AWSStarkControlService", + "resource": "com.amazonaws.cleanroomsml#ConfiguredModelAlgorithm" + }, + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws[-a-z]*:cleanrooms-ml:[-a-z0-9]+:[0-9]{12}:configured-model-algorithm/[-a-zA-Z0-9_/.]+$" + } + }, + "com.amazonaws.cleanroomsml#ConfiguredModelAlgorithmAssociation": { + "type": "resource", + "identifiers": { + "configuredModelAlgorithmAssociationArn": { + "target": "com.amazonaws.cleanroomsml#ConfiguredModelAlgorithmAssociationArn" + } + }, + "create": { + "target": "com.amazonaws.cleanroomsml#CreateConfiguredModelAlgorithmAssociation" + }, + "read": { + "target": "com.amazonaws.cleanroomsml#GetConfiguredModelAlgorithmAssociation" + }, + "delete": { + "target": "com.amazonaws.cleanroomsml#DeleteConfiguredModelAlgorithmAssociation" + }, + "list": { + "target": "com.amazonaws.cleanroomsml#ListConfiguredModelAlgorithmAssociations" + }, + "operations": [ + { + "target": "com.amazonaws.cleanroomsml#GetCollaborationConfiguredModelAlgorithmAssociation" + } + ], + "traits": { + "aws.api#arn": { + "template": "{configuredModelAlgorithmAssociationArn}", + "absolute": true + } + } + }, + "com.amazonaws.cleanroomsml#ConfiguredModelAlgorithmAssociationArn": { + "type": "string", + "traits": { + "aws.api#arnReference": { + "service": "com.amazonaws.cleanroomsml#AWSStarkControlService", + "resource": "com.amazonaws.cleanroomsml#ConfiguredModelAlgorithmAssociation" + }, + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws[-a-z]*:cleanrooms-ml:[-a-z0-9]+:[0-9]{12}:(membership/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/)?configured-model-algorithm-association/[-a-zA-Z0-9_/.]+$" + } + }, + "com.amazonaws.cleanroomsml#ConfiguredModelAlgorithmAssociationArnList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanroomsml#ConfiguredModelAlgorithmAssociationArn" + } + }, + "com.amazonaws.cleanroomsml#ConfiguredModelAlgorithmAssociationList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanroomsml#ConfiguredModelAlgorithmAssociationSummary" + } + }, + "com.amazonaws.cleanroomsml#ConfiguredModelAlgorithmAssociationSummary": { + "type": "structure", + "members": { + "createTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the configured model algorithm association was created.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "updateTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The most recent time at which the configured model algorithm association was updated.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "configuredModelAlgorithmAssociationArn": { + "target": "com.amazonaws.cleanroomsml#ConfiguredModelAlgorithmAssociationArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the configured model algorithm association.
", + "smithy.api#required": {} + } + }, + "configuredModelAlgorithmArn": { + "target": "com.amazonaws.cleanroomsml#ConfiguredModelAlgorithmArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the configured model algorithm that is being associated.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.cleanroomsml#NameString", + "traits": { + "smithy.api#documentation": "The name of the configured model algorithm association.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.cleanroomsml#ResourceDescription", + "traits": { + "smithy.api#documentation": "The description of the configured model algorithm association.
" + } + }, + "membershipIdentifier": { + "target": "com.amazonaws.cleanroomsml#UUID", + "traits": { + "smithy.api#documentation": "The membership ID of the member that created the configured model algorithm association.
", + "smithy.api#required": {} + } + }, + "collaborationIdentifier": { + "target": "com.amazonaws.cleanroomsml#UUID", + "traits": { + "smithy.api#documentation": "The collaboration ID of the collaboration that contains the configured model algorithm association.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Provides summary information about the configured model algorithm association.
" + } + }, + "com.amazonaws.cleanroomsml#ConfiguredModelAlgorithmList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanroomsml#ConfiguredModelAlgorithmSummary" + } + }, + "com.amazonaws.cleanroomsml#ConfiguredModelAlgorithmSummary": { + "type": "structure", + "members": { + "createTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the configured model algorithm was created.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "updateTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The most recent time at which the configured model algorithm was updated.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "configuredModelAlgorithmArn": { + "target": "com.amazonaws.cleanroomsml#ConfiguredModelAlgorithmArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the configured model algorithm.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.cleanroomsml#NameString", + "traits": { + "smithy.api#documentation": "The name of the configured model algorithm.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.cleanroomsml#ResourceDescription", + "traits": { + "smithy.api#documentation": "The description of the configured model algorithm.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides summary information about a configured model algorithm.
" + } + }, + "com.amazonaws.cleanroomsml#ConflictException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "You can't complete this action because another resource depends on this resource.
", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.cleanroomsml#ContainerArgument": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.cleanroomsml#ContainerArguments": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanroomsml#ContainerArgument" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.cleanroomsml#ContainerConfig": { + "type": "structure", + "members": { + "imageUri": { + "target": "com.amazonaws.cleanroomsml#AlgorithmImage", + "traits": { + "smithy.api#documentation": "The registry path of the docker image that contains the algorithm. Clean Rooms ML supports both registry/repository[:tag] and registry/repositry[@digest] image path formats. For more information about using images in Clean Rooms ML, see the Sagemaker API reference.
The entrypoint script for a Docker container used to run a training job. This script takes precedence over the default train processing instructions. See How Amazon SageMaker Runs Your Training Image for additional information. For more information, see How Sagemaker runs your training image.
" + } + }, + "arguments": { + "target": "com.amazonaws.cleanroomsml#ContainerArguments", + "traits": { + "smithy.api#documentation": "The arguments for a container used to run a training job. See How Amazon SageMaker Runs Your Training Image for additional information. For more information, see How Sagemaker runs your training image.
" + } + }, + "metricDefinitions": { + "target": "com.amazonaws.cleanroomsml#MetricDefinitionList", + "traits": { + "smithy.api#documentation": "A list of metric definition objects. Each object specifies the metric name and regular expressions used to parse algorithm logs. Amazon Web Services Clean Rooms ML publishes each metric to all members' Amazon CloudWatch using IAM role configured in PutMLConfiguration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides configuration information for the dockerized container where the model algorithm is stored.
" + } + }, + "com.amazonaws.cleanroomsml#ContainerEntrypoint": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanroomsml#ContainerEntrypointString" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.cleanroomsml#ContainerEntrypointString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.cleanroomsml#CreateAudienceModel": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanroomsml#CreateAudienceModelRequest" + }, + "output": { + "target": "com.amazonaws.cleanroomsml#CreateAudienceModelResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cleanroomsml#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanroomsml#ConflictException" + }, + { + "target": "com.amazonaws.cleanroomsml#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanroomsml#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.cleanroomsml#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Defines the information necessary to create an audience model. An audience model is a machine learning model that Clean Rooms ML trains to measure similarity between users. Clean Rooms ML manages training and storing the audience model. The audience model can be used in multiple calls to the StartAudienceGenerationJob API.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/audience-model" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cleanroomsml#CreateAudienceModelRequest": { + "type": "structure", + "members": { + "trainingDataStartTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The start date and time of the training window.
", + "smithy.api#timestampFormat": "date-time" + } + }, + "trainingDataEndTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The end date and time of the training window.
", + "smithy.api#timestampFormat": "date-time" + } + }, + "name": { + "target": "com.amazonaws.cleanroomsml#NameString", + "traits": { + "smithy.api#documentation": "The name of the audience model resource.
", + "smithy.api#required": {} + } + }, + "trainingDatasetArn": { + "target": "com.amazonaws.cleanroomsml#TrainingDatasetArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the training dataset for this audience model.
", + "smithy.api#required": {} + } + }, + "kmsKeyArn": { + "target": "com.amazonaws.cleanroomsml#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key. This key is used to encrypt and decrypt customer-owned data in the trained ML model and the associated data.
" + } + }, + "tags": { + "target": "com.amazonaws.cleanroomsml#TagMap", + "traits": { + "smithy.api#documentation": "The optional metadata that you apply to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50.
\nFor each resource, each tag key must be unique, and each tag key can have only one value.
\nMaximum key length - 128 Unicode characters in UTF-8.
\nMaximum value length - 256 Unicode characters in UTF-8.
\nIf your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms ML considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.
\nThe description of the audience model.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanroomsml#CreateAudienceModelResponse": { + "type": "structure", + "members": { + "audienceModelArn": { + "target": "com.amazonaws.cleanroomsml#AudienceModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the audience model.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cleanroomsml#CreateConfiguredAudienceModel": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanroomsml#CreateConfiguredAudienceModelRequest" + }, + "output": { + "target": "com.amazonaws.cleanroomsml#CreateConfiguredAudienceModelResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cleanroomsml#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanroomsml#ConflictException" + }, + { + "target": "com.amazonaws.cleanroomsml#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanroomsml#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.cleanroomsml#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Defines the information necessary to create a configured audience model.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/configured-audience-model" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cleanroomsml#CreateConfiguredAudienceModelRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.cleanroomsml#NameString", + "traits": { + "smithy.api#documentation": "The name of the configured audience model.
", + "smithy.api#required": {} + } + }, + "audienceModelArn": { + "target": "com.amazonaws.cleanroomsml#AudienceModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the audience model to use for the configured audience model.
", + "smithy.api#required": {} + } + }, + "outputConfig": { + "target": "com.amazonaws.cleanroomsml#ConfiguredAudienceModelOutputConfig", + "traits": { + "smithy.api#documentation": "Configure the Amazon S3 location and IAM Role for audiences created using this configured audience model. Each audience will have a unique location. The IAM Role must have s3:PutObject permission on the destination Amazon S3 location. If the destination is protected with Amazon S3 KMS-SSE, then the Role must also have the required KMS permissions.
The description of the configured audience model.
" + } + }, + "sharedAudienceMetrics": { + "target": "com.amazonaws.cleanroomsml#MetricsList", + "traits": { + "smithy.api#documentation": "Whether audience metrics are shared.
", + "smithy.api#required": {} + } + }, + "minMatchingSeedSize": { + "target": "com.amazonaws.cleanroomsml#MinMatchingSeedSize", + "traits": { + "smithy.api#default": 500, + "smithy.api#documentation": "The minimum number of users from the seed audience that must match with users in the training data of the audience model. The default value is 500.
" + } + }, + "audienceSizeConfig": { + "target": "com.amazonaws.cleanroomsml#AudienceSizeConfig", + "traits": { + "smithy.api#documentation": "Configure the list of output sizes of audiences that can be created using this configured audience model. A request to StartAudienceGenerationJob that uses this configured audience model must have an audienceSize selected from this list. You can use the ABSOLUTE\n AudienceSize to configure out audience sizes using the count of identifiers in the output. You can use the Percentage\n AudienceSize to configure sizes in the range 1-100 percent.
The optional metadata that you apply to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50.
\nFor each resource, each tag key must be unique, and each tag key can have only one value.
\nMaximum key length - 128 Unicode characters in UTF-8.
\nMaximum value length - 256 Unicode characters in UTF-8.
\nIf your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms ML considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.
\nConfigure how the service tags audience generation jobs created using this configured audience model. If you specify NONE, the tags from the StartAudienceGenerationJob request determine the tags of the audience generation job. If you specify FROM_PARENT_RESOURCE, the audience generation job inherits the tags from the configured audience model, by default. Tags in the StartAudienceGenerationJob will override the default.
When the client is in a different account than the configured audience model, the tags from the client are never applied to a resource in the caller's account.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanroomsml#CreateConfiguredAudienceModelResponse": { + "type": "structure", + "members": { + "configuredAudienceModelArn": { + "target": "com.amazonaws.cleanroomsml#ConfiguredAudienceModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the configured audience model.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cleanroomsml#CreateConfiguredModelAlgorithm": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanroomsml#CreateConfiguredModelAlgorithmRequest" + }, + "output": { + "target": "com.amazonaws.cleanroomsml#CreateConfiguredModelAlgorithmResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cleanroomsml#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanroomsml#ConflictException" + }, + { + "target": "com.amazonaws.cleanroomsml#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.cleanroomsml#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a configured model algorithm using a container image stored in an ECR repository.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/configured-model-algorithms" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cleanroomsml#CreateConfiguredModelAlgorithmAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanroomsml#CreateConfiguredModelAlgorithmAssociationRequest" + }, + "output": { + "target": "com.amazonaws.cleanroomsml#CreateConfiguredModelAlgorithmAssociationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cleanroomsml#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanroomsml#ConflictException" + }, + { + "target": "com.amazonaws.cleanroomsml#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanroomsml#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.cleanroomsml#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Associates a configured model algorithm to a collaboration for use by any member of the collaboration.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/memberships/{membershipIdentifier}/configured-model-algorithm-associations" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cleanroomsml#CreateConfiguredModelAlgorithmAssociationRequest": { + "type": "structure", + "members": { + "membershipIdentifier": { + "target": "com.amazonaws.cleanroomsml#UUID", + "traits": { + "smithy.api#documentation": "The membership ID of the member who is associating this configured model algorithm.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "configuredModelAlgorithmArn": { + "target": "com.amazonaws.cleanroomsml#ConfiguredModelAlgorithmArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the configured model algorithm that you want to associate.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.cleanroomsml#NameString", + "traits": { + "smithy.api#documentation": "The name of the configured model algorithm association.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.cleanroomsml#ResourceDescription", + "traits": { + "smithy.api#documentation": "The description of the configured model algorithm association.
" + } + }, + "privacyConfiguration": { + "target": "com.amazonaws.cleanroomsml#PrivacyConfiguration", + "traits": { + "smithy.api#documentation": "Specifies the privacy configuration information for the configured model algorithm association. This information includes the maximum data size that can be exported.
" + } + }, + "tags": { + "target": "com.amazonaws.cleanroomsml#TagMap", + "traits": { + "smithy.api#documentation": "The optional metadata that you apply to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50.
\nFor each resource, each tag key must be unique, and each tag key can have only one value.
\nMaximum key length - 128 Unicode characters in UTF-8.
\nMaximum value length - 256 Unicode characters in UTF-8.
\nIf your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms ML considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.
\nThe Amazon Resource Name (ARN) of the configured model algorithm association.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cleanroomsml#CreateConfiguredModelAlgorithmRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.cleanroomsml#NameString", + "traits": { + "smithy.api#documentation": "The name of the configured model algorithm.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.cleanroomsml#ResourceDescription", + "traits": { + "smithy.api#documentation": "The description of the configured model algorithm.
" + } + }, + "roleArn": { + "target": "com.amazonaws.cleanroomsml#IamRoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the role that is used to access the repository.
", + "smithy.api#required": {} + } + }, + "trainingContainerConfig": { + "target": "com.amazonaws.cleanroomsml#ContainerConfig", + "traits": { + "smithy.api#documentation": "Configuration information for the training container, including entrypoints and arguments.
" + } + }, + "inferenceContainerConfig": { + "target": "com.amazonaws.cleanroomsml#InferenceContainerConfig", + "traits": { + "smithy.api#documentation": "Configuration information for the inference container that is used when you run an inference job on a configured model algorithm.
" + } + }, + "tags": { + "target": "com.amazonaws.cleanroomsml#TagMap", + "traits": { + "smithy.api#documentation": "The optional metadata that you apply to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50.
\nFor each resource, each tag key must be unique, and each tag key can have only one value.
\nMaximum key length - 128 Unicode characters in UTF-8.
\nMaximum value length - 256 Unicode characters in UTF-8.
\nIf your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms ML considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.
\nThe Amazon Resource Name (ARN) of the KMS key. This key is used to encrypt and decrypt customer-owned data in the configured ML model algorithm and associated data.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanroomsml#CreateConfiguredModelAlgorithmResponse": { + "type": "structure", + "members": { + "configuredModelAlgorithmArn": { + "target": "com.amazonaws.cleanroomsml#ConfiguredModelAlgorithmArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the configured model algorithm.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cleanroomsml#CreateMLInputChannel": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanroomsml#CreateMLInputChannelRequest" + }, + "output": { + "target": "com.amazonaws.cleanroomsml#CreateMLInputChannelResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cleanroomsml#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanroomsml#ConflictException" + }, + { + "target": "com.amazonaws.cleanroomsml#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanroomsml#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.cleanroomsml#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Provides the information to create an ML input channel. An ML input channel is the result of a query that can be used for ML modeling.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/memberships/{membershipIdentifier}/ml-input-channels" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cleanroomsml#CreateMLInputChannelRequest": { + "type": "structure", + "members": { + "membershipIdentifier": { + "target": "com.amazonaws.cleanroomsml#UUID", + "traits": { + "smithy.api#documentation": "The membership ID of the member that is creating the ML input channel.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "configuredModelAlgorithmAssociations": { + "target": "com.amazonaws.cleanroomsml#ConfiguredModelAlgorithmAssociationArnList", + "traits": { + "smithy.api#documentation": "The associated configured model algorithms that are necessary to create this ML input channel.
", + "smithy.api#length": { + "min": 1, + "max": 1 + }, + "smithy.api#required": {} + } + }, + "inputChannel": { + "target": "com.amazonaws.cleanroomsml#InputChannel", + "traits": { + "smithy.api#documentation": "The input data that is used to create this ML input channel.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.cleanroomsml#NameString", + "traits": { + "smithy.api#documentation": "The name of the ML input channel.
", + "smithy.api#required": {} + } + }, + "retentionInDays": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The number of days that the data in the ML input channel is retained.
", + "smithy.api#range": { + "min": 1, + "max": 30 + }, + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.cleanroomsml#ResourceDescription", + "traits": { + "smithy.api#documentation": "The description of the ML input channel.
" + } + }, + "kmsKeyArn": { + "target": "com.amazonaws.cleanroomsml#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key that is used to access the input channel.
" + } + }, + "tags": { + "target": "com.amazonaws.cleanroomsml#TagMap", + "traits": { + "smithy.api#documentation": "The optional metadata that you apply to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50.
\nFor each resource, each tag key must be unique, and each tag key can have only one value.
\nMaximum key length - 128 Unicode characters in UTF-8.
\nMaximum value length - 256 Unicode characters in UTF-8.
\nIf your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms ML considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.
\nThe Amazon Resource Name (ARN) of the ML input channel.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cleanroomsml#CreateTrainedModel": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanroomsml#CreateTrainedModelRequest" + }, + "output": { + "target": "com.amazonaws.cleanroomsml#CreateTrainedModelResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cleanroomsml#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanroomsml#ConflictException" + }, + { + "target": "com.amazonaws.cleanroomsml#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanroomsml#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.cleanroomsml#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a trained model from an associated configured model algorithm using data from any member of the collaboration.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/memberships/{membershipIdentifier}/trained-models" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cleanroomsml#CreateTrainedModelRequest": { + "type": "structure", + "members": { + "membershipIdentifier": { + "target": "com.amazonaws.cleanroomsml#UUID", + "traits": { + "smithy.api#documentation": "The membership ID of the member that is creating the trained model.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.cleanroomsml#NameString", + "traits": { + "smithy.api#documentation": "The name of the trained model.
", + "smithy.api#required": {} + } + }, + "configuredModelAlgorithmAssociationArn": { + "target": "com.amazonaws.cleanroomsml#ConfiguredModelAlgorithmAssociationArn", + "traits": { + "smithy.api#documentation": "The associated configured model algorithm used to train this model.
", + "smithy.api#required": {} + } + }, + "hyperparameters": { + "target": "com.amazonaws.cleanroomsml#HyperParameters", + "traits": { + "smithy.api#documentation": "Algorithm-specific parameters that influence the quality of the model. You set hyperparameters before you start the learning process.
" + } + }, + "environment": { + "target": "com.amazonaws.cleanroomsml#Environment", + "traits": { + "smithy.api#documentation": "The environment variables to set in the Docker container.
" + } + }, + "resourceConfig": { + "target": "com.amazonaws.cleanroomsml#ResourceConfig", + "traits": { + "smithy.api#documentation": "Information about the EC2 resources that are used to train this model.
", + "smithy.api#required": {} + } + }, + "stoppingCondition": { + "target": "com.amazonaws.cleanroomsml#StoppingCondition", + "traits": { + "smithy.api#documentation": "The criteria that is used to stop model training.
" + } + }, + "dataChannels": { + "target": "com.amazonaws.cleanroomsml#ModelTrainingDataChannels", + "traits": { + "smithy.api#documentation": "Defines the data channels that are used as input for the trained model request.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.cleanroomsml#ResourceDescription", + "traits": { + "smithy.api#documentation": "The description of the trained model.
" + } + }, + "kmsKeyArn": { + "target": "com.amazonaws.cleanroomsml#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key. This key is used to encrypt and decrypt customer-owned data in the trained ML model and the associated data.
" + } + }, + "tags": { + "target": "com.amazonaws.cleanroomsml#TagMap", + "traits": { + "smithy.api#documentation": "The optional metadata that you apply to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50.
\nFor each resource, each tag key must be unique, and each tag key can have only one value.
\nMaximum key length - 128 Unicode characters in UTF-8.
\nMaximum value length - 256 Unicode characters in UTF-8.
\nIf your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms ML considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.
\nThe Amazon Resource Name (ARN) of the trained model.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cleanroomsml#CreateTrainingDataset": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanroomsml#CreateTrainingDatasetRequest" + }, + "output": { + "target": "com.amazonaws.cleanroomsml#CreateTrainingDatasetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cleanroomsml#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanroomsml#ConflictException" + }, + { + "target": "com.amazonaws.cleanroomsml#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Defines the information necessary to create a training dataset. In Clean Rooms ML, the TrainingDataset is metadata that points to a Glue table, which is read only during AudienceModel creation.
The name of the training dataset. This name must be unique in your account and region.
", + "smithy.api#required": {} + } + }, + "roleArn": { + "target": "com.amazonaws.cleanroomsml#IamRoleArn", + "traits": { + "smithy.api#documentation": "The ARN of the IAM role that Clean Rooms ML can assume to read the data referred to in the dataSource field of each dataset.
Passing a role across AWS accounts is not allowed. If you pass a role that isn't in your account, you get an AccessDeniedException error.
An array of information that lists the Dataset objects, which specifies the dataset type and details on its location and schema. You must provide a role that has read access to these tables.
", + "smithy.api#length": { + "min": 1, + "max": 1 + }, + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.cleanroomsml#TagMap", + "traits": { + "smithy.api#documentation": "The optional metadata that you apply to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50.
\nFor each resource, each tag key must be unique, and each tag key can have only one value.
\nMaximum key length - 128 Unicode characters in UTF-8.
\nMaximum value length - 256 Unicode characters in UTF-8.
\nIf your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms ML considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.
\nThe description of the training dataset.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanroomsml#CreateTrainingDatasetResponse": { + "type": "structure", + "members": { + "trainingDatasetArn": { + "target": "com.amazonaws.cleanroomsml#TrainingDatasetArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the training dataset resource.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cleanroomsml#DataSource": { + "type": "structure", + "members": { + "glueDataSource": { + "target": "com.amazonaws.cleanroomsml#GlueDataSource", + "traits": { + "smithy.api#documentation": "A GlueDataSource object that defines the catalog ID, database name, and table name for the training data.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Defines information about the Glue data source that contains the training data.
" + } + }, + "com.amazonaws.cleanroomsml#Dataset": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.cleanroomsml#DatasetType", + "traits": { + "smithy.api#documentation": "What type of information is found in the dataset.
", + "smithy.api#required": {} + } + }, + "inputConfig": { + "target": "com.amazonaws.cleanroomsml#DatasetInputConfig", + "traits": { + "smithy.api#documentation": "A DatasetInputConfig object that defines the data source and schema mapping.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Defines where the training dataset is located, what type of data it contains, and how to access the data.
" + } + }, + "com.amazonaws.cleanroomsml#DatasetInputConfig": { + "type": "structure", + "members": { + "schema": { + "target": "com.amazonaws.cleanroomsml#DatasetSchemaList", + "traits": { + "smithy.api#documentation": "The schema information for the training data.
", + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#required": {} + } + }, + "dataSource": { + "target": "com.amazonaws.cleanroomsml#DataSource", + "traits": { + "smithy.api#documentation": "A DataSource object that specifies the Glue data source for the training data.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Defines the Glue data source and schema mapping information.
" + } + }, + "com.amazonaws.cleanroomsml#DatasetList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanroomsml#Dataset" + } + }, + "com.amazonaws.cleanroomsml#DatasetSchemaList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanroomsml#ColumnSchema" + } + }, + "com.amazonaws.cleanroomsml#DatasetType": { + "type": "enum", + "members": { + "INTERACTIONS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERACTIONS" + } + } + } + }, + "com.amazonaws.cleanroomsml#DeleteAudienceGenerationJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanroomsml#DeleteAudienceGenerationJobRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cleanroomsml#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanroomsml#ConflictException" + }, + { + "target": "com.amazonaws.cleanroomsml#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanroomsml#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the specified audience generation job, and removes all data associated with the job.
", + "smithy.api#http": { + "code": 200, + "method": "DELETE", + "uri": "/audience-generation-job/{audienceGenerationJobArn}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cleanroomsml#DeleteAudienceGenerationJobRequest": { + "type": "structure", + "members": { + "audienceGenerationJobArn": { + "target": "com.amazonaws.cleanroomsml#AudienceGenerationJobArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the audience generation job that you want to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanroomsml#DeleteAudienceModel": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanroomsml#DeleteAudienceModelRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cleanroomsml#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanroomsml#ConflictException" + }, + { + "target": "com.amazonaws.cleanroomsml#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanroomsml#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Specifies an audience model that you want to delete. You can't delete an audience model if there are any configured audience models that depend on the audience model.
", + "smithy.api#http": { + "code": 200, + "uri": "/audience-model/{audienceModelArn}", + "method": "DELETE" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cleanroomsml#DeleteAudienceModelRequest": { + "type": "structure", + "members": { + "audienceModelArn": { + "target": "com.amazonaws.cleanroomsml#AudienceModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the audience model that you want to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanroomsml#DeleteConfiguredAudienceModel": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanroomsml#DeleteConfiguredAudienceModelRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cleanroomsml#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanroomsml#ConflictException" + }, + { + "target": "com.amazonaws.cleanroomsml#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanroomsml#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the specified configured audience model. You can't delete a configured audience model if there are any lookalike models that use the configured audience model. If you delete a configured audience model, it will be removed from any collaborations that it is associated to.
", + "smithy.api#http": { + "code": 200, + "uri": "/configured-audience-model/{configuredAudienceModelArn}", + "method": "DELETE" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cleanroomsml#DeleteConfiguredAudienceModelPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanroomsml#DeleteConfiguredAudienceModelPolicyRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cleanroomsml#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanroomsml#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanroomsml#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the specified configured audience model policy.
", + "smithy.api#http": { + "code": 200, + "method": "DELETE", + "uri": "/configured-audience-model/{configuredAudienceModelArn}/policy" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cleanroomsml#DeleteConfiguredAudienceModelPolicyRequest": { + "type": "structure", + "members": { + "configuredAudienceModelArn": { + "target": "com.amazonaws.cleanroomsml#ConfiguredAudienceModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the configured audience model policy that you want to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanroomsml#DeleteConfiguredAudienceModelRequest": { + "type": "structure", + "members": { + "configuredAudienceModelArn": { + "target": "com.amazonaws.cleanroomsml#ConfiguredAudienceModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the configured audience model that you want to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanroomsml#DeleteConfiguredModelAlgorithm": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanroomsml#DeleteConfiguredModelAlgorithmRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cleanroomsml#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanroomsml#ConflictException" + }, + { + "target": "com.amazonaws.cleanroomsml#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanroomsml#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a configured model algorithm.
", + "smithy.api#http": { + "code": 200, + "uri": "/configured-model-algorithms/{configuredModelAlgorithmArn}", + "method": "DELETE" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cleanroomsml#DeleteConfiguredModelAlgorithmAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanroomsml#DeleteConfiguredModelAlgorithmAssociationRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cleanroomsml#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanroomsml#ConflictException" + }, + { + "target": "com.amazonaws.cleanroomsml#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanroomsml#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a configured model algorithm association.
", + "smithy.api#http": { + "code": 200, + "method": "DELETE", + "uri": "/memberships/{membershipIdentifier}/configured-model-algorithm-associations/{configuredModelAlgorithmAssociationArn}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cleanroomsml#DeleteConfiguredModelAlgorithmAssociationRequest": { + "type": "structure", + "members": { + "configuredModelAlgorithmAssociationArn": { + "target": "com.amazonaws.cleanroomsml#ConfiguredModelAlgorithmAssociationArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the configured model algorithm association that you want to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "membershipIdentifier": { + "target": "com.amazonaws.cleanroomsml#UUID", + "traits": { + "smithy.api#documentation": "The membership ID of the member that is deleting the configured model algorithm association.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanroomsml#DeleteConfiguredModelAlgorithmRequest": { + "type": "structure", + "members": { + "configuredModelAlgorithmArn": { + "target": "com.amazonaws.cleanroomsml#ConfiguredModelAlgorithmArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the configured model algorithm that you want to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanroomsml#DeleteMLConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanroomsml#DeleteMLConfigurationRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cleanroomsml#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanroomsml#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanroomsml#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a ML modeling configuration.
", + "smithy.api#http": { + "code": 200, + "method": "DELETE", + "uri": "/memberships/{membershipIdentifier}/ml-configurations" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cleanroomsml#DeleteMLConfigurationRequest": { + "type": "structure", + "members": { + "membershipIdentifier": { + "target": "com.amazonaws.cleanroomsml#UUID", + "traits": { + "smithy.api#documentation": "The membership ID of the of the member that is deleting the ML modeling configuration.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanroomsml#DeleteMLInputChannelData": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanroomsml#DeleteMLInputChannelDataRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cleanroomsml#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanroomsml#ConflictException" + }, + { + "target": "com.amazonaws.cleanroomsml#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanroomsml#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Provides the information necessary to delete an ML input channel.
", + "smithy.api#http": { + "code": 200, + "method": "DELETE", + "uri": "/memberships/{membershipIdentifier}/ml-input-channels/{mlInputChannelArn}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cleanroomsml#DeleteMLInputChannelDataRequest": { + "type": "structure", + "members": { + "mlInputChannelArn": { + "target": "com.amazonaws.cleanroomsml#MLInputChannelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the ML input channel that you want to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "membershipIdentifier": { + "target": "com.amazonaws.cleanroomsml#UUID", + "traits": { + "smithy.api#documentation": "The membership ID of the membership that contains the ML input channel you want to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanroomsml#DeleteTrainedModelOutput": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanroomsml#DeleteTrainedModelOutputRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cleanroomsml#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanroomsml#ConflictException" + }, + { + "target": "com.amazonaws.cleanroomsml#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanroomsml#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the output of a trained model.
", + "smithy.api#http": { + "code": 200, + "method": "DELETE", + "uri": "/memberships/{membershipIdentifier}/trained-models/{trainedModelArn}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cleanroomsml#DeleteTrainedModelOutputRequest": { + "type": "structure", + "members": { + "trainedModelArn": { + "target": "com.amazonaws.cleanroomsml#TrainedModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the trained model whose output you want to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "membershipIdentifier": { + "target": "com.amazonaws.cleanroomsml#UUID", + "traits": { + "smithy.api#documentation": "The membership ID of the member that is deleting the trained model output.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanroomsml#DeleteTrainingDataset": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanroomsml#DeleteTrainingDatasetRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cleanroomsml#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanroomsml#ConflictException" + }, + { + "target": "com.amazonaws.cleanroomsml#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanroomsml#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Specifies a training dataset that you want to delete. You can't delete a training dataset if there are any audience models that depend on the training dataset. In Clean Rooms ML, the TrainingDataset is metadata that points to a Glue table, which is read only during AudienceModel creation. This action deletes the metadata.
The Amazon Resource Name (ARN) of the training dataset that you want to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanroomsml#Destination": { + "type": "structure", + "members": { + "s3Destination": { + "target": "com.amazonaws.cleanroomsml#S3ConfigMap", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The Amazon S3 location where the exported model artifacts are stored.
" + } + }, + "com.amazonaws.cleanroomsml#Environment": { + "type": "map", + "key": { + "target": "smithy.api#String", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$" + } + }, + "value": { + "target": "smithy.api#String", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "^[\\S\\s]*$" + } + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.cleanroomsml#GetAudienceGenerationJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanroomsml#GetAudienceGenerationJobRequest" + }, + "output": { + "target": "com.amazonaws.cleanroomsml#GetAudienceGenerationJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cleanroomsml#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanroomsml#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanroomsml#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns information about an audience generation job.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/audience-generation-job/{audienceGenerationJobArn}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.cleanroomsml#GetAudienceGenerationJobRequest": { + "type": "structure", + "members": { + "audienceGenerationJobArn": { + "target": "com.amazonaws.cleanroomsml#AudienceGenerationJobArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the audience generation job that you are interested in.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanroomsml#GetAudienceGenerationJobResponse": { + "type": "structure", + "members": { + "createTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the audience generation job was created.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "updateTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The most recent time at which the audience generation job was updated.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "audienceGenerationJobArn": { + "target": "com.amazonaws.cleanroomsml#AudienceGenerationJobArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the audience generation job.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.cleanroomsml#NameString", + "traits": { + "smithy.api#documentation": "The name of the audience generation job.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.cleanroomsml#ResourceDescription", + "traits": { + "smithy.api#documentation": "The description of the audience generation job.
" + } + }, + "status": { + "target": "com.amazonaws.cleanroomsml#AudienceGenerationJobStatus", + "traits": { + "smithy.api#documentation": "The status of the audience generation job.
", + "smithy.api#required": {} + } + }, + "statusDetails": { + "target": "com.amazonaws.cleanroomsml#StatusDetails", + "traits": { + "smithy.api#documentation": "Details about the status of the audience generation job.
" + } + }, + "configuredAudienceModelArn": { + "target": "com.amazonaws.cleanroomsml#ConfiguredAudienceModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the configured audience model used for this audience generation job.
", + "smithy.api#required": {} + } + }, + "seedAudience": { + "target": "com.amazonaws.cleanroomsml#AudienceGenerationJobDataSource", + "traits": { + "smithy.api#documentation": "The seed audience that was used for this audience generation job. This field will be null if the account calling the API is the account that started this audience generation job.
" + } + }, + "includeSeedInOutput": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Configure whether the seed users are included in the output audience. By default, Clean Rooms ML removes seed users from the output audience. If you specify TRUE, the seed users will appear first in the output. Clean Rooms ML does not explicitly reveal whether a user was in the seed, but the recipient of the audience will know that the first minimumSeedSize count of users are from the seed.
The identifier of the collaboration that this audience generation job is associated with.
" + } + }, + "metrics": { + "target": "com.amazonaws.cleanroomsml#AudienceQualityMetrics", + "traits": { + "smithy.api#documentation": "The relevance scores for different audience sizes and the recall score of the generated audience.
" + } + }, + "startedBy": { + "target": "com.amazonaws.cleanroomsml#AccountId", + "traits": { + "smithy.api#documentation": "The AWS account that started this audience generation job.
" + } + }, + "tags": { + "target": "com.amazonaws.cleanroomsml#TagMap", + "traits": { + "smithy.api#documentation": "The tags that are associated to this audience generation job.
" + } + }, + "protectedQueryIdentifier": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier of the protected query for this audience generation job.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cleanroomsml#GetAudienceModel": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanroomsml#GetAudienceModelRequest" + }, + "output": { + "target": "com.amazonaws.cleanroomsml#GetAudienceModelResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cleanroomsml#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanroomsml#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanroomsml#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns information about an audience model
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/audience-model/{audienceModelArn}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.cleanroomsml#GetAudienceModelRequest": { + "type": "structure", + "members": { + "audienceModelArn": { + "target": "com.amazonaws.cleanroomsml#AudienceModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the audience model that you are interested in.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanroomsml#GetAudienceModelResponse": { + "type": "structure", + "members": { + "createTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the audience model was created.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "updateTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The most recent time at which the audience model was updated.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "trainingDataStartTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The start date specified for the training window.
", + "smithy.api#timestampFormat": "date-time" + } + }, + "trainingDataEndTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The end date specified for the training window.
", + "smithy.api#timestampFormat": "date-time" + } + }, + "audienceModelArn": { + "target": "com.amazonaws.cleanroomsml#AudienceModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the audience model.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.cleanroomsml#NameString", + "traits": { + "smithy.api#documentation": "The name of the audience model.
", + "smithy.api#required": {} + } + }, + "trainingDatasetArn": { + "target": "com.amazonaws.cleanroomsml#TrainingDatasetArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the training dataset that was used for this audience model.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.cleanroomsml#AudienceModelStatus", + "traits": { + "smithy.api#documentation": "The status of the audience model.
", + "smithy.api#required": {} + } + }, + "statusDetails": { + "target": "com.amazonaws.cleanroomsml#StatusDetails", + "traits": { + "smithy.api#documentation": "Details about the status of the audience model.
" + } + }, + "kmsKeyArn": { + "target": "com.amazonaws.cleanroomsml#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The KMS key ARN used for the audience model.
" + } + }, + "tags": { + "target": "com.amazonaws.cleanroomsml#TagMap", + "traits": { + "smithy.api#documentation": "The tags that are assigned to the audience model.
" + } + }, + "description": { + "target": "com.amazonaws.cleanroomsml#ResourceDescription", + "traits": { + "smithy.api#documentation": "The description of the audience model.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cleanroomsml#GetCollaborationConfiguredModelAlgorithmAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanroomsml#GetCollaborationConfiguredModelAlgorithmAssociationRequest" + }, + "output": { + "target": "com.amazonaws.cleanroomsml#GetCollaborationConfiguredModelAlgorithmAssociationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cleanroomsml#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanroomsml#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanroomsml#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns information about the configured model algorithm association in a collaboration.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/collaborations/{collaborationIdentifier}/configured-model-algorithm-associations/{configuredModelAlgorithmAssociationArn}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.cleanroomsml#GetCollaborationConfiguredModelAlgorithmAssociationRequest": { + "type": "structure", + "members": { + "configuredModelAlgorithmAssociationArn": { + "target": "com.amazonaws.cleanroomsml#ConfiguredModelAlgorithmAssociationArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the configured model algorithm association that you want to return information about.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "collaborationIdentifier": { + "target": "com.amazonaws.cleanroomsml#UUID", + "traits": { + "smithy.api#documentation": "The collaboration ID for the collaboration that contains the configured model algorithm association that you want to return information about.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanroomsml#GetCollaborationConfiguredModelAlgorithmAssociationResponse": { + "type": "structure", + "members": { + "createTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the configured model algorithm association was created.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "updateTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The most recent time at which the configured model algorithm association was updated.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "configuredModelAlgorithmAssociationArn": { + "target": "com.amazonaws.cleanroomsml#ConfiguredModelAlgorithmAssociationArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the configured model algorithm association.
", + "smithy.api#required": {} + } + }, + "membershipIdentifier": { + "target": "com.amazonaws.cleanroomsml#UUID", + "traits": { + "smithy.api#documentation": "The membership ID of the member that created the configured model algorithm association.
", + "smithy.api#required": {} + } + }, + "collaborationIdentifier": { + "target": "com.amazonaws.cleanroomsml#UUID", + "traits": { + "smithy.api#documentation": "The collaboration ID of the collaboration that contains the configured model algorithm association.
", + "smithy.api#required": {} + } + }, + "configuredModelAlgorithmArn": { + "target": "com.amazonaws.cleanroomsml#ConfiguredModelAlgorithmArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the configured model algorithm association.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.cleanroomsml#NameString", + "traits": { + "smithy.api#documentation": "The name of the configured model algorithm association.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.cleanroomsml#ResourceDescription", + "traits": { + "smithy.api#documentation": "The description of the configured model algorithm association.
" + } + }, + "creatorAccountId": { + "target": "com.amazonaws.cleanroomsml#AccountId", + "traits": { + "smithy.api#documentation": "The account ID of the member that created the configured model algorithm association.
", + "smithy.api#required": {} + } + }, + "privacyConfiguration": { + "target": "com.amazonaws.cleanroomsml#PrivacyConfiguration" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cleanroomsml#GetCollaborationMLInputChannel": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanroomsml#GetCollaborationMLInputChannelRequest" + }, + "output": { + "target": "com.amazonaws.cleanroomsml#GetCollaborationMLInputChannelResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cleanroomsml#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanroomsml#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanroomsml#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns information about a specific ML input channel in a collaboration.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/collaborations/{collaborationIdentifier}/ml-input-channels/{mlInputChannelArn}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.cleanroomsml#GetCollaborationMLInputChannelRequest": { + "type": "structure", + "members": { + "mlInputChannelArn": { + "target": "com.amazonaws.cleanroomsml#MLInputChannelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the ML input channel that you want to get.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "collaborationIdentifier": { + "target": "com.amazonaws.cleanroomsml#UUID", + "traits": { + "smithy.api#documentation": "The collaboration ID of the collaboration that contains the ML input channel that you want to get.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanroomsml#GetCollaborationMLInputChannelResponse": { + "type": "structure", + "members": { + "createTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the ML input channel was created.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "updateTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The most recent time at which the ML input channel was updated.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "creatorAccountId": { + "target": "com.amazonaws.cleanroomsml#AccountId", + "traits": { + "smithy.api#documentation": "The account ID of the member who created the ML input channel.
", + "smithy.api#required": {} + } + }, + "membershipIdentifier": { + "target": "com.amazonaws.cleanroomsml#UUID", + "traits": { + "smithy.api#documentation": "The membership ID of the membership that contains the ML input channel.
", + "smithy.api#required": {} + } + }, + "collaborationIdentifier": { + "target": "com.amazonaws.cleanroomsml#UUID", + "traits": { + "smithy.api#documentation": "The collaboration ID of the collaboration that contains the ML input channel.
", + "smithy.api#required": {} + } + }, + "mlInputChannelArn": { + "target": "com.amazonaws.cleanroomsml#MLInputChannelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the ML input channel.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.cleanroomsml#NameString", + "traits": { + "smithy.api#documentation": "The name of the ML input channel.
", + "smithy.api#required": {} + } + }, + "configuredModelAlgorithmAssociations": { + "target": "com.amazonaws.cleanroomsml#ConfiguredModelAlgorithmAssociationArnList", + "traits": { + "smithy.api#documentation": "The configured model algorithm associations that were used to create the ML input channel.
", + "smithy.api#length": { + "min": 1, + "max": 1 + }, + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.cleanroomsml#MLInputChannelStatus", + "traits": { + "smithy.api#documentation": "The status of the ML input channel.
", + "smithy.api#required": {} + } + }, + "statusDetails": { + "target": "com.amazonaws.cleanroomsml#StatusDetails" + }, + "retentionInDays": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The number of days to retain the data for the ML input channel.
", + "smithy.api#range": { + "min": 1, + "max": 30 + }, + "smithy.api#required": {} + } + }, + "numberOfRecords": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "The number of records in the ML input channel.
", + "smithy.api#range": { + "min": 0, + "max": 100000000000 + } + } + }, + "description": { + "target": "com.amazonaws.cleanroomsml#ResourceDescription", + "traits": { + "smithy.api#documentation": "The description of the ML input channel.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cleanroomsml#GetCollaborationTrainedModel": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanroomsml#GetCollaborationTrainedModelRequest" + }, + "output": { + "target": "com.amazonaws.cleanroomsml#GetCollaborationTrainedModelResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cleanroomsml#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanroomsml#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanroomsml#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns information about a trained model in a collaboration.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/collaborations/{collaborationIdentifier}/trained-models/{trainedModelArn}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.cleanroomsml#GetCollaborationTrainedModelRequest": { + "type": "structure", + "members": { + "trainedModelArn": { + "target": "com.amazonaws.cleanroomsml#TrainedModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the trained model that you want to return information about.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "collaborationIdentifier": { + "target": "com.amazonaws.cleanroomsml#UUID", + "traits": { + "smithy.api#documentation": "The collaboration ID that contains the trained model that you want to return information about.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanroomsml#GetCollaborationTrainedModelResponse": { + "type": "structure", + "members": { + "membershipIdentifier": { + "target": "com.amazonaws.cleanroomsml#UUID", + "traits": { + "smithy.api#documentation": "The membership ID of the member that created the trained model.
", + "smithy.api#required": {} + } + }, + "collaborationIdentifier": { + "target": "com.amazonaws.cleanroomsml#UUID", + "traits": { + "smithy.api#documentation": "The collaboration ID of the collaboration that contains the trained model.
", + "smithy.api#required": {} + } + }, + "trainedModelArn": { + "target": "com.amazonaws.cleanroomsml#TrainedModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the trained model.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.cleanroomsml#NameString", + "traits": { + "smithy.api#documentation": "The name of the trained model.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.cleanroomsml#ResourceDescription", + "traits": { + "smithy.api#documentation": "The description of the trained model.
" + } + }, + "status": { + "target": "com.amazonaws.cleanroomsml#TrainedModelStatus", + "traits": { + "smithy.api#documentation": "The status of the trained model.
", + "smithy.api#required": {} + } + }, + "statusDetails": { + "target": "com.amazonaws.cleanroomsml#StatusDetails" + }, + "configuredModelAlgorithmAssociationArn": { + "target": "com.amazonaws.cleanroomsml#ConfiguredModelAlgorithmAssociationArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the configured model algorithm association that was used to create this trained model.
", + "smithy.api#required": {} + } + }, + "resourceConfig": { + "target": "com.amazonaws.cleanroomsml#ResourceConfig", + "traits": { + "smithy.api#documentation": "The EC2 resource configuration that was used to train this model.
" + } + }, + "stoppingCondition": { + "target": "com.amazonaws.cleanroomsml#StoppingCondition", + "traits": { + "smithy.api#documentation": "The stopping condition that determined when model training ended.
" + } + }, + "metricsStatus": { + "target": "com.amazonaws.cleanroomsml#MetricsStatus", + "traits": { + "smithy.api#documentation": "The status of the model metrics.
" + } + }, + "metricsStatusDetails": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Details about the status information for the model metrics.
" + } + }, + "logsStatus": { + "target": "com.amazonaws.cleanroomsml#LogsStatus", + "traits": { + "smithy.api#documentation": "Status information for the logs.
" + } + }, + "logsStatusDetails": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Details about the status information for the logs.
" + } + }, + "trainingContainerImageDigest": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Information about the training container image.
" + } + }, + "createTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the trained model was created.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "updateTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The most recent time at which the trained model was updated.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "creatorAccountId": { + "target": "com.amazonaws.cleanroomsml#AccountId", + "traits": { + "smithy.api#documentation": "The account ID of the member that created the trained model.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cleanroomsml#GetConfiguredAudienceModel": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanroomsml#GetConfiguredAudienceModelRequest" + }, + "output": { + "target": "com.amazonaws.cleanroomsml#GetConfiguredAudienceModelResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cleanroomsml#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanroomsml#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanroomsml#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns information about a specified configured audience model.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/configured-audience-model/{configuredAudienceModelArn}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.cleanroomsml#GetConfiguredAudienceModelPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanroomsml#GetConfiguredAudienceModelPolicyRequest" + }, + "output": { + "target": "com.amazonaws.cleanroomsml#GetConfiguredAudienceModelPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cleanroomsml#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanroomsml#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanroomsml#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns information about a configured audience model policy.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/configured-audience-model/{configuredAudienceModelArn}/policy" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.cleanroomsml#GetConfiguredAudienceModelPolicyRequest": { + "type": "structure", + "members": { + "configuredAudienceModelArn": { + "target": "com.amazonaws.cleanroomsml#ConfiguredAudienceModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the configured audience model that you are interested in.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanroomsml#GetConfiguredAudienceModelPolicyResponse": { + "type": "structure", + "members": { + "configuredAudienceModelArn": { + "target": "com.amazonaws.cleanroomsml#ConfiguredAudienceModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the configured audience model.
", + "smithy.api#required": {} + } + }, + "configuredAudienceModelPolicy": { + "target": "com.amazonaws.cleanroomsml#ResourcePolicy", + "traits": { + "smithy.api#documentation": "The configured audience model policy. This is a JSON IAM resource policy.
", + "smithy.api#required": {} + } + }, + "policyHash": { + "target": "com.amazonaws.cleanroomsml#Hash", + "traits": { + "smithy.api#documentation": "A cryptographic hash of the contents of the policy used to prevent unexpected concurrent modification of the policy.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cleanroomsml#GetConfiguredAudienceModelRequest": { + "type": "structure", + "members": { + "configuredAudienceModelArn": { + "target": "com.amazonaws.cleanroomsml#ConfiguredAudienceModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the configured audience model that you are interested in.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanroomsml#GetConfiguredAudienceModelResponse": { + "type": "structure", + "members": { + "createTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the configured audience model was created.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "updateTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The most recent time at which the configured audience model was updated.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "configuredAudienceModelArn": { + "target": "com.amazonaws.cleanroomsml#ConfiguredAudienceModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the configured audience model.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.cleanroomsml#NameString", + "traits": { + "smithy.api#documentation": "The name of the configured audience model.
", + "smithy.api#required": {} + } + }, + "audienceModelArn": { + "target": "com.amazonaws.cleanroomsml#AudienceModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the audience model used for this configured audience model.
", + "smithy.api#required": {} + } + }, + "outputConfig": { + "target": "com.amazonaws.cleanroomsml#ConfiguredAudienceModelOutputConfig", + "traits": { + "smithy.api#documentation": "The output configuration of the configured audience model
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.cleanroomsml#ResourceDescription", + "traits": { + "smithy.api#documentation": "The description of the configured audience model.
" + } + }, + "status": { + "target": "com.amazonaws.cleanroomsml#ConfiguredAudienceModelStatus", + "traits": { + "smithy.api#documentation": "The status of the configured audience model.
", + "smithy.api#required": {} + } + }, + "sharedAudienceMetrics": { + "target": "com.amazonaws.cleanroomsml#MetricsList", + "traits": { + "smithy.api#documentation": "Whether audience metrics are shared.
", + "smithy.api#required": {} + } + }, + "minMatchingSeedSize": { + "target": "com.amazonaws.cleanroomsml#MinMatchingSeedSize", + "traits": { + "smithy.api#documentation": "The minimum number of users from the seed audience that must match with users in the training data of the audience model.
" + } + }, + "audienceSizeConfig": { + "target": "com.amazonaws.cleanroomsml#AudienceSizeConfig", + "traits": { + "smithy.api#documentation": "The list of output sizes of audiences that can be created using this configured audience model. A request to StartAudienceGenerationJob that uses this configured audience model must have an audienceSize selected from this list. You can use the ABSOLUTE\n AudienceSize to configure out audience sizes using the count of identifiers in the output. You can use the Percentage\n AudienceSize to configure sizes in the range 1-100 percent.
The tags that are associated to this configured audience model.
" + } + }, + "childResourceTagOnCreatePolicy": { + "target": "com.amazonaws.cleanroomsml#TagOnCreatePolicy", + "traits": { + "smithy.api#documentation": "Provides the childResourceTagOnCreatePolicy that was used for this configured audience model.
Returns information about a configured model algorithm.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/configured-model-algorithms/{configuredModelAlgorithmArn}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.cleanroomsml#GetConfiguredModelAlgorithmAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanroomsml#GetConfiguredModelAlgorithmAssociationRequest" + }, + "output": { + "target": "com.amazonaws.cleanroomsml#GetConfiguredModelAlgorithmAssociationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cleanroomsml#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanroomsml#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanroomsml#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns information about a configured model algorithm association.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/memberships/{membershipIdentifier}/configured-model-algorithm-associations/{configuredModelAlgorithmAssociationArn}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.cleanroomsml#GetConfiguredModelAlgorithmAssociationRequest": { + "type": "structure", + "members": { + "configuredModelAlgorithmAssociationArn": { + "target": "com.amazonaws.cleanroomsml#ConfiguredModelAlgorithmAssociationArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the configured model algorithm association that you want to return information about.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "membershipIdentifier": { + "target": "com.amazonaws.cleanroomsml#UUID", + "traits": { + "smithy.api#documentation": "The membership ID of the member that created the configured model algorithm association.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanroomsml#GetConfiguredModelAlgorithmAssociationResponse": { + "type": "structure", + "members": { + "createTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the configured model algorithm association was created.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "updateTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The most recent time at which the configured model algorithm association was updated.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "configuredModelAlgorithmAssociationArn": { + "target": "com.amazonaws.cleanroomsml#ConfiguredModelAlgorithmAssociationArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the configured model algorithm association.
", + "smithy.api#required": {} + } + }, + "membershipIdentifier": { + "target": "com.amazonaws.cleanroomsml#UUID", + "traits": { + "smithy.api#documentation": "The membership ID of the member that created the configured model algorithm association.
", + "smithy.api#required": {} + } + }, + "collaborationIdentifier": { + "target": "com.amazonaws.cleanroomsml#UUID", + "traits": { + "smithy.api#documentation": "The collaboration ID of the collaboration that contains the configured model algorithm association.
", + "smithy.api#required": {} + } + }, + "configuredModelAlgorithmArn": { + "target": "com.amazonaws.cleanroomsml#ConfiguredModelAlgorithmArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the configured model algorithm that was associated to the collaboration.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.cleanroomsml#NameString", + "traits": { + "smithy.api#documentation": "The name of the configured model algorithm association.
", + "smithy.api#required": {} + } + }, + "privacyConfiguration": { + "target": "com.amazonaws.cleanroomsml#PrivacyConfiguration", + "traits": { + "smithy.api#documentation": "The privacy configuration information for the configured model algorithm association.
" + } + }, + "description": { + "target": "com.amazonaws.cleanroomsml#ResourceDescription", + "traits": { + "smithy.api#documentation": "The description of the configured model algorithm association.
" + } + }, + "tags": { + "target": "com.amazonaws.cleanroomsml#TagMap", + "traits": { + "smithy.api#documentation": "The optional metadata that you applied to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50.
\nFor each resource, each tag key must be unique, and each tag key can have only one value.
\nMaximum key length - 128 Unicode characters in UTF-8.
\nMaximum value length - 256 Unicode characters in UTF-8.
\nIf your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms ML considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.
\nThe Amazon Resource Name (ARN) of the configured model algorithm that you want to return information about.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanroomsml#GetConfiguredModelAlgorithmResponse": { + "type": "structure", + "members": { + "createTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the configured model algorithm was created.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "updateTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The most recent time at which the configured model algorithm was updated.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "configuredModelAlgorithmArn": { + "target": "com.amazonaws.cleanroomsml#ConfiguredModelAlgorithmArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the configured model algorithm.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.cleanroomsml#NameString", + "traits": { + "smithy.api#documentation": "The name of the configured model algorithm.
", + "smithy.api#required": {} + } + }, + "trainingContainerConfig": { + "target": "com.amazonaws.cleanroomsml#ContainerConfig", + "traits": { + "smithy.api#documentation": "The configuration information of the training container for the configured model algorithm.
" + } + }, + "inferenceContainerConfig": { + "target": "com.amazonaws.cleanroomsml#InferenceContainerConfig", + "traits": { + "smithy.api#documentation": "Configuration information for the inference container.
" + } + }, + "roleArn": { + "target": "com.amazonaws.cleanroomsml#IamRoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service role that was used to create the configured model algorithm.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.cleanroomsml#ResourceDescription", + "traits": { + "smithy.api#documentation": "The description of the configured model algorithm.
" + } + }, + "tags": { + "target": "com.amazonaws.cleanroomsml#TagMap", + "traits": { + "smithy.api#documentation": "The optional metadata that you applied to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50.
\nFor each resource, each tag key must be unique, and each tag key can have only one value.
\nMaximum key length - 128 Unicode characters in UTF-8.
\nMaximum value length - 256 Unicode characters in UTF-8.
\nIf your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms ML considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.
\nThe Amazon Resource Name (ARN) of the KMS key. This key is used to encrypt and decrypt customer-owned data in the configured ML model and associated data.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cleanroomsml#GetMLConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanroomsml#GetMLConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.cleanroomsml#GetMLConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cleanroomsml#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanroomsml#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanroomsml#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns information about a specific ML configuration.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/memberships/{membershipIdentifier}/ml-configurations" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.cleanroomsml#GetMLConfigurationRequest": { + "type": "structure", + "members": { + "membershipIdentifier": { + "target": "com.amazonaws.cleanroomsml#UUID", + "traits": { + "smithy.api#documentation": "The membership ID of the member that owns the ML configuration you want to return information about.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanroomsml#GetMLConfigurationResponse": { + "type": "structure", + "members": { + "membershipIdentifier": { + "target": "com.amazonaws.cleanroomsml#UUID", + "traits": { + "smithy.api#documentation": "The membership ID of the member that owns the ML configuration you requested.
", + "smithy.api#required": {} + } + }, + "defaultOutputLocation": { + "target": "com.amazonaws.cleanroomsml#MLOutputConfiguration", + "traits": { + "smithy.api#documentation": "The Amazon S3 location where ML model output is stored.
", + "smithy.api#required": {} + } + }, + "createTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the ML configuration was created.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "updateTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The most recent time at which the ML configuration was updated.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cleanroomsml#GetMLInputChannel": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanroomsml#GetMLInputChannelRequest" + }, + "output": { + "target": "com.amazonaws.cleanroomsml#GetMLInputChannelResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cleanroomsml#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanroomsml#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanroomsml#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns information about an ML input channel.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/memberships/{membershipIdentifier}/ml-input-channels/{mlInputChannelArn}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.cleanroomsml#GetMLInputChannelRequest": { + "type": "structure", + "members": { + "mlInputChannelArn": { + "target": "com.amazonaws.cleanroomsml#MLInputChannelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the ML input channel that you want to get.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "membershipIdentifier": { + "target": "com.amazonaws.cleanroomsml#UUID", + "traits": { + "smithy.api#documentation": "The membership ID of the membership that contains the ML input channel that you want to get.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanroomsml#GetMLInputChannelResponse": { + "type": "structure", + "members": { + "createTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the ML input channel was created.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "updateTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The most recent time at which the ML input channel was updated.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "membershipIdentifier": { + "target": "com.amazonaws.cleanroomsml#UUID", + "traits": { + "smithy.api#documentation": "The membership ID of the membership that contains the ML input channel.
", + "smithy.api#required": {} + } + }, + "collaborationIdentifier": { + "target": "com.amazonaws.cleanroomsml#UUID", + "traits": { + "smithy.api#documentation": "The collaboration ID of the collaboration that contains the ML input channel.
", + "smithy.api#required": {} + } + }, + "inputChannel": { + "target": "com.amazonaws.cleanroomsml#InputChannel", + "traits": { + "smithy.api#documentation": "The input channel that was used to create the ML input channel.
", + "smithy.api#required": {} + } + }, + "protectedQueryIdentifier": { + "target": "com.amazonaws.cleanroomsml#UUID", + "traits": { + "smithy.api#documentation": "The ID of the protected query that was used to create the ML input channel.
" + } + }, + "mlInputChannelArn": { + "target": "com.amazonaws.cleanroomsml#MLInputChannelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the ML input channel.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.cleanroomsml#NameString", + "traits": { + "smithy.api#documentation": "The name of the ML input channel.
", + "smithy.api#required": {} + } + }, + "configuredModelAlgorithmAssociations": { + "target": "com.amazonaws.cleanroomsml#ConfiguredModelAlgorithmAssociationArnList", + "traits": { + "smithy.api#documentation": "The configured model algorithm associations that were used to create the ML input channel.
", + "smithy.api#length": { + "min": 1, + "max": 1 + }, + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.cleanroomsml#MLInputChannelStatus", + "traits": { + "smithy.api#documentation": "The status of the ML input channel.
", + "smithy.api#required": {} + } + }, + "statusDetails": { + "target": "com.amazonaws.cleanroomsml#StatusDetails" + }, + "retentionInDays": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The number of days to keep the data in the ML input channel.
", + "smithy.api#range": { + "min": 1, + "max": 30 + }, + "smithy.api#required": {} + } + }, + "numberOfRecords": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "The number of records in the ML input channel.
", + "smithy.api#range": { + "min": 0, + "max": 100000000000 + } + } + }, + "numberOfFiles": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "The number of files in the ML input channel.
", + "smithy.api#range": { + "min": 0, + "max": 1000000 + } + } + }, + "sizeInGb": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "The size, in GB, of the ML input channel.
", + "smithy.api#range": { + "min": 0, + "max": 1000000 + } + } + }, + "description": { + "target": "com.amazonaws.cleanroomsml#ResourceDescription", + "traits": { + "smithy.api#documentation": "The description of the ML input channel.
" + } + }, + "kmsKeyArn": { + "target": "com.amazonaws.cleanroomsml#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key that was used to create the ML input channel.
" + } + }, + "tags": { + "target": "com.amazonaws.cleanroomsml#TagMap", + "traits": { + "smithy.api#documentation": "The optional metadata that you applied to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50.
\nFor each resource, each tag key must be unique, and each tag key can have only one value.
\nMaximum key length - 128 Unicode characters in UTF-8.
\nMaximum value length - 256 Unicode characters in UTF-8.
\nIf your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms ML considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.
\nReturns information about a trained model.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/memberships/{membershipIdentifier}/trained-models/{trainedModelArn}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.cleanroomsml#GetTrainedModelInferenceJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanroomsml#GetTrainedModelInferenceJobRequest" + }, + "output": { + "target": "com.amazonaws.cleanroomsml#GetTrainedModelInferenceJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cleanroomsml#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanroomsml#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanroomsml#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns information about a trained model inference job.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/memberships/{membershipIdentifier}/trained-model-inference-jobs/{trainedModelInferenceJobArn}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.cleanroomsml#GetTrainedModelInferenceJobRequest": { + "type": "structure", + "members": { + "membershipIdentifier": { + "target": "com.amazonaws.cleanroomsml#UUID", + "traits": { + "smithy.api#documentation": "Provides the membership ID of the membership that contains the trained model inference job that you are interested in.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "trainedModelInferenceJobArn": { + "target": "com.amazonaws.cleanroomsml#TrainedModelInferenceJobArn", + "traits": { + "smithy.api#documentation": "Provides the Amazon Resource Name (ARN) of the trained model inference job that you are interested in.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanroomsml#GetTrainedModelInferenceJobResponse": { + "type": "structure", + "members": { + "createTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the trained model inference job was created.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "updateTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The most recent time at which the trained model inference job was updated.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "trainedModelInferenceJobArn": { + "target": "com.amazonaws.cleanroomsml#TrainedModelInferenceJobArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the trained model inference job.
", + "smithy.api#required": {} + } + }, + "configuredModelAlgorithmAssociationArn": { + "target": "com.amazonaws.cleanroomsml#ConfiguredModelAlgorithmAssociationArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the configured model algorithm association that was used for the trained model inference job.
" + } + }, + "name": { + "target": "com.amazonaws.cleanroomsml#NameString", + "traits": { + "smithy.api#documentation": "The name of the trained model inference job.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.cleanroomsml#TrainedModelInferenceJobStatus", + "traits": { + "smithy.api#documentation": "The status of the trained model inference job.
", + "smithy.api#required": {} + } + }, + "trainedModelArn": { + "target": "com.amazonaws.cleanroomsml#TrainedModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the trained model that was used for the trained model inference job.
", + "smithy.api#required": {} + } + }, + "resourceConfig": { + "target": "com.amazonaws.cleanroomsml#InferenceResourceConfig", + "traits": { + "smithy.api#documentation": "The resource configuration information for the trained model inference job.
", + "smithy.api#required": {} + } + }, + "outputConfiguration": { + "target": "com.amazonaws.cleanroomsml#InferenceOutputConfiguration", + "traits": { + "smithy.api#documentation": "The output configuration information for the trained model inference job.
", + "smithy.api#required": {} + } + }, + "membershipIdentifier": { + "target": "com.amazonaws.cleanroomsml#UUID", + "traits": { + "smithy.api#documentation": "The membership ID of the membership that contains the trained model inference job.
", + "smithy.api#required": {} + } + }, + "dataSource": { + "target": "com.amazonaws.cleanroomsml#ModelInferenceDataSource", + "traits": { + "smithy.api#documentation": "The data source that was used for the trained model inference job.
", + "smithy.api#required": {} + } + }, + "containerExecutionParameters": { + "target": "com.amazonaws.cleanroomsml#InferenceContainerExecutionParameters", + "traits": { + "smithy.api#documentation": "The execution parameters for the model inference job container.
" + } + }, + "statusDetails": { + "target": "com.amazonaws.cleanroomsml#StatusDetails" + }, + "description": { + "target": "com.amazonaws.cleanroomsml#ResourceDescription", + "traits": { + "smithy.api#documentation": "The description of the trained model inference job.
" + } + }, + "inferenceContainerImageDigest": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Information about the training container image.
" + } + }, + "environment": { + "target": "com.amazonaws.cleanroomsml#InferenceEnvironmentMap", + "traits": { + "smithy.api#documentation": "The environment variables to set in the Docker container.
" + } + }, + "kmsKeyArn": { + "target": "com.amazonaws.cleanroomsml#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key. This key is used to encrypt and decrypt customer-owned data in the ML inference job and associated data.
" + } + }, + "metricsStatus": { + "target": "com.amazonaws.cleanroomsml#MetricsStatus", + "traits": { + "smithy.api#documentation": "The metrics status for the trained model inference job.
" + } + }, + "metricsStatusDetails": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Details about the metrics status for the trained model inference job.
" + } + }, + "logsStatus": { + "target": "com.amazonaws.cleanroomsml#LogsStatus", + "traits": { + "smithy.api#documentation": "The logs status for the trained model inference job.
" + } + }, + "logsStatusDetails": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Details about the logs status for the trained model inference job.
" + } + }, + "tags": { + "target": "com.amazonaws.cleanroomsml#TagMap", + "traits": { + "smithy.api#documentation": "The optional metadata that you applied to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50.
\nFor each resource, each tag key must be unique, and each tag key can have only one value.
\nMaximum key length - 128 Unicode characters in UTF-8.
\nMaximum value length - 256 Unicode characters in UTF-8.
\nIf your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms ML considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.
\nThe Amazon Resource Name (ARN) of the trained model that you are interested in.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "membershipIdentifier": { + "target": "com.amazonaws.cleanroomsml#UUID", + "traits": { + "smithy.api#documentation": "The membership ID of the member that created the trained model that you are interested in.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanroomsml#GetTrainedModelResponse": { + "type": "structure", + "members": { + "membershipIdentifier": { + "target": "com.amazonaws.cleanroomsml#UUID", + "traits": { + "smithy.api#documentation": "The membership ID of the member that created the trained model.
", + "smithy.api#required": {} + } + }, + "collaborationIdentifier": { + "target": "com.amazonaws.cleanroomsml#UUID", + "traits": { + "smithy.api#documentation": "The collaboration ID of the collaboration that contains the trained model.
", + "smithy.api#required": {} + } + }, + "trainedModelArn": { + "target": "com.amazonaws.cleanroomsml#TrainedModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the trained model.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.cleanroomsml#NameString", + "traits": { + "smithy.api#documentation": "The name of the trained model.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.cleanroomsml#ResourceDescription", + "traits": { + "smithy.api#documentation": "The description of the trained model.
" + } + }, + "status": { + "target": "com.amazonaws.cleanroomsml#TrainedModelStatus", + "traits": { + "smithy.api#documentation": "The status of the trained model.
", + "smithy.api#required": {} + } + }, + "statusDetails": { + "target": "com.amazonaws.cleanroomsml#StatusDetails" + }, + "configuredModelAlgorithmAssociationArn": { + "target": "com.amazonaws.cleanroomsml#ConfiguredModelAlgorithmAssociationArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the configured model algorithm association that was used to create the trained model.
", + "smithy.api#required": {} + } + }, + "resourceConfig": { + "target": "com.amazonaws.cleanroomsml#ResourceConfig", + "traits": { + "smithy.api#documentation": "The EC2 resource configuration that was used to create the trained model.
" + } + }, + "stoppingCondition": { + "target": "com.amazonaws.cleanroomsml#StoppingCondition", + "traits": { + "smithy.api#documentation": "The stopping condition that was used to terminate model training.
" + } + }, + "metricsStatus": { + "target": "com.amazonaws.cleanroomsml#MetricsStatus", + "traits": { + "smithy.api#documentation": "The status of the model metrics.
" + } + }, + "metricsStatusDetails": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Details about the metrics status for the trained model.
" + } + }, + "logsStatus": { + "target": "com.amazonaws.cleanroomsml#LogsStatus", + "traits": { + "smithy.api#documentation": "The logs status for the trained model.
" + } + }, + "logsStatusDetails": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Details about the logs status for the trained model.
" + } + }, + "trainingContainerImageDigest": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Information about the training image container.
" + } + }, + "createTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the trained model was created.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "updateTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The most recent time at which the trained model was updated.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "hyperparameters": { + "target": "com.amazonaws.cleanroomsml#HyperParameters", + "traits": { + "smithy.api#documentation": "The hyperparameters that were used to create the trained model.
" + } + }, + "environment": { + "target": "com.amazonaws.cleanroomsml#Environment", + "traits": { + "smithy.api#documentation": "The EC2 environment that was used to create the trained model.
" + } + }, + "kmsKeyArn": { + "target": "com.amazonaws.cleanroomsml#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key. This key is used to encrypt and decrypt customer-owned data in the trained ML model and associated data.
" + } + }, + "tags": { + "target": "com.amazonaws.cleanroomsml#TagMap", + "traits": { + "smithy.api#documentation": "The optional metadata that you applied to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50.
\nFor each resource, each tag key must be unique, and each tag key can have only one value.
\nMaximum key length - 128 Unicode characters in UTF-8.
\nMaximum value length - 256 Unicode characters in UTF-8.
\nIf your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms ML considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.
\nThe data channels that were used for the trained model.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cleanroomsml#GetTrainingDataset": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanroomsml#GetTrainingDatasetRequest" + }, + "output": { + "target": "com.amazonaws.cleanroomsml#GetTrainingDatasetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cleanroomsml#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanroomsml#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanroomsml#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns information about a training dataset.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/training-dataset/{trainingDatasetArn}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.cleanroomsml#GetTrainingDatasetRequest": { + "type": "structure", + "members": { + "trainingDatasetArn": { + "target": "com.amazonaws.cleanroomsml#TrainingDatasetArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the training dataset that you are interested in.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanroomsml#GetTrainingDatasetResponse": { + "type": "structure", + "members": { + "createTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the training dataset was created.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "updateTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The most recent time at which the training dataset was updated.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "trainingDatasetArn": { + "target": "com.amazonaws.cleanroomsml#TrainingDatasetArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the training dataset.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.cleanroomsml#NameString", + "traits": { + "smithy.api#documentation": "The name of the training dataset.
", + "smithy.api#required": {} + } + }, + "trainingData": { + "target": "com.amazonaws.cleanroomsml#DatasetList", + "traits": { + "smithy.api#documentation": "Metadata about the requested training data.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.cleanroomsml#TrainingDatasetStatus", + "traits": { + "smithy.api#documentation": "The status of the training dataset.
", + "smithy.api#required": {} + } + }, + "roleArn": { + "target": "com.amazonaws.cleanroomsml#IamRoleArn", + "traits": { + "smithy.api#documentation": "The IAM role used to read the training data.
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.cleanroomsml#TagMap", + "traits": { + "smithy.api#documentation": "The tags that are assigned to this training dataset.
" + } + }, + "description": { + "target": "com.amazonaws.cleanroomsml#ResourceDescription", + "traits": { + "smithy.api#documentation": "The description of the training dataset.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cleanroomsml#GlueDataSource": { + "type": "structure", + "members": { + "tableName": { + "target": "com.amazonaws.cleanroomsml#GlueTableName", + "traits": { + "smithy.api#documentation": "The Glue table that contains the training data.
", + "smithy.api#required": {} + } + }, + "databaseName": { + "target": "com.amazonaws.cleanroomsml#GlueDatabaseName", + "traits": { + "smithy.api#documentation": "The Glue database that contains the training data.
", + "smithy.api#required": {} + } + }, + "catalogId": { + "target": "com.amazonaws.cleanroomsml#AccountId", + "traits": { + "smithy.api#documentation": "The Glue catalog that contains the training data.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Defines the Glue data source that contains the training data.
" + } + }, + "com.amazonaws.cleanroomsml#GlueDatabaseName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_](([a-zA-Z0-9_]+-)*([a-zA-Z0-9_]+))?$" + } + }, + "com.amazonaws.cleanroomsml#GlueTableName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?$" + } + }, + "com.amazonaws.cleanroomsml#Hash": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 64, + "max": 128 + }, + "smithy.api#pattern": "^[0-9a-f]+$" + } + }, + "com.amazonaws.cleanroomsml#HyperParameters": { + "type": "map", + "key": { + "target": "smithy.api#String", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^.*$" + } + }, + "value": { + "target": "smithy.api#String", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2500 + }, + "smithy.api#pattern": "^.*$" + } + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.cleanroomsml#IamRoleArn": { + "type": "string", + "traits": { + "aws.api#arnReference": { + "type": "AWS::IAM::Role" + }, + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws[-a-z]*:iam::[0-9]{12}:role/.+$" + } + }, + "com.amazonaws.cleanroomsml#InferenceContainerConfig": { + "type": "structure", + "members": { + "imageUri": { + "target": "com.amazonaws.cleanroomsml#AlgorithmImage", + "traits": { + "smithy.api#documentation": "The registry path of the docker image that contains the inference algorithm. Clean Rooms ML supports both registry/repository[:tag] and registry/repositry[@digest] image path formats. For more information about using images in Clean Rooms ML, see the Sagemaker API reference.
Provides configuration information for the inference container.
" + } + }, + "com.amazonaws.cleanroomsml#InferenceContainerExecutionParameters": { + "type": "structure", + "members": { + "maxPayloadInMB": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The maximum size of the inference container payload, specified in MB.
", + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + } + }, + "traits": { + "smithy.api#documentation": "Provides execution parameters for the inference container.
" + } + }, + "com.amazonaws.cleanroomsml#InferenceEnvironmentMap": { + "type": "map", + "key": { + "target": "smithy.api#String", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$" + } + }, + "value": { + "target": "smithy.api#String", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10240 + }, + "smithy.api#pattern": "^[\\S\\s]*$" + } + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 16 + } + } + }, + "com.amazonaws.cleanroomsml#InferenceInstanceType": { + "type": "enum", + "members": { + "ML_R7I_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.48xlarge" + } + }, + "ML_R6I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.16xlarge" + } + }, + "ML_M6I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.xlarge" + } + }, + "ML_M5_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.4xlarge" + } + }, + "ML_P2_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p2.xlarge" + } + }, + "ML_M4_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m4.16xlarge" + } + }, + "ML_R7I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.16xlarge" + } + }, + "ML_M7I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.xlarge" + } + }, + "ML_M6I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.12xlarge" + } + }, + "ML_R7I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.8xlarge" + } + }, + "ML_R7I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.large" + } + }, + "ML_M7I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.12xlarge" + } + }, + "ML_M6I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.24xlarge" + } + }, + "ML_M7I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.24xlarge" + } + }, + "ML_R6I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.8xlarge" + } + }, + "ML_R6I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.large" + } + }, + "ML_G5_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.2xlarge" + } + }, + "ML_M5_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.large" + } + }, + "ML_P3_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p3.16xlarge" + } + }, + "ML_M7I_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.48xlarge" + } + }, + "ML_M6I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.16xlarge" + } + }, + "ML_P2_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p2.16xlarge" + } + }, + "ML_G5_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.4xlarge" + } + }, + "ML_M7I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.16xlarge" + } + }, + "ML_C4_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c4.2xlarge" + } + }, + "ML_C5_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.2xlarge" + } + }, + "ML_C6I_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.32xlarge" + } + }, + "ML_C4_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c4.4xlarge" + } + }, + "ML_G5_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.8xlarge" + } + }, + "ML_C6I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.xlarge" + } + }, + "ML_C5_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.4xlarge" + } + }, + "ML_G4DN_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.xlarge" + } + }, + "ML_C7I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.xlarge" + } + }, + "ML_C6I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.12xlarge" + } + }, + "ML_G4DN_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.12xlarge" + } + }, + "ML_C7I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.12xlarge" + } + }, + "ML_C6I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.24xlarge" + } + }, + "ML_G4DN_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.2xlarge" + } + }, + "ML_C7I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.24xlarge" + } + }, + "ML_C7I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.2xlarge" + } + }, + "ML_C4_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c4.8xlarge" + } + }, + "ML_C6I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.2xlarge" + } + }, + "ML_G4DN_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.4xlarge" + } + }, + "ML_C7I_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.48xlarge" + } + }, + "ML_C7I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.4xlarge" + } + }, + "ML_C6I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.16xlarge" + } + }, + "ML_C5_9XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.9xlarge" + } + }, + "ML_G4DN_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.16xlarge" + } + }, + "ML_C7I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.16xlarge" + } + }, + "ML_C6I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.4xlarge" + } + }, + "ML_C5_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.xlarge" + } + }, + "ML_C4_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c4.xlarge" + } + }, + "ML_G4DN_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.8xlarge" + } + }, + "ML_C7I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.8xlarge" + } + }, + "ML_C7I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c7i.large" + } + }, + "ML_G5_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.xlarge" + } + }, + "ML_C6I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.8xlarge" + } + }, + "ML_C6I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.large" + } + }, + "ML_G5_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.12xlarge" + } + }, + "ML_G5_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.24xlarge" + } + }, + "ML_M7I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.2xlarge" + } + }, + "ML_C5_18XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.18xlarge" + } + }, + "ML_G5_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.48xlarge" + } + }, + "ML_M6I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.2xlarge" + } + }, + "ML_G5_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.16xlarge" + } + }, + "ML_M7I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.4xlarge" + } + }, + "ML_P3_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p3.2xlarge" + } + }, + "ML_R6I_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.32xlarge" + } + }, + "ML_M6I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.4xlarge" + } + }, + "ML_M5_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.xlarge" + } + }, + "ML_M4_10XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m4.10xlarge" + } + }, + "ML_R6I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.xlarge" + } + }, + "ML_M5_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.12xlarge" + } + }, + "ML_M4_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m4.xlarge" + } + }, + "ML_R7I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.2xlarge" + } + }, + "ML_R7I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.xlarge" + } + }, + "ML_R6I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.12xlarge" + } + }, + "ML_M5_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.24xlarge" + } + }, + "ML_R7I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.12xlarge" + } + }, + "ML_M7I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.8xlarge" + } + }, + "ML_M7I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m7i.large" + } + }, + "ML_R6I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.24xlarge" + } + }, + "ML_R6I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.2xlarge" + } + }, + "ML_M4_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m4.2xlarge" + } + }, + "ML_R7I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.24xlarge" + } + }, + "ML_R7I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r7i.4xlarge" + } + }, + "ML_M6I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.8xlarge" + } + }, + "ML_M6I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.large" + } + }, + "ML_M5_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.2xlarge" + } + }, + "ML_P2_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p2.8xlarge" + } + }, + "ML_R6I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r6i.4xlarge" + } + }, + "ML_M6I_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.32xlarge" + } + }, + "ML_P3_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p3.8xlarge" + } + }, + "ML_M4_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m4.4xlarge" + } + } + } + }, + "com.amazonaws.cleanroomsml#InferenceOutputConfiguration": { + "type": "structure", + "members": { + "accept": { + "target": "smithy.api#String", + "traits": { + "smithy.api#default": "application/json", + "smithy.api#documentation": "The MIME type used to specify the output data.
", + "smithy.api#length": { + "max": 256 + }, + "smithy.api#pattern": "^.*$" + } + }, + "members": { + "target": "com.amazonaws.cleanroomsml#InferenceReceiverMembers", + "traits": { + "smithy.api#documentation": "Defines the members that can receive inference output.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration information about how the inference output is stored.
" + } + }, + "com.amazonaws.cleanroomsml#InferenceReceiverMember": { + "type": "structure", + "members": { + "accountId": { + "target": "com.amazonaws.cleanroomsml#AccountId", + "traits": { + "smithy.api#documentation": "The account ID of the member that can receive inference results.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Defines who will receive inference results.
" + } + }, + "com.amazonaws.cleanroomsml#InferenceReceiverMembers": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanroomsml#InferenceReceiverMember" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.cleanroomsml#InferenceResourceConfig": { + "type": "structure", + "members": { + "instanceType": { + "target": "com.amazonaws.cleanroomsml#InferenceInstanceType", + "traits": { + "smithy.api#documentation": "The type of instance that is used to perform model inference.
", + "smithy.api#required": {} + } + }, + "instanceCount": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#default": 1, + "smithy.api#documentation": "The number of instances to use.
", + "smithy.api#range": { + "min": 1, + "max": 10 + } + } + } + }, + "traits": { + "smithy.api#documentation": "Defines the resources used to perform model inference.
" + } + }, + "com.amazonaws.cleanroomsml#InputChannel": { + "type": "structure", + "members": { + "dataSource": { + "target": "com.amazonaws.cleanroomsml#InputChannelDataSource", + "traits": { + "smithy.api#documentation": "The data source that is used to create the ML input channel.
", + "smithy.api#required": {} + } + }, + "roleArn": { + "target": "com.amazonaws.cleanroomsml#IamRoleArn", + "traits": { + "smithy.api#documentation": "The ARN of the IAM role that Clean Rooms ML can assume to read the data referred to in the dataSource field the input channel.
Passing a role across AWS accounts is not allowed. If you pass a role that isn't in your account, you get an AccessDeniedException error.
Provides information about the data source that is used to create an ML input channel.
" + } + }, + "com.amazonaws.cleanroomsml#InputChannelDataSource": { + "type": "union", + "members": { + "protectedQueryInputParameters": { + "target": "com.amazonaws.cleanroomsml#ProtectedQueryInputParameters" + } + }, + "traits": { + "smithy.api#documentation": "Provides the data source that is used to define an input channel.
" + } + }, + "com.amazonaws.cleanroomsml#InstanceType": { + "type": "enum", + "members": { + "ML_M4_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m4.xlarge" + } + }, + "ML_M4_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m4.2xlarge" + } + }, + "ML_M4_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m4.4xlarge" + } + }, + "ML_M4_10XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m4.10xlarge" + } + }, + "ML_M4_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m4.16xlarge" + } + }, + "ML_G4DN_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.xlarge" + } + }, + "ML_G4DN_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.2xlarge" + } + }, + "ML_G4DN_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.4xlarge" + } + }, + "ML_G4DN_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.8xlarge" + } + }, + "ML_G4DN_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.12xlarge" + } + }, + "ML_G4DN_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g4dn.16xlarge" + } + }, + "ML_M5_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.large" + } + }, + "ML_M5_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.xlarge" + } + }, + "ML_M5_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.2xlarge" + } + }, + "ML_M5_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.4xlarge" + } + }, + "ML_M5_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.12xlarge" + } + }, + "ML_M5_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m5.24xlarge" + } + }, + "ML_C4_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c4.xlarge" + } + }, + "ML_C4_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c4.2xlarge" + } + }, + "ML_C4_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c4.4xlarge" + } + }, + "ML_C4_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c4.8xlarge" + } + }, + "ML_P2_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p2.xlarge" + } + }, + "ML_P2_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p2.8xlarge" + } + }, + "ML_P2_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p2.16xlarge" + } + }, + "ML_P3_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p3.2xlarge" + } + }, + "ML_P3_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p3.8xlarge" + } + }, + "ML_P3_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p3.16xlarge" + } + }, + "ML_P3DN_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p3dn.24xlarge" + } + }, + "ML_P4D_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p4d.24xlarge" + } + }, + "ML_P4DE_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p4de.24xlarge" + } + }, + "ML_P5_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p5.48xlarge" + } + }, + "ML_C5_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.xlarge" + } + }, + "ML_C5_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.2xlarge" + } + }, + "ML_C5_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.4xlarge" + } + }, + "ML_C5_9XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.9xlarge" + } + }, + "ML_C5_18XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5.18xlarge" + } + }, + "ML_C5N_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5n.xlarge" + } + }, + "ML_C5N_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5n.2xlarge" + } + }, + "ML_C5N_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5n.4xlarge" + } + }, + "ML_C5N_9XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5n.9xlarge" + } + }, + "ML_C5N_18XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c5n.18xlarge" + } + }, + "ML_G5_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.xlarge" + } + }, + "ML_G5_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.2xlarge" + } + }, + "ML_G5_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.4xlarge" + } + }, + "ML_G5_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.8xlarge" + } + }, + "ML_G5_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.16xlarge" + } + }, + "ML_G5_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.12xlarge" + } + }, + "ML_G5_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.24xlarge" + } + }, + "ML_G5_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.48xlarge" + } + }, + "ML_TRN1_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.trn1.2xlarge" + } + }, + "ML_TRN1_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.trn1.32xlarge" + } + }, + "ML_TRN1N_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.trn1n.32xlarge" + } + }, + "ML_M6I_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.large" + } + }, + "ML_M6I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.xlarge" + } + }, + "ML_M6I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.2xlarge" + } + }, + "ML_M6I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.4xlarge" + } + }, + "ML_M6I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.8xlarge" + } + }, + "ML_M6I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.12xlarge" + } + }, + "ML_M6I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.16xlarge" + } + }, + "ML_M6I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.24xlarge" + } + }, + "ML_M6I_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.m6i.32xlarge" + } + }, + "ML_C6I_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.xlarge" + } + }, + "ML_C6I_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.2xlarge" + } + }, + "ML_C6I_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.8xlarge" + } + }, + "ML_C6I_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.4xlarge" + } + }, + "ML_C6I_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.12xlarge" + } + }, + "ML_C6I_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.16xlarge" + } + }, + "ML_C6I_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.24xlarge" + } + }, + "ML_C6I_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.c6i.32xlarge" + } + }, + "ML_R5D_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5d.large" + } + }, + "ML_R5D_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5d.xlarge" + } + }, + "ML_R5D_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5d.2xlarge" + } + }, + "ML_R5D_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5d.4xlarge" + } + }, + "ML_R5D_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5d.8xlarge" + } + }, + "ML_R5D_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5d.12xlarge" + } + }, + "ML_R5D_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5d.16xlarge" + } + }, + "ML_R5D_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5d.24xlarge" + } + }, + "ML_T3_MEDIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t3.medium" + } + }, + "ML_T3_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t3.large" + } + }, + "ML_T3_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t3.xlarge" + } + }, + "ML_T3_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.t3.2xlarge" + } + }, + "ML_R5_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.large" + } + }, + "ML_R5_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.xlarge" + } + }, + "ML_R5_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.2xlarge" + } + }, + "ML_R5_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.4xlarge" + } + }, + "ML_R5_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.8xlarge" + } + }, + "ML_R5_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.12xlarge" + } + }, + "ML_R5_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.16xlarge" + } + }, + "ML_R5_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.r5.24xlarge" + } + } + } + }, + "com.amazonaws.cleanroomsml#KmsKeyArn": { + "type": "string", + "traits": { + "aws.api#arnReference": { + "type": "AWS::KMS::Key" + }, + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws[-a-z]*:kms:[-a-z0-9]+:[0-9]{12}:key/.+$" + } + }, + "com.amazonaws.cleanroomsml#ListAudienceExportJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanroomsml#ListAudienceExportJobsRequest" + }, + "output": { + "target": "com.amazonaws.cleanroomsml#ListAudienceExportJobsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cleanroomsml#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanroomsml#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of the audience export jobs.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/audience-export-job" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "audienceExportJobs" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.cleanroomsml#ListAudienceExportJobsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.cleanroomsml#NextToken", + "traits": { + "smithy.api#documentation": "The token value retrieved from a previous call to access the next page of results.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.cleanroomsml#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum size of the results that is returned per call.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "audienceGenerationJobArn": { + "target": "com.amazonaws.cleanroomsml#AudienceGenerationJobArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the audience generation job that you are interested in.
", + "smithy.api#httpQuery": "audienceGenerationJobArn" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanroomsml#ListAudienceExportJobsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.cleanroomsml#NextToken", + "traits": { + "smithy.api#documentation": "The token value used to access the next page of results.
" + } + }, + "audienceExportJobs": { + "target": "com.amazonaws.cleanroomsml#AudienceExportJobList", + "traits": { + "smithy.api#documentation": "The audience export jobs that match the request.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cleanroomsml#ListAudienceGenerationJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanroomsml#ListAudienceGenerationJobsRequest" + }, + "output": { + "target": "com.amazonaws.cleanroomsml#ListAudienceGenerationJobsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cleanroomsml#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanroomsml#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of audience generation jobs.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/audience-generation-job" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "audienceGenerationJobs" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.cleanroomsml#ListAudienceGenerationJobsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.cleanroomsml#NextToken", + "traits": { + "smithy.api#documentation": "The token value retrieved from a previous call to access the next page of results.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.cleanroomsml#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum size of the results that is returned per call.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "configuredAudienceModelArn": { + "target": "com.amazonaws.cleanroomsml#ConfiguredAudienceModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the configured audience model that was used for the audience generation jobs that you are interested in.
", + "smithy.api#httpQuery": "configuredAudienceModelArn" + } + }, + "collaborationId": { + "target": "com.amazonaws.cleanroomsml#UUID", + "traits": { + "smithy.api#documentation": "The identifier of the collaboration that contains the audience generation jobs that you are interested in.
", + "smithy.api#httpQuery": "collaborationId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanroomsml#ListAudienceGenerationJobsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.cleanroomsml#NextToken", + "traits": { + "smithy.api#documentation": "The token value used to access the next page of results.
" + } + }, + "audienceGenerationJobs": { + "target": "com.amazonaws.cleanroomsml#AudienceGenerationJobList", + "traits": { + "smithy.api#documentation": "The audience generation jobs that match the request.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cleanroomsml#ListAudienceModels": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanroomsml#ListAudienceModelsRequest" + }, + "output": { + "target": "com.amazonaws.cleanroomsml#ListAudienceModelsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cleanroomsml#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanroomsml#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of audience models.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/audience-model" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "audienceModels" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.cleanroomsml#ListAudienceModelsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.cleanroomsml#NextToken", + "traits": { + "smithy.api#documentation": "The token value retrieved from a previous call to access the next page of results.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.cleanroomsml#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum size of the results that is returned per call.
", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanroomsml#ListAudienceModelsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.cleanroomsml#NextToken", + "traits": { + "smithy.api#documentation": "The token value used to access the next page of results.
" + } + }, + "audienceModels": { + "target": "com.amazonaws.cleanroomsml#AudienceModelList", + "traits": { + "smithy.api#documentation": "The audience models that match the request.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cleanroomsml#ListCollaborationConfiguredModelAlgorithmAssociations": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanroomsml#ListCollaborationConfiguredModelAlgorithmAssociationsRequest" + }, + "output": { + "target": "com.amazonaws.cleanroomsml#ListCollaborationConfiguredModelAlgorithmAssociationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cleanroomsml#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanroomsml#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of the configured model algorithm associations in a collaboration.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/collaborations/{collaborationIdentifier}/configured-model-algorithm-associations" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "collaborationConfiguredModelAlgorithmAssociations" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.cleanroomsml#ListCollaborationConfiguredModelAlgorithmAssociationsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.cleanroomsml#NextToken", + "traits": { + "smithy.api#documentation": "The token value retrieved from a previous call to access the next page of results.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.cleanroomsml#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum size of the results that is returned per call.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "collaborationIdentifier": { + "target": "com.amazonaws.cleanroomsml#UUID", + "traits": { + "smithy.api#documentation": "The collaboration ID of the collaboration that contains the configured model algorithm associations that you are interested in.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanroomsml#ListCollaborationConfiguredModelAlgorithmAssociationsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.cleanroomsml#NextToken", + "traits": { + "smithy.api#documentation": "The token value used to access the next page of results.
" + } + }, + "collaborationConfiguredModelAlgorithmAssociations": { + "target": "com.amazonaws.cleanroomsml#CollaborationConfiguredModelAlgorithmAssociationList", + "traits": { + "smithy.api#documentation": "The configured model algorithm associations that belong to this collaboration.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cleanroomsml#ListCollaborationMLInputChannels": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanroomsml#ListCollaborationMLInputChannelsRequest" + }, + "output": { + "target": "com.amazonaws.cleanroomsml#ListCollaborationMLInputChannelsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cleanroomsml#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanroomsml#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of the ML input channels in a collaboration.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/collaborations/{collaborationIdentifier}/ml-input-channels" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "collaborationMLInputChannelsList" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.cleanroomsml#ListCollaborationMLInputChannelsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.cleanroomsml#NextToken", + "traits": { + "smithy.api#documentation": "The token value retrieved from a previous call to access the next page of results.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.cleanroomsml#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "collaborationIdentifier": { + "target": "com.amazonaws.cleanroomsml#UUID", + "traits": { + "smithy.api#documentation": "The collaboration ID of the collaboration that contains the ML input channels that you want to list.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanroomsml#ListCollaborationMLInputChannelsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.cleanroomsml#NextToken", + "traits": { + "smithy.api#documentation": "The token value used to access the next page of results.
" + } + }, + "collaborationMLInputChannelsList": { + "target": "com.amazonaws.cleanroomsml#CollaborationMLInputChannelsList", + "traits": { + "smithy.api#documentation": "The list of ML input channels that you wanted.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cleanroomsml#ListCollaborationTrainedModelExportJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanroomsml#ListCollaborationTrainedModelExportJobsRequest" + }, + "output": { + "target": "com.amazonaws.cleanroomsml#ListCollaborationTrainedModelExportJobsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cleanroomsml#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanroomsml#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of the export jobs for a trained model in a collaboration.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/collaborations/{collaborationIdentifier}/trained-models/{trainedModelArn}/export-jobs" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "collaborationTrainedModelExportJobs" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.cleanroomsml#ListCollaborationTrainedModelExportJobsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.cleanroomsml#NextToken", + "traits": { + "smithy.api#documentation": "The token value retrieved from a previous call to access the next page of results.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.cleanroomsml#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum size of the results that is returned per call.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "collaborationIdentifier": { + "target": "com.amazonaws.cleanroomsml#UUID", + "traits": { + "smithy.api#documentation": "The collaboration ID of the collaboration that contains the trained model export jobs that you are interested in.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "trainedModelArn": { + "target": "com.amazonaws.cleanroomsml#TrainedModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the trained model that was used to create the export jobs that you are interested in.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanroomsml#ListCollaborationTrainedModelExportJobsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.cleanroomsml#NextToken", + "traits": { + "smithy.api#documentation": "The token value used to access the next page of results.
" + } + }, + "collaborationTrainedModelExportJobs": { + "target": "com.amazonaws.cleanroomsml#CollaborationTrainedModelExportJobList", + "traits": { + "smithy.api#documentation": "The exports jobs that exist for the requested trained model in the requested collaboration.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cleanroomsml#ListCollaborationTrainedModelInferenceJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanroomsml#ListCollaborationTrainedModelInferenceJobsRequest" + }, + "output": { + "target": "com.amazonaws.cleanroomsml#ListCollaborationTrainedModelInferenceJobsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cleanroomsml#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanroomsml#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of trained model inference jobs in a specified collaboration.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/collaborations/{collaborationIdentifier}/trained-model-inference-jobs" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "collaborationTrainedModelInferenceJobs" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.cleanroomsml#ListCollaborationTrainedModelInferenceJobsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.cleanroomsml#NextToken", + "traits": { + "smithy.api#documentation": "The token value retrieved from a previous call to access the next page of results.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.cleanroomsml#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum size of the results that is returned per call.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "collaborationIdentifier": { + "target": "com.amazonaws.cleanroomsml#UUID", + "traits": { + "smithy.api#documentation": "The collaboration ID of the collaboration that contains the trained model inference jobs that you are interested in.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "trainedModelArn": { + "target": "com.amazonaws.cleanroomsml#TrainedModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the trained model that was used to create the trained model inference jobs that you are interested in.
", + "smithy.api#httpQuery": "trainedModelArn" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanroomsml#ListCollaborationTrainedModelInferenceJobsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.cleanroomsml#NextToken", + "traits": { + "smithy.api#documentation": "The token value used to access the next page of results.
" + } + }, + "collaborationTrainedModelInferenceJobs": { + "target": "com.amazonaws.cleanroomsml#CollaborationTrainedModelInferenceJobList", + "traits": { + "smithy.api#documentation": "The trained model inference jobs that you are interested in.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cleanroomsml#ListCollaborationTrainedModels": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanroomsml#ListCollaborationTrainedModelsRequest" + }, + "output": { + "target": "com.amazonaws.cleanroomsml#ListCollaborationTrainedModelsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cleanroomsml#AccessDeniedException" + }, + { + "target": "com.amazonaws.cleanroomsml#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of the trained models in a collaboration.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/collaborations/{collaborationIdentifier}/trained-models" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "collaborationTrainedModels" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.cleanroomsml#ListCollaborationTrainedModelsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.cleanroomsml#NextToken", + "traits": { + "smithy.api#documentation": "The token value retrieved from a previous call to access the next page of results.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.cleanroomsml#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum size of the results that is returned per call.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "collaborationIdentifier": { + "target": "com.amazonaws.cleanroomsml#UUID", + "traits": { + "smithy.api#documentation": "The collaboration ID of the collaboration that contains the trained models you are interested in.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanroomsml#ListCollaborationTrainedModelsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.cleanroomsml#NextToken", + "traits": { + "smithy.api#documentation": "The token value used to access the next page of results.
" + } + }, + "collaborationTrainedModels": { + "target": "com.amazonaws.cleanroomsml#CollaborationTrainedModelList", + "traits": { + "smithy.api#documentation": "The trained models in the collaboration that you requested.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cleanroomsml#ListConfiguredAudienceModels": { "type": "operation", "input": { - "target": "com.amazonaws.cleanroomsml#DeleteAudienceModelRequest" + "target": "com.amazonaws.cleanroomsml#ListConfiguredAudienceModelsRequest" }, "output": { - "target": "smithy.api#Unit" + "target": "com.amazonaws.cleanroomsml#ListConfiguredAudienceModelsResponse" }, "errors": [ { "target": "com.amazonaws.cleanroomsml#AccessDeniedException" }, { - "target": "com.amazonaws.cleanroomsml#ConflictException" + "target": "com.amazonaws.cleanroomsml#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of the configured audience models.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/configured-audience-model" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "configuredAudienceModels" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.cleanroomsml#ListConfiguredAudienceModelsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.cleanroomsml#NextToken", + "traits": { + "smithy.api#documentation": "The token value retrieved from a previous call to access the next page of results.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.cleanroomsml#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum size of the results that is returned per call.
", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanroomsml#ListConfiguredAudienceModelsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.cleanroomsml#NextToken", + "traits": { + "smithy.api#documentation": "The token value used to access the next page of results.
" + } }, + "configuredAudienceModels": { + "target": "com.amazonaws.cleanroomsml#ConfiguredAudienceModelList", + "traits": { + "smithy.api#documentation": "The configured audience models.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cleanroomsml#ListConfiguredModelAlgorithmAssociations": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanroomsml#ListConfiguredModelAlgorithmAssociationsRequest" + }, + "output": { + "target": "com.amazonaws.cleanroomsml#ListConfiguredModelAlgorithmAssociationsResponse" + }, + "errors": [ { - "target": "com.amazonaws.cleanroomsml#ResourceNotFoundException" + "target": "com.amazonaws.cleanroomsml#AccessDeniedException" }, { "target": "com.amazonaws.cleanroomsml#ValidationException" } ], "traits": { - "smithy.api#documentation": "Specifies an audience model that you want to delete. You can't delete an audience model if there are any configured audience models that depend on the audience model.
", + "smithy.api#documentation": "Returns a list of configured model algorithm associations.
", "smithy.api#http": { "code": 200, - "uri": "/audience-model/{audienceModelArn}", - "method": "DELETE" + "method": "GET", + "uri": "/memberships/{membershipIdentifier}/configured-model-algorithm-associations" }, - "smithy.api#idempotent": {} + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "configuredModelAlgorithmAssociations" + }, + "smithy.api#readonly": {} } }, - "com.amazonaws.cleanroomsml#DeleteAudienceModelRequest": { + "com.amazonaws.cleanroomsml#ListConfiguredModelAlgorithmAssociationsRequest": { "type": "structure", "members": { - "audienceModelArn": { - "target": "com.amazonaws.cleanroomsml#AudienceModelArn", + "nextToken": { + "target": "com.amazonaws.cleanroomsml#NextToken", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the audience model that you want to delete.
", + "smithy.api#documentation": "The token value retrieved from a previous call to access the next page of results.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.cleanroomsml#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum size of the results that is returned per call.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "membershipIdentifier": { + "target": "com.amazonaws.cleanroomsml#UUID", + "traits": { + "smithy.api#documentation": "The membership ID of the member that created the configured model algorithm associations you are interested in.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2112,45 +8165,192 @@ "smithy.api#input": {} } }, - "com.amazonaws.cleanroomsml#DeleteConfiguredAudienceModel": { + "com.amazonaws.cleanroomsml#ListConfiguredModelAlgorithmAssociationsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.cleanroomsml#NextToken", + "traits": { + "smithy.api#documentation": "The token value used to access the next page of results.
" + } + }, + "configuredModelAlgorithmAssociations": { + "target": "com.amazonaws.cleanroomsml#ConfiguredModelAlgorithmAssociationList", + "traits": { + "smithy.api#documentation": "The list of configured model algorithm associations.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cleanroomsml#ListConfiguredModelAlgorithms": { "type": "operation", "input": { - "target": "com.amazonaws.cleanroomsml#DeleteConfiguredAudienceModelRequest" + "target": "com.amazonaws.cleanroomsml#ListConfiguredModelAlgorithmsRequest" }, "output": { - "target": "smithy.api#Unit" + "target": "com.amazonaws.cleanroomsml#ListConfiguredModelAlgorithmsResponse" }, "errors": [ { "target": "com.amazonaws.cleanroomsml#AccessDeniedException" }, { - "target": "com.amazonaws.cleanroomsml#ConflictException" + "target": "com.amazonaws.cleanroomsml#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of configured model algorithms.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/configured-model-algorithms" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "configuredModelAlgorithms" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.cleanroomsml#ListConfiguredModelAlgorithmsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.cleanroomsml#NextToken", + "traits": { + "smithy.api#documentation": "The token value retrieved from a previous call to access the next page of results.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.cleanroomsml#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum size of the results that is returned per call.
", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanroomsml#ListConfiguredModelAlgorithmsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.cleanroomsml#NextToken", + "traits": { + "smithy.api#documentation": "The token value used to access the next page of results.
" + } }, + "configuredModelAlgorithms": { + "target": "com.amazonaws.cleanroomsml#ConfiguredModelAlgorithmList", + "traits": { + "smithy.api#documentation": "The list of configured model algorithms.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cleanroomsml#ListMLInputChannels": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanroomsml#ListMLInputChannelsRequest" + }, + "output": { + "target": "com.amazonaws.cleanroomsml#ListMLInputChannelsResponse" + }, + "errors": [ { - "target": "com.amazonaws.cleanroomsml#ResourceNotFoundException" + "target": "com.amazonaws.cleanroomsml#AccessDeniedException" }, { "target": "com.amazonaws.cleanroomsml#ValidationException" } - ], + ], + "traits": { + "smithy.api#documentation": "Returns a list of ML input channels.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/memberships/{membershipIdentifier}/ml-input-channels" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "mlInputChannelsList" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.cleanroomsml#ListMLInputChannelsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.cleanroomsml#NextToken", + "traits": { + "smithy.api#documentation": "The token value retrieved from a previous call to access the next page of results.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.cleanroomsml#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of ML input channels to return.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "membershipIdentifier": { + "target": "com.amazonaws.cleanroomsml#UUID", + "traits": { + "smithy.api#documentation": "The membership ID of the membership that contains the ML input channels that you want to list.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, "traits": { - "smithy.api#documentation": "Deletes the specified configured audience model. You can't delete a configured audience model if there are any lookalike models that use the configured audience model. If you delete a configured audience model, it will be removed from any collaborations that it is associated to.
", - "smithy.api#http": { - "code": 200, - "uri": "/configured-audience-model/{configuredAudienceModelArn}", - "method": "DELETE" + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanroomsml#ListMLInputChannelsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.cleanroomsml#NextToken", + "traits": { + "smithy.api#documentation": "The token value used to access the next page of results.
" + } }, - "smithy.api#idempotent": {} + "mlInputChannelsList": { + "target": "com.amazonaws.cleanroomsml#MLInputChannelsList", + "traits": { + "smithy.api#documentation": "The list of ML input channels that you wanted.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.cleanroomsml#DeleteConfiguredAudienceModelPolicy": { + "com.amazonaws.cleanroomsml#ListTagsForResource": { "type": "operation", "input": { - "target": "com.amazonaws.cleanroomsml#DeleteConfiguredAudienceModelPolicyRequest" + "target": "com.amazonaws.cleanroomsml#ListTagsForResourceRequest" }, "output": { - "target": "smithy.api#Unit" + "target": "com.amazonaws.cleanroomsml#ListTagsForResourceResponse" }, "errors": [ { @@ -2164,22 +8364,21 @@ } ], "traits": { - "smithy.api#documentation": "Deletes the specified configured audience model policy.
", + "smithy.api#documentation": "Returns a list of tags for a provided resource.
", "smithy.api#http": { - "code": 200, - "method": "DELETE", - "uri": "/configured-audience-model/{configuredAudienceModelArn}/policy" + "method": "GET", + "uri": "/tags/{resourceArn}" }, - "smithy.api#idempotent": {} + "smithy.api#readonly": {} } }, - "com.amazonaws.cleanroomsml#DeleteConfiguredAudienceModelPolicyRequest": { + "com.amazonaws.cleanroomsml#ListTagsForResourceRequest": { "type": "structure", "members": { - "configuredAudienceModelArn": { - "target": "com.amazonaws.cleanroomsml#ConfiguredAudienceModelArn", + "resourceArn": { + "target": "com.amazonaws.cleanroomsml#TaggableArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the configured audience model policy that you want to delete.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource that you are interested in.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2189,105 +8388,164 @@ "smithy.api#input": {} } }, - "com.amazonaws.cleanroomsml#DeleteConfiguredAudienceModelRequest": { + "com.amazonaws.cleanroomsml#ListTagsForResourceResponse": { "type": "structure", "members": { - "configuredAudienceModelArn": { - "target": "com.amazonaws.cleanroomsml#ConfiguredAudienceModelArn", + "tags": { + "target": "com.amazonaws.cleanroomsml#TagMap", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the configured audience model that you want to delete.
", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "The tags that are associated with the resource.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#input": {} + "smithy.api#output": {} } }, - "com.amazonaws.cleanroomsml#DeleteTrainingDataset": { + "com.amazonaws.cleanroomsml#ListTrainedModelInferenceJobs": { "type": "operation", "input": { - "target": "com.amazonaws.cleanroomsml#DeleteTrainingDatasetRequest" + "target": "com.amazonaws.cleanroomsml#ListTrainedModelInferenceJobsRequest" }, "output": { - "target": "smithy.api#Unit" + "target": "com.amazonaws.cleanroomsml#ListTrainedModelInferenceJobsResponse" }, "errors": [ { "target": "com.amazonaws.cleanroomsml#AccessDeniedException" }, - { - "target": "com.amazonaws.cleanroomsml#ConflictException" - }, - { - "target": "com.amazonaws.cleanroomsml#ResourceNotFoundException" - }, { "target": "com.amazonaws.cleanroomsml#ValidationException" } ], "traits": { - "smithy.api#documentation": "Specifies a training dataset that you want to delete. You can't delete a training dataset if there are any audience models that depend on the training dataset. In Clean Rooms ML, the TrainingDataset is metadata that points to a Glue table, which is read only during AudienceModel creation. This action deletes the metadata.
Returns a list of trained model inference jobs that match the request parameters.
", "smithy.api#http": { - "uri": "/training-dataset/{trainingDatasetArn}", - "method": "DELETE" + "code": 200, + "method": "GET", + "uri": "/memberships/{membershipIdentifier}/trained-model-inference-jobs" }, - "smithy.api#idempotent": {} + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "trainedModelInferenceJobs" + }, + "smithy.api#readonly": {} } }, - "com.amazonaws.cleanroomsml#DeleteTrainingDatasetRequest": { + "com.amazonaws.cleanroomsml#ListTrainedModelInferenceJobsRequest": { "type": "structure", "members": { - "trainingDatasetArn": { - "target": "com.amazonaws.cleanroomsml#TrainingDatasetArn", + "nextToken": { + "target": "com.amazonaws.cleanroomsml#NextToken", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the training dataset that you want to delete.
", + "smithy.api#documentation": "The token value retrieved from a previous call to access the next page of results.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.cleanroomsml#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum size of the results that is returned per call.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "membershipIdentifier": { + "target": "com.amazonaws.cleanroomsml#UUID", + "traits": { + "smithy.api#documentation": "The membership
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "trainedModelArn": { + "target": "com.amazonaws.cleanroomsml#TrainedModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of a trained model that was used to create the trained model inference jobs that you are interested in.
", + "smithy.api#httpQuery": "trainedModelArn" + } } }, "traits": { "smithy.api#input": {} } }, - "com.amazonaws.cleanroomsml#GetAudienceGenerationJob": { + "com.amazonaws.cleanroomsml#ListTrainedModelInferenceJobsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.cleanroomsml#NextToken", + "traits": { + "smithy.api#documentation": "The token value used to access the next page of results.
" + } + }, + "trainedModelInferenceJobs": { + "target": "com.amazonaws.cleanroomsml#TrainedModelInferenceJobList", + "traits": { + "smithy.api#documentation": "Returns the requested trained model inference jobs.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cleanroomsml#ListTrainedModels": { "type": "operation", "input": { - "target": "com.amazonaws.cleanroomsml#GetAudienceGenerationJobRequest" + "target": "com.amazonaws.cleanroomsml#ListTrainedModelsRequest" }, "output": { - "target": "com.amazonaws.cleanroomsml#GetAudienceGenerationJobResponse" + "target": "com.amazonaws.cleanroomsml#ListTrainedModelsResponse" }, "errors": [ { "target": "com.amazonaws.cleanroomsml#AccessDeniedException" }, - { - "target": "com.amazonaws.cleanroomsml#ResourceNotFoundException" - }, { "target": "com.amazonaws.cleanroomsml#ValidationException" } ], "traits": { - "smithy.api#documentation": "Returns information about an audience generation job.
", + "smithy.api#documentation": "Returns a list of trained models.
", "smithy.api#http": { "code": 200, "method": "GET", - "uri": "/audience-generation-job/{audienceGenerationJobArn}" + "uri": "/memberships/{membershipIdentifier}/trained-models" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "trainedModels" }, "smithy.api#readonly": {} } }, - "com.amazonaws.cleanroomsml#GetAudienceGenerationJobRequest": { + "com.amazonaws.cleanroomsml#ListTrainedModelsRequest": { "type": "structure", "members": { - "audienceGenerationJobArn": { - "target": "com.amazonaws.cleanroomsml#AudienceGenerationJobArn", + "nextToken": { + "target": "com.amazonaws.cleanroomsml#NextToken", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the audience generation job that you are interested in.
", + "smithy.api#documentation": "The token value retrieved from a previous call to access the next page of results.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.cleanroomsml#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum size of the results that is returned per call.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "membershipIdentifier": { + "target": "com.amazonaws.cleanroomsml#UUID", + "traits": { + "smithy.api#documentation": "The membership ID of the member that created the trained models you are interested in.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2297,164 +8555,284 @@ "smithy.api#input": {} } }, - "com.amazonaws.cleanroomsml#GetAudienceGenerationJobResponse": { + "com.amazonaws.cleanroomsml#ListTrainedModelsResponse": { "type": "structure", "members": { - "createTime": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "The time at which the audience generation job was created.
", - "smithy.api#required": {}, - "smithy.api#timestampFormat": "date-time" - } - }, - "updateTime": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "The most recent time at which the audience generation job was updated.
", - "smithy.api#required": {}, - "smithy.api#timestampFormat": "date-time" - } - }, - "audienceGenerationJobArn": { - "target": "com.amazonaws.cleanroomsml#AudienceGenerationJobArn", + "nextToken": { + "target": "com.amazonaws.cleanroomsml#NextToken", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the audience generation job.
", - "smithy.api#required": {} + "smithy.api#documentation": "The token value used to access the next page of results.
" } }, - "name": { - "target": "com.amazonaws.cleanroomsml#NameString", + "trainedModels": { + "target": "com.amazonaws.cleanroomsml#TrainedModelList", "traits": { - "smithy.api#documentation": "The name of the audience generation job.
", + "smithy.api#documentation": "The list of trained models.
", "smithy.api#required": {} } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cleanroomsml#ListTrainingDatasets": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanroomsml#ListTrainingDatasetsRequest" + }, + "output": { + "target": "com.amazonaws.cleanroomsml#ListTrainingDatasetsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cleanroomsml#AccessDeniedException" }, - "description": { - "target": "com.amazonaws.cleanroomsml#ResourceDescription", - "traits": { - "smithy.api#documentation": "The description of the audience generation job.
" - } - }, - "status": { - "target": "com.amazonaws.cleanroomsml#AudienceGenerationJobStatus", - "traits": { - "smithy.api#documentation": "The status of the audience generation job.
", - "smithy.api#required": {} - } + { + "target": "com.amazonaws.cleanroomsml#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of training datasets.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/training-dataset" }, - "statusDetails": { - "target": "com.amazonaws.cleanroomsml#StatusDetails", - "traits": { - "smithy.api#documentation": "Details about the status of the audience generation job.
" - } + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "trainingDatasets" }, - "configuredAudienceModelArn": { - "target": "com.amazonaws.cleanroomsml#ConfiguredAudienceModelArn", + "smithy.api#readonly": {} + } + }, + "com.amazonaws.cleanroomsml#ListTrainingDatasetsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.cleanroomsml#NextToken", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the configured audience model used for this audience generation job.
", - "smithy.api#required": {} + "smithy.api#documentation": "The token value retrieved from a previous call to access the next page of results.
", + "smithy.api#httpQuery": "nextToken" } }, - "seedAudience": { - "target": "com.amazonaws.cleanroomsml#AudienceGenerationJobDataSource", + "maxResults": { + "target": "com.amazonaws.cleanroomsml#MaxResults", "traits": { - "smithy.api#documentation": "The seed audience that was used for this audience generation job. This field will be null if the account calling the API is the account that started this audience generation job.
" + "smithy.api#documentation": "The maximum size of the results that is returned per call.
", + "smithy.api#httpQuery": "maxResults" } - }, - "includeSeedInOutput": { - "target": "smithy.api#Boolean", + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanroomsml#ListTrainingDatasetsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.cleanroomsml#NextToken", "traits": { - "smithy.api#documentation": "Configure whether the seed users are included in the output audience. By default, Clean Rooms ML removes seed users from the output audience. If you specify TRUE, the seed users will appear first in the output. Clean Rooms ML does not explicitly reveal whether a user was in the seed, but the recipient of the audience will know that the first minimumSeedSize count of users are from the seed.
The token value used to access the next page of results.
" } }, - "collaborationId": { - "target": "com.amazonaws.cleanroomsml#UUID", + "trainingDatasets": { + "target": "com.amazonaws.cleanroomsml#TrainingDatasetList", "traits": { - "smithy.api#documentation": "The identifier of the collaboration that this audience generation job is associated with.
" + "smithy.api#documentation": "The training datasets that match the request.
", + "smithy.api#required": {} } - }, - "metrics": { - "target": "com.amazonaws.cleanroomsml#AudienceQualityMetrics", + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cleanroomsml#LogsConfigurationPolicy": { + "type": "structure", + "members": { + "allowedAccountIds": { + "target": "com.amazonaws.cleanroomsml#AccountIdList", "traits": { - "smithy.api#documentation": "The relevance scores for different audience sizes and the recall score of the generated audience.
" + "smithy.api#documentation": "A list of account IDs that are allowed to access the logs.
", + "smithy.api#required": {} } }, - "startedBy": { - "target": "com.amazonaws.cleanroomsml#AccountId", + "filterPattern": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The AWS account that started this audience generation job.
" + "smithy.api#documentation": "A regular expression pattern that is used to parse the logs and return information that matches the pattern.
", + "smithy.api#length": { + "min": 0, + "max": 1024 + } } + } + }, + "traits": { + "smithy.api#documentation": "Provides the information necessary for a user to access the logs.
" + } + }, + "com.amazonaws.cleanroomsml#LogsConfigurationPolicyList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanroomsml#LogsConfigurationPolicy" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 }, - "tags": { - "target": "com.amazonaws.cleanroomsml#TagMap", + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.cleanroomsml#LogsStatus": { + "type": "enum", + "members": { + "PUBLISH_SUCCEEDED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The tags that are associated to this audience generation job.
" + "smithy.api#enumValue": "PUBLISH_SUCCEEDED" } }, - "protectedQueryIdentifier": { - "target": "smithy.api#String", + "PUBLISH_FAILED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The unique identifier of the protected query for this audience generation job.
" + "smithy.api#enumValue": "PUBLISH_FAILED" } } + } + }, + "com.amazonaws.cleanroomsml#MLConfiguration": { + "type": "resource", + "identifiers": { + "membershipIdentifier": { + "target": "com.amazonaws.cleanroomsml#UUID" + } + }, + "put": { + "target": "com.amazonaws.cleanroomsml#PutMLConfiguration" + }, + "read": { + "target": "com.amazonaws.cleanroomsml#GetMLConfiguration" + }, + "delete": { + "target": "com.amazonaws.cleanroomsml#DeleteMLConfiguration" }, "traits": { - "smithy.api#output": {} + "aws.api#arn": { + "template": "membership/{membershipIdentifier}" + } } }, - "com.amazonaws.cleanroomsml#GetAudienceModel": { - "type": "operation", - "input": { - "target": "com.amazonaws.cleanroomsml#GetAudienceModelRequest" + "com.amazonaws.cleanroomsml#MLInputChannel": { + "type": "resource", + "identifiers": { + "mlInputChannelArn": { + "target": "com.amazonaws.cleanroomsml#MLInputChannelArn" + } }, - "output": { - "target": "com.amazonaws.cleanroomsml#GetAudienceModelResponse" + "create": { + "target": "com.amazonaws.cleanroomsml#CreateMLInputChannel" }, - "errors": [ - { - "target": "com.amazonaws.cleanroomsml#AccessDeniedException" - }, - { - "target": "com.amazonaws.cleanroomsml#ResourceNotFoundException" - }, + "read": { + "target": "com.amazonaws.cleanroomsml#GetMLInputChannel" + }, + "delete": { + "target": "com.amazonaws.cleanroomsml#DeleteMLInputChannelData" + }, + "list": { + "target": "com.amazonaws.cleanroomsml#ListMLInputChannels" + }, + "operations": [ { - "target": "com.amazonaws.cleanroomsml#ValidationException" + "target": "com.amazonaws.cleanroomsml#GetCollaborationMLInputChannel" } ], "traits": { - "smithy.api#documentation": "Returns information about an audience model
", - "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/audience-model/{audienceModelArn}" + "aws.api#arn": { + "template": "{mlInputChannelArn}", + "absolute": true + } + } + }, + "com.amazonaws.cleanroomsml#MLInputChannelArn": { + "type": "string", + "traits": { + "aws.api#arnReference": { + "service": "com.amazonaws.cleanroomsml#AWSStarkControlService", + "resource": "com.amazonaws.cleanroomsml#MLInputChannel" }, - "smithy.api#readonly": {} + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws[-a-z]*:cleanrooms-ml:[-a-z0-9]+:[0-9]{12}:membership/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/ml-input-channel/[-a-zA-Z0-9_/.]+$" } }, - "com.amazonaws.cleanroomsml#GetAudienceModelRequest": { - "type": "structure", + "com.amazonaws.cleanroomsml#MLInputChannelStatus": { + "type": "enum", "members": { - "audienceModelArn": { - "target": "com.amazonaws.cleanroomsml#AudienceModelArn", + "CREATE_PENDING": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the audience model that you are interested in.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#enumValue": "CREATE_PENDING" + } + }, + "CREATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_IN_PROGRESS" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FAILED" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "DELETE_PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_PENDING" + } + }, + "DELETE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_IN_PROGRESS" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_FAILED" + } + }, + "INACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INACTIVE" } } - }, - "traits": { - "smithy.api#input": {} } }, - "com.amazonaws.cleanroomsml#GetAudienceModelResponse": { + "com.amazonaws.cleanroomsml#MLInputChannelSummary": { "type": "structure", "members": { "createTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "The time at which the audience model was created.
", + "smithy.api#documentation": "The time at which the ML input channel was created.
", "smithy.api#required": {}, "smithy.api#timestampFormat": "date-time" } @@ -2462,304 +8840,468 @@ "updateTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "The most recent time at which the audience model was updated.
", + "smithy.api#documentation": "The most recent time at which the ML input channel was updated.
", "smithy.api#required": {}, "smithy.api#timestampFormat": "date-time" } }, - "trainingDataStartTime": { - "target": "smithy.api#Timestamp", + "membershipIdentifier": { + "target": "com.amazonaws.cleanroomsml#UUID", "traits": { - "smithy.api#documentation": "The start date specified for the training window.
", - "smithy.api#timestampFormat": "date-time" + "smithy.api#documentation": "The membership ID of the membership that contains the ML input channel.
", + "smithy.api#required": {} } }, - "trainingDataEndTime": { - "target": "smithy.api#Timestamp", + "collaborationIdentifier": { + "target": "com.amazonaws.cleanroomsml#UUID", "traits": { - "smithy.api#documentation": "The end date specified for the training window.
", - "smithy.api#timestampFormat": "date-time" + "smithy.api#documentation": "The collaboration ID of the collaboration that contains the ML input channel.
", + "smithy.api#required": {} } }, - "audienceModelArn": { - "target": "com.amazonaws.cleanroomsml#AudienceModelArn", + "name": { + "target": "com.amazonaws.cleanroomsml#NameString", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the audience model.
", + "smithy.api#documentation": "The name of the ML input channel.
", "smithy.api#required": {} } }, - "name": { - "target": "com.amazonaws.cleanroomsml#NameString", + "configuredModelAlgorithmAssociations": { + "target": "com.amazonaws.cleanroomsml#ConfiguredModelAlgorithmAssociationArnList", "traits": { - "smithy.api#documentation": "The name of the audience model.
", + "smithy.api#documentation": "The associated configured model algorithms used to create the ML input channel.
", + "smithy.api#length": { + "min": 1, + "max": 1 + }, "smithy.api#required": {} } }, - "trainingDatasetArn": { - "target": "com.amazonaws.cleanroomsml#TrainingDatasetArn", + "protectedQueryIdentifier": { + "target": "com.amazonaws.cleanroomsml#UUID", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the training dataset that was used for this audience model.
", + "smithy.api#documentation": "The ID of the protected query that was used to create the ML input channel.
" + } + }, + "mlInputChannelArn": { + "target": "com.amazonaws.cleanroomsml#MLInputChannelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the ML input channel.
", "smithy.api#required": {} } }, "status": { - "target": "com.amazonaws.cleanroomsml#AudienceModelStatus", + "target": "com.amazonaws.cleanroomsml#MLInputChannelStatus", "traits": { - "smithy.api#documentation": "The status of the audience model.
", + "smithy.api#documentation": "The status of the ML input channel.
", "smithy.api#required": {} } }, - "statusDetails": { - "target": "com.amazonaws.cleanroomsml#StatusDetails", + "description": { + "target": "com.amazonaws.cleanroomsml#ResourceDescription", "traits": { - "smithy.api#documentation": "Details about the status of the audience model.
" + "smithy.api#documentation": "The description of the ML input channel.
" } - }, - "kmsKeyArn": { - "target": "com.amazonaws.cleanroomsml#KmsKeyArn", + } + }, + "traits": { + "smithy.api#documentation": "Provides summary information about the ML input channel.
" + } + }, + "com.amazonaws.cleanroomsml#MLInputChannelsList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanroomsml#MLInputChannelSummary" + } + }, + "com.amazonaws.cleanroomsml#MLOutputConfiguration": { + "type": "structure", + "members": { + "destination": { + "target": "com.amazonaws.cleanroomsml#Destination", "traits": { - "smithy.api#documentation": "The KMS key ARN used for the audience model.
" + "smithy.api#documentation": "The Amazon S3 location where exported model artifacts are stored.
" } }, - "tags": { - "target": "com.amazonaws.cleanroomsml#TagMap", + "roleArn": { + "target": "com.amazonaws.cleanroomsml#IamRoleArn", "traits": { - "smithy.api#documentation": "The tags that are assigned to the audience model.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service access role that is used to store the model artifacts.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration information about how the exported model artifacts are stored.
" + } + }, + "com.amazonaws.cleanroomsml#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.cleanroomsml#MetricDefinition": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.cleanroomsml#MetricName", + "traits": { + "smithy.api#documentation": "The name of the model metric.
", + "smithy.api#required": {} } }, - "description": { - "target": "com.amazonaws.cleanroomsml#ResourceDescription", + "regex": { + "target": "com.amazonaws.cleanroomsml#MetricRegex", "traits": { - "smithy.api#documentation": "The description of the audience model.
" + "smithy.api#documentation": "The regular expression statement that defines how the model metric is reported.
", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#output": {} + "smithy.api#documentation": "Information about the model metric that is reported for a trained model.
" } }, - "com.amazonaws.cleanroomsml#GetConfiguredAudienceModel": { - "type": "operation", - "input": { - "target": "com.amazonaws.cleanroomsml#GetConfiguredAudienceModelRequest" - }, - "output": { - "target": "com.amazonaws.cleanroomsml#GetConfiguredAudienceModelResponse" + "com.amazonaws.cleanroomsml#MetricDefinitionList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanroomsml#MetricDefinition" }, - "errors": [ - { - "target": "com.amazonaws.cleanroomsml#AccessDeniedException" - }, - { - "target": "com.amazonaws.cleanroomsml#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cleanroomsml#ValidationException" + "traits": { + "smithy.api#length": { + "min": 0, + "max": 40 } - ], + } + }, + "com.amazonaws.cleanroomsml#MetricName": { + "type": "string", "traits": { - "smithy.api#documentation": "Returns information about a specified configured audience model.
", - "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/configured-audience-model/{configuredAudienceModelArn}" + "smithy.api#length": { + "min": 1, + "max": 255 }, - "smithy.api#readonly": {} + "smithy.api#pattern": "^.+$" } }, - "com.amazonaws.cleanroomsml#GetConfiguredAudienceModelPolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.cleanroomsml#GetConfiguredAudienceModelPolicyRequest" - }, - "output": { - "target": "com.amazonaws.cleanroomsml#GetConfiguredAudienceModelPolicyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cleanroomsml#AccessDeniedException" - }, - { - "target": "com.amazonaws.cleanroomsml#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cleanroomsml#ValidationException" - } - ], + "com.amazonaws.cleanroomsml#MetricRegex": { + "type": "string", "traits": { - "smithy.api#documentation": "Returns information about a configured audience model policy.
", - "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/configured-audience-model/{configuredAudienceModelArn}/policy" + "smithy.api#length": { + "min": 1, + "max": 500 }, - "smithy.api#readonly": {} + "smithy.api#pattern": "^.+$" } }, - "com.amazonaws.cleanroomsml#GetConfiguredAudienceModelPolicyRequest": { + "com.amazonaws.cleanroomsml#MetricsConfigurationPolicy": { "type": "structure", "members": { - "configuredAudienceModelArn": { - "target": "com.amazonaws.cleanroomsml#ConfiguredAudienceModelArn", + "noiseLevel": { + "target": "com.amazonaws.cleanroomsml#NoiseLevelType", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the configured audience model that you are interested in.
", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "The noise level for the generated metrics.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#input": {} + "smithy.api#documentation": "Provides the configuration policy for metrics generation.
" } }, - "com.amazonaws.cleanroomsml#GetConfiguredAudienceModelPolicyResponse": { - "type": "structure", + "com.amazonaws.cleanroomsml#MetricsList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanroomsml#SharedAudienceMetrics" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.cleanroomsml#MetricsStatus": { + "type": "enum", "members": { - "configuredAudienceModelArn": { - "target": "com.amazonaws.cleanroomsml#ConfiguredAudienceModelArn", + "PUBLISH_SUCCEEDED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the configured audience model.
", - "smithy.api#required": {} + "smithy.api#enumValue": "PUBLISH_SUCCEEDED" } }, - "configuredAudienceModelPolicy": { - "target": "com.amazonaws.cleanroomsml#ResourcePolicy", + "PUBLISH_FAILED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The configured audience model policy. This is a JSON IAM resource policy.
", - "smithy.api#required": {} + "smithy.api#enumValue": "PUBLISH_FAILED" } - }, - "policyHash": { - "target": "com.amazonaws.cleanroomsml#Hash", + } + } + }, + "com.amazonaws.cleanroomsml#MinMatchingSeedSize": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 25, + "max": 500000 + } + } + }, + "com.amazonaws.cleanroomsml#ModelInferenceDataSource": { + "type": "structure", + "members": { + "mlInputChannelArn": { + "target": "com.amazonaws.cleanroomsml#MLInputChannelArn", "traits": { - "smithy.api#documentation": "A cryptographic hash of the contents of the policy used to prevent unexpected concurrent modification of the policy.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the ML input channel for this model inference data source.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#output": {} + "smithy.api#documentation": "Defines information about the data source used for model inference.
" } }, - "com.amazonaws.cleanroomsml#GetConfiguredAudienceModelRequest": { + "com.amazonaws.cleanroomsml#ModelTrainingDataChannel": { "type": "structure", "members": { - "configuredAudienceModelArn": { - "target": "com.amazonaws.cleanroomsml#ConfiguredAudienceModelArn", + "mlInputChannelArn": { + "target": "com.amazonaws.cleanroomsml#MLInputChannelArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the configured audience model that you are interested in.
", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the ML input channel for this model training data channel.
", + "smithy.api#required": {} + } + }, + "channelName": { + "target": "com.amazonaws.cleanroomsml#ModelTrainingDataChannelName", + "traits": { + "smithy.api#documentation": "The name of the training data channel.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#input": {} + "smithy.api#documentation": "Information about the model training data channel. A training data channel is a named data source that the training algorithms can consume.
" } }, - "com.amazonaws.cleanroomsml#GetConfiguredAudienceModelResponse": { - "type": "structure", + "com.amazonaws.cleanroomsml#ModelTrainingDataChannelName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[A-Za-z0-9\\.\\-_]+$" + } + }, + "com.amazonaws.cleanroomsml#ModelTrainingDataChannels": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanroomsml#ModelTrainingDataChannel" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + }, + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.cleanroomsml#NameString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^(?!\\s*$)[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t]*$" + } + }, + "com.amazonaws.cleanroomsml#NextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10240 + } + } + }, + "com.amazonaws.cleanroomsml#NoiseLevelType": { + "type": "enum", "members": { - "createTime": { - "target": "smithy.api#Timestamp", + "HIGH": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The time at which the configured audience model was created.
", - "smithy.api#required": {}, - "smithy.api#timestampFormat": "date-time" + "smithy.api#enumValue": "HIGH" } }, - "updateTime": { - "target": "smithy.api#Timestamp", + "MEDIUM": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The most recent time at which the configured audience model was updated.
", - "smithy.api#required": {}, - "smithy.api#timestampFormat": "date-time" + "smithy.api#enumValue": "MEDIUM" } }, - "configuredAudienceModelArn": { - "target": "com.amazonaws.cleanroomsml#ConfiguredAudienceModelArn", + "LOW": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the configured audience model.
", - "smithy.api#required": {} + "smithy.api#enumValue": "LOW" } }, - "name": { - "target": "com.amazonaws.cleanroomsml#NameString", + "NONE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The name of the configured audience model.
", - "smithy.api#required": {} + "smithy.api#enumValue": "NONE" } + } + } + }, + "com.amazonaws.cleanroomsml#ParameterKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 }, - "audienceModelArn": { - "target": "com.amazonaws.cleanroomsml#AudienceModelArn", + "smithy.api#pattern": "^[0-9a-zA-Z_]+$" + } + }, + "com.amazonaws.cleanroomsml#ParameterMap": { + "type": "map", + "key": { + "target": "com.amazonaws.cleanroomsml#ParameterKey" + }, + "value": { + "target": "com.amazonaws.cleanroomsml#ParameterValue" + } + }, + "com.amazonaws.cleanroomsml#ParameterValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 250 + } + } + }, + "com.amazonaws.cleanroomsml#PolicyExistenceCondition": { + "type": "enum", + "members": { + "POLICY_MUST_EXIST": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the audience model used for this configured audience model.
", - "smithy.api#required": {} + "smithy.api#enumValue": "POLICY_MUST_EXIST" } }, - "outputConfig": { - "target": "com.amazonaws.cleanroomsml#ConfiguredAudienceModelOutputConfig", + "POLICY_MUST_NOT_EXIST": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The output configuration of the configured audience model
", + "smithy.api#enumValue": "POLICY_MUST_NOT_EXIST" + } + } + } + }, + "com.amazonaws.cleanroomsml#PrivacyConfiguration": { + "type": "structure", + "members": { + "policies": { + "target": "com.amazonaws.cleanroomsml#PrivacyConfigurationPolicies", + "traits": { + "smithy.api#documentation": "The privacy configuration policies for a configured model algorithm association.
", "smithy.api#required": {} } - }, - "description": { - "target": "com.amazonaws.cleanroomsml#ResourceDescription", + } + }, + "traits": { + "smithy.api#documentation": "Information about the privacy configuration for a configured model algorithm association.
" + } + }, + "com.amazonaws.cleanroomsml#PrivacyConfigurationPolicies": { + "type": "structure", + "members": { + "trainedModels": { + "target": "com.amazonaws.cleanroomsml#TrainedModelsConfigurationPolicy", "traits": { - "smithy.api#documentation": "The description of the configured audience model.
" + "smithy.api#documentation": "Specifies who will receive the trained models.
" } }, - "status": { - "target": "com.amazonaws.cleanroomsml#ConfiguredAudienceModelStatus", + "trainedModelExports": { + "target": "com.amazonaws.cleanroomsml#TrainedModelExportsConfigurationPolicy", "traits": { - "smithy.api#documentation": "The status of the configured audience model.
", - "smithy.api#required": {} + "smithy.api#documentation": "Specifies who will receive the trained model export.
" } }, - "sharedAudienceMetrics": { - "target": "com.amazonaws.cleanroomsml#MetricsList", + "trainedModelInferenceJobs": { + "target": "com.amazonaws.cleanroomsml#TrainedModelInferenceJobsConfigurationPolicy", + "traits": { + "smithy.api#documentation": "Specifies who will receive the trained model inference jobs.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the privacy configuration policies for a configured model algorithm association.
" + } + }, + "com.amazonaws.cleanroomsml#ProtectedQueryInputParameters": { + "type": "structure", + "members": { + "sqlParameters": { + "target": "com.amazonaws.cleanroomsml#ProtectedQuerySQLParameters", "traits": { - "smithy.api#documentation": "Whether audience metrics are shared.
", "smithy.api#required": {} } }, - "minMatchingSeedSize": { - "target": "com.amazonaws.cleanroomsml#MinMatchingSeedSize", + "computeConfiguration": { + "target": "com.amazonaws.cleanroomsml#ComputeConfiguration", "traits": { - "smithy.api#documentation": "The minimum number of users from the seed audience that must match with users in the training data of the audience model.
" + "smithy.api#documentation": "Provides configuration information for the workers that will perform the protected query.
" } - }, - "audienceSizeConfig": { - "target": "com.amazonaws.cleanroomsml#AudienceSizeConfig", + } + }, + "traits": { + "smithy.api#documentation": "Provides information necessary to perform the protected query.
" + } + }, + "com.amazonaws.cleanroomsml#ProtectedQuerySQLParameters": { + "type": "structure", + "members": { + "queryString": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The list of output sizes of audiences that can be created using this configured audience model. A request to StartAudienceGenerationJob that uses this configured audience model must have an audienceSize selected from this list. You can use the ABSOLUTE\n AudienceSize to configure out audience sizes using the count of identifiers in the output. You can use the Percentage\n AudienceSize to configure sizes in the range 1-100 percent.
The query string to be submitted.
", + "smithy.api#length": { + "max": 500000 + } } }, - "tags": { - "target": "com.amazonaws.cleanroomsml#TagMap", + "analysisTemplateArn": { + "target": "com.amazonaws.cleanroomsml#AnalysisTemplateArn", "traits": { - "smithy.api#documentation": "The tags that are associated to this configured audience model.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) associated with the analysis template within a\n collaboration.
" } }, - "childResourceTagOnCreatePolicy": { - "target": "com.amazonaws.cleanroomsml#TagOnCreatePolicy", + "parameters": { + "target": "com.amazonaws.cleanroomsml#ParameterMap", "traits": { - "smithy.api#documentation": "Provides the childResourceTagOnCreatePolicy that was used for this configured audience model.
The protected query SQL parameters.
" } } }, "traits": { - "smithy.api#output": {} + "smithy.api#documentation": "The parameters for the SQL type Protected Query.
", + "smithy.api#sensitive": {} } }, - "com.amazonaws.cleanroomsml#GetTrainingDataset": { + "com.amazonaws.cleanroomsml#PutConfiguredAudienceModelPolicy": { "type": "operation", "input": { - "target": "com.amazonaws.cleanroomsml#GetTrainingDatasetRequest" + "target": "com.amazonaws.cleanroomsml#PutConfiguredAudienceModelPolicyRequest" }, "output": { - "target": "com.amazonaws.cleanroomsml#GetTrainingDatasetResponse" + "target": "com.amazonaws.cleanroomsml#PutConfiguredAudienceModelPolicyResponse" }, "errors": [ { @@ -2773,404 +9315,431 @@ } ], "traits": { - "smithy.api#documentation": "Returns information about a training dataset.
", + "smithy.api#documentation": "Create or update the resource policy for a configured audience model.
", "smithy.api#http": { "code": 200, - "method": "GET", - "uri": "/training-dataset/{trainingDatasetArn}" + "method": "PUT", + "uri": "/configured-audience-model/{configuredAudienceModelArn}/policy" }, - "smithy.api#readonly": {} + "smithy.api#idempotent": {} } }, - "com.amazonaws.cleanroomsml#GetTrainingDatasetRequest": { + "com.amazonaws.cleanroomsml#PutConfiguredAudienceModelPolicyRequest": { "type": "structure", "members": { - "trainingDatasetArn": { - "target": "com.amazonaws.cleanroomsml#TrainingDatasetArn", + "configuredAudienceModelArn": { + "target": "com.amazonaws.cleanroomsml#ConfiguredAudienceModelArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the training dataset that you are interested in.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the configured audience model that the resource policy will govern.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "configuredAudienceModelPolicy": { + "target": "com.amazonaws.cleanroomsml#ResourcePolicy", + "traits": { + "smithy.api#documentation": "The IAM resource policy.
", + "smithy.api#required": {} + } + }, + "previousPolicyHash": { + "target": "com.amazonaws.cleanroomsml#Hash", + "traits": { + "smithy.api#documentation": "A cryptographic hash of the contents of the policy used to prevent unexpected concurrent modification of the policy.
" + } + }, + "policyExistenceCondition": { + "target": "com.amazonaws.cleanroomsml#PolicyExistenceCondition", + "traits": { + "smithy.api#documentation": "Use this to prevent unexpected concurrent modification of the policy.
" + } } }, "traits": { "smithy.api#input": {} } }, - "com.amazonaws.cleanroomsml#GetTrainingDatasetResponse": { + "com.amazonaws.cleanroomsml#PutConfiguredAudienceModelPolicyResponse": { "type": "structure", "members": { - "createTime": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "The time at which the training dataset was created.
", - "smithy.api#required": {}, - "smithy.api#timestampFormat": "date-time" - } - }, - "updateTime": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "The most recent time at which the training dataset was updated.
", - "smithy.api#required": {}, - "smithy.api#timestampFormat": "date-time" - } - }, - "trainingDatasetArn": { - "target": "com.amazonaws.cleanroomsml#TrainingDatasetArn", + "configuredAudienceModelPolicy": { + "target": "com.amazonaws.cleanroomsml#ResourcePolicy", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the training dataset.
", + "smithy.api#documentation": "The IAM resource policy.
", "smithy.api#required": {} } }, - "name": { - "target": "com.amazonaws.cleanroomsml#NameString", + "policyHash": { + "target": "com.amazonaws.cleanroomsml#Hash", "traits": { - "smithy.api#documentation": "The name of the training dataset.
", + "smithy.api#documentation": "A cryptographic hash of the contents of the policy used to prevent unexpected concurrent modification of the policy.
", "smithy.api#required": {} } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cleanroomsml#PutMLConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.cleanroomsml#PutMLConfigurationRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cleanroomsml#AccessDeniedException" }, - "trainingData": { - "target": "com.amazonaws.cleanroomsml#DatasetList", - "traits": { - "smithy.api#documentation": "Metadata about the requested training data.
", - "smithy.api#required": {} - } + { + "target": "com.amazonaws.cleanroomsml#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Assigns information about an ML configuration.
", + "smithy.api#http": { + "code": 200, + "method": "PUT", + "uri": "/memberships/{membershipIdentifier}/ml-configurations" }, - "status": { - "target": "com.amazonaws.cleanroomsml#TrainingDatasetStatus", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cleanroomsml#PutMLConfigurationRequest": { + "type": "structure", + "members": { + "membershipIdentifier": { + "target": "com.amazonaws.cleanroomsml#UUID", "traits": { - "smithy.api#documentation": "The status of the training dataset.
", + "smithy.api#documentation": "The membership ID of the member that is being configured.
", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "roleArn": { - "target": "com.amazonaws.cleanroomsml#IamRoleArn", + "defaultOutputLocation": { + "target": "com.amazonaws.cleanroomsml#MLOutputConfiguration", "traits": { - "smithy.api#documentation": "The IAM role used to read the training data.
", + "smithy.api#documentation": "The default Amazon S3 location where ML output is stored for the specified member.
", "smithy.api#required": {} } - }, - "tags": { - "target": "com.amazonaws.cleanroomsml#TagMap", + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cleanroomsml#RelevanceMetric": { + "type": "structure", + "members": { + "audienceSize": { + "target": "com.amazonaws.cleanroomsml#AudienceSize", "traits": { - "smithy.api#documentation": "The tags that are assigned to this training dataset.
" + "smithy.api#required": {} } }, - "description": { - "target": "com.amazonaws.cleanroomsml#ResourceDescription", + "score": { + "target": "smithy.api#Double", "traits": { - "smithy.api#documentation": "The description of the training dataset.
" + "smithy.api#documentation": "The relevance score of the generated audience.
", + "smithy.api#range": { + "min": 0.0, + "max": 10.0 + } } } }, "traits": { - "smithy.api#output": {} + "smithy.api#documentation": "The relevance score of a generated audience.
" } }, - "com.amazonaws.cleanroomsml#GlueDataSource": { + "com.amazonaws.cleanroomsml#RelevanceMetrics": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanroomsml#RelevanceMetric" + } + }, + "com.amazonaws.cleanroomsml#ResourceConfig": { "type": "structure", "members": { - "tableName": { - "target": "com.amazonaws.cleanroomsml#GlueTableName", + "instanceCount": { + "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "The Glue table that contains the training data.
", - "smithy.api#required": {} + "smithy.api#default": 1, + "smithy.api#documentation": "The number of resources that are used to train the model.
", + "smithy.api#range": { + "min": 1, + "max": 1 + } } }, - "databaseName": { - "target": "com.amazonaws.cleanroomsml#GlueDatabaseName", + "instanceType": { + "target": "com.amazonaws.cleanroomsml#InstanceType", "traits": { - "smithy.api#documentation": "The Glue database that contains the training data.
", + "smithy.api#documentation": "The instance type that is used to train the model.
", "smithy.api#required": {} } }, - "catalogId": { - "target": "com.amazonaws.cleanroomsml#AccountId", + "volumeSizeInGB": { + "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "The Glue catalog that contains the training data.
" + "smithy.api#documentation": "The maximum size of the instance that is used to train the model.
", + "smithy.api#range": { + "min": 1, + "max": 8192 + }, + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Defines the Glue data source that contains the training data.
" + "smithy.api#documentation": "Information about the EC2 resources that are used to train the model.
" } }, - "com.amazonaws.cleanroomsml#GlueDatabaseName": { + "com.amazonaws.cleanroomsml#ResourceDescription": { "type": "string", "traits": { "smithy.api#length": { - "min": 1, - "max": 128 + "max": 255 }, - "smithy.api#pattern": "^[a-zA-Z0-9_](([a-zA-Z0-9_]+-)*([a-zA-Z0-9_]+))?$" + "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t\\r\\n]*$" } }, - "com.amazonaws.cleanroomsml#GlueTableName": { - "type": "string", + "com.amazonaws.cleanroomsml#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?$" + "smithy.api#documentation": "The resource you are requesting does not exist.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 } }, - "com.amazonaws.cleanroomsml#Hash": { + "com.amazonaws.cleanroomsml#ResourcePolicy": { "type": "string", "traits": { "smithy.api#length": { - "min": 64, - "max": 128 - }, - "smithy.api#pattern": "^[0-9a-f]+$" + "min": 1, + "max": 20480 + } + } + }, + "com.amazonaws.cleanroomsml#S3ConfigMap": { + "type": "structure", + "members": { + "s3Uri": { + "target": "com.amazonaws.cleanroomsml#S3Path", + "traits": { + "smithy.api#documentation": "The Amazon S3 location URI.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Provides information about an Amazon S3 bucket and path.
" } }, - "com.amazonaws.cleanroomsml#IamRoleArn": { + "com.amazonaws.cleanroomsml#S3Path": { "type": "string", "traits": { - "aws.api#arnReference": { - "type": "AWS::IAM::Role" - }, "smithy.api#length": { - "min": 20, - "max": 2048 + "min": 1, + "max": 1285 }, - "smithy.api#pattern": "^arn:aws[-a-z]*:iam::[0-9]{12}:role/.+$" + "smithy.api#pattern": "^s3://.+$" } }, - "com.amazonaws.cleanroomsml#KmsKeyArn": { - "type": "string", + "com.amazonaws.cleanroomsml#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, "traits": { - "aws.api#arnReference": { - "type": "AWS::KMS::Key" - }, - "smithy.api#length": { - "min": 20, - "max": 2048 + "smithy.api#documentation": "You have exceeded your service quota.
", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.cleanroomsml#SharedAudienceMetrics": { + "type": "enum", + "members": { + "ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL" + } }, - "smithy.api#pattern": "^arn:aws[-a-z]*:kms:[-a-z0-9]+:[0-9]{12}:key/.+$" + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + } } }, - "com.amazonaws.cleanroomsml#ListAudienceExportJobs": { + "com.amazonaws.cleanroomsml#StartAudienceExportJob": { "type": "operation", "input": { - "target": "com.amazonaws.cleanroomsml#ListAudienceExportJobsRequest" + "target": "com.amazonaws.cleanroomsml#StartAudienceExportJobRequest" }, "output": { - "target": "com.amazonaws.cleanroomsml#ListAudienceExportJobsResponse" + "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.cleanroomsml#AccessDeniedException" }, + { + "target": "com.amazonaws.cleanroomsml#ConflictException" + }, + { + "target": "com.amazonaws.cleanroomsml#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanroomsml#ServiceQuotaExceededException" + }, { "target": "com.amazonaws.cleanroomsml#ValidationException" } ], "traits": { - "smithy.api#documentation": "Returns a list of the audience export jobs.
", + "smithy.api#documentation": "Export an audience of a specified size after you have generated an audience.
", "smithy.api#http": { "code": 200, - "method": "GET", + "method": "POST", "uri": "/audience-export-job" }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "audienceExportJobs" - }, - "smithy.api#readonly": {} + "smithy.api#idempotent": {} } }, - "com.amazonaws.cleanroomsml#ListAudienceExportJobsRequest": { + "com.amazonaws.cleanroomsml#StartAudienceExportJobRequest": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.cleanroomsml#NextToken", - "traits": { - "smithy.api#documentation": "The token value retrieved from a previous call to access the next page of results.
", - "smithy.api#httpQuery": "nextToken" - } - }, - "maxResults": { - "target": "com.amazonaws.cleanroomsml#MaxResults", + "name": { + "target": "com.amazonaws.cleanroomsml#NameString", "traits": { - "smithy.api#documentation": "The maximum size of the results that is returned per call.
", - "smithy.api#httpQuery": "maxResults" + "smithy.api#documentation": "The name of the audience export job.
", + "smithy.api#required": {} } }, "audienceGenerationJobArn": { "target": "com.amazonaws.cleanroomsml#AudienceGenerationJobArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the audience generation job that you are interested in.
", - "smithy.api#httpQuery": "audienceGenerationJobArn" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the audience generation job that you want to export.
", + "smithy.api#required": {} } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cleanroomsml#ListAudienceExportJobsResponse": { - "type": "structure", - "members": { - "nextToken": { - "target": "com.amazonaws.cleanroomsml#NextToken", + }, + "audienceSize": { + "target": "com.amazonaws.cleanroomsml#AudienceSize", "traits": { - "smithy.api#documentation": "The token value retrieved from a previous call to access the next page of results.
" + "smithy.api#required": {} } }, - "audienceExportJobs": { - "target": "com.amazonaws.cleanroomsml#AudienceExportJobList", + "description": { + "target": "com.amazonaws.cleanroomsml#ResourceDescription", "traits": { - "smithy.api#documentation": "The audience export jobs that match the request.
", - "smithy.api#required": {} + "smithy.api#documentation": "The description of the audience export job.
" } } }, "traits": { - "smithy.api#output": {} + "smithy.api#input": {} } }, - "com.amazonaws.cleanroomsml#ListAudienceGenerationJobs": { + "com.amazonaws.cleanroomsml#StartAudienceGenerationJob": { "type": "operation", "input": { - "target": "com.amazonaws.cleanroomsml#ListAudienceGenerationJobsRequest" + "target": "com.amazonaws.cleanroomsml#StartAudienceGenerationJobRequest" }, "output": { - "target": "com.amazonaws.cleanroomsml#ListAudienceGenerationJobsResponse" + "target": "com.amazonaws.cleanroomsml#StartAudienceGenerationJobResponse" }, "errors": [ { "target": "com.amazonaws.cleanroomsml#AccessDeniedException" }, + { + "target": "com.amazonaws.cleanroomsml#ConflictException" + }, + { + "target": "com.amazonaws.cleanroomsml#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanroomsml#ServiceQuotaExceededException" + }, { "target": "com.amazonaws.cleanroomsml#ValidationException" } ], "traits": { - "smithy.api#documentation": "Returns a list of audience generation jobs.
", + "smithy.api#documentation": "Information necessary to start the audience generation job.
", "smithy.api#http": { "code": 200, - "method": "GET", + "method": "POST", "uri": "/audience-generation-job" }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "audienceGenerationJobs" - }, - "smithy.api#readonly": {} + "smithy.api#idempotent": {} } }, - "com.amazonaws.cleanroomsml#ListAudienceGenerationJobsRequest": { + "com.amazonaws.cleanroomsml#StartAudienceGenerationJobRequest": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.cleanroomsml#NextToken", - "traits": { - "smithy.api#documentation": "The token value retrieved from a previous call to access the next page of results.
", - "smithy.api#httpQuery": "nextToken" - } - }, - "maxResults": { - "target": "com.amazonaws.cleanroomsml#MaxResults", + "name": { + "target": "com.amazonaws.cleanroomsml#NameString", "traits": { - "smithy.api#documentation": "The maximum size of the results that is returned per call.
", - "smithy.api#httpQuery": "maxResults" + "smithy.api#documentation": "The name of the audience generation job.
", + "smithy.api#required": {} } }, "configuredAudienceModelArn": { "target": "com.amazonaws.cleanroomsml#ConfiguredAudienceModelArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the configured audience model that was used for the audience generation jobs that you are interested in.
", - "smithy.api#httpQuery": "configuredAudienceModelArn" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the configured audience model that is used for this audience generation job.
", + "smithy.api#required": {} } }, - "collaborationId": { - "target": "com.amazonaws.cleanroomsml#UUID", + "seedAudience": { + "target": "com.amazonaws.cleanroomsml#AudienceGenerationJobDataSource", "traits": { - "smithy.api#documentation": "The identifier of the collaboration that contains the audience generation jobs that you are interested in.
", - "smithy.api#httpQuery": "collaborationId" + "smithy.api#documentation": "The seed audience that is used to generate the audience.
", + "smithy.api#required": {} } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cleanroomsml#ListAudienceGenerationJobsResponse": { - "type": "structure", - "members": { - "nextToken": { - "target": "com.amazonaws.cleanroomsml#NextToken", + }, + "includeSeedInOutput": { + "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "The token value retrieved from a previous call to access the next page of results.
" + "smithy.api#default": false, + "smithy.api#documentation": "Whether the seed audience is included in the audience generation output.
" } }, - "audienceGenerationJobs": { - "target": "com.amazonaws.cleanroomsml#AudienceGenerationJobList", + "collaborationId": { + "target": "com.amazonaws.cleanroomsml#UUID", "traits": { - "smithy.api#documentation": "The audience generation jobs that match the request.
", - "smithy.api#required": {} + "smithy.api#documentation": "The identifier of the collaboration that contains the audience generation job.
" } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cleanroomsml#ListAudienceModels": { - "type": "operation", - "input": { - "target": "com.amazonaws.cleanroomsml#ListAudienceModelsRequest" - }, - "output": { - "target": "com.amazonaws.cleanroomsml#ListAudienceModelsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cleanroomsml#AccessDeniedException" - }, - { - "target": "com.amazonaws.cleanroomsml#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Returns a list of audience models.
", - "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/audience-model" - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "audienceModels" }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.cleanroomsml#ListAudienceModelsRequest": { - "type": "structure", - "members": { - "nextToken": { - "target": "com.amazonaws.cleanroomsml#NextToken", + "description": { + "target": "com.amazonaws.cleanroomsml#ResourceDescription", "traits": { - "smithy.api#documentation": "The token value retrieved from a previous call to access the next page of results.
", - "smithy.api#httpQuery": "nextToken" + "smithy.api#documentation": "The description of the audience generation job.
" } }, - "maxResults": { - "target": "com.amazonaws.cleanroomsml#MaxResults", - "traits": { - "smithy.api#documentation": "The maximum size of the results that is returned per call.
", - "smithy.api#httpQuery": "maxResults" + "tags": { + "target": "com.amazonaws.cleanroomsml#TagMap", + "traits": { + "smithy.api#documentation": "The optional metadata that you apply to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50.
\nFor each resource, each tag key must be unique, and each tag key can have only one value.
\nMaximum key length - 128 Unicode characters in UTF-8.
\nMaximum value length - 256 Unicode characters in UTF-8.
\nIf your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms ML considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.
\nThe token value retrieved from a previous call to access the next page of results.
" - } - }, - "audienceModels": { - "target": "com.amazonaws.cleanroomsml#AudienceModelList", + "audienceGenerationJobArn": { + "target": "com.amazonaws.cleanroomsml#AudienceGenerationJobArn", "traits": { - "smithy.api#documentation": "The audience models that match the request.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the audience generation job.
", "smithy.api#required": {} } } @@ -3199,132 +9762,211 @@ "smithy.api#output": {} } }, - "com.amazonaws.cleanroomsml#ListConfiguredAudienceModels": { + "com.amazonaws.cleanroomsml#StartTrainedModelExportJob": { "type": "operation", "input": { - "target": "com.amazonaws.cleanroomsml#ListConfiguredAudienceModelsRequest" + "target": "com.amazonaws.cleanroomsml#StartTrainedModelExportJobRequest" }, "output": { - "target": "com.amazonaws.cleanroomsml#ListConfiguredAudienceModelsResponse" + "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.cleanroomsml#AccessDeniedException" }, + { + "target": "com.amazonaws.cleanroomsml#ConflictException" + }, + { + "target": "com.amazonaws.cleanroomsml#ResourceNotFoundException" + }, { "target": "com.amazonaws.cleanroomsml#ValidationException" } ], "traits": { - "smithy.api#documentation": "Returns a list of the configured audience models.
", + "smithy.api#documentation": "Provides the information necessary to start a trained model export job.
", "smithy.api#http": { "code": 200, - "method": "GET", - "uri": "/configured-audience-model" - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "configuredAudienceModels" + "method": "POST", + "uri": "/memberships/{membershipIdentifier}/trained-models/{trainedModelArn}/export-jobs" }, - "smithy.api#readonly": {} + "smithy.api#idempotent": {} } }, - "com.amazonaws.cleanroomsml#ListConfiguredAudienceModelsRequest": { + "com.amazonaws.cleanroomsml#StartTrainedModelExportJobRequest": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.cleanroomsml#NextToken", + "name": { + "target": "com.amazonaws.cleanroomsml#NameString", "traits": { - "smithy.api#documentation": "The token value retrieved from a previous call to access the next page of results.
", - "smithy.api#httpQuery": "nextToken" + "smithy.api#documentation": "The name of the trained model export job.
", + "smithy.api#required": {} } }, - "maxResults": { - "target": "com.amazonaws.cleanroomsml#MaxResults", + "trainedModelArn": { + "target": "com.amazonaws.cleanroomsml#TrainedModelArn", "traits": { - "smithy.api#documentation": "The maximum size of the results that is returned per call.
", - "smithy.api#httpQuery": "maxResults" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the trained model that you want to export.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cleanroomsml#ListConfiguredAudienceModelsResponse": { - "type": "structure", - "members": { - "nextToken": { - "target": "com.amazonaws.cleanroomsml#NextToken", + }, + "membershipIdentifier": { + "target": "com.amazonaws.cleanroomsml#UUID", "traits": { - "smithy.api#documentation": "The token value retrieved from a previous call to access the next page of results.
" + "smithy.api#documentation": "The membership ID of the member that is receiving the exported trained model artifacts.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "configuredAudienceModels": { - "target": "com.amazonaws.cleanroomsml#ConfiguredAudienceModelList", + "outputConfiguration": { + "target": "com.amazonaws.cleanroomsml#TrainedModelExportOutputConfiguration", "traits": { - "smithy.api#documentation": "The configured audience models.
", + "smithy.api#documentation": "The output configuration information for the trained model export job.
", "smithy.api#required": {} } + }, + "description": { + "target": "com.amazonaws.cleanroomsml#ResourceDescription", + "traits": { + "smithy.api#documentation": "The description of the trained model export job.
" + } } }, "traits": { - "smithy.api#output": {} + "smithy.api#input": {} } }, - "com.amazonaws.cleanroomsml#ListTagsForResource": { + "com.amazonaws.cleanroomsml#StartTrainedModelInferenceJob": { "type": "operation", "input": { - "target": "com.amazonaws.cleanroomsml#ListTagsForResourceRequest" + "target": "com.amazonaws.cleanroomsml#StartTrainedModelInferenceJobRequest" }, "output": { - "target": "com.amazonaws.cleanroomsml#ListTagsForResourceResponse" + "target": "com.amazonaws.cleanroomsml#StartTrainedModelInferenceJobResponse" }, "errors": [ { "target": "com.amazonaws.cleanroomsml#AccessDeniedException" }, + { + "target": "com.amazonaws.cleanroomsml#ConflictException" + }, { "target": "com.amazonaws.cleanroomsml#ResourceNotFoundException" }, + { + "target": "com.amazonaws.cleanroomsml#ServiceQuotaExceededException" + }, { "target": "com.amazonaws.cleanroomsml#ValidationException" } ], "traits": { - "smithy.api#documentation": "Returns a list of tags for a provided resource.
", + "smithy.api#documentation": "Defines the information necessary to begin a trained model inference job.
", "smithy.api#http": { - "method": "GET", - "uri": "/tags/{resourceArn}" + "code": 200, + "method": "POST", + "uri": "/memberships/{membershipIdentifier}/trained-model-inference-jobs" }, - "smithy.api#readonly": {} + "smithy.api#idempotent": {} } }, - "com.amazonaws.cleanroomsml#ListTagsForResourceRequest": { + "com.amazonaws.cleanroomsml#StartTrainedModelInferenceJobRequest": { "type": "structure", "members": { - "resourceArn": { - "target": "com.amazonaws.cleanroomsml#TaggableArn", + "membershipIdentifier": { + "target": "com.amazonaws.cleanroomsml#UUID", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource that you are interested in.
", + "smithy.api#documentation": "The membership ID of the membership that contains the trained model inference job.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "name": { + "target": "com.amazonaws.cleanroomsml#NameString", + "traits": { + "smithy.api#documentation": "The name of the trained model inference job.
", + "smithy.api#required": {} + } + }, + "trainedModelArn": { + "target": "com.amazonaws.cleanroomsml#TrainedModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the trained model that is used for this trained model inference job.
", + "smithy.api#required": {} + } + }, + "configuredModelAlgorithmAssociationArn": { + "target": "com.amazonaws.cleanroomsml#ConfiguredModelAlgorithmAssociationArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the configured model algorithm association that is used for this trained model inference job.
" + } + }, + "resourceConfig": { + "target": "com.amazonaws.cleanroomsml#InferenceResourceConfig", + "traits": { + "smithy.api#documentation": "Defines the resource configuration for the trained model inference job.
", + "smithy.api#required": {} + } + }, + "outputConfiguration": { + "target": "com.amazonaws.cleanroomsml#InferenceOutputConfiguration", + "traits": { + "smithy.api#documentation": "Defines the output configuration information for the trained model inference job.
", + "smithy.api#required": {} + } + }, + "dataSource": { + "target": "com.amazonaws.cleanroomsml#ModelInferenceDataSource", + "traits": { + "smithy.api#documentation": "Defines he data source that is used for the trained model inference job.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.cleanroomsml#ResourceDescription", + "traits": { + "smithy.api#documentation": "The description of the trained model inference job.
" + } + }, + "containerExecutionParameters": { + "target": "com.amazonaws.cleanroomsml#InferenceContainerExecutionParameters", + "traits": { + "smithy.api#documentation": "The execution parameters for the container.
" + } + }, + "environment": { + "target": "com.amazonaws.cleanroomsml#InferenceEnvironmentMap", + "traits": { + "smithy.api#documentation": "The environment variables to set in the Docker container.
" + } + }, + "kmsKeyArn": { + "target": "com.amazonaws.cleanroomsml#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key. This key is used to encrypt and decrypt customer-owned data in the ML inference job and associated data.
" + } + }, + "tags": { + "target": "com.amazonaws.cleanroomsml#TagMap", + "traits": { + "smithy.api#documentation": "The optional metadata that you apply to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50.
\nFor each resource, each tag key must be unique, and each tag key can have only one value.
\nMaximum key length - 128 Unicode characters in UTF-8.
\nMaximum value length - 256 Unicode characters in UTF-8.
\nIf your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms ML considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.
\nThe tags that are associated with the resource.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the trained model inference job.
", "smithy.api#required": {} } } @@ -3333,53 +9975,141 @@ "smithy.api#output": {} } }, - "com.amazonaws.cleanroomsml#ListTrainingDatasets": { + "com.amazonaws.cleanroomsml#StatusDetails": { + "type": "structure", + "members": { + "statusCode": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The status code that was returned. The status code is intended for programmatic error handling. Clean Rooms ML will not change the status code for existing error conditions.
" + } + }, + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The error message that was returned. The message is intended for human consumption and can change at any time. Use the statusCode for programmatic error handling.
Details about the status of a resource.
" + } + }, + "com.amazonaws.cleanroomsml#StoppingCondition": { + "type": "structure", + "members": { + "maxRuntimeInSeconds": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#default": 86400, + "smithy.api#documentation": "The maximum amount of time, in seconds, that model training can run before it is terminated.
", + "smithy.api#range": { + "min": 1, + "max": 2419200 + } + } + } + }, + "traits": { + "smithy.api#documentation": "The criteria used to stop model training.
" + } + }, + "com.amazonaws.cleanroomsml#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.cleanroomsml#TagKeys": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanroomsml#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.cleanroomsml#TagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.cleanroomsml#TagKey" + }, + "value": { + "target": "com.amazonaws.cleanroomsml#TagValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.cleanroomsml#TagOnCreatePolicy": { + "type": "enum", + "members": { + "FROM_PARENT_RESOURCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FROM_PARENT_RESOURCE" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + } + } + }, + "com.amazonaws.cleanroomsml#TagResource": { "type": "operation", "input": { - "target": "com.amazonaws.cleanroomsml#ListTrainingDatasetsRequest" + "target": "com.amazonaws.cleanroomsml#TagResourceRequest" }, "output": { - "target": "com.amazonaws.cleanroomsml#ListTrainingDatasetsResponse" + "target": "com.amazonaws.cleanroomsml#TagResourceResponse" }, "errors": [ { "target": "com.amazonaws.cleanroomsml#AccessDeniedException" }, - { - "target": "com.amazonaws.cleanroomsml#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Returns a list of training datasets.
", - "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/training-dataset" - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "trainingDatasets" - }, - "smithy.api#readonly": {} + { + "target": "com.amazonaws.cleanroomsml#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cleanroomsml#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Adds metadata tags to a specified resource.
", + "smithy.api#http": { + "method": "POST", + "uri": "/tags/{resourceArn}" + } } }, - "com.amazonaws.cleanroomsml#ListTrainingDatasetsRequest": { + "com.amazonaws.cleanroomsml#TagResourceRequest": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.cleanroomsml#NextToken", + "resourceArn": { + "target": "com.amazonaws.cleanroomsml#TaggableArn", "traits": { - "smithy.api#documentation": "The token value retrieved from a previous call to access the next page of results.
", - "smithy.api#httpQuery": "nextToken" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource that you want to assign tags.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "maxResults": { - "target": "com.amazonaws.cleanroomsml#MaxResults", + "tags": { + "target": "com.amazonaws.cleanroomsml#TagMap", "traits": { - "smithy.api#documentation": "The maximum size of the results that is returned per call.
", - "smithy.api#httpQuery": "maxResults" + "smithy.api#documentation": "The optional metadata that you apply to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50.
\nFor each resource, each tag key must be unique, and each tag key can have only one value.
\nMaximum key length - 128 Unicode characters in UTF-8.
\nMaximum value length - 256 Unicode characters in UTF-8.
\nIf your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.
\nThe token value retrieved from a previous call to access the next page of results.
" - } - }, - "trainingDatasets": { - "target": "com.amazonaws.cleanroomsml#TrainingDatasetList", - "traits": { - "smithy.api#documentation": "The training datasets that match the request.
", - "smithy.api#required": {} - } - } - }, + "members": {}, "traits": { "smithy.api#output": {} } }, - "com.amazonaws.cleanroomsml#MaxResults": { - "type": "integer", + "com.amazonaws.cleanroomsml#TagValue": { + "type": "string", "traits": { - "smithy.api#range": { - "min": 1, - "max": 100 + "smithy.api#length": { + "min": 0, + "max": 256 } } }, - "com.amazonaws.cleanroomsml#MetricsList": { - "type": "list", - "member": { - "target": "com.amazonaws.cleanroomsml#SharedAudienceMetrics" - }, + "com.amazonaws.cleanroomsml#TaggableArn": { + "type": "string", "traits": { + "aws.api#arnReference": { + "service": "com.amazonaws.cleanroomsml#AWSStarkControlService" + }, "smithy.api#length": { - "min": 1, - "max": 1 - } + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws[-a-z]*:cleanrooms-ml:[-a-z0-9]+:[0-9]{12}:(membership/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/(configured-model-algorithm-association|trained-model|trained-model-inference-job|ml-input-channel)|training-dataset|audience-model|configured-audience-model|audience-generation-job|configured-model-algorithm|configured-model-algorithm-association|trained-model|trained-model-inference-job)/[-a-zA-Z0-9_/.]+$" } }, - "com.amazonaws.cleanroomsml#MinMatchingSeedSize": { - "type": "integer", + "com.amazonaws.cleanroomsml#TrainedModel": { + "type": "resource", + "identifiers": { + "trainedModelArn": { + "target": "com.amazonaws.cleanroomsml#TrainedModelArn" + } + }, + "create": { + "target": "com.amazonaws.cleanroomsml#CreateTrainedModel" + }, + "read": { + "target": "com.amazonaws.cleanroomsml#GetTrainedModel" + }, + "delete": { + "target": "com.amazonaws.cleanroomsml#DeleteTrainedModelOutput" + }, + "list": { + "target": "com.amazonaws.cleanroomsml#ListTrainedModels" + }, + "operations": [ + { + "target": "com.amazonaws.cleanroomsml#CancelTrainedModel" + }, + { + "target": "com.amazonaws.cleanroomsml#GetCollaborationTrainedModel" + } + ], "traits": { - "smithy.api#range": { - "min": 25, - "max": 500000 + "aws.api#arn": { + "template": "{trainedModelArn}", + "absolute": true } } }, - "com.amazonaws.cleanroomsml#NameString": { + "com.amazonaws.cleanroomsml#TrainedModelArn": { "type": "string", "traits": { + "aws.api#arnReference": { + "service": "com.amazonaws.cleanroomsml#AWSStarkControlService", + "resource": "com.amazonaws.cleanroomsml#TrainedModel" + }, "smithy.api#length": { - "min": 1, - "max": 63 + "min": 20, + "max": 2048 }, - "smithy.api#pattern": "^(?!\\s*$)[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t]*$" + "smithy.api#pattern": "^arn:aws[-a-z]*:cleanrooms-ml:[-a-z0-9]+:[0-9]{12}:(membership/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/)?trained-model/[-a-zA-Z0-9_/.]+$" } }, - "com.amazonaws.cleanroomsml#NextToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10240 + "com.amazonaws.cleanroomsml#TrainedModelExportFileType": { + "type": "enum", + "members": { + "MODEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MODEL" + } + }, + "OUTPUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OUTPUT" + } } } }, - "com.amazonaws.cleanroomsml#ParameterKey": { - "type": "string", + "com.amazonaws.cleanroomsml#TrainedModelExportFileTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanroomsml#TrainedModelExportFileType" + }, "traits": { "smithy.api#length": { "min": 1, - "max": 100 + "max": 2 }, - "smithy.api#pattern": "^[0-9a-zA-Z_]+$" + "smithy.api#uniqueItems": {} } }, - "com.amazonaws.cleanroomsml#ParameterMap": { - "type": "map", - "key": { - "target": "com.amazonaws.cleanroomsml#ParameterKey" + "com.amazonaws.cleanroomsml#TrainedModelExportJob": { + "type": "resource", + "identifiers": { + "trainedModelExportJobArn": { + "target": "com.amazonaws.cleanroomsml#TrainedModelExportJobArn" + } }, - "value": { - "target": "com.amazonaws.cleanroomsml#ParameterValue" + "create": { + "target": "com.amazonaws.cleanroomsml#StartTrainedModelExportJob" + }, + "traits": { + "aws.api#arn": { + "template": "{trainedModelExportJobArn}", + "absolute": true + } } }, - "com.amazonaws.cleanroomsml#ParameterValue": { + "com.amazonaws.cleanroomsml#TrainedModelExportJobArn": { "type": "string", "traits": { + "aws.api#arnReference": { + "service": "com.amazonaws.cleanroomsml#AWSStarkControlService", + "resource": "com.amazonaws.cleanroomsml#TrainedModelExportJob" + }, "smithy.api#length": { - "min": 0, - "max": 250 - } + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws[-a-z]*:cleanrooms-ml:[-a-z0-9]+:[0-9]{12}:trained-model-export-job/[-a-zA-Z0-9_/.]+$" } }, - "com.amazonaws.cleanroomsml#PolicyExistenceCondition": { + "com.amazonaws.cleanroomsml#TrainedModelExportJobStatus": { "type": "enum", "members": { - "POLICY_MUST_EXIST": { + "CREATE_PENDING": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "POLICY_MUST_EXIST" + "smithy.api#enumValue": "CREATE_PENDING" } }, - "POLICY_MUST_NOT_EXIST": { + "CREATE_IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "POLICY_MUST_NOT_EXIST" - } - } - } - }, - "com.amazonaws.cleanroomsml#ProtectedQuerySQLParameters": { - "type": "structure", - "members": { - "queryString": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "The query string to be submitted.
", - "smithy.api#length": { - "max": 90000 - } + "smithy.api#enumValue": "CREATE_IN_PROGRESS" } }, - "analysisTemplateArn": { - "target": "com.amazonaws.cleanroomsml#AnalysisTemplateArn", + "CREATE_FAILED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) associated with the analysis template within a\n collaboration.
" + "smithy.api#enumValue": "CREATE_FAILED" } }, - "parameters": { - "target": "com.amazonaws.cleanroomsml#ParameterMap", + "ACTIVE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The protected query SQL parameters.
" + "smithy.api#enumValue": "ACTIVE" } } - }, - "traits": { - "smithy.api#documentation": "The parameters for the SQL type Protected Query.
", - "smithy.api#sensitive": {} } }, - "com.amazonaws.cleanroomsml#PutConfiguredAudienceModelPolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.cleanroomsml#PutConfiguredAudienceModelPolicyRequest" - }, - "output": { - "target": "com.amazonaws.cleanroomsml#PutConfiguredAudienceModelPolicyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cleanroomsml#AccessDeniedException" - }, - { - "target": "com.amazonaws.cleanroomsml#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.cleanroomsml#ValidationException" + "com.amazonaws.cleanroomsml#TrainedModelExportOutputConfiguration": { + "type": "structure", + "members": { + "members": { + "target": "com.amazonaws.cleanroomsml#TrainedModelExportReceiverMembers", + "traits": { + "smithy.api#documentation": "The members that will received the exported trained model output.
", + "smithy.api#required": {} + } } - ], + }, "traits": { - "smithy.api#documentation": "Create or update the resource policy for a configured audience model.
", - "smithy.api#http": { - "code": 200, - "method": "PUT", - "uri": "/configured-audience-model/{configuredAudienceModelArn}/policy" - }, - "smithy.api#idempotent": {} + "smithy.api#documentation": "Information about the output of the trained model export job.
" } }, - "com.amazonaws.cleanroomsml#PutConfiguredAudienceModelPolicyRequest": { + "com.amazonaws.cleanroomsml#TrainedModelExportReceiverMember": { "type": "structure", "members": { - "configuredAudienceModelArn": { - "target": "com.amazonaws.cleanroomsml#ConfiguredAudienceModelArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the configured audience model that the resource policy will govern.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "configuredAudienceModelPolicy": { - "target": "com.amazonaws.cleanroomsml#ResourcePolicy", + "accountId": { + "target": "com.amazonaws.cleanroomsml#AccountId", "traits": { - "smithy.api#documentation": "The IAM resource policy.
", + "smithy.api#documentation": "The account ID of the member who will receive trained model exports.
", "smithy.api#required": {} } - }, - "previousPolicyHash": { - "target": "com.amazonaws.cleanroomsml#Hash", - "traits": { - "smithy.api#documentation": "A cryptographic hash of the contents of the policy used to prevent unexpected concurrent modification of the policy.
" - } - }, - "policyExistenceCondition": { - "target": "com.amazonaws.cleanroomsml#PolicyExistenceCondition", - "traits": { - "smithy.api#documentation": "Use this to prevent unexpected concurrent modification of the policy.
" - } } }, "traits": { - "smithy.api#input": {} + "smithy.api#documentation": "Provides information about the member who will receive trained model exports.
" + } + }, + "com.amazonaws.cleanroomsml#TrainedModelExportReceiverMembers": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanroomsml#TrainedModelExportReceiverMember" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } } }, - "com.amazonaws.cleanroomsml#PutConfiguredAudienceModelPolicyResponse": { + "com.amazonaws.cleanroomsml#TrainedModelExportsConfigurationPolicy": { "type": "structure", "members": { - "configuredAudienceModelPolicy": { - "target": "com.amazonaws.cleanroomsml#ResourcePolicy", + "maxSize": { + "target": "com.amazonaws.cleanroomsml#TrainedModelExportsMaxSize", "traits": { - "smithy.api#documentation": "The IAM resource policy.
", + "smithy.api#documentation": "The maximum size of the data that can be exported.
", "smithy.api#required": {} } }, - "policyHash": { - "target": "com.amazonaws.cleanroomsml#Hash", + "filesToExport": { + "target": "com.amazonaws.cleanroomsml#TrainedModelExportFileTypeList", "traits": { - "smithy.api#documentation": "A cryptographic hash of the contents of the policy used to prevent unexpected concurrent modification of the policy.
", + "smithy.api#documentation": "The files that are exported during the trained model export job.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#output": {} + "smithy.api#documentation": "Information about how the trained model exports are configured.
" } }, - "com.amazonaws.cleanroomsml#RelevanceMetric": { + "com.amazonaws.cleanroomsml#TrainedModelExportsMaxSize": { "type": "structure", "members": { - "audienceSize": { - "target": "com.amazonaws.cleanroomsml#AudienceSize", + "unit": { + "target": "com.amazonaws.cleanroomsml#TrainedModelExportsMaxSizeUnitType", "traits": { + "smithy.api#documentation": "The unit of measurement for the data size.
", "smithy.api#required": {} } }, - "score": { - "target": "smithy.api#Double", + "value": { + "target": "com.amazonaws.cleanroomsml#TrainedModelExportsMaxSizeValue", "traits": { - "smithy.api#documentation": "The relevance score of the generated audience.
" + "smithy.api#documentation": "The maximum size of the dataset to export.
", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "The relevance score of a generated audience.
" - } - }, - "com.amazonaws.cleanroomsml#RelevanceMetrics": { - "type": "list", - "member": { - "target": "com.amazonaws.cleanroomsml#RelevanceMetric" - } - }, - "com.amazonaws.cleanroomsml#ResourceDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 255 - }, - "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\t\\r\\n]*$" + "smithy.api#documentation": "The maximum size of the trained model metrics that can be exported. If the trained model metrics dataset is larger than this value, it will not be exported.
" } }, - "com.amazonaws.cleanroomsml#ResourceNotFoundException": { - "type": "structure", + "com.amazonaws.cleanroomsml#TrainedModelExportsMaxSizeUnitType": { + "type": "enum", "members": { - "message": { - "target": "smithy.api#String", + "GB": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#required": {} + "smithy.api#enumValue": "GB" } } - }, - "traits": { - "smithy.api#documentation": "The resource you are requesting does not exist.
", - "smithy.api#error": "client", - "smithy.api#httpError": 404 } }, - "com.amazonaws.cleanroomsml#ResourcePolicy": { - "type": "string", + "com.amazonaws.cleanroomsml#TrainedModelExportsMaxSizeValue": { + "type": "double", "traits": { - "smithy.api#length": { - "min": 1, - "max": 20480 + "smithy.api#range": { + "min": 0.01, + "max": 10.0 } } }, - "com.amazonaws.cleanroomsml#S3ConfigMap": { - "type": "structure", - "members": { - "s3Uri": { - "target": "com.amazonaws.cleanroomsml#S3Path", - "traits": { - "smithy.api#documentation": "The Amazon S3 location URI.
", - "smithy.api#required": {} - } + "com.amazonaws.cleanroomsml#TrainedModelInferenceJob": { + "type": "resource", + "identifiers": { + "trainedModelInferenceJobArn": { + "target": "com.amazonaws.cleanroomsml#TrainedModelInferenceJobArn" } }, + "create": { + "target": "com.amazonaws.cleanroomsml#StartTrainedModelInferenceJob" + }, + "read": { + "target": "com.amazonaws.cleanroomsml#GetTrainedModelInferenceJob" + }, + "list": { + "target": "com.amazonaws.cleanroomsml#ListTrainedModelInferenceJobs" + }, + "operations": [ + { + "target": "com.amazonaws.cleanroomsml#CancelTrainedModelInferenceJob" + } + ], "traits": { - "smithy.api#documentation": "Provides information about an Amazon S3 bucket and path.
" + "aws.api#arn": { + "template": "{trainedModelInferenceJobArn}", + "absolute": true + } } }, - "com.amazonaws.cleanroomsml#S3Path": { + "com.amazonaws.cleanroomsml#TrainedModelInferenceJobArn": { "type": "string", "traits": { + "aws.api#arnReference": { + "service": "com.amazonaws.cleanroomsml#AWSStarkControlService", + "resource": "com.amazonaws.cleanroomsml#TrainedModelInferenceJob" + }, "smithy.api#length": { - "min": 1, - "max": 1285 + "min": 20, + "max": 2048 }, - "smithy.api#pattern": "^s3://.+$" + "smithy.api#pattern": "^arn:aws[-a-z]*:cleanrooms-ml:[-a-z0-9]+:[0-9]{12}:(membership/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/)?trained-model-inference-job/[-a-zA-Z0-9_/.]+$" } }, - "com.amazonaws.cleanroomsml#ServiceQuotaExceededException": { - "type": "structure", - "members": { - "message": { - "target": "smithy.api#String", - "traits": { - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "You have exceeded your service quota.
", - "smithy.api#error": "client", - "smithy.api#httpError": 402 + "com.amazonaws.cleanroomsml#TrainedModelInferenceJobList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanroomsml#TrainedModelInferenceJobSummary" } }, - "com.amazonaws.cleanroomsml#SharedAudienceMetrics": { + "com.amazonaws.cleanroomsml#TrainedModelInferenceJobStatus": { "type": "enum", "members": { - "ALL": { + "CREATE_PENDING": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "ALL" + "smithy.api#enumValue": "CREATE_PENDING" } }, - "NONE": { + "CREATE_IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "NONE" + "smithy.api#enumValue": "CREATE_IN_PROGRESS" } - } - } - }, - "com.amazonaws.cleanroomsml#StartAudienceExportJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.cleanroomsml#StartAudienceExportJobRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.cleanroomsml#AccessDeniedException" }, - { - "target": "com.amazonaws.cleanroomsml#ConflictException" + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FAILED" + } }, - { - "target": "com.amazonaws.cleanroomsml#ResourceNotFoundException" + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } }, - { - "target": "com.amazonaws.cleanroomsml#ServiceQuotaExceededException" + "CANCEL_PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCEL_PENDING" + } }, - { - "target": "com.amazonaws.cleanroomsml#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Export an audience of a specified size after you have generated an audience.
", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/audience-export-job" + "CANCEL_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCEL_IN_PROGRESS" + } }, - "smithy.api#idempotent": {} + "CANCEL_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCEL_FAILED" + } + }, + "INACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INACTIVE" + } + } } }, - "com.amazonaws.cleanroomsml#StartAudienceExportJobRequest": { + "com.amazonaws.cleanroomsml#TrainedModelInferenceJobSummary": { "type": "structure", "members": { - "name": { - "target": "com.amazonaws.cleanroomsml#NameString", + "trainedModelInferenceJobArn": { + "target": "com.amazonaws.cleanroomsml#TrainedModelInferenceJobArn", "traits": { - "smithy.api#documentation": "The name of the audience export job.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the trained model inference job.
", "smithy.api#required": {} } }, - "audienceGenerationJobArn": { - "target": "com.amazonaws.cleanroomsml#AudienceGenerationJobArn", + "configuredModelAlgorithmAssociationArn": { + "target": "com.amazonaws.cleanroomsml#ConfiguredModelAlgorithmAssociationArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the audience generation job that you want to export.
", - "smithy.api#required": {} + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the configured model algorithm association that is used for the trained model inference job.
" } }, - "audienceSize": { - "target": "com.amazonaws.cleanroomsml#AudienceSize", + "membershipIdentifier": { + "target": "com.amazonaws.cleanroomsml#UUID", "traits": { + "smithy.api#documentation": "The membership ID of the membership that contains the trained model inference job.
", "smithy.api#required": {} } }, - "description": { - "target": "com.amazonaws.cleanroomsml#ResourceDescription", + "trainedModelArn": { + "target": "com.amazonaws.cleanroomsml#TrainedModelArn", "traits": { - "smithy.api#documentation": "The description of the audience export job.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the trained model that is used for the trained model inference job.
", + "smithy.api#required": {} } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cleanroomsml#StartAudienceGenerationJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.cleanroomsml#StartAudienceGenerationJobRequest" - }, - "output": { - "target": "com.amazonaws.cleanroomsml#StartAudienceGenerationJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cleanroomsml#AccessDeniedException" - }, - { - "target": "com.amazonaws.cleanroomsml#ConflictException" }, - { - "target": "com.amazonaws.cleanroomsml#ResourceNotFoundException" + "collaborationIdentifier": { + "target": "com.amazonaws.cleanroomsml#UUID", + "traits": { + "smithy.api#documentation": "The collaboration ID of the collaboration that contains the trained model inference job.
", + "smithy.api#required": {} + } }, - { - "target": "com.amazonaws.cleanroomsml#ServiceQuotaExceededException" + "status": { + "target": "com.amazonaws.cleanroomsml#TrainedModelInferenceJobStatus", + "traits": { + "smithy.api#documentation": "The status of the trained model inference job.
", + "smithy.api#required": {} + } }, - { - "target": "com.amazonaws.cleanroomsml#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Information necessary to start the audience generation job.
", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/audience-generation-job" + "outputConfiguration": { + "target": "com.amazonaws.cleanroomsml#InferenceOutputConfiguration", + "traits": { + "smithy.api#documentation": "The output configuration information of the trained model job.
", + "smithy.api#required": {} + } }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.cleanroomsml#StartAudienceGenerationJobRequest": { - "type": "structure", - "members": { "name": { "target": "com.amazonaws.cleanroomsml#NameString", "traits": { - "smithy.api#documentation": "The name of the audience generation job.
", + "smithy.api#documentation": "The name of the trained model inference job.
", "smithy.api#required": {} } }, - "configuredAudienceModelArn": { - "target": "com.amazonaws.cleanroomsml#ConfiguredAudienceModelArn", + "description": { + "target": "com.amazonaws.cleanroomsml#ResourceDescription", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the configured audience model that is used for this audience generation job.
", - "smithy.api#required": {} + "smithy.api#documentation": "The description of the trained model inference job.
" } }, - "seedAudience": { - "target": "com.amazonaws.cleanroomsml#AudienceGenerationJobDataSource", + "metricsStatus": { + "target": "com.amazonaws.cleanroomsml#MetricsStatus", "traits": { - "smithy.api#documentation": "The seed audience that is used to generate the audience.
", - "smithy.api#required": {} + "smithy.api#documentation": "The metric status of the trained model inference job.
" } }, - "includeSeedInOutput": { - "target": "smithy.api#Boolean", + "metricsStatusDetails": { + "target": "smithy.api#String", "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "Whether the seed audience is included in the audience generation output.
" + "smithy.api#documentation": "Details about the metrics status for the trained model inference job.
" } }, - "collaborationId": { - "target": "com.amazonaws.cleanroomsml#UUID", + "logsStatus": { + "target": "com.amazonaws.cleanroomsml#LogsStatus", + "traits": { + "smithy.api#documentation": "The log status of the trained model inference job.
" + } + }, + "logsStatusDetails": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The identifier of the collaboration that contains the audience generation job.
" + "smithy.api#documentation": "Details about the log status for the trained model inference job.
" } }, - "description": { - "target": "com.amazonaws.cleanroomsml#ResourceDescription", + "createTime": { + "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "The description of the audience generation job.
" + "smithy.api#documentation": "The time at which the trained model inference job was created.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" } }, - "tags": { - "target": "com.amazonaws.cleanroomsml#TagMap", + "updateTime": { + "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "The optional metadata that you apply to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50.
\nFor each resource, each tag key must be unique, and each tag key can have only one value.
\nMaximum key length - 128 Unicode characters in UTF-8.
\nMaximum value length - 256 Unicode characters in UTF-8.
\nIf your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms ML considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.
\nThe most recent time at which the trained model inference job was updated.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" } } }, "traits": { - "smithy.api#input": {} + "smithy.api#documentation": "Provides information about the trained model inference job.
" } }, - "com.amazonaws.cleanroomsml#StartAudienceGenerationJobResponse": { + "com.amazonaws.cleanroomsml#TrainedModelInferenceJobsConfigurationPolicy": { "type": "structure", "members": { - "audienceGenerationJobArn": { - "target": "com.amazonaws.cleanroomsml#AudienceGenerationJobArn", + "containerLogs": { + "target": "com.amazonaws.cleanroomsml#LogsConfigurationPolicyList", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the audience generation job.
", - "smithy.api#required": {} + "smithy.api#documentation": "The logs container for the trained model inference job.
" + } + }, + "maxOutputSize": { + "target": "com.amazonaws.cleanroomsml#TrainedModelInferenceMaxOutputSize", + "traits": { + "smithy.api#documentation": "The maximum allowed size of the output of the trained model inference job.
" } } }, "traits": { - "smithy.api#output": {} + "smithy.api#documentation": "Provides configuration information for the trained model inference job.
" } }, - "com.amazonaws.cleanroomsml#StatusDetails": { + "com.amazonaws.cleanroomsml#TrainedModelInferenceMaxOutputSize": { "type": "structure", "members": { - "statusCode": { - "target": "smithy.api#String", + "unit": { + "target": "com.amazonaws.cleanroomsml#TrainedModelInferenceMaxOutputSizeUnitType", "traits": { - "smithy.api#documentation": "The status code that was returned. The status code is intended for programmatic error handling. Clean Rooms ML will not change the status code for existing error conditions.
" + "smithy.api#documentation": "The measurement unit to use.
", + "smithy.api#required": {} } }, - "message": { - "target": "smithy.api#String", + "value": { + "target": "com.amazonaws.cleanroomsml#TrainedModelInferenceMaxOutputSizeValue", "traits": { - "smithy.api#documentation": "The error message that was returned. The message is intended for human consumption and can change at any time. Use the statusCode for programmatic error handling.
The maximum output size value.
", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Details about the status of a resource.
" + "smithy.api#documentation": "Information about the maximum output size for a trained model inference job.
" } }, - "com.amazonaws.cleanroomsml#TagKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 + "com.amazonaws.cleanroomsml#TrainedModelInferenceMaxOutputSizeUnitType": { + "type": "enum", + "members": { + "GB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GB" + } } } }, - "com.amazonaws.cleanroomsml#TagKeys": { - "type": "list", - "member": { - "target": "com.amazonaws.cleanroomsml#TagKey" - }, + "com.amazonaws.cleanroomsml#TrainedModelInferenceMaxOutputSizeValue": { + "type": "double", "traits": { - "smithy.api#length": { - "min": 0, - "max": 200 + "smithy.api#range": { + "min": 0.01, + "max": 10.0 } } }, - "com.amazonaws.cleanroomsml#TagMap": { - "type": "map", - "key": { - "target": "com.amazonaws.cleanroomsml#TagKey" - }, - "value": { - "target": "com.amazonaws.cleanroomsml#TagValue" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 200 - } + "com.amazonaws.cleanroomsml#TrainedModelList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanroomsml#TrainedModelSummary" } }, - "com.amazonaws.cleanroomsml#TagOnCreatePolicy": { + "com.amazonaws.cleanroomsml#TrainedModelStatus": { "type": "enum", "members": { - "FROM_PARENT_RESOURCE": { + "CREATE_PENDING": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "FROM_PARENT_RESOURCE" + "smithy.api#enumValue": "CREATE_PENDING" } }, - "NONE": { + "CREATE_IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "NONE" + "smithy.api#enumValue": "CREATE_IN_PROGRESS" } - } - } - }, - "com.amazonaws.cleanroomsml#TagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.cleanroomsml#TagResourceRequest" - }, - "output": { - "target": "com.amazonaws.cleanroomsml#TagResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.cleanroomsml#AccessDeniedException" }, - { - "target": "com.amazonaws.cleanroomsml#ResourceNotFoundException" + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FAILED" + } }, - { - "target": "com.amazonaws.cleanroomsml#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Adds metadata tags to a specified resource.
", - "smithy.api#http": { - "method": "POST", - "uri": "/tags/{resourceArn}" + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "DELETE_PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_PENDING" + } + }, + "DELETE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_IN_PROGRESS" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_FAILED" + } + }, + "INACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INACTIVE" + } + }, + "CANCEL_PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCEL_PENDING" + } + }, + "CANCEL_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCEL_IN_PROGRESS" + } + }, + "CANCEL_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCEL_FAILED" + } } } }, - "com.amazonaws.cleanroomsml#TagResourceRequest": { + "com.amazonaws.cleanroomsml#TrainedModelSummary": { "type": "structure", "members": { - "resourceArn": { - "target": "com.amazonaws.cleanroomsml#TaggableArn", + "createTime": { + "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource that you want to assign tags.
", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "The time at which the trained model was created.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "updateTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The most recent time at which the trained model was updated.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "trainedModelArn": { + "target": "com.amazonaws.cleanroomsml#TrainedModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the trained model.
", "smithy.api#required": {} } }, - "tags": { - "target": "com.amazonaws.cleanroomsml#TagMap", + "name": { + "target": "com.amazonaws.cleanroomsml#NameString", "traits": { - "smithy.api#documentation": "The optional metadata that you apply to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50.
\nFor each resource, each tag key must be unique, and each tag key can have only one value.
\nMaximum key length - 128 Unicode characters in UTF-8.
\nMaximum value length - 256 Unicode characters in UTF-8.
\nIf your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.
\nThe name of the trained model.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.cleanroomsml#ResourceDescription", + "traits": { + "smithy.api#documentation": "The description of the trained model.
" + } + }, + "membershipIdentifier": { + "target": "com.amazonaws.cleanroomsml#UUID", + "traits": { + "smithy.api#documentation": "The membership ID of the member that created the trained model.
", + "smithy.api#required": {} + } + }, + "collaborationIdentifier": { + "target": "com.amazonaws.cleanroomsml#UUID", + "traits": { + "smithy.api#documentation": "The collaboration ID of the collaboration that contains the trained model.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.cleanroomsml#TrainedModelStatus", + "traits": { + "smithy.api#documentation": "The status of the trained model.
", + "smithy.api#required": {} + } + }, + "configuredModelAlgorithmAssociationArn": { + "target": "com.amazonaws.cleanroomsml#ConfiguredModelAlgorithmAssociationArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the configured model algorithm association that was used to create this trained model.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#input": {} + "smithy.api#documentation": "Summary information about the trained model.
" } }, - "com.amazonaws.cleanroomsml#TagResourceResponse": { + "com.amazonaws.cleanroomsml#TrainedModelsConfigurationPolicy": { "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cleanroomsml#TagValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 + "members": { + "containerLogs": { + "target": "com.amazonaws.cleanroomsml#LogsConfigurationPolicyList", + "traits": { + "smithy.api#documentation": "The container for the logs of the trained model.
" + } + }, + "containerMetrics": { + "target": "com.amazonaws.cleanroomsml#MetricsConfigurationPolicy", + "traits": { + "smithy.api#documentation": "The container for the metrics of the trained model.
" + } } - } - }, - "com.amazonaws.cleanroomsml#TaggableArn": { - "type": "string", + }, "traits": { - "aws.api#arnReference": { - "service": "com.amazonaws.cleanroomsml#AWSStarkControlService" - }, - "smithy.api#length": { - "min": 20, - "max": 2048 - }, - "smithy.api#pattern": "^arn:aws[-a-z]*:cleanrooms-ml:[-a-z0-9]+:[0-9]{12}:(training-dataset|audience-model|configured-audience-model|audience-generation-job)/[-a-zA-Z0-9_/.]+$" + "smithy.api#documentation": "The configuration policy for the trained models.
" } }, "com.amazonaws.cleanroomsml#TrainingDataset": { @@ -4352,6 +11122,49 @@ "smithy.api#error": "client", "smithy.api#httpError": 400 } + }, + "com.amazonaws.cleanroomsml#WorkerComputeConfiguration": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.cleanroomsml#WorkerComputeType", + "traits": { + "smithy.api#default": "CR.1X", + "smithy.api#documentation": "The instance type of the compute workers that are used.
" + } + }, + "number": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#default": 16, + "smithy.api#documentation": "The number of compute workers that are used.
", + "smithy.api#range": { + "min": 2, + "max": 400 + } + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration information about the compute workers that perform the transform job.
" + } + }, + "com.amazonaws.cleanroomsml#WorkerComputeType": { + "type": "enum", + "members": { + "CR1X": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CR.1X" + } + }, + "CR4X": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CR.4X" + } + } + } } } }