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

ListManagedEndpoints

Lists managed endpoints based on a set of parameters. 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?createdAfter=createdAfter&createdBefore=createdBefore&maxResults=maxResults&nextToken=nextToken&states=states&types=types HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

createdAfter

The date and time after which the endpoints are created.

createdBefore

The date and time before which the endpoints are created.

maxResults

The maximum number of managed endpoints that can be listed.

nextToken

The token for the next set of managed endpoints to return.

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

Pattern: .*\S.*

states

The states of the managed endpoints.

Array Members: Maximum number of 10 items.

Valid Values: CREATING | ACTIVE | TERMINATING | TERMINATED | TERMINATED_WITH_ERRORS

types

The types of the managed endpoints.

Array Members: Maximum number of 10 items.

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

Pattern: .*\S.*

virtualClusterId

The ID of the 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

{
   "endpoints": [ 
      { 
         "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"
      }
   ],
   "nextToken": "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.

endpoints

The managed endpoints to be listed.

Type: Array of Endpoint objects

nextToken

The token for the next set of endpoints to return.

Type: String

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

Pattern: .*\S.*

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

ValidationException

There are invalid parameters in the client request.

HTTP Status Code: 400