@aws-sdk/client-sagemaker 3.233.0 → 3.235.0

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

@@ -1,5 +1,81 @@
-import { ActionSummary, AdditionalInferenceSpecificationDefinition, AgentVersion, AlgorithmSortBy, AlgorithmSpecification, AlgorithmSummary, AppDetails, AppImageConfigDetails, AppImageConfigSortKey, AppNetworkAccessType, AppSecurityGroupManagement, AppSortKey, AppSpecification, AppStatus, AppType, ArtifactSource, ArtifactSummary, AssociationEdgeType, AssociationSummary, AsyncInferenceConfig, AuthMode, AutoMLCandidate, AutoMLChannel, AutoMLJobArtifacts, AutoMLJobCompletionCriteria, AutoMLJobConfig, AutoMLJobObjective, AutoMLJobSecondaryStatus, AutoMLJobStatus, AutoMLJobSummary, AutoMLOutputDataConfig, AutoMLPartialFailureReason, AutoMLSortBy, AutoMLSortOrder, BatchDataCaptureConfig, BatchStrategy, CandidateSortBy, CandidateStatus, Channel, CheckpointConfig, CognitoConfig, CompilationJobStatus, ContainerDefinition, ContextSource, DataCaptureConfig, DataQualityAppSpecification, DataQualityBaselineConfig, DataQualityJobInput, DefaultSpaceSettings, DeploymentConfig, DomainSettings, EdgeDeploymentModelConfig, EdgeOutputConfig, EdgePresetDeploymentType, ExecutionRoleIdentityConfig, ExplainerConfig, FeatureDefinition, FeatureType, GitConfig, HyperParameterTuningJobObjectiveType, InferenceSpecification, InputConfig, KernelGatewayImageConfig, MetadataProperties, ModelApprovalStatus, ModelDeployConfig, ModelPackageStatus, MonitoringNetworkConfig, MonitoringOutputConfig, MonitoringResources, MonitoringStoppingCondition, NeoVpcConfig, ObjectiveStatus, OutputConfig, OutputDataConfig, OutputParameter, ProblemType, ProductionVariant, ProductionVariantAcceleratorType, ProductionVariantInstanceType, ProductionVariantServerlessConfig, ResourceConfig, ResourceSpec, StoppingCondition, Tag, TransformInput, TransformOutput, TransformResources, UserContext, UserSettings, VpcConfig } from "./models_0";
-import { _InstanceType, DataCaptureConfigSummary, DataProcessing, DebugHookConfig, DebugRuleConfiguration, DebugRuleEvaluationStatus, DeployedImage, DeploymentStageStatusSummary, DirectInternetAccess, DriftCheckBaselines, EndpointInfo, ExperimentConfig, FlowDefinitionOutputConfig, HubContentType, HubS3StorageConfig, HumanLoopActivationConfig, HumanLoopConfig, HumanLoopRequestSource, HumanTaskConfig, HyperParameterTrainingJobDefinition, HyperParameterTuningJobConfig, HyperParameterTuningJobStrategyType, HyperParameterTuningJobWarmStartConfig, InferenceExecutionConfig, InferenceExperimentDataStorageConfig, InferenceExperimentSchedule, InferenceExperimentType, InstanceMetadataServiceConfiguration, LabelingJobAlgorithmsConfig, LabelingJobInputConfig, LabelingJobOutputConfig, LabelingJobStoppingConditions, MemberDefinition, ModelBiasAppSpecification, ModelBiasBaselineConfig, ModelBiasJobInput, ModelCardExportOutputConfig, ModelCardSecurityConfig, ModelCardStatus, ModelClientConfig, ModelExplainabilityAppSpecification, ModelExplainabilityBaselineConfig, ModelExplainabilityJobInput, ModelInfrastructureConfig, ModelMetrics, ModelPackageValidationSpecification, ModelQualityAppSpecification, ModelQualityBaselineConfig, ModelQualityJobInput, MonitoringScheduleConfig, MonitoringType, NetworkConfig, NotebookInstanceAcceleratorType, NotebookInstanceLifecycleHook, NotificationConfiguration, OfflineStoreConfig, OnlineStoreConfig, ParallelismConfiguration, ProcessingInput, ProcessingOutputConfig, ProcessingResources, ProcessingStoppingCondition, ProfilerConfig, ProfilerRuleConfiguration, RecommendationJobInputConfig, RecommendationJobStoppingConditions, RecommendationJobType, ResourceLimits, RetryStrategy, RootAccess, RuleEvaluationStatus, ServiceCatalogProvisioningDetails, ShadowModeConfig, SourceAlgorithmSpecification, SourceIpConfig, SpaceSettings, StudioLifecycleConfigAppType, TensorBoardOutputConfig, TrialComponentArtifact, TrialComponentParameterValue, TrialComponentStatus } from "./models_1";
+import { ActionSummary, AdditionalInferenceSpecificationDefinition, AgentVersion, AlgorithmSortBy, AlgorithmSpecification, AlgorithmStatus, AlgorithmStatusDetails, AlgorithmSummary, AlgorithmValidationSpecification, AppDetails, AppImageConfigDetails, AppImageConfigSortKey, AppNetworkAccessType, AppSecurityGroupManagement, AppSortKey, AppSpecification, AppStatus, AppType, ArtifactSource, ArtifactSummary, AssociationEdgeType, AsyncInferenceConfig, AuthMode, AutoMLCandidate, AutoMLChannel, AutoMLJobArtifacts, AutoMLJobCompletionCriteria, AutoMLJobConfig, AutoMLJobObjective, AutoMLJobSecondaryStatus, AutoMLJobStatus, AutoMLOutputDataConfig, AutoMLPartialFailureReason, BatchDataCaptureConfig, BatchStrategy, Channel, CheckpointConfig, CognitoConfig, CompilationJobStatus, ContainerDefinition, ContextSource, DataCaptureConfig, DataQualityAppSpecification, DataQualityBaselineConfig, DataQualityJobInput, DefaultSpaceSettings, DeploymentConfig, DomainSettings, EdgeDeploymentModelConfig, EdgeOutputConfig, EdgePresetDeploymentType, ExecutionRoleIdentityConfig, ExplainerConfig, FeatureDefinition, FeatureType, GitConfig, HyperParameterTuningJobObjectiveType, InferenceSpecification, InputConfig, KernelGatewayImageConfig, MetadataProperties, ModelApprovalStatus, ModelDeployConfig, ModelPackageStatus, MonitoringNetworkConfig, MonitoringOutputConfig, MonitoringResources, MonitoringStoppingCondition, NeoVpcConfig, ObjectiveStatus, OutputConfig, OutputDataConfig, OutputParameter, ProblemType, ProductionVariant, ProductionVariantAcceleratorType, ProductionVariantInstanceType, ProductionVariantServerlessConfig, ResourceConfig, ResourceSpec, StoppingCondition, Tag, TrainingSpecification, TransformInput, TransformOutput, TransformResources, UserContext, UserSettings, VpcConfig } from "./models_0";
+import { _InstanceType, DataCaptureConfigSummary, DataProcessing, DebugHookConfig, DebugRuleConfiguration, DebugRuleEvaluationStatus, DeployedImage, DeploymentStageStatusSummary, DirectInternetAccess, DriftCheckBaselines, EndpointInfo, ExperimentConfig, FlowDefinitionOutputConfig, HubContentType, HubS3StorageConfig, HumanLoopActivationConfig, HumanLoopConfig, HumanLoopRequestSource, HumanTaskConfig, HyperParameterTrainingJobDefinition, HyperParameterTuningJobConfig, HyperParameterTuningJobStrategyType, HyperParameterTuningJobWarmStartConfig, InferenceExecutionConfig, InferenceExperimentDataStorageConfig, InferenceExperimentSchedule, InferenceExperimentType, InstanceMetadataServiceConfiguration, JobType, LabelingJobAlgorithmsConfig, LabelingJobInputConfig, LabelingJobOutputConfig, LabelingJobStoppingConditions, MemberDefinition, ModelBiasAppSpecification, ModelBiasBaselineConfig, ModelBiasJobInput, ModelCardExportOutputConfig, ModelCardSecurityConfig, ModelCardStatus, ModelClientConfig, ModelExplainabilityAppSpecification, ModelExplainabilityBaselineConfig, ModelExplainabilityJobInput, ModelInfrastructureConfig, ModelMetrics, ModelPackageValidationSpecification, ModelQualityAppSpecification, ModelQualityBaselineConfig, ModelQualityJobInput, MonitoringScheduleConfig, MonitoringType, NetworkConfig, NotebookInstanceAcceleratorType, NotebookInstanceLifecycleHook, NotificationConfiguration, OfflineStoreConfig, OnlineStoreConfig, ParallelismConfiguration, ProcessingInput, ProcessingOutputConfig, ProcessingResources, ProcessingStoppingCondition, Processor, ProfilerConfig, ProfilerRuleConfiguration, RecommendationJobInputConfig, RecommendationJobStoppingConditions, RecommendationJobType, ResourceLimits, RetryStrategy, RootAccess, RuleEvaluationStatus, ServiceCatalogProvisioningDetails, ShadowModeConfig, SourceAlgorithmSpecification, SourceIpConfig, SpaceSettings, StudioLifecycleConfigAppType, TensorBoardOutputConfig, TrialComponentArtifact, TrialComponentParameterValue, TrialComponentStatus, VendorGuidance } from "./models_1";
+export interface DescribeAlgorithmInput {
+    /**
+     * <p>The name of the algorithm to describe.</p>
+     */
+    AlgorithmName: string | undefined;
+}
+export interface DescribeAlgorithmOutput {
+    /**
+     * <p>The name of the algorithm being described.</p>
+     */
+    AlgorithmName: string | undefined;
+    /**
+     * <p>The Amazon Resource Name (ARN) of the algorithm.</p>
+     */
+    AlgorithmArn: string | undefined;
+    /**
+     * <p>A brief summary about the algorithm.</p>
+     */
+    AlgorithmDescription?: string;
+    /**
+     * <p>A timestamp specifying when the algorithm was created.</p>
+     */
+    CreationTime: Date | undefined;
+    /**
+     * <p>Details about training jobs run by this algorithm.</p>
+     */
+    TrainingSpecification: TrainingSpecification | undefined;
+    /**
+     * <p>Details about inference jobs that the algorithm runs.</p>
+     */
+    InferenceSpecification?: InferenceSpecification;
+    /**
+     * <p>Details about configurations for one or more training jobs that SageMaker runs to test the
+     *             algorithm.</p>
+     */
+    ValidationSpecification?: AlgorithmValidationSpecification;
+    /**
+     * <p>The current status of the algorithm.</p>
+     */
+    AlgorithmStatus: AlgorithmStatus | string | undefined;
+    /**
+     * <p>Details about the current status of the algorithm.</p>
+     */
+    AlgorithmStatusDetails: AlgorithmStatusDetails | undefined;
+    /**
+     * <p>The product identifier of the algorithm.</p>
+     */
+    ProductId?: string;
+    /**
+     * <p>Whether the algorithm is certified to be listed in Amazon Web Services
+     *             Marketplace.</p>
+     */
+    CertifyForMarketplace?: boolean;
+}
+export interface DescribeAppRequest {
+    /**
+     * <p>The domain ID.</p>
+     */
+    DomainId: string | undefined;
+    /**
+     * <p>The user profile name. If this value is not set, then <code>SpaceName</code> must be set.</p>
+     */
+    UserProfileName?: string;
+    /**
+     * <p>The type of app.</p>
+     */
+    AppType: AppType | string | undefined;
+    /**
+     * <p>The name of the app.</p>
+     */
+    AppName: string | undefined;
+    /**
+     * <p>The name of the space.</p>
+     */
+    SpaceName?: string;
+}
 export interface DescribeAppResponse {
     /**
      * <p>The Amazon Resource Name (ARN) of the app.</p>
@@ -224,7 +300,9 @@ export interface DescribeAutoMLJobResponse {
      */
     PartialFailureReasons?: AutoMLPartialFailureReason[];
     /**
-     * <p>Returns the job's best <code>AutoMLCandidate</code>.</p>
+     * <p>The best model candidate selected by SageMaker Autopilot using both the best objective metric and
+     *          lowest <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-metrics-validation.html">InferenceLatency</a> for
+     *          an experiment.</p>
      */
     BestCandidate?: AutoMLCandidate;
     /**
@@ -2144,7 +2222,7 @@ export interface DescribeImageResponse {
      */
     FailureReason?: string;
     /**
-     * <p>The Amazon Resource Name (ARN) of the image.</p>
+     * <p>The ARN of the image.</p>
      */
     ImageArn?: string;
     /**
@@ -2160,7 +2238,7 @@ export interface DescribeImageResponse {
      */
     LastModifiedTime?: Date;
     /**
-     * <p>The Amazon Resource Name (ARN) of the IAM role that enables Amazon SageMaker to perform tasks on your behalf.</p>
+     * <p>The ARN of the IAM role that enables Amazon SageMaker to perform tasks on your behalf.</p>
      */
     RoleArn?: string;
 }
@@ -2173,6 +2251,10 @@ export interface DescribeImageVersionRequest {
      * <p>The version of the image. If not specified, the latest version is described.</p>
      */
     Version?: number;
+    /**
+     * <p>The alias of the image version.</p>
+     */
+    Alias?: string;
 }
 export declare enum ImageVersionStatus {
     CREATED = "CREATED",
@@ -2199,7 +2281,7 @@ export interface DescribeImageVersionResponse {
      */
     FailureReason?: string;
     /**
-     * <p>The Amazon Resource Name (ARN) of the image the version is based on.</p>
+     * <p>The ARN of the image the version is based on.</p>
      */
     ImageArn?: string;
     /**
@@ -2218,6 +2300,76 @@ export interface DescribeImageVersionResponse {
      * <p>The version number.</p>
      */
     Version?: number;
+    /**
+     * <p>The stability of the image version specified by the maintainer.</p>
+     *          <ul>
+     *             <li>
+     *                <p>
+     *                   <code>NOT_PROVIDED</code>: The maintainers did not provide a status for image version stability.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>STABLE</code>: The image version is stable.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>TO_BE_ARCHIVED</code>: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>ARCHIVED</code>: The image version is archived. Archived image versions are not searchable and are no longer actively supported. </p>
+     *             </li>
+     *          </ul>
+     */
+    VendorGuidance?: VendorGuidance | string;
+    /**
+     * <p>Indicates SageMaker job type compatibility.</p>
+     *          <ul>
+     *             <li>
+     *                <p>
+     *                   <code>TRAINING</code>: The image version is compatible with SageMaker training jobs.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>INFERENCE</code>: The image version is compatible with SageMaker inference jobs.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>NOTEBOOK_KERNEL</code>: The image version is compatible with SageMaker notebook kernels.</p>
+     *             </li>
+     *          </ul>
+     */
+    JobType?: JobType | string;
+    /**
+     * <p>The machine learning framework vended in the image version.</p>
+     */
+    MLFramework?: string;
+    /**
+     * <p>The supported programming language and its version.</p>
+     */
+    ProgrammingLang?: string;
+    /**
+     * <p>Indicates CPU or GPU compatibility.</p>
+     *          <ul>
+     *             <li>
+     *                <p>
+     *                   <code>CPU</code>: The image version is compatible with CPU.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>GPU</code>: The image version is compatible with GPU.</p>
+     *             </li>
+     *          </ul>
+     */
+    Processor?: Processor | string;
+    /**
+     * <p>Indicates Horovod compatibility.</p>
+     */
+    Horovod?: boolean;
+    /**
+     * <p>The maintainer description of the image version.</p>
+     */
+    ReleaseNotes?: string;
 }
 export interface DescribeInferenceExperimentRequest {
     /**
@@ -5314,7 +5466,8 @@ export interface DescribeTrialComponentResponse {
      */
     LineageGroupArn?: string;
     /**
-     * <p>A list of the Amazon Resource Name (ARN) and, if applicable, job type for multiple sources of an experiment run.</p>
+     * <p>A list of ARNs and, if applicable, job types for multiple sources of an experiment
+     *       run.</p>
      */
     Sources?: TrialComponentSource[];
 }
@@ -7176,7 +7329,7 @@ export interface Image {
      */
     FailureReason?: string;
     /**
-     * <p>The Amazon Resource Name (ARN) of the image.</p>
+     * <p>The ARN of the image.</p>
      */
     ImageArn: string | undefined;
     /**
@@ -7215,7 +7368,7 @@ export interface ImageVersion {
      */
     FailureReason?: string;
     /**
-     * <p>The Amazon Resource Name (ARN) of the image the version is based on.</p>
+     * <p>The ARN of the image the version is based on.</p>
      */
     ImageArn: string | undefined;
     /**
@@ -7700,6 +7853,39 @@ export interface ListAlgorithmsOutput {
      */
     NextToken?: string;
 }
+export interface ListAliasesRequest {
+    /**
+     * <p>The name of the image.</p>
+     */
+    ImageName: string | undefined;
+    /**
+     * <p>The alias of the image version.</p>
+     */
+    Alias?: string;
+    /**
+     * <p>The version of the image. If image version is not specified, the aliases of all versions of the image are listed.</p>
+     */
+    Version?: number;
+    /**
+     * <p>The maximum number of aliases to return.</p>
+     */
+    MaxResults?: number;
+    /**
+     * <p>If the previous call to <code>ListAliases</code> didn't return the full set of
+     *          aliases, the call returns a token for retrieving the next set of aliases.</p>
+     */
+    NextToken?: string;
+}
+export interface ListAliasesResponse {
+    /**
+     * <p>A list of SageMaker image version aliases.</p>
+     */
+    SageMakerImageVersionAliases?: string[];
+    /**
+     * <p>A token for getting the next set of aliases, if more aliases exist.</p>
+     */
+    NextToken?: string;
+}
 export interface ListAppImageConfigsRequest {
     /**
      * <p>The maximum number of AppImageConfigs to return in the response. The default value is
@@ -7894,113 +8080,18 @@ export interface ListAssociationsRequest {
      */
     MaxResults?: number;
 }
-export interface ListAssociationsResponse {
-    /**
-     * <p>A list of associations and their properties.</p>
-     */
-    AssociationSummaries?: AssociationSummary[];
-    /**
-     * <p>A token for getting the next set of associations, if there are any.</p>
-     */
-    NextToken?: string;
-}
-export interface ListAutoMLJobsRequest {
-    /**
-     * <p>Request a list of jobs, using a filter for time.</p>
-     */
-    CreationTimeAfter?: Date;
-    /**
-     * <p>Request a list of jobs, using a filter for time.</p>
-     */
-    CreationTimeBefore?: Date;
-    /**
-     * <p>Request a list of jobs, using a filter for time.</p>
-     */
-    LastModifiedTimeAfter?: Date;
-    /**
-     * <p>Request a list of jobs, using a filter for time.</p>
-     */
-    LastModifiedTimeBefore?: Date;
-    /**
-     * <p>Request a list of jobs, using a search filter for name.</p>
-     */
-    NameContains?: string;
-    /**
-     * <p>Request a list of jobs, using a filter for status.</p>
-     */
-    StatusEquals?: AutoMLJobStatus | string;
-    /**
-     * <p>The sort order for the results. The default is <code>Descending</code>.</p>
-     */
-    SortOrder?: AutoMLSortOrder | string;
-    /**
-     * <p>The parameter by which to sort the results. The default is <code>Name</code>.</p>
-     */
-    SortBy?: AutoMLSortBy | string;
-    /**
-     * <p>Request a list of jobs up to a specified limit.</p>
-     */
-    MaxResults?: number;
-    /**
-     * <p>If the previous response was truncated, you receive this token. Use it in your next
-     *          request to receive the next set of results.</p>
-     */
-    NextToken?: string;
-}
-export interface ListAutoMLJobsResponse {
-    /**
-     * <p>Returns a summary list of jobs.</p>
-     */
-    AutoMLJobSummaries: AutoMLJobSummary[] | undefined;
-    /**
-     * <p>If the previous response was truncated, you receive this token. Use it in your next
-     *          request to receive the next set of results.</p>
-     */
-    NextToken?: string;
-}
-export interface ListCandidatesForAutoMLJobRequest {
-    /**
-     * <p>List the candidates created for the job by providing the job's name.</p>
-     */
-    AutoMLJobName: string | undefined;
-    /**
-     * <p>List the candidates for the job and filter by status.</p>
-     */
-    StatusEquals?: CandidateStatus | string;
-    /**
-     * <p>List the candidates for the job and filter by candidate name.</p>
-     */
-    CandidateNameEquals?: string;
-    /**
-     * <p>The sort order for the results. The default is <code>Ascending</code>.</p>
-     */
-    SortOrder?: AutoMLSortOrder | string;
-    /**
-     * <p>The parameter by which to sort the results. The default is
-     *          <code>Descending</code>.</p>
-     */
-    SortBy?: CandidateSortBy | string;
-    /**
-     * <p>List the job's candidates up to a specified limit.</p>
-     */
-    MaxResults?: number;
-    /**
-     * <p>If the previous response was truncated, you receive this token. Use it in your next
-     *          request to receive the next set of results.</p>
-     */
-    NextToken?: string;
-}
-export interface ListCandidatesForAutoMLJobResponse {
-    /**
-     * <p>Summaries about the <code>AutoMLCandidates</code>.</p>
-     */
-    Candidates: AutoMLCandidate[] | undefined;
-    /**
-     * <p>If the previous response was truncated, you receive this token. Use it in your next
-     *          request to receive the next set of results.</p>
-     */
-    NextToken?: string;
-}
+/**
+ * @internal
+ */
+export declare const DescribeAlgorithmInputFilterSensitiveLog: (obj: DescribeAlgorithmInput) => any;
+/**
+ * @internal
+ */
+export declare const DescribeAlgorithmOutputFilterSensitiveLog: (obj: DescribeAlgorithmOutput) => any;
+/**
+ * @internal
+ */
+export declare const DescribeAppRequestFilterSensitiveLog: (obj: DescribeAppRequest) => any;
 /**
  * @internal
  */
@@ -8909,6 +9000,14 @@ export declare const ListAlgorithmsInputFilterSensitiveLog: (obj: ListAlgorithms
  * @internal
  */
 export declare const ListAlgorithmsOutputFilterSensitiveLog: (obj: ListAlgorithmsOutput) => any;
+/**
+ * @internal
+ */
+export declare const ListAliasesRequestFilterSensitiveLog: (obj: ListAliasesRequest) => any;
+/**
+ * @internal
+ */
+export declare const ListAliasesResponseFilterSensitiveLog: (obj: ListAliasesResponse) => any;
 /**
  * @internal
  */
@@ -8937,23 +9036,3 @@ export declare const ListArtifactsResponseFilterSensitiveLog: (obj: ListArtifact
  * @internal
  */
 export declare const ListAssociationsRequestFilterSensitiveLog: (obj: ListAssociationsRequest) => any;
-/**
- * @internal
- */
-export declare const ListAssociationsResponseFilterSensitiveLog: (obj: ListAssociationsResponse) => any;
-/**
- * @internal
- */
-export declare const ListAutoMLJobsRequestFilterSensitiveLog: (obj: ListAutoMLJobsRequest) => any;
-/**
- * @internal
- */
-export declare const ListAutoMLJobsResponseFilterSensitiveLog: (obj: ListAutoMLJobsResponse) => any;
-/**
- * @internal
- */
-export declare const ListCandidatesForAutoMLJobRequestFilterSensitiveLog: (obj: ListCandidatesForAutoMLJobRequest) => any;
-/**
- * @internal
- */
-export declare const ListCandidatesForAutoMLJobResponseFilterSensitiveLog: (obj: ListCandidatesForAutoMLJobResponse) => any;