AWS CLI Command Reference

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

get-dataflow-endpoint-group

Description

Returns the dataflow endpoint group.

See also: AWS API Documentation

Synopsis

  get-dataflow-endpoint-group
--dataflow-endpoint-group-id <value>
[--cli-input-json <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

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

UUID of a dataflow endpoint group.

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

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. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

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

contactPostPassDurationSeconds -> (integer)

Amount of time, in seconds, after a contact ends that the Ground Station Dataflow Endpoint Group will be in a POSTPASS state. A Ground Station Dataflow Endpoint Group State Change event will be emitted when the Dataflow Endpoint Group enters and exits the POSTPASS state.

contactPrePassDurationSeconds -> (integer)

Amount of time, in seconds, before a contact starts that the Ground Station Dataflow Endpoint Group will be in a PREPASS state. A Ground Station Dataflow Endpoint Group State Change event will be emitted when the Dataflow Endpoint Group enters and exits the PREPASS state.

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.

awsGroundStationAgentEndpoint -> (structure)

An agent endpoint.

agentStatus -> (string)

The status of AgentEndpoint.

auditResults -> (string)

The results of the audit.

egressAddress -> (structure)

The egress address of AgentEndpoint.

mtu -> (integer)

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

socketAddress -> (structure)

A socket address.

name -> (string)

Name of a socket address.

port -> (integer)

Port of a socket address.

ingressAddress -> (structure)

The ingress address of AgentEndpoint.

mtu -> (integer)

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

socketAddress -> (structure)

A ranged socket address.

name -> (string)

IPv4 socket address.

portRange -> (structure)

Port range of a socket address.

maximum -> (integer)

A maximum value.

minimum -> (integer)

A minimum value.

name -> (string)

Name string associated with AgentEndpoint. Used as a human-readable identifier for AgentEndpoint.

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.

healthReasons -> (list)

Health reasons for a dataflow endpoint. This field is ignored when calling CreateDataflowEndpointGroup .

(string)

healthStatus -> (string)

A dataflow endpoint health status. This field is ignored when calling CreateDataflowEndpointGroup .

securityDetails -> (structure)

Endpoint security details including a list of subnets, a list of security groups and a role to connect streams to instances.

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)