Skip to content

CreatePartnerAppRequest

Source code in docs_src/capo_sagemaker/types/create_partner_app_request.py
class CreatePartnerAppRequest(TypedDict, closed=True):
    name: NotRequired["capo_sagemaker.types.partner_app_name.PartnerAppName"]
    """<p>The name to give the SageMaker Partner AI App.</p>"""
    type: NotRequired["capo_sagemaker.types.partner_app_type.PartnerAppType"]
    """<p>The type of SageMaker Partner AI App to create. Must be one of the following: <code>lakera-guard</code>, <code>comet</code>, <code>deepchecks-llm-evaluation</code>, or <code>fiddler</code>.</p>"""
    execution_role_arn: NotRequired["capo_sagemaker.types.role_arn.RoleArn"]
    """<p>The ARN of the IAM role that the partner application uses.</p>"""
    kms_key_id: NotRequired["capo_sagemaker.types.kms_key_id.KmsKeyId"]
    """<p>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.</p>"""
    maintenance_config: NotRequired[
        "capo_sagemaker.types.partner_app_maintenance_config.PartnerAppMaintenanceConfig"
    ]
    """<p>Maintenance configuration settings for the SageMaker Partner AI App.</p>"""
    tier: NotRequired["capo_sagemaker.types.non_empty_string64.NonEmptyString64"]
    """<p>Indicates the instance type and size of the cluster attached to the SageMaker Partner AI App.</p>"""
    application_config: NotRequired[
        "capo_sagemaker.types.partner_app_config.PartnerAppConfig"
    ]
    """<p>Configuration settings for the SageMaker Partner AI App.</p>"""
    idc_config: NotRequired["capo_sagemaker.types.idc_config_input.IdcConfigInput"]
    """<p>Specifies the Amazon Web Services IAM Identity Center configuration for the SageMaker Partner AI App. Specify this parameter when <code>AuthType</code> is <code>IDC</code>. Apps that use <code>IAM</code> authorization don't use this parameter.</p>"""
    auth_type: NotRequired[
        "capo_sagemaker.types.partner_app_auth_type.PartnerAppAuthType"
    ]
    """<p>The authorization type that users use to access the SageMaker Partner AI App. Valid values:</p> <ul> <li> <p> <code>IAM</code>: Users access the SageMaker Partner AI App with their Amazon Web Services IAM identity.</p> </li> <li> <p> <code>IDC</code>: Users access the SageMaker Partner AI App with their Amazon Web Services IAM Identity Center identity. Specify the Identity Center instance to use in <code>IdcConfig</code>.</p> </li> </ul>"""
    enable_iam_session_based_identity: NotRequired[
        "capo_sagemaker.types.boolean.Boolean"
    ]
    """<p>When set to <code>TRUE</code>, 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.</p>"""
    enable_auto_minor_version_upgrade: NotRequired[
        "capo_sagemaker.types.boolean.Boolean"
    ]
    """<p>When set to <code>TRUE</code>, 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 <code>FALSE</code>.</p>"""
    client_token: NotRequired["capo_sagemaker.types.client_token.ClientToken"]
    """<p>A unique token that guarantees that the call to this API is idempotent.</p>"""
    tags: NotRequired["capo_sagemaker.types.tag_list.TagList"]
    """<p>Each tag consists of a key and an optional value. Tag keys must be unique per resource.</p>"""

application_config instance-attribute

application_config: NotRequired[PartnerAppConfig]

Configuration settings for the SageMaker Partner AI App.

auth_type instance-attribute

auth_type: NotRequired[PartnerAppAuthType]

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

  • IAM: Users access the SageMaker Partner AI App with their Amazon Web Services IAM identity.

  • IDC: Users access the SageMaker Partner AI App with their Amazon Web Services IAM Identity Center identity. Specify the Identity Center instance to use in IdcConfig.

client_token instance-attribute

client_token: NotRequired[ClientToken]

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

enable_auto_minor_version_upgrade instance-attribute

enable_auto_minor_version_upgrade: NotRequired[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.

enable_iam_session_based_identity instance-attribute

enable_iam_session_based_identity: NotRequired[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.

execution_role_arn instance-attribute

execution_role_arn: NotRequired[RoleArn]

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

idc_config instance-attribute

idc_config: NotRequired[IdcConfigInput]

Specifies the Amazon Web Services IAM Identity Center configuration for the SageMaker Partner AI App. Specify this parameter when AuthType is IDC. Apps that use IAM authorization don't use this parameter.

kms_key_id instance-attribute

kms_key_id: NotRequired[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.

maintenance_config instance-attribute

maintenance_config: NotRequired[PartnerAppMaintenanceConfig]

Maintenance configuration settings for the SageMaker Partner AI App.

name instance-attribute

name: NotRequired[PartnerAppName]

The name to give the SageMaker Partner AI App.

tags instance-attribute

tags: NotRequired[TagList]

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

tier instance-attribute

tier: NotRequired[NonEmptyString64]

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

type instance-attribute

type: NotRequired[PartnerAppType]

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