[ aws . groundstation ]

describe-contact

Description

Describes an existing contact.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-contact
--contact-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--contact-id (string)

UUID of a contact.

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

contactId -> (string)

UUID of a contact.

contactStatus -> (string)

Status of a contact.

dataflowList -> (list)

List describing source and destination details for each dataflow edge.

(structure)

Information about a dataflow edge used in a contact.

destination -> (structure)

Dataflow details for the destination side.

configDetails -> (structure)

Additional details for a Config , if type is dataflow endpoint or antenna demod decode.

antennaDemodDecodeDetails -> (structure)

Details for antenna demod decode Config in a contact.

outputNode -> (string)

Name of an antenna demod decode output node used in a contact.

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

s3RecordingDetails -> (structure)

Details for an S3 recording Config in a contact.

bucketArn -> (string)

ARN of the bucket used.

keyTemplate -> (string)

Template of the S3 key used.

configId -> (string)

UUID of a Config .

configType -> (string)

Type of a Config .

dataflowDestinationRegion -> (string)

Region of a dataflow destination.

errorMessage -> (string)

Error message for a dataflow.

source -> (structure)

Dataflow details for the source side.

configDetails -> (structure)

Additional details for a Config , if type is dataflow endpoint or antenna demod decode.

antennaDemodDecodeDetails -> (structure)

Details for antenna demod decode Config in a contact.

outputNode -> (string)

Name of an antenna demod decode output node used in a contact.

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

s3RecordingDetails -> (structure)

Details for an S3 recording Config in a contact.

bucketArn -> (string)

ARN of the bucket used.

keyTemplate -> (string)

Template of the S3 key used.

configId -> (string)

UUID of a Config .

configType -> (string)

Type of a Config .

dataflowSourceRegion -> (string)

Region of a dataflow source.

endTime -> (timestamp)

End time of a contact.

errorMessage -> (string)

Error message for a contact.

groundStation -> (string)

Ground station for a contact.

maximumElevation -> (structure)

Maximum elevation angle of a contact.

unit -> (string)

Elevation angle units.

value -> (double)

Elevation angle value.

missionProfileArn -> (string)

ARN of a mission profile.

postPassEndTime -> (timestamp)

Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.

prePassStartTime -> (timestamp)

Amount of time prior to contact start you’d like to receive a CloudWatch event indicating an upcoming pass.

region -> (string)

Region of a contact.

satelliteArn -> (string)

ARN of a satellite.

startTime -> (timestamp)

Start time of a contact.

tags -> (map)

Tags assigned to a contact.

key -> (string)

value -> (string)