UpdatePartnerApp - Amazon SageMaker

UpdatePartnerApp

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

Request Syntax

{ "ApplicationConfig": { "AdminUsers": [ "string" ], "Arguments": { "string" : "string" } }, "Arn": "string", "ClientToken": "string", "EnableIamSessionBasedIdentity": boolean, "MaintenanceConfig": { "MaintenanceWindowStart": "string" }, "Tags": [ { "Key": "string", "Value": "string" } ], "Tier": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ApplicationConfig

Configuration settings for the SageMaker Partner AI App.

Type: PartnerAppConfig object

Required: No

Arn

The ARN of the SageMaker Partner AI App to update.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:partner-app\/app-[A-Z0-9]{12}$

Required: Yes

ClientToken

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 36.

Pattern: ^[a-zA-Z0-9-]+$

Required: No

EnableIamSessionBasedIdentity

When set to TRUE, the SageMaker Partner AI App sets the AWS IAM session name or the authenticated IAM user as the identity of the SageMaker Partner AI App user.

Type: Boolean

Required: No

MaintenanceConfig

Maintenance configuration settings for the SageMaker Partner AI App.

Type: PartnerAppMaintenanceConfig object

Required: No

Tags

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

Type: Array of Tag objects

Array Members: Minimum number of 0 items. Maximum number of 50 items.

Required: No

Tier

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

Type: String

Length Constraints: Maximum length of 64.

Pattern: ^(?!\s*$).+

Required: No

Response Syntax

{ "Arn": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Arn

The ARN of the SageMaker Partner AI App that was updated.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:partner-app\/app-[A-Z0-9]{12}$

Errors

For information about the errors that are common to all actions, see Common Errors.

ConflictException

There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.

HTTP Status Code: 400

ResourceNotFound

Resource being access is not found.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: