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 ]

list-managed-endpoints

Description

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.

See also: AWS API Documentation

list-managed-endpoints is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: endpoints

Synopsis

  list-managed-endpoints
--virtual-cluster-id <value>
[--created-before <value>]
[--created-after <value>]
[--types <value>]
[--states <value>]
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--virtual-cluster-id (string)

The ID of the virtual cluster.

--created-before (timestamp)

The date and time before which the endpoints are created.

--created-after (timestamp)

The date and time after which the endpoints are created.

--types (list)

The types of the managed endpoints.

(string)

Syntax:

"string" "string" ...

--states (list)

The states of the managed endpoints.

(string)

Syntax:

"string" "string" ...

Where valid values are:
  CREATING
  ACTIVE
  TERMINATING
  TERMINATED
  TERMINATED_WITH_ERRORS

--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.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command's output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command's output. If the total number of items available is more than the value specified, a NextToken is provided in the command's output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--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.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

• json
• text
• table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

endpoints -> (list)

The managed endpoints to be listed.

(structure)

This entity represents the endpoint that is managed by Amazon EMR on EKS.

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.

containerLogRotationConfiguration -> (structure)

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

nextToken -> (string)

The token for the next set of endpoints to return.