Class: Aws::SageMaker::Types::CreatePartnerAppRequest

Inherits:

Struct

• Object
• Struct
• Aws::SageMaker::Types::CreatePartnerAppRequest

Defined in:

gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #application_config ⇒ Types::PartnerAppConfig

  Configuration settings for the SageMaker Partner AI App.

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

• #execution_role_arn ⇒ String

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

• #idc_config ⇒ Types::IdcConfigInput

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

• #kms_key_id ⇒ String

  SageMaker Partner AI Apps uses Amazon Web Services KMS to encrypt data at rest using an Amazon Web Services managed key by default.

• #maintenance_config ⇒ Types::PartnerAppMaintenanceConfig

  Maintenance configuration settings for the SageMaker Partner AI App.

• #name ⇒ String

  The name to give 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.

• #type ⇒ String

  The type of SageMaker Partner AI App to create.

Instance Attribute Details

#application_config ⇒ Types::PartnerAppConfig

Configuration settings for the SageMaker Partner AI App.

Returns:

• (Types::PartnerAppConfig)

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

class CreatePartnerAppRequest < Struct.new(
  :name,
  :type,
  :execution_role_arn,
  :kms_key_id,
  :maintenance_config,
  :tier,
  :application_config,
  :idc_config,
  :auth_type,
  :enable_iam_session_based_identity,
  :enable_auto_minor_version_upgrade,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#auth_type ⇒ String

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.

Returns:

• (String)

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

class CreatePartnerAppRequest < Struct.new(
  :name,
  :type,
  :execution_role_arn,
  :kms_key_id,
  :maintenance_config,
  :tier,
  :application_config,
  :idc_config,
  :auth_type,
  :enable_iam_session_based_identity,
  :enable_auto_minor_version_upgrade,
  :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 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 13874

class CreatePartnerAppRequest < Struct.new(
  :name,
  :type,
  :execution_role_arn,
  :kms_key_id,
  :maintenance_config,
  :tier,
  :application_config,
  :idc_config,
  :auth_type,
  :enable_iam_session_based_identity,
  :enable_auto_minor_version_upgrade,
  :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. Default is FALSE.

Returns:

• (Boolean)

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

class CreatePartnerAppRequest < Struct.new(
  :name,
  :type,
  :execution_role_arn,
  :kms_key_id,
  :maintenance_config,
  :tier,
  :application_config,
  :idc_config,
  :auth_type,
  :enable_iam_session_based_identity,
  :enable_auto_minor_version_upgrade,
  :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 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 13874

class CreatePartnerAppRequest < Struct.new(
  :name,
  :type,
  :execution_role_arn,
  :kms_key_id,
  :maintenance_config,
  :tier,
  :application_config,
  :idc_config,
  :auth_type,
  :enable_iam_session_based_identity,
  :enable_auto_minor_version_upgrade,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#execution_role_arn ⇒ String

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

Returns:

• (String)

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

class CreatePartnerAppRequest < Struct.new(
  :name,
  :type,
  :execution_role_arn,
  :kms_key_id,
  :maintenance_config,
  :tier,
  :application_config,
  :idc_config,
  :auth_type,
  :enable_iam_session_based_identity,
  :enable_auto_minor_version_upgrade,
  :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 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 13874

class CreatePartnerAppRequest < Struct.new(
  :name,
  :type,
  :execution_role_arn,
  :kms_key_id,
  :maintenance_config,
  :tier,
  :application_config,
  :idc_config,
  :auth_type,
  :enable_iam_session_based_identity,
  :enable_auto_minor_version_upgrade,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_id ⇒ String

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.

Returns:

• (String)

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

class CreatePartnerAppRequest < Struct.new(
  :name,
  :type,
  :execution_role_arn,
  :kms_key_id,
  :maintenance_config,
  :tier,
  :application_config,
  :idc_config,
  :auth_type,
  :enable_iam_session_based_identity,
  :enable_auto_minor_version_upgrade,
  :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 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 13874

class CreatePartnerAppRequest < Struct.new(
  :name,
  :type,
  :execution_role_arn,
  :kms_key_id,
  :maintenance_config,
  :tier,
  :application_config,
  :idc_config,
  :auth_type,
  :enable_iam_session_based_identity,
  :enable_auto_minor_version_upgrade,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name to give the SageMaker Partner AI App.

Returns:

• (String)

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

class CreatePartnerAppRequest < Struct.new(
  :name,
  :type,
  :execution_role_arn,
  :kms_key_id,
  :maintenance_config,
  :tier,
  :application_config,
  :idc_config,
  :auth_type,
  :enable_iam_session_based_identity,
  :enable_auto_minor_version_upgrade,
  :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 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 13874

class CreatePartnerAppRequest < Struct.new(
  :name,
  :type,
  :execution_role_arn,
  :kms_key_id,
  :maintenance_config,
  :tier,
  :application_config,
  :idc_config,
  :auth_type,
  :enable_iam_session_based_identity,
  :enable_auto_minor_version_upgrade,
  :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 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 13874

class CreatePartnerAppRequest < Struct.new(
  :name,
  :type,
  :execution_role_arn,
  :kms_key_id,
  :maintenance_config,
  :tier,
  :application_config,
  :idc_config,
  :auth_type,
  :enable_iam_session_based_identity,
  :enable_auto_minor_version_upgrade,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

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

Returns:

• (String)

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

class CreatePartnerAppRequest < Struct.new(
  :name,
  :type,
  :execution_role_arn,
  :kms_key_id,
  :maintenance_config,
  :tier,
  :application_config,
  :idc_config,
  :auth_type,
  :enable_iam_session_based_identity,
  :enable_auto_minor_version_upgrade,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end