Amazon SageMaker Service

{'ResourceSpec': {'SageMakerImageArn': 'string'}}

Creates a running App for the specified UserProfile. Supported Apps are JupyterServer and KernelGateway. This operation is automatically invoked by Amazon SageMaker Amazon SageMaker Studio (Studio) upon access to the associated Studio Domain, and when new kernel configurations are selected by the user. A user may have multiple Apps active simultaneously. Apps will automatically terminate and be deleted when stopped from within Studio, or when the DeleteApp API is manually called. UserProfiles are limited to 5 concurrently running Apps at a time.

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',
        '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.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.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'
    }
)

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.

type Tags

list

param Tags

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

• (dict) --

  Describes a tag.

  • Key (string) -- [REQUIRED]

    The tag key.

  • Value (string) -- [REQUIRED]

    The tag value.

type ResourceSpec

dict

param ResourceSpec

The instance type and quantity.

• SageMakerImageArn (string) --

  The Amazon Resource Name (ARN) of the image created on the instance.

• InstanceType (string) --

  The instance type.

rtype

dict

returns

Response Syntax

{
    'AppArn': 'string'
}

Response Structure

• (dict) --

  • AppArn (string) --

    The app's Amazon Resource Name (ARN).

{'DefaultUserSettings': {'JupyterServerAppSettings': {'DefaultResourceSpec': {'SageMakerImageArn': 'string'}},
                         'KernelGatewayAppSettings': {'DefaultResourceSpec': {'SageMakerImageArn': 'string'}},
                         'TensorBoardAppSettings': {'DefaultResourceSpec': {'SageMakerImageArn': 'string'}}}}

Creates a Domain for Amazon SageMaker Amazon SageMaker Studio (Studio), which can be accessed by end-users in a web browser. A Domain has an associated directory, list of authorized users, and a variety of security, application, policies, and Amazon Virtual Private Cloud configurations. An AWS account is limited to one Domain, per region. Users within a domain can share notebook files and other artifacts with each other. When a Domain is created, an Amazon Elastic File System (EFS) is also created for use by all of the users within the Domain. Each user receives a private home directory within the EFS for notebooks, Git repositories, and data files.

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',
                '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.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.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'
            }
        },
        'KernelGatewayAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': '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.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.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'
            }
        },
        'TensorBoardAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': '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.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.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'
            }
        }
    },
    SubnetIds=[
        'string',
    ],
    VpcId='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    HomeEfsFileSystemKmsKeyId='string'
)

type DomainName

string

param DomainName

[REQUIRED]

A name for the domain.

type AuthMode

string

param AuthMode

[REQUIRED]

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

type DefaultUserSettings

dict

param DefaultUserSettings

[REQUIRED]

The default user settings.

• ExecutionRole (string) --

  The execution role for the user.

• SecurityGroups (list) --

  The security groups.

  • (string) --

• SharingSettings (dict) --

  The sharing settings.

  • NotebookOutputOption (string) --

    The notebook output option.

  • S3OutputPath (string) --

    The Amazon S3 output path.

  • S3KmsKeyId (string) --

    The AWS Key Management Service encryption key ID.

• JupyterServerAppSettings (dict) --

  The Jupyter server's app settings.

  • DefaultResourceSpec (dict) --

    The instance type and quantity.

    • SageMakerImageArn (string) --

      The Amazon Resource Name (ARN) of the image created on the instance.

    • InstanceType (string) --

      The instance type.

• KernelGatewayAppSettings (dict) --

  The kernel gateway app settings.

  • DefaultResourceSpec (dict) --

    The instance type and quantity.

    • SageMakerImageArn (string) --

      The Amazon Resource Name (ARN) of the image created on the instance.

    • InstanceType (string) --

      The instance type.

• TensorBoardAppSettings (dict) --

  The TensorBoard app settings.

  • DefaultResourceSpec (dict) --

    The instance type and quantity.

    • SageMakerImageArn (string) --

      The Amazon Resource Name (ARN) of the image created on the instance.

    • InstanceType (string) --

      The instance type.

type SubnetIds

list

param SubnetIds

[REQUIRED]

Security setting to limit to a set of subnets.

• (string) --

type VpcId

string

param VpcId

[REQUIRED]

Security setting to limit the domain's communication to a Amazon Virtual Private Cloud.

type Tags

list

param Tags

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

• (dict) --

  Describes a tag.

  • Key (string) -- [REQUIRED]

    The tag key.

  • Value (string) -- [REQUIRED]

    The tag value.

type HomeEfsFileSystemKmsKeyId

string

param HomeEfsFileSystemKmsKeyId

The AWS Key Management Service encryption key ID.

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.

{'UserSettings': {'JupyterServerAppSettings': {'DefaultResourceSpec': {'SageMakerImageArn': 'string'}},
                  'KernelGatewayAppSettings': {'DefaultResourceSpec': {'SageMakerImageArn': 'string'}},
                  'TensorBoardAppSettings': {'DefaultResourceSpec': {'SageMakerImageArn': 'string'}}}}

Creates a new 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 during on-boarding. If an administrator invites a person by email or imports them from SSO, a new UserProfile is automatically created. This entity 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',
                '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.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.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'
            }
        },
        'KernelGatewayAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': '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.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.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'
            }
        },
        'TensorBoardAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': '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.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.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'
            }
        }
    }
)

type DomainId

string

param DomainId

[REQUIRED]

The ID of the associated Domain.

type UserProfileName

string

param UserProfileName

[REQUIRED]

A name for the UserProfile.

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

• (dict) --

  Describes a tag.

  • Key (string) -- [REQUIRED]

    The tag key.

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

  • (string) --

• SharingSettings (dict) --

  The sharing settings.

  • NotebookOutputOption (string) --

    The notebook output option.

  • S3OutputPath (string) --

    The Amazon S3 output path.

  • S3KmsKeyId (string) --

    The AWS Key Management Service encryption key ID.

• JupyterServerAppSettings (dict) --

  The Jupyter server's app settings.

  • DefaultResourceSpec (dict) --

    The instance type and quantity.

    • SageMakerImageArn (string) --

      The Amazon Resource Name (ARN) of the image created on the instance.

    • InstanceType (string) --

      The instance type.

• KernelGatewayAppSettings (dict) --

  The kernel gateway app settings.

  • DefaultResourceSpec (dict) --

    The instance type and quantity.

    • SageMakerImageArn (string) --

      The Amazon Resource Name (ARN) of the image created on the instance.

    • InstanceType (string) --

      The instance type.

• TensorBoardAppSettings (dict) --

  The TensorBoard app settings.

  • DefaultResourceSpec (dict) --

    The instance type and quantity.

    • SageMakerImageArn (string) --

      The Amazon Resource Name (ARN) of the image created on the instance.

    • InstanceType (string) --

      The instance type.

rtype

dict

returns

Response Syntax

{
    'UserProfileArn': 'string'
}

Response Structure

• (dict) --

  • UserProfileArn (string) --

    The user profile Amazon Resource Name (ARN).

{'ResourceSpec': {'SageMakerImageArn': 'string'}}

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',
        '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.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.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'
    }
}

Response Structure

• (dict) --

  • AppArn (string) --

    The app's Amazon Resource Name (ARN).

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

    • SageMakerImageArn (string) --

      The Amazon Resource Name (ARN) of the image created on the instance.

    • InstanceType (string) --

      The instance type.

{'DefaultUserSettings': {'JupyterServerAppSettings': {'DefaultResourceSpec': {'SageMakerImageArn': 'string'}},
                         'KernelGatewayAppSettings': {'DefaultResourceSpec': {'SageMakerImageArn': 'string'}},
                         'TensorBoardAppSettings': {'DefaultResourceSpec': {'SageMakerImageArn': 'string'}}}}

The desciption 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',
    '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',
                '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.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.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'
            }
        },
        'KernelGatewayAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': '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.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.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'
            }
        },
        'TensorBoardAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': '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.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.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'
            }
        }
    },
    'HomeEfsFileSystemKmsKeyId': 'string',
    'SubnetIds': [
        'string',
    ],
    'Url': 'string',
    'VpcId': '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 all UserProfile 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.

      • (string) --

    • SharingSettings (dict) --

      The sharing settings.

      • NotebookOutputOption (string) --

        The notebook output option.

      • S3OutputPath (string) --

        The Amazon S3 output path.

      • S3KmsKeyId (string) --

        The AWS Key Management Service encryption key ID.

    • JupyterServerAppSettings (dict) --

      The Jupyter server's app settings.

      • DefaultResourceSpec (dict) --

        The instance type and quantity.

        • SageMakerImageArn (string) --

          The Amazon Resource Name (ARN) of the image created on the instance.

        • InstanceType (string) --

          The instance type.

    • KernelGatewayAppSettings (dict) --

      The kernel gateway app settings.

      • DefaultResourceSpec (dict) --

        The instance type and quantity.

        • SageMakerImageArn (string) --

          The Amazon Resource Name (ARN) of the image created on the instance.

        • InstanceType (string) --

          The instance type.

    • TensorBoardAppSettings (dict) --

      The TensorBoard app settings.

      • DefaultResourceSpec (dict) --

        The instance type and quantity.

        • SageMakerImageArn (string) --

          The Amazon Resource Name (ARN) of the image created on the instance.

        • InstanceType (string) --

          The instance type.

  • HomeEfsFileSystemKmsKeyId (string) --

    The AWS Key Management Service encryption key ID.

  • SubnetIds (list) --

    Security setting to limit to a set of subnets.

    • (string) --

  • Url (string) --

    The domain's URL.

  • VpcId (string) --

    The ID of the Amazon Virtual Private Cloud.

{'UserSettings': {'JupyterServerAppSettings': {'DefaultResourceSpec': {'SageMakerImageArn': 'string'}},
                  'KernelGatewayAppSettings': {'DefaultResourceSpec': {'SageMakerImageArn': 'string'}},
                  'TensorBoardAppSettings': {'DefaultResourceSpec': {'SageMakerImageArn': 'string'}}}}

Describes the user profile.

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.

rtype

dict

returns

Response Syntax

{
    'DomainId': 'string',
    'UserProfileArn': 'string',
    'UserProfileName': 'string',
    'HomeEfsFileSystemUid': 'string',
    'Status': 'Deleting'|'Failed'|'InService'|'Pending',
    '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',
                '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.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.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'
            }
        },
        'KernelGatewayAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': '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.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.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'
            }
        },
        'TensorBoardAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': '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.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.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'
            }
        }
    }
}

Response Structure

• (dict) --

  • DomainId (string) --

    The domain ID.

  • UserProfileArn (string) --

    The user profile Amazon Resource Name (ARN).

  • UserProfileName (string) --

    The user profile name.

  • HomeEfsFileSystemUid (string) --

    The homa Amazon Elastic File System (EFS) Uid.

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

      • (string) --

    • SharingSettings (dict) --

      The sharing settings.

      • NotebookOutputOption (string) --

        The notebook output option.

      • S3OutputPath (string) --

        The Amazon S3 output path.

      • S3KmsKeyId (string) --

        The AWS Key Management Service encryption key ID.

    • JupyterServerAppSettings (dict) --

      The Jupyter server's app settings.

      • DefaultResourceSpec (dict) --

        The instance type and quantity.

        • SageMakerImageArn (string) --

          The Amazon Resource Name (ARN) of the image created on the instance.

        • InstanceType (string) --

          The instance type.

    • KernelGatewayAppSettings (dict) --

      The kernel gateway app settings.

      • DefaultResourceSpec (dict) --

        The instance type and quantity.

        • SageMakerImageArn (string) --

          The Amazon Resource Name (ARN) of the image created on the instance.

        • InstanceType (string) --

          The instance type.

    • TensorBoardAppSettings (dict) --

      The TensorBoard app settings.

      • DefaultResourceSpec (dict) --

        The instance type and quantity.

        • SageMakerImageArn (string) --

          The Amazon Resource Name (ARN) of the image created on the instance.

        • InstanceType (string) --

          The instance type.

{'DefaultUserSettings': {'JupyterServerAppSettings': {'DefaultResourceSpec': {'SageMakerImageArn': 'string'}},
                         'KernelGatewayAppSettings': {'DefaultResourceSpec': {'SageMakerImageArn': 'string'}},
                         'TensorBoardAppSettings': {'DefaultResourceSpec': {'SageMakerImageArn': 'string'}}}}

Updates a domain. Changes will impact all of the people 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',
                '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.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.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'
            }
        },
        'KernelGatewayAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': '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.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.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'
            }
        },
        'TensorBoardAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': '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.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.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'
            }
        }
    }
)

type DomainId

string

param DomainId

[REQUIRED]

The domain ID.

type DefaultUserSettings

dict

param DefaultUserSettings

A collection of settings.

• ExecutionRole (string) --

  The execution role for the user.

• SecurityGroups (list) --

  The security groups.

  • (string) --

• SharingSettings (dict) --

  The sharing settings.

  • NotebookOutputOption (string) --

    The notebook output option.

  • S3OutputPath (string) --

    The Amazon S3 output path.

  • S3KmsKeyId (string) --

    The AWS Key Management Service encryption key ID.

• JupyterServerAppSettings (dict) --

  The Jupyter server's app settings.

  • DefaultResourceSpec (dict) --

    The instance type and quantity.

    • SageMakerImageArn (string) --

      The Amazon Resource Name (ARN) of the image created on the instance.

    • InstanceType (string) --

      The instance type.

• KernelGatewayAppSettings (dict) --

  The kernel gateway app settings.

  • DefaultResourceSpec (dict) --

    The instance type and quantity.

    • SageMakerImageArn (string) --

      The Amazon Resource Name (ARN) of the image created on the instance.

    • InstanceType (string) --

      The instance type.

• TensorBoardAppSettings (dict) --

  The TensorBoard app settings.

  • DefaultResourceSpec (dict) --

    The instance type and quantity.

    • SageMakerImageArn (string) --

      The Amazon Resource Name (ARN) of the image created on the instance.

    • InstanceType (string) --

      The instance type.

rtype

dict

returns

Response Syntax

{
    'DomainArn': 'string'
}

Response Structure

• (dict) --

  • DomainArn (string) --

    The domain Amazon Resource Name (ARN).

{'UserSettings': {'JupyterServerAppSettings': {'DefaultResourceSpec': {'SageMakerImageArn': 'string'}},
                  'KernelGatewayAppSettings': {'DefaultResourceSpec': {'SageMakerImageArn': 'string'}},
                  'TensorBoardAppSettings': {'DefaultResourceSpec': {'SageMakerImageArn': 'string'}}}}

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',
                '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.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.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'
            }
        },
        'KernelGatewayAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': '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.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.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'
            }
        },
        'TensorBoardAppSettings': {
            'DefaultResourceSpec': {
                'SageMakerImageArn': '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.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.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'
            }
        }
    }
)

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.

  • (string) --

• SharingSettings (dict) --

  The sharing settings.

  • NotebookOutputOption (string) --

    The notebook output option.

  • S3OutputPath (string) --

    The Amazon S3 output path.

  • S3KmsKeyId (string) --

    The AWS Key Management Service encryption key ID.

• JupyterServerAppSettings (dict) --

  The Jupyter server's app settings.

  • DefaultResourceSpec (dict) --

    The instance type and quantity.

    • SageMakerImageArn (string) --

      The Amazon Resource Name (ARN) of the image created on the instance.

    • InstanceType (string) --

      The instance type.

• KernelGatewayAppSettings (dict) --

  The kernel gateway app settings.

  • DefaultResourceSpec (dict) --

    The instance type and quantity.

    • SageMakerImageArn (string) --

      The Amazon Resource Name (ARN) of the image created on the instance.

    • InstanceType (string) --

      The instance type.

• TensorBoardAppSettings (dict) --

  The TensorBoard app settings.

  • DefaultResourceSpec (dict) --

    The instance type and quantity.

    • SageMakerImageArn (string) --

      The Amazon Resource Name (ARN) of the image created on the instance.

    • InstanceType (string) --

      The instance type.

rtype

dict

returns

Response Syntax

{
    'UserProfileArn': 'string'
}

Response Structure

• (dict) --

  • UserProfileArn (string) --

    The user profile Amazon Resource Name (ARN).