The name of the MLflow Tracking Server to update.
* @public */ TrackingServerName: string | undefined; /** *The new S3 URI for the general purpose bucket to use as the artifact store for the MLflow Tracking Server.
* @public */ ArtifactStoreUri?: string | undefined; /** *The new size for the MLflow Tracking Server.
* @public */ TrackingServerSize?: TrackingServerSize | undefined; /** *Whether to enable or disable automatic registration of new MLflow models to the SageMaker Model Registry. To enable automatic model registration, set this value to True. To disable automatic model registration, set this value to False. If not specified, AutomaticModelRegistration defaults to False
The new weekly maintenance window start day and time to update. The maintenance window day and time should be in Coordinated Universal Time (UTC) 24-hour standard time. For example: TUE:03:30.
* @public */ WeeklyMaintenanceWindowStart?: string | undefined; /** *The new expected Amazon Web Services account ID that owns the Amazon S3 bucket for artifact storage.
* @public */ S3BucketOwnerAccountId?: string | undefined; /** *Whether to enable or disable Amazon S3 Bucket Owenrship Verifaction whenever the MLflow Tracking Server interacts with Amazon Amazon S3.
* @public */ S3BucketOwnerVerification?: boolean | undefined; } /** * @public */ export interface UpdateMlflowTrackingServerResponse { /** *The ARN of the updated MLflow Tracking Server.
* @public */ TrackingServerArn?: string | undefined; } /** * @public */ export interface UpdateModelCardRequest { /** *The name or Amazon Resource Name (ARN) of the model card to update.
* @public */ ModelCardName: string | undefined; /** *The updated model card content. Content must be in model card JSON schema and provided as a string.
When updating model card content, be sure to include the full content and not just updated content.
* @public */ Content?: string | undefined; /** *The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.
Draft: The model card is a work in progress.
PendingReview: The model card is pending review.
Approved: The model card is approved.
Archived: The model card is archived. No more updates should be made to the model card, but it can still be exported.
The Amazon Resource Name (ARN) of the updated model card.
* @public */ ModelCardArn: string | undefined; } /** * @public */ export interface UpdateModelPackageInput { /** *The Amazon Resource Name (ARN) of the model package.
* @public */ ModelPackageArn: string | undefined; /** *The approval status of the model.
* @public */ ModelApprovalStatus?: ModelApprovalStatus | undefined; /** *The package registration type of the model package input.
* @public */ ModelPackageRegistrationType?: ModelPackageRegistrationType | undefined; /** *A description for the approval status of the model.
* @public */ ApprovalDescription?: string | undefined; /** *The metadata properties associated with the model package versions.
* @public */ CustomerMetadataProperties?: RecordThe metadata properties associated with the model package versions to remove.
* @public */ CustomerMetadataPropertiesToRemove?: string[] | undefined; /** *An array of additional Inference Specification objects to be added to the existing array additional Inference Specification. Total number of additional Inference Specifications can not exceed 15. Each additional Inference Specification specifies artifacts based on this model package that can be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.
* @public */ AdditionalInferenceSpecificationsToAdd?: AdditionalInferenceSpecificationDefinition[] | undefined; /** *Specifies details about inference jobs that you can run with models based on this model package, including the following information:
The Amazon ECR paths of containers that contain the inference code and model artifacts.
The instance types that the model package supports for transform jobs and real-time endpoints used for inference.
The input and output content formats that the model package supports for inference.
The URI of the source for the model package.
* @public */ SourceUri?: string | undefined; /** *The model card associated with the model package. Since ModelPackageModelCard is tied to a model package, it is a specific usage of a model card and its schema is simplified compared to the schema of ModelCard. The ModelPackageModelCard schema does not include model_package_details, and model_overview is composed of the model_creator and model_artifact properties. For more information about the model package model card schema, see Model package model card schema. For more information about the model card associated with the model package, see View the Details of a Model Version.
A structure describing the current state of the model in its life cycle.
* @public */ ModelLifeCycle?: ModelLifeCycle | undefined; /** *A unique token that guarantees that the call to this API is idempotent.
* @public */ ClientToken?: string | undefined; } /** * @public */ export interface UpdateModelPackageOutput { /** *The Amazon Resource Name (ARN) of the model.
* @public */ ModelPackageArn: string | undefined; } /** * @public */ export interface UpdateMonitoringAlertRequest { /** *The name of a monitoring schedule.
* @public */ MonitoringScheduleName: string | undefined; /** *The name of a monitoring alert.
* @public */ MonitoringAlertName: string | undefined; /** *Within EvaluationPeriod, how many execution failures will raise an alert.
The number of most recent monitoring executions to consider when evaluating alert status.
* @public */ EvaluationPeriod: number | undefined; } /** * @public */ export interface UpdateMonitoringAlertResponse { /** *The Amazon Resource Name (ARN) of the monitoring schedule.
* @public */ MonitoringScheduleArn: string | undefined; /** *The name of a monitoring alert.
* @public */ MonitoringAlertName?: string | undefined; } /** * @public */ export interface UpdateMonitoringScheduleRequest { /** *The name of the monitoring schedule. The name must be unique within an Amazon Web Services Region within an Amazon Web Services account.
* @public */ MonitoringScheduleName: string | undefined; /** *The configuration object that specifies the monitoring schedule and defines the monitoring job.
* @public */ MonitoringScheduleConfig: MonitoringScheduleConfig | undefined; } /** * @public */ export interface UpdateMonitoringScheduleResponse { /** *The Amazon Resource Name (ARN) of the monitoring schedule.
* @public */ MonitoringScheduleArn: string | undefined; } /** * @public */ export interface UpdateNotebookInstanceInput { /** *The name of the notebook instance to update.
* @public */ NotebookInstanceName: string | undefined; /** *The Amazon ML compute instance type.
* @public */ InstanceType?: _InstanceType | undefined; /** *The IP address type for the notebook instance. Specify ipv4 for IPv4-only connectivity or dualstack for both IPv4 and IPv6 connectivity. The notebook instance must be stopped before updating this setting. When you specify dualstack, the subnet must support IPv6 addressing.
The platform identifier of the notebook instance runtime environment.
* @public */ PlatformIdentifier?: string | undefined; /** *The Amazon Resource Name (ARN) of the IAM role that SageMaker AI can assume to access the notebook instance. For more information, see SageMaker AI Roles.
To be able to pass this role to SageMaker AI, the caller of this API must have the iam:PassRole permission.
The name of a lifecycle configuration to associate with the notebook instance. For information about lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.
* @public */ LifecycleConfigName?: string | undefined; /** *Set to true to remove the notebook instance lifecycle configuration currently associated with the notebook instance. This operation is idempotent. If you specify a lifecycle configuration that is not associated with the notebook instance when you call this method, it does not throw an error.
The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB. ML storage volumes are encrypted, so SageMaker AI can't determine the amount of available free space on the volume. Because of this, you can increase the volume size when you update a notebook instance, but you can't decrease the volume size. If you want to decrease the size of the ML storage volume in use, create a new notebook instance with the desired size.
* @public */ VolumeSizeInGB?: number | undefined; /** *The Git repository to associate 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 Amazon Web Services CodeCommit 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 Associating Git Repositories with SageMaker AI Notebook Instances.
* @public */ DefaultCodeRepository?: string | undefined; /** *An array of up to three Git repositories to associate 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 Amazon Web Services CodeCommit 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 Associating Git Repositories with SageMaker AI Notebook Instances.
* @public */ AdditionalCodeRepositories?: string[] | undefined; /** *This parameter is no longer supported. Elastic Inference (EI) is no longer available.
This parameter was used to specify a list of the EI instance types to associate with this notebook instance.
* @public */ AcceleratorTypes?: NotebookInstanceAcceleratorType[] | undefined; /** *This parameter is no longer supported. Elastic Inference (EI) is no longer available.
This parameter was used to specify a list of the EI instance types to remove from this notebook instance.
* @public */ DisassociateAcceleratorTypes?: boolean | undefined; /** *The name or URL of the default Git repository to remove from this notebook instance. This operation is idempotent. If you specify a Git repository that is not associated with the notebook instance when you call this method, it does not throw an error.
* @public */ DisassociateDefaultCodeRepository?: boolean | undefined; /** *A list of names or URLs of the default Git repositories to remove from this notebook instance. This operation is idempotent. If you specify a Git repository that is not associated with the notebook instance when you call this method, it does not throw an error.
* @public */ DisassociateAdditionalCodeRepositories?: boolean | undefined; /** *Whether root access is enabled or disabled for users of the notebook instance. The default value is Enabled.
If you set this to Disabled, users don't have root access on the notebook instance, but lifecycle configuration scripts still run with root permissions.
Information on the IMDS configuration of the notebook instance
* @public */ InstanceMetadataServiceConfiguration?: InstanceMetadataServiceConfiguration | undefined; } /** * @public */ export interface UpdateNotebookInstanceOutput { } /** * @public */ export interface UpdateNotebookInstanceLifecycleConfigInput { /** *The name of the lifecycle configuration.
* @public */ NotebookInstanceLifecycleConfigName: string | undefined; /** *The shell script that runs only once, when you create a notebook instance. The shell script must be a base64-encoded string.
* @public */ OnCreate?: NotebookInstanceLifecycleHook[] | undefined; /** *The shell script that runs every time you start a notebook instance, including when you create the notebook instance. The shell script must be a base64-encoded string.
* @public */ OnStart?: NotebookInstanceLifecycleHook[] | undefined; } /** * @public */ export interface UpdateNotebookInstanceLifecycleConfigOutput { } /** * @public */ export interface UpdatePartnerAppRequest { /** *The ARN of the SageMaker Partner AI App to update.
* @public */ Arn: string | undefined; /** *Maintenance configuration settings for the SageMaker Partner AI App.
* @public */ MaintenanceConfig?: PartnerAppMaintenanceConfig | undefined; /** *Indicates the instance type and size of the cluster attached to the SageMaker Partner AI App.
* @public */ Tier?: string | undefined; /** *Configuration settings for the SageMaker Partner AI App.
* @public */ ApplicationConfig?: PartnerAppConfig | undefined; /** *When set to TRUE, the SageMaker Partner AI App sets the Amazon Web Services IAM session name or the authenticated IAM user as the identity of the SageMaker Partner AI App user.
When set to TRUE, the SageMaker Partner AI App is automatically upgraded to the latest minor version during the next scheduled maintenance window, if one is available.
The semantic version to upgrade the SageMaker Partner AI App to. Must be the same semantic version returned in the AvailableUpgrade field from DescribePartnerApp. Version skipping and downgrades are not supported.
A unique token that guarantees that the call to this API is idempotent.
* @public */ ClientToken?: string | undefined; /** *Each tag consists of a key and an optional value. Tag keys must be unique per resource.
* @public */ Tags?: Tag[] | undefined; } /** * @public */ export interface UpdatePartnerAppResponse { /** *The ARN of the SageMaker Partner AI App that was updated.
* @public */ Arn?: string | undefined; } /** * @public */ export interface UpdatePipelineRequest { /** *The name of the pipeline to update.
* @public */ PipelineName: string | undefined; /** *The display name of the pipeline.
* @public */ PipelineDisplayName?: string | undefined; /** *The JSON pipeline definition.
* @public */ PipelineDefinition?: string | undefined; /** *The location of the pipeline definition stored in Amazon S3. If specified, SageMaker will retrieve the pipeline definition from this location.
* @public */ PipelineDefinitionS3Location?: PipelineDefinitionS3Location | undefined; /** *The description of the pipeline.
* @public */ PipelineDescription?: string | undefined; /** *The Amazon Resource Name (ARN) that the pipeline uses to execute.
* @public */ RoleArn?: string | undefined; /** *If specified, it applies to all executions of this pipeline by default.
* @public */ ParallelismConfiguration?: ParallelismConfiguration | undefined; } /** * @public */ export interface UpdatePipelineResponse { /** *The Amazon Resource Name (ARN) of the updated pipeline.
* @public */ PipelineArn?: string | undefined; /** *The ID of the pipeline version.
* @public */ PipelineVersionId?: number | undefined; } /** * @public */ export interface UpdatePipelineExecutionRequest { /** *The Amazon Resource Name (ARN) of the pipeline execution.
* @public */ PipelineExecutionArn: string | undefined; /** *The description of the pipeline execution.
* @public */ PipelineExecutionDescription?: string | undefined; /** *The display name of the pipeline execution.
* @public */ PipelineExecutionDisplayName?: string | undefined; /** *This configuration, if specified, overrides the parallelism configuration of the parent pipeline for this specific run.
* @public */ ParallelismConfiguration?: ParallelismConfiguration | undefined; } /** * @public */ export interface UpdatePipelineExecutionResponse { /** *The Amazon Resource Name (ARN) of the updated pipeline execution.
* @public */ PipelineExecutionArn?: string | undefined; } /** * @public */ export interface UpdatePipelineVersionRequest { /** *The Amazon Resource Name (ARN) of the pipeline.
* @public */ PipelineArn: string | undefined; /** *The pipeline version ID to update.
* @public */ PipelineVersionId: number | undefined; /** *The display name of the pipeline version.
* @public */ PipelineVersionDisplayName?: string | undefined; /** *The description of the pipeline version.
* @public */ PipelineVersionDescription?: string | undefined; } /** * @public */ export interface UpdatePipelineVersionResponse { /** *The Amazon Resource Name (ARN) of the pipeline.
* @public */ PipelineArn?: string | undefined; /** *The ID of the pipeline version.
* @public */ PipelineVersionId?: number | undefined; } /** *Details that you specify to provision a service catalog product. For information about service catalog, see What is Amazon Web Services Service Catalog.
* @public */ export interface ServiceCatalogProvisioningUpdateDetails { /** *The ID of the provisioning artifact.
* @public */ ProvisioningArtifactId?: string | undefined; /** *A list of key value pairs that you specify when you provision a product.
* @public */ ProvisioningParameters?: ProvisioningParameter[] | undefined; } /** *Contains configuration details for updating an existing template provider in the project.
* @public */ export interface UpdateTemplateProvider { /** *The CloudFormation template provider configuration to update.
* @public */ CfnTemplateProvider?: CfnUpdateTemplateProvider | undefined; } /** * @public */ export interface UpdateProjectInput { /** *The name of the project.
* @public */ ProjectName: string | undefined; /** *The description for the project.
* @public */ ProjectDescription?: string | undefined; /** *The product ID and provisioning artifact ID to provision a service catalog. The provisioning artifact ID will default to the latest provisioning artifact ID of the product, if you don't provide the provisioning artifact ID. For more information, see What is Amazon Web Services Service Catalog.
* @public */ ServiceCatalogProvisioningUpdateDetails?: ServiceCatalogProvisioningUpdateDetails | undefined; /** *An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources. In addition, the project must have tag update constraints set in order to include this parameter in the request. For more information, see Amazon Web Services Service Catalog Tag Update Constraints.
* @public */ Tags?: Tag[] | undefined; /** *The template providers to update in the project.
* @public */ TemplateProvidersToUpdate?: UpdateTemplateProvider[] | undefined; } /** * @public */ export interface UpdateProjectOutput { /** *The Amazon Resource Name (ARN) of the project.
* @public */ ProjectArn: string | undefined; } /** * @public */ export interface UpdateSpaceRequest { /** *The ID of the associated domain.
* @public */ DomainId: string | undefined; /** *The name of the space.
* @public */ SpaceName: string | undefined; /** *A collection of space settings.
* @public */ SpaceSettings?: SpaceSettings | undefined; /** *The name of the space that appears in the Amazon SageMaker Studio UI.
* @public */ SpaceDisplayName?: string | undefined; } /** * @public */ export interface UpdateSpaceResponse { /** *The space's Amazon Resource Name (ARN).
* @public */ SpaceArn?: string | undefined; } /** * @public */ export interface UpdateTrainingJobRequest { /** *The name of a training job to update the Debugger profiling configuration.
* @public */ TrainingJobName: string | undefined; /** *Configuration information for Amazon SageMaker Debugger system monitoring, framework profiling, and storage paths.
* @public */ ProfilerConfig?: ProfilerConfigForUpdate | undefined; /** *Configuration information for Amazon SageMaker Debugger rules for profiling system and framework metrics.
* @public */ ProfilerRuleConfigurations?: ProfilerRuleConfiguration[] | undefined; /** *The training job ResourceConfig to update warm pool retention length.
Configuration for remote debugging while the training job is running. You can update the remote debugging configuration when the SecondaryStatus of the job is Downloading or Training.To learn more about the remote debugging functionality of SageMaker, see Access a training container through Amazon Web Services Systems Manager (SSM) for remote debugging.
The Amazon Resource Name (ARN) of the training job.
* @public */ TrainingJobArn: string | undefined; } /** * @public */ export interface UpdateTrialRequest { /** *The name of the trial to update.
* @public */ TrialName: string | undefined; /** *The name of the trial as displayed. The name doesn't need to be unique. If DisplayName isn't specified, TrialName is displayed.
The Amazon Resource Name (ARN) of the trial.
* @public */ TrialArn?: string | undefined; } /** * @public */ export interface UpdateTrialComponentRequest { /** *The name of the component to update.
* @public */ TrialComponentName: string | undefined; /** *The name of the component as displayed. The name doesn't need to be unique. If DisplayName isn't specified, TrialComponentName is displayed.
The new status of the component.
* @public */ Status?: TrialComponentStatus | undefined; /** *When the component started.
* @public */ StartTime?: Date | undefined; /** *When the component ended.
* @public */ EndTime?: Date | undefined; /** *Replaces all of the component's hyperparameters with the specified hyperparameters or add new hyperparameters. Existing hyperparameters are replaced if the trial component is updated with an identical hyperparameter key.
* @public */ Parameters?: RecordThe hyperparameters to remove from the component.
* @public */ ParametersToRemove?: string[] | undefined; /** *Replaces all of the component's input artifacts with the specified artifacts or adds new input artifacts. Existing input artifacts are replaced if the trial component is updated with an identical input artifact key.
* @public */ InputArtifacts?: RecordThe input artifacts to remove from the component.
* @public */ InputArtifactsToRemove?: string[] | undefined; /** *Replaces all of the component's output artifacts with the specified artifacts or adds new output artifacts. Existing output artifacts are replaced if the trial component is updated with an identical output artifact key.
* @public */ OutputArtifacts?: RecordThe output artifacts to remove from the component.
* @public */ OutputArtifactsToRemove?: string[] | undefined; } /** * @public */ export interface UpdateTrialComponentResponse { /** *The Amazon Resource Name (ARN) of the trial component.
* @public */ TrialComponentArn?: string | undefined; } /** * @public */ export interface UpdateUserProfileRequest { /** *The domain ID.
* @public */ DomainId: string | undefined; /** *The user profile name.
* @public */ UserProfileName: string | undefined; /** *A collection of settings.
* @public */ UserSettings?: UserSettings | undefined; } /** * @public */ export interface UpdateUserProfileResponse { /** *The user profile Amazon Resource Name (ARN).
* @public */ UserProfileArn?: string | undefined; } /** * @public */ export interface UpdateWorkforceRequest { /** *The name of the private workforce that you want to update. You can find your workforce name by using the ListWorkforces operation.
* @public */ WorkforceName: string | undefined; /** *A list of one to ten worker IP address ranges (CIDRs) that can be used to access tasks assigned to this workforce.
Maximum: Ten CIDR values
* @public */ SourceIpConfig?: SourceIpConfig | undefined; /** *Use this parameter to update your OIDC Identity Provider (IdP) configuration for a workforce made using your own IdP.
* @public */ OidcConfig?: OidcConfig | undefined; /** *Use this parameter to update your VPC configuration for a workforce.
* @public */ WorkforceVpcConfig?: WorkforceVpcConfigRequest | undefined; /** *Use this parameter to specify whether you want IPv4 only or dualstack (IPv4 and IPv6) to support your labeling workforce.
A single private workforce. You can create one private work force in each Amazon Web Services Region. By default, any workforce-related API operation used in a specific region will apply to the workforce created in that region. To learn how to create a private workforce, see Create a Private Workforce.
* @public */ Workforce: Workforce | undefined; } /** * @public */ export interface UpdateWorkteamRequest { /** *The name of the work team to update.
* @public */ WorkteamName: string | undefined; /** *A list of MemberDefinition objects that contains objects that identify the workers that make up the work team.
Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). For private workforces created using Amazon Cognito use CognitoMemberDefinition. For workforces created using your own OIDC identity provider (IdP) use OidcMemberDefinition. You should not provide input for both of these parameters in a single request.
For workforces created using Amazon Cognito, private work teams correspond to Amazon Cognito user groups within the user pool used to create a workforce. All of the CognitoMemberDefinition objects that make up the member definition must have the same ClientId and UserPool values. To add a Amazon Cognito user group to an existing worker pool, see Adding groups to a User Pool. For more information about user pools, see Amazon Cognito User Pools.
For workforces created using your own OIDC IdP, specify the user groups that you want to include in your private work team in OidcMemberDefinition by listing those groups in Groups. Be aware that user groups that are already in the work team must also be listed in Groups when you make this request to remain on the work team. If you do not include these user groups, they will no longer be associated with the work team you update.
An updated description for the work team.
* @public */ Description?: string | undefined; /** *Configures SNS topic notifications for available or expiring work items
* @public */ NotificationConfiguration?: NotificationConfiguration | undefined; /** *Use this optional parameter to constrain access to an Amazon S3 resource based on the IP address using supported IAM global condition keys. The Amazon S3 resource is accessed in the worker portal using a Amazon S3 presigned URL.
* @public */ WorkerAccessConfiguration?: WorkerAccessConfiguration | undefined; } /** * @public */ export interface UpdateWorkteamResponse { /** *A Workteam object that describes the updated work team.
A multi-expression that searches for the specified resource or resources in a search. All resource objects that satisfy the expression's condition are included in the search results. You must specify at least one subexpression, filter, or nested filter. A SearchExpression can contain up to twenty elements.
A SearchExpression contains the following components:
A list of Filter objects. Each filter defines a simple Boolean expression comprised of a resource property name, Boolean operator, and value.
A list of NestedFilter objects. Each nested filter defines a list of Boolean expressions using a list of resource properties. A nested filter is satisfied if a single object in the list satisfies all Boolean expressions.
A list of SearchExpression objects. A search expression object can be nested in a list of search expression objects.
A Boolean operator: And or Or.
A list of filter objects.
* @public */ Filters?: Filter[] | undefined; /** *A list of nested filter objects.
* @public */ NestedFilters?: NestedFilters[] | undefined; /** *A list of search expression objects.
* @public */ SubExpressions?: SearchExpression[] | undefined; /** *A Boolean operator used to evaluate the search expression. If you want every conditional statement in all lists to be satisfied for the entire search expression to be true, specify And. If only a single conditional statement needs to be true for the entire search expression to be true, specify Or. The default value is And.
The name of the SageMaker resource to search for.
* @public */ Resource: ResourceType | undefined; /** *A Boolean conditional statement. Resources must satisfy this condition to be included in search results. You must provide at least one subexpression, filter, or nested filter. The maximum number of recursive SubExpressions, NestedFilters, and Filters that can be included in a SearchExpression object is 50.
The name of the resource property used to sort the SearchResults. The default is LastModifiedTime.
How SearchResults are ordered. Valid values are Ascending or Descending. The default is Descending.
If more than MaxResults resources match the specified SearchExpression, the response includes a NextToken. The NextToken can be passed to the next SearchRequest to continue retrieving results.
The maximum number of results to return.
* @public */ MaxResults?: number | undefined; /** * A cross account filter option. When the value is "CrossAccount" the search results will only include resources made discoverable to you from other accounts. When the value is "SameAccount" or null the search results will only include resources from your account. Default is null. For more information on searching for resources made discoverable to your account, see Search discoverable resources in the SageMaker Developer Guide. The maximum number of ResourceCatalogs viewable is 1000.
Limits the results of your search request to the resources that you can access.
* @public */ VisibilityConditions?: VisibilityConditions[] | undefined; }