@aws-sdk/client-cleanroomsml 3.462.0

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

@@ -0,0 +1,453 @@
+import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
+import { CleanRoomsMLServiceException as __BaseException } from "./CleanRoomsMLServiceException";
+export declare class AccessDeniedException extends __BaseException {
+  readonly name: "AccessDeniedException";
+  readonly $fault: "client";
+  constructor(
+    opts: __ExceptionOptionType<AccessDeniedException, __BaseException>
+  );
+}
+export interface S3ConfigMap {
+  s3Uri: string | undefined;
+}
+export interface AudienceDestination {
+  s3Destination: S3ConfigMap | undefined;
+}
+export interface ListAudienceExportJobsRequest {
+  nextToken?: string;
+  maxResults?: number;
+  audienceGenerationJobArn?: string;
+}
+export declare const AudienceSizeType: {
+  readonly ABSOLUTE: "ABSOLUTE";
+  readonly PERCENTAGE: "PERCENTAGE";
+};
+export type AudienceSizeType =
+  (typeof AudienceSizeType)[keyof typeof AudienceSizeType];
+export interface AudienceSize {
+  type: AudienceSizeType | undefined;
+  value: number | undefined;
+}
+export declare const AudienceExportJobStatus: {
+  readonly ACTIVE: "ACTIVE";
+  readonly CREATE_FAILED: "CREATE_FAILED";
+  readonly CREATE_IN_PROGRESS: "CREATE_IN_PROGRESS";
+  readonly CREATE_PENDING: "CREATE_PENDING";
+};
+export type AudienceExportJobStatus =
+  (typeof AudienceExportJobStatus)[keyof typeof AudienceExportJobStatus];
+export interface StatusDetails {
+  statusCode?: string;
+  message?: string;
+}
+export interface AudienceExportJobSummary {
+  createTime: Date | undefined;
+  updateTime: Date | undefined;
+  name: string | undefined;
+  audienceGenerationJobArn: string | undefined;
+  audienceSize: AudienceSize | undefined;
+  description?: string;
+  status: AudienceExportJobStatus | undefined;
+  statusDetails?: StatusDetails;
+  outputLocation?: string;
+}
+export interface ListAudienceExportJobsResponse {
+  nextToken?: string;
+  audienceExportJobs: AudienceExportJobSummary[] | undefined;
+}
+export declare class ValidationException extends __BaseException {
+  readonly name: "ValidationException";
+  readonly $fault: "client";
+  constructor(
+    opts: __ExceptionOptionType<ValidationException, __BaseException>
+  );
+}
+export declare class ConflictException extends __BaseException {
+  readonly name: "ConflictException";
+  readonly $fault: "client";
+  constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
+}
+export declare class ResourceNotFoundException extends __BaseException {
+  readonly name: "ResourceNotFoundException";
+  readonly $fault: "client";
+  constructor(
+    opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>
+  );
+}
+export declare class ServiceQuotaExceededException extends __BaseException {
+  readonly name: "ServiceQuotaExceededException";
+  readonly $fault: "client";
+  constructor(
+    opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>
+  );
+}
+export interface StartAudienceExportJobRequest {
+  name: string | undefined;
+  audienceGenerationJobArn: string | undefined;
+  audienceSize: AudienceSize | undefined;
+  description?: string;
+}
+export interface DeleteAudienceGenerationJobRequest {
+  audienceGenerationJobArn: string | undefined;
+}
+export interface GetAudienceGenerationJobRequest {
+  audienceGenerationJobArn: string | undefined;
+}
+export interface RelevanceMetric {
+  audienceSize: AudienceSize | undefined;
+  score?: number;
+}
+export interface AudienceQualityMetrics {
+  relevanceMetrics: RelevanceMetric[] | undefined;
+}
+export interface AudienceGenerationJobDataSource {
+  dataSource: S3ConfigMap | undefined;
+  roleArn: string | undefined;
+}
+export declare const AudienceGenerationJobStatus: {
+  readonly ACTIVE: "ACTIVE";
+  readonly CREATE_FAILED: "CREATE_FAILED";
+  readonly CREATE_IN_PROGRESS: "CREATE_IN_PROGRESS";
+  readonly CREATE_PENDING: "CREATE_PENDING";
+  readonly DELETE_FAILED: "DELETE_FAILED";
+  readonly DELETE_IN_PROGRESS: "DELETE_IN_PROGRESS";
+  readonly DELETE_PENDING: "DELETE_PENDING";
+};
+export type AudienceGenerationJobStatus =
+  (typeof AudienceGenerationJobStatus)[keyof typeof AudienceGenerationJobStatus];
+export interface GetAudienceGenerationJobResponse {
+  createTime: Date | undefined;
+  updateTime: Date | undefined;
+  audienceGenerationJobArn: string | undefined;
+  name: string | undefined;
+  description?: string;
+  status: AudienceGenerationJobStatus | undefined;
+  statusDetails?: StatusDetails;
+  configuredAudienceModelArn: string | undefined;
+  seedAudience?: AudienceGenerationJobDataSource;
+  includeSeedInOutput?: boolean;
+  collaborationId?: string;
+  metrics?: AudienceQualityMetrics;
+  startedBy?: string;
+  tags?: Record<string, string>;
+}
+export interface ListAudienceGenerationJobsRequest {
+  nextToken?: string;
+  maxResults?: number;
+  configuredAudienceModelArn?: string;
+  collaborationId?: string;
+}
+export interface AudienceGenerationJobSummary {
+  createTime: Date | undefined;
+  updateTime: Date | undefined;
+  audienceGenerationJobArn: string | undefined;
+  name: string | undefined;
+  description?: string;
+  status: AudienceGenerationJobStatus | undefined;
+  configuredAudienceModelArn: string | undefined;
+  collaborationId?: string;
+  startedBy?: string;
+}
+export interface ListAudienceGenerationJobsResponse {
+  nextToken?: string;
+  audienceGenerationJobs: AudienceGenerationJobSummary[] | undefined;
+}
+export interface StartAudienceGenerationJobRequest {
+  name: string | undefined;
+  configuredAudienceModelArn: string | undefined;
+  seedAudience: AudienceGenerationJobDataSource | undefined;
+  includeSeedInOutput?: boolean;
+  collaborationId?: string;
+  description?: string;
+  tags?: Record<string, string>;
+}
+export interface StartAudienceGenerationJobResponse {
+  audienceGenerationJobArn: string | undefined;
+}
+export interface CreateAudienceModelRequest {
+  trainingDataStartTime?: Date;
+  trainingDataEndTime?: Date;
+  name: string | undefined;
+  trainingDatasetArn: string | undefined;
+  kmsKeyArn?: string;
+  tags?: Record<string, string>;
+  description?: string;
+}
+export interface CreateAudienceModelResponse {
+  audienceModelArn: string | undefined;
+}
+export interface DeleteAudienceModelRequest {
+  audienceModelArn: string | undefined;
+}
+export interface GetAudienceModelRequest {
+  audienceModelArn: string | undefined;
+}
+export declare const AudienceModelMetricType: {
+  readonly MEAN_RECIPROCAL_RANK: "MEAN_RECIPROCAL_RANK";
+  readonly NORMALIZED_DISCOUNTED_CUMULATIVE_GAIN: "NORMALIZED_DISCOUNTED_CUMULATIVE_GAIN";
+  readonly PRECISION: "PRECISION";
+  readonly RECALL: "RECALL";
+};
+export type AudienceModelMetricType =
+  (typeof AudienceModelMetricType)[keyof typeof AudienceModelMetricType];
+export interface AudienceModelMetric {
+  type: AudienceModelMetricType | undefined;
+  forTopKItemPredictions: number | undefined;
+  value: number | undefined;
+}
+export declare const AudienceModelStatus: {
+  readonly ACTIVE: "ACTIVE";
+  readonly CREATE_FAILED: "CREATE_FAILED";
+  readonly CREATE_IN_PROGRESS: "CREATE_IN_PROGRESS";
+  readonly CREATE_PENDING: "CREATE_PENDING";
+  readonly DELETE_FAILED: "DELETE_FAILED";
+  readonly DELETE_IN_PROGRESS: "DELETE_IN_PROGRESS";
+  readonly DELETE_PENDING: "DELETE_PENDING";
+};
+export type AudienceModelStatus =
+  (typeof AudienceModelStatus)[keyof typeof AudienceModelStatus];
+export interface GetAudienceModelResponse {
+  createTime: Date | undefined;
+  updateTime: Date | undefined;
+  trainingDataStartTime?: Date;
+  trainingDataEndTime?: Date;
+  audienceModelArn: string | undefined;
+  name: string | undefined;
+  trainingDatasetArn: string | undefined;
+  status: AudienceModelStatus | undefined;
+  statusDetails?: StatusDetails;
+  metrics?: AudienceModelMetric[];
+  kmsKeyArn?: string;
+  tags?: Record<string, string>;
+  description?: string;
+}
+export interface ListAudienceModelsRequest {
+  nextToken?: string;
+  maxResults?: number;
+}
+export interface AudienceModelSummary {
+  createTime: Date | undefined;
+  updateTime: Date | undefined;
+  audienceModelArn: string | undefined;
+  name: string | undefined;
+  trainingDatasetArn: string | undefined;
+  status: AudienceModelStatus | undefined;
+  description?: string;
+}
+export interface ListAudienceModelsResponse {
+  nextToken?: string;
+  audienceModels: AudienceModelSummary[] | undefined;
+}
+export interface AudienceSizeConfig {
+  audienceSizeType: AudienceSizeType | undefined;
+  audienceSizeBins: number[] | undefined;
+}
+export declare const TagOnCreatePolicy: {
+  readonly FROM_PARENT_RESOURCE: "FROM_PARENT_RESOURCE";
+  readonly NONE: "NONE";
+};
+export type TagOnCreatePolicy =
+  (typeof TagOnCreatePolicy)[keyof typeof TagOnCreatePolicy];
+export interface ConfiguredAudienceModelOutputConfig {
+  destination: AudienceDestination | undefined;
+  roleArn: string | undefined;
+}
+export declare const SharedAudienceMetrics: {
+  readonly ALL: "ALL";
+  readonly NONE: "NONE";
+};
+export type SharedAudienceMetrics =
+  (typeof SharedAudienceMetrics)[keyof typeof SharedAudienceMetrics];
+export interface CreateConfiguredAudienceModelRequest {
+  name: string | undefined;
+  audienceModelArn: string | undefined;
+  outputConfig: ConfiguredAudienceModelOutputConfig | undefined;
+  description?: string;
+  sharedAudienceMetrics: SharedAudienceMetrics[] | undefined;
+  minMatchingSeedSize?: number;
+  audienceSizeConfig?: AudienceSizeConfig;
+  tags?: Record<string, string>;
+  childResourceTagOnCreatePolicy?: TagOnCreatePolicy;
+}
+export interface CreateConfiguredAudienceModelResponse {
+  configuredAudienceModelArn: string | undefined;
+}
+export interface DeleteConfiguredAudienceModelRequest {
+  configuredAudienceModelArn: string | undefined;
+}
+export interface GetConfiguredAudienceModelRequest {
+  configuredAudienceModelArn: string | undefined;
+}
+export declare const ConfiguredAudienceModelStatus: {
+  readonly ACTIVE: "ACTIVE";
+};
+export type ConfiguredAudienceModelStatus =
+  (typeof ConfiguredAudienceModelStatus)[keyof typeof ConfiguredAudienceModelStatus];
+export interface GetConfiguredAudienceModelResponse {
+  createTime: Date | undefined;
+  updateTime: Date | undefined;
+  configuredAudienceModelArn: string | undefined;
+  name: string | undefined;
+  audienceModelArn: string | undefined;
+  outputConfig: ConfiguredAudienceModelOutputConfig | undefined;
+  description?: string;
+  status: ConfiguredAudienceModelStatus | undefined;
+  sharedAudienceMetrics: SharedAudienceMetrics[] | undefined;
+  minMatchingSeedSize?: number;
+  audienceSizeConfig?: AudienceSizeConfig;
+  tags?: Record<string, string>;
+  childResourceTagOnCreatePolicy?: TagOnCreatePolicy;
+}
+export interface ListConfiguredAudienceModelsRequest {
+  nextToken?: string;
+  maxResults?: number;
+}
+export interface ConfiguredAudienceModelSummary {
+  createTime: Date | undefined;
+  updateTime: Date | undefined;
+  name: string | undefined;
+  audienceModelArn: string | undefined;
+  outputConfig: ConfiguredAudienceModelOutputConfig | undefined;
+  description?: string;
+  configuredAudienceModelArn: string | undefined;
+  status: ConfiguredAudienceModelStatus | undefined;
+}
+export interface ListConfiguredAudienceModelsResponse {
+  nextToken?: string;
+  configuredAudienceModels: ConfiguredAudienceModelSummary[] | undefined;
+}
+export interface UpdateConfiguredAudienceModelRequest {
+  configuredAudienceModelArn: string | undefined;
+  outputConfig?: ConfiguredAudienceModelOutputConfig;
+  audienceModelArn?: string;
+  sharedAudienceMetrics?: SharedAudienceMetrics[];
+  minMatchingSeedSize?: number;
+  audienceSizeConfig?: AudienceSizeConfig;
+  description?: string;
+}
+export interface UpdateConfiguredAudienceModelResponse {
+  configuredAudienceModelArn: string | undefined;
+}
+export interface DeleteConfiguredAudienceModelPolicyRequest {
+  configuredAudienceModelArn: string | undefined;
+}
+export interface GetConfiguredAudienceModelPolicyRequest {
+  configuredAudienceModelArn: string | undefined;
+}
+export interface GetConfiguredAudienceModelPolicyResponse {
+  configuredAudienceModelArn: string | undefined;
+  configuredAudienceModelPolicy: string | undefined;
+  policyHash: string | undefined;
+}
+export declare const PolicyExistenceCondition: {
+  readonly POLICY_MUST_EXIST: "POLICY_MUST_EXIST";
+  readonly POLICY_MUST_NOT_EXIST: "POLICY_MUST_NOT_EXIST";
+};
+export type PolicyExistenceCondition =
+  (typeof PolicyExistenceCondition)[keyof typeof PolicyExistenceCondition];
+export interface PutConfiguredAudienceModelPolicyRequest {
+  configuredAudienceModelArn: string | undefined;
+  configuredAudienceModelPolicy: string | undefined;
+  previousPolicyHash?: string;
+  policyExistenceCondition?: PolicyExistenceCondition;
+}
+export interface PutConfiguredAudienceModelPolicyResponse {
+  configuredAudienceModelPolicy: string | undefined;
+  policyHash: string | undefined;
+}
+export interface ListTagsForResourceRequest {
+  resourceArn: string | undefined;
+}
+export interface ListTagsForResourceResponse {
+  tags: Record<string, string> | undefined;
+}
+export interface TagResourceRequest {
+  resourceArn: string | undefined;
+  tags: Record<string, string> | undefined;
+}
+export interface TagResourceResponse {}
+export interface GlueDataSource {
+  tableName: string | undefined;
+  databaseName: string | undefined;
+  catalogId?: string;
+}
+export interface DataSource {
+  glueDataSource: GlueDataSource | undefined;
+}
+export declare const ColumnType: {
+  readonly CATEGORICAL_FEATURE: "CATEGORICAL_FEATURE";
+  readonly ITEM_ID: "ITEM_ID";
+  readonly NUMERICAL_FEATURE: "NUMERICAL_FEATURE";
+  readonly TIMESTAMP: "TIMESTAMP";
+  readonly USER_ID: "USER_ID";
+};
+export type ColumnType = (typeof ColumnType)[keyof typeof ColumnType];
+export interface ColumnSchema {
+  columnName: string | undefined;
+  columnTypes: ColumnType[] | undefined;
+}
+export interface DatasetInputConfig {
+  schema: ColumnSchema[] | undefined;
+  dataSource: DataSource | undefined;
+}
+export declare const DatasetType: {
+  readonly INTERACTIONS: "INTERACTIONS";
+};
+export type DatasetType = (typeof DatasetType)[keyof typeof DatasetType];
+export interface Dataset {
+  type: DatasetType | undefined;
+  inputConfig: DatasetInputConfig | undefined;
+}
+export interface CreateTrainingDatasetRequest {
+  name: string | undefined;
+  roleArn: string | undefined;
+  trainingData: Dataset[] | undefined;
+  tags?: Record<string, string>;
+  description?: string;
+}
+export interface CreateTrainingDatasetResponse {
+  trainingDatasetArn: string | undefined;
+}
+export interface DeleteTrainingDatasetRequest {
+  trainingDatasetArn: string | undefined;
+}
+export interface GetTrainingDatasetRequest {
+  trainingDatasetArn: string | undefined;
+}
+export declare const TrainingDatasetStatus: {
+  readonly ACTIVE: "ACTIVE";
+};
+export type TrainingDatasetStatus =
+  (typeof TrainingDatasetStatus)[keyof typeof TrainingDatasetStatus];
+export interface GetTrainingDatasetResponse {
+  createTime: Date | undefined;
+  updateTime: Date | undefined;
+  trainingDatasetArn: string | undefined;
+  name: string | undefined;
+  trainingData: Dataset[] | undefined;
+  status: TrainingDatasetStatus | undefined;
+  roleArn: string | undefined;
+  tags?: Record<string, string>;
+  description?: string;
+}
+export interface ListTrainingDatasetsRequest {
+  nextToken?: string;
+  maxResults?: number;
+}
+export interface TrainingDatasetSummary {
+  createTime: Date | undefined;
+  updateTime: Date | undefined;
+  trainingDatasetArn: string | undefined;
+  name: string | undefined;
+  status: TrainingDatasetStatus | undefined;
+  description?: string;
+}
+export interface ListTrainingDatasetsResponse {
+  nextToken?: string;
+  trainingDatasets: TrainingDatasetSummary[] | undefined;
+}
+export interface UntagResourceRequest {
+  resourceArn: string | undefined;
+  tagKeys: string[] | undefined;
+}
+export interface UntagResourceResponse {}

package/dist-types/ts3.4/pagination/Interfaces.d.ts

@@ -0,0 +1,6 @@
+import { PaginationConfiguration } from "@smithy/types";
+import { CleanRoomsMLClient } from "../CleanRoomsMLClient";
+export interface CleanRoomsMLPaginationConfiguration
+  extends PaginationConfiguration {
+  client: CleanRoomsMLClient;
+}

package/dist-types/ts3.4/pagination/ListAudienceExportJobsPaginator.d.ts

@@ -0,0 +1,11 @@
+import { Paginator } from "@smithy/types";
+import {
+  ListAudienceExportJobsCommandInput,
+  ListAudienceExportJobsCommandOutput,
+} from "../commands/ListAudienceExportJobsCommand";
+import { CleanRoomsMLPaginationConfiguration } from "./Interfaces";
+export declare function paginateListAudienceExportJobs(
+  config: CleanRoomsMLPaginationConfiguration,
+  input: ListAudienceExportJobsCommandInput,
+  ...additionalArguments: any
+): Paginator<ListAudienceExportJobsCommandOutput>;

package/dist-types/ts3.4/pagination/ListAudienceGenerationJobsPaginator.d.ts

@@ -0,0 +1,11 @@
+import { Paginator } from "@smithy/types";
+import {
+  ListAudienceGenerationJobsCommandInput,
+  ListAudienceGenerationJobsCommandOutput,
+} from "../commands/ListAudienceGenerationJobsCommand";
+import { CleanRoomsMLPaginationConfiguration } from "./Interfaces";
+export declare function paginateListAudienceGenerationJobs(
+  config: CleanRoomsMLPaginationConfiguration,
+  input: ListAudienceGenerationJobsCommandInput,
+  ...additionalArguments: any
+): Paginator<ListAudienceGenerationJobsCommandOutput>;

package/dist-types/ts3.4/pagination/ListAudienceModelsPaginator.d.ts

@@ -0,0 +1,11 @@
+import { Paginator } from "@smithy/types";
+import {
+  ListAudienceModelsCommandInput,
+  ListAudienceModelsCommandOutput,
+} from "../commands/ListAudienceModelsCommand";
+import { CleanRoomsMLPaginationConfiguration } from "./Interfaces";
+export declare function paginateListAudienceModels(
+  config: CleanRoomsMLPaginationConfiguration,
+  input: ListAudienceModelsCommandInput,
+  ...additionalArguments: any
+): Paginator<ListAudienceModelsCommandOutput>;

package/dist-types/ts3.4/pagination/ListConfiguredAudienceModelsPaginator.d.ts

@@ -0,0 +1,11 @@
+import { Paginator } from "@smithy/types";
+import {
+  ListConfiguredAudienceModelsCommandInput,
+  ListConfiguredAudienceModelsCommandOutput,
+} from "../commands/ListConfiguredAudienceModelsCommand";
+import { CleanRoomsMLPaginationConfiguration } from "./Interfaces";
+export declare function paginateListConfiguredAudienceModels(
+  config: CleanRoomsMLPaginationConfiguration,
+  input: ListConfiguredAudienceModelsCommandInput,
+  ...additionalArguments: any
+): Paginator<ListConfiguredAudienceModelsCommandOutput>;

package/dist-types/ts3.4/pagination/ListTrainingDatasetsPaginator.d.ts

@@ -0,0 +1,11 @@
+import { Paginator } from "@smithy/types";
+import {
+  ListTrainingDatasetsCommandInput,
+  ListTrainingDatasetsCommandOutput,
+} from "../commands/ListTrainingDatasetsCommand";
+import { CleanRoomsMLPaginationConfiguration } from "./Interfaces";
+export declare function paginateListTrainingDatasets(
+  config: CleanRoomsMLPaginationConfiguration,
+  input: ListTrainingDatasetsCommandInput,
+  ...additionalArguments: any
+): Paginator<ListTrainingDatasetsCommandOutput>;

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

@@ -0,0 +1,6 @@
+export * from "./Interfaces";
+export * from "./ListAudienceExportJobsPaginator";
+export * from "./ListAudienceGenerationJobsPaginator";
+export * from "./ListAudienceModelsPaginator";
+export * from "./ListConfiguredAudienceModelsPaginator";
+export * from "./ListTrainingDatasetsPaginator";