:doc:`SageMaker <../../sagemaker>` / Client / describe_partner_app

********************
describe_partner_app
********************



.. py:method:: SageMaker.Client.describe_partner_app(**kwargs)

  

  Gets information about a SageMaker Partner AI App.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribePartnerApp>`_  


  **Request Syntax**
  ::

    response = client.describe_partner_app(
        Arn='string',
        IncludeAvailableUpgrade=True|False
    )
    
  :type Arn: string
  :param Arn: **[REQUIRED]** 

    The ARN of the SageMaker Partner AI App to describe.

    

  
  :type IncludeAvailableUpgrade: boolean
  :param IncludeAvailableUpgrade: 

    When set to ``TRUE``, the response includes available upgrade information for the SageMaker Partner AI App. Default is ``FALSE``.

    

  
  
  :rtype: 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),
          'LastModifiedTime': datetime(2015, 1, 1),
          'ExecutionRoleArn': 'string',
          'KmsKeyId': 'string',
          'BaseUrl': 'string',
          'MaintenanceConfig': {
              'MaintenanceWindowStart': 'string'
          },
          'Tier': 'string',
          'Version': 'string',
          'ApplicationConfig': {
              'AdminUsers': [
                  'string',
              ],
              'Arguments': {
                  'string': 'string'
              },
              'AssignedGroupPatterns': [
                  'string',
              ],
              'RoleGroupAssignments': [
                  {
                      'RoleName': 'string',
                      'GroupPatterns': [
                          'string',
                      ]
                  },
              ]
          },
          'AuthType': 'IAM',
          'EnableIamSessionBasedIdentity': True|False,
          'Error': {
              'Code': 'string',
              'Reason': 'string'
          },
          'EnableAutoMinorVersionUpgrade': True|False,
          'CurrentVersionEolDate': datetime(2015, 1, 1),
          'AvailableUpgrade': {
              'Version': 'string',
              'ReleaseNotes': [
                  '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.

         

        
        * 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.
        

        
      

      - **CreationTime** *(datetime) --* 

        The time that the SageMaker Partner AI App was created.

        
      

      - **LastModifiedTime** *(datetime) --* 

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

        
      

      - **ExecutionRoleArn** *(string) --* 

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

        
      

      - **KmsKeyId** *(string) --* 

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

        
      

      - **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) --* 
      
    
        

        - **AssignedGroupPatterns** *(list) --* 

          A list of Amazon Web Services IAM Identity Center group patterns that can access the SageMaker Partner AI App. Group names support wildcard matching using ``*``. An empty list indicates the app will not use Identity Center group features. All groups specified in ``RoleGroupAssignments`` must match patterns in this list.

          
          

          - *(string) --* 
      
        

        - **RoleGroupAssignments** *(list) --* 

          A map of in-app roles to Amazon Web Services IAM Identity Center group patterns. Groups assigned to specific roles receive those permissions, while groups in ``AssignedGroupPatterns`` but not in this map receive default in-app role depending on app type. Group patterns support wildcard matching using ``*``. Currently supported by Fiddler version 1.3 and later with roles: ``ORG_MEMBER`` (default) and ``ORG_ADMIN``.

          
          

          - *(dict) --* 

            Defines the mapping between an in-app role and the Amazon Web Services IAM Identity Center group patterns that should be assigned to that role within the SageMaker Partner AI App.

            
            

            - **RoleName** *(string) --* 

              The name of the in-app role within the SageMaker Partner AI App. The specific roles available depend on the app type and version.

              
            

            - **GroupPatterns** *(list) --* 

              A list of Amazon Web Services IAM Identity Center group patterns that should be assigned to the specified role. Group patterns support wildcard matching using ``*``.

              
              

              - *(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.

          
    
      

      - **EnableAutoMinorVersionUpgrade** *(boolean) --* 

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

        
      

      - **CurrentVersionEolDate** *(datetime) --* 

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

        
      

      - **AvailableUpgrade** *(dict) --* 

        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.

        
        

        - **Version** *(string) --* 

          The semantic version number of the available upgrade for the SageMaker Partner AI App.

          
        

        - **ReleaseNotes** *(list) --* 

          A list of release notes describing the changes and improvements included in the available upgrade version.

          
          

          - *(string) --* 
      
    
  
  **Exceptions**
  
  *   :py:class:`SageMaker.Client.exceptions.ResourceNotFound`

  