[ aws . groundstation ]

get-dataflow-endpoint-group

Description

Returns the dataflow endpoint group.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-dataflow-endpoint-group
--dataflow-endpoint-group-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--dataflow-endpoint-group-id (string)

UUID of a dataflow endpoint group.

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

See ‘aws help’ for descriptions of global parameters.

Output

dataflowEndpointGroupArn -> (string)

ARN of a dataflow endpoint group.

dataflowEndpointGroupId -> (string)

UUID of a dataflow endpoint group.

endpointsDetails -> (list)

Details of a dataflow endpoint.

(structure)

Information about the endpoint details.

endpoint -> (structure)

A dataflow endpoint.

address -> (structure)

Socket address of a dataflow endpoint.

name -> (string)

Name of a socket address.

port -> (integer)

Port of a socket address.

mtu -> (integer)

Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.

name -> (string)

Name of a dataflow endpoint.

status -> (string)

Status of a dataflow endpoint.

securityDetails -> (structure)

Endpoint security details.

roleArn -> (string)

ARN to a role needed for connecting streams to your instances.

securityGroupIds -> (list)

The security groups to attach to the elastic network interfaces.

(string)

subnetIds -> (list)

A list of subnets where AWS Ground Station places elastic network interfaces to send streams to your instances.

(string)

tags -> (map)

Tags assigned to a dataflow endpoint group.

key -> (string)

value -> (string)