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

CreateManagedEndpoint

Creates 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


POST /virtualclusters/virtualClusterId/endpoints HTTP/1.1
Content-type: application/json

{
   "certificateArn": "string",
   "clientToken": "string",
   "configurationOverrides": { 
      "applicationConfiguration": [ 
         { 
            "classification": "string",
            "configurations": [ 
               "Configuration"
            ],
            "properties": { 
               "string" : "string" 
            }
         }
      ],
      "monitoringConfiguration": { 
         "cloudWatchMonitoringConfiguration": { 
            "logGroupName": "string",
            "logStreamNamePrefix": "string"
         },
         "containerLogRotationConfiguration": { 
            "maxFilesToKeep": number,
            "rotationSize": "string"
         },
         "managedLogs": { 
            "allowAWSToRetainLogs": "string",
            "encryptionKeyArn": "string"
         },
         "persistentAppUI": "string",
         "s3MonitoringConfiguration": { 
            "logUri": "string"
         }
      }
   },
   "executionRoleArn": "string",
   "name": "string",
   "releaseLabel": "string",
   "tags": { 
      "string" : "string" 
   },
   "type": "string"
}

URI Request Parameters

The request uses the following URI parameters.

virtualClusterId

The ID of the virtual cluster for which a managed endpoint is created.

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

Pattern: [0-9a-z]+

Required: Yes

Request Body

The request accepts the following data in JSON format.

certificateArn

This parameter has been deprecated.

The certificate ARN provided by users for the managed endpoint. This field is under deprecation and will be removed in future releases.

Type: String

Length Constraints: Minimum length of 44. Maximum length of 2048.

Pattern: ^arn:(aws[a-zA-Z0-9-]*):acm:.+:(\d{12}):certificate/.+$

Required: No

clientToken

The client idempotency token for this create call.

Type: String

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

Pattern: .*\S.*

Required: Yes

configurationOverrides

The configuration settings that will be used to override existing configurations.

Type: ConfigurationOverrides object

Required: No

executionRoleArn

The ARN of the execution role.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:(aws[a-zA-Z0-9-]*):iam::(\d{12})?:(role((\u002F)|(\u002F[\u0021-\u007F]+\u002F))[\w+=,.@-]+)$

Required: Yes

name

The name of the managed endpoint.

Type: String

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

Pattern: [\.\-_/#A-Za-z0-9]+

Required: Yes

releaseLabel

The Amazon EMR release version.

Type: String

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

Pattern: [\.\-_/A-Za-z0-9]+

Required: Yes

tags

The tags of the managed endpoint.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: .*\S.*

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Value Pattern: .*\S.*

Required: No

type

The type of the managed endpoint.

Type: String

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

Pattern: .*\S.*

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "arn": "string",
   "id": "string",
   "name": "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.

arn

The output contains the ARN of the managed endpoint.

Type: String

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

Pattern: ^arn:(aws[a-zA-Z0-9-]*):emr-containers:.+:(\d{12}):\/virtualclusters\/[0-9a-zA-Z]+\/endpoints\/[0-9a-zA-Z]+$

id

The output contains the ID of the managed endpoint.

Type: String

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

Pattern: [0-9a-z]+

name

The output contains the name of the managed endpoint.

Type: String

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

Pattern: [\.\-_/#A-Za-z0-9]+

virtualClusterId

The output contains the ID of the virtual cluster.

Type: String

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

Pattern: [0-9a-z]+

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