/AWS1/CL_SGMDESCRPARTNERAPPRSP¶
DescribePartnerAppResponse
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_arn TYPE /AWS1/SGMPARTNERAPPARN /AWS1/SGMPARTNERAPPARN¶
The ARN of the SageMaker Partner AI App that was described.
iv_name TYPE /AWS1/SGMPARTNERAPPNAME /AWS1/SGMPARTNERAPPNAME¶
The name of the SageMaker Partner AI App.
iv_type TYPE /AWS1/SGMPARTNERAPPTYPE /AWS1/SGMPARTNERAPPTYPE¶
The type of SageMaker Partner AI App. Must be one of the following:
lakera-guard,comet,deepchecks-llm-evaluation, orfiddler.
iv_status TYPE /AWS1/SGMPARTNERAPPSTATUS /AWS1/SGMPARTNERAPPSTATUS¶
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.
iv_creationtime TYPE /AWS1/SGMTIMESTAMP /AWS1/SGMTIMESTAMP¶
The time that the SageMaker Partner AI App was created.
iv_lastmodifiedtime TYPE /AWS1/SGMTIMESTAMP /AWS1/SGMTIMESTAMP¶
The time that the SageMaker Partner AI App was last modified.
iv_executionrolearn TYPE /AWS1/SGMROLEARN /AWS1/SGMROLEARN¶
The ARN of the IAM role associated with the SageMaker Partner AI App.
iv_kmskeyid TYPE /AWS1/SGMKMSKEYID /AWS1/SGMKMSKEYID¶
The Amazon Web Services KMS customer managed key used to encrypt the data at rest associated with SageMaker Partner AI Apps.
iv_baseurl TYPE /AWS1/SGMSTRING2048 /AWS1/SGMSTRING2048¶
The URL of the SageMaker Partner AI App that the Application SDK uses to support in-app calls for the user.
io_maintenanceconfig TYPE REF TO /AWS1/CL_SGMPTRAPPMAINTENANC00 /AWS1/CL_SGMPTRAPPMAINTENANC00¶
Maintenance configuration settings for the SageMaker Partner AI App.
iv_tier TYPE /AWS1/SGMNONEMPTYSTRING64 /AWS1/SGMNONEMPTYSTRING64¶
The instance type and size of the cluster attached to the SageMaker Partner AI App.
iv_version TYPE /AWS1/SGMNONEMPTYSTRING64 /AWS1/SGMNONEMPTYSTRING64¶
The version of the SageMaker Partner AI App.
io_applicationconfig TYPE REF TO /AWS1/CL_SGMPARTNERAPPCONFIG /AWS1/CL_SGMPARTNERAPPCONFIG¶
Configuration settings for the SageMaker Partner AI App.
iv_authtype TYPE /AWS1/SGMPARTNERAPPAUTHTYPE /AWS1/SGMPARTNERAPPAUTHTYPE¶
The authorization type that users use to access the SageMaker Partner AI App.
iv_enableiamsessionbasedid TYPE /AWS1/SGMBOOLEAN /AWS1/SGMBOOLEAN¶
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.
io_error TYPE REF TO /AWS1/CL_SGMERRORINFO /AWS1/CL_SGMERRORINFO¶
This is an error field object that contains the error code and the reason for an operation failure.
iv_enableautominorvrsupgrade TYPE /AWS1/SGMBOOLEAN /AWS1/SGMBOOLEAN¶
Indicates whether the SageMaker Partner AI App is configured for automatic minor version upgrades during scheduled maintenance windows.
iv_currentversioneoldate TYPE /AWS1/SGMTIMESTAMP /AWS1/SGMTIMESTAMP¶
The end-of-life date for the current version of the SageMaker Partner AI App.
io_availableupgrade TYPE REF TO /AWS1/CL_SGMAVAILABLEUPGRADE /AWS1/CL_SGMAVAILABLEUPGRADE¶
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.
Queryable Attributes¶
Arn¶
The ARN of the SageMaker Partner AI App that was described.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ARN() |
Getter for ARN, with configurable default |
ASK_ARN() |
Getter for ARN w/ exceptions if field has no value |
HAS_ARN() |
Determine if ARN has a value |
Name¶
The name of the SageMaker Partner AI App.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_NAME() |
Getter for NAME, with configurable default |
ASK_NAME() |
Getter for NAME w/ exceptions if field has no value |
HAS_NAME() |
Determine if NAME has a value |
Type¶
The type of SageMaker Partner AI App. Must be one of the following:
lakera-guard,comet,deepchecks-llm-evaluation, orfiddler.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TYPE() |
Getter for TYPE, with configurable default |
ASK_TYPE() |
Getter for TYPE w/ exceptions if field has no value |
HAS_TYPE() |
Determine if TYPE has a value |
Status¶
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATUS() |
Getter for STATUS, with configurable default |
ASK_STATUS() |
Getter for STATUS w/ exceptions if field has no value |
HAS_STATUS() |
Determine if STATUS has a value |
CreationTime¶
The time that the SageMaker Partner AI App was created.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREATIONTIME() |
Getter for CREATIONTIME, with configurable default |
ASK_CREATIONTIME() |
Getter for CREATIONTIME w/ exceptions if field has no value |
HAS_CREATIONTIME() |
Determine if CREATIONTIME has a value |
LastModifiedTime¶
The time that the SageMaker Partner AI App was last modified.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LASTMODIFIEDTIME() |
Getter for LASTMODIFIEDTIME, with configurable default |
ASK_LASTMODIFIEDTIME() |
Getter for LASTMODIFIEDTIME w/ exceptions if field has no va |
HAS_LASTMODIFIEDTIME() |
Determine if LASTMODIFIEDTIME has a value |
ExecutionRoleArn¶
The ARN of the IAM role associated with the SageMaker Partner AI App.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_EXECUTIONROLEARN() |
Getter for EXECUTIONROLEARN, with configurable default |
ASK_EXECUTIONROLEARN() |
Getter for EXECUTIONROLEARN w/ exceptions if field has no va |
HAS_EXECUTIONROLEARN() |
Determine if EXECUTIONROLEARN has a value |
KmsKeyId¶
The Amazon Web Services KMS customer managed key used to encrypt the data at rest associated with SageMaker Partner AI Apps.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_KMSKEYID() |
Getter for KMSKEYID, with configurable default |
ASK_KMSKEYID() |
Getter for KMSKEYID w/ exceptions if field has no value |
HAS_KMSKEYID() |
Determine if KMSKEYID has a value |
BaseUrl¶
The URL of the SageMaker Partner AI App that the Application SDK uses to support in-app calls for the user.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_BASEURL() |
Getter for BASEURL, with configurable default |
ASK_BASEURL() |
Getter for BASEURL w/ exceptions if field has no value |
HAS_BASEURL() |
Determine if BASEURL has a value |
MaintenanceConfig¶
Maintenance configuration settings for the SageMaker Partner AI App.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_MAINTENANCECONFIG() |
Getter for MAINTENANCECONFIG |
Tier¶
The instance type and size of the cluster attached to the SageMaker Partner AI App.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TIER() |
Getter for TIER, with configurable default |
ASK_TIER() |
Getter for TIER w/ exceptions if field has no value |
HAS_TIER() |
Determine if TIER has a value |
Version¶
The version of the SageMaker Partner AI App.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_VERSION() |
Getter for VERSION, with configurable default |
ASK_VERSION() |
Getter for VERSION w/ exceptions if field has no value |
HAS_VERSION() |
Determine if VERSION has a value |
ApplicationConfig¶
Configuration settings for the SageMaker Partner AI App.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_APPLICATIONCONFIG() |
Getter for APPLICATIONCONFIG |
AuthType¶
The authorization type that users use to access the SageMaker Partner AI App.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_AUTHTYPE() |
Getter for AUTHTYPE, with configurable default |
ASK_AUTHTYPE() |
Getter for AUTHTYPE w/ exceptions if field has no value |
HAS_AUTHTYPE() |
Determine if AUTHTYPE has a value |
EnableIamSessionBasedIdentity¶
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ENABLEIAMSESSIONBASEDID() |
Getter for ENABLEIAMSESSIONBASEDID, with configurable defaul |
ASK_ENABLEIAMSESSIONBASEDID() |
Getter for ENABLEIAMSESSIONBASEDID w/ exceptions if field ha |
HAS_ENABLEIAMSESSIONBASEDID() |
Determine if ENABLEIAMSESSIONBASEDID has a value |
Error¶
This is an error field object that contains the error code and the reason for an operation failure.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ERROR() |
Getter for ERROR |
EnableAutoMinorVersionUpgrade¶
Indicates whether the SageMaker Partner AI App is configured for automatic minor version upgrades during scheduled maintenance windows.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ENBAUTOMINORVRSUPGRADE() |
Getter for ENABLEAUTOMINORVRSUPGRADE, with configurable defa |
ASK_ENBAUTOMINORVRSUPGRADE() |
Getter for ENABLEAUTOMINORVRSUPGRADE w/ exceptions if field |
HAS_ENBAUTOMINORVRSUPGRADE() |
Determine if ENABLEAUTOMINORVRSUPGRADE has a value |
CurrentVersionEolDate¶
The end-of-life date for the current version of the SageMaker Partner AI App.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CURRENTVERSIONEOLDATE() |
Getter for CURRENTVERSIONEOLDATE, with configurable default |
ASK_CURRENTVERSIONEOLDATE() |
Getter for CURRENTVERSIONEOLDATE w/ exceptions if field has |
HAS_CURRENTVERSIONEOLDATE() |
Determine if CURRENTVERSIONEOLDATE has a value |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_AVAILABLEUPGRADE() |
Getter for AVAILABLEUPGRADE |