@aws-sdk/client-sagemaker 3.600.0 → 3.606.0

package/dist-types/models/models_3.d.ts

@@ -1,6 +1,345 @@
 import { ActionSummary, AgentVersion, AlgorithmSortBy, AlgorithmSpecification, AlgorithmSummary, AppDetails, AppImageConfigDetails, AppImageConfigSortKey, AppSortKey, AppSpecification, ArtifactSummary, AssociationEdgeType, AssociationSummary, AutoMLCandidate, AutoMLJobStatus, AutoMLJobSummary, AutoMLSortBy, AutoMLSortOrder, BatchDataCaptureConfig, BatchStrategy, CandidateSortBy, CandidateStatus, Channel, CheckpointConfig, ClusterNodeSummary, ClusterSortBy, ClusterSummary, CodeRepositorySortBy, CodeRepositorySortOrder, CodeRepositorySummary, CognitoConfig, CompilationJobStatus, CompilationJobSummary, ContextSummary, MetadataProperties, ModelApprovalStatus, ModelPackageStatus, OutputDataConfig, OutputParameter, ResourceConfig, ResourceSpec, StoppingCondition, Tag, TransformInput, TransformOutput, TransformResources, UserContext, VpcConfig } from "./models_0";
-import { DockerSettings, EdgeOutputConfig, ExecutionRoleIdentityConfig, ExperimentConfig, FeatureDefinition, FeatureType, HyperParameterTrainingJobDefinition, HyperParameterTuningJobConfig, HyperParameterTuningJobStrategyType, HyperParameterTuningJobWarmStartConfig, InferenceExperimentSchedule, InferenceExperimentType, LabelingJobInputConfig, ModelCardStatus, MonitoringScheduleConfig, MonitoringType, NetworkConfig, NotebookInstanceLifecycleHook, OfflineStoreConfig, OnlineStoreConfig, OwnershipSettings, ParallelismConfiguration, ProcessingInput, ProcessingOutputConfig, ProcessingResources, ProcessingStoppingCondition, RecommendationJobType, ResourceLimits, RetryStrategy, ServiceCatalogProvisioningDetails, UserSettings } from "./models_1";
-import { CrossAccountFilterOption, CustomizedMetricSpecification, DataCaptureConfigSummary, DataProcessing, DebugHookConfig, DebugRuleConfiguration, DebugRuleEvaluationStatus, DomainStatus, EdgePackagingJobStatus, EndpointOutputConfiguration, EndpointStatus, ExperimentSource, FeatureGroupStatus, FeatureParameter, FlowDefinitionStatus, HubContentStatus, HubContentType, HubStatus, HyperParameterTrainingJobSummary, HyperParameterTuningJobCompletionDetails, HyperParameterTuningJobConsumedResources, HyperParameterTuningJobStatus, ImageStatus, ImageVersionStatus, InferenceComponentStatus, InferenceExperimentStatus, InferenceMetrics, InfraCheckConfig, IsTrackingServerActive, LabelCounters, LabelingJobOutput, LabelingJobStatus, LastUpdateStatus, MemberDefinition, ModelArtifacts, ModelCardExportJobStatus, ModelClientConfig, ModelConfiguration, ModelPackageGroupStatus, MonitoringExecutionSummary, NotificationConfiguration, ObjectiveStatusCounters, OfflineStoreStatus, OfflineStoreStatusValue, ProductionVariantSummary, ProfilerConfig, ProfilerRuleConfiguration, RecommendationJobStatus, RecommendationMetrics, RemoteDebugConfig, RuleEvaluationStatus, ScheduleStatus, SourceIpConfig, SpaceSettings, SpaceSharingSettings, StudioLifecycleConfigAppType, TensorBoardOutputConfig, TrackingServerStatus, TrainingJobStatus, TrainingJobStatusCounters, TrialComponentArtifact, TrialComponentParameterValue, TrialComponentStatus, WorkerAccessConfiguration } from "./models_2";
+import { _InstanceType, DirectInternetAccess, DockerSettings, EdgeOutputConfig, ExecutionRoleIdentityConfig, ExperimentConfig, FeatureDefinition, FeatureType, HyperParameterTrainingJobDefinition, HyperParameterTuningJobConfig, HyperParameterTuningJobStrategyType, HyperParameterTuningJobWarmStartConfig, InferenceExperimentSchedule, InferenceExperimentType, InstanceMetadataServiceConfiguration, LabelingJobInputConfig, ModelCardStatus, MonitoringScheduleConfig, MonitoringType, NetworkConfig, NotebookInstanceAcceleratorType, NotebookInstanceLifecycleHook, OfflineStoreConfig, OnlineStoreConfig, ParallelismConfiguration, ProcessingInput, ProcessingOutputConfig, ProcessingResources, ProcessingStoppingCondition, RecommendationJobType, ResourceLimits, RetryStrategy, RootAccess, ServiceCatalogProvisioningDetails, UserSettings } from "./models_1";
+import { CrossAccountFilterOption, CustomizedMetricSpecification, DataCaptureConfigSummary, DataProcessing, DebugHookConfig, DebugRuleConfiguration, DebugRuleEvaluationStatus, DomainStatus, EdgePackagingJobStatus, EndpointOutputConfiguration, EndpointStatus, ExperimentSource, FeatureGroupStatus, FeatureParameter, FlowDefinitionStatus, HubContentStatus, HubContentSupportStatus, HubContentType, HubStatus, HyperParameterTrainingJobSummary, HyperParameterTuningJobCompletionDetails, HyperParameterTuningJobConsumedResources, HyperParameterTuningJobStatus, ImageStatus, ImageVersionStatus, InferenceComponentStatus, InferenceExperimentStatus, InferenceMetrics, InfraCheckConfig, IsTrackingServerActive, LabelCounters, LabelingJobOutput, LabelingJobStatus, LastUpdateStatus, MemberDefinition, ModelArtifacts, ModelCardExportJobStatus, ModelClientConfig, ModelConfiguration, ModelPackageGroupStatus, NotificationConfiguration, ObjectiveStatusCounters, OfflineStoreStatus, OfflineStoreStatusValue, OwnershipSettings, ProductionVariantSummary, ProfilerConfig, ProfilerRuleConfiguration, RecommendationJobStatus, RecommendationMetrics, RemoteDebugConfig, RuleEvaluationStatus, SourceIpConfig, SpaceSettings, SpaceSharingSettings, StudioLifecycleConfigAppType, TensorBoardOutputConfig, TrackingServerStatus, TrainingJobStatus, TrainingJobStatusCounters, TrialComponentArtifact, TrialComponentParameterValue, TrialComponentStatus, WorkerAccessConfiguration } from "./models_2";
+/**
+ * @public
+ * @enum
+ */
+export declare const ExecutionStatus: {
+    readonly COMPLETED: "Completed";
+    readonly COMPLETED_WITH_VIOLATIONS: "CompletedWithViolations";
+    readonly FAILED: "Failed";
+    readonly IN_PROGRESS: "InProgress";
+    readonly PENDING: "Pending";
+    readonly STOPPED: "Stopped";
+    readonly STOPPING: "Stopping";
+};
+/**
+ * @public
+ */
+export type ExecutionStatus = (typeof ExecutionStatus)[keyof typeof ExecutionStatus];
+/**
+ * <p>Summary of information about the last monitoring job to run.</p>
+ * @public
+ */
+export interface MonitoringExecutionSummary {
+    /**
+     * <p>The name of the monitoring schedule.</p>
+     * @public
+     */
+    MonitoringScheduleName: string | undefined;
+    /**
+     * <p>The time the monitoring job was scheduled.</p>
+     * @public
+     */
+    ScheduledTime: Date | undefined;
+    /**
+     * <p>The time at which the monitoring job was created.</p>
+     * @public
+     */
+    CreationTime: Date | undefined;
+    /**
+     * <p>A timestamp that indicates the last time the monitoring job was modified.</p>
+     * @public
+     */
+    LastModifiedTime: Date | undefined;
+    /**
+     * <p>The status of the monitoring job.</p>
+     * @public
+     */
+    MonitoringExecutionStatus: ExecutionStatus | undefined;
+    /**
+     * <p>The Amazon Resource Name (ARN) of the monitoring job.</p>
+     * @public
+     */
+    ProcessingJobArn?: string;
+    /**
+     * <p>The name of the endpoint used to run the monitoring job.</p>
+     * @public
+     */
+    EndpointName?: string;
+    /**
+     * <p>Contains the reason a monitoring job failed, if it failed.</p>
+     * @public
+     */
+    FailureReason?: string;
+    /**
+     * <p>The name of the monitoring job.</p>
+     * @public
+     */
+    MonitoringJobDefinitionName?: string;
+    /**
+     * <p>The type of the monitoring job.</p>
+     * @public
+     */
+    MonitoringType?: MonitoringType;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const ScheduleStatus: {
+    readonly FAILED: "Failed";
+    readonly PENDING: "Pending";
+    readonly SCHEDULED: "Scheduled";
+    readonly STOPPED: "Stopped";
+};
+/**
+ * @public
+ */
+export type ScheduleStatus = (typeof ScheduleStatus)[keyof typeof ScheduleStatus];
+/**
+ * @public
+ */
+export interface DescribeMonitoringScheduleResponse {
+    /**
+     * <p>The Amazon Resource Name (ARN) of the monitoring schedule.</p>
+     * @public
+     */
+    MonitoringScheduleArn: string | undefined;
+    /**
+     * <p>Name of the monitoring schedule.</p>
+     * @public
+     */
+    MonitoringScheduleName: string | undefined;
+    /**
+     * <p>The status of an monitoring job.</p>
+     * @public
+     */
+    MonitoringScheduleStatus: ScheduleStatus | undefined;
+    /**
+     * <p>The type of the monitoring job that this schedule runs. This is one of the following
+     *          values.</p>
+     *          <ul>
+     *             <li>
+     *                <p>
+     *                   <code>DATA_QUALITY</code> - The schedule is for a data quality monitoring
+     *                job.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>MODEL_QUALITY</code> - The schedule is for a model quality monitoring
+     *                job.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>MODEL_BIAS</code> - The schedule is for a bias monitoring job.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>MODEL_EXPLAINABILITY</code> - The schedule is for an explainability
+     *                monitoring job.</p>
+     *             </li>
+     *          </ul>
+     * @public
+     */
+    MonitoringType?: MonitoringType;
+    /**
+     * <p>A string, up to one KB in size, that contains the reason a monitoring job failed, if it
+     *          failed.</p>
+     * @public
+     */
+    FailureReason?: string;
+    /**
+     * <p>The time at which the monitoring job was created.</p>
+     * @public
+     */
+    CreationTime: Date | undefined;
+    /**
+     * <p>The time at which the monitoring job was last modified.</p>
+     * @public
+     */
+    LastModifiedTime: Date | undefined;
+    /**
+     * <p>The configuration object that specifies the monitoring schedule and defines the monitoring
+     *    job.</p>
+     * @public
+     */
+    MonitoringScheduleConfig: MonitoringScheduleConfig | undefined;
+    /**
+     * <p> The name of the endpoint for the monitoring job.</p>
+     * @public
+     */
+    EndpointName?: string;
+    /**
+     * <p>Describes metadata on the last execution to run, if there was one.</p>
+     * @public
+     */
+    LastMonitoringExecutionSummary?: MonitoringExecutionSummary;
+}
+/**
+ * @public
+ */
+export interface DescribeNotebookInstanceInput {
+    /**
+     * <p>The name of the notebook instance that you want information about.</p>
+     * @public
+     */
+    NotebookInstanceName: string | undefined;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const NotebookInstanceStatus: {
+    readonly Deleting: "Deleting";
+    readonly Failed: "Failed";
+    readonly InService: "InService";
+    readonly Pending: "Pending";
+    readonly Stopped: "Stopped";
+    readonly Stopping: "Stopping";
+    readonly Updating: "Updating";
+};
+/**
+ * @public
+ */
+export type NotebookInstanceStatus = (typeof NotebookInstanceStatus)[keyof typeof NotebookInstanceStatus];
+/**
+ * @public
+ */
+export interface DescribeNotebookInstanceOutput {
+    /**
+     * <p>The Amazon Resource Name (ARN) of the notebook instance.</p>
+     * @public
+     */
+    NotebookInstanceArn?: string;
+    /**
+     * <p>The name of the SageMaker notebook instance. </p>
+     * @public
+     */
+    NotebookInstanceName?: string;
+    /**
+     * <p>The status of the notebook instance.</p>
+     * @public
+     */
+    NotebookInstanceStatus?: NotebookInstanceStatus;
+    /**
+     * <p>If status is <code>Failed</code>, the reason it failed.</p>
+     * @public
+     */
+    FailureReason?: string;
+    /**
+     * <p>The URL that you use to connect to the Jupyter notebook that is running in your
+     *             notebook instance. </p>
+     * @public
+     */
+    Url?: string;
+    /**
+     * <p>The type of ML compute instance running on the notebook instance.</p>
+     * @public
+     */
+    InstanceType?: _InstanceType;
+    /**
+     * <p>The ID of the VPC subnet.</p>
+     * @public
+     */
+    SubnetId?: string;
+    /**
+     * <p>The IDs of the VPC security groups.</p>
+     * @public
+     */
+    SecurityGroups?: string[];
+    /**
+     * <p>The Amazon Resource Name (ARN) of the IAM role associated with the instance.
+     *         </p>
+     * @public
+     */
+    RoleArn?: string;
+    /**
+     * <p>The Amazon Web Services KMS key ID SageMaker uses to encrypt data when storing it on the
+     *             ML storage volume attached to the instance. </p>
+     * @public
+     */
+    KmsKeyId?: string;
+    /**
+     * <p>The network interface IDs that SageMaker created at the time of creating the instance.
+     *         </p>
+     * @public
+     */
+    NetworkInterfaceId?: string;
+    /**
+     * <p>A timestamp. Use this parameter to retrieve the time when the notebook instance was
+     *             last modified. </p>
+     * @public
+     */
+    LastModifiedTime?: Date;
+    /**
+     * <p>A timestamp. Use this parameter to return the time when the notebook instance was
+     *             created</p>
+     * @public
+     */
+    CreationTime?: Date;
+    /**
+     * <p>Returns the name of a notebook instance lifecycle configuration.</p>
+     *          <p>For information about notebook instance lifestyle configurations, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html">Step
+     *                 2.1: (Optional) Customize a Notebook Instance</a>
+     *          </p>
+     * @public
+     */
+    NotebookInstanceLifecycleConfigName?: string;
+    /**
+     * <p>Describes whether SageMaker provides internet access to the notebook instance. If this
+     *             value is set to <i>Disabled</i>, the notebook instance does not have
+     *             internet access, and cannot connect to SageMaker training and endpoint services.</p>
+     *          <p>For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/appendix-additional-considerations.html#appendix-notebook-and-internet-access">Notebook Instances Are Internet-Enabled by Default</a>.</p>
+     * @public
+     */
+    DirectInternetAccess?: DirectInternetAccess;
+    /**
+     * <p>The size, in GB, of the ML storage volume attached to the notebook instance.</p>
+     * @public
+     */
+    VolumeSizeInGB?: number;
+    /**
+     * <p>A list of the Elastic Inference (EI) instance types associated with this notebook
+     *             instance. Currently only one EI instance type can be associated with a notebook
+     *             instance. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/ei.html">Using Elastic Inference in
+     *             Amazon SageMaker</a>.</p>
+     * @public
+     */
+    AcceleratorTypes?: NotebookInstanceAcceleratorType[];
+    /**
+     * <p>The Git repository associated with the notebook instance as its default code
+     *             repository. This can be either the name of a Git repository stored as a resource in your
+     *             account, or the URL of a Git repository in <a href="https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html">Amazon Web Services CodeCommit</a>
+     *             or in any other Git repository. When you open a notebook instance, it opens in the
+     *             directory that contains this repository. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html">Associating Git
+     *                 Repositories with SageMaker Notebook Instances</a>.</p>
+     * @public
+     */
+    DefaultCodeRepository?: string;
+    /**
+     * <p>An array of up to three Git repositories associated with the notebook instance. These
+     *             can be either the names of Git repositories stored as resources in your account, or the
+     *             URL of Git repositories in <a href="https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html">Amazon Web Services CodeCommit</a>
+     *             or in any other Git repository. These repositories are cloned at the same level as the
+     *             default repository of your notebook instance. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html">Associating Git
+     *                 Repositories with SageMaker Notebook Instances</a>.</p>
+     * @public
+     */
+    AdditionalCodeRepositories?: string[];
+    /**
+     * <p>Whether root access is enabled or disabled for users of the notebook instance.</p>
+     *          <note>
+     *             <p>Lifecycle configurations need root access to be able to set up a notebook
+     *                 instance. Because of this, lifecycle configurations associated with a notebook
+     *                 instance always run with root access even if you disable root access for
+     *                 users.</p>
+     *          </note>
+     * @public
+     */
+    RootAccess?: RootAccess;
+    /**
+     * <p>The platform identifier of the notebook instance runtime environment.</p>
+     * @public
+     */
+    PlatformIdentifier?: string;
+    /**
+     * <p>Information on the IMDS configuration of the notebook instance</p>
+     * @public
+     */
+    InstanceMetadataServiceConfiguration?: InstanceMetadataServiceConfiguration;
+}
 /**
  * @public
  */
@@ -4355,6 +4694,11 @@ export interface HubContentInfo {
      * @public
      */
     HubContentArn: string | undefined;
+    /**
+     * <p>The ARN of the public hub content.</p>
+     * @public
+     */
+    SageMakerPublicHubContentArn?: string;
     /**
      * <p>The version of the hub content.</p>
      * @public
@@ -4380,6 +4724,11 @@ export interface HubContentInfo {
      * @public
      */
     HubContentDescription?: string;
+    /**
+     * <p>The support status of the hub content.</p>
+     * @public
+     */
+    SupportStatus?: HubContentSupportStatus;
     /**
      * <p>The searchable keywords for the hub content.</p>
      * @public
@@ -4395,6 +4744,11 @@ export interface HubContentInfo {
      * @public
      */
     CreationTime: Date | undefined;
+    /**
+     * <p>The date and time when the hub content was originally created, before any updates or revisions.</p>
+     * @public
+     */
+    OriginalCreationTime?: Date;
 }
 /**
  * @public
@@ -9463,163 +9817,3 @@ export interface ModelSummary {
      */
     CreationTime: Date | undefined;
 }
-/**
- * @public
- */
-export interface ListModelsOutput {
-    /**
-     * <p>An array of <code>ModelSummary</code> objects, each of which lists a
-     *             model.</p>
-     * @public
-     */
-    Models: ModelSummary[] | undefined;
-    /**
-     * <p> If the response is truncated, SageMaker returns this token. To retrieve the next set of
-     *             models, use it in the subsequent request. </p>
-     * @public
-     */
-    NextToken?: string;
-}
-/**
- * @public
- * @enum
- */
-export declare const MonitoringAlertHistorySortKey: {
-    readonly CreationTime: "CreationTime";
-    readonly Status: "Status";
-};
-/**
- * @public
- */
-export type MonitoringAlertHistorySortKey = (typeof MonitoringAlertHistorySortKey)[keyof typeof MonitoringAlertHistorySortKey];
-/**
- * @public
- * @enum
- */
-export declare const MonitoringAlertStatus: {
-    readonly IN_ALERT: "InAlert";
-    readonly OK: "OK";
-};
-/**
- * @public
- */
-export type MonitoringAlertStatus = (typeof MonitoringAlertStatus)[keyof typeof MonitoringAlertStatus];
-/**
- * @public
- */
-export interface ListMonitoringAlertHistoryRequest {
-    /**
-     * <p>The name of a monitoring schedule.</p>
-     * @public
-     */
-    MonitoringScheduleName?: string;
-    /**
-     * <p>The name of a monitoring alert.</p>
-     * @public
-     */
-    MonitoringAlertName?: string;
-    /**
-     * <p>The field used to sort results. The default is <code>CreationTime</code>.</p>
-     * @public
-     */
-    SortBy?: MonitoringAlertHistorySortKey;
-    /**
-     * <p>The sort order, whether <code>Ascending</code> or <code>Descending</code>, of the alert
-     *          history. The default is <code>Descending</code>.</p>
-     * @public
-     */
-    SortOrder?: SortOrder;
-    /**
-     * <p>If the result of the previous <code>ListMonitoringAlertHistory</code> request was
-     *          truncated, the response includes a <code>NextToken</code>. To retrieve the next set of
-     *          alerts in the history, use the token in the next request.</p>
-     * @public
-     */
-    NextToken?: string;
-    /**
-     * <p>The maximum number of results to display. The default is 100.</p>
-     * @public
-     */
-    MaxResults?: number;
-    /**
-     * <p>A filter that returns only alerts created on or before the specified time.</p>
-     * @public
-     */
-    CreationTimeBefore?: Date;
-    /**
-     * <p>A filter that returns only alerts created on or after the specified time.</p>
-     * @public
-     */
-    CreationTimeAfter?: Date;
-    /**
-     * <p>A filter that retrieves only alerts with a specific status.</p>
-     * @public
-     */
-    StatusEquals?: MonitoringAlertStatus;
-}
-/**
- * <p>Provides summary information of an alert's history.</p>
- * @public
- */
-export interface MonitoringAlertHistorySummary {
-    /**
-     * <p>The name of a monitoring schedule.</p>
-     * @public
-     */
-    MonitoringScheduleName: string | undefined;
-    /**
-     * <p>The name of a monitoring alert.</p>
-     * @public
-     */
-    MonitoringAlertName: string | undefined;
-    /**
-     * <p>A timestamp that indicates when the first alert transition occurred in an alert history.
-     *       An alert transition can be from status <code>InAlert</code> to <code>OK</code>,
-     *       or from <code>OK</code> to <code>InAlert</code>.</p>
-     * @public
-     */
-    CreationTime: Date | undefined;
-    /**
-     * <p>The current alert status of an alert.</p>
-     * @public
-     */
-    AlertStatus: MonitoringAlertStatus | undefined;
-}
-/**
- * @public
- */
-export interface ListMonitoringAlertHistoryResponse {
-    /**
-     * <p>An alert history for a model monitoring schedule.</p>
-     * @public
-     */
-    MonitoringAlertHistory?: MonitoringAlertHistorySummary[];
-    /**
-     * <p>If the response is truncated, SageMaker returns this token. To retrieve the next set of
-     *          alerts, use it in the subsequent request.</p>
-     * @public
-     */
-    NextToken?: string;
-}
-/**
- * @public
- */
-export interface ListMonitoringAlertsRequest {
-    /**
-     * <p>The name of a monitoring schedule.</p>
-     * @public
-     */
-    MonitoringScheduleName: string | undefined;
-    /**
-     * <p>If the result of the previous <code>ListMonitoringAlerts</code> request was truncated,
-     *          the response includes a <code>NextToken</code>. To retrieve the next set of alerts in the
-     *          history, use the token in the next request.</p>
-     * @public
-     */
-    NextToken?: string;
-    /**
-     * <p>The maximum number of results to display. The default is 100.</p>
-     * @public
-     */
-    MaxResults?: number;
-}