Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

CreatePartnerApp

Creates an Amazon SageMaker Partner AI App.

Request Syntax


{
   "ApplicationConfig": { 
      "AdminUsers": [ "string" ],
      "Arguments": { 
         "string" : "string" 
      }
   },
   "AuthType": "string",
   "ClientToken": "string",
   "EnableIamSessionBasedIdentity": boolean,
   "ExecutionRoleArn": "string",
   "KmsKeyId": "string",
   "MaintenanceConfig": { 
      "MaintenanceWindowStart": "string"
   },
   "Name": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "Tier": "string",
   "Type": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ApplicationConfig

Configuration settings for the SageMaker Partner AI App.

Type: PartnerAppConfig object

Required: No

AuthType

The authorization type that users use to access the SageMaker Partner AI App.

Type: String

Valid Values: IAM

Required: Yes

ClientToken

A unique token that guarantees that the call to this API is idempotent.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 36.

Pattern: [a-zA-Z0-9-]+

Required: No

EnableIamSessionBasedIdentity

When set to TRUE, the SageMaker Partner AI App sets the AWS IAM session name or the authenticated IAM user as the identity of the SageMaker Partner AI App user.

Type: Boolean

Required: No

ExecutionRoleArn

The ARN of the IAM role that the partner application uses.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+

Required: Yes

KmsKeyId

SageMaker Partner AI Apps uses AWS KMS to encrypt data at rest using an AWS managed key by default. For more control, specify a customer managed key.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: [a-zA-Z0-9:/_-]*

Required: No

MaintenanceConfig

Maintenance configuration settings for the SageMaker Partner AI App.

Type: PartnerAppMaintenanceConfig object

Required: No

Name

The name to give the SageMaker Partner AI App.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [a-zA-Z0-9]+

Required: Yes

Tags

Each tag consists of a key and an optional value. Tag keys must be unique per resource.

Type: Array of Tag objects

Array Members: Minimum number of 0 items. Maximum number of 50 items.

Required: No

Tier

Indicates the instance type and size of the cluster attached to the SageMaker Partner AI App.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 64.

Pattern: (?!\s*$).+

Required: Yes

Type

The type of SageMaker Partner AI App to create. Must be one of the following: lakera-guard, comet, deepchecks-llm-evaluation, or fiddler.

Type: String

Valid Values: lakera-guard | comet | deepchecks-llm-evaluation | fiddler

Required: Yes

Response Syntax


{
   "Arn": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Arn

The ARN of the SageMaker Partner AI App.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:partner-app\/app-[A-Z0-9]{12}

Errors

For information about the errors that are common to all actions, see Common Errors.

ConflictException

There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.

HTTP Status Code: 400

ResourceLimitExceeded

You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.

HTTP Status Code: 400