@aws-sdk/client-sagemaker 3.181.0 → 3.182.0

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

@@ -1,5 +1,143 @@
-import { ActionSummary, AdditionalInferenceSpecificationDefinition, AgentVersion, AlgorithmSortBy, AlgorithmSpecification, AlgorithmSummary, AppDetails, AppImageConfigDetails, AppImageConfigSortKey, AppSortKey, AppSpecification, ArtifactSummary, AssociationEdgeType, AssociationSummary, AutoMLCandidate, AutoMLJobStatus, AutoMLJobSummary, AutoMLSortBy, AutoMLSortOrder, BatchStrategy, CandidateSortBy, CandidateStatus, Channel, CheckpointConfig, CodeRepositorySortBy, CodeRepositorySortOrder, CodeRepositorySummary, CognitoConfig, CompilationJobStatus, CompilationJobSummary, ContainerDefinition, ContextSummary, EdgeOutputConfig, ExecutionRoleIdentityConfig, FeatureDefinition, FeatureType, FlowDefinitionOutputConfig, HumanLoopActivationConfig, HumanLoopConfig, HumanLoopRequestSource, HyperParameterTuningJobObjectiveType, InferenceSpecification, MetadataProperties, ModelApprovalStatus, ModelPackageStatus, MonitoringNetworkConfig, MonitoringOutputConfig, MonitoringResources, MonitoringStoppingCondition, ObjectiveStatus, OfflineStoreConfig, OnlineStoreConfig, OutputDataConfig, OutputParameter, ProductionVariantInstanceType, ResourceConfig, ResourceSpec, StoppingCondition, Tag, TransformInput, TransformOutput, TransformResources, UserContext, UserSettings, VpcConfig } from "./models_0";
-import { _InstanceType, DataCaptureConfigSummary, DataProcessing, DebugHookConfig, DebugRuleConfiguration, DebugRuleEvaluationStatus, DirectInternetAccess, DomainStatus, DriftCheckBaselines, EdgePackagingJobStatus, EndpointStatus, ExperimentConfig, ExperimentSource, FeatureGroupStatus, HumanTaskConfig, HyperParameterTrainingJobDefinition, HyperParameterTuningJobConfig, HyperParameterTuningJobStrategyType, HyperParameterTuningJobWarmStartConfig, InferenceExecutionConfig, InstanceMetadataServiceConfiguration, LabelingJobAlgorithmsConfig, LabelingJobInputConfig, LabelingJobOutputConfig, LabelingJobStoppingConditions, LastUpdateStatus, MemberDefinition, ModelArtifacts, ModelBiasAppSpecification, ModelBiasBaselineConfig, ModelBiasJobInput, ModelClientConfig, ModelExplainabilityAppSpecification, ModelExplainabilityBaselineConfig, ModelExplainabilityJobInput, ModelMetrics, ModelPackageValidationSpecification, ModelQualityAppSpecification, ModelQualityBaselineConfig, ModelQualityJobInput, MonitoringScheduleConfig, MonitoringType, NetworkConfig, NotebookInstanceAcceleratorType, NotebookInstanceLifecycleHook, NotificationConfiguration, OfflineStoreStatusValue, ParallelismConfiguration, ProcessingInput, ProcessingOutputConfig, ProcessingResources, ProcessingStoppingCondition, ProductionVariantSummary, ProfilerConfig, ProfilerRuleConfiguration, RecommendationJobInputConfig, RecommendationJobStoppingConditions, RecommendationJobType, ResourceLimits, RetryStrategy, RootAccess, RuleEvaluationStatus, ServiceCatalogProvisioningDetails, SourceAlgorithmSpecification, SourceIpConfig, StudioLifecycleConfigAppType, TensorBoardOutputConfig, TrialComponentArtifact, TrialComponentParameterValue, TrialComponentStatus } from "./models_1";
+import { ActionSummary, AdditionalInferenceSpecificationDefinition, AgentVersion, AlgorithmSortBy, AlgorithmSpecification, AlgorithmSummary, AppDetails, AppImageConfigDetails, AppImageConfigSortKey, AppSortKey, AppSpecification, ArtifactSummary, AssociationEdgeType, AssociationSummary, AsyncInferenceConfig, AutoMLCandidate, AutoMLJobStatus, AutoMLJobSummary, AutoMLSortBy, AutoMLSortOrder, BatchStrategy, CandidateSortBy, CandidateStatus, Channel, CheckpointConfig, CodeRepositorySortBy, CodeRepositorySortOrder, CodeRepositorySummary, CognitoConfig, CompilationJobStatus, CompilationJobSummary, ContainerDefinition, ContextSummary, DataCaptureConfig, EdgeOutputConfig, ExecutionRoleIdentityConfig, ExplainerConfig, FeatureDefinition, FeatureType, HumanLoopActivationConfig, HyperParameterTuningJobObjectiveType, InferenceSpecification, MetadataProperties, ModelApprovalStatus, ModelPackageStatus, MonitoringNetworkConfig, MonitoringOutputConfig, MonitoringResources, MonitoringStoppingCondition, ObjectiveStatus, OfflineStoreConfig, OnlineStoreConfig, OutputDataConfig, OutputParameter, ProductionVariant, ProductionVariantInstanceType, ResourceConfig, ResourceSpec, StoppingCondition, Tag, TransformInput, TransformOutput, TransformResources, UserContext, UserSettings, VpcConfig } from "./models_0";
+import { _InstanceType, DataCaptureConfigSummary, DataProcessing, DebugHookConfig, DebugRuleConfiguration, DebugRuleEvaluationStatus, DirectInternetAccess, DomainStatus, DriftCheckBaselines, EdgePackagingJobStatus, EndpointStatus, ExperimentConfig, FlowDefinitionOutputConfig, HumanLoopConfig, HumanLoopRequestSource, HumanTaskConfig, HyperParameterTrainingJobDefinition, HyperParameterTuningJobConfig, HyperParameterTuningJobStrategyType, HyperParameterTuningJobWarmStartConfig, InferenceExecutionConfig, InstanceMetadataServiceConfiguration, LabelingJobAlgorithmsConfig, LabelingJobInputConfig, LabelingJobOutputConfig, LabelingJobStoppingConditions, MemberDefinition, ModelArtifacts, ModelBiasAppSpecification, ModelBiasBaselineConfig, ModelBiasJobInput, ModelClientConfig, ModelExplainabilityAppSpecification, ModelExplainabilityBaselineConfig, ModelExplainabilityJobInput, ModelMetrics, ModelPackageValidationSpecification, ModelQualityAppSpecification, ModelQualityBaselineConfig, ModelQualityJobInput, MonitoringScheduleConfig, MonitoringType, NetworkConfig, NotebookInstanceAcceleratorType, NotebookInstanceLifecycleHook, NotificationConfiguration, ParallelismConfiguration, ProcessingInput, ProcessingOutputConfig, ProcessingResources, ProcessingStoppingCondition, ProductionVariantSummary, ProfilerConfig, ProfilerRuleConfiguration, RecommendationJobInputConfig, RecommendationJobStoppingConditions, RecommendationJobType, ResourceLimits, RetryStrategy, RootAccess, RuleEvaluationStatus, ServiceCatalogProvisioningDetails, SourceAlgorithmSpecification, SourceIpConfig, StudioLifecycleConfigAppType, TensorBoardOutputConfig, TrialComponentArtifact, TrialComponentParameterValue, TrialComponentStatus } from "./models_1";
+export interface DescribeEndpointConfigOutput {
+    /**
+     * <p>Name of the SageMaker endpoint configuration.</p>
+     */
+    EndpointConfigName: string | undefined;
+    /**
+     * <p>The Amazon Resource Name (ARN) of the endpoint configuration.</p>
+     */
+    EndpointConfigArn: string | undefined;
+    /**
+     * <p>An array of <code>ProductionVariant</code> objects, one for each model that you
+     *             want to host at this endpoint.</p>
+     */
+    ProductionVariants: ProductionVariant[] | undefined;
+    /**
+     * <p>Configuration to control how SageMaker captures inference data.</p>
+     */
+    DataCaptureConfig?: DataCaptureConfig;
+    /**
+     * <p>Amazon Web Services KMS key ID Amazon SageMaker uses to encrypt data when storing it on
+     *             the ML storage volume attached to the instance.</p>
+     */
+    KmsKeyId?: string;
+    /**
+     * <p>A timestamp that shows when the endpoint configuration was created.</p>
+     */
+    CreationTime: Date | undefined;
+    /**
+     * <p>Returns the description of an endpoint configuration created using the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpointConfig.html">
+     *                <code>CreateEndpointConfig</code>
+     *             </a> API.</p>
+     */
+    AsyncInferenceConfig?: AsyncInferenceConfig;
+    /**
+     * <p>The configuration parameters for an explainer.</p>
+     */
+    ExplainerConfig?: ExplainerConfig;
+}
+export interface DescribeExperimentRequest {
+    /**
+     * <p>The name of the experiment to describe.</p>
+     */
+    ExperimentName: string | undefined;
+}
+/**
+ * <p>The source of the experiment.</p>
+ */
+export interface ExperimentSource {
+    /**
+     * <p>The Amazon Resource Name (ARN) of the source.</p>
+     */
+    SourceArn: string | undefined;
+    /**
+     * <p>The source type.</p>
+     */
+    SourceType?: string;
+}
+export interface DescribeExperimentResponse {
+    /**
+     * <p>The name of the experiment.</p>
+     */
+    ExperimentName?: string;
+    /**
+     * <p>The Amazon Resource Name (ARN) of the experiment.</p>
+     */
+    ExperimentArn?: string;
+    /**
+     * <p>The name of the experiment as displayed. If <code>DisplayName</code> isn't specified,
+     *         <code>ExperimentName</code> is displayed.</p>
+     */
+    DisplayName?: string;
+    /**
+     * <p>The ARN of the source and, optionally, the type.</p>
+     */
+    Source?: ExperimentSource;
+    /**
+     * <p>The description of the experiment.</p>
+     */
+    Description?: string;
+    /**
+     * <p>When the experiment was created.</p>
+     */
+    CreationTime?: Date;
+    /**
+     * <p>Who created the experiment.</p>
+     */
+    CreatedBy?: UserContext;
+    /**
+     * <p>When the experiment was last modified.</p>
+     */
+    LastModifiedTime?: Date;
+    /**
+     * <p>Who last modified the experiment.</p>
+     */
+    LastModifiedBy?: UserContext;
+}
+export interface DescribeFeatureGroupRequest {
+    /**
+     * <p>The name of the <code>FeatureGroup</code> you want described. </p>
+     */
+    FeatureGroupName: string | undefined;
+    /**
+     * <p>A token to resume pagination of the list of <code>Features</code>
+     *             (<code>FeatureDefinitions</code>). 2,500 <code>Features</code> are returned by
+     *          default.</p>
+     */
+    NextToken?: string;
+}
+export declare enum FeatureGroupStatus {
+    CREATED = "Created",
+    CREATE_FAILED = "CreateFailed",
+    CREATING = "Creating",
+    DELETE_FAILED = "DeleteFailed",
+    DELETING = "Deleting"
+}
+export declare enum LastUpdateStatusValue {
+    FAILED = "Failed",
+    IN_PROGRESS = "InProgress",
+    SUCCESSFUL = "Successful"
+}
+/**
+ * <p>A value that indicates whether the update was successful.</p>
+ */
+export interface LastUpdateStatus {
+    /**
+     * <p>A value that indicates whether the update was made successful.</p>
+     */
+    Status: LastUpdateStatusValue | string | undefined;
+    /**
+     * <p>If the update wasn't successful, indicates the reason why it failed.</p>
+     */
+    FailureReason?: string;
+}
+export declare enum OfflineStoreStatusValue {
+    ACTIVE = "Active",
+    BLOCKED = "Blocked",
+    DISABLED = "Disabled"
+}
 /**
  * <p>The status of <code>OfflineStore</code>.</p>
  */
@@ -7257,254 +7395,30 @@ export declare enum ModelSortKey {
     CreationTime = "CreationTime",
     Name = "Name"
 }
-export interface ListModelsInput {
-    /**
-     * <p>Sorts the list of results. The default is <code>CreationTime</code>.</p>
-     */
-    SortBy?: ModelSortKey | string;
-    /**
-     * <p>The sort order for results. The default is <code>Descending</code>.</p>
-     */
-    SortOrder?: OrderKey | string;
-    /**
-     * <p>If the response to a previous <code>ListModels</code> request was truncated, the
-     *             response includes a <code>NextToken</code>. To retrieve the next set of models, use the
-     *             token in the next request.</p>
-     */
-    NextToken?: string;
-    /**
-     * <p>The maximum number of models to return in the response.</p>
-     */
-    MaxResults?: number;
-    /**
-     * <p>A string in the model name. This filter returns only models whose name contains the
-     *             specified string.</p>
-     */
-    NameContains?: string;
-    /**
-     * <p>A filter that returns only models created before the specified time
-     *             (timestamp).</p>
-     */
-    CreationTimeBefore?: Date;
-    /**
-     * <p>A filter that returns only models with a creation time greater than or equal to the
-     *             specified time (timestamp).</p>
-     */
-    CreationTimeAfter?: Date;
-}
 /**
- * <p>Provides summary information about a model.</p>
+ * @internal
  */
-export interface ModelSummary {
-    /**
-     * <p>The name of the model that you want a summary for.</p>
-     */
-    ModelName: string | undefined;
-    /**
-     * <p>The Amazon Resource Name (ARN) of the model.</p>
-     */
-    ModelArn: string | undefined;
-    /**
-     * <p>A timestamp that indicates when the model was created.</p>
-     */
-    CreationTime: Date | undefined;
-}
-export interface ListModelsOutput {
-    /**
-     * <p>An array of <code>ModelSummary</code> objects, each of which lists a
-     *             model.</p>
-     */
-    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>
-     */
-    NextToken?: string;
-}
-export declare enum MonitoringExecutionSortKey {
-    CREATION_TIME = "CreationTime",
-    SCHEDULED_TIME = "ScheduledTime",
-    STATUS = "Status"
-}
-export interface ListMonitoringExecutionsRequest {
-    /**
-     * <p>Name of a specific schedule to fetch jobs for.</p>
-     */
-    MonitoringScheduleName?: string;
-    /**
-     * <p>Name of a specific endpoint to fetch jobs for.</p>
-     */
-    EndpointName?: string;
-    /**
-     * <p>Whether to sort results by <code>Status</code>, <code>CreationTime</code>,
-     *             <code>ScheduledTime</code> field. The default is <code>CreationTime</code>.</p>
-     */
-    SortBy?: MonitoringExecutionSortKey | string;
-    /**
-     * <p>Whether to sort the results in <code>Ascending</code> or <code>Descending</code> order.
-     *          The default is <code>Descending</code>.</p>
-     */
-    SortOrder?: SortOrder | string;
-    /**
-     * <p>The token returned if the response is truncated. To retrieve the next set of job
-     *          executions, use it in the next request.</p>
-     */
-    NextToken?: string;
-    /**
-     * <p>The maximum number of jobs to return in the response. The default value is 10.</p>
-     */
-    MaxResults?: number;
-    /**
-     * <p>Filter for jobs scheduled before a specified time.</p>
-     */
-    ScheduledTimeBefore?: Date;
-    /**
-     * <p>Filter for jobs scheduled after a specified time.</p>
-     */
-    ScheduledTimeAfter?: Date;
-    /**
-     * <p>A filter that returns only jobs created before a specified time.</p>
-     */
-    CreationTimeBefore?: Date;
-    /**
-     * <p>A filter that returns only jobs created after a specified time.</p>
-     */
-    CreationTimeAfter?: Date;
-    /**
-     * <p>A filter that returns only jobs modified after a specified time.</p>
-     */
-    LastModifiedTimeBefore?: Date;
-    /**
-     * <p>A filter that returns only jobs modified before a specified time.</p>
-     */
-    LastModifiedTimeAfter?: Date;
-    /**
-     * <p>A filter that retrieves only jobs with a specific status.</p>
-     */
-    StatusEquals?: ExecutionStatus | string;
-    /**
-     * <p>Gets a list of the monitoring job runs of the specified monitoring job
-     *          definitions.</p>
-     */
-    MonitoringJobDefinitionName?: string;
-    /**
-     * <p>A filter that returns only the monitoring job runs of the specified monitoring
-     *          type.</p>
-     */
-    MonitoringTypeEquals?: MonitoringType | string;
-}
-export interface ListMonitoringExecutionsResponse {
-    /**
-     * <p>A JSON array in which each element is a summary for a monitoring execution.</p>
-     */
-    MonitoringExecutionSummaries: MonitoringExecutionSummary[] | undefined;
-    /**
-     * <p>If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of jobs,
-     *          use it in the subsequent reques</p>
-     */
-    NextToken?: string;
-}
-export declare enum MonitoringScheduleSortKey {
-    CREATION_TIME = "CreationTime",
-    NAME = "Name",
-    STATUS = "Status"
-}
-export interface ListMonitoringSchedulesRequest {
-    /**
-     * <p>Name of a specific endpoint to fetch schedules for.</p>
-     */
-    EndpointName?: string;
-    /**
-     * <p>Whether to sort results by <code>Status</code>, <code>CreationTime</code>,
-     *             <code>ScheduledTime</code> field. The default is <code>CreationTime</code>.</p>
-     */
-    SortBy?: MonitoringScheduleSortKey | string;
-    /**
-     * <p>Whether to sort the results in <code>Ascending</code> or <code>Descending</code> order.
-     *          The default is <code>Descending</code>.</p>
-     */
-    SortOrder?: SortOrder | string;
-    /**
-     * <p>The token returned if the response is truncated. To retrieve the next set of job
-     *          executions, use it in the next request.</p>
-     */
-    NextToken?: string;
-    /**
-     * <p>The maximum number of jobs to return in the response. The default value is 10.</p>
-     */
-    MaxResults?: number;
-    /**
-     * <p>Filter for monitoring schedules whose name contains a specified string.</p>
-     */
-    NameContains?: string;
-    /**
-     * <p>A filter that returns only monitoring schedules created before a specified time.</p>
-     */
-    CreationTimeBefore?: Date;
-    /**
-     * <p>A filter that returns only monitoring schedules created after a specified time.</p>
-     */
-    CreationTimeAfter?: Date;
-    /**
-     * <p>A filter that returns only monitoring schedules modified before a specified time.</p>
-     */
-    LastModifiedTimeBefore?: Date;
-    /**
-     * <p>A filter that returns only monitoring schedules modified after a specified time.</p>
-     */
-    LastModifiedTimeAfter?: Date;
-    /**
-     * <p>A filter that returns only monitoring schedules modified before a specified time.</p>
-     */
-    StatusEquals?: ScheduleStatus | string;
-    /**
-     * <p>Gets a list of the monitoring schedules for the specified monitoring job
-     *          definition.</p>
-     */
-    MonitoringJobDefinitionName?: string;
-    /**
-     * <p>A filter that returns only the monitoring schedules for the specified monitoring
-     *          type.</p>
-     */
-    MonitoringTypeEquals?: MonitoringType | string;
-}
+export declare const DescribeEndpointConfigOutputFilterSensitiveLog: (obj: DescribeEndpointConfigOutput) => any;
 /**
- * <p>Summarizes the monitoring schedule.</p>
+ * @internal
  */
-export interface MonitoringScheduleSummary {
-    /**
-     * <p>The name of the monitoring schedule.</p>
-     */
-    MonitoringScheduleName: string | undefined;
-    /**
-     * <p>The Amazon Resource Name (ARN) of the monitoring schedule.</p>
-     */
-    MonitoringScheduleArn: string | undefined;
-    /**
-     * <p>The creation time of the monitoring schedule.</p>
-     */
-    CreationTime: Date | undefined;
-    /**
-     * <p>The last time the monitoring schedule was modified.</p>
-     */
-    LastModifiedTime: Date | undefined;
-    /**
-     * <p>The status of the monitoring schedule.</p>
-     */
-    MonitoringScheduleStatus: ScheduleStatus | string | undefined;
-    /**
-     * <p>The name of the endpoint using the monitoring schedule.</p>
-     */
-    EndpointName?: string;
-    /**
-     * <p>The name of the monitoring job definition that the schedule is for.</p>
-     */
-    MonitoringJobDefinitionName?: string;
-    /**
-     * <p>The type of the monitoring job definition that the schedule is for.</p>
-     */
-    MonitoringType?: MonitoringType | string;
-}
+export declare const DescribeExperimentRequestFilterSensitiveLog: (obj: DescribeExperimentRequest) => any;
+/**
+ * @internal
+ */
+export declare const ExperimentSourceFilterSensitiveLog: (obj: ExperimentSource) => any;
+/**
+ * @internal
+ */
+export declare const DescribeExperimentResponseFilterSensitiveLog: (obj: DescribeExperimentResponse) => any;
+/**
+ * @internal
+ */
+export declare const DescribeFeatureGroupRequestFilterSensitiveLog: (obj: DescribeFeatureGroupRequest) => any;
+/**
+ * @internal
+ */
+export declare const LastUpdateStatusFilterSensitiveLog: (obj: LastUpdateStatus) => any;
 /**
  * @internal
  */
@@ -8433,31 +8347,3 @@ export declare const ListModelQualityJobDefinitionsRequestFilterSensitiveLog: (o
  * @internal
  */
 export declare const ListModelQualityJobDefinitionsResponseFilterSensitiveLog: (obj: ListModelQualityJobDefinitionsResponse) => any;
-/**
- * @internal
- */
-export declare const ListModelsInputFilterSensitiveLog: (obj: ListModelsInput) => any;
-/**
- * @internal
- */
-export declare const ModelSummaryFilterSensitiveLog: (obj: ModelSummary) => any;
-/**
- * @internal
- */
-export declare const ListModelsOutputFilterSensitiveLog: (obj: ListModelsOutput) => any;
-/**
- * @internal
- */
-export declare const ListMonitoringExecutionsRequestFilterSensitiveLog: (obj: ListMonitoringExecutionsRequest) => any;
-/**
- * @internal
- */
-export declare const ListMonitoringExecutionsResponseFilterSensitiveLog: (obj: ListMonitoringExecutionsResponse) => any;
-/**
- * @internal
- */
-export declare const ListMonitoringSchedulesRequestFilterSensitiveLog: (obj: ListMonitoringSchedulesRequest) => any;
-/**
- * @internal
- */
-export declare const MonitoringScheduleSummaryFilterSensitiveLog: (obj: MonitoringScheduleSummary) => any;