DescribePartnerApp
Gets information about a SageMaker Partner AI App.
Request Syntax
{
"Arn": "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.
- Arn
-
The ARN of the SageMaker Partner AI App to describe.
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
Response Syntax
{
"ApplicationConfig": {
"AdminUsers": [ "string" ],
"Arguments": {
"string" : "string"
}
},
"Arn": "string",
"AuthType": "string",
"BaseUrl": "string",
"CreationTime": number,
"EnableIamSessionBasedIdentity": boolean,
"Error": {
"Code": "string",
"Reason": "string"
},
"ExecutionRoleArn": "string",
"KmsKeyId": "string",
"LastModifiedTime": number,
"MaintenanceConfig": {
"MaintenanceWindowStart": "string"
},
"Name": "string",
"Status": "string",
"Tier": "string",
"Type": "string",
"Version": "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.
- ApplicationConfig
-
Configuration settings for the SageMaker Partner AI App.
Type: PartnerAppConfig object
- Arn
-
The ARN of the SageMaker Partner AI App that was described.
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} - AuthType
-
The authorization type that users use to access the SageMaker Partner AI App.
Type: String
Valid Values:
IAM - BaseUrl
-
The URL of the SageMaker Partner AI App that the Application SDK uses to support in-app calls for the user.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
- CreationTime
-
The time that the SageMaker Partner AI App was created.
Type: Timestamp
- 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
- Error
-
This is an error field object that contains the error code and the reason for an operation failure.
Type: ErrorInfo object
- ExecutionRoleArn
-
The ARN of the IAM role associated with the SageMaker Partner AI App.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+ - KmsKeyId
-
The AWS KMS customer managed key used to encrypt the data at rest associated with SageMaker Partner AI Apps.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern:
[a-zA-Z0-9:/_-]* - LastModifiedTime
-
The time that the SageMaker Partner AI App was last modified.
Type: Timestamp
- MaintenanceConfig
-
Maintenance configuration settings for the SageMaker Partner AI App.
Type: PartnerAppMaintenanceConfig object
- Name
-
The name of the SageMaker Partner AI App.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[a-zA-Z0-9]+ - 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 AWS Support.
-
UpdateFailed: The partner AI app couldn't be updated but is available.
-
Deleted: The partner AI app is permanently deleted and not available.
Type: String
Valid Values:
Creating | Updating | Deleting | Available | Failed | UpdateFailed | Deleted -
- Tier
-
The instance type and size of the cluster attached to the SageMaker Partner AI App.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 64.
Pattern:
(?!\s*$).+ - Type
-
The type of SageMaker Partner AI App. Must be one of the following:
lakera-guard,comet,deepchecks-llm-evaluation, orfiddler.Type: String
Valid Values:
lakera-guard | comet | deepchecks-llm-evaluation | fiddler - Version
-
The version of the SageMaker Partner AI App.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 64.
Pattern:
(?!\s*$).+
Errors
For information about the errors that are common to all actions, see Common Errors.
- 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:
