SageMaker / Client / describe_partner_app

describe_partner_app#

SageMaker.Client.describe_partner_app(**kwargs)#

Gets information about a SageMaker Partner AI App.

Request Syntax

response = client.describe_partner_app(
    Arn='string'
)

Parameters:

Arn (string) –

[REQUIRED]

The ARN of the SageMaker Partner AI App to describe.

Return type:

dict

Returns:

Response Syntax

{
    'Arn': 'string',
    'Name': 'string',
    'Type': 'lakera-guard'|'comet'|'deepchecks-llm-evaluation'|'fiddler',
    'Status': 'Creating'|'Updating'|'Deleting'|'Available'|'Failed'|'UpdateFailed'|'Deleted',
    'CreationTime': datetime(2015, 1, 1),
    'ExecutionRoleArn': 'string',
    'BaseUrl': 'string',
    'MaintenanceConfig': {
        'MaintenanceWindowStart': 'string'
    },
    'Tier': 'string',
    'Version': 'string',
    'ApplicationConfig': {
        'AdminUsers': [
            'string',
        ],
        'Arguments': {
            'string': 'string'
        }
    },
    'AuthType': 'IAM',
    'EnableIamSessionBasedIdentity': True|False,
    'Error': {
        'Code': 'string',
        'Reason': 'string'
    }
}

Response Structure

(dict) –
- Arn (string) –
  
  The ARN of the SageMaker Partner AI App that was described.
- Name (string) –
  
  The name of the SageMaker Partner AI App.
- Type (string) –
  
  The type of SageMaker Partner AI App. Must be one of the following: lakera-guard, comet, deepchecks-llm-evaluation, or fiddler.
- Status (string) –
  
  The status of the SageMaker Partner AI App.
- CreationTime (datetime) –
  
  The time that the SageMaker Partner AI App was created.
- ExecutionRoleArn (string) –
  
  The ARN of the IAM role associated with the SageMaker Partner AI App.
- BaseUrl (string) –
  
  The URL of the SageMaker Partner AI App that the Application SDK uses to support in-app calls for the user.
- MaintenanceConfig (dict) –
  
  Maintenance configuration settings for the SageMaker Partner AI App.
  - MaintenanceWindowStart (string) –
    
    The day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time that weekly maintenance updates are scheduled. This value must take the following format: 3-letter-day:24-h-hour:minute. For example: TUE:03:30.
- Tier (string) –
  
  The instance type and size of the cluster attached to the SageMaker Partner AI App.
- Version (string) –
  
  The version of the SageMaker Partner AI App.
- ApplicationConfig (dict) –
  
  Configuration settings for the SageMaker Partner AI App.
  - AdminUsers (list) –
    
    The list of users that are given admin access to the SageMaker Partner AI App.
    - (string) –
  - Arguments (dict) –
    
    This is a map of required inputs for a SageMaker Partner AI App. Based on the application type, the map is populated with a key and value pair that is specific to the user and application.
    - (string) –
      - (string) –
- AuthType (string) –
  
  The authorization type that users use to access the SageMaker Partner AI App.
- EnableIamSessionBasedIdentity (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 (dict) –
  
  This is an error field object that contains the error code and the reason for an operation failure.
  - Code (string) –
    
    The error code for an invalid or failed operation.
  - Reason (string) –
    
    The failure reason for the operation.

Exceptions

SageMaker.Client.exceptions.ResourceNotFound