:doc:`EMRContainers <../../emr-containers>` / Client / describe_managed_endpoint

*************************
describe_managed_endpoint
*************************



.. py:method:: EMRContainers.Client.describe_managed_endpoint(**kwargs)

  

  Displays detailed information about a managed endpoint. A managed endpoint is a gateway that connects Amazon EMR Studio to Amazon EMR on EKS so that Amazon EMR Studio can communicate with your virtual cluster.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/emr-containers-2020-10-01/DescribeManagedEndpoint>`_  


  **Request Syntax**
  ::

    response = client.describe_managed_endpoint(
        id='string',
        virtualClusterId='string'
    )
    
  :type id: string
  :param id: **[REQUIRED]** 

    This output displays ID of the managed endpoint.

    

  
  :type virtualClusterId: string
  :param virtualClusterId: **[REQUIRED]** 

    The ID of the endpoint's virtual cluster.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'endpoint': {
              'id': 'string',
              'name': 'string',
              'arn': 'string',
              'virtualClusterId': 'string',
              'type': 'string',
              'state': 'CREATING'|'ACTIVE'|'TERMINATING'|'TERMINATED'|'TERMINATED_WITH_ERRORS',
              'releaseLabel': 'string',
              'executionRoleArn': 'string',
              'certificateArn': 'string',
              'certificateAuthority': {
                  'certificateArn': 'string',
                  'certificateData': 'string'
              },
              'configurationOverrides': {
                  'applicationConfiguration': [
                      {
                          'classification': 'string',
                          'properties': {
                              'string': 'string'
                          },
                          'configurations': {'... recursive ...'}
                      },
                  ],
                  'monitoringConfiguration': {
                      'managedLogs': {
                          'allowAWSToRetainLogs': 'ENABLED'|'DISABLED',
                          'encryptionKeyArn': 'string'
                      },
                      'persistentAppUI': 'ENABLED'|'DISABLED',
                      'cloudWatchMonitoringConfiguration': {
                          'logGroupName': 'string',
                          'logStreamNamePrefix': 'string'
                      },
                      's3MonitoringConfiguration': {
                          'logUri': 'string'
                      },
                      'containerLogRotationConfiguration': {
                          'rotationSize': 'string',
                          'maxFilesToKeep': 123
                      }
                  }
              },
              'serverUrl': 'string',
              'createdAt': datetime(2015, 1, 1),
              'securityGroup': 'string',
              'subnetIds': [
                  'string',
              ],
              'stateDetails': 'string',
              'failureReason': 'INTERNAL_ERROR'|'USER_ERROR'|'VALIDATION_ERROR'|'CLUSTER_UNAVAILABLE',
              'tags': {
                  'string': 'string'
              }
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **endpoint** *(dict) --* 

        This output displays information about a managed endpoint.

        
        

        - **id** *(string) --* 

          The ID of the endpoint.

          
        

        - **name** *(string) --* 

          The name of the endpoint.

          
        

        - **arn** *(string) --* 

          The ARN of the endpoint.

          
        

        - **virtualClusterId** *(string) --* 

          The ID of the endpoint's virtual cluster.

          
        

        - **type** *(string) --* 

          The type of the endpoint.

          
        

        - **state** *(string) --* 

          The state of the endpoint.

          
        

        - **releaseLabel** *(string) --* 

          The EMR release version to be used for the endpoint.

          
        

        - **executionRoleArn** *(string) --* 

          The execution role ARN of the endpoint.

          
        

        - **certificateArn** *(string) --* 

          The certificate ARN of the endpoint. This field is under deprecation and will be removed in future.

          
        

        - **certificateAuthority** *(dict) --* 

          The certificate generated by emr control plane on customer behalf to secure the managed endpoint.

          
          

          - **certificateArn** *(string) --* 

            The ARN of the certificate generated for managed endpoint.

            
          

          - **certificateData** *(string) --* 

            The base64 encoded PEM certificate data generated for managed endpoint.

            
      
        

        - **configurationOverrides** *(dict) --* 

          The configuration settings that are used to override existing configurations for endpoints.

          
          

          - **applicationConfiguration** *(list) --* 

            The configurations for the application running by the job run.

            
            

            - *(dict) --* 

              A configuration specification to be used when provisioning virtual clusters, which can include configurations for applications and software bundled with Amazon EMR on EKS. A configuration consists of a classification, properties, and optional nested configurations. A classification refers to an application-specific configuration file. Properties are the settings you want to change in that file.

              
              

              - **classification** *(string) --* 

                The classification within a configuration.

                
              

              - **properties** *(dict) --* 

                A set of properties specified within a configuration classification.

                
                

                - *(string) --* 
                  

                  - *(string) --* 
            
          
              

              - **configurations** *(list) --* 

                A list of additional configurations to apply within a configuration object.

                
          
        
          

          - **monitoringConfiguration** *(dict) --* 

            The configurations for monitoring.

            
            

            - **managedLogs** *(dict) --* 

              The entity that controls configuration for managed logs.

              
              

              - **allowAWSToRetainLogs** *(string) --* 

                Determines whether Amazon Web Services can retain logs.

                
              

              - **encryptionKeyArn** *(string) --* 

                The Amazon resource name (ARN) of the encryption key for logs.

                
          
            

            - **persistentAppUI** *(string) --* 

              Monitoring configurations for the persistent application UI.

              
            

            - **cloudWatchMonitoringConfiguration** *(dict) --* 

              Monitoring configurations for CloudWatch.

              
              

              - **logGroupName** *(string) --* 

                The name of the log group for log publishing.

                
              

              - **logStreamNamePrefix** *(string) --* 

                The specified name prefix for log streams.

                
          
            

            - **s3MonitoringConfiguration** *(dict) --* 

              Amazon S3 configuration for monitoring log publishing.

              
              

              - **logUri** *(string) --* 

                Amazon S3 destination URI for log publishing.

                
          
            

            - **containerLogRotationConfiguration** *(dict) --* 

              Enable or disable container log rotation.

              
              

              - **rotationSize** *(string) --* 

                The file size at which to rotate logs. Minimum of 2KB, Maximum of 2GB.

                
              

              - **maxFilesToKeep** *(integer) --* 

                The number of files to keep in container after rotation.

                
          
        
      
        

        - **serverUrl** *(string) --* 

          The server URL of the endpoint.

          
        

        - **createdAt** *(datetime) --* 

          The date and time when the endpoint was created.

          
        

        - **securityGroup** *(string) --* 

          The security group configuration of the endpoint.

          
        

        - **subnetIds** *(list) --* 

          The subnet IDs of the endpoint.

          
          

          - *(string) --* 
      
        

        - **stateDetails** *(string) --* 

          Additional details of the endpoint state.

          
        

        - **failureReason** *(string) --* 

          The reasons why the endpoint has failed.

          
        

        - **tags** *(dict) --* 

          The tags of the endpoint.

          
          

          - *(string) --* 
            

            - *(string) --* 
      
    
    
  
  **Exceptions**
  
  *   :py:class:`EMRContainers.Client.exceptions.ValidationException`

  
  *   :py:class:`EMRContainers.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`EMRContainers.Client.exceptions.InternalServerException`

  