SageMaker / Client / create_partner_app

create_partner_app¶

SageMaker.Client.create_partner_app(**kwargs)¶

Creates an Amazon SageMaker Partner AI App.

Request Syntax

response = client.create_partner_app(
    Name='string',
    Type='lakera-guard'|'comet'|'deepchecks-llm-evaluation'|'fiddler',
    ExecutionRoleArn='string',
    KmsKeyId='string',
    MaintenanceConfig={
        'MaintenanceWindowStart': 'string'
    },
    Tier='string',
    ApplicationConfig={
        'AdminUsers': [
            'string',
        ],
        'Arguments': {
            'string': 'string'
        },
        'AssignedGroupPatterns': [
            'string',
        ],
        'RoleGroupAssignments': [
            {
                'RoleName': 'string',
                'GroupPatterns': [
                    'string',
                ]
            },
        ]
    },
    AuthType='IAM',
    EnableIamSessionBasedIdentity=True|False,
    EnableAutoMinorVersionUpgrade=True|False,
    ClientToken='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

Parameters:

Name (string) –
[REQUIRED]

The name to give the SageMaker Partner AI App.
Type (string) –
[REQUIRED]

The type of SageMaker Partner AI App to create. Must be one of the following: lakera-guard, comet, deepchecks-llm-evaluation, or fiddler.
ExecutionRoleArn (string) –
[REQUIRED]

The ARN of the IAM role that the partner application uses.
KmsKeyId (string) – 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.
MaintenanceConfig (dict) –
Maintenance configuration settings for the SageMaker Partner AI App.
- MaintenanceWindowStart (string) –
  
  The day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time that weekly maintenance updates are scheduled. This value must take the following format: 3-letter-day:24-h-hour:minute. For example: TUE:03:30.
Tier (string) –
[REQUIRED]

Indicates the instance type and size of the cluster attached to the SageMaker Partner AI App.
ApplicationConfig (dict) –
Configuration settings for the SageMaker Partner AI App.
- AdminUsers (list) –
  
  The list of users that are given admin access to the SageMaker Partner AI App.
  - (string) –
- Arguments (dict) –
  
  This is a map of required inputs for a SageMaker Partner AI App. Based on the application type, the map is populated with a key and value pair that is specific to the user and application.
  - (string) –
    - (string) –
- AssignedGroupPatterns (list) –
  
  A list of Amazon Web Services IAM Identity Center group patterns that can access the SageMaker Partner AI App. Group names support wildcard matching using *. An empty list indicates the app will not use Identity Center group features. All groups specified in RoleGroupAssignments must match patterns in this list.
  - (string) –
- RoleGroupAssignments (list) –
  
  A map of in-app roles to Amazon Web Services IAM Identity Center group patterns. Groups assigned to specific roles receive those permissions, while groups in AssignedGroupPatterns but not in this map receive default in-app role depending on app type. Group patterns support wildcard matching using *. Currently supported by Fiddler version 1.3 and later with roles: ORG_MEMBER (default) and ORG_ADMIN.
  - (dict) –
    
    Defines the mapping between an in-app role and the Amazon Web Services IAM Identity Center group patterns that should be assigned to that role within the SageMaker Partner AI App.
    - RoleName (string) – [REQUIRED]
      
      The name of the in-app role within the SageMaker Partner AI App. The specific roles available depend on the app type and version.
    - GroupPatterns (list) – [REQUIRED]
      
      A list of Amazon Web Services IAM Identity Center group patterns that should be assigned to the specified role. Group patterns support wildcard matching using *.
      - (string) –
AuthType (string) –
[REQUIRED]

The authorization type that users use to access the SageMaker Partner AI App.
EnableIamSessionBasedIdentity (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.
EnableAutoMinorVersionUpgrade (boolean) – 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.
ClientToken (string) –
A unique token that guarantees that the call to this API is idempotent.

This field is autopopulated if not provided.
Tags (list) –
Each tag consists of a key and an optional value. Tag keys must be unique per resource.
- (dict) –
  
  A tag object that consists of a key and an optional value, used to manage metadata for SageMaker Amazon Web Services resources.
  
  You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. For more information on adding tags to SageMaker resources, see AddTags.
  
  For more information on adding metadata to your Amazon Web Services resources with tagging, see Tagging Amazon Web Services resources. For advice on best practices for managing Amazon Web Services resources with tagging, see Tagging Best Practices: Implement an Effective Amazon Web Services Resource Tagging Strategy.
  - Key (string) – [REQUIRED]
    
    The tag key. Tag keys must be unique per resource.
  - Value (string) – [REQUIRED]
    
    The tag value.

Return type:

dict

Returns:

Response Syntax

{
    'Arn': 'string'
}

Response Structure

(dict) –
- Arn (string) –
  
  The ARN of the SageMaker Partner AI App.

Exceptions

SageMaker.Client.exceptions.ConflictException
SageMaker.Client.exceptions.ResourceLimitExceeded