Class: Aws::SageMaker::Types::UpdatePartnerAppRequest

Inherits:

Struct

• Object
• Struct
• Aws::SageMaker::Types::UpdatePartnerAppRequest

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-sagemaker/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #app_version ⇒ String

  The semantic version to upgrade the SageMaker Partner AI App to.

• #application_config ⇒ Types::PartnerAppConfig

  Configuration settings for the SageMaker Partner AI App.

• #arn ⇒ String

  The ARN of the SageMaker Partner AI App to update.

• #auth_type ⇒ String

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

• #client_token ⇒ String

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

• #enable_auto_minor_version_upgrade ⇒ 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 ⇒ 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 ⇒ Types::IdcConfigInput

  Specifies the Amazon Web Services IAM Identity Center configuration for the SageMaker Partner AI App.

• #maintenance_config ⇒ Types::PartnerAppMaintenanceConfig

  Maintenance configuration settings for the SageMaker Partner AI App.

• #tags ⇒ Array<Types::Tag>

  Each tag consists of a key and an optional value.

• #tier ⇒ String

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

Instance Attribute Details

#app_version ⇒ String

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.

Returns:

• (String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 58367

class UpdatePartnerAppRequest < Struct.new(
  :arn,
  :maintenance_config,
  :tier,
  :application_config,
  :idc_config,
  :auth_type,
  :enable_iam_session_based_identity,
  :enable_auto_minor_version_upgrade,
  :app_version,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#application_config ⇒ Types::PartnerAppConfig

Configuration settings for the SageMaker Partner AI App.

Returns:

• (Types::PartnerAppConfig)

# File 'lib/aws-sdk-sagemaker/types.rb', line 58367

class UpdatePartnerAppRequest < Struct.new(
  :arn,
  :maintenance_config,
  :tier,
  :application_config,
  :idc_config,
  :auth_type,
  :enable_iam_session_based_identity,
  :enable_auto_minor_version_upgrade,
  :app_version,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#arn ⇒ String

The ARN of the SageMaker Partner AI App to update.

Returns:

• (String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 58367

class UpdatePartnerAppRequest < Struct.new(
  :arn,
  :maintenance_config,
  :tier,
  :application_config,
  :idc_config,
  :auth_type,
  :enable_iam_session_based_identity,
  :enable_auto_minor_version_upgrade,
  :app_version,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#auth_type ⇒ String

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.

Returns:

• (String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 58367

class UpdatePartnerAppRequest < Struct.new(
  :arn,
  :maintenance_config,
  :tier,
  :application_config,
  :idc_config,
  :auth_type,
  :enable_iam_session_based_identity,
  :enable_auto_minor_version_upgrade,
  :app_version,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#client_token ⇒ String

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

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

• (String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 58367

class UpdatePartnerAppRequest < Struct.new(
  :arn,
  :maintenance_config,
  :tier,
  :application_config,
  :idc_config,
  :auth_type,
  :enable_iam_session_based_identity,
  :enable_auto_minor_version_upgrade,
  :app_version,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#enable_auto_minor_version_upgrade ⇒ 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.

Returns:

• (Boolean)

# File 'lib/aws-sdk-sagemaker/types.rb', line 58367

class UpdatePartnerAppRequest < Struct.new(
  :arn,
  :maintenance_config,
  :tier,
  :application_config,
  :idc_config,
  :auth_type,
  :enable_iam_session_based_identity,
  :enable_auto_minor_version_upgrade,
  :app_version,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#enable_iam_session_based_identity ⇒ 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.

Returns:

• (Boolean)

# File 'lib/aws-sdk-sagemaker/types.rb', line 58367

class UpdatePartnerAppRequest < Struct.new(
  :arn,
  :maintenance_config,
  :tier,
  :application_config,
  :idc_config,
  :auth_type,
  :enable_iam_session_based_identity,
  :enable_auto_minor_version_upgrade,
  :app_version,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#idc_config ⇒ Types::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.

Returns:

• (Types::IdcConfigInput)

# File 'lib/aws-sdk-sagemaker/types.rb', line 58367

class UpdatePartnerAppRequest < Struct.new(
  :arn,
  :maintenance_config,
  :tier,
  :application_config,
  :idc_config,
  :auth_type,
  :enable_iam_session_based_identity,
  :enable_auto_minor_version_upgrade,
  :app_version,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#maintenance_config ⇒ Types::PartnerAppMaintenanceConfig

Maintenance configuration settings for the SageMaker Partner AI App.

Returns:

• (Types::PartnerAppMaintenanceConfig)

# File 'lib/aws-sdk-sagemaker/types.rb', line 58367

class UpdatePartnerAppRequest < Struct.new(
  :arn,
  :maintenance_config,
  :tier,
  :application_config,
  :idc_config,
  :auth_type,
  :enable_iam_session_based_identity,
  :enable_auto_minor_version_upgrade,
  :app_version,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

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

Returns:

• (Array<Types::Tag>)

# File 'lib/aws-sdk-sagemaker/types.rb', line 58367

class UpdatePartnerAppRequest < Struct.new(
  :arn,
  :maintenance_config,
  :tier,
  :application_config,
  :idc_config,
  :auth_type,
  :enable_iam_session_based_identity,
  :enable_auto_minor_version_upgrade,
  :app_version,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tier ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 58367

class UpdatePartnerAppRequest < Struct.new(
  :arn,
  :maintenance_config,
  :tier,
  :application_config,
  :idc_config,
  :auth_type,
  :enable_iam_session_based_identity,
  :enable_auto_minor_version_upgrade,
  :app_version,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end