Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

DescribeManagedEndpoint

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.

Request Syntax


GET /virtualclusters/virtualClusterId/endpoints/endpointId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

endpointId

This output displays ID of the managed endpoint.

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [0-9a-z]+

Required: Yes

virtualClusterId

The ID of the endpoint's virtual cluster.

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [0-9a-z]+

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "endpoint": { 
      "arn": "string",
      "certificateArn": "string",
      "certificateAuthority": { 
         "certificateArn": "string",
         "certificateData": "string"
      },
      "configurationOverrides": { 
         "applicationConfiguration": [ 
            { 
               "classification": "string",
               "configurations": [ 
                  "Configuration"
               ],
               "properties": { 
                  "string" : "string" 
               }
            }
         ],
         "monitoringConfiguration": { 
            "cloudWatchMonitoringConfiguration": { 
               "logGroupName": "string",
               "logStreamNamePrefix": "string"
            },
            "containerLogRotationConfiguration": { 
               "maxFilesToKeep": number,
               "rotationSize": "string"
            },
            "persistentAppUI": "string",
            "s3MonitoringConfiguration": { 
               "logUri": "string"
            }
         }
      },
      "createdAt": "string",
      "executionRoleArn": "string",
      "failureReason": "string",
      "id": "string",
      "name": "string",
      "releaseLabel": "string",
      "securityGroup": "string",
      "serverUrl": "string",
      "state": "string",
      "stateDetails": "string",
      "subnetIds": [ "string" ],
      "tags": { 
         "string" : "string" 
      },
      "type": "string",
      "virtualClusterId": "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.

endpoint

This output displays information about a managed endpoint.

Type: Endpoint object

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerException

This is an internal server exception.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 400

ValidationException

There are invalid parameters in the client request.

HTTP Status Code: 400