Skip to content

CreateAppRequest

Source code in docs_src/capo_sagemaker/types/create_app_request.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
class CreateAppRequest(TypedDict, closed=True):
    domain_id: NotRequired["capo_sagemaker.types.domain_id.DomainId"]
    """<p>The domain ID.</p>"""
    user_profile_name: NotRequired[
        "capo_sagemaker.types.user_profile_name.UserProfileName"
    ]
    """<p>The user profile name. If this value is not set, then <code>SpaceName</code> must be set.</p>"""
    space_name: NotRequired["capo_sagemaker.types.space_name.SpaceName"]
    """<p>The name of the space. If this value is not set, then <code>UserProfileName</code> must be set.</p>"""
    app_type: NotRequired["capo_sagemaker.types.app_type.AppType"]
    """<p>The type of app.</p>"""
    app_name: NotRequired["capo_sagemaker.types.app_name.AppName"]
    """<p>The name of the app.</p>"""
    tags: NotRequired["capo_sagemaker.types.tag_list.TagList"]
    """<p>Each tag consists of a key and an optional value. Tag keys must be unique per resource.</p>"""
    resource_spec: NotRequired["capo_sagemaker.types.resource_spec.ResourceSpec"]
    """<p>The instance type and the Amazon Resource Name (ARN) of the SageMaker AI image created on the instance.</p> <note> <p>The value of <code>InstanceType</code> passed as part of the <code>ResourceSpec</code> in the <code>CreateApp</code> call overrides the value passed as part of the <code>ResourceSpec</code> configured for the user profile or the domain. If <code>InstanceType</code> is not specified in any of those three <code>ResourceSpec</code> values for a <code>KernelGateway</code> app, the <code>CreateApp</code> call fails with a request validation error.</p> </note>"""
    recovery_mode: NotRequired["capo_sagemaker.types.boolean.Boolean"]
    """<p> Indicates whether the application is launched in recovery mode. </p>"""

app_name instance-attribute 

app_name: NotRequired[AppName]

The name of the app.

app_type instance-attribute 

app_type: NotRequired[AppType]

The type of app.

domain_id instance-attribute 

domain_id: NotRequired[DomainId]

The domain ID.

recovery_mode instance-attribute 

recovery_mode: NotRequired[Boolean]

Indicates whether the application is launched in recovery mode.

resource_spec instance-attribute 

resource_spec: NotRequired[ResourceSpec]

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

The value of InstanceType passed as part of the ResourceSpec in the CreateApp call overrides the value passed as part of the ResourceSpec configured for the user profile or the domain. If InstanceType is not specified in any of those three ResourceSpec values for a KernelGateway app, the CreateApp call fails with a request validation error.

space_name instance-attribute 

space_name: NotRequired[SpaceName]

The name of the space. If this value is not set, then UserProfileName must be set.

tags instance-attribute 

tags: NotRequired[TagList]

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

user_profile_name instance-attribute 

user_profile_name: NotRequired[UserProfileName]

The user profile name. If this value is not set, then SpaceName must be set.