SageMaker / Client / create_user_profile

create_user_profile#

SageMaker.Client.create_user_profile(**kwargs)#

Creates a user profile. A user profile represents a single user within a domain, and is the main way to reference a “person” for the purposes of sharing, reporting, and other user-oriented features. This entity is created when a user onboards to Amazon SageMaker Studio. If an administrator invites a person by email or imports them from IAM Identity Center, a user profile is automatically created. A user profile is the primary holder of settings for an individual user and has a reference to the user’s private Amazon Elastic File System (EFS) home directory.

See also: AWS API Documentation

Request Syntax

response = client.create_user_profile(
    DomainId='string',
    UserProfileName='string',
    SingleSignOnUserIdentifier='string',
    SingleSignOnUserValue='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    UserSettings={
        'ExecutionRole': 'string',
        'SecurityGroups': [
            'string',
        ],
        'SharingSettings': {
            'NotebookOutputOption': 'Allowed'|'Disabled',
            'S3OutputPath': 'string',
            'S3KmsKeyId': 'string'
        },
        'JupyterServerAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': 'string',
                'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge',
                'LifecycleConfigArn': 'string'
            },
            'LifecycleConfigArns': [
                'string',
            ],
            'CodeRepositories': [
                {
                    'RepositoryUrl': 'string'
                },
            ]
        },
        'KernelGatewayAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': 'string',
                'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge',
                'LifecycleConfigArn': 'string'
            },
            'CustomImages': [
                {
                    'ImageName': 'string',
                    'ImageVersionNumber': 123,
                    'AppImageConfigName': 'string'
                },
            ],
            'LifecycleConfigArns': [
                'string',
            ]
        },
        'TensorBoardAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': 'string',
                'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge',
                'LifecycleConfigArn': 'string'
            }
        },
        'RStudioServerProAppSettings': {
            'AccessStatus': 'ENABLED'|'DISABLED',
            'UserGroup': 'R_STUDIO_ADMIN'|'R_STUDIO_USER'
        },
        'RSessionAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': 'string',
                'SageMakerImageVersionArn': 'string',
                'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge',
                'LifecycleConfigArn': 'string'
            },
            'CustomImages': [
                {
                    'ImageName': 'string',
                    'ImageVersionNumber': 123,
                    'AppImageConfigName': 'string'
                },
            ]
        },
        'CanvasAppSettings': {
            'TimeSeriesForecastingSettings': {
                'Status': 'ENABLED'|'DISABLED',
                'AmazonForecastRoleArn': 'string'
            },
            'ModelRegisterSettings': {
                'Status': 'ENABLED'|'DISABLED',
                'CrossAccountModelRegisterRoleArn': 'string'
            }
        }
    }
)
Parameters:

  • DomainId (string) –

    [REQUIRED]

    The ID of the associated Domain.

  • UserProfileName (string) –

    [REQUIRED]

    A name for the UserProfile. This value is not case sensitive.

  • SingleSignOnUserIdentifier (string) – A specifier for the type of value specified in SingleSignOnUserValue. Currently, the only supported value is “UserName”. If the Domain’s AuthMode is IAM Identity Center, this field is required. If the Domain’s AuthMode is not IAM Identity Center, this field cannot be specified.

  • SingleSignOnUserValue (string) – The username of the associated Amazon Web Services Single Sign-On User for this UserProfile. If the Domain’s AuthMode is IAM Identity Center, this field is required, and must match a valid username of a user in your directory. If the Domain’s AuthMode is not IAM Identity Center, this field cannot be specified.

  • Tags (list) –

    Each tag consists of a key and an optional value. Tag keys must be unique per resource.

    Tags that you specify for the User Profile are also added to all Apps that the User Profile launches.

    • (dict) –

      A tag object that consists of a key and an optional value, used to manage metadata for SageMaker Amazon Web Services resources.

      You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. For more information on adding tags to SageMaker resources, see AddTags.

      For more information on adding metadata to your Amazon Web Services resources with tagging, see Tagging Amazon Web Services resources. For advice on best practices for managing Amazon Web Services resources with tagging, see Tagging Best Practices: Implement an Effective Amazon Web Services Resource Tagging Strategy.

      • Key (string) – [REQUIRED]

        The tag key. Tag keys must be unique per resource.

      • Value (string) – [REQUIRED]

        The tag value.

  • UserSettings (dict) –

    A collection of settings.

    • ExecutionRole (string) –

      The execution role for the user.

    • SecurityGroups (list) –

      The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.

      Optional when the CreateDomain.AppNetworkAccessType parameter is set to PublicInternetOnly.

      Required when the CreateDomain.AppNetworkAccessType parameter is set to VpcOnly, unless specified as part of the DefaultUserSettings for the domain.

      Amazon SageMaker adds a security group to allow NFS traffic from SageMaker Studio. Therefore, the number of security groups that you can specify is one less than the maximum number shown.

      • (string) –

    • SharingSettings (dict) –

      Specifies options for sharing SageMaker Studio notebooks.

      • NotebookOutputOption (string) –

        Whether to include the notebook cell output when sharing the notebook. The default is Disabled.

      • S3OutputPath (string) –

        When NotebookOutputOption is Allowed, the Amazon S3 bucket used to store the shared notebook snapshots.

      • S3KmsKeyId (string) –

        When NotebookOutputOption is Allowed, the Amazon Web Services Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.

    • JupyterServerAppSettings (dict) –

      The Jupyter server’s app settings.

      • DefaultResourceSpec (dict) –

        The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the JupyterServer app. If you use the LifecycleConfigArns parameter, then this parameter is also required.

        • SageMakerImageArn (string) –

          The ARN of the SageMaker image that the image version belongs to.

        • SageMakerImageVersionArn (string) –

          The ARN of the image version created on the instance.

        • InstanceType (string) –

          The instance type that the image version runs on.

          Note

          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.

        • LifecycleConfigArn (string) –

          The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.

      • LifecycleConfigArns (list) –

        The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the JupyterServerApp. If you use this parameter, the DefaultResourceSpec parameter is also required.

        Note

        To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty list.

        • (string) –

      • CodeRepositories (list) –

        A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterServer application.

        • (dict) –

          A Git repository that SageMaker automatically displays to users for cloning in the JupyterServer application.

          • RepositoryUrl (string) – [REQUIRED]

            The URL of the Git repository.

    • KernelGatewayAppSettings (dict) –

      The kernel gateway app settings.

      • DefaultResourceSpec (dict) –

        The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the KernelGateway app.

        Note

        The Amazon SageMaker Studio UI does not use the default instance type value set here. The default instance type set here is used when Apps are created using the Amazon Web Services Command Line Interface or Amazon Web Services CloudFormation and the instance type parameter value is not passed.

        • SageMakerImageArn (string) –

          The ARN of the SageMaker image that the image version belongs to.

        • SageMakerImageVersionArn (string) –

          The ARN of the image version created on the instance.

        • InstanceType (string) –

          The instance type that the image version runs on.

          Note

          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.

        • LifecycleConfigArn (string) –

          The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.

      • CustomImages (list) –

        A list of custom SageMaker images that are configured to run as a KernelGateway app.

        • (dict) –

          A custom SageMaker image. For more information, see Bring your own SageMaker image.

          • ImageName (string) – [REQUIRED]

            The name of the CustomImage. Must be unique to your account.

          • ImageVersionNumber (integer) –

            The version number of the CustomImage.

          • AppImageConfigName (string) – [REQUIRED]

            The name of the AppImageConfig.

      • LifecycleConfigArns (list) –

        The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the the user profile or domain.

        Note

        To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty list.

        • (string) –

    • TensorBoardAppSettings (dict) –

      The TensorBoard app settings.

      • DefaultResourceSpec (dict) –

        The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.

        • SageMakerImageArn (string) –

          The ARN of the SageMaker image that the image version belongs to.

        • SageMakerImageVersionArn (string) –

          The ARN of the image version created on the instance.

        • InstanceType (string) –

          The instance type that the image version runs on.

          Note

          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.

        • LifecycleConfigArn (string) –

          The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.

    • RStudioServerProAppSettings (dict) –

      A collection of settings that configure user interaction with the RStudioServerPro app.

      • AccessStatus (string) –

        Indicates whether the current user has access to the RStudioServerPro app.

      • UserGroup (string) –

        The level of permissions that the user has within the RStudioServerPro app. This value defaults to User. The Admin value allows the user access to the RStudio Administrative Dashboard.

    • RSessionAppSettings (dict) –

      A collection of settings that configure the RSessionGateway app.

      • DefaultResourceSpec (dict) –

        Specifies the ARN’s of a SageMaker image and SageMaker image version, and the instance type that the version runs on.

        • SageMakerImageArn (string) –

          The ARN of the SageMaker image that the image version belongs to.

        • SageMakerImageVersionArn (string) –

          The ARN of the image version created on the instance.

        • InstanceType (string) –

          The instance type that the image version runs on.

          Note

          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.

        • LifecycleConfigArn (string) –

          The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.

      • CustomImages (list) –

        A list of custom SageMaker images that are configured to run as a RSession app.

        • (dict) –

          A custom SageMaker image. For more information, see Bring your own SageMaker image.

          • ImageName (string) – [REQUIRED]

            The name of the CustomImage. Must be unique to your account.

          • ImageVersionNumber (integer) –

            The version number of the CustomImage.

          • AppImageConfigName (string) – [REQUIRED]

            The name of the AppImageConfig.

    • CanvasAppSettings (dict) –

      The Canvas app settings.

      • TimeSeriesForecastingSettings (dict) –

        Time series forecast settings for the Canvas application.

        • Status (string) –

          Describes whether time series forecasting is enabled or disabled in the Canvas application.

        • AmazonForecastRoleArn (string) –

          The IAM role that Canvas passes to Amazon Forecast for time series forecasting. By default, Canvas uses the execution role specified in the UserProfile that launches the Canvas application. If an execution role is not specified in the UserProfile, Canvas uses the execution role specified in the Domain that owns the UserProfile. To allow time series forecasting, this IAM role should have the AmazonSageMakerCanvasForecastAccess policy attached and forecast.amazonaws.com added in the trust relationship as a service principal.

      • ModelRegisterSettings (dict) –

        The model registry settings for the SageMaker Canvas application.

        • Status (string) –

          Describes whether the integration to the model registry is enabled or disabled in the Canvas application.

        • CrossAccountModelRegisterRoleArn (string) –

          The Amazon Resource Name (ARN) of the SageMaker model registry account. Required only to register model versions created by a different SageMaker Canvas Amazon Web Services account than the Amazon Web Services account in which SageMaker model registry is set up.

Return type:

dict

Returns:

Response Syntax

{
    'UserProfileArn': 'string'
}

Response Structure

  • (dict) –

    • UserProfileArn (string) –

      The user profile Amazon Resource Name (ARN).

Exceptions

  • SageMaker.Client.exceptions.ResourceLimitExceeded

  • SageMaker.Client.exceptions.ResourceInUse