AWS API Changes

2025/03/25 - Amazon SageMaker Service - 2 updated api methods

Changes This release adds support for customer-managed KMS keys in Amazon SageMaker Partner AI Apps

CreatePartnerApp (updated)

Link ¶
Changes (request)

{'KmsKeyId': 'string'}

Creates an Amazon SageMaker Partner AI App.

See also: AWS API Documentation

Request Syntax

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'
        }
    },
    AuthType='IAM',
    EnableIamSessionBasedIdentity=True|False,
    ClientToken='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

type Name:

string

param Name:

[REQUIRED]

The name to give the SageMaker Partner AI App.

type Type:

string

param Type:

[REQUIRED]

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

type ExecutionRoleArn:

string

param ExecutionRoleArn:

[REQUIRED]

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

type KmsKeyId:

string

param KmsKeyId:

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.

type MaintenanceConfig:

dict

param MaintenanceConfig:

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.

type Tier:

string

param Tier:

[REQUIRED]

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

type ApplicationConfig:

dict

param ApplicationConfig:

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) --

type AuthType:

string

param AuthType:

[REQUIRED]

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

type EnableIamSessionBasedIdentity:

boolean

param EnableIamSessionBasedIdentity:

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.

type ClientToken:

string

param ClientToken:

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

This field is autopopulated if not provided.

type Tags:

list

param Tags:

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.

rtype:

dict

returns:

Response Syntax

{
    'Arn': 'string'
}

Response Structure

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

DescribePartnerApp (updated)

Link ¶
Changes (response)

{'KmsKeyId': 'string', 'LastModifiedTime': 'timestamp'}

Gets information about a SageMaker Partner AI App.

See also: AWS API Documentation

Request Syntax

client.describe_partner_app(
    Arn='string'
)

type Arn:

string

param Arn:

[REQUIRED]

The ARN of the SageMaker Partner AI App to describe.

rtype:

dict

returns:

Response Syntax

{
    'Arn': 'string',
    'Name': 'string',
    'Type': 'lakera-guard'|'comet'|'deepchecks-llm-evaluation'|'fiddler',
    'Status': 'Creating'|'Updating'|'Deleting'|'Available'|'Failed'|'UpdateFailed'|'Deleted',
    'CreationTime': datetime(2015, 1, 1),
    'LastModifiedTime': datetime(2015, 1, 1),
    'ExecutionRoleArn': 'string',
    'KmsKeyId': 'string',
    'BaseUrl': 'string',
    'MaintenanceConfig': {
        'MaintenanceWindowStart': 'string'
    },
    'Tier': 'string',
    'Version': 'string',
    'ApplicationConfig': {
        'AdminUsers': [
            'string',
        ],
        'Arguments': {
            'string': 'string'
        }
    },
    'AuthType': 'IAM',
    'EnableIamSessionBasedIdentity': True|False,
    'Error': {
        'Code': 'string',
        'Reason': 'string'
    }
}

Response Structure

(dict) --
- Arn (string) --
  
  The ARN of the SageMaker Partner AI App that was described.
- Name (string) --
  
  The name of the SageMaker Partner AI App.
- Type (string) --
  
  The type of SageMaker Partner AI App. Must be one of the following: lakera-guard, comet, deepchecks-llm-evaluation, or fiddler.
- Status (string) --
  
  The status of the SageMaker Partner AI App.
- CreationTime (datetime) --
  
  The time that the SageMaker Partner AI App was created.
- LastModifiedTime (datetime) --
  
  The time that the SageMaker Partner AI App was last modified.
- ExecutionRoleArn (string) --
  
  The ARN of the IAM role associated with the SageMaker Partner AI App.
- KmsKeyId (string) --
  
  The Amazon Web Services KMS customer managed key used to encrypt the data at rest associated with SageMaker Partner AI Apps.
- BaseUrl (string) --
  
  The URL of the SageMaker Partner AI App that the Application SDK uses to support in-app calls for the user.
- 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) --
  
  The instance type and size of the cluster attached to the SageMaker Partner AI App.
- Version (string) --
  
  The version of 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) --
- AuthType (string) --
  
  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.
- Error (dict) --
  
  This is an error field object that contains the error code and the reason for an operation failure.
  - Code (string) --
    
    The error code for an invalid or failed operation.
  - Reason (string) --
    
    The failure reason for the operation.