[ aws . emr-containers ]
describe-managed-endpoint¶
Description¶
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.
See also: AWS API Documentation
Synopsis¶
describe-managed-endpoint
--id <value>
--virtual-cluster-id <value>
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
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 | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.
--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
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
- yaml
- yaml-stream
--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.
--cli-binary-format (string)
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.
- base64
- raw-in-base64-out
--no-cli-pager (boolean)
Disable cli pager for output.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
--no-cli-auto-prompt (boolean)
Disable automatically prompt for CLI input 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.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)