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 ]

describe-contact¶

Description¶

Describes an existing contact.

Synopsis¶

  describe-contact
--contact-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¶

--contact-id (string)

UUID of a contact.

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

contactId -> (string)

UUID of a contact.

missionProfileArn -> (string)

ARN of a mission profile.

satelliteArn -> (string)

ARN of a satellite.

startTime -> (timestamp)

Start time of a contact in UTC.

endTime -> (timestamp)

End time of a contact in UTC.

prePassStartTime -> (timestamp)

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

postPassEndTime -> (timestamp)

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

groundStation -> (string)

Ground station for a contact.

contactStatus -> (string)

Status of a contact.

errorMessage -> (string)

Error message for a contact.

maximumElevation -> (structure)

Maximum elevation angle of a contact.

value -> (double)

Elevation angle value.

unit -> (string)

Elevation angle units.

tags -> (map)

Tags assigned to a contact.

key -> (string)

value -> (string)

region -> (string)

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

source -> (structure)

Dataflow details for the source side.

configType -> (string)

Type of a Config .

configId -> (string)

UUID of a Config .

configDetails -> (tagged union structure)

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

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: endpointDetails, antennaDemodDecodeDetails, s3RecordingDetails.

endpointDetails -> (structure)

Information about the endpoint details.

securityDetails -> (structure)

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

subnetIds -> (list)

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

(string)

securityGroupIds -> (list)

The security groups to attach to the elastic network interfaces.

(string)

roleArn -> (string)

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

endpoint -> (structure)

A dataflow endpoint.

name -> (string)

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

status -> (string)

Status of a dataflow endpoint.

mtu -> (integer)

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

awsGroundStationAgentEndpoint -> (structure)

An agent endpoint.

name -> (string)

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

egressAddress -> (structure)

The egress address of AgentEndpoint.

socketAddress -> (structure)

A socket address.

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.

ingressAddress -> (structure)

The ingress address of AgentEndpoint.

socketAddress -> (structure)

A ranged socket address.

name -> (string)

IPv4 socket address.

portRange -> (structure)

Port range of a socket address.

minimum -> (integer)

A minimum value.

maximum -> (integer)

A maximum value.

mtu -> (integer)

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

agentStatus -> (string)

The status of AgentEndpoint.

auditResults -> (string)

The results of the audit.

uplinkAwsGroundStationAgentEndpoint -> (structure)

Definition for an uplink agent endpoint

name -> (string)

Uplink dataflow endpoint name

dataflowDetails -> (tagged union structure)

Dataflow details for the uplink endpoint

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: agentConnectionDetails.

agentConnectionDetails -> (structure)

Uplink connection details for customer to Agent and Agent to Ground Station

ingressAddressAndPort -> (structure)

Egress address of AgentEndpoint with an optional mtu.

socketAddress -> (structure)

A socket address.

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.

agentIpAndPortAddress -> (structure)

Ingress address of AgentEndpoint with a port range and an optional mtu.

socketAddress -> (structure)

A ranged socket address.

name -> (string)

IPv4 socket address.

portRange -> (structure)

Port range of a socket address.

minimum -> (integer)

A minimum value.

maximum -> (integer)

A maximum value.

mtu -> (integer)

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

agentStatus -> (string)

Status of the agent associated with the uplink dataflow endpoint

auditResults -> (string)

Health audit results for the uplink dataflow endpoint

downlinkAwsGroundStationAgentEndpoint -> (structure)

Definition for a downlink agent endpoint

name -> (string)

Downlink dataflow endpoint name

dataflowDetails -> (tagged union structure)

Dataflow details for the downlink endpoint

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: agentConnectionDetails.

agentConnectionDetails -> (structure)

Downlink connection details for customer to Agent and Agent to Ground Station

agentIpAndPortAddress -> (structure)

Ingress address of AgentEndpoint with a port range and an optional mtu.

socketAddress -> (structure)

A ranged socket address.

name -> (string)

IPv4 socket address.

portRange -> (structure)

Port range of a socket address.

minimum -> (integer)

A minimum value.

maximum -> (integer)

A maximum value.

mtu -> (integer)

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

egressAddressAndPort -> (structure)

Egress address of AgentEndpoint with an optional mtu.

socketAddress -> (structure)

A socket address.

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.

agentStatus -> (string)

Status of the agent associated with the downlink dataflow endpoint

auditResults -> (string)

Health audit results for the downlink dataflow endpoint

healthStatus -> (string)

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

healthReasons -> (list)

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

(string)

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.

s3RecordingDetails -> (structure)

Details for an S3 recording Config in a contact.

bucketArn -> (string)

ARN of the bucket used.

keyTemplate -> (string)

Key template used for the S3 Recording Configuration

dataflowSourceRegion -> (string)

Region of a dataflow source.

destination -> (structure)

Dataflow details for the destination side.

configType -> (string)

Type of a Config .

configId -> (string)

UUID of a Config .

configDetails -> (tagged union structure)

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

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: endpointDetails, antennaDemodDecodeDetails, s3RecordingDetails.

endpointDetails -> (structure)

Information about the endpoint details.

securityDetails -> (structure)

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

subnetIds -> (list)

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

(string)

securityGroupIds -> (list)

The security groups to attach to the elastic network interfaces.

(string)

roleArn -> (string)

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

endpoint -> (structure)

A dataflow endpoint.

name -> (string)

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

status -> (string)

Status of a dataflow endpoint.

mtu -> (integer)

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

awsGroundStationAgentEndpoint -> (structure)

An agent endpoint.

name -> (string)

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

egressAddress -> (structure)

The egress address of AgentEndpoint.

socketAddress -> (structure)

A socket address.

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.

ingressAddress -> (structure)

The ingress address of AgentEndpoint.

socketAddress -> (structure)

A ranged socket address.

name -> (string)

IPv4 socket address.

portRange -> (structure)

Port range of a socket address.

minimum -> (integer)

A minimum value.

maximum -> (integer)

A maximum value.

mtu -> (integer)

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

agentStatus -> (string)

The status of AgentEndpoint.

auditResults -> (string)

The results of the audit.

uplinkAwsGroundStationAgentEndpoint -> (structure)

Definition for an uplink agent endpoint

name -> (string)

Uplink dataflow endpoint name

dataflowDetails -> (tagged union structure)

Dataflow details for the uplink endpoint

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: agentConnectionDetails.

agentConnectionDetails -> (structure)

Uplink connection details for customer to Agent and Agent to Ground Station

ingressAddressAndPort -> (structure)

Egress address of AgentEndpoint with an optional mtu.

socketAddress -> (structure)

A socket address.

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.

agentIpAndPortAddress -> (structure)

Ingress address of AgentEndpoint with a port range and an optional mtu.

socketAddress -> (structure)

A ranged socket address.

name -> (string)

IPv4 socket address.

portRange -> (structure)

Port range of a socket address.

minimum -> (integer)

A minimum value.

maximum -> (integer)

A maximum value.

mtu -> (integer)

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

agentStatus -> (string)

Status of the agent associated with the uplink dataflow endpoint

auditResults -> (string)

Health audit results for the uplink dataflow endpoint

downlinkAwsGroundStationAgentEndpoint -> (structure)

Definition for a downlink agent endpoint

name -> (string)

Downlink dataflow endpoint name

dataflowDetails -> (tagged union structure)

Dataflow details for the downlink endpoint

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: agentConnectionDetails.

agentConnectionDetails -> (structure)

Downlink connection details for customer to Agent and Agent to Ground Station

agentIpAndPortAddress -> (structure)

Ingress address of AgentEndpoint with a port range and an optional mtu.

socketAddress -> (structure)

A ranged socket address.

name -> (string)

IPv4 socket address.

portRange -> (structure)

Port range of a socket address.

minimum -> (integer)

A minimum value.

maximum -> (integer)

A maximum value.

mtu -> (integer)

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

egressAddressAndPort -> (structure)

Egress address of AgentEndpoint with an optional mtu.

socketAddress -> (structure)

A socket address.

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.

agentStatus -> (string)

Status of the agent associated with the downlink dataflow endpoint

auditResults -> (string)

Health audit results for the downlink dataflow endpoint

healthStatus -> (string)

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

healthReasons -> (list)

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

(string)

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.

s3RecordingDetails -> (structure)

Details for an S3 recording Config in a contact.

bucketArn -> (string)

ARN of the bucket used.

keyTemplate -> (string)

Key template used for the S3 Recording Configuration

dataflowDestinationRegion -> (string)

Region of a dataflow destination.

errorMessage -> (string)

Error message for a dataflow.

visibilityStartTime -> (timestamp)

Projected time in UTC your satellite will rise above the receive mask . This time is based on the satellite’s current active ephemeris for future contacts and the ephemeris that was active during contact execution for completed contacts.

visibilityEndTime -> (timestamp)

Projected time in UTC your satellite will set below the receive mask . This time is based on the satellite’s current active ephemeris for future contacts and the ephemeris that was active during contact execution for completed contacts.

trackingOverrides -> (structure)

Tracking configuration overrides specified when the contact was reserved.

programTrackSettings -> (tagged union structure)

Program track settings to override for antenna tracking during the contact.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: azEl.

azEl -> (structure)

Program track settings for AzElEphemeris .

ephemerisId -> (string)

Unique identifier of the azimuth elevation ephemeris.

ephemeris -> (structure)

The ephemeris that determines antenna pointing directions for the contact.

ephemerisId -> (string)

Unique identifier of the ephemeris. Appears only for custom ephemerides.

ephemerisType -> (string)

Type of ephemeris.

Table of Contents

Feedback

User Guide

Note:

describe-contact¶

Description¶

Synopsis¶

Options¶

Global Options¶

Output¶

Note

Note

Note

Note

Note

Note

Note