AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon SageMaker Service UpdateDomain API operation.

Syntax

Update-SMDomain
-DomainId <String>
-AppNetworkAccessType <AppNetworkAccessType>
-AppSecurityGroupManagement <AppSecurityGroupManagement>
-EmrSettings_AssumableRoleArn <String[]>
-JupyterLabAppSettings_BuiltInLifecycleConfigArn <String>
-JupyterLabAppSettings_CodeRepository <CodeRepository[]>
-JupyterServerAppSettings_CodeRepository <CodeRepository[]>
-DefaultSpaceSettings_CustomFileSystemConfig <CustomFileSystemConfig[]>
-JupyterLabAppSettings_CustomImage <CustomImage[]>
-KernelGatewayAppSettings_CustomImage <CustomImage[]>
-DefaultEbsStorageSettings_DefaultEbsVolumeSizeInGb <Int32>
-DefaultUserSetting <UserSettings>
-UnifiedStudioSettings_DomainAccountId <String>
-RStudioServerProDomainSettingsForUpdate_DomainExecutionRoleArn <String>
-UnifiedStudioSettings_DomainId <String>
-UnifiedStudioSettings_DomainRegion <String>
-DockerSettings_EnableDockerAccess <FeatureStatus>
-UnifiedStudioSettings_EnvironmentId <String>
-DefaultSpaceSettings_ExecutionRole <String>
-EmrSettings_ExecutionRoleArn <String[]>
-DomainSettingsForUpdate_ExecutionRoleIdentityConfig <ExecutionRoleIdentityConfig>
-CustomPosixUserConfig_Gid <Int64>
-IdleSettings_IdleTimeoutInMinute <Int32>
-DefaultSpaceSettings_JupyterLabAppSettings_DefaultResourceSpec_InstanceType <AppInstanceType>
-DefaultSpaceSettings_JupyterServerAppSettings_DefaultResourceSpec_InstanceType <AppInstanceType>
-DefaultSpaceSettings_KernelGatewayAppSettings_DefaultResourceSpec_InstanceType <AppInstanceType>
-DefaultResourceSpec_InstanceType <AppInstanceType>
-DomainSettingsForUpdate_IpAddressType <IPAddressType>
-DefaultSpaceSettings_JupyterLabAppSettings_DefaultResourceSpec_LifecycleConfigArn <String>
-DefaultSpaceSettings_JupyterServerAppSettings_DefaultResourceSpec_LifecycleConfigArn <String>
-DefaultSpaceSettings_KernelGatewayAppSettings_DefaultResourceSpec_LifecycleConfigArn <String>
-DefaultResourceSpec_LifecycleConfigArn <String>
-JupyterLabAppSettings_LifecycleConfigArn <String[]>
-JupyterServerAppSettings_LifecycleConfigArn <String[]>
-KernelGatewayAppSettings_LifecycleConfigArn <String[]>
-IdleSettings_LifecycleManagement <LifecycleManagement>
-IdleSettings_MaxIdleTimeoutInMinute <Int32>
-DefaultEbsStorageSettings_MaximumEbsVolumeSizeInGb <Int32>
-IdleSettings_MinIdleTimeoutInMinute <Int32>
-UnifiedStudioSettings_ProjectId <String>
-UnifiedStudioSettings_ProjectS3Path <String>
-AmazonQSettings_QProfileArn <String>
-DockerSettings_RootlessDocker <FeatureStatus>
-RStudioServerProDomainSettingsForUpdate_RStudioConnectUrl <String>
-RStudioServerProDomainSettingsForUpdate_RStudioPackageManagerUrl <String>
-DefaultSpaceSettings_JupyterLabAppSettings_DefaultResourceSpec_SageMakerImageArn <String>
-DefaultSpaceSettings_JupyterServerAppSettings_DefaultResourceSpec_SageMakerImageArn <String>
-DefaultSpaceSettings_KernelGatewayAppSettings_DefaultResourceSpec_SageMakerImageArn <String>
-DefaultResourceSpec_SageMakerImageArn <String>
-DefaultResourceSpec_SageMakerImageVersionAlias <String>
-DefaultSpaceSettings_JupyterServerAppSettings_DefaultResourceSpec_SageMakerImageVersionAlias <String>
-DefaultSpaceSettings_KernelGatewayAppSettings_DefaultResourceSpec_SageMakerImageVersionAlias <String>
-DomainSettingsForUpdate_RStudioServerProDomainSettingsForUpdate_DefaultResourceSpec_SageMakerImageVersionAlias <String>
-DefaultSpaceSettings_JupyterLabAppSettings_DefaultResourceSpec_SageMakerImageVersionArn <String>
-DefaultSpaceSettings_JupyterServerAppSettings_DefaultResourceSpec_SageMakerImageVersionArn <String>
-DefaultSpaceSettings_KernelGatewayAppSettings_DefaultResourceSpec_SageMakerImageVersionArn <String>
-DefaultResourceSpec_SageMakerImageVersionArn <String>
-DomainSettingsForUpdate_SecurityGroupId <String[]>
-DefaultSpaceSettings_SecurityGroup <String[]>
-UnifiedStudioSettings_SingleSignOnApplicationArn <String>
-AmazonQSettings_Status <FeatureStatus>
-TrustedIdentityPropagationSettings_Status <FeatureStatus>
-UnifiedStudioSettings_StudioWebPortalAccess <FeatureStatus>
-SubnetId <String[]>
-TagPropagation <TagPropagation>
-CustomPosixUserConfig_Uid <Int64>
-DockerSettings_VpcOnlyTrustedAccount <String[]>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonSageMakerConfig>

Description

Updates the default settings for new user profiles in the domain.

Parameters

-AmazonQSettings_QProfileArn <String>
The ARN of the Amazon Q profile used within the domain.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDomainSettingsForUpdate_AmazonQSettings_QProfileArn
-AmazonQSettings_Status <FeatureStatus>
Whether Amazon Q has been enabled within the domain.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDomainSettingsForUpdate_AmazonQSettings_Status
-AppNetworkAccessType <AppNetworkAccessType>
Specifies the VPC used for non-EFS traffic.
  • PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker AI, which allows direct internet access.
  • VpcOnly - All Studio traffic is through the specified VPC and subnets.
This configuration can only be modified if there are no apps in the InService, Pending, or Deleting state. The configuration cannot be updated if DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is already set or DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided as part of the same request.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AppSecurityGroupManagement <AppSecurityGroupManagement>
The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode. Required when CreateDomain.AppNetworkAccessType is VPCOnly and DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided. If setting up the domain for use with RStudio, this value must be set to Service.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonSageMakerConfig>
Amazon.PowerShell.Cmdlets.SM.AmazonSageMakerClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CustomPosixUserConfig_Gid <Int64>
The POSIX group ID.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultSpaceSettings_CustomPosixUserConfig_Gid
-CustomPosixUserConfig_Uid <Int64>
The POSIX user ID.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultSpaceSettings_CustomPosixUserConfig_Uid
-DefaultEbsStorageSettings_DefaultEbsVolumeSizeInGb <Int32>
The default size of the EBS storage volume for a space.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultSpaceSettings_SpaceStorageSettings_DefaultEbsStorageSettings_DefaultEbsVolumeSizeInGb
-DefaultEbsStorageSettings_MaximumEbsVolumeSizeInGb <Int32>
The maximum size of the EBS storage volume for a space.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultSpaceSettings_SpaceStorageSettings_DefaultEbsStorageSettings_MaximumEbsVolumeSizeInGb
-DefaultResourceSpec_InstanceType <AppInstanceType>
The instance type that the image version runs on.JupyterServer apps only support the system value.For KernelGateway apps, the system value is translated to ml.t3.medium. KernelGateway apps also support all other values for available instance types.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDomainSettingsForUpdate_RStudioServerProDomainSettingsForUpdate_DefaultResourceSpec_InstanceType
-DefaultResourceSpec_LifecycleConfigArn <String>
The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDomainSettingsForUpdate_RStudioServerProDomainSettingsForUpdate_DefaultResourceSpec_LifecycleConfigArn
-DefaultResourceSpec_SageMakerImageArn <String>
The ARN of the SageMaker AI image that the image version belongs to.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDomainSettingsForUpdate_RStudioServerProDomainSettingsForUpdate_DefaultResourceSpec_SageMakerImageArn
-DefaultResourceSpec_SageMakerImageVersionAlias <String>
The SageMakerImageVersionAlias of the image to launch with. This value is in SemVer 2.0.0 versioning format.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultSpaceSettings_JupyterLabAppSettings_DefaultResourceSpec_SageMakerImageVersionAlias
-DefaultResourceSpec_SageMakerImageVersionArn <String>
The ARN of the image version created on the instance. To clear the value set for SageMakerImageVersionArn, pass None as the value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDomainSettingsForUpdate_RStudioServerProDomainSettingsForUpdate_DefaultResourceSpec_SageMakerImageVersionArn
-DefaultSpaceSettings_CustomFileSystemConfig <CustomFileSystemConfig[]>
The settings for assigning a custom file system to a domain. Permitted users can access this file system in Amazon SageMaker AI Studio. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultSpaceSettings_CustomFileSystemConfigs
-DefaultSpaceSettings_ExecutionRole <String>
The ARN of the execution role for the space.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DefaultSpaceSettings_JupyterLabAppSettings_DefaultResourceSpec_InstanceType <AppInstanceType>
The instance type that the image version runs on.JupyterServer apps only support the system value.For KernelGateway apps, the system value is translated to ml.t3.medium. KernelGateway apps also support all other values for available instance types.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DefaultSpaceSettings_JupyterLabAppSettings_DefaultResourceSpec_LifecycleConfigArn <String>
The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DefaultSpaceSettings_JupyterLabAppSettings_DefaultResourceSpec_SageMakerImageArn <String>
The ARN of the SageMaker AI image that the image version belongs to.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DefaultSpaceSettings_JupyterLabAppSettings_DefaultResourceSpec_SageMakerImageVersionArn <String>
The ARN of the image version created on the instance. To clear the value set for SageMakerImageVersionArn, pass None as the value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DefaultSpaceSettings_JupyterServerAppSettings_DefaultResourceSpec_InstanceType <AppInstanceType>
The instance type that the image version runs on.JupyterServer apps only support the system value.For KernelGateway apps, the system value is translated to ml.t3.medium. KernelGateway apps also support all other values for available instance types.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DefaultSpaceSettings_JupyterServerAppSettings_DefaultResourceSpec_LifecycleConfigArn <String>
The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DefaultSpaceSettings_JupyterServerAppSettings_DefaultResourceSpec_SageMakerImageArn <String>
The ARN of the SageMaker AI image that the image version belongs to.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DefaultSpaceSettings_JupyterServerAppSettings_DefaultResourceSpec_SageMakerImageVersionAlias <String>
The SageMakerImageVersionAlias of the image to launch with. This value is in SemVer 2.0.0 versioning format.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DefaultSpaceSettings_JupyterServerAppSettings_DefaultResourceSpec_SageMakerImageVersionArn <String>
The ARN of the image version created on the instance. To clear the value set for SageMakerImageVersionArn, pass None as the value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DefaultSpaceSettings_KernelGatewayAppSettings_DefaultResourceSpec_InstanceType <AppInstanceType>
The instance type that the image version runs on.JupyterServer apps only support the system value.For KernelGateway apps, the system value is translated to ml.t3.medium. KernelGateway apps also support all other values for available instance types.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DefaultSpaceSettings_KernelGatewayAppSettings_DefaultResourceSpec_LifecycleConfigArn <String>
The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DefaultSpaceSettings_KernelGatewayAppSettings_DefaultResourceSpec_SageMakerImageArn <String>
The ARN of the SageMaker AI image that the image version belongs to.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DefaultSpaceSettings_KernelGatewayAppSettings_DefaultResourceSpec_SageMakerImageVersionAlias <String>
The SageMakerImageVersionAlias of the image to launch with. This value is in SemVer 2.0.0 versioning format.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DefaultSpaceSettings_KernelGatewayAppSettings_DefaultResourceSpec_SageMakerImageVersionArn <String>
The ARN of the image version created on the instance. To clear the value set for SageMakerImageVersionArn, pass None as the value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DefaultSpaceSettings_SecurityGroup <String[]>
The security group IDs for the Amazon VPC that the space uses for communication. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultSpaceSettings_SecurityGroups
-DefaultUserSetting <UserSettings>
A collection of settings.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultUserSettings
-DockerSettings_EnableDockerAccess <FeatureStatus>
Indicates whether the domain can access Docker.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDomainSettingsForUpdate_DockerSettings_EnableDockerAccess
-DockerSettings_RootlessDocker <FeatureStatus>
Indicates whether to use rootless Docker.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDomainSettingsForUpdate_DockerSettings_RootlessDocker
-DockerSettings_VpcOnlyTrustedAccount <String[]>
The list of Amazon Web Services accounts that are trusted when the domain is created in VPC-only mode. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDomainSettingsForUpdate_DockerSettings_VpcOnlyTrustedAccounts
-DomainId <String>
The ID of the domain to be updated.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-DomainSettingsForUpdate_ExecutionRoleIdentityConfig <ExecutionRoleIdentityConfig>
The configuration for attaching a SageMaker AI user profile name to the execution role as a sts:SourceIdentity key. This configuration can only be modified if there are no apps in the InService or Pending state.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DomainSettingsForUpdate_IpAddressType <IPAddressType>
The IP address type for the domain. Specify ipv4 for IPv4-only connectivity or dualstack for both IPv4 and IPv6 connectivity. When you specify dualstack, the subnet must support IPv6 CIDR blocks.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DomainSettingsForUpdate_RStudioServerProDomainSettingsForUpdate_DefaultResourceSpec_SageMakerImageVersionAlias <String>
The SageMakerImageVersionAlias of the image to launch with. This value is in SemVer 2.0.0 versioning format.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DomainSettingsForUpdate_SecurityGroupId <String[]>
The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDomainSettingsForUpdate_SecurityGroupIds
-EmrSettings_AssumableRoleArn <String[]>
An array of Amazon Resource Names (ARNs) of the IAM roles that the execution role of SageMaker can assume for performing operations or tasks related to Amazon EMR clusters or Amazon EMR Serverless applications. These roles define the permissions and access policies required when performing Amazon EMR-related operations, such as listing, connecting to, or terminating Amazon EMR clusters or Amazon EMR Serverless applications. They are typically used in cross-account access scenarios, where the Amazon EMR resources (clusters or serverless applications) are located in a different Amazon Web Services account than the SageMaker domain. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultSpaceSettings_JupyterLabAppSettings_EmrSettings_AssumableRoleArns
-EmrSettings_ExecutionRoleArn <String[]>
An array of Amazon Resource Names (ARNs) of the IAM roles used by the Amazon EMR cluster instances or job execution environments to access other Amazon Web Services services and resources needed during the runtime of your Amazon EMR or Amazon EMR Serverless workloads, such as Amazon S3 for data access, Amazon CloudWatch for logging, or other Amazon Web Services services based on the particular workload requirements. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultSpaceSettings_JupyterLabAppSettings_EmrSettings_ExecutionRoleArns
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-IdleSettings_IdleTimeoutInMinute <Int32>
The time that SageMaker waits after the application becomes idle before shutting it down.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultSpaceSettings_JupyterLabAppSettings_AppLifecycleManagement_IdleSettings_IdleTimeoutInMinutes
-IdleSettings_LifecycleManagement <LifecycleManagement>
Indicates whether idle shutdown is activated for the application type.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultSpaceSettings_JupyterLabAppSettings_AppLifecycleManagement_IdleSettings_LifecycleManagement
-IdleSettings_MaxIdleTimeoutInMinute <Int32>
The maximum value in minutes that custom idle shutdown can be set to by the user.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultSpaceSettings_JupyterLabAppSettings_AppLifecycleManagement_IdleSettings_MaxIdleTimeoutInMinutes
-IdleSettings_MinIdleTimeoutInMinute <Int32>
The minimum value in minutes that custom idle shutdown can be set to by the user.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultSpaceSettings_JupyterLabAppSettings_AppLifecycleManagement_IdleSettings_MinIdleTimeoutInMinutes
-JupyterLabAppSettings_BuiltInLifecycleConfigArn <String>
The lifecycle configuration that runs before the default lifecycle configuration. It can override changes made in the default lifecycle configuration.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultSpaceSettings_JupyterLabAppSettings_BuiltInLifecycleConfigArn
-JupyterLabAppSettings_CodeRepository <CodeRepository[]>
A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterLab application. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultSpaceSettings_JupyterLabAppSettings_CodeRepositories
-JupyterLabAppSettings_CustomImage <CustomImage[]>
A list of custom SageMaker images that are configured to run as a JupyterLab app. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultSpaceSettings_JupyterLabAppSettings_CustomImages
-JupyterLabAppSettings_LifecycleConfigArn <String[]>
The Amazon Resource Name (ARN) of the lifecycle configurations attached to the user profile or domain. To remove a lifecycle config, you must set LifecycleConfigArns to an empty list. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultSpaceSettings_JupyterLabAppSettings_LifecycleConfigArns
-JupyterServerAppSettings_CodeRepository <CodeRepository[]>
A list of Git repositories that SageMaker AI automatically displays to users for cloning in the JupyterServer application. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultSpaceSettings_JupyterServerAppSettings_CodeRepositories
-JupyterServerAppSettings_LifecycleConfigArn <String[]>
The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the JupyterServerApp. If you use this parameter, the DefaultResourceSpec parameter is also required.To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty list. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultSpaceSettings_JupyterServerAppSettings_LifecycleConfigArns
-KernelGatewayAppSettings_CustomImage <CustomImage[]>
A list of custom SageMaker AI images that are configured to run as a KernelGateway app.The maximum number of custom images are as follows.
  • On a domain level: 200
  • On a space level: 5
  • On a user profile level: 5
Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultSpaceSettings_KernelGatewayAppSettings_CustomImages
-KernelGatewayAppSettings_LifecycleConfigArn <String[]>
The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the the user profile or domain.To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty list. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultSpaceSettings_KernelGatewayAppSettings_LifecycleConfigArns
-RStudioServerProDomainSettingsForUpdate_DomainExecutionRoleArn <String>
The execution role for the RStudioServerPro Domain-level app.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDomainSettingsForUpdate_RStudioServerProDomainSettingsForUpdate_DomainExecutionRoleArn
-RStudioServerProDomainSettingsForUpdate_RStudioConnectUrl <String>
A URL pointing to an RStudio Connect server.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDomainSettingsForUpdate_RStudioServerProDomainSettingsForUpdate_RStudioConnectUrl
-RStudioServerProDomainSettingsForUpdate_RStudioPackageManagerUrl <String>
A URL pointing to an RStudio Package Manager server.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDomainSettingsForUpdate_RStudioServerProDomainSettingsForUpdate_RStudioPackageManagerUrl
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'DomainArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.UpdateDomainResponse). Specifying the name of a property of type Amazon.SageMaker.Model.UpdateDomainResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SubnetId <String[]>
The VPC subnets that Studio uses for communication.If removing subnets, ensure there are no apps in the InService, Pending, or Deleting state. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSubnetIds
-TagPropagation <TagPropagation>
Indicates whether custom tag propagation is supported for the domain. Defaults to DISABLED.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TrustedIdentityPropagationSettings_Status <FeatureStatus>
The status of Trusted Identity Propagation (TIP) at the SageMaker domain level. When disabled, standard IAM role-based access is used. When enabled:
  • User identities from IAM Identity Center are propagated through the application to TIP enabled Amazon Web Services services.
  • New applications or existing applications that are automatically patched, will use the domain level configuration.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDomainSettingsForUpdate_TrustedIdentityPropagationSettings_Status
-UnifiedStudioSettings_DomainAccountId <String>
The ID of the Amazon Web Services account that has the Amazon SageMaker Unified Studio domain. The default value, if you don't specify an ID, is the ID of the account that has the Amazon SageMaker AI domain.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDomainSettingsForUpdate_UnifiedStudioSettings_DomainAccountId
-UnifiedStudioSettings_DomainId <String>
The ID of the Amazon SageMaker Unified Studio domain associated with this domain.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDomainSettingsForUpdate_UnifiedStudioSettings_DomainId
-UnifiedStudioSettings_DomainRegion <String>
The Amazon Web Services Region where the domain is located in Amazon SageMaker Unified Studio. The default value, if you don't specify a Region, is the Region where the Amazon SageMaker AI domain is located.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDomainSettingsForUpdate_UnifiedStudioSettings_DomainRegion
-UnifiedStudioSettings_EnvironmentId <String>
The ID of the environment that Amazon SageMaker Unified Studio associates with the domain.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDomainSettingsForUpdate_UnifiedStudioSettings_EnvironmentId
-UnifiedStudioSettings_ProjectId <String>
The ID of the Amazon SageMaker Unified Studio project that corresponds to the domain.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDomainSettingsForUpdate_UnifiedStudioSettings_ProjectId
-UnifiedStudioSettings_ProjectS3Path <String>
The location where Amazon S3 stores temporary execution data and other artifacts for the project that corresponds to the domain.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDomainSettingsForUpdate_UnifiedStudioSettings_ProjectS3Path
-UnifiedStudioSettings_SingleSignOnApplicationArn <String>
The ARN of the Amazon DataZone application managed by Amazon SageMaker Unified Studio in the Amazon Web Services IAM Identity Center.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDomainSettingsForUpdate_UnifiedStudioSettings_SingleSignOnApplicationArn
-UnifiedStudioSettings_StudioWebPortalAccess <FeatureStatus>
Sets whether you can access the domain in Amazon SageMaker Studio:
ENABLED
You can access the domain in Amazon SageMaker Studio. If you migrate the domain to Amazon SageMaker Unified Studio, you can access it in both studio interfaces.
DISABLED
You can't access the domain in Amazon SageMaker Studio. If you migrate the domain to Amazon SageMaker Unified Studio, you can access it only in that studio interface.
To migrate a domain to Amazon SageMaker Unified Studio, you specify the UnifiedStudioSettings data type when you use the UpdateDomain action.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDomainSettingsForUpdate_UnifiedStudioSettings_StudioWebPortalAccess

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

System.String or Amazon.SageMaker.Model.UpdateDomainResponse
This cmdlet returns a System.String object. The service call response (type Amazon.SageMaker.Model.UpdateDomainResponse) can be returned by specifying '-Select *'.
Developer Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z