Skip to content

Commit

Permalink
feat(client-sagemaker): Amazon SageMaker Studio now supports Docker a…
Browse files Browse the repository at this point in the history
…ccess from within app container
  • Loading branch information
awstools committed Dec 28, 2023
1 parent 5e8a193 commit 16531e4
Show file tree
Hide file tree
Showing 10 changed files with 182 additions and 69 deletions.
6 changes: 6 additions & 0 deletions clients/client-sagemaker/src/commands/CreateDomainCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -246,6 +246,12 @@ export interface CreateDomainCommandOutput extends CreateDomainResponse, __Metad
* DefaultResourceSpec: "<ResourceSpec>",
* },
* ExecutionRoleIdentityConfig: "USER_PROFILE_NAME" || "DISABLED",
* DockerSettings: { // DockerSettings
* EnableDockerAccess: "ENABLED" || "DISABLED",
* VpcOnlyTrustedAccounts: [ // VpcOnlyTrustedAccounts
* "STRING_VALUE",
* ],
* },
* },
* SubnetIds: [ // Subnets // required
* "STRING_VALUE",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -217,6 +217,12 @@ export interface DescribeDomainCommandOutput extends DescribeDomainResponse, __M
* // DefaultResourceSpec: "<ResourceSpec>",
* // },
* // ExecutionRoleIdentityConfig: "USER_PROFILE_NAME" || "DISABLED",
* // DockerSettings: { // DockerSettings
* // EnableDockerAccess: "ENABLED" || "DISABLED",
* // VpcOnlyTrustedAccounts: [ // VpcOnlyTrustedAccounts
* // "STRING_VALUE",
* // ],
* // },
* // },
* // AppNetworkAccessType: "PublicInternetOnly" || "VpcOnly",
* // HomeEfsFileSystemKmsKeyId: "STRING_VALUE",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,7 @@ import { Command as $Command } from "@smithy/smithy-client";
import { MetadataBearer as __MetadataBearer } from "@smithy/types";

import { commonParams } from "../endpoint/EndpointParameters";
import { DescribeTrainingJobRequest } from "../models/models_2";
import { DescribeTrainingJobResponse } from "../models/models_3";
import { DescribeTrainingJobRequest, DescribeTrainingJobResponse } from "../models/models_3";
import { de_DescribeTrainingJobCommand, se_DescribeTrainingJobCommand } from "../protocols/Aws_json1_1";
import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient";

Expand Down
6 changes: 6 additions & 0 deletions clients/client-sagemaker/src/commands/UpdateDomainCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -201,6 +201,12 @@ export interface UpdateDomainCommandOutput extends UpdateDomainResponse, __Metad
* SecurityGroupIds: [ // DomainSecurityGroupIds
* "STRING_VALUE",
* ],
* DockerSettings: { // DockerSettings
* EnableDockerAccess: "ENABLED" || "DISABLED",
* VpcOnlyTrustedAccounts: [ // VpcOnlyTrustedAccounts
* "STRING_VALUE",
* ],
* },
* },
* AppSecurityGroupManagement: "Service" || "Customer",
* DefaultSpaceSettings: { // DefaultSpaceSettings
Expand Down
62 changes: 25 additions & 37 deletions clients/client-sagemaker/src/models/models_1.ts
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ import {
ContextSource,
ContinuousParameterRange,
ConvergenceDetected,
FeatureStatus,
HyperParameterScalingType,
HyperParameterTuningJobObjective,
InferenceSpecification,
Expand Down Expand Up @@ -1275,6 +1276,24 @@ export interface UserSettings {
CustomFileSystemConfigs?: CustomFileSystemConfig[];
}

/**
* @public
* <p>A collection of settings that configure the domain's Docker interaction.</p>
*/
export interface DockerSettings {
/**
* @public
* <p>Indicates whether the domain can access Docker.</p>
*/
EnableDockerAccess?: FeatureStatus;

/**
* @public
* <p>The list of Amazon Web Services accounts that are trusted when the domain is created in VPC-only mode.</p>
*/
VpcOnlyTrustedAccounts?: string[];
}

/**
* @public
* @enum
Expand Down Expand Up @@ -1349,6 +1368,12 @@ export interface DomainSettings {
* <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_monitor.html">sts:SourceIdentity key</a>.</p>
*/
ExecutionRoleIdentityConfig?: ExecutionRoleIdentityConfig;

/**
* @public
* <p>A collection of settings that configure the domain's Docker interaction.</p>
*/
DockerSettings?: DockerSettings;
}

/**
Expand Down Expand Up @@ -11752,43 +11777,6 @@ export interface InfraCheckConfig {
EnableInfraCheck?: boolean;
}

/**
* @public
* <p>Configuration information for Amazon SageMaker Debugger system monitoring, framework profiling, and
* storage paths.</p>
*/
export interface ProfilerConfig {
/**
* @public
* <p>Path to Amazon S3 storage location for system and framework metrics.</p>
*/
S3OutputPath?: string;

/**
* @public
* <p>A time interval for capturing system metrics in milliseconds. Available values are
* 100, 200, 500, 1000 (1 second), 5000 (5 seconds), and 60000 (1 minute) milliseconds. The default value is 500 milliseconds.</p>
*/
ProfilingIntervalInMilliseconds?: number;

/**
* @public
* <p>Configuration information for capturing framework metrics. Available key strings for different profiling options are
* <code>DetailedProfilingConfig</code>, <code>PythonProfilingConfig</code>, and <code>DataLoaderProfilingConfig</code>.
* The following codes are configuration structures for the <code>ProfilingParameters</code> parameter. To learn more about
* how to configure the <code>ProfilingParameters</code> parameter,
* see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/debugger-createtrainingjob-api.html">Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job</a>.
* </p>
*/
ProfilingParameters?: Record<string, string>;

/**
* @public
* <p>Configuration to turn off Amazon SageMaker Debugger's system monitoring and profiling functionality. To turn it off, set to <code>True</code>.</p>
*/
DisableProfiler?: boolean;
}

/**
* @internal
*/
Expand Down
49 changes: 37 additions & 12 deletions clients/client-sagemaker/src/models/models_2.ts
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,6 @@ import {
ProductionVariantManagedInstanceScaling,
ProductionVariantRoutingConfig,
ProductionVariantServerlessConfig,
ProfilerConfig,
RecommendationJobInputConfig,
RecommendationJobStoppingConditions,
RecommendationJobType,
Expand All @@ -176,6 +175,43 @@ import {
VendorGuidance,
} from "./models_1";

/**
* @public
* <p>Configuration information for Amazon SageMaker Debugger system monitoring, framework profiling, and
* storage paths.</p>
*/
export interface ProfilerConfig {
/**
* @public
* <p>Path to Amazon S3 storage location for system and framework metrics.</p>
*/
S3OutputPath?: string;

/**
* @public
* <p>A time interval for capturing system metrics in milliseconds. Available values are
* 100, 200, 500, 1000 (1 second), 5000 (5 seconds), and 60000 (1 minute) milliseconds. The default value is 500 milliseconds.</p>
*/
ProfilingIntervalInMilliseconds?: number;

/**
* @public
* <p>Configuration information for capturing framework metrics. Available key strings for different profiling options are
* <code>DetailedProfilingConfig</code>, <code>PythonProfilingConfig</code>, and <code>DataLoaderProfilingConfig</code>.
* The following codes are configuration structures for the <code>ProfilingParameters</code> parameter. To learn more about
* how to configure the <code>ProfilingParameters</code> parameter,
* see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/debugger-createtrainingjob-api.html">Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job</a>.
* </p>
*/
ProfilingParameters?: Record<string, string>;

/**
* @public
* <p>Configuration to turn off Amazon SageMaker Debugger's system monitoring and profiling functionality. To turn it off, set to <code>True</code>.</p>
*/
DisableProfiler?: boolean;
}

/**
* @public
* <p>Configuration information for profiling rules.</p>
Expand Down Expand Up @@ -10013,17 +10049,6 @@ export interface DescribeSubscribedWorkteamResponse {
SubscribedWorkteam: SubscribedWorkteam | undefined;
}

/**
* @public
*/
export interface DescribeTrainingJobRequest {
/**
* @public
* <p>The name of the training job.</p>
*/
TrainingJobName: string | undefined;
}

/**
* @internal
*/
Expand Down
32 changes: 19 additions & 13 deletions clients/client-sagemaker/src/models/models_3.ts
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ import {
_InstanceType,
DebugHookConfig,
DebugRuleConfiguration,
DockerSettings,
EdgeOutputConfig,
ExecutionRoleIdentityConfig,
ExperimentConfig,
Expand All @@ -71,7 +72,6 @@ import {
MonitoringType,
OfflineStoreConfig,
OnlineStoreConfig,
ProfilerConfig,
RecommendationJobType,
ResourceLimits,
RetryStrategy,
Expand Down Expand Up @@ -122,6 +122,7 @@ import {
OfflineStoreStatusValue,
PipelineExecutionStatus,
ProductionVariantSummary,
ProfilerConfig,
ProfilerRuleConfiguration,
RecommendationJobStatus,
RecommendationMetrics,
Expand All @@ -137,6 +138,17 @@ import {
TrialComponentStatus,
} from "./models_2";

/**
* @public
*/
export interface DescribeTrainingJobRequest {
/**
* @public
* <p>The name of the training job.</p>
*/
TrainingJobName: string | undefined;
}

/**
* @public
* <p>The name, value, and date and time of a metric that was emitted to Amazon CloudWatch.</p>
Expand Down Expand Up @@ -2353,6 +2365,12 @@ export interface DomainSettingsForUpdate {
* communication between Domain-level apps and user apps.</p>
*/
SecurityGroupIds?: string[];

/**
* @public
* <p>A collection of settings that configure the domain's Docker interaction.</p>
*/
DockerSettings?: DockerSettings;
}

/**
Expand Down Expand Up @@ -11104,15 +11122,3 @@ export interface TransformJobStepMetadata {
*/
Arn?: string;
}

/**
* @public
* <p>Metadata for a tuning step.</p>
*/
export interface TuningJobStepMetaData {
/**
* @public
* <p>The Amazon Resource Name (ARN) of the tuning job that was run by this step execution.</p>
*/
Arn?: string;
}
15 changes: 13 additions & 2 deletions clients/client-sagemaker/src/models/models_4.ts
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,6 @@ import {
ProcessingResources,
ProcessingStoppingCondition,
Processor,
ProfilerConfig,
ProvisioningParameter,
RetryStrategy,
RootAccess,
Expand Down Expand Up @@ -113,6 +112,7 @@ import {
PipelineExperimentConfig,
PipelineStatus,
ProcessingJobStatus,
ProfilerConfig,
ProfilerRuleConfiguration,
ProjectStatus,
ScheduleStatus,
Expand Down Expand Up @@ -165,14 +165,25 @@ import {
TrialComponentMetricSummary,
TrialComponentSource,
TrialSource,
TuningJobStepMetaData,
UserProfileStatus,
WarmPoolResourceStatus,
WarmPoolStatus,
Workforce,
Workteam,
} from "./models_3";

/**
* @public
* <p>Metadata for a tuning step.</p>
*/
export interface TuningJobStepMetaData {
/**
* @public
* <p>The Amazon Resource Name (ARN) of the tuning job that was run by this step execution.</p>
*/
Arn?: string;
}

/**
* @public
* <p>Metadata for a step execution.</p>
Expand Down
Loading

0 comments on commit 16531e4

Please sign in to comment.