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	awscc.sagemaker.partner_apps

Fields

get (all properties)

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.
kms_key_id	string	The AWS KMS customer managed key used to encrypt the data associated with the PartnerApp.
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.

list (identifiers only)

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the created PartnerApp.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	partner_apps	INSERT	Name, Type, AuthType, ExecutionRoleArn, Tier, region
delete_resource	partner_apps	DELETE	Identifier, region
update_resource	partner_apps	UPDATE	Identifier, PatchDocument, region
list_resources	partner_apps_list_only	SELECT	region
get_resource	partner_apps	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual partner_app.

SELECT
  region,
  arn,
  name,
  type,
  execution_role_arn,
  kms_key_id,
  tier,
  enable_iam_session_based_identity,
  application_config,
  auth_type,
  base_url,
  maintenance_config,
  client_token,
  tags
FROM awscc.sagemaker.partner_apps
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}';

list (identifiers only)

Lists all partner_apps in a region.

SELECT
  region,
  arn
FROM awscc.sagemaker.partner_apps_list_only
WHERE
  region = '{{ region }}';

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 awscc.sagemaker.partner_apps (
  Name,
  Type,
  ExecutionRoleArn,
  Tier,
  AuthType,
  region
)
SELECT
  '{{ name }}',
  '{{ type }}',
  '{{ execution_role_arn }}',
  '{{ tier }}',
  '{{ auth_type }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.sagemaker.partner_apps (
  Name,
  Type,
  ExecutionRoleArn,
  KmsKeyId,
  Tier,
  EnableIamSessionBasedIdentity,
  ApplicationConfig,
  AuthType,
  MaintenanceConfig,
  ClientToken,
  Tags,
  region
)
SELECT
  '{{ name }}',
  '{{ type }}',
  '{{ execution_role_arn }}',
  '{{ kms_key_id }}',
  '{{ tier }}',
  '{{ enable_iam_session_based_identity }}',
  '{{ application_config }}',
  '{{ auth_type }}',
  '{{ maintenance_config }}',
  '{{ client_token }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

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: execution_role_arn
      value: '{{ execution_role_arn }}'
    - name: kms_key_id
      value: '{{ kms_key_id }}'
    - name: tier
      value: '{{ tier }}'
    - name: enable_iam_session_based_identity
      value: '{{ enable_iam_session_based_identity }}'
    - name: application_config
      value:
        admin_users:
          - '{{ admin_users[0] }}'
        arguments: {}
    - name: auth_type
      value: '{{ auth_type }}'
    - name: maintenance_config
      value:
        maintenance_window_start: '{{ maintenance_window_start }}'
    - name: client_token
      value: '{{ client_token }}'
    - name: tags
      value:
        - value: '{{ value }}'
          key: '{{ key }}'

UPDATE example

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

/*+ update */
UPDATE awscc.sagemaker.partner_apps
SET PatchDocument = string('{{ {
    "Tier": tier,
    "EnableIamSessionBasedIdentity": enable_iam_session_based_identity,
    "ApplicationConfig": application_config,
    "MaintenanceConfig": maintenance_config,
    "ClientToken": client_token,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.sagemaker.partner_apps
WHERE
  Identifier = '{{ arn }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

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

Create

sagemaker:CreatePartnerApp,
sagemaker:DescribePartnerApp,
sagemaker:AddTags,
sagemaker:ListTags,
iam:PassRole,
kms:CreateGrant,
kms:DescribeKey

Read

sagemaker:DescribePartnerApp,
sagemaker:ListTags

Update

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

Delete

sagemaker:DeletePartnerApp,
sagemaker:DescribePartnerApp,
sagemaker:DeleteTags

List

sagemaker:ListPartnerApps,
sagemaker:DescribePartnerApp,
sagemaker:ListTags