SageMaker / Client / update_partner_app

update_partner_app#

SageMaker.Client.update_partner_app(**kwargs)#

Updates all of the SageMaker Partner AI Apps in an account.

See also: AWS API Documentation

Request Syntax

response = client.update_partner_app(
    Arn='string',
    MaintenanceConfig={
        'MaintenanceWindowStart': 'string'
    },
    Tier='string',
    ApplicationConfig={
        'AdminUsers': [
            'string',
        ],
        'Arguments': {
            'string': 'string'
        }
    },
    EnableIamSessionBasedIdentity=True|False,
    ClientToken='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:

  • Arn (string) –

    [REQUIRED]

    The ARN of the SageMaker Partner AI App to update.

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

  • 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.

  • 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 that was updated.

Exceptions

  • SageMaker.Client.exceptions.ResourceNotFound

  • SageMaker.Client.exceptions.ConflictException