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	aws.sagemaker.apps

Fields

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

Methods

Name	Accessible by	Required Params
create_resource	INSERT	AppName, AppType, DomainId, UserProfileName, region
delete_resource	DELETE	data__Identifier, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all apps in a region.

SELECT
region,
app_arn,
app_name,
app_type,
domain_id,
resource_spec,
tags,
user_profile_name
FROM aws.sagemaker.apps
WHERE region = 'us-east-1';

Gets all properties from an individual app.

SELECT
region,
app_arn,
app_name,
app_type,
domain_id,
resource_spec,
tags,
user_profile_name
FROM aws.sagemaker.apps
WHERE region = 'us-east-1' AND data__Identifier = '<AppName>|<AppType>|<DomainId>|<UserProfileName>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.sagemaker.apps (
 AppName,
 AppType,
 DomainId,
 UserProfileName,
 region
)
SELECT 
'{{ AppName }}',
 '{{ AppType }}',
 '{{ DomainId }}',
 '{{ UserProfileName }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.sagemaker.apps (
 AppName,
 AppType,
 DomainId,
 ResourceSpec,
 Tags,
 UserProfileName,
 region
)
SELECT 
 '{{ AppName }}',
 '{{ AppType }}',
 '{{ DomainId }}',
 '{{ ResourceSpec }}',
 '{{ Tags }}',
 '{{ UserProfileName }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: app
    props:
      - name: AppName
        value: '{{ AppName }}'
      - name: AppType
        value: '{{ AppType }}'
      - name: DomainId
        value: '{{ DomainId }}'
      - name: ResourceSpec
        value:
          InstanceType: '{{ InstanceType }}'
          SageMakerImageArn: '{{ SageMakerImageArn }}'
          SageMakerImageVersionArn: '{{ SageMakerImageVersionArn }}'
      - name: Tags
        value:
          - Value: '{{ Value }}'
            Key: '{{ Key }}'
      - name: UserProfileName
        value: '{{ UserProfileName }}'

DELETE example

/*+ delete */
DELETE FROM aws.sagemaker.apps
WHERE data__Identifier = '<AppName|AppType|DomainId|UserProfileName>'
AND region = 'us-east-1';

Permissions

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

Create

sagemaker:CreateApp,
sagemaker:DescribeApp

Read

sagemaker:DescribeApp,
sagemaker:DescribeApp

Delete

sagemaker:DeleteApp,
sagemaker:DescribeApp

List

sagemaker:ListApps