partner_apps

Creates, updates, deletes or gets a partner_app resource or lists partner_apps in a region

Overview

Name	partner_apps
Type	Resource
Description	Resource Type definition for AWS::SageMaker::PartnerApp
Id	aws.sagemaker.partner_apps

Fields

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the created PartnerApp.
name	string	A name for the PartnerApp.
type	string	The type of PartnerApp.
execution_role_arn	string	The execution role for the user.
tier	string	The tier of the PartnerApp.
enable_iam_session_based_identity	boolean	Enables IAM Session based Identity for PartnerApp.
application_config	object	A collection of settings that specify the maintenance schedule for the PartnerApp.
auth_type	string	The Auth type of PartnerApp.
base_url	string	The AppServerUrl based on app and account-info.
maintenance_config	object	A collection of settings that specify the maintenance schedule for the PartnerApp.
client_token	string	The client token for the PartnerApp.
tags	array	A list of tags to apply to the PartnerApp.
region	string	AWS region.

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

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Name, Type, AuthType, ExecutionRoleArn, Tier, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all partner_apps in a region.

SELECT
region,
arn,
name,
type,
execution_role_arn,
tier,
enable_iam_session_based_identity,
application_config,
auth_type,
base_url,
maintenance_config,
client_token,
tags
FROM aws.sagemaker.partner_apps
WHERE region = 'us-east-1';

Gets all properties from an individual partner_app.

SELECT
region,
arn,
name,
type,
execution_role_arn,
tier,
enable_iam_session_based_identity,
application_config,
auth_type,
base_url,
maintenance_config,
client_token,
tags
FROM aws.sagemaker.partner_apps
WHERE region = 'us-east-1' AND data__Identifier = '<Arn>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.sagemaker.partner_apps (
 Name,
 Type,
 ExecutionRoleArn,
 Tier,
 AuthType,
 region
)
SELECT 
'{{ Name }}',
 '{{ Type }}',
 '{{ ExecutionRoleArn }}',
 '{{ Tier }}',
 '{{ AuthType }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.sagemaker.partner_apps (
 Name,
 Type,
 ExecutionRoleArn,
 Tier,
 EnableIamSessionBasedIdentity,
 ApplicationConfig,
 AuthType,
 MaintenanceConfig,
 ClientToken,
 Tags,
 region
)
SELECT 
 '{{ Name }}',
 '{{ Type }}',
 '{{ ExecutionRoleArn }}',
 '{{ Tier }}',
 '{{ EnableIamSessionBasedIdentity }}',
 '{{ ApplicationConfig }}',
 '{{ AuthType }}',
 '{{ MaintenanceConfig }}',
 '{{ ClientToken }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: partner_app
    props:
      - name: Name
        value: '{{ Name }}'
      - name: Type
        value: '{{ Type }}'
      - name: ExecutionRoleArn
        value: '{{ ExecutionRoleArn }}'
      - name: Tier
        value: '{{ Tier }}'
      - name: EnableIamSessionBasedIdentity
        value: '{{ EnableIamSessionBasedIdentity }}'
      - name: ApplicationConfig
        value:
          AdminUsers:
            - '{{ AdminUsers[0] }}'
          Arguments: {}
      - name: AuthType
        value: '{{ AuthType }}'
      - name: MaintenanceConfig
        value:
          MaintenanceWindowStart: '{{ MaintenanceWindowStart }}'
      - name: ClientToken
        value: '{{ ClientToken }}'
      - name: Tags
        value:
          - Value: '{{ Value }}'
            Key: '{{ Key }}'

DELETE example

/*+ delete */
DELETE FROM aws.sagemaker.partner_apps
WHERE data__Identifier = '<Arn>'
AND region = 'us-east-1';

Permissions

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

Create

sagemaker:CreatePartnerApp,
sagemaker:DescribePartnerApp,
sagemaker:AddTags,
sagemaker:ListTags,
iam:PassRole

Read

sagemaker:DescribePartnerApp,
sagemaker:ListTags

Update

sagemaker:UpdatePartnerApp,
sagemaker:DescribePartnerApp,
sagemaker:AddTags,
sagemaker:ListTags,
sagemaker:DeleteTags

Delete

sagemaker:DeletePartnerApp,
sagemaker:DescribePartnerApp,
sagemaker:DeleteTags

List

sagemaker:ListPartnerApps,
sagemaker:DescribePartnerApp,
sagemaker:ListTags