import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * Manages an AWS SageMaker AI Hyper Parameter Tuning Job. * * > **NOTE:** This resource does not wait for the tuning job to complete before returning. Terraform may complete apply before the job reaches a terminal state. * * ## Example Usage * * ### Basic Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as aws from "@pulumi/aws"; * * const example = new aws.sagemaker.HyperParameterTuningJob("example", { * config: { * objective: { * metricName: "test:msd", * type: "Minimize", * }, * parameterRanges: { * categoricalParameterRanges: [{ * name: "init_method", * values: [ * "kmeans++", * "random", * ], * }], * integerParameterRanges: [ * { * name: "epochs", * minValue: "1", * maxValue: "10", * scalingType: "Auto", * }, * { * name: "extra_center_factor", * minValue: "4", * maxValue: "10", * scalingType: "Auto", * }, * { * name: "mini_batch_size", * minValue: "3000", * maxValue: "15000", * scalingType: "Auto", * }, * ], * }, * resourceLimits: { * maxNumberOfTrainingJobs: 2, * maxParallelTrainingJobs: 1, * }, * strategy: "Bayesian", * }, * trainingJobDefinition: { * algorithmSpecification: { * trainingImage: "174872318107.dkr.ecr.us-west-2.amazonaws.com/kmeans:1", * trainingInputMode: "File", * }, * outputDataConfig: { * s3OutputPath: "s3://example-bucket/output/", * }, * resourceConfig: { * instanceCount: 1, * instanceType: "ml.m5.large", * volumeSizeInGb: 30, * }, * stoppingCondition: { * maxRuntimeInSeconds: 3600, * }, * inputDataConfigs: [ * { * dataSource: { * s3DataSource: { * s3DataType: "S3Prefix", * s3Uri: "s3://example-bucket/input/", * }, * }, * channelName: "train", * contentType: "text/csv", * inputMode: "File", * }, * { * dataSource: { * s3DataSource: { * s3DataType: "S3Prefix", * s3Uri: "s3://example-bucket/input/", * }, * }, * channelName: "test", * contentType: "text/csv", * inputMode: "File", * }, * ], * roleArn: "arn:aws:iam::123456789012:role/example-sagemaker-execution-role", * staticHyperParameters: { * feature_dim: "3", * k: "2", * }, * }, * name: "example", * }); * ``` * * ## Import * * ### Identity Schema * * #### Required * * * `name` (String) Name of the Hyper Parameter Tuning Job. * * #### Optional * * * `accountId` (String) AWS Account where this resource is managed. * * `region` (String) Region where this resource is managed. * * Using `pulumi import`, import SageMaker AI Hyper Parameter Tuning Jobs using `name`. For example: * * ```sh * $ pulumi import aws:sagemaker/hyperParameterTuningJob:HyperParameterTuningJob example example-hyper-parameter-tuning-job * ``` */ export declare class HyperParameterTuningJob extends pulumi.CustomResource { /** * Get an existing HyperParameterTuningJob resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: HyperParameterTuningJobState, opts?: pulumi.CustomResourceOptions): HyperParameterTuningJob; /** * Returns true if the given object is an instance of HyperParameterTuningJob. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is HyperParameterTuningJob; /** * ARN of the Hyper Parameter Tuning Job. */ readonly arn: pulumi.Output; /** * Autotune settings. See `autotune`. */ readonly autotune: pulumi.Output; /** * Tuning job settings. See `config`. */ readonly config: pulumi.Output; /** * Reason returned by SageMaker AI when a job fails. */ readonly failureReason: pulumi.Output; /** * Name of the tuning job. * * The following arguments are optional: */ readonly name: pulumi.Output; /** * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration. */ readonly region: pulumi.Output; /** * Current tuning job status. */ readonly status: pulumi.Output; /** * Map of tags to assign to this resource. */ readonly tags: pulumi.Output<{ [key: string]: string; } | undefined>; /** * Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block. */ readonly tagsAll: pulumi.Output<{ [key: string]: string; }>; readonly timeouts: pulumi.Output; /** * Single training job definition for tuning. See `trainingJobDefinition`. */ readonly trainingJobDefinition: pulumi.Output; /** * Multiple training job definitions for tuning. See `trainingJobDefinition`. */ readonly trainingJobDefinitions: pulumi.Output; /** * Warm start settings. See `warmStartConfig`. */ readonly warmStartConfig: pulumi.Output; /** * Create a HyperParameterTuningJob resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: HyperParameterTuningJobArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering HyperParameterTuningJob resources. */ export interface HyperParameterTuningJobState { /** * ARN of the Hyper Parameter Tuning Job. */ arn?: pulumi.Input; /** * Autotune settings. See `autotune`. */ autotune?: pulumi.Input; /** * Tuning job settings. See `config`. */ config?: pulumi.Input; /** * Reason returned by SageMaker AI when a job fails. */ failureReason?: pulumi.Input; /** * Name of the tuning job. * * The following arguments are optional: */ name?: pulumi.Input; /** * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration. */ region?: pulumi.Input; /** * Current tuning job status. */ status?: pulumi.Input; /** * Map of tags to assign to this resource. */ tags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block. */ tagsAll?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; timeouts?: pulumi.Input; /** * Single training job definition for tuning. See `trainingJobDefinition`. */ trainingJobDefinition?: pulumi.Input; /** * Multiple training job definitions for tuning. See `trainingJobDefinition`. */ trainingJobDefinitions?: pulumi.Input[] | undefined>; /** * Warm start settings. See `warmStartConfig`. */ warmStartConfig?: pulumi.Input; } /** * The set of arguments for constructing a HyperParameterTuningJob resource. */ export interface HyperParameterTuningJobArgs { /** * Autotune settings. See `autotune`. */ autotune?: pulumi.Input; /** * Tuning job settings. See `config`. */ config: pulumi.Input; /** * Name of the tuning job. * * The following arguments are optional: */ name?: pulumi.Input; /** * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration. */ region?: pulumi.Input; /** * Map of tags to assign to this resource. */ tags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; timeouts?: pulumi.Input; /** * Single training job definition for tuning. See `trainingJobDefinition`. */ trainingJobDefinition?: pulumi.Input; /** * Multiple training job definitions for tuning. See `trainingJobDefinition`. */ trainingJobDefinitions?: pulumi.Input[] | undefined>; /** * Warm start settings. See `warmStartConfig`. */ warmStartConfig?: pulumi.Input; } //# sourceMappingURL=hyperParameterTuningJob.d.ts.map