apps

Creates, updates, deletes or gets an app resource or lists apps in a region

Overview

Name	apps
Type	Resource
Description	Resource Type definition for AWS::SageMaker::App
Id	awscc.sagemaker.apps

Fields

get (all properties)

Name	Datatype	Description
app_arn	string	The Amazon Resource Name (ARN) of the app.
app_name	string	The name of the app.
app_type	string	The type of app.
domain_id	string	The domain ID.
▶resource_spec	object	The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.
▶tags	array	A list of tags to apply to the app.
user_profile_name	string	The user profile name.
built_in_lifecycle_config_arn	string	The lifecycle configuration that runs before the default lifecycle configuration.
recovery_mode	boolean	Indicates whether the application is launched in recovery mode.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
app_name	string	The name of the app.
app_type	string	The type of app.
domain_id	string	The domain ID.
user_profile_name	string	The user profile name.
region	string	AWS region.

For more information, see AWS::SageMaker::App.

Methods

Name	Resource	Accessible by	Required Params
create_resource	apps	INSERT	AppName, AppType, DomainId, UserProfileName, region
delete_resource	apps	DELETE	Identifier, region
update_resource	apps	UPDATE	Identifier, PatchDocument, region
list_resources	apps_list_only	SELECT	region
get_resource	apps	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual app.

SELECT
  region,
  app_arn,
  app_name,
  app_type,
  domain_id,
  resource_spec,
  tags,
  user_profile_name,
  built_in_lifecycle_config_arn,
  recovery_mode
FROM awscc.sagemaker.apps
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ app_name }}|{{ app_type }}|{{ domain_id }}|{{ user_profile_name }}';

list (identifiers only)

Lists all apps in a region.

SELECT
  region,
  app_name,
  app_type,
  domain_id,
  user_profile_name
FROM awscc.sagemaker.apps_list_only
WHERE
  region = 'us-east-1';

INSERT example

Use the following StackQL query and manifest file to create a new app resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.sagemaker.apps (
  AppName,
  AppType,
  DomainId,
  UserProfileName,
  region
)
SELECT
  '{{ app_name }}',
  '{{ app_type }}',
  '{{ domain_id }}',
  '{{ user_profile_name }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.sagemaker.apps (
  AppName,
  AppType,
  DomainId,
  ResourceSpec,
  Tags,
  UserProfileName,
  RecoveryMode,
  region
)
SELECT
  '{{ app_name }}',
  '{{ app_type }}',
  '{{ domain_id }}',
  '{{ resource_spec }}',
  '{{ tags }}',
  '{{ user_profile_name }}',
  '{{ recovery_mode }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: app
    props:
      - name: app_name
        value: '{{ app_name }}'
      - name: app_type
        value: '{{ app_type }}'
      - name: domain_id
        value: '{{ domain_id }}'
      - name: resource_spec
        value:
          instance_type: '{{ instance_type }}'
          sage_maker_image_arn: '{{ sage_maker_image_arn }}'
          sage_maker_image_version_arn: '{{ sage_maker_image_version_arn }}'
          lifecycle_config_arn: '{{ lifecycle_config_arn }}'
      - name: tags
        value:
          - value: '{{ value }}'
            key: '{{ key }}'
      - name: user_profile_name
        value: '{{ user_profile_name }}'
      - name: recovery_mode
        value: '{{ recovery_mode }}'

UPDATE example

Use the following StackQL query and manifest file to update a app resource, using stack-deploy.

/*+ update */
UPDATE awscc.sagemaker.apps
SET PatchDocument = string('{{ {
    "Tags": tags,
    "RecoveryMode": recovery_mode
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ app_name }}|{{ app_type }}|{{ domain_id }}|{{ user_profile_name }}';

DELETE example

/*+ delete */
DELETE FROM awscc.sagemaker.apps
WHERE
  Identifier = '{{ app_name }}|{{ app_type }}|{{ domain_id }}|{{ user_profile_name }}' AND
  region = 'us-east-1';

Permissions

To operate on the apps resource, the following permissions are required:

Create

sagemaker:CreateApp,
sagemaker:DescribeApp,
sagemaker:AddTags,
sagemaker:ListTags

Read

sagemaker:DescribeApp,
sagemaker:DescribeApp,
sagemaker:ListTags

Update

sagemaker:DescribeApp,
sagemaker:AddTags,
sagemaker:DeleteTags,
sagemaker:ListTags

Delete

sagemaker:DeleteApp,
sagemaker:DescribeApp,
sagemaker:DeleteTags,
sagemaker:ListTags

List

sagemaker:ListApps,
sagemaker:ListTags