Skip to content

UpdatePartnerAppRequest

Source code in docs_src/capo_sagemaker/types/update_partner_app_request.py
class UpdatePartnerAppRequest(TypedDict, closed=True):
    arn: NotRequired["capo_sagemaker.types.partner_app_arn.PartnerAppArn"]
    """<p>The ARN of the SageMaker Partner AI App to update.</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. Use this parameter to migrate an existing SageMaker Partner AI App from <code>IAM</code> authorization to <code>IDC</code> authorization. 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.</p>"""
    app_version: NotRequired[
        "capo_sagemaker.types.major_minor_version.MajorMinorVersion"
    ]
    """<p>The semantic version to upgrade the SageMaker Partner AI App to. Must be the same semantic version returned in the <code>AvailableUpgrade</code> field from <code>DescribePartnerApp</code>. Version skipping and downgrades are not supported.</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>"""

app_version instance-attribute

app_version: NotRequired[MajorMinorVersion]

The semantic version to upgrade the SageMaker Partner AI App to. Must be the same semantic version returned in the AvailableUpgrade field from DescribePartnerApp. Version skipping and downgrades are not supported.

application_config instance-attribute

application_config: NotRequired[PartnerAppConfig]

Configuration settings for the SageMaker Partner AI App.

arn instance-attribute

arn: NotRequired[PartnerAppArn]

The ARN of the SageMaker Partner AI App to update.

auth_type instance-attribute

auth_type: NotRequired[PartnerAppAuthType]

The authorization type that users use to access the SageMaker Partner AI App. Use this parameter to migrate an existing SageMaker Partner AI App from IAM authorization to IDC authorization. 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.

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.

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.

maintenance_config instance-attribute

maintenance_config: NotRequired[PartnerAppMaintenanceConfig]

Maintenance configuration settings for 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.