Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . emr-containers ]

describe-managed-endpoint

Description

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

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-managed-endpoint
--id <value>
--virtual-cluster-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--id (string)

This output displays ID of the managed endpoint.

--virtual-cluster-id (string)

The ID of the endpoint's virtual cluster.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

endpoint -> (structure)

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 -> (structure)

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 -> (structure)

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

applicationConfiguration -> (list)

The configurations for the application running by the job run.

(structure)

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 -> (map)

A set of properties specified within a configuration classification.

key -> (string)

value -> (string)

configurations -> (list)

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

(structure)

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 -> (map)

A set of properties specified within a configuration classification.

key -> (string)

value -> (string)

monitoringConfiguration -> (structure)

The configurations for monitoring.

persistentAppUI -> (string)

Monitoring configurations for the persistent application UI.

cloudWatchMonitoringConfiguration -> (structure)

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 -> (structure)

Amazon S3 configuration for monitoring log publishing.

logUri -> (string)

Amazon S3 destination URI for log publishing.

serverUrl -> (string)

The server URL of the endpoint.

createdAt -> (timestamp)

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 -> (map)

The tags of the endpoint.

key -> (string)

value -> (string)