Amazon SageMaker Service

2021/07/30 - Amazon SageMaker Service - 9 updated api methods

Changes  API changes with respect to Lambda steps in model building pipelines. Adds several waiters to async Sagemaker Image APIs. Add more instance types to AppInstanceType field

CreateApp (updated) Link ¶
Changes (request)
{'ResourceSpec': {'InstanceType': {'ml.m5d.12xlarge',
                                   'ml.m5d.16xlarge',
                                   'ml.m5d.24xlarge',
                                   'ml.m5d.2xlarge',
                                   'ml.m5d.4xlarge',
                                   'ml.m5d.8xlarge',
                                   'ml.m5d.large',
                                   'ml.m5d.xlarge',
                                   'ml.p3dn.24xlarge',
                                   'ml.r5.12xlarge',
                                   'ml.r5.16xlarge',
                                   'ml.r5.24xlarge',
                                   'ml.r5.2xlarge',
                                   'ml.r5.4xlarge',
                                   'ml.r5.8xlarge',
                                   'ml.r5.large',
                                   'ml.r5.xlarge'}}}

Creates a running app for the specified UserProfile. Supported apps are JupyterServer and KernelGateway . This operation is automatically invoked by Amazon SageMaker Studio upon access to the associated Domain, and when new kernel configurations are selected by the user. A user may have multiple Apps active simultaneously.

See also: AWS API Documentation

Request Syntax

client.create_app(
    DomainId='string',
    UserProfileName='string',
    AppType='JupyterServer'|'KernelGateway'|'TensorBoard',
    AppName='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    ResourceSpec={
        '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'
    }
)
type DomainId

string

param DomainId

[REQUIRED]

The domain ID.

type UserProfileName

string

param UserProfileName

[REQUIRED]

The user profile name.

type AppType

string

param AppType

[REQUIRED]

The type of app. Supported apps are JupyterServer and KernelGateway . TensorBoard is not supported.

type AppName

string

param AppName

[REQUIRED]

The name of the app.

type Tags

list

param Tags

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

  • (dict) --

    A tag object that consists of a key and an optional value, used to manage metadata for Amazon 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 Amazon 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.

type ResourceSpec

dict

param ResourceSpec

The 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.

rtype

dict

returns

Response Syntax

{
    'AppArn': 'string'
}

Response Structure

  • (dict) --

    • AppArn (string) --

      The Amazon Resource Name (ARN) of the app.

CreateDomain (updated) Link ¶
Changes (request)
{'DefaultUserSettings': {'JupyterServerAppSettings': {'DefaultResourceSpec': {'InstanceType': {'ml.m5d.12xlarge',
                                                                                               'ml.m5d.16xlarge',
                                                                                               'ml.m5d.24xlarge',
                                                                                               'ml.m5d.2xlarge',
                                                                                               'ml.m5d.4xlarge',
                                                                                               'ml.m5d.8xlarge',
                                                                                               'ml.m5d.large',
                                                                                               'ml.m5d.xlarge',
                                                                                               'ml.p3dn.24xlarge',
                                                                                               'ml.r5.12xlarge',
                                                                                               'ml.r5.16xlarge',
                                                                                               'ml.r5.24xlarge',
                                                                                               'ml.r5.2xlarge',
                                                                                               'ml.r5.4xlarge',
                                                                                               'ml.r5.8xlarge',
                                                                                               'ml.r5.large',
                                                                                               'ml.r5.xlarge'}}},
                         'KernelGatewayAppSettings': {'DefaultResourceSpec': {'InstanceType': {'ml.m5d.12xlarge',
                                                                                               'ml.m5d.16xlarge',
                                                                                               'ml.m5d.24xlarge',
                                                                                               'ml.m5d.2xlarge',
                                                                                               'ml.m5d.4xlarge',
                                                                                               'ml.m5d.8xlarge',
                                                                                               'ml.m5d.large',
                                                                                               'ml.m5d.xlarge',
                                                                                               'ml.p3dn.24xlarge',
                                                                                               'ml.r5.12xlarge',
                                                                                               'ml.r5.16xlarge',
                                                                                               'ml.r5.24xlarge',
                                                                                               'ml.r5.2xlarge',
                                                                                               'ml.r5.4xlarge',
                                                                                               'ml.r5.8xlarge',
                                                                                               'ml.r5.large',
                                                                                               'ml.r5.xlarge'}}},
                         'TensorBoardAppSettings': {'DefaultResourceSpec': {'InstanceType': {'ml.m5d.12xlarge',
                                                                                             'ml.m5d.16xlarge',
                                                                                             'ml.m5d.24xlarge',
                                                                                             'ml.m5d.2xlarge',
                                                                                             'ml.m5d.4xlarge',
                                                                                             'ml.m5d.8xlarge',
                                                                                             'ml.m5d.large',
                                                                                             'ml.m5d.xlarge',
                                                                                             'ml.p3dn.24xlarge',
                                                                                             'ml.r5.12xlarge',
                                                                                             'ml.r5.16xlarge',
                                                                                             'ml.r5.24xlarge',
                                                                                             'ml.r5.2xlarge',
                                                                                             'ml.r5.4xlarge',
                                                                                             'ml.r5.8xlarge',
                                                                                             'ml.r5.large',
                                                                                             'ml.r5.xlarge'}}}}}

Creates a Domain used by Amazon SageMaker Studio. A domain consists of an associated Amazon Elastic File System (EFS) volume, a list of authorized users, and a variety of security, application, policy, and Amazon Virtual Private Cloud (VPC) configurations. An Amazon Web Services account is limited to one domain per region. Users within a domain can share notebook files and other artifacts with each other.

EFS storage

When a domain is created, an EFS volume is created for use by all of the users within the domain. Each user receives a private home directory within the EFS volume for notebooks, Git repositories, and data files.

SageMaker uses the Amazon Web Services Key Management Service (Amazon Web Services KMS) to encrypt the EFS volume attached to the domain with an Amazon Web Services managed customer master key (CMK) by default. For more control, you can specify a customer managed CMK. For more information, see Protect Data at Rest Using Encryption.

VPC configuration

All SageMaker Studio traffic between the domain and the EFS volume is through the specified VPC and subnets. For other Studio traffic, you can specify the AppNetworkAccessType parameter. AppNetworkAccessType corresponds to the network access type that you choose when you onboard to Studio. The following options are available:

  • PublicInternetOnly - Non-EFS traffic goes through a VPC managed by Amazon SageMaker, which allows internet access. This is the default value.

  • VpcOnly - All Studio traffic is through the specified VPC and subnets. Internet access is disabled by default. To allow internet access, you must specify a NAT gateway. When internet access is disabled, you won't be able to run a Studio notebook or to train or host models unless your VPC has an interface endpoint to the SageMaker API and runtime or a NAT gateway and your security groups allow outbound connections.

Warning

NFS traffic over TCP on port 2049 needs to be allowed in both inbound and outbound rules in order to launch a SageMaker Studio app successfully.

For more information, see Connect SageMaker Studio Notebooks to Resources in a VPC.

See also: AWS API Documentation

Request Syntax

client.create_domain(
    DomainName='string',
    AuthMode='SSO'|'IAM',
    DefaultUserSettings={
        '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'
            }
        },
        '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'
            },
            'CustomImages': [
                {
                    'ImageName': 'string',
                    'ImageVersionNumber': 123,
                    'AppImageConfigName': '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'
            }
        }
    },
    SubnetIds=[
        'string',
    ],
    VpcId='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    AppNetworkAccessType='PublicInternetOnly'|'VpcOnly',
    HomeEfsFileSystemKmsKeyId='string',
    KmsKeyId='string'
)
type DomainName

string

param DomainName

[REQUIRED]

A name for the domain.

type AuthMode

string

param AuthMode

[REQUIRED]

The mode of authentication that members use to access the domain.

type DefaultUserSettings

dict

param DefaultUserSettings

[REQUIRED]

The default settings to use to create a user profile when UserSettings isn't specified in the call to the CreateUserProfile API.

SecurityGroups is aggregated when specified in both calls. For all other settings in UserSettings , the values specified in CreateUserProfile take precedence over those specified in CreateDomain .

  • 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 .

    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.

      • 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.

  • 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.

      • 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.

    • 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.

  • 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.

type SubnetIds

list

param SubnetIds

[REQUIRED]

The VPC subnets that Studio uses for communication.

  • (string) --

type VpcId

string

param VpcId

[REQUIRED]

The ID of the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.

type Tags

list

param Tags

Tags to associated with the Domain. Each tag consists of a key and an optional value. Tag keys must be unique per resource. Tags are searchable using the Search API.

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

  • (dict) --

    A tag object that consists of a key and an optional value, used to manage metadata for Amazon 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 Amazon 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.

type AppNetworkAccessType

string

param AppNetworkAccessType

Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly .

  • PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker, which allows direct internet access

  • VpcOnly - All Studio traffic is through the specified VPC and subnets

type HomeEfsFileSystemKmsKeyId

string

param HomeEfsFileSystemKmsKeyId

This member is deprecated and replaced with KmsKeyId .

type KmsKeyId

string

param KmsKeyId

SageMaker uses Amazon Web Services KMS to encrypt the EFS volume attached to the domain with an Amazon Web Services managed customer master key (CMK) by default. For more control, specify a customer managed CMK.

rtype

dict

returns

Response Syntax

{
    'DomainArn': 'string',
    'Url': 'string'
}

Response Structure

  • (dict) --

    • DomainArn (string) --

      The Amazon Resource Name (ARN) of the created domain.

    • Url (string) --

      The URL to the created domain.

CreateUserProfile (updated) Link ¶
Changes (request)
{'UserSettings': {'JupyterServerAppSettings': {'DefaultResourceSpec': {'InstanceType': {'ml.m5d.12xlarge',
                                                                                        'ml.m5d.16xlarge',
                                                                                        'ml.m5d.24xlarge',
                                                                                        'ml.m5d.2xlarge',
                                                                                        'ml.m5d.4xlarge',
                                                                                        'ml.m5d.8xlarge',
                                                                                        'ml.m5d.large',
                                                                                        'ml.m5d.xlarge',
                                                                                        'ml.p3dn.24xlarge',
                                                                                        'ml.r5.12xlarge',
                                                                                        'ml.r5.16xlarge',
                                                                                        'ml.r5.24xlarge',
                                                                                        'ml.r5.2xlarge',
                                                                                        'ml.r5.4xlarge',
                                                                                        'ml.r5.8xlarge',
                                                                                        'ml.r5.large',
                                                                                        'ml.r5.xlarge'}}},
                  'KernelGatewayAppSettings': {'DefaultResourceSpec': {'InstanceType': {'ml.m5d.12xlarge',
                                                                                        'ml.m5d.16xlarge',
                                                                                        'ml.m5d.24xlarge',
                                                                                        'ml.m5d.2xlarge',
                                                                                        'ml.m5d.4xlarge',
                                                                                        'ml.m5d.8xlarge',
                                                                                        'ml.m5d.large',
                                                                                        'ml.m5d.xlarge',
                                                                                        'ml.p3dn.24xlarge',
                                                                                        'ml.r5.12xlarge',
                                                                                        'ml.r5.16xlarge',
                                                                                        'ml.r5.24xlarge',
                                                                                        'ml.r5.2xlarge',
                                                                                        'ml.r5.4xlarge',
                                                                                        'ml.r5.8xlarge',
                                                                                        'ml.r5.large',
                                                                                        'ml.r5.xlarge'}}},
                  'TensorBoardAppSettings': {'DefaultResourceSpec': {'InstanceType': {'ml.m5d.12xlarge',
                                                                                      'ml.m5d.16xlarge',
                                                                                      'ml.m5d.24xlarge',
                                                                                      'ml.m5d.2xlarge',
                                                                                      'ml.m5d.4xlarge',
                                                                                      'ml.m5d.8xlarge',
                                                                                      'ml.m5d.large',
                                                                                      'ml.m5d.xlarge',
                                                                                      'ml.p3dn.24xlarge',
                                                                                      'ml.r5.12xlarge',
                                                                                      'ml.r5.16xlarge',
                                                                                      'ml.r5.24xlarge',
                                                                                      'ml.r5.2xlarge',
                                                                                      'ml.r5.4xlarge',
                                                                                      'ml.r5.8xlarge',
                                                                                      'ml.r5.large',
                                                                                      'ml.r5.xlarge'}}}}}

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 SSO, 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

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'
            }
        },
        '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'
            },
            'CustomImages': [
                {
                    'ImageName': 'string',
                    'ImageVersionNumber': 123,
                    'AppImageConfigName': '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'
            }
        }
    }
)
type DomainId

string

param DomainId

[REQUIRED]

The ID of the associated Domain.

type UserProfileName

string

param UserProfileName

[REQUIRED]

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

type SingleSignOnUserIdentifier

string

param SingleSignOnUserIdentifier

A specifier for the type of value specified in SingleSignOnUserValue. Currently, the only supported value is "UserName". If the Domain's AuthMode is SSO, this field is required. If the Domain's AuthMode is not SSO, this field cannot be specified.

type SingleSignOnUserValue

string

param SingleSignOnUserValue

The username of the associated Amazon Web Services Single Sign-On User for this UserProfile. If the Domain's AuthMode is SSO, this field is required, and must match a valid username of a user in your directory. If the Domain's AuthMode is not SSO, this field cannot be specified.

type Tags

list

param Tags

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 Amazon 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 Amazon 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.

type UserSettings

dict

param UserSettings

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 .

    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.

      • 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.

  • 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.

      • 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.

    • 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.

  • 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.

rtype

dict

returns

Response Syntax

{
    'UserProfileArn': 'string'
}

Response Structure

  • (dict) --

    • UserProfileArn (string) --

      The user profile Amazon Resource Name (ARN).

DescribeApp (updated) Link ¶
Changes (response)
{'ResourceSpec': {'InstanceType': {'ml.m5d.12xlarge',
                                   'ml.m5d.16xlarge',
                                   'ml.m5d.24xlarge',
                                   'ml.m5d.2xlarge',
                                   'ml.m5d.4xlarge',
                                   'ml.m5d.8xlarge',
                                   'ml.m5d.large',
                                   'ml.m5d.xlarge',
                                   'ml.p3dn.24xlarge',
                                   'ml.r5.12xlarge',
                                   'ml.r5.16xlarge',
                                   'ml.r5.24xlarge',
                                   'ml.r5.2xlarge',
                                   'ml.r5.4xlarge',
                                   'ml.r5.8xlarge',
                                   'ml.r5.large',
                                   'ml.r5.xlarge'}}}

Describes the app.

See also: AWS API Documentation

Request Syntax

client.describe_app(
    DomainId='string',
    UserProfileName='string',
    AppType='JupyterServer'|'KernelGateway'|'TensorBoard',
    AppName='string'
)
type DomainId

string

param DomainId

[REQUIRED]

The domain ID.

type UserProfileName

string

param UserProfileName

[REQUIRED]

The user profile name.

type AppType

string

param AppType

[REQUIRED]

The type of app.

type AppName

string

param AppName

[REQUIRED]

The name of the app.

rtype

dict

returns

Response Syntax

{
    'AppArn': 'string',
    'AppType': 'JupyterServer'|'KernelGateway'|'TensorBoard',
    'AppName': 'string',
    'DomainId': 'string',
    'UserProfileName': 'string',
    'Status': 'Deleted'|'Deleting'|'Failed'|'InService'|'Pending',
    'LastHealthCheckTimestamp': datetime(2015, 1, 1),
    'LastUserActivityTimestamp': datetime(2015, 1, 1),
    'CreationTime': datetime(2015, 1, 1),
    'FailureReason': 'string',
    'ResourceSpec': {
        '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'
    }
}

Response Structure

  • (dict) --

    • AppArn (string) --

      The Amazon Resource Name (ARN) of the app.

    • AppType (string) --

      The type of app.

    • AppName (string) --

      The name of the app.

    • DomainId (string) --

      The domain ID.

    • UserProfileName (string) --

      The user profile name.

    • Status (string) --

      The status.

    • LastHealthCheckTimestamp (datetime) --

      The timestamp of the last health check.

    • LastUserActivityTimestamp (datetime) --

      The timestamp of the last user's activity.

    • CreationTime (datetime) --

      The creation time.

    • FailureReason (string) --

      The failure reason.

    • ResourceSpec (dict) --

      The 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.

DescribeDomain (updated) Link ¶
Changes (response)
{'DefaultUserSettings': {'JupyterServerAppSettings': {'DefaultResourceSpec': {'InstanceType': {'ml.m5d.12xlarge',
                                                                                               'ml.m5d.16xlarge',
                                                                                               'ml.m5d.24xlarge',
                                                                                               'ml.m5d.2xlarge',
                                                                                               'ml.m5d.4xlarge',
                                                                                               'ml.m5d.8xlarge',
                                                                                               'ml.m5d.large',
                                                                                               'ml.m5d.xlarge',
                                                                                               'ml.p3dn.24xlarge',
                                                                                               'ml.r5.12xlarge',
                                                                                               'ml.r5.16xlarge',
                                                                                               'ml.r5.24xlarge',
                                                                                               'ml.r5.2xlarge',
                                                                                               'ml.r5.4xlarge',
                                                                                               'ml.r5.8xlarge',
                                                                                               'ml.r5.large',
                                                                                               'ml.r5.xlarge'}}},
                         'KernelGatewayAppSettings': {'DefaultResourceSpec': {'InstanceType': {'ml.m5d.12xlarge',
                                                                                               'ml.m5d.16xlarge',
                                                                                               'ml.m5d.24xlarge',
                                                                                               'ml.m5d.2xlarge',
                                                                                               'ml.m5d.4xlarge',
                                                                                               'ml.m5d.8xlarge',
                                                                                               'ml.m5d.large',
                                                                                               'ml.m5d.xlarge',
                                                                                               'ml.p3dn.24xlarge',
                                                                                               'ml.r5.12xlarge',
                                                                                               'ml.r5.16xlarge',
                                                                                               'ml.r5.24xlarge',
                                                                                               'ml.r5.2xlarge',
                                                                                               'ml.r5.4xlarge',
                                                                                               'ml.r5.8xlarge',
                                                                                               'ml.r5.large',
                                                                                               'ml.r5.xlarge'}}},
                         'TensorBoardAppSettings': {'DefaultResourceSpec': {'InstanceType': {'ml.m5d.12xlarge',
                                                                                             'ml.m5d.16xlarge',
                                                                                             'ml.m5d.24xlarge',
                                                                                             'ml.m5d.2xlarge',
                                                                                             'ml.m5d.4xlarge',
                                                                                             'ml.m5d.8xlarge',
                                                                                             'ml.m5d.large',
                                                                                             'ml.m5d.xlarge',
                                                                                             'ml.p3dn.24xlarge',
                                                                                             'ml.r5.12xlarge',
                                                                                             'ml.r5.16xlarge',
                                                                                             'ml.r5.24xlarge',
                                                                                             'ml.r5.2xlarge',
                                                                                             'ml.r5.4xlarge',
                                                                                             'ml.r5.8xlarge',
                                                                                             'ml.r5.large',
                                                                                             'ml.r5.xlarge'}}}}}

The description of the domain.

See also: AWS API Documentation

Request Syntax

client.describe_domain(
    DomainId='string'
)
type DomainId

string

param DomainId

[REQUIRED]

The domain ID.

rtype

dict

returns

Response Syntax

{
    'DomainArn': 'string',
    'DomainId': 'string',
    'DomainName': 'string',
    'HomeEfsFileSystemId': 'string',
    'SingleSignOnManagedApplicationInstanceId': 'string',
    'Status': 'Deleting'|'Failed'|'InService'|'Pending'|'Updating'|'Update_Failed'|'Delete_Failed',
    'CreationTime': datetime(2015, 1, 1),
    'LastModifiedTime': datetime(2015, 1, 1),
    'FailureReason': 'string',
    'AuthMode': 'SSO'|'IAM',
    'DefaultUserSettings': {
        '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'
            }
        },
        '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'
            },
            'CustomImages': [
                {
                    'ImageName': 'string',
                    'ImageVersionNumber': 123,
                    'AppImageConfigName': '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'
            }
        }
    },
    'AppNetworkAccessType': 'PublicInternetOnly'|'VpcOnly',
    'HomeEfsFileSystemKmsKeyId': 'string',
    'SubnetIds': [
        'string',
    ],
    'Url': 'string',
    'VpcId': 'string',
    'KmsKeyId': 'string'
}

Response Structure

  • (dict) --

    • DomainArn (string) --

      The domain's Amazon Resource Name (ARN).

    • DomainId (string) --

      The domain ID.

    • DomainName (string) --

      The domain name.

    • HomeEfsFileSystemId (string) --

      The ID of the Amazon Elastic File System (EFS) managed by this Domain.

    • SingleSignOnManagedApplicationInstanceId (string) --

      The SSO managed application instance ID.

    • Status (string) --

      The status.

    • CreationTime (datetime) --

      The creation time.

    • LastModifiedTime (datetime) --

      The last modified time.

    • FailureReason (string) --

      The failure reason.

    • AuthMode (string) --

      The domain's authentication mode.

    • DefaultUserSettings (dict) --

      Settings which are applied to UserProfiles in this domain if settings are not explicitly specified in a given UserProfile.

      • 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 .

        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.

          • 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.

      • 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.

          • 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.

        • 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) --

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

            • ImageVersionNumber (integer) --

              The version number of the CustomImage.

            • AppImageConfigName (string) --

              The name of the AppImageConfig.

      • 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.

    • AppNetworkAccessType (string) --

      Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly .

      • PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker, which allows direct internet access

      • VpcOnly - All Studio traffic is through the specified VPC and subnets

    • HomeEfsFileSystemKmsKeyId (string) --

      This member is deprecated and replaced with KmsKeyId .

    • SubnetIds (list) --

      The VPC subnets that Studio uses for communication.

      • (string) --

    • Url (string) --

      The domain's URL.

    • VpcId (string) --

      The ID of the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.

    • KmsKeyId (string) --

      The Amazon Web Services KMS customer managed CMK used to encrypt the EFS volume attached to the domain.

DescribeUserProfile (updated) Link ¶
Changes (response)
{'UserSettings': {'JupyterServerAppSettings': {'DefaultResourceSpec': {'InstanceType': {'ml.m5d.12xlarge',
                                                                                        'ml.m5d.16xlarge',
                                                                                        'ml.m5d.24xlarge',
                                                                                        'ml.m5d.2xlarge',
                                                                                        'ml.m5d.4xlarge',
                                                                                        'ml.m5d.8xlarge',
                                                                                        'ml.m5d.large',
                                                                                        'ml.m5d.xlarge',
                                                                                        'ml.p3dn.24xlarge',
                                                                                        'ml.r5.12xlarge',
                                                                                        'ml.r5.16xlarge',
                                                                                        'ml.r5.24xlarge',
                                                                                        'ml.r5.2xlarge',
                                                                                        'ml.r5.4xlarge',
                                                                                        'ml.r5.8xlarge',
                                                                                        'ml.r5.large',
                                                                                        'ml.r5.xlarge'}}},
                  'KernelGatewayAppSettings': {'DefaultResourceSpec': {'InstanceType': {'ml.m5d.12xlarge',
                                                                                        'ml.m5d.16xlarge',
                                                                                        'ml.m5d.24xlarge',
                                                                                        'ml.m5d.2xlarge',
                                                                                        'ml.m5d.4xlarge',
                                                                                        'ml.m5d.8xlarge',
                                                                                        'ml.m5d.large',
                                                                                        'ml.m5d.xlarge',
                                                                                        'ml.p3dn.24xlarge',
                                                                                        'ml.r5.12xlarge',
                                                                                        'ml.r5.16xlarge',
                                                                                        'ml.r5.24xlarge',
                                                                                        'ml.r5.2xlarge',
                                                                                        'ml.r5.4xlarge',
                                                                                        'ml.r5.8xlarge',
                                                                                        'ml.r5.large',
                                                                                        'ml.r5.xlarge'}}},
                  'TensorBoardAppSettings': {'DefaultResourceSpec': {'InstanceType': {'ml.m5d.12xlarge',
                                                                                      'ml.m5d.16xlarge',
                                                                                      'ml.m5d.24xlarge',
                                                                                      'ml.m5d.2xlarge',
                                                                                      'ml.m5d.4xlarge',
                                                                                      'ml.m5d.8xlarge',
                                                                                      'ml.m5d.large',
                                                                                      'ml.m5d.xlarge',
                                                                                      'ml.p3dn.24xlarge',
                                                                                      'ml.r5.12xlarge',
                                                                                      'ml.r5.16xlarge',
                                                                                      'ml.r5.24xlarge',
                                                                                      'ml.r5.2xlarge',
                                                                                      'ml.r5.4xlarge',
                                                                                      'ml.r5.8xlarge',
                                                                                      'ml.r5.large',
                                                                                      'ml.r5.xlarge'}}}}}

Describes a user profile. For more information, see CreateUserProfile .

See also: AWS API Documentation

Request Syntax

client.describe_user_profile(
    DomainId='string',
    UserProfileName='string'
)
type DomainId

string

param DomainId

[REQUIRED]

The domain ID.

type UserProfileName

string

param UserProfileName

[REQUIRED]

The user profile name. This value is not case sensitive.

rtype

dict

returns

Response Syntax

{
    'DomainId': 'string',
    'UserProfileArn': 'string',
    'UserProfileName': 'string',
    'HomeEfsFileSystemUid': 'string',
    'Status': 'Deleting'|'Failed'|'InService'|'Pending'|'Updating'|'Update_Failed'|'Delete_Failed',
    'LastModifiedTime': datetime(2015, 1, 1),
    'CreationTime': datetime(2015, 1, 1),
    'FailureReason': 'string',
    'SingleSignOnUserIdentifier': 'string',
    'SingleSignOnUserValue': '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'
            }
        },
        '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'
            },
            'CustomImages': [
                {
                    'ImageName': 'string',
                    'ImageVersionNumber': 123,
                    'AppImageConfigName': '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'
            }
        }
    }
}

Response Structure

  • (dict) --

    • DomainId (string) --

      The ID of the domain that contains the profile.

    • UserProfileArn (string) --

      The user profile Amazon Resource Name (ARN).

    • UserProfileName (string) --

      The user profile name.

    • HomeEfsFileSystemUid (string) --

      The ID of the user's profile in the Amazon Elastic File System (EFS) volume.

    • Status (string) --

      The status.

    • LastModifiedTime (datetime) --

      The last modified time.

    • CreationTime (datetime) --

      The creation time.

    • FailureReason (string) --

      The failure reason.

    • SingleSignOnUserIdentifier (string) --

      The SSO user identifier.

    • SingleSignOnUserValue (string) --

      The SSO user 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 .

        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.

          • 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.

      • 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.

          • 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.

        • 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) --

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

            • ImageVersionNumber (integer) --

              The version number of the CustomImage.

            • AppImageConfigName (string) --

              The name of the AppImageConfig.

      • 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.

ListPipelineExecutionSteps (updated) Link ¶
Changes (response)
{'PipelineExecutionSteps': {'Metadata': {'Lambda': {'Arn': 'string',
                                                    'OutputParameters': [{'Name': 'string',
                                                                          'Value': 'string'}]}}}}

Gets a list of PipeLineExecutionStep objects.

See also: AWS API Documentation

Request Syntax

client.list_pipeline_execution_steps(
    PipelineExecutionArn='string',
    NextToken='string',
    MaxResults=123,
    SortOrder='Ascending'|'Descending'
)
type PipelineExecutionArn

string

param PipelineExecutionArn

The Amazon Resource Name (ARN) of the pipeline execution.

type NextToken

string

param NextToken

If the result of the previous ListPipelineExecutionSteps request was truncated, the response includes a NextToken . To retrieve the next set of pipeline execution steps, use the token in the next request.

type MaxResults

integer

param MaxResults

The maximum number of pipeline execution steps to return in the response.

type SortOrder

string

param SortOrder

The field by which to sort results. The default is CreatedTime .

rtype

dict

returns

Response Syntax

{
    'PipelineExecutionSteps': [
        {
            'StepName': 'string',
            'StartTime': datetime(2015, 1, 1),
            'EndTime': datetime(2015, 1, 1),
            'StepStatus': 'Starting'|'Executing'|'Stopping'|'Stopped'|'Failed'|'Succeeded',
            'CacheHitResult': {
                'SourcePipelineExecutionArn': 'string'
            },
            'FailureReason': 'string',
            'Metadata': {
                'TrainingJob': {
                    'Arn': 'string'
                },
                'ProcessingJob': {
                    'Arn': 'string'
                },
                'TransformJob': {
                    'Arn': 'string'
                },
                'TuningJob': {
                    'Arn': 'string'
                },
                'Model': {
                    'Arn': 'string'
                },
                'RegisterModel': {
                    'Arn': 'string'
                },
                'Condition': {
                    'Outcome': 'True'|'False'
                },
                'Callback': {
                    'CallbackToken': 'string',
                    'SqsQueueUrl': 'string',
                    'OutputParameters': [
                        {
                            'Name': 'string',
                            'Value': 'string'
                        },
                    ]
                },
                'Lambda': {
                    'Arn': 'string',
                    'OutputParameters': [
                        {
                            'Name': 'string',
                            'Value': 'string'
                        },
                    ]
                }
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • PipelineExecutionSteps (list) --

      A list of PipeLineExecutionStep objects. Each PipeLineExecutionStep consists of StepName, StartTime, EndTime, StepStatus, and Metadata. Metadata is an object with properties for each job that contains relevant information about the job created by the step.

      • (dict) --

        An execution of a step in a pipeline.

        • StepName (string) --

          The name of the step that is executed.

        • StartTime (datetime) --

          The time that the step started executing.

        • EndTime (datetime) --

          The time that the step stopped executing.

        • StepStatus (string) --

          The status of the step execution.

        • CacheHitResult (dict) --

          If this pipeline execution step was cached, details on the cache hit.

          • SourcePipelineExecutionArn (string) --

            The Amazon Resource Name (ARN) of the pipeline execution.

        • FailureReason (string) --

          The reason why the step failed execution. This is only returned if the step failed its execution.

        • Metadata (dict) --

          Metadata for the step execution.

          • TrainingJob (dict) --

            The Amazon Resource Name (ARN) of the training job that was run by this step execution.

            • Arn (string) --

              The Amazon Resource Name (ARN) of the training job that was run by this step execution.

          • ProcessingJob (dict) --

            The Amazon Resource Name (ARN) of the processing job that was run by this step execution.

            • Arn (string) --

              The Amazon Resource Name (ARN) of the processing job.

          • TransformJob (dict) --

            The Amazon Resource Name (ARN) of the transform job that was run by this step execution.

            • Arn (string) --

              The Amazon Resource Name (ARN) of the transform job that was run by this step execution.

          • TuningJob (dict) --

            The Amazon Resource Name (ARN) of the tuning job that was run by this step execution.

            • Arn (string) --

              The Amazon Resource Name (ARN) of the tuning job that was run by this step execution.

          • Model (dict) --

            The Amazon Resource Name (ARN) of the model that was created by this step execution.

            • Arn (string) --

              The Amazon Resource Name (ARN) of the created model.

          • RegisterModel (dict) --

            The Amazon Resource Name (ARN) of the model package the model was registered to by this step execution.

            • Arn (string) --

              The Amazon Resource Name (ARN) of the model package.

          • Condition (dict) --

            The outcome of the condition evaluation that was run by this step execution.

            • Outcome (string) --

              The outcome of the Condition step evaluation.

          • Callback (dict) --

            The URL of the Amazon SQS queue used by this step execution, the pipeline generated token, and a list of output parameters.

            • CallbackToken (string) --

              The pipeline generated token from the Amazon SQS queue.

            • SqsQueueUrl (string) --

              The URL of the Amazon Simple Queue Service (Amazon SQS) queue used by the callback step.

            • OutputParameters (list) --

              A list of the output parameters of the callback step.

              • (dict) --

                An output parameter of a pipeline step.

                • Name (string) --

                  The name of the output parameter.

                • Value (string) --

                  The value of the output parameter.

          • Lambda (dict) --

            The Amazon Resource Name (ARN) of the Lambda function that was run by this step execution and a list of output parameters.

            • Arn (string) --

              The Amazon Resource Name (ARN) of the Lambda function that was run by this step execution.

            • OutputParameters (list) --

              A list of the output parameters of the Lambda step.

              • (dict) --

                An output parameter of a pipeline step.

                • Name (string) --

                  The name of the output parameter.

                • Value (string) --

                  The value of the output parameter.

    • NextToken (string) --

      If the result of the previous ListPipelineExecutionSteps request was truncated, the response includes a NextToken . To retrieve the next set of pipeline execution steps, use the token in the next request.

UpdateDomain (updated) Link ¶
Changes (request)
{'DefaultUserSettings': {'JupyterServerAppSettings': {'DefaultResourceSpec': {'InstanceType': {'ml.m5d.12xlarge',
                                                                                               'ml.m5d.16xlarge',
                                                                                               'ml.m5d.24xlarge',
                                                                                               'ml.m5d.2xlarge',
                                                                                               'ml.m5d.4xlarge',
                                                                                               'ml.m5d.8xlarge',
                                                                                               'ml.m5d.large',
                                                                                               'ml.m5d.xlarge',
                                                                                               'ml.p3dn.24xlarge',
                                                                                               'ml.r5.12xlarge',
                                                                                               'ml.r5.16xlarge',
                                                                                               'ml.r5.24xlarge',
                                                                                               'ml.r5.2xlarge',
                                                                                               'ml.r5.4xlarge',
                                                                                               'ml.r5.8xlarge',
                                                                                               'ml.r5.large',
                                                                                               'ml.r5.xlarge'}}},
                         'KernelGatewayAppSettings': {'DefaultResourceSpec': {'InstanceType': {'ml.m5d.12xlarge',
                                                                                               'ml.m5d.16xlarge',
                                                                                               'ml.m5d.24xlarge',
                                                                                               'ml.m5d.2xlarge',
                                                                                               'ml.m5d.4xlarge',
                                                                                               'ml.m5d.8xlarge',
                                                                                               'ml.m5d.large',
                                                                                               'ml.m5d.xlarge',
                                                                                               'ml.p3dn.24xlarge',
                                                                                               'ml.r5.12xlarge',
                                                                                               'ml.r5.16xlarge',
                                                                                               'ml.r5.24xlarge',
                                                                                               'ml.r5.2xlarge',
                                                                                               'ml.r5.4xlarge',
                                                                                               'ml.r5.8xlarge',
                                                                                               'ml.r5.large',
                                                                                               'ml.r5.xlarge'}}},
                         'TensorBoardAppSettings': {'DefaultResourceSpec': {'InstanceType': {'ml.m5d.12xlarge',
                                                                                             'ml.m5d.16xlarge',
                                                                                             'ml.m5d.24xlarge',
                                                                                             'ml.m5d.2xlarge',
                                                                                             'ml.m5d.4xlarge',
                                                                                             'ml.m5d.8xlarge',
                                                                                             'ml.m5d.large',
                                                                                             'ml.m5d.xlarge',
                                                                                             'ml.p3dn.24xlarge',
                                                                                             'ml.r5.12xlarge',
                                                                                             'ml.r5.16xlarge',
                                                                                             'ml.r5.24xlarge',
                                                                                             'ml.r5.2xlarge',
                                                                                             'ml.r5.4xlarge',
                                                                                             'ml.r5.8xlarge',
                                                                                             'ml.r5.large',
                                                                                             'ml.r5.xlarge'}}}}}

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

See also: AWS API Documentation

Request Syntax

client.update_domain(
    DomainId='string',
    DefaultUserSettings={
        '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'
            }
        },
        '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'
            },
            'CustomImages': [
                {
                    'ImageName': 'string',
                    'ImageVersionNumber': 123,
                    'AppImageConfigName': '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'
            }
        }
    }
)
type DomainId

string

param DomainId

[REQUIRED]

The ID of the domain to be updated.

type DefaultUserSettings

dict

param DefaultUserSettings

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 .

    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.

      • 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.

  • 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.

      • 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.

    • 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.

  • 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.

rtype

dict

returns

Response Syntax

{
    'DomainArn': 'string'
}

Response Structure

  • (dict) --

    • DomainArn (string) --

      The Amazon Resource Name (ARN) of the domain.

UpdateUserProfile (updated) Link ¶
Changes (request)
{'UserSettings': {'JupyterServerAppSettings': {'DefaultResourceSpec': {'InstanceType': {'ml.m5d.12xlarge',
                                                                                        'ml.m5d.16xlarge',
                                                                                        'ml.m5d.24xlarge',
                                                                                        'ml.m5d.2xlarge',
                                                                                        'ml.m5d.4xlarge',
                                                                                        'ml.m5d.8xlarge',
                                                                                        'ml.m5d.large',
                                                                                        'ml.m5d.xlarge',
                                                                                        'ml.p3dn.24xlarge',
                                                                                        'ml.r5.12xlarge',
                                                                                        'ml.r5.16xlarge',
                                                                                        'ml.r5.24xlarge',
                                                                                        'ml.r5.2xlarge',
                                                                                        'ml.r5.4xlarge',
                                                                                        'ml.r5.8xlarge',
                                                                                        'ml.r5.large',
                                                                                        'ml.r5.xlarge'}}},
                  'KernelGatewayAppSettings': {'DefaultResourceSpec': {'InstanceType': {'ml.m5d.12xlarge',
                                                                                        'ml.m5d.16xlarge',
                                                                                        'ml.m5d.24xlarge',
                                                                                        'ml.m5d.2xlarge',
                                                                                        'ml.m5d.4xlarge',
                                                                                        'ml.m5d.8xlarge',
                                                                                        'ml.m5d.large',
                                                                                        'ml.m5d.xlarge',
                                                                                        'ml.p3dn.24xlarge',
                                                                                        'ml.r5.12xlarge',
                                                                                        'ml.r5.16xlarge',
                                                                                        'ml.r5.24xlarge',
                                                                                        'ml.r5.2xlarge',
                                                                                        'ml.r5.4xlarge',
                                                                                        'ml.r5.8xlarge',
                                                                                        'ml.r5.large',
                                                                                        'ml.r5.xlarge'}}},
                  'TensorBoardAppSettings': {'DefaultResourceSpec': {'InstanceType': {'ml.m5d.12xlarge',
                                                                                      'ml.m5d.16xlarge',
                                                                                      'ml.m5d.24xlarge',
                                                                                      'ml.m5d.2xlarge',
                                                                                      'ml.m5d.4xlarge',
                                                                                      'ml.m5d.8xlarge',
                                                                                      'ml.m5d.large',
                                                                                      'ml.m5d.xlarge',
                                                                                      'ml.p3dn.24xlarge',
                                                                                      'ml.r5.12xlarge',
                                                                                      'ml.r5.16xlarge',
                                                                                      'ml.r5.24xlarge',
                                                                                      'ml.r5.2xlarge',
                                                                                      'ml.r5.4xlarge',
                                                                                      'ml.r5.8xlarge',
                                                                                      'ml.r5.large',
                                                                                      'ml.r5.xlarge'}}}}}

Updates a user profile.

See also: AWS API Documentation

Request Syntax

client.update_user_profile(
    DomainId='string',
    UserProfileName='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'
            }
        },
        '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'
            },
            'CustomImages': [
                {
                    'ImageName': 'string',
                    'ImageVersionNumber': 123,
                    'AppImageConfigName': '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'
            }
        }
    }
)
type DomainId

string

param DomainId

[REQUIRED]

The domain ID.

type UserProfileName

string

param UserProfileName

[REQUIRED]

The user profile name.

type UserSettings

dict

param UserSettings

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 .

    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.

      • 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.

  • 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.

      • 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.

    • 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.

  • 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.

rtype

dict

returns

Response Syntax

{
    'UserProfileArn': 'string'
}

Response Structure

  • (dict) --

    • UserProfileArn (string) --

      The user profile Amazon Resource Name (ARN).