Class: Aws::SageMaker::Types::DescribePartnerAppResponse

Inherits:

Struct

Object
Struct
Aws::SageMaker::Types::DescribePartnerAppResponse

show all

Defined in:: gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb

Overview

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#application_config ⇒ Types::PartnerAppConfig
Configuration settings for the SageMaker Partner AI App.
#arn ⇒ String
The ARN of the SageMaker Partner AI App that was described.
#auth_type ⇒ String
The authorization type that users use to access the SageMaker Partner AI App.
#available_upgrade ⇒ Types::AvailableUpgrade
A map of available minor version upgrades for the SageMaker Partner AI App.
#base_url ⇒ String
The URL of the SageMaker Partner AI App that the Application SDK uses to support in-app calls for the user.
#creation_time ⇒ Time
The time that the SageMaker Partner AI App was created.
#current_version_eol_date ⇒ Time
The end-of-life date for the current version of the SageMaker Partner AI App.
#enable_auto_minor_version_upgrade ⇒ Boolean
Indicates whether the SageMaker Partner AI App is configured for automatic minor version upgrades during scheduled maintenance windows.
#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.
#error ⇒ Types::ErrorInfo
This is an error field object that contains the error code and the reason for an operation failure.
#execution_role_arn ⇒ String
The ARN of the IAM role associated with the SageMaker Partner AI App.
#idc_config ⇒ Types::IdcConfigOutput
Contains the Amazon Web Services IAM Identity Center configuration for the SageMaker Partner AI App, including the Identity Center instance and the Identity Center application that SageMaker creates for the app.
#kms_key_id ⇒ String
The Amazon Web Services KMS customer managed key used to encrypt the data at rest associated with SageMaker Partner AI Apps.
#last_modified_time ⇒ Time
The time that the SageMaker Partner AI App was last modified.
#maintenance_config ⇒ Types::PartnerAppMaintenanceConfig
Maintenance configuration settings for the SageMaker Partner AI App.
#name ⇒ String
The name of the SageMaker Partner AI App.
#status ⇒ String
The status of the SageMaker Partner AI App.
#tier ⇒ String
The instance type and size of the cluster attached to the SageMaker Partner AI App.
#type ⇒ String
The type of SageMaker Partner AI App.
#version ⇒ String
The version of the SageMaker Partner AI App.

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 23107

class DescribePartnerAppResponse < Struct.new(
  :arn,
  :name,
  :type,
  :status,
  :creation_time,
  :last_modified_time,
  :execution_role_arn,
  :kms_key_id,
  :base_url,
  :maintenance_config,
  :tier,
  :version,
  :application_config,
  :auth_type,
  :enable_iam_session_based_identity,
  :error,
  :enable_auto_minor_version_upgrade,
  :current_version_eol_date,
  :available_upgrade,
  :idc_config)
  SENSITIVE = []
  include Aws::Structure
end

#arn ⇒ `String`

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

Returns:

(String)

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

class DescribePartnerAppResponse < Struct.new(
  :arn,
  :name,
  :type,
  :status,
  :creation_time,
  :last_modified_time,
  :execution_role_arn,
  :kms_key_id,
  :base_url,
  :maintenance_config,
  :tier,
  :version,
  :application_config,
  :auth_type,
  :enable_iam_session_based_identity,
  :error,
  :enable_auto_minor_version_upgrade,
  :current_version_eol_date,
  :available_upgrade,
  :idc_config)
  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.

Returns:

(String)

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

class DescribePartnerAppResponse < Struct.new(
  :arn,
  :name,
  :type,
  :status,
  :creation_time,
  :last_modified_time,
  :execution_role_arn,
  :kms_key_id,
  :base_url,
  :maintenance_config,
  :tier,
  :version,
  :application_config,
  :auth_type,
  :enable_iam_session_based_identity,
  :error,
  :enable_auto_minor_version_upgrade,
  :current_version_eol_date,
  :available_upgrade,
  :idc_config)
  SENSITIVE = []
  include Aws::Structure
end

#available_upgrade ⇒ `Types::AvailableUpgrade`

A map of available minor version upgrades for the SageMaker Partner AI App. The key is the semantic version number, and the value is a list of release notes for that version. A null value indicates no upgrades are available.

Returns:

(Types::AvailableUpgrade)

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

class DescribePartnerAppResponse < Struct.new(
  :arn,
  :name,
  :type,
  :status,
  :creation_time,
  :last_modified_time,
  :execution_role_arn,
  :kms_key_id,
  :base_url,
  :maintenance_config,
  :tier,
  :version,
  :application_config,
  :auth_type,
  :enable_iam_session_based_identity,
  :error,
  :enable_auto_minor_version_upgrade,
  :current_version_eol_date,
  :available_upgrade,
  :idc_config)
  SENSITIVE = []
  include Aws::Structure
end

#base_url ⇒ `String`

The URL of the SageMaker Partner AI App that the Application SDK uses to support in-app calls for the user.

Returns:

(String)

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

class DescribePartnerAppResponse < Struct.new(
  :arn,
  :name,
  :type,
  :status,
  :creation_time,
  :last_modified_time,
  :execution_role_arn,
  :kms_key_id,
  :base_url,
  :maintenance_config,
  :tier,
  :version,
  :application_config,
  :auth_type,
  :enable_iam_session_based_identity,
  :error,
  :enable_auto_minor_version_upgrade,
  :current_version_eol_date,
  :available_upgrade,
  :idc_config)
  SENSITIVE = []
  include Aws::Structure
end

#creation_time ⇒ `Time`

The time that the SageMaker Partner AI App was created.

Returns:

(Time)

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

class DescribePartnerAppResponse < Struct.new(
  :arn,
  :name,
  :type,
  :status,
  :creation_time,
  :last_modified_time,
  :execution_role_arn,
  :kms_key_id,
  :base_url,
  :maintenance_config,
  :tier,
  :version,
  :application_config,
  :auth_type,
  :enable_iam_session_based_identity,
  :error,
  :enable_auto_minor_version_upgrade,
  :current_version_eol_date,
  :available_upgrade,
  :idc_config)
  SENSITIVE = []
  include Aws::Structure
end

#current_version_eol_date ⇒ `Time`

The end-of-life date for the current version of the SageMaker Partner AI App.

Returns:

(Time)

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

class DescribePartnerAppResponse < Struct.new(
  :arn,
  :name,
  :type,
  :status,
  :creation_time,
  :last_modified_time,
  :execution_role_arn,
  :kms_key_id,
  :base_url,
  :maintenance_config,
  :tier,
  :version,
  :application_config,
  :auth_type,
  :enable_iam_session_based_identity,
  :error,
  :enable_auto_minor_version_upgrade,
  :current_version_eol_date,
  :available_upgrade,
  :idc_config)
  SENSITIVE = []
  include Aws::Structure
end

#enable_auto_minor_version_upgrade ⇒ `Boolean`

Indicates whether the SageMaker Partner AI App is configured for automatic minor version upgrades during scheduled maintenance windows.

Returns:

(Boolean)

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

class DescribePartnerAppResponse < Struct.new(
  :arn,
  :name,
  :type,
  :status,
  :creation_time,
  :last_modified_time,
  :execution_role_arn,
  :kms_key_id,
  :base_url,
  :maintenance_config,
  :tier,
  :version,
  :application_config,
  :auth_type,
  :enable_iam_session_based_identity,
  :error,
  :enable_auto_minor_version_upgrade,
  :current_version_eol_date,
  :available_upgrade,
  :idc_config)
  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 23107

class DescribePartnerAppResponse < Struct.new(
  :arn,
  :name,
  :type,
  :status,
  :creation_time,
  :last_modified_time,
  :execution_role_arn,
  :kms_key_id,
  :base_url,
  :maintenance_config,
  :tier,
  :version,
  :application_config,
  :auth_type,
  :enable_iam_session_based_identity,
  :error,
  :enable_auto_minor_version_upgrade,
  :current_version_eol_date,
  :available_upgrade,
  :idc_config)
  SENSITIVE = []
  include Aws::Structure
end

#error ⇒ `Types::ErrorInfo`

This is an error field object that contains the error code and the reason for an operation failure.

Returns:

(Types::ErrorInfo)

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

class DescribePartnerAppResponse < Struct.new(
  :arn,
  :name,
  :type,
  :status,
  :creation_time,
  :last_modified_time,
  :execution_role_arn,
  :kms_key_id,
  :base_url,
  :maintenance_config,
  :tier,
  :version,
  :application_config,
  :auth_type,
  :enable_iam_session_based_identity,
  :error,
  :enable_auto_minor_version_upgrade,
  :current_version_eol_date,
  :available_upgrade,
  :idc_config)
  SENSITIVE = []
  include Aws::Structure
end

#execution_role_arn ⇒ `String`

The ARN of the IAM role associated with the SageMaker Partner AI App.

Returns:

(String)

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

class DescribePartnerAppResponse < Struct.new(
  :arn,
  :name,
  :type,
  :status,
  :creation_time,
  :last_modified_time,
  :execution_role_arn,
  :kms_key_id,
  :base_url,
  :maintenance_config,
  :tier,
  :version,
  :application_config,
  :auth_type,
  :enable_iam_session_based_identity,
  :error,
  :enable_auto_minor_version_upgrade,
  :current_version_eol_date,
  :available_upgrade,
  :idc_config)
  SENSITIVE = []
  include Aws::Structure
end

#idc_config ⇒ `Types::IdcConfigOutput`

Contains the Amazon Web Services IAM Identity Center configuration for the SageMaker Partner AI App, including the Identity Center instance and the Identity Center application that SageMaker creates for the app. The service returns this field for apps that use IDC authorization.

Returns:

(Types::IdcConfigOutput)

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

class DescribePartnerAppResponse < Struct.new(
  :arn,
  :name,
  :type,
  :status,
  :creation_time,
  :last_modified_time,
  :execution_role_arn,
  :kms_key_id,
  :base_url,
  :maintenance_config,
  :tier,
  :version,
  :application_config,
  :auth_type,
  :enable_iam_session_based_identity,
  :error,
  :enable_auto_minor_version_upgrade,
  :current_version_eol_date,
  :available_upgrade,
  :idc_config)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_id ⇒ `String`

The Amazon Web Services KMS customer managed key used to encrypt the data at rest associated with SageMaker Partner AI Apps.

Returns:

(String)

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

class DescribePartnerAppResponse < Struct.new(
  :arn,
  :name,
  :type,
  :status,
  :creation_time,
  :last_modified_time,
  :execution_role_arn,
  :kms_key_id,
  :base_url,
  :maintenance_config,
  :tier,
  :version,
  :application_config,
  :auth_type,
  :enable_iam_session_based_identity,
  :error,
  :enable_auto_minor_version_upgrade,
  :current_version_eol_date,
  :available_upgrade,
  :idc_config)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_time ⇒ `Time`

The time that the SageMaker Partner AI App was last modified.

Returns:

(Time)

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

class DescribePartnerAppResponse < Struct.new(
  :arn,
  :name,
  :type,
  :status,
  :creation_time,
  :last_modified_time,
  :execution_role_arn,
  :kms_key_id,
  :base_url,
  :maintenance_config,
  :tier,
  :version,
  :application_config,
  :auth_type,
  :enable_iam_session_based_identity,
  :error,
  :enable_auto_minor_version_upgrade,
  :current_version_eol_date,
  :available_upgrade,
  :idc_config)
  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 23107

class DescribePartnerAppResponse < Struct.new(
  :arn,
  :name,
  :type,
  :status,
  :creation_time,
  :last_modified_time,
  :execution_role_arn,
  :kms_key_id,
  :base_url,
  :maintenance_config,
  :tier,
  :version,
  :application_config,
  :auth_type,
  :enable_iam_session_based_identity,
  :error,
  :enable_auto_minor_version_upgrade,
  :current_version_eol_date,
  :available_upgrade,
  :idc_config)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ `String`

The name of the SageMaker Partner AI App.

Returns:

(String)

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

class DescribePartnerAppResponse < Struct.new(
  :arn,
  :name,
  :type,
  :status,
  :creation_time,
  :last_modified_time,
  :execution_role_arn,
  :kms_key_id,
  :base_url,
  :maintenance_config,
  :tier,
  :version,
  :application_config,
  :auth_type,
  :enable_iam_session_based_identity,
  :error,
  :enable_auto_minor_version_upgrade,
  :current_version_eol_date,
  :available_upgrade,
  :idc_config)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ `String`

The status of the SageMaker Partner AI App.

Creating: SageMaker AI is creating the partner AI app. The partner AI app is not available during creation.
Updating: SageMaker AI is updating the partner AI app. The partner AI app is not available when updating.
Deleting: SageMaker AI is deleting the partner AI app. The partner AI app is not available during deletion.
Available: The partner AI app is provisioned and accessible.
Failed: The partner AI app is in a failed state and isn't available. SageMaker AI is investigating the issue. For further guidance, contact Amazon Web Services Support.
UpdateFailed: The partner AI app couldn't be updated but is available.
Deleted: The partner AI app is permanently deleted and not available.

Returns:

(String)

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

class DescribePartnerAppResponse < Struct.new(
  :arn,
  :name,
  :type,
  :status,
  :creation_time,
  :last_modified_time,
  :execution_role_arn,
  :kms_key_id,
  :base_url,
  :maintenance_config,
  :tier,
  :version,
  :application_config,
  :auth_type,
  :enable_iam_session_based_identity,
  :error,
  :enable_auto_minor_version_upgrade,
  :current_version_eol_date,
  :available_upgrade,
  :idc_config)
  SENSITIVE = []
  include Aws::Structure
end

#tier ⇒ `String`

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 23107

class DescribePartnerAppResponse < Struct.new(
  :arn,
  :name,
  :type,
  :status,
  :creation_time,
  :last_modified_time,
  :execution_role_arn,
  :kms_key_id,
  :base_url,
  :maintenance_config,
  :tier,
  :version,
  :application_config,
  :auth_type,
  :enable_iam_session_based_identity,
  :error,
  :enable_auto_minor_version_upgrade,
  :current_version_eol_date,
  :available_upgrade,
  :idc_config)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ `String`

The type of SageMaker Partner AI App. 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 23107

class DescribePartnerAppResponse < Struct.new(
  :arn,
  :name,
  :type,
  :status,
  :creation_time,
  :last_modified_time,
  :execution_role_arn,
  :kms_key_id,
  :base_url,
  :maintenance_config,
  :tier,
  :version,
  :application_config,
  :auth_type,
  :enable_iam_session_based_identity,
  :error,
  :enable_auto_minor_version_upgrade,
  :current_version_eol_date,
  :available_upgrade,
  :idc_config)
  SENSITIVE = []
  include Aws::Structure
end

#version ⇒ `String`

The version of the SageMaker Partner AI App.

Returns:

(String)

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

class DescribePartnerAppResponse < Struct.new(
  :arn,
  :name,
  :type,
  :status,
  :creation_time,
  :last_modified_time,
  :execution_role_arn,
  :kms_key_id,
  :base_url,
  :maintenance_config,
  :tier,
  :version,
  :application_config,
  :auth_type,
  :enable_iam_session_based_identity,
  :error,
  :enable_auto_minor_version_upgrade,
  :current_version_eol_date,
  :available_upgrade,
  :idc_config)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::SageMaker::Types::DescribePartnerAppResponse

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#application_config ⇒ Types::PartnerAppConfig

#arn ⇒ String

#auth_type ⇒ String

#available_upgrade ⇒ Types::AvailableUpgrade

#base_url ⇒ String

#creation_time ⇒ Time

#current_version_eol_date ⇒ Time

#enable_auto_minor_version_upgrade ⇒ Boolean

#enable_iam_session_based_identity ⇒ Boolean

#error ⇒ Types::ErrorInfo

#execution_role_arn ⇒ String

#idc_config ⇒ Types::IdcConfigOutput

#kms_key_id ⇒ String

#last_modified_time ⇒ Time

#maintenance_config ⇒ Types::PartnerAppMaintenanceConfig

#name ⇒ String

#status ⇒ String

#tier ⇒ String

#type ⇒ String

#version ⇒ String

#application_config ⇒ `Types::PartnerAppConfig`

#arn ⇒ `String`

#auth_type ⇒ `String`

#available_upgrade ⇒ `Types::AvailableUpgrade`

#base_url ⇒ `String`

#creation_time ⇒ `Time`

#current_version_eol_date ⇒ `Time`

#enable_auto_minor_version_upgrade ⇒ `Boolean`

#enable_iam_session_based_identity ⇒ `Boolean`

#error ⇒ `Types::ErrorInfo`

#execution_role_arn ⇒ `String`

#idc_config ⇒ `Types::IdcConfigOutput`

#kms_key_id ⇒ `String`

#last_modified_time ⇒ `Time`

#maintenance_config ⇒ `Types::PartnerAppMaintenanceConfig`

#name ⇒ `String`

#status ⇒ `String`

#tier ⇒ `String`

#type ⇒ `String`

#version ⇒ `String`