partner_apps

Creates, updates, deletes, gets or lists a partner_apps resource.

Overview

Name	partner_apps
Type	Resource
Id	aws.sagemaker.partner_apps

Fields

The following fields are returned by SELECT queries:

describe_partner_app

Name	Datatype	Description
application_config	object	Configuration settings for the SageMaker Partner AI App.
arn	string	The ARN of the SageMaker Partner AI App that was described. (pattern: <code>arn:aws[a-z-]:sagemaker:[a-z0-9-]:[0-9]{12}:partner-app/app-[A-Z0-9]{12}</code>)
auth_type	string	The authorization type that users use to access the SageMaker Partner AI App. (IAM)
available_upgrade	object	A map of available minor version upgrades for the SageMaker Partner AI App. The key is the semantic version number, and the value is a list of release notes for that version. A null value indicates no upgrades are available.
base_url	string	The URL of the SageMaker Partner AI App that the Application SDK uses to support in-app calls for the user.
creation_time	string (date-time)	The time that the SageMaker Partner AI App was created.
current_version_eol_date	string (date-time)	The end-of-life date for the current version of the SageMaker Partner AI App.
enable_auto_minor_version_upgrade	boolean	Indicates whether the SageMaker Partner AI App is configured for automatic minor version upgrades during scheduled maintenance windows.
enable_iam_session_based_identity	boolean	When set to TRUE, the SageMaker Partner AI App sets the Amazon Web Services IAM session name or the authenticated IAM user as the identity of the SageMaker Partner AI App user.
error	object	This is an error field object that contains the error code and the reason for an operation failure.
execution_role_arn	string	The ARN of the IAM role associated with the SageMaker Partner AI App. (pattern: <code>arn:aws[a-z-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@-_/]+</code>)
kms_key_id	string	The Amazon Web Services KMS customer managed key used to encrypt the data at rest associated with SageMaker Partner AI Apps. (pattern: <code>[a-zA-Z0-9:/_-]*</code>)
last_modified_time	string (date-time)	The time that the SageMaker Partner AI App was last modified.
maintenance_config	object	Maintenance configuration settings for the SageMaker Partner AI App.
name	string	The name of the SageMaker Partner AI App. (pattern: <code>[a-zA-Z0-9]+</code>)
status	string	The status of the SageMaker Partner AI App. Creating: SageMaker AI is creating the partner AI app. The partner AI app is not available during creation. Updating: SageMaker AI is updating the partner AI app. The partner AI app is not available when updating. Deleting: SageMaker AI is deleting the partner AI app. The partner AI app is not available during deletion. Available: The partner AI app is provisioned and accessible. Failed: The partner AI app is in a failed state and isn't available. SageMaker AI is investigating the issue. For further guidance, contact Amazon Web Services Support. UpdateFailed: The partner AI app couldn't be updated but is available. Deleted: The partner AI app is permanently deleted and not available. (Creating, Updating, Deleting, Available, Failed, UpdateFailed, Deleted)
tier	string	The instance type and size of the cluster attached to the SageMaker Partner AI App. (pattern: <code>(?!\s*$).+</code>)
type	string	The type of SageMaker Partner AI App. Must be one of the following: lakera-guard, comet, deepchecks-llm-evaluation, or fiddler. (lakera-guard, comet, deepchecks-llm-evaluation, fiddler)
version	string	The version of the SageMaker Partner AI App. (pattern: <code>(?!\s*$).+</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_partner_app	select	region		Gets information about a SageMaker Partner AI App.
create_partner_app	insert	region, ExecutionRoleArn, AuthType		Creates an Amazon SageMaker Partner AI App.
create_partner_app_presigned_url	insert	region		Creates a presigned URL to access an Amazon SageMaker Partner AI App.
update_partner_app	update	region		Updates all of the SageMaker Partner AI Apps in an account.
delete_partner_app	delete	region		Deletes a SageMaker Partner AI App.
list_partner_apps	exec	region		Lists all of the SageMaker Partner AI Apps in an account.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_partner_app

Gets information about a SageMaker Partner AI App.

SELECT
application_config,
arn,
auth_type,
available_upgrade,
base_url,
creation_time,
current_version_eol_date,
enable_auto_minor_version_upgrade,
enable_iam_session_based_identity,
error,
execution_role_arn,
kms_key_id,
last_modified_time,
maintenance_config,
name,
status,
tier,
type,
version
FROM aws.sagemaker.partner_apps
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_partner_app

Creates an Amazon SageMaker Partner AI App.

INSERT INTO aws.sagemaker.partner_apps (
Name,
Type,
ExecutionRoleArn,
KmsKeyId,
MaintenanceConfig,
Tier,
ApplicationConfig,
AuthType,
EnableIamSessionBasedIdentity,
EnableAutoMinorVersionUpgrade,
ClientToken,
Tags,
region
)
SELECT 
'{{ Name }}',
'{{ Type }}',
'{{ ExecutionRoleArn }}' /* required */,
'{{ KmsKeyId }}',
'{{ MaintenanceConfig }}',
'{{ Tier }}',
'{{ ApplicationConfig }}',
'{{ AuthType }}' /* required */,
{{ EnableIamSessionBasedIdentity }},
{{ EnableAutoMinorVersionUpgrade }},
'{{ ClientToken }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
arn
;

create_partner_app_presigned_url

Creates a presigned URL to access an Amazon SageMaker Partner AI App.

INSERT INTO aws.sagemaker.partner_apps (
Arn,
ExpiresInSeconds,
SessionExpirationDurationInSeconds,
region
)
SELECT 
'{{ Arn }}',
{{ ExpiresInSeconds }},
{{ SessionExpirationDurationInSeconds }},
'{{ region }}'
RETURNING
url
;

Manifest

# Description fields are for documentation purposes
- name: partner_apps
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the partner_apps resource.
  - name: Name
    value: "{{ Name }}"
    description: |
      The name to give the SageMaker Partner AI App.
  - name: Type
    value: "{{ Type }}"
    description: |
      The type of SageMaker Partner AI App to create. Must be one of the following: lakera-guard, comet, deepchecks-llm-evaluation, or fiddler.
    valid_values: ['lakera-guard', 'comet', 'deepchecks-llm-evaluation', 'fiddler']
  - name: ExecutionRoleArn
    value: "{{ ExecutionRoleArn }}"
    description: |
      The ARN of the IAM role that the partner application uses.
  - name: KmsKeyId
    value: "{{ KmsKeyId }}"
    description: |
      SageMaker Partner AI Apps uses Amazon Web Services KMS to encrypt data at rest using an Amazon Web Services managed key by default. For more control, specify a customer managed key.
  - name: MaintenanceConfig
    description: |
      Maintenance configuration settings for the SageMaker Partner AI App.
    value:
      MaintenanceWindowStart: "{{ MaintenanceWindowStart }}"
  - name: Tier
    value: "{{ Tier }}"
    description: |
      Indicates the instance type and size of the cluster attached to the SageMaker Partner AI App.
  - name: ApplicationConfig
    description: |
      Configuration settings for the SageMaker Partner AI App.
    value:
      AdminUsers:
        - "{{ AdminUsers }}"
      Arguments: "{{ Arguments }}"
      AssignedGroupPatterns:
        - "{{ AssignedGroupPatterns }}"
      RoleGroupAssignments:
        - RoleName: "{{ RoleName }}"
          GroupPatterns: "{{ GroupPatterns }}"
  - name: AuthType
    value: "{{ AuthType }}"
    description: |
      The authorization type that users use to access the SageMaker Partner AI App.
    valid_values: ['IAM']
  - name: EnableIamSessionBasedIdentity
    value: {{ EnableIamSessionBasedIdentity }}
    description: |
      When set to TRUE, the SageMaker Partner AI App sets the Amazon Web Services IAM session name or the authenticated IAM user as the identity of the SageMaker Partner AI App user.
  - name: EnableAutoMinorVersionUpgrade
    value: {{ EnableAutoMinorVersionUpgrade }}
    description: |
      When set to TRUE, the SageMaker Partner AI App is automatically upgraded to the latest minor version during the next scheduled maintenance window, if one is available. Default is FALSE.
  - name: ClientToken
    value: "{{ ClientToken }}"
    description: |
      A unique token that guarantees that the call to this API is idempotent.
  - name: Tags
    description: |
      Each tag consists of a key and an optional value. Tag keys must be unique per resource.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
  - name: Arn
    value: "{{ Arn }}"
    description: |
      The ARN of the SageMaker Partner AI App to create the presigned URL for.
  - name: ExpiresInSeconds
    value: {{ ExpiresInSeconds }}
    description: |
      The time that will pass before the presigned URL expires.
  - name: SessionExpirationDurationInSeconds
    value: {{ SessionExpirationDurationInSeconds }}
    description: |
      Indicates how long the Amazon SageMaker Partner AI App session can be accessed for after logging in.

UPDATE examples

update_partner_app

Updates all of the SageMaker Partner AI Apps in an account.

UPDATE aws.sagemaker.partner_apps
SET 
Arn = '{{ Arn }}',
MaintenanceConfig = '{{ MaintenanceConfig }}',
Tier = '{{ Tier }}',
ApplicationConfig = '{{ ApplicationConfig }}',
EnableIamSessionBasedIdentity = {{ EnableIamSessionBasedIdentity }},
EnableAutoMinorVersionUpgrade = {{ EnableAutoMinorVersionUpgrade }},
AppVersion = '{{ AppVersion }}',
ClientToken = '{{ ClientToken }}',
Tags = '{{ Tags }}'
WHERE 
region = '{{ region }}' --required
RETURNING
arn;

DELETE examples

delete_partner_app

Deletes a SageMaker Partner AI App.

DELETE FROM aws.sagemaker.partner_apps
WHERE region = '{{ region }}' --required
;

Lifecycle Methods

list_partner_apps

Lists all of the SageMaker Partner AI Apps in an account.

EXEC aws.sagemaker.partner_apps.list_partner_apps 
@region='{{ region }}' --required 
@@json=
'{
"MaxResults": {{ MaxResults }}, 
"NextToken": "{{ NextToken }}"
}'
;